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
)
94 container_of(kobj
, struct device
, kobj
)->parent
->parent
;
95 struct pyra_device
*pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
96 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
102 if (off
!= 0 || count
!= real_size
)
105 mutex_lock(&pyra
->pyra_lock
);
106 retval
= roccat_common2_receive(usb_dev
, command
, buf
, real_size
);
107 mutex_unlock(&pyra
->pyra_lock
);
115 static ssize_t
pyra_sysfs_write(struct file
*fp
, struct kobject
*kobj
,
116 void const *buf
, loff_t off
, size_t count
,
117 size_t real_size
, uint command
)
120 container_of(kobj
, struct device
, kobj
)->parent
->parent
;
121 struct pyra_device
*pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
122 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
125 if (off
!= 0 || count
!= real_size
)
128 mutex_lock(&pyra
->pyra_lock
);
129 retval
= roccat_common2_send_with_status(usb_dev
, command
, (void *)buf
, real_size
);
130 mutex_unlock(&pyra
->pyra_lock
);
138 #define PYRA_SYSFS_W(thingy, THINGY) \
139 static ssize_t pyra_sysfs_write_ ## thingy(struct file *fp, \
140 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
141 loff_t off, size_t count) \
143 return pyra_sysfs_write(fp, kobj, buf, off, count, \
144 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
147 #define PYRA_SYSFS_R(thingy, THINGY) \
148 static ssize_t pyra_sysfs_read_ ## thingy(struct file *fp, \
149 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
150 loff_t off, size_t count) \
152 return pyra_sysfs_read(fp, kobj, buf, off, count, \
153 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
156 #define PYRA_SYSFS_RW(thingy, THINGY) \
157 PYRA_SYSFS_W(thingy, THINGY) \
158 PYRA_SYSFS_R(thingy, THINGY)
160 #define PYRA_BIN_ATTRIBUTE_RW(thingy, THINGY) \
161 PYRA_SYSFS_RW(thingy, THINGY); \
162 static struct bin_attribute bin_attr_##thingy = { \
163 .attr = { .name = #thingy, .mode = 0660 }, \
164 .size = PYRA_SIZE_ ## THINGY, \
165 .read = pyra_sysfs_read_ ## thingy, \
166 .write = pyra_sysfs_write_ ## thingy \
169 #define PYRA_BIN_ATTRIBUTE_R(thingy, THINGY) \
170 PYRA_SYSFS_R(thingy, THINGY); \
171 static struct bin_attribute bin_attr_##thingy = { \
172 .attr = { .name = #thingy, .mode = 0440 }, \
173 .size = PYRA_SIZE_ ## THINGY, \
174 .read = pyra_sysfs_read_ ## thingy, \
177 #define PYRA_BIN_ATTRIBUTE_W(thingy, THINGY) \
178 PYRA_SYSFS_W(thingy, THINGY); \
179 static struct bin_attribute bin_attr_##thingy = { \
180 .attr = { .name = #thingy, .mode = 0220 }, \
181 .size = PYRA_SIZE_ ## THINGY, \
182 .write = pyra_sysfs_write_ ## thingy \
185 PYRA_BIN_ATTRIBUTE_W(control
, CONTROL
);
186 PYRA_BIN_ATTRIBUTE_RW(info
, INFO
);
187 PYRA_BIN_ATTRIBUTE_RW(profile_settings
, PROFILE_SETTINGS
);
188 PYRA_BIN_ATTRIBUTE_RW(profile_buttons
, PROFILE_BUTTONS
);
190 static ssize_t
pyra_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
= pyra_send_control(usb_dev
, *(uint
*)(attr
->private),
200 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS
);
204 return pyra_sysfs_read(fp
, kobj
, buf
, off
, count
,
205 PYRA_SIZE_PROFILE_SETTINGS
,
206 PYRA_COMMAND_PROFILE_SETTINGS
);
209 static ssize_t
pyra_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
= pyra_send_control(usb_dev
, *(uint
*)(attr
->private),
219 PYRA_CONTROL_REQUEST_PROFILE_BUTTONS
);
223 return pyra_sysfs_read(fp
, kobj
, buf
, off
, count
,
224 PYRA_SIZE_PROFILE_BUTTONS
,
225 PYRA_COMMAND_PROFILE_BUTTONS
);
228 #define PROFILE_ATTR(number) \
229 static struct bin_attribute bin_attr_profile##number##_settings = { \
230 .attr = { .name = "profile" #number "_settings", .mode = 0440 }, \
231 .size = PYRA_SIZE_PROFILE_SETTINGS, \
232 .read = pyra_sysfs_read_profilex_settings, \
233 .private = &profile_numbers[number-1], \
235 static struct bin_attribute bin_attr_profile##number##_buttons = { \
236 .attr = { .name = "profile" #number "_buttons", .mode = 0440 }, \
237 .size = PYRA_SIZE_PROFILE_BUTTONS, \
238 .read = pyra_sysfs_read_profilex_buttons, \
239 .private = &profile_numbers[number-1], \
247 static ssize_t
pyra_sysfs_write_settings(struct file
*fp
,
248 struct kobject
*kobj
, struct bin_attribute
*attr
, char *buf
,
249 loff_t off
, size_t count
)
252 container_of(kobj
, struct device
, kobj
)->parent
->parent
;
253 struct pyra_device
*pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
254 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
256 struct pyra_roccat_report roccat_report
;
257 struct pyra_settings
const *settings
;
259 if (off
!= 0 || count
!= PYRA_SIZE_SETTINGS
)
262 settings
= (struct pyra_settings
const *)buf
;
263 if (settings
->startup_profile
>= ARRAY_SIZE(pyra
->profile_settings
))
266 mutex_lock(&pyra
->pyra_lock
);
268 retval
= pyra_set_settings(usb_dev
, settings
);
270 mutex_unlock(&pyra
->pyra_lock
);
274 profile_activated(pyra
, settings
->startup_profile
);
276 roccat_report
.type
= PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2
;
277 roccat_report
.value
= settings
->startup_profile
+ 1;
278 roccat_report
.key
= 0;
279 roccat_report_event(pyra
->chrdev_minor
,
280 (uint8_t const *)&roccat_report
);
282 mutex_unlock(&pyra
->pyra_lock
);
283 return PYRA_SIZE_SETTINGS
;
286 PYRA_SYSFS_R(settings
, SETTINGS
);
287 static struct bin_attribute bin_attr_settings
=
288 __BIN_ATTR(settings
, (S_IWUSR
| S_IRUGO
),
289 pyra_sysfs_read_settings
, pyra_sysfs_write_settings
,
292 static ssize_t
pyra_sysfs_show_actual_cpi(struct device
*dev
,
293 struct device_attribute
*attr
, char *buf
)
295 struct pyra_device
*pyra
=
296 hid_get_drvdata(dev_get_drvdata(dev
->parent
->parent
));
297 return snprintf(buf
, PAGE_SIZE
, "%d\n", pyra
->actual_cpi
);
299 static DEVICE_ATTR(actual_cpi
, 0440, pyra_sysfs_show_actual_cpi
, NULL
);
301 static ssize_t
pyra_sysfs_show_actual_profile(struct device
*dev
,
302 struct device_attribute
*attr
, char *buf
)
304 struct pyra_device
*pyra
=
305 hid_get_drvdata(dev_get_drvdata(dev
->parent
->parent
));
306 struct usb_device
*usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
307 struct pyra_settings settings
;
309 mutex_lock(&pyra
->pyra_lock
);
310 roccat_common2_receive(usb_dev
, PYRA_COMMAND_SETTINGS
,
311 &settings
, PYRA_SIZE_SETTINGS
);
312 mutex_unlock(&pyra
->pyra_lock
);
314 return snprintf(buf
, PAGE_SIZE
, "%d\n", settings
.startup_profile
);
316 static DEVICE_ATTR(actual_profile
, 0440, pyra_sysfs_show_actual_profile
, NULL
);
317 static DEVICE_ATTR(startup_profile
, 0440, pyra_sysfs_show_actual_profile
, NULL
);
319 static ssize_t
pyra_sysfs_show_firmware_version(struct device
*dev
,
320 struct device_attribute
*attr
, char *buf
)
322 struct pyra_device
*pyra
;
323 struct usb_device
*usb_dev
;
324 struct pyra_info info
;
326 dev
= dev
->parent
->parent
;
327 pyra
= hid_get_drvdata(dev_get_drvdata(dev
));
328 usb_dev
= interface_to_usbdev(to_usb_interface(dev
));
330 mutex_lock(&pyra
->pyra_lock
);
331 roccat_common2_receive(usb_dev
, PYRA_COMMAND_INFO
,
332 &info
, PYRA_SIZE_INFO
);
333 mutex_unlock(&pyra
->pyra_lock
);
335 return snprintf(buf
, PAGE_SIZE
, "%d\n", info
.firmware_version
);
337 static DEVICE_ATTR(firmware_version
, 0440, pyra_sysfs_show_firmware_version
,
340 static struct attribute
*pyra_attrs
[] = {
341 &dev_attr_actual_cpi
.attr
,
342 &dev_attr_actual_profile
.attr
,
343 &dev_attr_firmware_version
.attr
,
344 &dev_attr_startup_profile
.attr
,
348 static struct bin_attribute
*pyra_bin_attributes
[] = {
351 &bin_attr_profile_settings
,
352 &bin_attr_profile_buttons
,
354 &bin_attr_profile1_settings
,
355 &bin_attr_profile2_settings
,
356 &bin_attr_profile3_settings
,
357 &bin_attr_profile4_settings
,
358 &bin_attr_profile5_settings
,
359 &bin_attr_profile1_buttons
,
360 &bin_attr_profile2_buttons
,
361 &bin_attr_profile3_buttons
,
362 &bin_attr_profile4_buttons
,
363 &bin_attr_profile5_buttons
,
367 static const struct attribute_group pyra_group
= {
369 .bin_attrs
= pyra_bin_attributes
,
372 static const struct attribute_group
*pyra_groups
[] = {
377 static int pyra_init_pyra_device_struct(struct usb_device
*usb_dev
,
378 struct pyra_device
*pyra
)
380 struct pyra_settings settings
;
383 mutex_init(&pyra
->pyra_lock
);
385 retval
= pyra_get_settings(usb_dev
, &settings
);
389 for (i
= 0; i
< 5; ++i
) {
390 retval
= pyra_get_profile_settings(usb_dev
,
391 &pyra
->profile_settings
[i
], i
);
396 profile_activated(pyra
, settings
.startup_profile
);
401 static int pyra_init_specials(struct hid_device
*hdev
)
403 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
404 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
405 struct pyra_device
*pyra
;
408 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
409 == USB_INTERFACE_PROTOCOL_MOUSE
) {
411 pyra
= kzalloc(sizeof(*pyra
), GFP_KERNEL
);
413 hid_err(hdev
, "can't alloc device descriptor\n");
416 hid_set_drvdata(hdev
, pyra
);
418 retval
= pyra_init_pyra_device_struct(usb_dev
, pyra
);
420 hid_err(hdev
, "couldn't init struct pyra_device\n");
424 retval
= roccat_connect(pyra_class
, hdev
,
425 sizeof(struct pyra_roccat_report
));
427 hid_err(hdev
, "couldn't init char dev\n");
429 pyra
->chrdev_minor
= retval
;
430 pyra
->roccat_claimed
= 1;
433 hid_set_drvdata(hdev
, NULL
);
442 static void pyra_remove_specials(struct hid_device
*hdev
)
444 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
445 struct pyra_device
*pyra
;
447 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
448 == USB_INTERFACE_PROTOCOL_MOUSE
) {
449 pyra
= hid_get_drvdata(hdev
);
450 if (pyra
->roccat_claimed
)
451 roccat_disconnect(pyra
->chrdev_minor
);
452 kfree(hid_get_drvdata(hdev
));
456 static int pyra_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
460 retval
= hid_parse(hdev
);
462 hid_err(hdev
, "parse failed\n");
466 retval
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
468 hid_err(hdev
, "hw start failed\n");
472 retval
= pyra_init_specials(hdev
);
474 hid_err(hdev
, "couldn't install mouse\n");
485 static void pyra_remove(struct hid_device
*hdev
)
487 pyra_remove_specials(hdev
);
491 static void pyra_keep_values_up_to_date(struct pyra_device
*pyra
,
494 struct pyra_mouse_event_button
const *button_event
;
497 case PYRA_MOUSE_REPORT_NUMBER_BUTTON
:
498 button_event
= (struct pyra_mouse_event_button
const *)data
;
499 switch (button_event
->type
) {
500 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2
:
501 profile_activated(pyra
, button_event
->data1
- 1);
503 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI
:
504 pyra
->actual_cpi
= button_event
->data1
;
511 static void pyra_report_to_chrdev(struct pyra_device
const *pyra
,
514 struct pyra_roccat_report roccat_report
;
515 struct pyra_mouse_event_button
const *button_event
;
517 if (data
[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON
)
520 button_event
= (struct pyra_mouse_event_button
const *)data
;
522 switch (button_event
->type
) {
523 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2
:
524 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI
:
525 roccat_report
.type
= button_event
->type
;
526 roccat_report
.value
= button_event
->data1
;
527 roccat_report
.key
= 0;
528 roccat_report_event(pyra
->chrdev_minor
,
529 (uint8_t const *)&roccat_report
);
531 case PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO
:
532 case PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT
:
533 case PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH
:
534 if (button_event
->data2
== PYRA_MOUSE_EVENT_BUTTON_PRESS
) {
535 roccat_report
.type
= button_event
->type
;
536 roccat_report
.key
= button_event
->data1
;
538 * pyra reports profile numbers with range 1-5.
539 * Keeping this behaviour.
541 roccat_report
.value
= pyra
->actual_profile
+ 1;
542 roccat_report_event(pyra
->chrdev_minor
,
543 (uint8_t const *)&roccat_report
);
549 static int pyra_raw_event(struct hid_device
*hdev
, struct hid_report
*report
,
552 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
553 struct pyra_device
*pyra
= hid_get_drvdata(hdev
);
555 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
556 != USB_INTERFACE_PROTOCOL_MOUSE
)
562 pyra_keep_values_up_to_date(pyra
, data
);
564 if (pyra
->roccat_claimed
)
565 pyra_report_to_chrdev(pyra
, data
);
570 static const struct hid_device_id pyra_devices
[] = {
571 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT
,
572 USB_DEVICE_ID_ROCCAT_PYRA_WIRED
) },
573 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT
,
574 USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS
) },
578 MODULE_DEVICE_TABLE(hid
, pyra_devices
);
580 static struct hid_driver pyra_driver
= {
582 .id_table
= pyra_devices
,
584 .remove
= pyra_remove
,
585 .raw_event
= pyra_raw_event
588 static int __init
pyra_init(void)
592 /* class name has to be same as driver name */
593 pyra_class
= class_create(THIS_MODULE
, "pyra");
594 if (IS_ERR(pyra_class
))
595 return PTR_ERR(pyra_class
);
596 pyra_class
->dev_groups
= pyra_groups
;
598 retval
= hid_register_driver(&pyra_driver
);
600 class_destroy(pyra_class
);
604 static void __exit
pyra_exit(void)
606 hid_unregister_driver(&pyra_driver
);
607 class_destroy(pyra_class
);
610 module_init(pyra_init
);
611 module_exit(pyra_exit
);
613 MODULE_AUTHOR("Stefan Achatz");
614 MODULE_DESCRIPTION("USB Roccat Pyra driver");
615 MODULE_LICENSE("GPL v2");