2 * Roccat Kone driver for Linux
4 * Copyright (c) 2010 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 Kone is a gamer mouse which consists of a mouse part and a keyboard
16 * part. The keyboard part enables the mouse to execute stored macros with mixed
17 * key- and button-events.
19 * TODO implement on-the-fly polling-rate change
20 * The windows driver has the ability to change the polling rate of the
21 * device on the press of a mousebutton.
22 * Is it possible to remove and reinstall the urb in raw-event- or any
23 * other handler, or to defer this action to be executed somewhere else?
25 * TODO is it possible to overwrite group for sysfs attributes via udev?
28 #include <linux/device.h>
29 #include <linux/input.h>
30 #include <linux/hid.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/hid-roccat.h>
35 #include "hid-roccat-common.h"
36 #include "hid-roccat-kone.h"
38 static uint profile_numbers[5] = {0, 1, 2, 3, 4};
40 static void kone_profile_activated(struct kone_device *kone, uint new_profile)
42 kone->actual_profile = new_profile;
43 kone->actual_dpi = kone->profiles[new_profile - 1].startup_dpi;
46 static void kone_profile_report(struct kone_device *kone, uint new_profile)
48 struct kone_roccat_report roccat_report;
49 roccat_report.event = kone_mouse_event_switch_profile;
50 roccat_report.value = new_profile;
51 roccat_report.key = 0;
52 roccat_report_event(kone->chrdev_minor, (uint8_t *)&roccat_report);
55 static int kone_receive(struct usb_device *usb_dev, uint usb_command,
56 void *data, uint size)
61 buf = kmalloc(size, GFP_KERNEL);
65 len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
67 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
68 usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
70 memcpy(data, buf, size);
72 return ((len < 0) ? len : ((len != size) ? -EIO : 0));
75 static int kone_send(struct usb_device *usb_dev, uint usb_command,
76 void const *data, uint size)
81 buf = kmemdup(data, size, GFP_KERNEL);
85 len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
87 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
88 usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
91 return ((len < 0) ? len : ((len != size) ? -EIO : 0));
94 /* kone_class is used for creating sysfs attributes via roccat char device */
95 static struct class *kone_class;
97 static void kone_set_settings_checksum(struct kone_settings *settings)
99 uint16_t checksum = 0;
100 unsigned char *address = (unsigned char *)settings;
103 for (i = 0; i < sizeof(struct kone_settings) - 2; ++i, ++address)
104 checksum += *address;
105 settings->checksum = cpu_to_le16(checksum);
109 * Checks success after writing data to mouse
110 * On success returns 0
111 * On failure returns errno
113 static int kone_check_write(struct usb_device *usb_dev)
120 * Mouse needs 50 msecs until it says ok, but there are
121 * 30 more msecs needed for next write to work.
125 retval = kone_receive(usb_dev,
126 kone_command_confirm_write, &data, 1);
131 * value of 3 seems to mean something like
132 * "not finished yet, but it looks good"
133 * So check again after a moment.
137 if (data == 1) /* everything alright */
141 dev_err(&usb_dev->dev, "got retval %d when checking write\n", data);
146 * Reads settings from mouse and stores it in @buf
147 * On success returns 0
148 * On failure returns errno
150 static int kone_get_settings(struct usb_device *usb_dev,
151 struct kone_settings *buf)
153 return kone_receive(usb_dev, kone_command_settings, buf,
154 sizeof(struct kone_settings));
158 * Writes settings from @buf to mouse
159 * On success returns 0
160 * On failure returns errno
162 static int kone_set_settings(struct usb_device *usb_dev,
163 struct kone_settings const *settings)
166 retval = kone_send(usb_dev, kone_command_settings,
167 settings, sizeof(struct kone_settings));
170 return kone_check_write(usb_dev);
174 * Reads profile data from mouse and stores it in @buf
175 * @number: profile number to read
176 * On success returns 0
177 * On failure returns errno
179 static int kone_get_profile(struct usb_device *usb_dev,
180 struct kone_profile *buf, int number)
184 if (number < 1 || number > 5)
187 len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
188 USB_REQ_CLEAR_FEATURE,
189 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
190 kone_command_profile, number, buf,
191 sizeof(struct kone_profile), USB_CTRL_SET_TIMEOUT);
193 if (len != sizeof(struct kone_profile))
200 * Writes profile data to mouse.
201 * @number: profile number to write
202 * On success returns 0
203 * On failure returns errno
205 static int kone_set_profile(struct usb_device *usb_dev,
206 struct kone_profile const *profile, int number)
210 if (number < 1 || number > 5)
213 len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
214 USB_REQ_SET_CONFIGURATION,
215 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
216 kone_command_profile, number, (void *)profile,
217 sizeof(struct kone_profile),
218 USB_CTRL_SET_TIMEOUT);
220 if (len != sizeof(struct kone_profile))
223 if (kone_check_write(usb_dev))
230 * Reads value of "fast-clip-weight" and stores it in @result
231 * On success returns 0
232 * On failure returns errno
234 static int kone_get_weight(struct usb_device *usb_dev, int *result)
239 retval = kone_receive(usb_dev, kone_command_weight, &data, 1);
249 * Reads firmware_version of mouse and stores it in @result
250 * On success returns 0
251 * On failure returns errno
253 static int kone_get_firmware_version(struct usb_device *usb_dev, int *result)
258 retval = kone_receive(usb_dev, kone_command_firmware_version,
263 *result = le16_to_cpu(data);
267 static ssize_t kone_sysfs_read_settings(struct file *fp, struct kobject *kobj,
268 struct bin_attribute *attr, char *buf,
269 loff_t off, size_t count) {
271 container_of(kobj, struct device, kobj)->parent->parent;
272 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
274 if (off >= sizeof(struct kone_settings))
277 if (off + count > sizeof(struct kone_settings))
278 count = sizeof(struct kone_settings) - off;
280 mutex_lock(&kone->kone_lock);
281 memcpy(buf, ((char const *)&kone->settings) + off, count);
282 mutex_unlock(&kone->kone_lock);
288 * Writing settings automatically activates startup_profile.
289 * This function keeps values in kone_device up to date and assumes that in
290 * case of error the old data is still valid
292 static ssize_t kone_sysfs_write_settings(struct file *fp, struct kobject *kobj,
293 struct bin_attribute *attr, char *buf,
294 loff_t off, size_t count) {
296 container_of(kobj, struct device, kobj)->parent->parent;
297 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
298 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
299 int retval = 0, difference, old_profile;
301 /* I need to get my data in one piece */
302 if (off != 0 || count != sizeof(struct kone_settings))
305 mutex_lock(&kone->kone_lock);
306 difference = memcmp(buf, &kone->settings, sizeof(struct kone_settings));
308 retval = kone_set_settings(usb_dev,
309 (struct kone_settings const *)buf);
311 mutex_unlock(&kone->kone_lock);
315 old_profile = kone->settings.startup_profile;
316 memcpy(&kone->settings, buf, sizeof(struct kone_settings));
318 kone_profile_activated(kone, kone->settings.startup_profile);
320 if (kone->settings.startup_profile != old_profile)
321 kone_profile_report(kone, kone->settings.startup_profile);
323 mutex_unlock(&kone->kone_lock);
325 return sizeof(struct kone_settings);
327 static BIN_ATTR(settings, 0660, kone_sysfs_read_settings,
328 kone_sysfs_write_settings, sizeof(struct kone_settings));
330 static ssize_t kone_sysfs_read_profilex(struct file *fp,
331 struct kobject *kobj, struct bin_attribute *attr,
332 char *buf, loff_t off, size_t count) {
334 container_of(kobj, struct device, kobj)->parent->parent;
335 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
337 if (off >= sizeof(struct kone_profile))
340 if (off + count > sizeof(struct kone_profile))
341 count = sizeof(struct kone_profile) - off;
343 mutex_lock(&kone->kone_lock);
344 memcpy(buf, ((char const *)&kone->profiles[*(uint *)(attr->private)]) + off, count);
345 mutex_unlock(&kone->kone_lock);
350 /* Writes data only if different to stored data */
351 static ssize_t kone_sysfs_write_profilex(struct file *fp,
352 struct kobject *kobj, struct bin_attribute *attr,
353 char *buf, loff_t off, size_t count) {
355 container_of(kobj, struct device, kobj)->parent->parent;
356 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
357 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
358 struct kone_profile *profile;
359 int retval = 0, difference;
361 /* I need to get my data in one piece */
362 if (off != 0 || count != sizeof(struct kone_profile))
365 profile = &kone->profiles[*(uint *)(attr->private)];
367 mutex_lock(&kone->kone_lock);
368 difference = memcmp(buf, profile, sizeof(struct kone_profile));
370 retval = kone_set_profile(usb_dev,
371 (struct kone_profile const *)buf,
372 *(uint *)(attr->private) + 1);
374 memcpy(profile, buf, sizeof(struct kone_profile));
376 mutex_unlock(&kone->kone_lock);
381 return sizeof(struct kone_profile);
383 #define PROFILE_ATTR(number) \
384 static struct bin_attribute bin_attr_profile##number = { \
385 .attr = { .name = "profile##number", .mode = 0660 }, \
386 .size = sizeof(struct kone_profile), \
387 .read = kone_sysfs_read_profilex, \
388 .write = kone_sysfs_write_profilex, \
389 .private = &profile_numbers[number-1], \
397 static ssize_t kone_sysfs_show_actual_profile(struct device *dev,
398 struct device_attribute *attr, char *buf)
400 struct kone_device *kone =
401 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
402 return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_profile);
404 static DEVICE_ATTR(actual_profile, 0440, kone_sysfs_show_actual_profile, NULL);
406 static ssize_t kone_sysfs_show_actual_dpi(struct device *dev,
407 struct device_attribute *attr, char *buf)
409 struct kone_device *kone =
410 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
411 return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_dpi);
413 static DEVICE_ATTR(actual_dpi, 0440, kone_sysfs_show_actual_dpi, NULL);
415 /* weight is read each time, since we don't get informed when it's changed */
416 static ssize_t kone_sysfs_show_weight(struct device *dev,
417 struct device_attribute *attr, char *buf)
419 struct kone_device *kone;
420 struct usb_device *usb_dev;
424 dev = dev->parent->parent;
425 kone = hid_get_drvdata(dev_get_drvdata(dev));
426 usb_dev = interface_to_usbdev(to_usb_interface(dev));
428 mutex_lock(&kone->kone_lock);
429 retval = kone_get_weight(usb_dev, &weight);
430 mutex_unlock(&kone->kone_lock);
434 return snprintf(buf, PAGE_SIZE, "%d\n", weight);
436 static DEVICE_ATTR(weight, 0440, kone_sysfs_show_weight, NULL);
438 static ssize_t kone_sysfs_show_firmware_version(struct device *dev,
439 struct device_attribute *attr, char *buf)
441 struct kone_device *kone =
442 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
443 return snprintf(buf, PAGE_SIZE, "%d\n", kone->firmware_version);
445 static DEVICE_ATTR(firmware_version, 0440, kone_sysfs_show_firmware_version,
448 static ssize_t kone_sysfs_show_tcu(struct device *dev,
449 struct device_attribute *attr, char *buf)
451 struct kone_device *kone =
452 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
453 return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.tcu);
456 static int kone_tcu_command(struct usb_device *usb_dev, int number)
460 return kone_send(usb_dev, kone_command_calibrate, &value, 1);
464 * Calibrating the tcu is the only action that changes settings data inside the
465 * mouse, so this data needs to be reread
467 static ssize_t kone_sysfs_set_tcu(struct device *dev,
468 struct device_attribute *attr, char const *buf, size_t size)
470 struct kone_device *kone;
471 struct usb_device *usb_dev;
475 dev = dev->parent->parent;
476 kone = hid_get_drvdata(dev_get_drvdata(dev));
477 usb_dev = interface_to_usbdev(to_usb_interface(dev));
479 retval = kstrtoul(buf, 10, &state);
483 if (state != 0 && state != 1)
486 mutex_lock(&kone->kone_lock);
488 if (state == 1) { /* state activate */
489 retval = kone_tcu_command(usb_dev, 1);
492 retval = kone_tcu_command(usb_dev, 2);
495 ssleep(5); /* tcu needs this time for calibration */
496 retval = kone_tcu_command(usb_dev, 3);
499 retval = kone_tcu_command(usb_dev, 0);
502 retval = kone_tcu_command(usb_dev, 4);
506 * Kone needs this time to settle things.
507 * Reading settings too early will result in invalid data.
508 * Roccat's driver waits 1 sec, maybe this time could be
514 /* calibration changes values in settings, so reread */
515 retval = kone_get_settings(usb_dev, &kone->settings);
517 goto exit_no_settings;
519 /* only write settings back if activation state is different */
520 if (kone->settings.tcu != state) {
521 kone->settings.tcu = state;
522 kone_set_settings_checksum(&kone->settings);
524 retval = kone_set_settings(usb_dev, &kone->settings);
526 dev_err(&usb_dev->dev, "couldn't set tcu state\n");
528 * try to reread valid settings into buffer overwriting
531 retval = kone_get_settings(usb_dev, &kone->settings);
533 goto exit_no_settings;
536 /* calibration resets profile */
537 kone_profile_activated(kone, kone->settings.startup_profile);
542 dev_err(&usb_dev->dev, "couldn't read settings\n");
544 mutex_unlock(&kone->kone_lock);
547 static DEVICE_ATTR(tcu, 0660, kone_sysfs_show_tcu, kone_sysfs_set_tcu);
549 static ssize_t kone_sysfs_show_startup_profile(struct device *dev,
550 struct device_attribute *attr, char *buf)
552 struct kone_device *kone =
553 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
554 return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.startup_profile);
557 static ssize_t kone_sysfs_set_startup_profile(struct device *dev,
558 struct device_attribute *attr, char const *buf, size_t size)
560 struct kone_device *kone;
561 struct usb_device *usb_dev;
563 unsigned long new_startup_profile;
565 dev = dev->parent->parent;
566 kone = hid_get_drvdata(dev_get_drvdata(dev));
567 usb_dev = interface_to_usbdev(to_usb_interface(dev));
569 retval = kstrtoul(buf, 10, &new_startup_profile);
573 if (new_startup_profile < 1 || new_startup_profile > 5)
576 mutex_lock(&kone->kone_lock);
578 kone->settings.startup_profile = new_startup_profile;
579 kone_set_settings_checksum(&kone->settings);
581 retval = kone_set_settings(usb_dev, &kone->settings);
583 mutex_unlock(&kone->kone_lock);
587 /* changing the startup profile immediately activates this profile */
588 kone_profile_activated(kone, new_startup_profile);
589 kone_profile_report(kone, new_startup_profile);
591 mutex_unlock(&kone->kone_lock);
594 static DEVICE_ATTR(startup_profile, 0660, kone_sysfs_show_startup_profile,
595 kone_sysfs_set_startup_profile);
597 static struct attribute *kone_attrs[] = {
599 * Read actual dpi settings.
600 * Returns raw value for further processing. Refer to enum
601 * kone_polling_rates to get real value.
603 &dev_attr_actual_dpi.attr,
604 &dev_attr_actual_profile.attr,
607 * The mouse can be equipped with one of four supplied weights from 5
608 * to 20 grams which are recognized and its value can be read out.
609 * This returns the raw value reported by the mouse for easy evaluation
610 * by software. Refer to enum kone_weights to get corresponding real
613 &dev_attr_weight.attr,
616 * Prints firmware version stored in mouse as integer.
617 * The raw value reported by the mouse is returned for easy evaluation,
618 * to get the real version number the decimal point has to be shifted 2
619 * positions to the left. E.g. a value of 138 means 1.38.
621 &dev_attr_firmware_version.attr,
624 * Prints state of Tracking Control Unit as number where 0 = off and
625 * 1 = on. Writing 0 deactivates tcu and writing 1 calibrates and
630 /* Prints and takes the number of the profile the mouse starts with */
631 &dev_attr_startup_profile.attr,
635 static struct bin_attribute *kone_bin_attributes[] = {
645 static const struct attribute_group kone_group = {
647 .bin_attrs = kone_bin_attributes,
650 static const struct attribute_group *kone_groups[] = {
655 static int kone_init_kone_device_struct(struct usb_device *usb_dev,
656 struct kone_device *kone)
661 mutex_init(&kone->kone_lock);
663 for (i = 0; i < 5; ++i) {
664 retval = kone_get_profile(usb_dev, &kone->profiles[i], i + 1);
669 retval = kone_get_settings(usb_dev, &kone->settings);
673 retval = kone_get_firmware_version(usb_dev, &kone->firmware_version);
677 kone_profile_activated(kone, kone->settings.startup_profile);
683 * Since IGNORE_MOUSE quirk moved to hid-apple, there is no way to bind only to
684 * mousepart if usb_hid is compiled into the kernel and kone is compiled as
686 * Secial behaviour is bound only to mousepart since only mouseevents contain
687 * additional notifications.
689 static int kone_init_specials(struct hid_device *hdev)
691 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
692 struct usb_device *usb_dev = interface_to_usbdev(intf);
693 struct kone_device *kone;
696 if (intf->cur_altsetting->desc.bInterfaceProtocol
697 == USB_INTERFACE_PROTOCOL_MOUSE) {
699 kone = kzalloc(sizeof(*kone), GFP_KERNEL);
701 hid_err(hdev, "can't alloc device descriptor\n");
704 hid_set_drvdata(hdev, kone);
706 retval = kone_init_kone_device_struct(usb_dev, kone);
708 hid_err(hdev, "couldn't init struct kone_device\n");
712 retval = roccat_connect(kone_class, hdev,
713 sizeof(struct kone_roccat_report));
715 hid_err(hdev, "couldn't init char dev\n");
716 /* be tolerant about not getting chrdev */
718 kone->roccat_claimed = 1;
719 kone->chrdev_minor = retval;
722 hid_set_drvdata(hdev, NULL);
731 static void kone_remove_specials(struct hid_device *hdev)
733 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
734 struct kone_device *kone;
736 if (intf->cur_altsetting->desc.bInterfaceProtocol
737 == USB_INTERFACE_PROTOCOL_MOUSE) {
738 kone = hid_get_drvdata(hdev);
739 if (kone->roccat_claimed)
740 roccat_disconnect(kone->chrdev_minor);
741 kfree(hid_get_drvdata(hdev));
745 static int kone_probe(struct hid_device *hdev, const struct hid_device_id *id)
749 retval = hid_parse(hdev);
751 hid_err(hdev, "parse failed\n");
755 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
757 hid_err(hdev, "hw start failed\n");
761 retval = kone_init_specials(hdev);
763 hid_err(hdev, "couldn't install mouse\n");
775 static void kone_remove(struct hid_device *hdev)
777 kone_remove_specials(hdev);
781 /* handle special events and keep actual profile and dpi values up to date */
782 static void kone_keep_values_up_to_date(struct kone_device *kone,
783 struct kone_mouse_event const *event)
785 switch (event->event) {
786 case kone_mouse_event_switch_profile:
787 kone->actual_dpi = kone->profiles[event->value - 1].
789 case kone_mouse_event_osd_profile:
790 kone->actual_profile = event->value;
792 case kone_mouse_event_switch_dpi:
793 case kone_mouse_event_osd_dpi:
794 kone->actual_dpi = event->value;
799 static void kone_report_to_chrdev(struct kone_device const *kone,
800 struct kone_mouse_event const *event)
802 struct kone_roccat_report roccat_report;
804 switch (event->event) {
805 case kone_mouse_event_switch_profile:
806 case kone_mouse_event_switch_dpi:
807 case kone_mouse_event_osd_profile:
808 case kone_mouse_event_osd_dpi:
809 roccat_report.event = event->event;
810 roccat_report.value = event->value;
811 roccat_report.key = 0;
812 roccat_report_event(kone->chrdev_minor,
813 (uint8_t *)&roccat_report);
815 case kone_mouse_event_call_overlong_macro:
816 case kone_mouse_event_multimedia:
817 if (event->value == kone_keystroke_action_press) {
818 roccat_report.event = event->event;
819 roccat_report.value = kone->actual_profile;
820 roccat_report.key = event->macro_key;
821 roccat_report_event(kone->chrdev_minor,
822 (uint8_t *)&roccat_report);
830 * Is called for keyboard- and mousepart.
831 * Only mousepart gets informations about special events in its extended event
834 static int kone_raw_event(struct hid_device *hdev, struct hid_report *report,
837 struct kone_device *kone = hid_get_drvdata(hdev);
838 struct kone_mouse_event *event = (struct kone_mouse_event *)data;
840 /* keyboard events are always processed by default handler */
841 if (size != sizeof(struct kone_mouse_event))
848 * Firmware 1.38 introduced new behaviour for tilt and special buttons.
849 * Pressed button is reported in each movement event.
850 * Workaround sends only one event per press.
852 if (memcmp(&kone->last_mouse_event.tilt, &event->tilt, 5))
853 memcpy(&kone->last_mouse_event, event,
854 sizeof(struct kone_mouse_event));
856 memset(&event->tilt, 0, 5);
858 kone_keep_values_up_to_date(kone, event);
860 if (kone->roccat_claimed)
861 kone_report_to_chrdev(kone, event);
863 return 0; /* always do further processing */
866 static const struct hid_device_id kone_devices[] = {
867 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONE) },
871 MODULE_DEVICE_TABLE(hid, kone_devices);
873 static struct hid_driver kone_driver = {
875 .id_table = kone_devices,
877 .remove = kone_remove,
878 .raw_event = kone_raw_event
881 static int __init kone_init(void)
885 /* class name has to be same as driver name */
886 kone_class = class_create(THIS_MODULE, "kone");
887 if (IS_ERR(kone_class))
888 return PTR_ERR(kone_class);
889 kone_class->dev_groups = kone_groups;
891 retval = hid_register_driver(&kone_driver);
893 class_destroy(kone_class);
897 static void __exit kone_exit(void)
899 hid_unregister_driver(&kone_driver);
900 class_destroy(kone_class);
903 module_init(kone_init);
904 module_exit(kone_exit);
906 MODULE_AUTHOR("Stefan Achatz");
907 MODULE_DESCRIPTION("USB Roccat Kone driver");
908 MODULE_LICENSE("GPL v2");