]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - drivers/hid/hid-roccat-arvo.c
HID: roccat: Increase waiting time for Kone[+] to prevent occasional freezes
[mirror_ubuntu-eoan-kernel.git] / drivers / hid / hid-roccat-arvo.c
CommitLineData
e68cc603
SA
1/*
2 * Roccat Arvo driver for Linux
3 *
4 * Copyright (c) 2011 Stefan Achatz <erazor_de@users.sourceforge.net>
5 */
6
7/*
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
11 * any later version.
12 */
13
14/*
15 * Roccat Arvo is a gamer keyboard with 5 macro keys that can be configured in
16 * 5 profiles.
17 */
18
19#include <linux/device.h>
20#include <linux/input.h>
21#include <linux/hid.h>
e68cc603
SA
22#include <linux/module.h>
23#include <linux/slab.h>
24#include "hid-ids.h"
25#include "hid-roccat.h"
5772f636 26#include "hid-roccat-common.h"
e68cc603
SA
27#include "hid-roccat-arvo.h"
28
29static struct class *arvo_class;
30
e68cc603
SA
31static ssize_t arvo_sysfs_show_mode_key(struct device *dev,
32 struct device_attribute *attr, char *buf)
33{
34 struct arvo_device *arvo =
35 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
36 struct usb_device *usb_dev =
37 interface_to_usbdev(to_usb_interface(dev->parent->parent));
5772f636 38 struct arvo_mode_key temp_buf;
e68cc603
SA
39 int retval;
40
e68cc603 41 mutex_lock(&arvo->arvo_lock);
5772f636
SA
42 retval = roccat_common_receive(usb_dev, ARVO_USB_COMMAND_MODE_KEY,
43 &temp_buf, sizeof(struct arvo_mode_key));
e68cc603
SA
44 mutex_unlock(&arvo->arvo_lock);
45 if (retval)
5772f636 46 return retval;
e68cc603 47
5772f636 48 return snprintf(buf, PAGE_SIZE, "%d\n", temp_buf.state);
e68cc603
SA
49}
50
51static ssize_t arvo_sysfs_set_mode_key(struct device *dev,
52 struct device_attribute *attr, char const *buf, size_t size)
53{
54 struct arvo_device *arvo =
55 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
56 struct usb_device *usb_dev =
57 interface_to_usbdev(to_usb_interface(dev->parent->parent));
5772f636 58 struct arvo_mode_key temp_buf;
e68cc603
SA
59 unsigned long state;
60 int retval;
61
e68cc603
SA
62 retval = strict_strtoul(buf, 10, &state);
63 if (retval)
5772f636 64 return retval;
e68cc603 65
5772f636
SA
66 temp_buf.command = ARVO_COMMAND_MODE_KEY;
67 temp_buf.state = state;
e68cc603
SA
68
69 mutex_lock(&arvo->arvo_lock);
5772f636
SA
70 retval = roccat_common_send(usb_dev, ARVO_USB_COMMAND_MODE_KEY,
71 &temp_buf, sizeof(struct arvo_mode_key));
e68cc603
SA
72 mutex_unlock(&arvo->arvo_lock);
73 if (retval)
5772f636 74 return retval;
e68cc603 75
5772f636 76 return size;
e68cc603
SA
77}
78
79static ssize_t arvo_sysfs_show_key_mask(struct device *dev,
80 struct device_attribute *attr, char *buf)
81{
82 struct arvo_device *arvo =
83 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
84 struct usb_device *usb_dev =
85 interface_to_usbdev(to_usb_interface(dev->parent->parent));
5772f636 86 struct arvo_key_mask temp_buf;
e68cc603
SA
87 int retval;
88
e68cc603 89 mutex_lock(&arvo->arvo_lock);
5772f636
SA
90 retval = roccat_common_receive(usb_dev, ARVO_USB_COMMAND_KEY_MASK,
91 &temp_buf, sizeof(struct arvo_key_mask));
e68cc603
SA
92 mutex_unlock(&arvo->arvo_lock);
93 if (retval)
5772f636 94 return retval;
e68cc603 95
5772f636 96 return snprintf(buf, PAGE_SIZE, "%d\n", temp_buf.key_mask);
e68cc603
SA
97}
98
99static ssize_t arvo_sysfs_set_key_mask(struct device *dev,
100 struct device_attribute *attr, char const *buf, size_t size)
101{
102 struct arvo_device *arvo =
103 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
104 struct usb_device *usb_dev =
105 interface_to_usbdev(to_usb_interface(dev->parent->parent));
5772f636 106 struct arvo_key_mask temp_buf;
e68cc603
SA
107 unsigned long key_mask;
108 int retval;
109
e68cc603
SA
110 retval = strict_strtoul(buf, 10, &key_mask);
111 if (retval)
5772f636 112 return retval;
e68cc603 113
5772f636
SA
114 temp_buf.command = ARVO_COMMAND_KEY_MASK;
115 temp_buf.key_mask = key_mask;
e68cc603
SA
116
117 mutex_lock(&arvo->arvo_lock);
5772f636
SA
118 retval = roccat_common_send(usb_dev, ARVO_USB_COMMAND_KEY_MASK,
119 &temp_buf, sizeof(struct arvo_key_mask));
e68cc603
SA
120 mutex_unlock(&arvo->arvo_lock);
121 if (retval)
5772f636 122 return retval;
e68cc603 123
5772f636 124 return size;
e68cc603
SA
125}
126
127/* retval is 1-5 on success, < 0 on error */
128static int arvo_get_actual_profile(struct usb_device *usb_dev)
129{
5772f636 130 struct arvo_actual_profile temp_buf;
e68cc603
SA
131 int retval;
132
5772f636
SA
133 retval = roccat_common_receive(usb_dev, ARVO_USB_COMMAND_ACTUAL_PROFILE,
134 &temp_buf, sizeof(struct arvo_actual_profile));
e68cc603 135
5772f636
SA
136 if (retval)
137 return retval;
e68cc603 138
5772f636 139 return temp_buf.actual_profile;
e68cc603
SA
140}
141
142static ssize_t arvo_sysfs_show_actual_profile(struct device *dev,
143 struct device_attribute *attr, char *buf)
144{
145 struct arvo_device *arvo =
146 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
147
148 return snprintf(buf, PAGE_SIZE, "%d\n", arvo->actual_profile);
149}
150
151static ssize_t arvo_sysfs_set_actual_profile(struct device *dev,
152 struct device_attribute *attr, char const *buf, size_t size)
153{
154 struct arvo_device *arvo =
155 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
156 struct usb_device *usb_dev =
157 interface_to_usbdev(to_usb_interface(dev->parent->parent));
5772f636 158 struct arvo_actual_profile temp_buf;
e68cc603
SA
159 unsigned long profile;
160 int retval;
161
e68cc603
SA
162 retval = strict_strtoul(buf, 10, &profile);
163 if (retval)
5772f636 164 return retval;
e68cc603 165
5772f636
SA
166 temp_buf.command = ARVO_COMMAND_ACTUAL_PROFILE;
167 temp_buf.actual_profile = profile;
e68cc603
SA
168
169 mutex_lock(&arvo->arvo_lock);
5772f636
SA
170 retval = roccat_common_send(usb_dev, ARVO_USB_COMMAND_ACTUAL_PROFILE,
171 &temp_buf, sizeof(struct arvo_actual_profile));
e68cc603
SA
172 if (!retval) {
173 arvo->actual_profile = profile;
174 retval = size;
175 }
176 mutex_unlock(&arvo->arvo_lock);
e68cc603
SA
177 return retval;
178}
179
180static ssize_t arvo_sysfs_write(struct file *fp,
181 struct kobject *kobj, void const *buf,
182 loff_t off, size_t count, size_t real_size, uint command)
183{
184 struct device *dev =
185 container_of(kobj, struct device, kobj)->parent->parent;
186 struct arvo_device *arvo = hid_get_drvdata(dev_get_drvdata(dev));
187 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
188 int retval;
189
190 if (off != 0 || count != real_size)
191 return -EINVAL;
192
193 mutex_lock(&arvo->arvo_lock);
5772f636 194 retval = roccat_common_send(usb_dev, command, buf, real_size);
e68cc603
SA
195 mutex_unlock(&arvo->arvo_lock);
196
197 return (retval ? retval : real_size);
198}
199
200static ssize_t arvo_sysfs_read(struct file *fp,
201 struct kobject *kobj, void *buf, loff_t off,
202 size_t count, size_t real_size, uint command)
203{
204 struct device *dev =
205 container_of(kobj, struct device, kobj)->parent->parent;
206 struct arvo_device *arvo = hid_get_drvdata(dev_get_drvdata(dev));
207 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
208 int retval;
209
210 if (off >= real_size)
211 return 0;
212
213 if (off != 0 || count != real_size)
214 return -EINVAL;
215
216 mutex_lock(&arvo->arvo_lock);
5772f636 217 retval = roccat_common_receive(usb_dev, command, buf, real_size);
e68cc603
SA
218 mutex_unlock(&arvo->arvo_lock);
219
220 return (retval ? retval : real_size);
221}
222
223static ssize_t arvo_sysfs_write_button(struct file *fp,
224 struct kobject *kobj, struct bin_attribute *attr, char *buf,
225 loff_t off, size_t count)
226{
227 return arvo_sysfs_write(fp, kobj, buf, off, count,
228 sizeof(struct arvo_button), ARVO_USB_COMMAND_BUTTON);
229}
230
231static ssize_t arvo_sysfs_read_info(struct file *fp,
232 struct kobject *kobj, struct bin_attribute *attr, char *buf,
233 loff_t off, size_t count)
234{
235 return arvo_sysfs_read(fp, kobj, buf, off, count,
236 sizeof(struct arvo_info), ARVO_USB_COMMAND_INFO);
237}
238
239
240static struct device_attribute arvo_attributes[] = {
241 __ATTR(mode_key, 0660,
242 arvo_sysfs_show_mode_key, arvo_sysfs_set_mode_key),
243 __ATTR(key_mask, 0660,
244 arvo_sysfs_show_key_mask, arvo_sysfs_set_key_mask),
245 __ATTR(actual_profile, 0660,
246 arvo_sysfs_show_actual_profile,
247 arvo_sysfs_set_actual_profile),
248 __ATTR_NULL
249};
250
251static struct bin_attribute arvo_bin_attributes[] = {
252 {
253 .attr = { .name = "button", .mode = 0220 },
254 .size = sizeof(struct arvo_button),
255 .write = arvo_sysfs_write_button
256 },
257 {
258 .attr = { .name = "info", .mode = 0440 },
259 .size = sizeof(struct arvo_info),
260 .read = arvo_sysfs_read_info
261 },
262 __ATTR_NULL
263};
264
265static int arvo_init_arvo_device_struct(struct usb_device *usb_dev,
266 struct arvo_device *arvo)
267{
268 int retval;
269
270 mutex_init(&arvo->arvo_lock);
271
272 retval = arvo_get_actual_profile(usb_dev);
273 if (retval < 0)
274 return retval;
275 arvo->actual_profile = retval;
276
277 return 0;
278}
279
280static int arvo_init_specials(struct hid_device *hdev)
281{
282 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
283 struct usb_device *usb_dev = interface_to_usbdev(intf);
284 struct arvo_device *arvo;
285 int retval;
286
287 if (intf->cur_altsetting->desc.bInterfaceProtocol
288 == USB_INTERFACE_PROTOCOL_KEYBOARD) {
289 hid_set_drvdata(hdev, NULL);
290 return 0;
291 }
292
293 arvo = kzalloc(sizeof(*arvo), GFP_KERNEL);
294 if (!arvo) {
a28764ef 295 hid_err(hdev, "can't alloc device descriptor\n");
e68cc603
SA
296 return -ENOMEM;
297 }
298 hid_set_drvdata(hdev, arvo);
299
300 retval = arvo_init_arvo_device_struct(usb_dev, arvo);
301 if (retval) {
a28764ef 302 hid_err(hdev, "couldn't init struct arvo_device\n");
e68cc603
SA
303 goto exit_free;
304 }
305
306 retval = roccat_connect(arvo_class, hdev);
307 if (retval < 0) {
a28764ef 308 hid_err(hdev, "couldn't init char dev\n");
e68cc603
SA
309 } else {
310 arvo->chrdev_minor = retval;
311 arvo->roccat_claimed = 1;
312 }
313
314 return 0;
315exit_free:
316 kfree(arvo);
317 return retval;
318}
319
320static void arvo_remove_specials(struct hid_device *hdev)
321{
322 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
323 struct arvo_device *arvo;
324
325 if (intf->cur_altsetting->desc.bInterfaceProtocol
326 == USB_INTERFACE_PROTOCOL_KEYBOARD)
327 return;
328
329 arvo = hid_get_drvdata(hdev);
330 if (arvo->roccat_claimed)
331 roccat_disconnect(arvo->chrdev_minor);
332 kfree(arvo);
333}
334
335static int arvo_probe(struct hid_device *hdev,
336 const struct hid_device_id *id)
337{
338 int retval;
339
340 retval = hid_parse(hdev);
341 if (retval) {
a28764ef 342 hid_err(hdev, "parse failed\n");
e68cc603
SA
343 goto exit;
344 }
345
346 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
347 if (retval) {
a28764ef 348 hid_err(hdev, "hw start failed\n");
e68cc603
SA
349 goto exit;
350 }
351
352 retval = arvo_init_specials(hdev);
353 if (retval) {
a28764ef 354 hid_err(hdev, "couldn't install keyboard\n");
e68cc603
SA
355 goto exit_stop;
356 }
357
358 return 0;
359
360exit_stop:
361 hid_hw_stop(hdev);
362exit:
363 return retval;
364}
365
366static void arvo_remove(struct hid_device *hdev)
367{
368 arvo_remove_specials(hdev);
369 hid_hw_stop(hdev);
370}
371
372static void arvo_report_to_chrdev(struct arvo_device const *arvo,
373 u8 const *data)
374{
375 struct arvo_special_report const *special_report;
376 struct arvo_roccat_report roccat_report;
377
378 special_report = (struct arvo_special_report const *)data;
379
380 roccat_report.profile = arvo->actual_profile;
381 roccat_report.button = special_report->event &
382 ARVO_SPECIAL_REPORT_EVENT_MASK_BUTTON;
383 if ((special_report->event & ARVO_SPECIAL_REPORT_EVENT_MASK_ACTION) ==
384 ARVO_SPECIAL_REPORT_EVENT_ACTION_PRESS)
385 roccat_report.action = ARVO_ROCCAT_REPORT_ACTION_PRESS;
386 else
387 roccat_report.action = ARVO_ROCCAT_REPORT_ACTION_RELEASE;
388
389 roccat_report_event(arvo->chrdev_minor, (uint8_t const *)&roccat_report,
390 sizeof(struct arvo_roccat_report));
391}
392
393static int arvo_raw_event(struct hid_device *hdev,
394 struct hid_report *report, u8 *data, int size)
395{
396 struct arvo_device *arvo = hid_get_drvdata(hdev);
397
398 if (size != 3)
399 return 0;
400
401 if (arvo->roccat_claimed)
402 arvo_report_to_chrdev(arvo, data);
403
404 return 0;
405}
406
407static const struct hid_device_id arvo_devices[] = {
408 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_ARVO) },
409 { }
410};
411
412MODULE_DEVICE_TABLE(hid, arvo_devices);
413
414static struct hid_driver arvo_driver = {
415 .name = "arvo",
416 .id_table = arvo_devices,
417 .probe = arvo_probe,
418 .remove = arvo_remove,
419 .raw_event = arvo_raw_event
420};
421
422static int __init arvo_init(void)
423{
424 int retval;
425
426 arvo_class = class_create(THIS_MODULE, "arvo");
427 if (IS_ERR(arvo_class))
428 return PTR_ERR(arvo_class);
429 arvo_class->dev_attrs = arvo_attributes;
430 arvo_class->dev_bin_attrs = arvo_bin_attributes;
431
432 retval = hid_register_driver(&arvo_driver);
433 if (retval)
434 class_destroy(arvo_class);
435 return retval;
436}
437
438static void __exit arvo_exit(void)
439{
440 class_destroy(arvo_class);
441 hid_unregister_driver(&arvo_driver);
442}
443
444module_init(arvo_init);
445module_exit(arvo_exit);
446
447MODULE_AUTHOR("Stefan Achatz");
448MODULE_DESCRIPTION("USB Roccat Arvo driver");
449MODULE_LICENSE("GPL v2");