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) \
160 .attr = { .name = #thingy, .mode = 0660 }, \
161 .size = KONEPLUS_SIZE_ ## THINGY, \
162 .read = koneplus_sysfs_read_ ## thingy, \
163 .write = koneplus_sysfs_write_ ## thingy \
166 #define KONEPLUS_BIN_ATTRIBUTE_R(thingy, THINGY) \
168 .attr = { .name = #thingy, .mode = 0440 }, \
169 .size = KONEPLUS_SIZE_ ## THINGY, \
170 .read = koneplus_sysfs_read_ ## thingy, \
173 #define KONEPLUS_BIN_ATTRIBUTE_W(thingy, THINGY) \
175 .attr = { .name = #thingy, .mode = 0220 }, \
176 .size = KONEPLUS_SIZE_ ## THINGY, \
177 .write = koneplus_sysfs_write_ ## thingy \
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
)
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
)
195 container_of(kobj
, struct device
, kobj
)->parent
->parent
;
196 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
199 retval
= koneplus_send_control(usb_dev
, *(uint
*)(attr
->private),
200 KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS
);
204 return koneplus_sysfs_read(fp
, kobj
, buf
, off
, count
,
205 KONEPLUS_SIZE_PROFILE_SETTINGS
,
206 KONEPLUS_COMMAND_PROFILE_SETTINGS
);
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
)
214 container_of(kobj
, struct device
, kobj
)->parent
->parent
;
215 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
218 retval
= koneplus_send_control(usb_dev
, *(uint
*)(attr
->private),
219 KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS
);
223 return koneplus_sysfs_read(fp
, kobj
, buf
, off
, count
,
224 KONEPLUS_SIZE_PROFILE_BUTTONS
,
225 KONEPLUS_COMMAND_PROFILE_BUTTONS
);
228 static ssize_t
koneplus_sysfs_show_actual_profile(struct device
*dev
,
229 struct device_attribute
*attr
, char *buf
)
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
);
236 static ssize_t
koneplus_sysfs_set_actual_profile(struct device
*dev
,
237 struct device_attribute
*attr
, char const *buf
, size_t size
)
239 struct koneplus_device
*koneplus
;
240 struct usb_device
*usb_dev
;
241 unsigned long profile
;
243 struct koneplus_roccat_report roccat_report
;
245 dev
= dev
->parent
->parent
;
246 koneplus
= hid_get_drvdata(dev_get_drvdata(dev
));
247 usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
249 retval
= strict_strtoul(buf
, 10, &profile
);
256 mutex_lock(&koneplus
->koneplus_lock
);
258 retval
= koneplus_set_actual_profile(usb_dev
, profile
);
260 mutex_unlock(&koneplus
->koneplus_lock
);
264 koneplus_profile_activated(koneplus
, profile
);
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
);
273 mutex_unlock(&koneplus
->koneplus_lock
);
278 static ssize_t
koneplus_sysfs_show_firmware_version(struct device
*dev
,
279 struct device_attribute
*attr
, char *buf
)
281 struct koneplus_device
*koneplus
;
282 struct usb_device
*usb_dev
;
283 struct koneplus_info info
;
285 dev
= dev
->parent
->parent
;
286 koneplus
= hid_get_drvdata(dev_get_drvdata(dev
));
287 usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
289 mutex_lock(&koneplus
->koneplus_lock
);
290 roccat_common2_receive(usb_dev
, KONEPLUS_COMMAND_INFO
,
291 &info
, KONEPLUS_SIZE_INFO
);
292 mutex_unlock(&koneplus
->koneplus_lock
);
294 return snprintf(buf
, PAGE_SIZE
, "%d\n", info
.firmware_version
);
297 static struct device_attribute koneplus_attributes
[] = {
298 __ATTR(actual_profile
, 0660,
299 koneplus_sysfs_show_actual_profile
,
300 koneplus_sysfs_set_actual_profile
),
301 __ATTR(startup_profile
, 0660,
302 koneplus_sysfs_show_actual_profile
,
303 koneplus_sysfs_set_actual_profile
),
304 __ATTR(firmware_version
, 0440,
305 koneplus_sysfs_show_firmware_version
, NULL
),
309 static struct bin_attribute koneplus_bin_attributes
[] = {
310 KONEPLUS_BIN_ATTRIBUTE_W(control
, CONTROL
),
311 KONEPLUS_BIN_ATTRIBUTE_RW(info
, INFO
),
312 KONEPLUS_BIN_ATTRIBUTE_W(talk
, TALK
),
313 KONEPLUS_BIN_ATTRIBUTE_W(macro
, MACRO
),
314 KONEPLUS_BIN_ATTRIBUTE_RW(sensor
, SENSOR
),
315 KONEPLUS_BIN_ATTRIBUTE_RW(tcu
, TCU
),
316 KONEPLUS_BIN_ATTRIBUTE_R(tcu_image
, TCU_IMAGE
),
317 KONEPLUS_BIN_ATTRIBUTE_RW(profile_settings
, PROFILE_SETTINGS
),
318 KONEPLUS_BIN_ATTRIBUTE_RW(profile_buttons
, PROFILE_BUTTONS
),
320 .attr
= { .name
= "profile1_settings", .mode
= 0440 },
321 .size
= KONEPLUS_SIZE_PROFILE_SETTINGS
,
322 .read
= koneplus_sysfs_read_profilex_settings
,
323 .private = &profile_numbers
[0]
326 .attr
= { .name
= "profile2_settings", .mode
= 0440 },
327 .size
= KONEPLUS_SIZE_PROFILE_SETTINGS
,
328 .read
= koneplus_sysfs_read_profilex_settings
,
329 .private = &profile_numbers
[1]
332 .attr
= { .name
= "profile3_settings", .mode
= 0440 },
333 .size
= KONEPLUS_SIZE_PROFILE_SETTINGS
,
334 .read
= koneplus_sysfs_read_profilex_settings
,
335 .private = &profile_numbers
[2]
338 .attr
= { .name
= "profile4_settings", .mode
= 0440 },
339 .size
= KONEPLUS_SIZE_PROFILE_SETTINGS
,
340 .read
= koneplus_sysfs_read_profilex_settings
,
341 .private = &profile_numbers
[3]
344 .attr
= { .name
= "profile5_settings", .mode
= 0440 },
345 .size
= KONEPLUS_SIZE_PROFILE_SETTINGS
,
346 .read
= koneplus_sysfs_read_profilex_settings
,
347 .private = &profile_numbers
[4]
350 .attr
= { .name
= "profile1_buttons", .mode
= 0440 },
351 .size
= KONEPLUS_SIZE_PROFILE_BUTTONS
,
352 .read
= koneplus_sysfs_read_profilex_buttons
,
353 .private = &profile_numbers
[0]
356 .attr
= { .name
= "profile2_buttons", .mode
= 0440 },
357 .size
= KONEPLUS_SIZE_PROFILE_BUTTONS
,
358 .read
= koneplus_sysfs_read_profilex_buttons
,
359 .private = &profile_numbers
[1]
362 .attr
= { .name
= "profile3_buttons", .mode
= 0440 },
363 .size
= KONEPLUS_SIZE_PROFILE_BUTTONS
,
364 .read
= koneplus_sysfs_read_profilex_buttons
,
365 .private = &profile_numbers
[2]
368 .attr
= { .name
= "profile4_buttons", .mode
= 0440 },
369 .size
= KONEPLUS_SIZE_PROFILE_BUTTONS
,
370 .read
= koneplus_sysfs_read_profilex_buttons
,
371 .private = &profile_numbers
[3]
374 .attr
= { .name
= "profile5_buttons", .mode
= 0440 },
375 .size
= KONEPLUS_SIZE_PROFILE_BUTTONS
,
376 .read
= koneplus_sysfs_read_profilex_buttons
,
377 .private = &profile_numbers
[4]
382 static int koneplus_init_koneplus_device_struct(struct usb_device
*usb_dev
,
383 struct koneplus_device
*koneplus
)
387 mutex_init(&koneplus
->koneplus_lock
);
389 retval
= koneplus_get_actual_profile(usb_dev
);
392 koneplus_profile_activated(koneplus
, retval
);
397 static int koneplus_init_specials(struct hid_device
*hdev
)
399 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
400 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
401 struct koneplus_device
*koneplus
;
404 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
405 == USB_INTERFACE_PROTOCOL_MOUSE
) {
407 koneplus
= kzalloc(sizeof(*koneplus
), GFP_KERNEL
);
409 hid_err(hdev
, "can't alloc device descriptor\n");
412 hid_set_drvdata(hdev
, koneplus
);
414 retval
= koneplus_init_koneplus_device_struct(usb_dev
, koneplus
);
416 hid_err(hdev
, "couldn't init struct koneplus_device\n");
420 retval
= roccat_connect(koneplus_class
, hdev
,
421 sizeof(struct koneplus_roccat_report
));
423 hid_err(hdev
, "couldn't init char dev\n");
425 koneplus
->chrdev_minor
= retval
;
426 koneplus
->roccat_claimed
= 1;
429 hid_set_drvdata(hdev
, NULL
);
438 static void koneplus_remove_specials(struct hid_device
*hdev
)
440 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
441 struct koneplus_device
*koneplus
;
443 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
444 == USB_INTERFACE_PROTOCOL_MOUSE
) {
445 koneplus
= hid_get_drvdata(hdev
);
446 if (koneplus
->roccat_claimed
)
447 roccat_disconnect(koneplus
->chrdev_minor
);
452 static int koneplus_probe(struct hid_device
*hdev
,
453 const struct hid_device_id
*id
)
457 retval
= hid_parse(hdev
);
459 hid_err(hdev
, "parse failed\n");
463 retval
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
465 hid_err(hdev
, "hw start failed\n");
469 retval
= koneplus_init_specials(hdev
);
471 hid_err(hdev
, "couldn't install mouse\n");
483 static void koneplus_remove(struct hid_device
*hdev
)
485 koneplus_remove_specials(hdev
);
489 static void koneplus_keep_values_up_to_date(struct koneplus_device
*koneplus
,
492 struct koneplus_mouse_report_button
const *button_report
;
495 case KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON
:
496 button_report
= (struct koneplus_mouse_report_button
const *)data
;
497 switch (button_report
->type
) {
498 case KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE
:
499 koneplus_profile_activated(koneplus
, button_report
->data1
- 1);
506 static void koneplus_report_to_chrdev(struct koneplus_device
const *koneplus
,
509 struct koneplus_roccat_report roccat_report
;
510 struct koneplus_mouse_report_button
const *button_report
;
512 if (data
[0] != KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON
)
515 button_report
= (struct koneplus_mouse_report_button
const *)data
;
517 if ((button_report
->type
== KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH
||
518 button_report
->type
== KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER
) &&
519 button_report
->data2
!= KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS
)
522 roccat_report
.type
= button_report
->type
;
523 roccat_report
.data1
= button_report
->data1
;
524 roccat_report
.data2
= button_report
->data2
;
525 roccat_report
.profile
= koneplus
->actual_profile
+ 1;
526 roccat_report_event(koneplus
->chrdev_minor
,
527 (uint8_t const *)&roccat_report
);
530 static int koneplus_raw_event(struct hid_device
*hdev
,
531 struct hid_report
*report
, u8
*data
, int size
)
533 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
534 struct koneplus_device
*koneplus
= hid_get_drvdata(hdev
);
536 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
537 != USB_INTERFACE_PROTOCOL_MOUSE
)
540 if (koneplus
== NULL
)
543 koneplus_keep_values_up_to_date(koneplus
, data
);
545 if (koneplus
->roccat_claimed
)
546 koneplus_report_to_chrdev(koneplus
, data
);
551 static const struct hid_device_id koneplus_devices
[] = {
552 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT
, USB_DEVICE_ID_ROCCAT_KONEPLUS
) },
553 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT
, USB_DEVICE_ID_ROCCAT_KONEXTD
) },
557 MODULE_DEVICE_TABLE(hid
, koneplus_devices
);
559 static struct hid_driver koneplus_driver
= {
561 .id_table
= koneplus_devices
,
562 .probe
= koneplus_probe
,
563 .remove
= koneplus_remove
,
564 .raw_event
= koneplus_raw_event
567 static int __init
koneplus_init(void)
571 /* class name has to be same as driver name */
572 koneplus_class
= class_create(THIS_MODULE
, "koneplus");
573 if (IS_ERR(koneplus_class
))
574 return PTR_ERR(koneplus_class
);
575 koneplus_class
->dev_attrs
= koneplus_attributes
;
576 koneplus_class
->dev_bin_attrs
= koneplus_bin_attributes
;
578 retval
= hid_register_driver(&koneplus_driver
);
580 class_destroy(koneplus_class
);
584 static void __exit
koneplus_exit(void)
586 hid_unregister_driver(&koneplus_driver
);
587 class_destroy(koneplus_class
);
590 module_init(koneplus_init
);
591 module_exit(koneplus_exit
);
593 MODULE_AUTHOR("Stefan Achatz");
594 MODULE_DESCRIPTION("USB Roccat Kone[+]/XTD driver");
595 MODULE_LICENSE("GPL v2");