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;
50 roccat_report.event = kone_mouse_event_switch_profile;
51 roccat_report.value = new_profile;
52 roccat_report.key = 0;
53 roccat_report_event(kone->chrdev_minor, (uint8_t *)&roccat_report);
56 static int kone_receive(struct usb_device *usb_dev, uint usb_command,
57 void *data, uint size)
62 buf = kmalloc(size, GFP_KERNEL);
66 len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
68 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
69 usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
71 memcpy(data, buf, size);
73 return ((len < 0) ? len : ((len != size) ? -EIO : 0));
76 static int kone_send(struct usb_device *usb_dev, uint usb_command,
77 void const *data, uint size)
82 buf = kmemdup(data, size, GFP_KERNEL);
86 len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
88 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
89 usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
92 return ((len < 0) ? len : ((len != size) ? -EIO : 0));
95 /* kone_class is used for creating sysfs attributes via roccat char device */
96 static struct class *kone_class;
98 static void kone_set_settings_checksum(struct kone_settings *settings)
100 uint16_t checksum = 0;
101 unsigned char *address = (unsigned char *)settings;
104 for (i = 0; i < sizeof(struct kone_settings) - 2; ++i, ++address)
105 checksum += *address;
106 settings->checksum = cpu_to_le16(checksum);
110 * Checks success after writing data to mouse
111 * On success returns 0
112 * On failure returns errno
114 static int kone_check_write(struct usb_device *usb_dev)
121 * Mouse needs 50 msecs until it says ok, but there are
122 * 30 more msecs needed for next write to work.
126 retval = kone_receive(usb_dev,
127 kone_command_confirm_write, &data, 1);
132 * value of 3 seems to mean something like
133 * "not finished yet, but it looks good"
134 * So check again after a moment.
138 if (data == 1) /* everything alright */
142 dev_err(&usb_dev->dev, "got retval %d when checking write\n", data);
147 * Reads settings from mouse and stores it in @buf
148 * On success returns 0
149 * On failure returns errno
151 static int kone_get_settings(struct usb_device *usb_dev,
152 struct kone_settings *buf)
154 return kone_receive(usb_dev, kone_command_settings, buf,
155 sizeof(struct kone_settings));
159 * Writes settings from @buf to mouse
160 * On success returns 0
161 * On failure returns errno
163 static int kone_set_settings(struct usb_device *usb_dev,
164 struct kone_settings const *settings)
168 retval = kone_send(usb_dev, kone_command_settings,
169 settings, sizeof(struct kone_settings));
172 return kone_check_write(usb_dev);
176 * Reads profile data from mouse and stores it in @buf
177 * @number: profile number to read
178 * On success returns 0
179 * On failure returns errno
181 static int kone_get_profile(struct usb_device *usb_dev,
182 struct kone_profile *buf, int number)
186 if (number < 1 || number > 5)
189 len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
190 USB_REQ_CLEAR_FEATURE,
191 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
192 kone_command_profile, number, buf,
193 sizeof(struct kone_profile), USB_CTRL_SET_TIMEOUT);
195 if (len != sizeof(struct kone_profile))
202 * Writes profile data to mouse.
203 * @number: profile number to write
204 * On success returns 0
205 * On failure returns errno
207 static int kone_set_profile(struct usb_device *usb_dev,
208 struct kone_profile const *profile, int number)
212 if (number < 1 || number > 5)
215 len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
216 USB_REQ_SET_CONFIGURATION,
217 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
218 kone_command_profile, number, (void *)profile,
219 sizeof(struct kone_profile),
220 USB_CTRL_SET_TIMEOUT);
222 if (len != sizeof(struct kone_profile))
225 if (kone_check_write(usb_dev))
232 * Reads value of "fast-clip-weight" and stores it in @result
233 * On success returns 0
234 * On failure returns errno
236 static int kone_get_weight(struct usb_device *usb_dev, int *result)
241 retval = kone_receive(usb_dev, kone_command_weight, &data, 1);
251 * Reads firmware_version of mouse and stores it in @result
252 * On success returns 0
253 * On failure returns errno
255 static int kone_get_firmware_version(struct usb_device *usb_dev, int *result)
260 retval = kone_receive(usb_dev, kone_command_firmware_version,
265 *result = le16_to_cpu(data);
269 static ssize_t kone_sysfs_read_settings(struct file *fp, struct kobject *kobj,
270 struct bin_attribute *attr, char *buf,
271 loff_t off, size_t count) {
273 container_of(kobj, struct device, kobj)->parent->parent;
274 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
276 if (off >= sizeof(struct kone_settings))
279 if (off + count > sizeof(struct kone_settings))
280 count = sizeof(struct kone_settings) - off;
282 mutex_lock(&kone->kone_lock);
283 memcpy(buf, ((char const *)&kone->settings) + off, count);
284 mutex_unlock(&kone->kone_lock);
290 * Writing settings automatically activates startup_profile.
291 * This function keeps values in kone_device up to date and assumes that in
292 * case of error the old data is still valid
294 static ssize_t kone_sysfs_write_settings(struct file *fp, struct kobject *kobj,
295 struct bin_attribute *attr, char *buf,
296 loff_t off, size_t count) {
298 container_of(kobj, struct device, kobj)->parent->parent;
299 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
300 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
301 int retval = 0, difference, old_profile;
302 struct kone_settings *settings = (struct kone_settings *)buf;
304 /* I need to get my data in one piece */
305 if (off != 0 || count != sizeof(struct kone_settings))
308 mutex_lock(&kone->kone_lock);
309 difference = memcmp(settings, &kone->settings,
310 sizeof(struct kone_settings));
312 if (settings->startup_profile < 1 ||
313 settings->startup_profile > 5) {
318 retval = kone_set_settings(usb_dev, settings);
322 old_profile = kone->settings.startup_profile;
323 memcpy(&kone->settings, settings, sizeof(struct kone_settings));
325 kone_profile_activated(kone, kone->settings.startup_profile);
327 if (kone->settings.startup_profile != old_profile)
328 kone_profile_report(kone, kone->settings.startup_profile);
331 mutex_unlock(&kone->kone_lock);
336 return sizeof(struct kone_settings);
338 static BIN_ATTR(settings, 0660, kone_sysfs_read_settings,
339 kone_sysfs_write_settings, sizeof(struct kone_settings));
341 static ssize_t kone_sysfs_read_profilex(struct file *fp,
342 struct kobject *kobj, struct bin_attribute *attr,
343 char *buf, loff_t off, size_t count) {
345 container_of(kobj, struct device, kobj)->parent->parent;
346 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
348 if (off >= sizeof(struct kone_profile))
351 if (off + count > sizeof(struct kone_profile))
352 count = sizeof(struct kone_profile) - off;
354 mutex_lock(&kone->kone_lock);
355 memcpy(buf, ((char const *)&kone->profiles[*(uint *)(attr->private)]) + off, count);
356 mutex_unlock(&kone->kone_lock);
361 /* Writes data only if different to stored data */
362 static ssize_t kone_sysfs_write_profilex(struct file *fp,
363 struct kobject *kobj, struct bin_attribute *attr,
364 char *buf, loff_t off, size_t count) {
366 container_of(kobj, struct device, kobj)->parent->parent;
367 struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
368 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
369 struct kone_profile *profile;
370 int retval = 0, difference;
372 /* I need to get my data in one piece */
373 if (off != 0 || count != sizeof(struct kone_profile))
376 profile = &kone->profiles[*(uint *)(attr->private)];
378 mutex_lock(&kone->kone_lock);
379 difference = memcmp(buf, profile, sizeof(struct kone_profile));
381 retval = kone_set_profile(usb_dev,
382 (struct kone_profile const *)buf,
383 *(uint *)(attr->private) + 1);
385 memcpy(profile, buf, sizeof(struct kone_profile));
387 mutex_unlock(&kone->kone_lock);
392 return sizeof(struct kone_profile);
394 #define PROFILE_ATTR(number) \
395 static struct bin_attribute bin_attr_profile##number = { \
396 .attr = { .name = "profile" #number, .mode = 0660 }, \
397 .size = sizeof(struct kone_profile), \
398 .read = kone_sysfs_read_profilex, \
399 .write = kone_sysfs_write_profilex, \
400 .private = &profile_numbers[number-1], \
408 static ssize_t kone_sysfs_show_actual_profile(struct device *dev,
409 struct device_attribute *attr, char *buf)
411 struct kone_device *kone =
412 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
413 return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_profile);
415 static DEVICE_ATTR(actual_profile, 0440, kone_sysfs_show_actual_profile, NULL);
417 static ssize_t kone_sysfs_show_actual_dpi(struct device *dev,
418 struct device_attribute *attr, char *buf)
420 struct kone_device *kone =
421 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
422 return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_dpi);
424 static DEVICE_ATTR(actual_dpi, 0440, kone_sysfs_show_actual_dpi, NULL);
426 /* weight is read each time, since we don't get informed when it's changed */
427 static ssize_t kone_sysfs_show_weight(struct device *dev,
428 struct device_attribute *attr, char *buf)
430 struct kone_device *kone;
431 struct usb_device *usb_dev;
435 dev = dev->parent->parent;
436 kone = hid_get_drvdata(dev_get_drvdata(dev));
437 usb_dev = interface_to_usbdev(to_usb_interface(dev));
439 mutex_lock(&kone->kone_lock);
440 retval = kone_get_weight(usb_dev, &weight);
441 mutex_unlock(&kone->kone_lock);
445 return snprintf(buf, PAGE_SIZE, "%d\n", weight);
447 static DEVICE_ATTR(weight, 0440, kone_sysfs_show_weight, NULL);
449 static ssize_t kone_sysfs_show_firmware_version(struct device *dev,
450 struct device_attribute *attr, char *buf)
452 struct kone_device *kone =
453 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
454 return snprintf(buf, PAGE_SIZE, "%d\n", kone->firmware_version);
456 static DEVICE_ATTR(firmware_version, 0440, kone_sysfs_show_firmware_version,
459 static ssize_t kone_sysfs_show_tcu(struct device *dev,
460 struct device_attribute *attr, char *buf)
462 struct kone_device *kone =
463 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
464 return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.tcu);
467 static int kone_tcu_command(struct usb_device *usb_dev, int number)
472 return kone_send(usb_dev, kone_command_calibrate, &value, 1);
476 * Calibrating the tcu is the only action that changes settings data inside the
477 * mouse, so this data needs to be reread
479 static ssize_t kone_sysfs_set_tcu(struct device *dev,
480 struct device_attribute *attr, char const *buf, size_t size)
482 struct kone_device *kone;
483 struct usb_device *usb_dev;
487 dev = dev->parent->parent;
488 kone = hid_get_drvdata(dev_get_drvdata(dev));
489 usb_dev = interface_to_usbdev(to_usb_interface(dev));
491 retval = kstrtoul(buf, 10, &state);
495 if (state != 0 && state != 1)
498 mutex_lock(&kone->kone_lock);
500 if (state == 1) { /* state activate */
501 retval = kone_tcu_command(usb_dev, 1);
504 retval = kone_tcu_command(usb_dev, 2);
507 ssleep(5); /* tcu needs this time for calibration */
508 retval = kone_tcu_command(usb_dev, 3);
511 retval = kone_tcu_command(usb_dev, 0);
514 retval = kone_tcu_command(usb_dev, 4);
518 * Kone needs this time to settle things.
519 * Reading settings too early will result in invalid data.
520 * Roccat's driver waits 1 sec, maybe this time could be
526 /* calibration changes values in settings, so reread */
527 retval = kone_get_settings(usb_dev, &kone->settings);
529 goto exit_no_settings;
531 /* only write settings back if activation state is different */
532 if (kone->settings.tcu != state) {
533 kone->settings.tcu = state;
534 kone_set_settings_checksum(&kone->settings);
536 retval = kone_set_settings(usb_dev, &kone->settings);
538 dev_err(&usb_dev->dev, "couldn't set tcu state\n");
540 * try to reread valid settings into buffer overwriting
543 retval = kone_get_settings(usb_dev, &kone->settings);
545 goto exit_no_settings;
548 /* calibration resets profile */
549 kone_profile_activated(kone, kone->settings.startup_profile);
554 dev_err(&usb_dev->dev, "couldn't read settings\n");
556 mutex_unlock(&kone->kone_lock);
559 static DEVICE_ATTR(tcu, 0660, kone_sysfs_show_tcu, kone_sysfs_set_tcu);
561 static ssize_t kone_sysfs_show_startup_profile(struct device *dev,
562 struct device_attribute *attr, char *buf)
564 struct kone_device *kone =
565 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
566 return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.startup_profile);
569 static ssize_t kone_sysfs_set_startup_profile(struct device *dev,
570 struct device_attribute *attr, char const *buf, size_t size)
572 struct kone_device *kone;
573 struct usb_device *usb_dev;
575 unsigned long new_startup_profile;
577 dev = dev->parent->parent;
578 kone = hid_get_drvdata(dev_get_drvdata(dev));
579 usb_dev = interface_to_usbdev(to_usb_interface(dev));
581 retval = kstrtoul(buf, 10, &new_startup_profile);
585 if (new_startup_profile < 1 || new_startup_profile > 5)
588 mutex_lock(&kone->kone_lock);
590 kone->settings.startup_profile = new_startup_profile;
591 kone_set_settings_checksum(&kone->settings);
593 retval = kone_set_settings(usb_dev, &kone->settings);
595 mutex_unlock(&kone->kone_lock);
599 /* changing the startup profile immediately activates this profile */
600 kone_profile_activated(kone, new_startup_profile);
601 kone_profile_report(kone, new_startup_profile);
603 mutex_unlock(&kone->kone_lock);
606 static DEVICE_ATTR(startup_profile, 0660, kone_sysfs_show_startup_profile,
607 kone_sysfs_set_startup_profile);
609 static struct attribute *kone_attrs[] = {
611 * Read actual dpi settings.
612 * Returns raw value for further processing. Refer to enum
613 * kone_polling_rates to get real value.
615 &dev_attr_actual_dpi.attr,
616 &dev_attr_actual_profile.attr,
619 * The mouse can be equipped with one of four supplied weights from 5
620 * to 20 grams which are recognized and its value can be read out.
621 * This returns the raw value reported by the mouse for easy evaluation
622 * by software. Refer to enum kone_weights to get corresponding real
625 &dev_attr_weight.attr,
628 * Prints firmware version stored in mouse as integer.
629 * The raw value reported by the mouse is returned for easy evaluation,
630 * to get the real version number the decimal point has to be shifted 2
631 * positions to the left. E.g. a value of 138 means 1.38.
633 &dev_attr_firmware_version.attr,
636 * Prints state of Tracking Control Unit as number where 0 = off and
637 * 1 = on. Writing 0 deactivates tcu and writing 1 calibrates and
642 /* Prints and takes the number of the profile the mouse starts with */
643 &dev_attr_startup_profile.attr,
647 static struct bin_attribute *kone_bin_attributes[] = {
657 static const struct attribute_group kone_group = {
659 .bin_attrs = kone_bin_attributes,
662 static const struct attribute_group *kone_groups[] = {
667 static int kone_init_kone_device_struct(struct usb_device *usb_dev,
668 struct kone_device *kone)
673 mutex_init(&kone->kone_lock);
675 for (i = 0; i < 5; ++i) {
676 retval = kone_get_profile(usb_dev, &kone->profiles[i], i + 1);
681 retval = kone_get_settings(usb_dev, &kone->settings);
685 retval = kone_get_firmware_version(usb_dev, &kone->firmware_version);
689 kone_profile_activated(kone, kone->settings.startup_profile);
695 * Since IGNORE_MOUSE quirk moved to hid-apple, there is no way to bind only to
696 * mousepart if usb_hid is compiled into the kernel and kone is compiled as
698 * Secial behaviour is bound only to mousepart since only mouseevents contain
699 * additional notifications.
701 static int kone_init_specials(struct hid_device *hdev)
703 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
704 struct usb_device *usb_dev = interface_to_usbdev(intf);
705 struct kone_device *kone;
708 if (intf->cur_altsetting->desc.bInterfaceProtocol
709 == USB_INTERFACE_PROTOCOL_MOUSE) {
711 kone = kzalloc(sizeof(*kone), GFP_KERNEL);
714 hid_set_drvdata(hdev, kone);
716 retval = kone_init_kone_device_struct(usb_dev, kone);
718 hid_err(hdev, "couldn't init struct kone_device\n");
722 retval = roccat_connect(kone_class, hdev,
723 sizeof(struct kone_roccat_report));
725 hid_err(hdev, "couldn't init char dev\n");
726 /* be tolerant about not getting chrdev */
728 kone->roccat_claimed = 1;
729 kone->chrdev_minor = retval;
732 hid_set_drvdata(hdev, NULL);
741 static void kone_remove_specials(struct hid_device *hdev)
743 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
744 struct kone_device *kone;
746 if (intf->cur_altsetting->desc.bInterfaceProtocol
747 == USB_INTERFACE_PROTOCOL_MOUSE) {
748 kone = hid_get_drvdata(hdev);
749 if (kone->roccat_claimed)
750 roccat_disconnect(kone->chrdev_minor);
751 kfree(hid_get_drvdata(hdev));
755 static int kone_probe(struct hid_device *hdev, const struct hid_device_id *id)
759 retval = hid_parse(hdev);
761 hid_err(hdev, "parse failed\n");
765 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
767 hid_err(hdev, "hw start failed\n");
771 retval = kone_init_specials(hdev);
773 hid_err(hdev, "couldn't install mouse\n");
785 static void kone_remove(struct hid_device *hdev)
787 kone_remove_specials(hdev);
791 /* handle special events and keep actual profile and dpi values up to date */
792 static void kone_keep_values_up_to_date(struct kone_device *kone,
793 struct kone_mouse_event const *event)
795 switch (event->event) {
796 case kone_mouse_event_switch_profile:
797 kone->actual_dpi = kone->profiles[event->value - 1].
799 case kone_mouse_event_osd_profile:
800 kone->actual_profile = event->value;
802 case kone_mouse_event_switch_dpi:
803 case kone_mouse_event_osd_dpi:
804 kone->actual_dpi = event->value;
809 static void kone_report_to_chrdev(struct kone_device const *kone,
810 struct kone_mouse_event const *event)
812 struct kone_roccat_report roccat_report;
814 switch (event->event) {
815 case kone_mouse_event_switch_profile:
816 case kone_mouse_event_switch_dpi:
817 case kone_mouse_event_osd_profile:
818 case kone_mouse_event_osd_dpi:
819 roccat_report.event = event->event;
820 roccat_report.value = event->value;
821 roccat_report.key = 0;
822 roccat_report_event(kone->chrdev_minor,
823 (uint8_t *)&roccat_report);
825 case kone_mouse_event_call_overlong_macro:
826 case kone_mouse_event_multimedia:
827 if (event->value == kone_keystroke_action_press) {
828 roccat_report.event = event->event;
829 roccat_report.value = kone->actual_profile;
830 roccat_report.key = event->macro_key;
831 roccat_report_event(kone->chrdev_minor,
832 (uint8_t *)&roccat_report);
840 * Is called for keyboard- and mousepart.
841 * Only mousepart gets informations about special events in its extended event
844 static int kone_raw_event(struct hid_device *hdev, struct hid_report *report,
847 struct kone_device *kone = hid_get_drvdata(hdev);
848 struct kone_mouse_event *event = (struct kone_mouse_event *)data;
850 /* keyboard events are always processed by default handler */
851 if (size != sizeof(struct kone_mouse_event))
858 * Firmware 1.38 introduced new behaviour for tilt and special buttons.
859 * Pressed button is reported in each movement event.
860 * Workaround sends only one event per press.
862 if (memcmp(&kone->last_mouse_event.tilt, &event->tilt, 5))
863 memcpy(&kone->last_mouse_event, event,
864 sizeof(struct kone_mouse_event));
866 memset(&event->tilt, 0, 5);
868 kone_keep_values_up_to_date(kone, event);
870 if (kone->roccat_claimed)
871 kone_report_to_chrdev(kone, event);
873 return 0; /* always do further processing */
876 static const struct hid_device_id kone_devices[] = {
877 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONE) },
881 MODULE_DEVICE_TABLE(hid, kone_devices);
883 static struct hid_driver kone_driver = {
885 .id_table = kone_devices,
887 .remove = kone_remove,
888 .raw_event = kone_raw_event
891 static int __init kone_init(void)
895 /* class name has to be same as driver name */
896 kone_class = class_create(THIS_MODULE, "kone");
897 if (IS_ERR(kone_class))
898 return PTR_ERR(kone_class);
899 kone_class->dev_groups = kone_groups;
901 retval = hid_register_driver(&kone_driver);
903 class_destroy(kone_class);
907 static void __exit kone_exit(void)
909 hid_unregister_driver(&kone_driver);
910 class_destroy(kone_class);
913 module_init(kone_init);
914 module_exit(kone_exit);
916 MODULE_AUTHOR("Stefan Achatz");
917 MODULE_DESCRIPTION("USB Roccat Kone driver");
918 MODULE_LICENSE("GPL v2");