2 * Roccat Kova[+] driver for Linux
4 * Copyright (c) 2011 Stefan Achatz <erazor_de@users.sourceforge.net>
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)
15 * Roccat Kova[+] is a bigger version of the Pyra with two more side buttons.
18 #include <linux/device.h>
19 #include <linux/input.h>
20 #include <linux/hid.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/hid-roccat.h>
25 #include "hid-roccat-common.h"
26 #include "hid-roccat-kovaplus.h"
28 static uint profile_numbers[5] = {0, 1, 2, 3, 4};
30 static struct class *kovaplus_class;
32 static uint kovaplus_convert_event_cpi(uint value)
34 return (value == 7 ? 4 : (value == 4 ? 3 : value));
37 static void kovaplus_profile_activated(struct kovaplus_device *kovaplus,
38 uint new_profile_index)
40 kovaplus->actual_profile = new_profile_index;
41 kovaplus->actual_cpi = kovaplus->profile_settings[new_profile_index].cpi_startup_level;
42 kovaplus->actual_x_sensitivity = kovaplus->profile_settings[new_profile_index].sensitivity_x;
43 kovaplus->actual_y_sensitivity = kovaplus->profile_settings[new_profile_index].sensitivity_y;
46 static int kovaplus_send_control(struct usb_device *usb_dev, uint value,
47 enum kovaplus_control_requests request)
50 struct roccat_common2_control control;
52 if ((request == KOVAPLUS_CONTROL_REQUEST_PROFILE_SETTINGS ||
53 request == KOVAPLUS_CONTROL_REQUEST_PROFILE_BUTTONS) &&
57 control.command = ROCCAT_COMMON_COMMAND_CONTROL;
58 control.value = value;
59 control.request = request;
61 retval = roccat_common2_send(usb_dev, ROCCAT_COMMON_COMMAND_CONTROL,
62 &control, sizeof(struct roccat_common2_control));
67 static int kovaplus_select_profile(struct usb_device *usb_dev, uint number,
68 enum kovaplus_control_requests request)
70 return kovaplus_send_control(usb_dev, number, request);
73 static int kovaplus_get_profile_settings(struct usb_device *usb_dev,
74 struct kovaplus_profile_settings *buf, uint number)
78 retval = kovaplus_select_profile(usb_dev, number,
79 KOVAPLUS_CONTROL_REQUEST_PROFILE_SETTINGS);
83 return roccat_common2_receive(usb_dev, KOVAPLUS_COMMAND_PROFILE_SETTINGS,
84 buf, KOVAPLUS_SIZE_PROFILE_SETTINGS);
87 static int kovaplus_get_profile_buttons(struct usb_device *usb_dev,
88 struct kovaplus_profile_buttons *buf, int number)
92 retval = kovaplus_select_profile(usb_dev, number,
93 KOVAPLUS_CONTROL_REQUEST_PROFILE_BUTTONS);
97 return roccat_common2_receive(usb_dev, KOVAPLUS_COMMAND_PROFILE_BUTTONS,
98 buf, KOVAPLUS_SIZE_PROFILE_BUTTONS);
101 /* retval is 0-4 on success, < 0 on error */
102 static int kovaplus_get_actual_profile(struct usb_device *usb_dev)
104 struct kovaplus_actual_profile buf;
107 retval = roccat_common2_receive(usb_dev, KOVAPLUS_COMMAND_ACTUAL_PROFILE,
108 &buf, sizeof(struct kovaplus_actual_profile));
110 return retval ? retval : buf.actual_profile;
113 static int kovaplus_set_actual_profile(struct usb_device *usb_dev,
116 struct kovaplus_actual_profile buf;
118 buf.command = KOVAPLUS_COMMAND_ACTUAL_PROFILE;
119 buf.size = sizeof(struct kovaplus_actual_profile);
120 buf.actual_profile = new_profile;
122 return roccat_common2_send_with_status(usb_dev,
123 KOVAPLUS_COMMAND_ACTUAL_PROFILE,
124 &buf, sizeof(struct kovaplus_actual_profile));
127 static ssize_t kovaplus_sysfs_read(struct file *fp, struct kobject *kobj,
128 char *buf, loff_t off, size_t count,
129 size_t real_size, uint command)
132 container_of(kobj, struct device, kobj)->parent->parent;
133 struct kovaplus_device *kovaplus = hid_get_drvdata(dev_get_drvdata(dev));
134 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
137 if (off >= real_size)
140 if (off != 0 || count != real_size)
143 mutex_lock(&kovaplus->kovaplus_lock);
144 retval = roccat_common2_receive(usb_dev, command, buf, real_size);
145 mutex_unlock(&kovaplus->kovaplus_lock);
153 static ssize_t kovaplus_sysfs_write(struct file *fp, struct kobject *kobj,
154 void const *buf, loff_t off, size_t count,
155 size_t real_size, uint command)
158 container_of(kobj, struct device, kobj)->parent->parent;
159 struct kovaplus_device *kovaplus = hid_get_drvdata(dev_get_drvdata(dev));
160 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
163 if (off != 0 || count != real_size)
166 mutex_lock(&kovaplus->kovaplus_lock);
167 retval = roccat_common2_send_with_status(usb_dev, command,
169 mutex_unlock(&kovaplus->kovaplus_lock);
177 #define KOVAPLUS_SYSFS_W(thingy, THINGY) \
178 static ssize_t kovaplus_sysfs_write_ ## thingy(struct file *fp, \
179 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
180 loff_t off, size_t count) \
182 return kovaplus_sysfs_write(fp, kobj, buf, off, count, \
183 KOVAPLUS_SIZE_ ## THINGY, KOVAPLUS_COMMAND_ ## THINGY); \
186 #define KOVAPLUS_SYSFS_R(thingy, THINGY) \
187 static ssize_t kovaplus_sysfs_read_ ## thingy(struct file *fp, \
188 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
189 loff_t off, size_t count) \
191 return kovaplus_sysfs_read(fp, kobj, buf, off, count, \
192 KOVAPLUS_SIZE_ ## THINGY, KOVAPLUS_COMMAND_ ## THINGY); \
195 #define KOVAPLUS_SYSFS_RW(thingy, THINGY) \
196 KOVAPLUS_SYSFS_W(thingy, THINGY) \
197 KOVAPLUS_SYSFS_R(thingy, THINGY)
199 #define KOVAPLUS_BIN_ATTRIBUTE_RW(thingy, THINGY) \
201 .attr = { .name = #thingy, .mode = 0660 }, \
202 .size = KOVAPLUS_SIZE_ ## THINGY, \
203 .read = kovaplus_sysfs_read_ ## thingy, \
204 .write = kovaplus_sysfs_write_ ## thingy \
207 #define KOVAPLUS_BIN_ATTRIBUTE_R(thingy, THINGY) \
209 .attr = { .name = #thingy, .mode = 0440 }, \
210 .size = KOVAPLUS_SIZE_ ## THINGY, \
211 .read = kovaplus_sysfs_read_ ## thingy, \
214 #define KOVAPLUS_BIN_ATTRIBUTE_W(thingy, THINGY) \
216 .attr = { .name = #thingy, .mode = 0220 }, \
217 .size = KOVAPLUS_SIZE_ ## THINGY, \
218 .write = kovaplus_sysfs_write_ ## thingy \
221 KOVAPLUS_SYSFS_W(control, CONTROL)
222 KOVAPLUS_SYSFS_RW(info, INFO)
223 KOVAPLUS_SYSFS_RW(profile_settings, PROFILE_SETTINGS)
224 KOVAPLUS_SYSFS_RW(profile_buttons, PROFILE_BUTTONS)
226 static ssize_t kovaplus_sysfs_read_profilex_settings(struct file *fp,
227 struct kobject *kobj, struct bin_attribute *attr, char *buf,
228 loff_t off, size_t count)
231 container_of(kobj, struct device, kobj)->parent->parent;
232 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
235 retval = kovaplus_select_profile(usb_dev, *(uint *)(attr->private),
236 KOVAPLUS_CONTROL_REQUEST_PROFILE_SETTINGS);
240 return kovaplus_sysfs_read(fp, kobj, buf, off, count,
241 KOVAPLUS_SIZE_PROFILE_SETTINGS,
242 KOVAPLUS_COMMAND_PROFILE_SETTINGS);
245 static ssize_t kovaplus_sysfs_read_profilex_buttons(struct file *fp,
246 struct kobject *kobj, struct bin_attribute *attr, char *buf,
247 loff_t off, size_t count)
250 container_of(kobj, struct device, kobj)->parent->parent;
251 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
254 retval = kovaplus_select_profile(usb_dev, *(uint *)(attr->private),
255 KOVAPLUS_CONTROL_REQUEST_PROFILE_BUTTONS);
259 return kovaplus_sysfs_read(fp, kobj, buf, off, count,
260 KOVAPLUS_SIZE_PROFILE_BUTTONS,
261 KOVAPLUS_COMMAND_PROFILE_BUTTONS);
264 static ssize_t kovaplus_sysfs_show_actual_profile(struct device *dev,
265 struct device_attribute *attr, char *buf)
267 struct kovaplus_device *kovaplus =
268 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
269 return snprintf(buf, PAGE_SIZE, "%d\n", kovaplus->actual_profile);
272 static ssize_t kovaplus_sysfs_set_actual_profile(struct device *dev,
273 struct device_attribute *attr, char const *buf, size_t size)
275 struct kovaplus_device *kovaplus;
276 struct usb_device *usb_dev;
277 unsigned long profile;
279 struct kovaplus_roccat_report roccat_report;
281 dev = dev->parent->parent;
282 kovaplus = hid_get_drvdata(dev_get_drvdata(dev));
283 usb_dev = interface_to_usbdev(to_usb_interface(dev));
285 retval = strict_strtoul(buf, 10, &profile);
292 mutex_lock(&kovaplus->kovaplus_lock);
293 retval = kovaplus_set_actual_profile(usb_dev, profile);
295 mutex_unlock(&kovaplus->kovaplus_lock);
299 kovaplus_profile_activated(kovaplus, profile);
301 roccat_report.type = KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE_1;
302 roccat_report.profile = profile + 1;
303 roccat_report.button = 0;
304 roccat_report.data1 = profile + 1;
305 roccat_report.data2 = 0;
306 roccat_report_event(kovaplus->chrdev_minor,
307 (uint8_t const *)&roccat_report);
309 mutex_unlock(&kovaplus->kovaplus_lock);
313 static DEVICE_ATTR(actual_profile, 0660,
314 kovaplus_sysfs_show_actual_profile,
315 kovaplus_sysfs_set_actual_profile);
317 static ssize_t kovaplus_sysfs_show_actual_cpi(struct device *dev,
318 struct device_attribute *attr, char *buf)
320 struct kovaplus_device *kovaplus =
321 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
322 return snprintf(buf, PAGE_SIZE, "%d\n", kovaplus->actual_cpi);
324 static DEVICE_ATTR(actual_cpi, 0440, kovaplus_sysfs_show_actual_cpi, NULL);
326 static ssize_t kovaplus_sysfs_show_actual_sensitivity_x(struct device *dev,
327 struct device_attribute *attr, char *buf)
329 struct kovaplus_device *kovaplus =
330 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
331 return snprintf(buf, PAGE_SIZE, "%d\n", kovaplus->actual_x_sensitivity);
333 static DEVICE_ATTR(actual_sensitivity_x, 0440,
334 kovaplus_sysfs_show_actual_sensitivity_x, NULL);
336 static ssize_t kovaplus_sysfs_show_actual_sensitivity_y(struct device *dev,
337 struct device_attribute *attr, char *buf)
339 struct kovaplus_device *kovaplus =
340 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
341 return snprintf(buf, PAGE_SIZE, "%d\n", kovaplus->actual_y_sensitivity);
343 static DEVICE_ATTR(actual_sensitivity_y, 0440,
344 kovaplus_sysfs_show_actual_sensitivity_y, NULL);
346 static ssize_t kovaplus_sysfs_show_firmware_version(struct device *dev,
347 struct device_attribute *attr, char *buf)
349 struct kovaplus_device *kovaplus;
350 struct usb_device *usb_dev;
351 struct kovaplus_info info;
353 dev = dev->parent->parent;
354 kovaplus = hid_get_drvdata(dev_get_drvdata(dev));
355 usb_dev = interface_to_usbdev(to_usb_interface(dev));
357 mutex_lock(&kovaplus->kovaplus_lock);
358 roccat_common2_receive(usb_dev, KOVAPLUS_COMMAND_INFO,
359 &info, KOVAPLUS_SIZE_INFO);
360 mutex_unlock(&kovaplus->kovaplus_lock);
362 return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
364 static DEVICE_ATTR(firmware_version, 0440,
365 kovaplus_sysfs_show_firmware_version, NULL);
367 static struct attribute *kovaplus_attrs[] = {
368 &dev_attr_actual_cpi.attr,
369 &dev_attr_firmware_version.attr,
370 &dev_attr_actual_profile.attr,
371 &dev_attr_actual_sensitivity_x.attr,
372 &dev_attr_actual_sensitivity_y.attr,
375 ATTRIBUTE_GROUPS(kovaplus);
377 static struct bin_attribute kovaplus_bin_attributes[] = {
378 KOVAPLUS_BIN_ATTRIBUTE_W(control, CONTROL),
379 KOVAPLUS_BIN_ATTRIBUTE_RW(info, INFO),
380 KOVAPLUS_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS),
381 KOVAPLUS_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS),
383 .attr = { .name = "profile1_settings", .mode = 0440 },
384 .size = KOVAPLUS_SIZE_PROFILE_SETTINGS,
385 .read = kovaplus_sysfs_read_profilex_settings,
386 .private = &profile_numbers[0]
389 .attr = { .name = "profile2_settings", .mode = 0440 },
390 .size = KOVAPLUS_SIZE_PROFILE_SETTINGS,
391 .read = kovaplus_sysfs_read_profilex_settings,
392 .private = &profile_numbers[1]
395 .attr = { .name = "profile3_settings", .mode = 0440 },
396 .size = KOVAPLUS_SIZE_PROFILE_SETTINGS,
397 .read = kovaplus_sysfs_read_profilex_settings,
398 .private = &profile_numbers[2]
401 .attr = { .name = "profile4_settings", .mode = 0440 },
402 .size = KOVAPLUS_SIZE_PROFILE_SETTINGS,
403 .read = kovaplus_sysfs_read_profilex_settings,
404 .private = &profile_numbers[3]
407 .attr = { .name = "profile5_settings", .mode = 0440 },
408 .size = KOVAPLUS_SIZE_PROFILE_SETTINGS,
409 .read = kovaplus_sysfs_read_profilex_settings,
410 .private = &profile_numbers[4]
413 .attr = { .name = "profile1_buttons", .mode = 0440 },
414 .size = KOVAPLUS_SIZE_PROFILE_BUTTONS,
415 .read = kovaplus_sysfs_read_profilex_buttons,
416 .private = &profile_numbers[0]
419 .attr = { .name = "profile2_buttons", .mode = 0440 },
420 .size = KOVAPLUS_SIZE_PROFILE_BUTTONS,
421 .read = kovaplus_sysfs_read_profilex_buttons,
422 .private = &profile_numbers[1]
425 .attr = { .name = "profile3_buttons", .mode = 0440 },
426 .size = KOVAPLUS_SIZE_PROFILE_BUTTONS,
427 .read = kovaplus_sysfs_read_profilex_buttons,
428 .private = &profile_numbers[2]
431 .attr = { .name = "profile4_buttons", .mode = 0440 },
432 .size = KOVAPLUS_SIZE_PROFILE_BUTTONS,
433 .read = kovaplus_sysfs_read_profilex_buttons,
434 .private = &profile_numbers[3]
437 .attr = { .name = "profile5_buttons", .mode = 0440 },
438 .size = KOVAPLUS_SIZE_PROFILE_BUTTONS,
439 .read = kovaplus_sysfs_read_profilex_buttons,
440 .private = &profile_numbers[4]
445 static int kovaplus_init_kovaplus_device_struct(struct usb_device *usb_dev,
446 struct kovaplus_device *kovaplus)
449 static uint wait = 70; /* device will freeze with just 60 */
451 mutex_init(&kovaplus->kovaplus_lock);
453 for (i = 0; i < 5; ++i) {
455 retval = kovaplus_get_profile_settings(usb_dev,
456 &kovaplus->profile_settings[i], i);
461 retval = kovaplus_get_profile_buttons(usb_dev,
462 &kovaplus->profile_buttons[i], i);
468 retval = kovaplus_get_actual_profile(usb_dev);
471 kovaplus_profile_activated(kovaplus, retval);
476 static int kovaplus_init_specials(struct hid_device *hdev)
478 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
479 struct usb_device *usb_dev = interface_to_usbdev(intf);
480 struct kovaplus_device *kovaplus;
483 if (intf->cur_altsetting->desc.bInterfaceProtocol
484 == USB_INTERFACE_PROTOCOL_MOUSE) {
486 kovaplus = kzalloc(sizeof(*kovaplus), GFP_KERNEL);
488 hid_err(hdev, "can't alloc device descriptor\n");
491 hid_set_drvdata(hdev, kovaplus);
493 retval = kovaplus_init_kovaplus_device_struct(usb_dev, kovaplus);
495 hid_err(hdev, "couldn't init struct kovaplus_device\n");
499 retval = roccat_connect(kovaplus_class, hdev,
500 sizeof(struct kovaplus_roccat_report));
502 hid_err(hdev, "couldn't init char dev\n");
504 kovaplus->chrdev_minor = retval;
505 kovaplus->roccat_claimed = 1;
509 hid_set_drvdata(hdev, NULL);
518 static void kovaplus_remove_specials(struct hid_device *hdev)
520 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
521 struct kovaplus_device *kovaplus;
523 if (intf->cur_altsetting->desc.bInterfaceProtocol
524 == USB_INTERFACE_PROTOCOL_MOUSE) {
525 kovaplus = hid_get_drvdata(hdev);
526 if (kovaplus->roccat_claimed)
527 roccat_disconnect(kovaplus->chrdev_minor);
532 static int kovaplus_probe(struct hid_device *hdev,
533 const struct hid_device_id *id)
537 retval = hid_parse(hdev);
539 hid_err(hdev, "parse failed\n");
543 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
545 hid_err(hdev, "hw start failed\n");
549 retval = kovaplus_init_specials(hdev);
551 hid_err(hdev, "couldn't install mouse\n");
563 static void kovaplus_remove(struct hid_device *hdev)
565 kovaplus_remove_specials(hdev);
569 static void kovaplus_keep_values_up_to_date(struct kovaplus_device *kovaplus,
572 struct kovaplus_mouse_report_button const *button_report;
574 if (data[0] != KOVAPLUS_MOUSE_REPORT_NUMBER_BUTTON)
577 button_report = (struct kovaplus_mouse_report_button const *)data;
579 switch (button_report->type) {
580 case KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE_1:
581 kovaplus_profile_activated(kovaplus, button_report->data1 - 1);
583 case KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_CPI:
584 kovaplus->actual_cpi = kovaplus_convert_event_cpi(button_report->data1);
585 case KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_SENSITIVITY:
586 kovaplus->actual_x_sensitivity = button_report->data1;
587 kovaplus->actual_y_sensitivity = button_report->data2;
591 static void kovaplus_report_to_chrdev(struct kovaplus_device const *kovaplus,
594 struct kovaplus_roccat_report roccat_report;
595 struct kovaplus_mouse_report_button const *button_report;
597 if (data[0] != KOVAPLUS_MOUSE_REPORT_NUMBER_BUTTON)
600 button_report = (struct kovaplus_mouse_report_button const *)data;
602 if (button_report->type == KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE_2)
605 roccat_report.type = button_report->type;
606 roccat_report.profile = kovaplus->actual_profile + 1;
608 if (roccat_report.type == KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_MACRO ||
609 roccat_report.type == KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_SHORTCUT ||
610 roccat_report.type == KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH ||
611 roccat_report.type == KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER)
612 roccat_report.button = button_report->data1;
614 roccat_report.button = 0;
616 if (roccat_report.type == KOVAPLUS_MOUSE_REPORT_BUTTON_TYPE_CPI)
617 roccat_report.data1 = kovaplus_convert_event_cpi(button_report->data1);
619 roccat_report.data1 = button_report->data1;
621 roccat_report.data2 = button_report->data2;
623 roccat_report_event(kovaplus->chrdev_minor,
624 (uint8_t const *)&roccat_report);
627 static int kovaplus_raw_event(struct hid_device *hdev,
628 struct hid_report *report, u8 *data, int size)
630 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
631 struct kovaplus_device *kovaplus = hid_get_drvdata(hdev);
633 if (intf->cur_altsetting->desc.bInterfaceProtocol
634 != USB_INTERFACE_PROTOCOL_MOUSE)
637 if (kovaplus == NULL)
640 kovaplus_keep_values_up_to_date(kovaplus, data);
642 if (kovaplus->roccat_claimed)
643 kovaplus_report_to_chrdev(kovaplus, data);
648 static const struct hid_device_id kovaplus_devices[] = {
649 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KOVAPLUS) },
653 MODULE_DEVICE_TABLE(hid, kovaplus_devices);
655 static struct hid_driver kovaplus_driver = {
657 .id_table = kovaplus_devices,
658 .probe = kovaplus_probe,
659 .remove = kovaplus_remove,
660 .raw_event = kovaplus_raw_event
663 static int __init kovaplus_init(void)
667 kovaplus_class = class_create(THIS_MODULE, "kovaplus");
668 if (IS_ERR(kovaplus_class))
669 return PTR_ERR(kovaplus_class);
670 kovaplus_class->dev_groups = kovaplus_groups;
671 kovaplus_class->dev_bin_attrs = kovaplus_bin_attributes;
673 retval = hid_register_driver(&kovaplus_driver);
675 class_destroy(kovaplus_class);
679 static void __exit kovaplus_exit(void)
681 hid_unregister_driver(&kovaplus_driver);
682 class_destroy(kovaplus_class);
685 module_init(kovaplus_init);
686 module_exit(kovaplus_exit);
688 MODULE_AUTHOR("Stefan Achatz");
689 MODULE_DESCRIPTION("USB Roccat Kova[+] driver");
690 MODULE_LICENSE("GPL v2");