2 * Roccat Pyra 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 Pyra is a mobile gamer mouse which comes in wired and wireless
16 * variant. Wireless variant is not tested.
17 * Userland tools can be found at http://sourceforge.net/projects/roccat
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-pyra.h"
30 static uint profile_numbers
[5] = {0, 1, 2, 3, 4};
32 /* pyra_class is used for creating sysfs attributes via roccat char device */
33 static struct class *pyra_class
;
35 static void profile_activated(struct pyra_device
*pyra
,
36 unsigned int new_profile
)
38 if (new_profile
>= ARRAY_SIZE(pyra
->profile_settings
))
40 pyra
->actual_profile
= new_profile
;
41 pyra
->actual_cpi
= pyra
->profile_settings
[pyra
->actual_profile
].y_cpi
;
44 static int pyra_send_control(struct usb_device
*usb_dev
, int value
,
45 enum pyra_control_requests request
)
47 struct roccat_common2_control control
;
49 if ((request
== PYRA_CONTROL_REQUEST_PROFILE_SETTINGS
||
50 request
== PYRA_CONTROL_REQUEST_PROFILE_BUTTONS
) &&
51 (value
< 0 || value
> 4))
54 control
.command
= ROCCAT_COMMON_COMMAND_CONTROL
;
55 control
.value
= value
;
56 control
.request
= request
;
58 return roccat_common2_send(usb_dev
, ROCCAT_COMMON_COMMAND_CONTROL
,
59 &control
, sizeof(struct roccat_common2_control
));
62 static int pyra_get_profile_settings(struct usb_device
*usb_dev
,
63 struct pyra_profile_settings
*buf
, int number
)
66 retval
= pyra_send_control(usb_dev
, number
,
67 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS
);
70 return roccat_common2_receive(usb_dev
, PYRA_COMMAND_PROFILE_SETTINGS
,
71 buf
, PYRA_SIZE_PROFILE_SETTINGS
);
74 static int pyra_get_settings(struct usb_device
*usb_dev
,
75 struct pyra_settings
*buf
)
77 return roccat_common2_receive(usb_dev
, PYRA_COMMAND_SETTINGS
,
78 buf
, PYRA_SIZE_SETTINGS
);
81 static int pyra_set_settings(struct usb_device
*usb_dev
,
82 struct pyra_settings
const *settings
)
84 return roccat_common2_send_with_status(usb_dev
,
85 PYRA_COMMAND_SETTINGS
, settings
,
89 static ssize_t
pyra_sysfs_read(struct file
*fp
, struct kobject
*kobj
,
90 char *buf
, loff_t off
, size_t count
,
91 size_t real_size
, uint command
)
93 struct device
*dev
= kobj_to_dev(kobj
)->parent
->parent
;
94 struct pyra_device
*pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
95 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
101 if (off
!= 0 || count
!= real_size
)
104 mutex_lock(&pyra
->pyra_lock
);
105 retval
= roccat_common2_receive(usb_dev
, command
, buf
, real_size
);
106 mutex_unlock(&pyra
->pyra_lock
);
114 static ssize_t
pyra_sysfs_write(struct file
*fp
, struct kobject
*kobj
,
115 void const *buf
, loff_t off
, size_t count
,
116 size_t real_size
, uint command
)
118 struct device
*dev
= kobj_to_dev(kobj
)->parent
->parent
;
119 struct pyra_device
*pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
120 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
123 if (off
!= 0 || count
!= real_size
)
126 mutex_lock(&pyra
->pyra_lock
);
127 retval
= roccat_common2_send_with_status(usb_dev
, command
, (void *)buf
, real_size
);
128 mutex_unlock(&pyra
->pyra_lock
);
136 #define PYRA_SYSFS_W(thingy, THINGY) \
137 static ssize_t pyra_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 pyra_sysfs_write(fp, kobj, buf, off, count, \
142 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
145 #define PYRA_SYSFS_R(thingy, THINGY) \
146 static ssize_t pyra_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 pyra_sysfs_read(fp, kobj, buf, off, count, \
151 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
154 #define PYRA_SYSFS_RW(thingy, THINGY) \
155 PYRA_SYSFS_W(thingy, THINGY) \
156 PYRA_SYSFS_R(thingy, THINGY)
158 #define PYRA_BIN_ATTRIBUTE_RW(thingy, THINGY) \
159 PYRA_SYSFS_RW(thingy, THINGY); \
160 static struct bin_attribute bin_attr_##thingy = { \
161 .attr = { .name = #thingy, .mode = 0660 }, \
162 .size = PYRA_SIZE_ ## THINGY, \
163 .read = pyra_sysfs_read_ ## thingy, \
164 .write = pyra_sysfs_write_ ## thingy \
167 #define PYRA_BIN_ATTRIBUTE_R(thingy, THINGY) \
168 PYRA_SYSFS_R(thingy, THINGY); \
169 static struct bin_attribute bin_attr_##thingy = { \
170 .attr = { .name = #thingy, .mode = 0440 }, \
171 .size = PYRA_SIZE_ ## THINGY, \
172 .read = pyra_sysfs_read_ ## thingy, \
175 #define PYRA_BIN_ATTRIBUTE_W(thingy, THINGY) \
176 PYRA_SYSFS_W(thingy, THINGY); \
177 static struct bin_attribute bin_attr_##thingy = { \
178 .attr = { .name = #thingy, .mode = 0220 }, \
179 .size = PYRA_SIZE_ ## THINGY, \
180 .write = pyra_sysfs_write_ ## thingy \
183 PYRA_BIN_ATTRIBUTE_W(control
, CONTROL
);
184 PYRA_BIN_ATTRIBUTE_RW(info
, INFO
);
185 PYRA_BIN_ATTRIBUTE_RW(profile_settings
, PROFILE_SETTINGS
);
186 PYRA_BIN_ATTRIBUTE_RW(profile_buttons
, PROFILE_BUTTONS
);
188 static ssize_t
pyra_sysfs_read_profilex_settings(struct file
*fp
,
189 struct kobject
*kobj
, struct bin_attribute
*attr
, char *buf
,
190 loff_t off
, size_t count
)
192 struct device
*dev
= kobj_to_dev(kobj
)->parent
->parent
;
193 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
196 retval
= pyra_send_control(usb_dev
, *(uint
*)(attr
->private),
197 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS
);
201 return pyra_sysfs_read(fp
, kobj
, buf
, off
, count
,
202 PYRA_SIZE_PROFILE_SETTINGS
,
203 PYRA_COMMAND_PROFILE_SETTINGS
);
206 static ssize_t
pyra_sysfs_read_profilex_buttons(struct file
*fp
,
207 struct kobject
*kobj
, struct bin_attribute
*attr
, char *buf
,
208 loff_t off
, size_t count
)
210 struct device
*dev
= kobj_to_dev(kobj
)->parent
->parent
;
211 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
214 retval
= pyra_send_control(usb_dev
, *(uint
*)(attr
->private),
215 PYRA_CONTROL_REQUEST_PROFILE_BUTTONS
);
219 return pyra_sysfs_read(fp
, kobj
, buf
, off
, count
,
220 PYRA_SIZE_PROFILE_BUTTONS
,
221 PYRA_COMMAND_PROFILE_BUTTONS
);
224 #define PROFILE_ATTR(number) \
225 static struct bin_attribute bin_attr_profile##number##_settings = { \
226 .attr = { .name = "profile" #number "_settings", .mode = 0440 }, \
227 .size = PYRA_SIZE_PROFILE_SETTINGS, \
228 .read = pyra_sysfs_read_profilex_settings, \
229 .private = &profile_numbers[number-1], \
231 static struct bin_attribute bin_attr_profile##number##_buttons = { \
232 .attr = { .name = "profile" #number "_buttons", .mode = 0440 }, \
233 .size = PYRA_SIZE_PROFILE_BUTTONS, \
234 .read = pyra_sysfs_read_profilex_buttons, \
235 .private = &profile_numbers[number-1], \
243 static ssize_t
pyra_sysfs_write_settings(struct file
*fp
,
244 struct kobject
*kobj
, struct bin_attribute
*attr
, char *buf
,
245 loff_t off
, size_t count
)
247 struct device
*dev
= kobj_to_dev(kobj
)->parent
->parent
;
248 struct pyra_device
*pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
249 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
251 struct pyra_roccat_report roccat_report
;
252 struct pyra_settings
const *settings
;
254 if (off
!= 0 || count
!= PYRA_SIZE_SETTINGS
)
257 settings
= (struct pyra_settings
const *)buf
;
258 if (settings
->startup_profile
>= ARRAY_SIZE(pyra
->profile_settings
))
261 mutex_lock(&pyra
->pyra_lock
);
263 retval
= pyra_set_settings(usb_dev
, settings
);
265 mutex_unlock(&pyra
->pyra_lock
);
269 profile_activated(pyra
, settings
->startup_profile
);
271 roccat_report
.type
= PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2
;
272 roccat_report
.value
= settings
->startup_profile
+ 1;
273 roccat_report
.key
= 0;
274 roccat_report_event(pyra
->chrdev_minor
,
275 (uint8_t const *)&roccat_report
);
277 mutex_unlock(&pyra
->pyra_lock
);
278 return PYRA_SIZE_SETTINGS
;
281 PYRA_SYSFS_R(settings
, SETTINGS
);
282 static struct bin_attribute bin_attr_settings
=
283 __BIN_ATTR(settings
, (S_IWUSR
| S_IRUGO
),
284 pyra_sysfs_read_settings
, pyra_sysfs_write_settings
,
287 static ssize_t
pyra_sysfs_show_actual_cpi(struct device
*dev
,
288 struct device_attribute
*attr
, char *buf
)
290 struct pyra_device
*pyra
=
291 hid_get_drvdata(dev_get_drvdata(dev
->parent
->parent
));
292 return snprintf(buf
, PAGE_SIZE
, "%d\n", pyra
->actual_cpi
);
294 static DEVICE_ATTR(actual_cpi
, 0440, pyra_sysfs_show_actual_cpi
, NULL
);
296 static ssize_t
pyra_sysfs_show_actual_profile(struct device
*dev
,
297 struct device_attribute
*attr
, char *buf
)
299 struct pyra_device
*pyra
=
300 hid_get_drvdata(dev_get_drvdata(dev
->parent
->parent
));
301 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
302 struct pyra_settings settings
;
304 mutex_lock(&pyra
->pyra_lock
);
305 roccat_common2_receive(usb_dev
, PYRA_COMMAND_SETTINGS
,
306 &settings
, PYRA_SIZE_SETTINGS
);
307 mutex_unlock(&pyra
->pyra_lock
);
309 return snprintf(buf
, PAGE_SIZE
, "%d\n", settings
.startup_profile
);
311 static DEVICE_ATTR(actual_profile
, 0440, pyra_sysfs_show_actual_profile
, NULL
);
312 static DEVICE_ATTR(startup_profile
, 0440, pyra_sysfs_show_actual_profile
, NULL
);
314 static ssize_t
pyra_sysfs_show_firmware_version(struct device
*dev
,
315 struct device_attribute
*attr
, char *buf
)
317 struct pyra_device
*pyra
;
318 struct usb_device
*usb_dev
;
319 struct pyra_info info
;
321 dev
= dev
->parent
->parent
;
322 pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
323 usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
325 mutex_lock(&pyra
->pyra_lock
);
326 roccat_common2_receive(usb_dev
, PYRA_COMMAND_INFO
,
327 &info
, PYRA_SIZE_INFO
);
328 mutex_unlock(&pyra
->pyra_lock
);
330 return snprintf(buf
, PAGE_SIZE
, "%d\n", info
.firmware_version
);
332 static DEVICE_ATTR(firmware_version
, 0440, pyra_sysfs_show_firmware_version
,
335 static struct attribute
*pyra_attrs
[] = {
336 &dev_attr_actual_cpi
.attr
,
337 &dev_attr_actual_profile
.attr
,
338 &dev_attr_firmware_version
.attr
,
339 &dev_attr_startup_profile
.attr
,
343 static struct bin_attribute
*pyra_bin_attributes
[] = {
346 &bin_attr_profile_settings
,
347 &bin_attr_profile_buttons
,
349 &bin_attr_profile1_settings
,
350 &bin_attr_profile2_settings
,
351 &bin_attr_profile3_settings
,
352 &bin_attr_profile4_settings
,
353 &bin_attr_profile5_settings
,
354 &bin_attr_profile1_buttons
,
355 &bin_attr_profile2_buttons
,
356 &bin_attr_profile3_buttons
,
357 &bin_attr_profile4_buttons
,
358 &bin_attr_profile5_buttons
,
362 static const struct attribute_group pyra_group
= {
364 .bin_attrs
= pyra_bin_attributes
,
367 static const struct attribute_group
*pyra_groups
[] = {
372 static int pyra_init_pyra_device_struct(struct usb_device
*usb_dev
,
373 struct pyra_device
*pyra
)
375 struct pyra_settings settings
;
378 mutex_init(&pyra
->pyra_lock
);
380 retval
= pyra_get_settings(usb_dev
, &settings
);
384 for (i
= 0; i
< 5; ++i
) {
385 retval
= pyra_get_profile_settings(usb_dev
,
386 &pyra
->profile_settings
[i
], i
);
391 profile_activated(pyra
, settings
.startup_profile
);
396 static int pyra_init_specials(struct hid_device
*hdev
)
398 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
399 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
400 struct pyra_device
*pyra
;
403 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
404 == USB_INTERFACE_PROTOCOL_MOUSE
) {
406 pyra
= kzalloc(sizeof(*pyra
), GFP_KERNEL
);
408 hid_err(hdev
, "can't alloc device descriptor\n");
411 hid_set_drvdata(hdev
, pyra
);
413 retval
= pyra_init_pyra_device_struct(usb_dev
, pyra
);
415 hid_err(hdev
, "couldn't init struct pyra_device\n");
419 retval
= roccat_connect(pyra_class
, hdev
,
420 sizeof(struct pyra_roccat_report
));
422 hid_err(hdev
, "couldn't init char dev\n");
424 pyra
->chrdev_minor
= retval
;
425 pyra
->roccat_claimed
= 1;
428 hid_set_drvdata(hdev
, NULL
);
437 static void pyra_remove_specials(struct hid_device
*hdev
)
439 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
440 struct pyra_device
*pyra
;
442 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
443 == USB_INTERFACE_PROTOCOL_MOUSE
) {
444 pyra
= hid_get_drvdata(hdev
);
445 if (pyra
->roccat_claimed
)
446 roccat_disconnect(pyra
->chrdev_minor
);
447 kfree(hid_get_drvdata(hdev
));
451 static int pyra_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
455 retval
= hid_parse(hdev
);
457 hid_err(hdev
, "parse failed\n");
461 retval
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
463 hid_err(hdev
, "hw start failed\n");
467 retval
= pyra_init_specials(hdev
);
469 hid_err(hdev
, "couldn't install mouse\n");
480 static void pyra_remove(struct hid_device
*hdev
)
482 pyra_remove_specials(hdev
);
486 static void pyra_keep_values_up_to_date(struct pyra_device
*pyra
,
489 struct pyra_mouse_event_button
const *button_event
;
492 case PYRA_MOUSE_REPORT_NUMBER_BUTTON
:
493 button_event
= (struct pyra_mouse_event_button
const *)data
;
494 switch (button_event
->type
) {
495 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2
:
496 profile_activated(pyra
, button_event
->data1
- 1);
498 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI
:
499 pyra
->actual_cpi
= button_event
->data1
;
506 static void pyra_report_to_chrdev(struct pyra_device
const *pyra
,
509 struct pyra_roccat_report roccat_report
;
510 struct pyra_mouse_event_button
const *button_event
;
512 if (data
[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON
)
515 button_event
= (struct pyra_mouse_event_button
const *)data
;
517 switch (button_event
->type
) {
518 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2
:
519 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI
:
520 roccat_report
.type
= button_event
->type
;
521 roccat_report
.value
= button_event
->data1
;
522 roccat_report
.key
= 0;
523 roccat_report_event(pyra
->chrdev_minor
,
524 (uint8_t const *)&roccat_report
);
526 case PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO
:
527 case PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT
:
528 case PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH
:
529 if (button_event
->data2
== PYRA_MOUSE_EVENT_BUTTON_PRESS
) {
530 roccat_report
.type
= button_event
->type
;
531 roccat_report
.key
= button_event
->data1
;
533 * pyra reports profile numbers with range 1-5.
534 * Keeping this behaviour.
536 roccat_report
.value
= pyra
->actual_profile
+ 1;
537 roccat_report_event(pyra
->chrdev_minor
,
538 (uint8_t const *)&roccat_report
);
544 static int pyra_raw_event(struct hid_device
*hdev
, struct hid_report
*report
,
547 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
548 struct pyra_device
*pyra
= hid_get_drvdata(hdev
);
550 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
551 != USB_INTERFACE_PROTOCOL_MOUSE
)
557 pyra_keep_values_up_to_date(pyra
, data
);
559 if (pyra
->roccat_claimed
)
560 pyra_report_to_chrdev(pyra
, data
);
565 static const struct hid_device_id pyra_devices
[] = {
566 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT
,
567 USB_DEVICE_ID_ROCCAT_PYRA_WIRED
) },
568 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT
,
569 USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS
) },
573 MODULE_DEVICE_TABLE(hid
, pyra_devices
);
575 static struct hid_driver pyra_driver
= {
577 .id_table
= pyra_devices
,
579 .remove
= pyra_remove
,
580 .raw_event
= pyra_raw_event
583 static int __init
pyra_init(void)
587 /* class name has to be same as driver name */
588 pyra_class
= class_create(THIS_MODULE
, "pyra");
589 if (IS_ERR(pyra_class
))
590 return PTR_ERR(pyra_class
);
591 pyra_class
->dev_groups
= pyra_groups
;
593 retval
= hid_register_driver(&pyra_driver
);
595 class_destroy(pyra_class
);
599 static void __exit
pyra_exit(void)
601 hid_unregister_driver(&pyra_driver
);
602 class_destroy(pyra_class
);
605 module_init(pyra_init
);
606 module_exit(pyra_exit
);
608 MODULE_AUTHOR("Stefan Achatz");
609 MODULE_DESCRIPTION("USB Roccat Pyra driver");
610 MODULE_LICENSE("GPL v2");