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 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.
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>
27 #include "hid-roccat-common.h"
28 #include "hid-roccat-koneplus.h"
30 static uint profile_numbers[5] = {0, 1, 2, 3, 4};
32 static struct class *koneplus_class;
34 static void koneplus_profile_activated(struct koneplus_device *koneplus,
37 koneplus->actual_profile = new_profile;
40 static int koneplus_send_control(struct usb_device *usb_dev, uint value,
41 enum koneplus_control_requests request)
43 struct roccat_common2_control control;
45 if ((request == KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS ||
46 request == KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS) &&
50 control.command = ROCCAT_COMMON_COMMAND_CONTROL;
51 control.value = value;
52 control.request = request;
54 return roccat_common2_send_with_status(usb_dev,
55 ROCCAT_COMMON_COMMAND_CONTROL,
56 &control, sizeof(struct roccat_common2_control));
60 /* retval is 0-4 on success, < 0 on error */
61 static int koneplus_get_actual_profile(struct usb_device *usb_dev)
63 struct koneplus_actual_profile buf;
66 retval = roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_ACTUAL_PROFILE,
67 &buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
69 return retval ? retval : buf.actual_profile;
72 static int koneplus_set_actual_profile(struct usb_device *usb_dev,
75 struct koneplus_actual_profile buf;
77 buf.command = KONEPLUS_COMMAND_ACTUAL_PROFILE;
78 buf.size = KONEPLUS_SIZE_ACTUAL_PROFILE;
79 buf.actual_profile = new_profile;
81 return roccat_common2_send_with_status(usb_dev,
82 KONEPLUS_COMMAND_ACTUAL_PROFILE,
83 &buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
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)
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));
99 if (off != 0 || count != real_size)
102 mutex_lock(&koneplus->koneplus_lock);
103 retval = roccat_common2_receive(usb_dev, command, buf, real_size);
104 mutex_unlock(&koneplus->koneplus_lock);
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)
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));
122 if (off != 0 || count != real_size)
125 mutex_lock(&koneplus->koneplus_lock);
126 retval = roccat_common2_send_with_status(usb_dev, command,
128 mutex_unlock(&koneplus->koneplus_lock);
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) \
141 return koneplus_sysfs_write(fp, kobj, buf, off, count, \
142 KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
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) \
150 return koneplus_sysfs_read(fp, kobj, buf, off, count, \
151 KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
154 #define KONEPLUS_SYSFS_RW(thingy, THINGY) \
155 KONEPLUS_SYSFS_W(thingy, THINGY) \
156 KONEPLUS_SYSFS_R(thingy, THINGY)
158 #define KONEPLUS_BIN_ATTRIBUTE_RW(thingy, THINGY) \
159 KONEPLUS_SYSFS_RW(thingy, THINGY); \
160 static struct bin_attribute bin_attr_##thingy = { \
161 .attr = { .name = #thingy, .mode = 0660 }, \
162 .size = KONEPLUS_SIZE_ ## THINGY, \
163 .read = koneplus_sysfs_read_ ## thingy, \
164 .write = koneplus_sysfs_write_ ## thingy \
167 #define KONEPLUS_BIN_ATTRIBUTE_R(thingy, THINGY) \
168 KONEPLUS_SYSFS_R(thingy, THINGY); \
169 static struct bin_attribute bin_attr_##thingy = { \
170 .attr = { .name = #thingy, .mode = 0440 }, \
171 .size = KONEPLUS_SIZE_ ## THINGY, \
172 .read = koneplus_sysfs_read_ ## thingy, \
175 #define KONEPLUS_BIN_ATTRIBUTE_W(thingy, THINGY) \
176 KONEPLUS_SYSFS_W(thingy, THINGY); \
177 static struct bin_attribute bin_attr_##thingy = { \
178 .attr = { .name = #thingy, .mode = 0220 }, \
179 .size = KONEPLUS_SIZE_ ## THINGY, \
180 .write = koneplus_sysfs_write_ ## thingy \
182 KONEPLUS_BIN_ATTRIBUTE_W(control, CONTROL);
183 KONEPLUS_BIN_ATTRIBUTE_W(talk, TALK);
184 KONEPLUS_BIN_ATTRIBUTE_W(macro, MACRO);
185 KONEPLUS_BIN_ATTRIBUTE_R(tcu_image, TCU_IMAGE);
186 KONEPLUS_BIN_ATTRIBUTE_RW(info, INFO);
187 KONEPLUS_BIN_ATTRIBUTE_RW(sensor, SENSOR);
188 KONEPLUS_BIN_ATTRIBUTE_RW(tcu, TCU);
189 KONEPLUS_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS);
190 KONEPLUS_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS);
192 static ssize_t koneplus_sysfs_read_profilex_settings(struct file *fp,
193 struct kobject *kobj, struct bin_attribute *attr, char *buf,
194 loff_t off, size_t count)
197 container_of(kobj, struct device, kobj)->parent->parent;
198 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
201 retval = koneplus_send_control(usb_dev, *(uint *)(attr->private),
202 KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS);
206 return koneplus_sysfs_read(fp, kobj, buf, off, count,
207 KONEPLUS_SIZE_PROFILE_SETTINGS,
208 KONEPLUS_COMMAND_PROFILE_SETTINGS);
211 static ssize_t koneplus_sysfs_read_profilex_buttons(struct file *fp,
212 struct kobject *kobj, struct bin_attribute *attr, char *buf,
213 loff_t off, size_t count)
216 container_of(kobj, struct device, kobj)->parent->parent;
217 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
220 retval = koneplus_send_control(usb_dev, *(uint *)(attr->private),
221 KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS);
225 return koneplus_sysfs_read(fp, kobj, buf, off, count,
226 KONEPLUS_SIZE_PROFILE_BUTTONS,
227 KONEPLUS_COMMAND_PROFILE_BUTTONS);
230 #define PROFILE_ATTR(number) \
231 static struct bin_attribute bin_attr_profile##number##_settings = { \
232 .attr = { .name = "profile" #number "_settings", .mode = 0440 }, \
233 .size = KONEPLUS_SIZE_PROFILE_SETTINGS, \
234 .read = koneplus_sysfs_read_profilex_settings, \
235 .private = &profile_numbers[number-1], \
237 static struct bin_attribute bin_attr_profile##number##_buttons = { \
238 .attr = { .name = "profile" #number "_buttons", .mode = 0440 }, \
239 .size = KONEPLUS_SIZE_PROFILE_BUTTONS, \
240 .read = koneplus_sysfs_read_profilex_buttons, \
241 .private = &profile_numbers[number-1], \
249 static ssize_t koneplus_sysfs_show_actual_profile(struct device *dev,
250 struct device_attribute *attr, char *buf)
252 struct koneplus_device *koneplus =
253 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
254 return snprintf(buf, PAGE_SIZE, "%d\n", koneplus->actual_profile);
257 static ssize_t koneplus_sysfs_set_actual_profile(struct device *dev,
258 struct device_attribute *attr, char const *buf, size_t size)
260 struct koneplus_device *koneplus;
261 struct usb_device *usb_dev;
262 unsigned long profile;
264 struct koneplus_roccat_report roccat_report;
266 dev = dev->parent->parent;
267 koneplus = hid_get_drvdata(dev_get_drvdata(dev));
268 usb_dev = interface_to_usbdev(to_usb_interface(dev));
270 retval = kstrtoul(buf, 10, &profile);
277 mutex_lock(&koneplus->koneplus_lock);
279 retval = koneplus_set_actual_profile(usb_dev, profile);
281 mutex_unlock(&koneplus->koneplus_lock);
285 koneplus_profile_activated(koneplus, profile);
287 roccat_report.type = KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE;
288 roccat_report.data1 = profile + 1;
289 roccat_report.data2 = 0;
290 roccat_report.profile = profile + 1;
291 roccat_report_event(koneplus->chrdev_minor,
292 (uint8_t const *)&roccat_report);
294 mutex_unlock(&koneplus->koneplus_lock);
298 static DEVICE_ATTR(actual_profile, 0660,
299 koneplus_sysfs_show_actual_profile,
300 koneplus_sysfs_set_actual_profile);
301 static DEVICE_ATTR(startup_profile, 0660,
302 koneplus_sysfs_show_actual_profile,
303 koneplus_sysfs_set_actual_profile);
305 static ssize_t koneplus_sysfs_show_firmware_version(struct device *dev,
306 struct device_attribute *attr, char *buf)
308 struct koneplus_device *koneplus;
309 struct usb_device *usb_dev;
310 struct koneplus_info info;
312 dev = dev->parent->parent;
313 koneplus = hid_get_drvdata(dev_get_drvdata(dev));
314 usb_dev = interface_to_usbdev(to_usb_interface(dev));
316 mutex_lock(&koneplus->koneplus_lock);
317 roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_INFO,
318 &info, KONEPLUS_SIZE_INFO);
319 mutex_unlock(&koneplus->koneplus_lock);
321 return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
323 static DEVICE_ATTR(firmware_version, 0440,
324 koneplus_sysfs_show_firmware_version, NULL);
326 static struct attribute *koneplus_attrs[] = {
327 &dev_attr_actual_profile.attr,
328 &dev_attr_startup_profile.attr,
329 &dev_attr_firmware_version.attr,
333 static struct bin_attribute *koneplus_bin_attributes[] = {
341 &bin_attr_profile_settings,
342 &bin_attr_profile_buttons,
343 &bin_attr_profile1_settings,
344 &bin_attr_profile2_settings,
345 &bin_attr_profile3_settings,
346 &bin_attr_profile4_settings,
347 &bin_attr_profile5_settings,
348 &bin_attr_profile1_buttons,
349 &bin_attr_profile2_buttons,
350 &bin_attr_profile3_buttons,
351 &bin_attr_profile4_buttons,
352 &bin_attr_profile5_buttons,
356 static const struct attribute_group koneplus_group = {
357 .attrs = koneplus_attrs,
358 .bin_attrs = koneplus_bin_attributes,
361 static const struct attribute_group *koneplus_groups[] = {
366 static int koneplus_init_koneplus_device_struct(struct usb_device *usb_dev,
367 struct koneplus_device *koneplus)
371 mutex_init(&koneplus->koneplus_lock);
373 retval = koneplus_get_actual_profile(usb_dev);
376 koneplus_profile_activated(koneplus, retval);
381 static int koneplus_init_specials(struct hid_device *hdev)
383 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
384 struct usb_device *usb_dev = interface_to_usbdev(intf);
385 struct koneplus_device *koneplus;
388 if (intf->cur_altsetting->desc.bInterfaceProtocol
389 == USB_INTERFACE_PROTOCOL_MOUSE) {
391 koneplus = kzalloc(sizeof(*koneplus), GFP_KERNEL);
393 hid_err(hdev, "can't alloc device descriptor\n");
396 hid_set_drvdata(hdev, koneplus);
398 retval = koneplus_init_koneplus_device_struct(usb_dev, koneplus);
400 hid_err(hdev, "couldn't init struct koneplus_device\n");
404 retval = roccat_connect(koneplus_class, hdev,
405 sizeof(struct koneplus_roccat_report));
407 hid_err(hdev, "couldn't init char dev\n");
409 koneplus->chrdev_minor = retval;
410 koneplus->roccat_claimed = 1;
413 hid_set_drvdata(hdev, NULL);
422 static void koneplus_remove_specials(struct hid_device *hdev)
424 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
425 struct koneplus_device *koneplus;
427 if (intf->cur_altsetting->desc.bInterfaceProtocol
428 == USB_INTERFACE_PROTOCOL_MOUSE) {
429 koneplus = hid_get_drvdata(hdev);
430 if (koneplus->roccat_claimed)
431 roccat_disconnect(koneplus->chrdev_minor);
436 static int koneplus_probe(struct hid_device *hdev,
437 const struct hid_device_id *id)
441 retval = hid_parse(hdev);
443 hid_err(hdev, "parse failed\n");
447 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
449 hid_err(hdev, "hw start failed\n");
453 retval = koneplus_init_specials(hdev);
455 hid_err(hdev, "couldn't install mouse\n");
467 static void koneplus_remove(struct hid_device *hdev)
469 koneplus_remove_specials(hdev);
473 static void koneplus_keep_values_up_to_date(struct koneplus_device *koneplus,
476 struct koneplus_mouse_report_button const *button_report;
479 case KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON:
480 button_report = (struct koneplus_mouse_report_button const *)data;
481 switch (button_report->type) {
482 case KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE:
483 koneplus_profile_activated(koneplus, button_report->data1 - 1);
490 static void koneplus_report_to_chrdev(struct koneplus_device const *koneplus,
493 struct koneplus_roccat_report roccat_report;
494 struct koneplus_mouse_report_button const *button_report;
496 if (data[0] != KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON)
499 button_report = (struct koneplus_mouse_report_button const *)data;
501 if ((button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH ||
502 button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER) &&
503 button_report->data2 != KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS)
506 roccat_report.type = button_report->type;
507 roccat_report.data1 = button_report->data1;
508 roccat_report.data2 = button_report->data2;
509 roccat_report.profile = koneplus->actual_profile + 1;
510 roccat_report_event(koneplus->chrdev_minor,
511 (uint8_t const *)&roccat_report);
514 static int koneplus_raw_event(struct hid_device *hdev,
515 struct hid_report *report, u8 *data, int size)
517 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
518 struct koneplus_device *koneplus = hid_get_drvdata(hdev);
520 if (intf->cur_altsetting->desc.bInterfaceProtocol
521 != USB_INTERFACE_PROTOCOL_MOUSE)
524 if (koneplus == NULL)
527 koneplus_keep_values_up_to_date(koneplus, data);
529 if (koneplus->roccat_claimed)
530 koneplus_report_to_chrdev(koneplus, data);
535 static const struct hid_device_id koneplus_devices[] = {
536 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEPLUS) },
537 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEXTD) },
541 MODULE_DEVICE_TABLE(hid, koneplus_devices);
543 static struct hid_driver koneplus_driver = {
545 .id_table = koneplus_devices,
546 .probe = koneplus_probe,
547 .remove = koneplus_remove,
548 .raw_event = koneplus_raw_event
551 static int __init koneplus_init(void)
555 /* class name has to be same as driver name */
556 koneplus_class = class_create(THIS_MODULE, "koneplus");
557 if (IS_ERR(koneplus_class))
558 return PTR_ERR(koneplus_class);
559 koneplus_class->dev_groups = koneplus_groups;
561 retval = hid_register_driver(&koneplus_driver);
563 class_destroy(koneplus_class);
567 static void __exit koneplus_exit(void)
569 hid_unregister_driver(&koneplus_driver);
570 class_destroy(koneplus_class);
573 module_init(koneplus_init);
574 module_exit(koneplus_exit);
576 MODULE_AUTHOR("Stefan Achatz");
577 MODULE_DESCRIPTION("USB Roccat Kone[+]/XTD driver");
578 MODULE_LICENSE("GPL v2");