]> Pileus Git - ~andy/linux/blob - drivers/hid/hid-roccat-koneplus.c
11906b4b42b242066cae1af8d450174052b39294
[~andy/linux] / drivers / hid / hid-roccat-koneplus.c
1 /*
2  * Roccat Kone[+] driver for Linux
3  *
4  * Copyright (c) 2010 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 Kone[+] is an updated/improved version of the Kone with more memory
16  * and functionality and without the non-standard behaviours the Kone had.
17  * KoneXTD has same capabilities but updated sensor.
18  */
19
20 #include <linux/device.h>
21 #include <linux/input.h>
22 #include <linux/hid.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/hid-roccat.h>
26 #include "hid-ids.h"
27 #include "hid-roccat-common.h"
28 #include "hid-roccat-koneplus.h"
29
30 static uint profile_numbers[5] = {0, 1, 2, 3, 4};
31
32 static struct class *koneplus_class;
33
34 static void koneplus_profile_activated(struct koneplus_device *koneplus,
35                 uint new_profile)
36 {
37         koneplus->actual_profile = new_profile;
38 }
39
40 static int koneplus_send_control(struct usb_device *usb_dev, uint value,
41                 enum koneplus_control_requests request)
42 {
43         struct roccat_common2_control control;
44
45         if ((request == KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS ||
46                         request == KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS) &&
47                         value > 4)
48                 return -EINVAL;
49
50         control.command = ROCCAT_COMMON_COMMAND_CONTROL;
51         control.value = value;
52         control.request = request;
53
54         return roccat_common2_send_with_status(usb_dev,
55                         ROCCAT_COMMON_COMMAND_CONTROL,
56                         &control, sizeof(struct roccat_common2_control));
57 }
58
59
60 /* retval is 0-4 on success, < 0 on error */
61 static int koneplus_get_actual_profile(struct usb_device *usb_dev)
62 {
63         struct koneplus_actual_profile buf;
64         int retval;
65
66         retval = roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_ACTUAL_PROFILE,
67                         &buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
68
69         return retval ? retval : buf.actual_profile;
70 }
71
72 static int koneplus_set_actual_profile(struct usb_device *usb_dev,
73                 int new_profile)
74 {
75         struct koneplus_actual_profile buf;
76
77         buf.command = KONEPLUS_COMMAND_ACTUAL_PROFILE;
78         buf.size = KONEPLUS_SIZE_ACTUAL_PROFILE;
79         buf.actual_profile = new_profile;
80
81         return roccat_common2_send_with_status(usb_dev,
82                         KONEPLUS_COMMAND_ACTUAL_PROFILE,
83                         &buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
84 }
85
86 static ssize_t koneplus_sysfs_read(struct file *fp, struct kobject *kobj,
87                 char *buf, loff_t off, size_t count,
88                 size_t real_size, uint command)
89 {
90         struct device *dev =
91                         container_of(kobj, struct device, kobj)->parent->parent;
92         struct koneplus_device *koneplus = hid_get_drvdata(dev_get_drvdata(dev));
93         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
94         int retval;
95
96         if (off >= real_size)
97                 return 0;
98
99         if (off != 0 || count != real_size)
100                 return -EINVAL;
101
102         mutex_lock(&koneplus->koneplus_lock);
103         retval = roccat_common2_receive(usb_dev, command, buf, real_size);
104         mutex_unlock(&koneplus->koneplus_lock);
105
106         if (retval)
107                 return retval;
108
109         return real_size;
110 }
111
112 static ssize_t koneplus_sysfs_write(struct file *fp, struct kobject *kobj,
113                 void const *buf, loff_t off, size_t count,
114                 size_t real_size, uint command)
115 {
116         struct device *dev =
117                         container_of(kobj, struct device, kobj)->parent->parent;
118         struct koneplus_device *koneplus = hid_get_drvdata(dev_get_drvdata(dev));
119         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
120         int retval;
121
122         if (off != 0 || count != real_size)
123                 return -EINVAL;
124
125         mutex_lock(&koneplus->koneplus_lock);
126         retval = roccat_common2_send_with_status(usb_dev, command,
127                         buf, real_size);
128         mutex_unlock(&koneplus->koneplus_lock);
129
130         if (retval)
131                 return retval;
132
133         return real_size;
134 }
135
136 #define KONEPLUS_SYSFS_W(thingy, THINGY) \
137 static ssize_t koneplus_sysfs_write_ ## thingy(struct file *fp, \
138                 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
139                 loff_t off, size_t count) \
140 { \
141         return koneplus_sysfs_write(fp, kobj, buf, off, count, \
142                         KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
143 }
144
145 #define KONEPLUS_SYSFS_R(thingy, THINGY) \
146 static ssize_t koneplus_sysfs_read_ ## thingy(struct file *fp, \
147                 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
148                 loff_t off, size_t count) \
149 { \
150         return koneplus_sysfs_read(fp, kobj, buf, off, count, \
151                         KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
152 }
153
154 #define KONEPLUS_SYSFS_RW(thingy, THINGY) \
155 KONEPLUS_SYSFS_W(thingy, THINGY) \
156 KONEPLUS_SYSFS_R(thingy, THINGY)
157
158 #define KONEPLUS_BIN_ATTRIBUTE_RW(thingy, THINGY) \
159 { \
160         .attr = { .name = #thingy, .mode = 0660 }, \
161         .size = KONEPLUS_SIZE_ ## THINGY, \
162         .read = koneplus_sysfs_read_ ## thingy, \
163         .write = koneplus_sysfs_write_ ## thingy \
164 }
165
166 #define KONEPLUS_BIN_ATTRIBUTE_R(thingy, THINGY) \
167 { \
168         .attr = { .name = #thingy, .mode = 0440 }, \
169         .size = KONEPLUS_SIZE_ ## THINGY, \
170         .read = koneplus_sysfs_read_ ## thingy, \
171 }
172
173 #define KONEPLUS_BIN_ATTRIBUTE_W(thingy, THINGY) \
174 { \
175         .attr = { .name = #thingy, .mode = 0220 }, \
176         .size = KONEPLUS_SIZE_ ## THINGY, \
177         .write = koneplus_sysfs_write_ ## thingy \
178 }
179
180 KONEPLUS_SYSFS_W(control, CONTROL)
181 KONEPLUS_SYSFS_RW(info, INFO)
182 KONEPLUS_SYSFS_W(talk, TALK)
183 KONEPLUS_SYSFS_W(macro, MACRO)
184 KONEPLUS_SYSFS_RW(sensor, SENSOR)
185 KONEPLUS_SYSFS_RW(tcu, TCU)
186 KONEPLUS_SYSFS_R(tcu_image, TCU_IMAGE)
187 KONEPLUS_SYSFS_RW(profile_settings, PROFILE_SETTINGS)
188 KONEPLUS_SYSFS_RW(profile_buttons, PROFILE_BUTTONS)
189
190 static ssize_t koneplus_sysfs_read_profilex_settings(struct file *fp,
191                 struct kobject *kobj, struct bin_attribute *attr, char *buf,
192                 loff_t off, size_t count)
193 {
194         struct device *dev =
195                         container_of(kobj, struct device, kobj)->parent->parent;
196         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
197         ssize_t retval;
198
199         retval = koneplus_send_control(usb_dev, *(uint *)(attr->private),
200                         KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS);
201         if (retval)
202                 return retval;
203
204         return koneplus_sysfs_read(fp, kobj, buf, off, count,
205                         KONEPLUS_SIZE_PROFILE_SETTINGS,
206                         KONEPLUS_COMMAND_PROFILE_SETTINGS);
207 }
208
209 static ssize_t koneplus_sysfs_read_profilex_buttons(struct file *fp,
210                 struct kobject *kobj, struct bin_attribute *attr, char *buf,
211                 loff_t off, size_t count)
212 {
213         struct device *dev =
214                         container_of(kobj, struct device, kobj)->parent->parent;
215         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
216         ssize_t retval;
217
218         retval = koneplus_send_control(usb_dev, *(uint *)(attr->private),
219                         KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS);
220         if (retval)
221                 return retval;
222
223         return koneplus_sysfs_read(fp, kobj, buf, off, count,
224                         KONEPLUS_SIZE_PROFILE_BUTTONS,
225                         KONEPLUS_COMMAND_PROFILE_BUTTONS);
226 }
227
228 static ssize_t koneplus_sysfs_show_actual_profile(struct device *dev,
229                 struct device_attribute *attr, char *buf)
230 {
231         struct koneplus_device *koneplus =
232                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
233         return snprintf(buf, PAGE_SIZE, "%d\n", koneplus->actual_profile);
234 }
235
236 static ssize_t koneplus_sysfs_set_actual_profile(struct device *dev,
237                 struct device_attribute *attr, char const *buf, size_t size)
238 {
239         struct koneplus_device *koneplus;
240         struct usb_device *usb_dev;
241         unsigned long profile;
242         int retval;
243         struct koneplus_roccat_report roccat_report;
244
245         dev = dev->parent->parent;
246         koneplus = hid_get_drvdata(dev_get_drvdata(dev));
247         usb_dev = interface_to_usbdev(to_usb_interface(dev));
248
249         retval = strict_strtoul(buf, 10, &profile);
250         if (retval)
251                 return retval;
252
253         if (profile > 4)
254                 return -EINVAL;
255
256         mutex_lock(&koneplus->koneplus_lock);
257
258         retval = koneplus_set_actual_profile(usb_dev, profile);
259         if (retval) {
260                 mutex_unlock(&koneplus->koneplus_lock);
261                 return retval;
262         }
263
264         koneplus_profile_activated(koneplus, profile);
265
266         roccat_report.type = KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE;
267         roccat_report.data1 = profile + 1;
268         roccat_report.data2 = 0;
269         roccat_report.profile = profile + 1;
270         roccat_report_event(koneplus->chrdev_minor,
271                         (uint8_t const *)&roccat_report);
272
273         mutex_unlock(&koneplus->koneplus_lock);
274
275         return size;
276 }
277 static DEVICE_ATTR(actual_profile, 0660,
278                    koneplus_sysfs_show_actual_profile,
279                    koneplus_sysfs_set_actual_profile);
280 static DEVICE_ATTR(startup_profile, 0660,
281                    koneplus_sysfs_show_actual_profile,
282                    koneplus_sysfs_set_actual_profile);
283
284 static ssize_t koneplus_sysfs_show_firmware_version(struct device *dev,
285                 struct device_attribute *attr, char *buf)
286 {
287         struct koneplus_device *koneplus;
288         struct usb_device *usb_dev;
289         struct koneplus_info info;
290
291         dev = dev->parent->parent;
292         koneplus = hid_get_drvdata(dev_get_drvdata(dev));
293         usb_dev = interface_to_usbdev(to_usb_interface(dev));
294
295         mutex_lock(&koneplus->koneplus_lock);
296         roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_INFO,
297                         &info, KONEPLUS_SIZE_INFO);
298         mutex_unlock(&koneplus->koneplus_lock);
299
300         return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
301 }
302 static DEVICE_ATTR(firmware_version, 0440,
303                    koneplus_sysfs_show_firmware_version, NULL);
304
305 static struct attribute *koneplus_attrs[] = {
306         &dev_attr_actual_profile.attr,
307         &dev_attr_startup_profile.attr,
308         &dev_attr_firmware_version.attr,
309         NULL,
310 };
311 ATTRIBUTE_GROUPS(koneplus);
312
313 static struct bin_attribute koneplus_bin_attributes[] = {
314         KONEPLUS_BIN_ATTRIBUTE_W(control, CONTROL),
315         KONEPLUS_BIN_ATTRIBUTE_RW(info, INFO),
316         KONEPLUS_BIN_ATTRIBUTE_W(talk, TALK),
317         KONEPLUS_BIN_ATTRIBUTE_W(macro, MACRO),
318         KONEPLUS_BIN_ATTRIBUTE_RW(sensor, SENSOR),
319         KONEPLUS_BIN_ATTRIBUTE_RW(tcu, TCU),
320         KONEPLUS_BIN_ATTRIBUTE_R(tcu_image, TCU_IMAGE),
321         KONEPLUS_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS),
322         KONEPLUS_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS),
323         {
324                 .attr = { .name = "profile1_settings", .mode = 0440 },
325                 .size = KONEPLUS_SIZE_PROFILE_SETTINGS,
326                 .read = koneplus_sysfs_read_profilex_settings,
327                 .private = &profile_numbers[0]
328         },
329         {
330                 .attr = { .name = "profile2_settings", .mode = 0440 },
331                 .size = KONEPLUS_SIZE_PROFILE_SETTINGS,
332                 .read = koneplus_sysfs_read_profilex_settings,
333                 .private = &profile_numbers[1]
334         },
335         {
336                 .attr = { .name = "profile3_settings", .mode = 0440 },
337                 .size = KONEPLUS_SIZE_PROFILE_SETTINGS,
338                 .read = koneplus_sysfs_read_profilex_settings,
339                 .private = &profile_numbers[2]
340         },
341         {
342                 .attr = { .name = "profile4_settings", .mode = 0440 },
343                 .size = KONEPLUS_SIZE_PROFILE_SETTINGS,
344                 .read = koneplus_sysfs_read_profilex_settings,
345                 .private = &profile_numbers[3]
346         },
347         {
348                 .attr = { .name = "profile5_settings", .mode = 0440 },
349                 .size = KONEPLUS_SIZE_PROFILE_SETTINGS,
350                 .read = koneplus_sysfs_read_profilex_settings,
351                 .private = &profile_numbers[4]
352         },
353         {
354                 .attr = { .name = "profile1_buttons", .mode = 0440 },
355                 .size = KONEPLUS_SIZE_PROFILE_BUTTONS,
356                 .read = koneplus_sysfs_read_profilex_buttons,
357                 .private = &profile_numbers[0]
358         },
359         {
360                 .attr = { .name = "profile2_buttons", .mode = 0440 },
361                 .size = KONEPLUS_SIZE_PROFILE_BUTTONS,
362                 .read = koneplus_sysfs_read_profilex_buttons,
363                 .private = &profile_numbers[1]
364         },
365         {
366                 .attr = { .name = "profile3_buttons", .mode = 0440 },
367                 .size = KONEPLUS_SIZE_PROFILE_BUTTONS,
368                 .read = koneplus_sysfs_read_profilex_buttons,
369                 .private = &profile_numbers[2]
370         },
371         {
372                 .attr = { .name = "profile4_buttons", .mode = 0440 },
373                 .size = KONEPLUS_SIZE_PROFILE_BUTTONS,
374                 .read = koneplus_sysfs_read_profilex_buttons,
375                 .private = &profile_numbers[3]
376         },
377         {
378                 .attr = { .name = "profile5_buttons", .mode = 0440 },
379                 .size = KONEPLUS_SIZE_PROFILE_BUTTONS,
380                 .read = koneplus_sysfs_read_profilex_buttons,
381                 .private = &profile_numbers[4]
382         },
383         __ATTR_NULL
384 };
385
386 static int koneplus_init_koneplus_device_struct(struct usb_device *usb_dev,
387                 struct koneplus_device *koneplus)
388 {
389         int retval;
390
391         mutex_init(&koneplus->koneplus_lock);
392
393         retval = koneplus_get_actual_profile(usb_dev);
394         if (retval < 0)
395                 return retval;
396         koneplus_profile_activated(koneplus, retval);
397
398         return 0;
399 }
400
401 static int koneplus_init_specials(struct hid_device *hdev)
402 {
403         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
404         struct usb_device *usb_dev = interface_to_usbdev(intf);
405         struct koneplus_device *koneplus;
406         int retval;
407
408         if (intf->cur_altsetting->desc.bInterfaceProtocol
409                         == USB_INTERFACE_PROTOCOL_MOUSE) {
410
411                 koneplus = kzalloc(sizeof(*koneplus), GFP_KERNEL);
412                 if (!koneplus) {
413                         hid_err(hdev, "can't alloc device descriptor\n");
414                         return -ENOMEM;
415                 }
416                 hid_set_drvdata(hdev, koneplus);
417
418                 retval = koneplus_init_koneplus_device_struct(usb_dev, koneplus);
419                 if (retval) {
420                         hid_err(hdev, "couldn't init struct koneplus_device\n");
421                         goto exit_free;
422                 }
423
424                 retval = roccat_connect(koneplus_class, hdev,
425                                 sizeof(struct koneplus_roccat_report));
426                 if (retval < 0) {
427                         hid_err(hdev, "couldn't init char dev\n");
428                 } else {
429                         koneplus->chrdev_minor = retval;
430                         koneplus->roccat_claimed = 1;
431                 }
432         } else {
433                 hid_set_drvdata(hdev, NULL);
434         }
435
436         return 0;
437 exit_free:
438         kfree(koneplus);
439         return retval;
440 }
441
442 static void koneplus_remove_specials(struct hid_device *hdev)
443 {
444         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
445         struct koneplus_device *koneplus;
446
447         if (intf->cur_altsetting->desc.bInterfaceProtocol
448                         == USB_INTERFACE_PROTOCOL_MOUSE) {
449                 koneplus = hid_get_drvdata(hdev);
450                 if (koneplus->roccat_claimed)
451                         roccat_disconnect(koneplus->chrdev_minor);
452                 kfree(koneplus);
453         }
454 }
455
456 static int koneplus_probe(struct hid_device *hdev,
457                 const struct hid_device_id *id)
458 {
459         int retval;
460
461         retval = hid_parse(hdev);
462         if (retval) {
463                 hid_err(hdev, "parse failed\n");
464                 goto exit;
465         }
466
467         retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
468         if (retval) {
469                 hid_err(hdev, "hw start failed\n");
470                 goto exit;
471         }
472
473         retval = koneplus_init_specials(hdev);
474         if (retval) {
475                 hid_err(hdev, "couldn't install mouse\n");
476                 goto exit_stop;
477         }
478
479         return 0;
480
481 exit_stop:
482         hid_hw_stop(hdev);
483 exit:
484         return retval;
485 }
486
487 static void koneplus_remove(struct hid_device *hdev)
488 {
489         koneplus_remove_specials(hdev);
490         hid_hw_stop(hdev);
491 }
492
493 static void koneplus_keep_values_up_to_date(struct koneplus_device *koneplus,
494                 u8 const *data)
495 {
496         struct koneplus_mouse_report_button const *button_report;
497
498         switch (data[0]) {
499         case KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON:
500                 button_report = (struct koneplus_mouse_report_button const *)data;
501                 switch (button_report->type) {
502                 case KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE:
503                         koneplus_profile_activated(koneplus, button_report->data1 - 1);
504                         break;
505                 }
506                 break;
507         }
508 }
509
510 static void koneplus_report_to_chrdev(struct koneplus_device const *koneplus,
511                 u8 const *data)
512 {
513         struct koneplus_roccat_report roccat_report;
514         struct koneplus_mouse_report_button const *button_report;
515
516         if (data[0] != KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON)
517                 return;
518
519         button_report = (struct koneplus_mouse_report_button const *)data;
520
521         if ((button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH ||
522                         button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER) &&
523                         button_report->data2 != KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS)
524                 return;
525
526         roccat_report.type = button_report->type;
527         roccat_report.data1 = button_report->data1;
528         roccat_report.data2 = button_report->data2;
529         roccat_report.profile = koneplus->actual_profile + 1;
530         roccat_report_event(koneplus->chrdev_minor,
531                         (uint8_t const *)&roccat_report);
532 }
533
534 static int koneplus_raw_event(struct hid_device *hdev,
535                 struct hid_report *report, u8 *data, int size)
536 {
537         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
538         struct koneplus_device *koneplus = hid_get_drvdata(hdev);
539
540         if (intf->cur_altsetting->desc.bInterfaceProtocol
541                         != USB_INTERFACE_PROTOCOL_MOUSE)
542                 return 0;
543
544         if (koneplus == NULL)
545                 return 0;
546
547         koneplus_keep_values_up_to_date(koneplus, data);
548
549         if (koneplus->roccat_claimed)
550                 koneplus_report_to_chrdev(koneplus, data);
551
552         return 0;
553 }
554
555 static const struct hid_device_id koneplus_devices[] = {
556         { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEPLUS) },
557         { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEXTD) },
558         { }
559 };
560
561 MODULE_DEVICE_TABLE(hid, koneplus_devices);
562
563 static struct hid_driver koneplus_driver = {
564                 .name = "koneplus",
565                 .id_table = koneplus_devices,
566                 .probe = koneplus_probe,
567                 .remove = koneplus_remove,
568                 .raw_event = koneplus_raw_event
569 };
570
571 static int __init koneplus_init(void)
572 {
573         int retval;
574
575         /* class name has to be same as driver name */
576         koneplus_class = class_create(THIS_MODULE, "koneplus");
577         if (IS_ERR(koneplus_class))
578                 return PTR_ERR(koneplus_class);
579         koneplus_class->dev_groups = koneplus_groups;
580         koneplus_class->dev_bin_attrs = koneplus_bin_attributes;
581
582         retval = hid_register_driver(&koneplus_driver);
583         if (retval)
584                 class_destroy(koneplus_class);
585         return retval;
586 }
587
588 static void __exit koneplus_exit(void)
589 {
590         hid_unregister_driver(&koneplus_driver);
591         class_destroy(koneplus_class);
592 }
593
594 module_init(koneplus_init);
595 module_exit(koneplus_exit);
596
597 MODULE_AUTHOR("Stefan Achatz");
598 MODULE_DESCRIPTION("USB Roccat Kone[+]/XTD driver");
599 MODULE_LICENSE("GPL v2");