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 pyra->actual_profile = new_profile;
39 pyra->actual_cpi = pyra->profile_settings[pyra->actual_profile].y_cpi;
42 static int pyra_send_control(struct usb_device *usb_dev, int value,
43 enum pyra_control_requests request)
45 struct pyra_control control;
47 if ((request == PYRA_CONTROL_REQUEST_PROFILE_SETTINGS ||
48 request == PYRA_CONTROL_REQUEST_PROFILE_BUTTONS) &&
49 (value < 0 || value > 4))
52 control.command = PYRA_COMMAND_CONTROL;
53 control.value = value;
54 control.request = request;
56 return roccat_common_send(usb_dev, PYRA_COMMAND_CONTROL,
57 &control, sizeof(struct pyra_control));
60 static int pyra_receive_control_status(struct usb_device *usb_dev)
63 struct pyra_control control;
67 retval = roccat_common_receive(usb_dev, PYRA_COMMAND_CONTROL,
68 &control, sizeof(struct pyra_control));
70 /* requested too early, try again */
71 } while (retval == -EPROTO);
73 if (!retval && control.command == PYRA_COMMAND_CONTROL &&
74 control.request == PYRA_CONTROL_REQUEST_STATUS &&
78 hid_err(usb_dev, "receive control status: unknown response 0x%x 0x%x\n",
79 control.request, control.value);
80 return retval ? retval : -EINVAL;
84 static int pyra_get_profile_settings(struct usb_device *usb_dev,
85 struct pyra_profile_settings *buf, int number)
88 retval = pyra_send_control(usb_dev, number,
89 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
92 return roccat_common_receive(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS,
93 buf, sizeof(struct pyra_profile_settings));
96 static int pyra_get_profile_buttons(struct usb_device *usb_dev,
97 struct pyra_profile_buttons *buf, int number)
100 retval = pyra_send_control(usb_dev, number,
101 PYRA_CONTROL_REQUEST_PROFILE_BUTTONS);
104 return roccat_common_receive(usb_dev, PYRA_COMMAND_PROFILE_BUTTONS,
105 buf, sizeof(struct pyra_profile_buttons));
108 static int pyra_get_settings(struct usb_device *usb_dev,
109 struct pyra_settings *buf)
111 return roccat_common_receive(usb_dev, PYRA_COMMAND_SETTINGS,
112 buf, sizeof(struct pyra_settings));
115 static int pyra_get_info(struct usb_device *usb_dev, struct pyra_info *buf)
117 return roccat_common_receive(usb_dev, PYRA_COMMAND_INFO,
118 buf, sizeof(struct pyra_info));
121 static int pyra_send(struct usb_device *usb_dev, uint command,
122 void const *buf, uint size)
125 retval = roccat_common_send(usb_dev, command, buf, size);
128 return pyra_receive_control_status(usb_dev);
131 static int pyra_set_profile_settings(struct usb_device *usb_dev,
132 struct pyra_profile_settings const *settings)
134 return pyra_send(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS, settings,
135 sizeof(struct pyra_profile_settings));
138 static int pyra_set_profile_buttons(struct usb_device *usb_dev,
139 struct pyra_profile_buttons const *buttons)
141 return pyra_send(usb_dev, PYRA_COMMAND_PROFILE_BUTTONS, buttons,
142 sizeof(struct pyra_profile_buttons));
145 static int pyra_set_settings(struct usb_device *usb_dev,
146 struct pyra_settings const *settings)
148 return pyra_send(usb_dev, PYRA_COMMAND_SETTINGS, settings,
149 sizeof(struct pyra_settings));
152 static ssize_t pyra_sysfs_read_profilex_settings(struct file *fp,
153 struct kobject *kobj, struct bin_attribute *attr, char *buf,
154 loff_t off, size_t count)
157 container_of(kobj, struct device, kobj)->parent->parent;
158 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
160 if (off >= sizeof(struct pyra_profile_settings))
163 if (off + count > sizeof(struct pyra_profile_settings))
164 count = sizeof(struct pyra_profile_settings) - off;
166 mutex_lock(&pyra->pyra_lock);
167 memcpy(buf, ((char const *)&pyra->profile_settings[*(uint *)(attr->private)]) + off,
169 mutex_unlock(&pyra->pyra_lock);
174 static ssize_t pyra_sysfs_read_profilex_buttons(struct file *fp,
175 struct kobject *kobj, struct bin_attribute *attr, char *buf,
176 loff_t off, size_t count)
179 container_of(kobj, struct device, kobj)->parent->parent;
180 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
182 if (off >= sizeof(struct pyra_profile_buttons))
185 if (off + count > sizeof(struct pyra_profile_buttons))
186 count = sizeof(struct pyra_profile_buttons) - off;
188 mutex_lock(&pyra->pyra_lock);
189 memcpy(buf, ((char const *)&pyra->profile_buttons[*(uint *)(attr->private)]) + off,
191 mutex_unlock(&pyra->pyra_lock);
196 static ssize_t pyra_sysfs_write_profile_settings(struct file *fp,
197 struct kobject *kobj, struct bin_attribute *attr, char *buf,
198 loff_t off, size_t count)
201 container_of(kobj, struct device, kobj)->parent->parent;
202 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
203 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
207 struct pyra_profile_settings *profile_settings;
209 if (off != 0 || count != sizeof(struct pyra_profile_settings))
212 profile_number = ((struct pyra_profile_settings const *)buf)->number;
213 profile_settings = &pyra->profile_settings[profile_number];
215 mutex_lock(&pyra->pyra_lock);
216 difference = memcmp(buf, profile_settings,
217 sizeof(struct pyra_profile_settings));
219 retval = pyra_set_profile_settings(usb_dev,
220 (struct pyra_profile_settings const *)buf);
222 memcpy(profile_settings, buf,
223 sizeof(struct pyra_profile_settings));
225 mutex_unlock(&pyra->pyra_lock);
230 return sizeof(struct pyra_profile_settings);
233 static ssize_t pyra_sysfs_write_profile_buttons(struct file *fp,
234 struct kobject *kobj, struct bin_attribute *attr, char *buf,
235 loff_t off, size_t count)
238 container_of(kobj, struct device, kobj)->parent->parent;
239 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
240 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
244 struct pyra_profile_buttons *profile_buttons;
246 if (off != 0 || count != sizeof(struct pyra_profile_buttons))
249 profile_number = ((struct pyra_profile_buttons const *)buf)->number;
250 profile_buttons = &pyra->profile_buttons[profile_number];
252 mutex_lock(&pyra->pyra_lock);
253 difference = memcmp(buf, profile_buttons,
254 sizeof(struct pyra_profile_buttons));
256 retval = pyra_set_profile_buttons(usb_dev,
257 (struct pyra_profile_buttons const *)buf);
259 memcpy(profile_buttons, buf,
260 sizeof(struct pyra_profile_buttons));
262 mutex_unlock(&pyra->pyra_lock);
267 return sizeof(struct pyra_profile_buttons);
270 static ssize_t pyra_sysfs_read_settings(struct file *fp,
271 struct kobject *kobj, struct bin_attribute *attr, char *buf,
272 loff_t off, size_t count)
275 container_of(kobj, struct device, kobj)->parent->parent;
276 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
278 if (off >= sizeof(struct pyra_settings))
281 if (off + count > sizeof(struct pyra_settings))
282 count = sizeof(struct pyra_settings) - off;
284 mutex_lock(&pyra->pyra_lock);
285 memcpy(buf, ((char const *)&pyra->settings) + off, count);
286 mutex_unlock(&pyra->pyra_lock);
291 static ssize_t pyra_sysfs_write_settings(struct file *fp,
292 struct kobject *kobj, struct bin_attribute *attr, char *buf,
293 loff_t off, size_t count)
296 container_of(kobj, struct device, kobj)->parent->parent;
297 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
298 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
301 struct pyra_roccat_report roccat_report;
303 if (off != 0 || count != sizeof(struct pyra_settings))
306 mutex_lock(&pyra->pyra_lock);
307 difference = memcmp(buf, &pyra->settings, sizeof(struct pyra_settings));
309 retval = pyra_set_settings(usb_dev,
310 (struct pyra_settings const *)buf);
312 mutex_unlock(&pyra->pyra_lock);
316 memcpy(&pyra->settings, buf,
317 sizeof(struct pyra_settings));
319 profile_activated(pyra, pyra->settings.startup_profile);
321 roccat_report.type = PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2;
322 roccat_report.value = pyra->settings.startup_profile + 1;
323 roccat_report.key = 0;
324 roccat_report_event(pyra->chrdev_minor,
325 (uint8_t const *)&roccat_report);
327 mutex_unlock(&pyra->pyra_lock);
328 return sizeof(struct pyra_settings);
332 static ssize_t pyra_sysfs_show_actual_cpi(struct device *dev,
333 struct device_attribute *attr, char *buf)
335 struct pyra_device *pyra =
336 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
337 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_cpi);
340 static ssize_t pyra_sysfs_show_actual_profile(struct device *dev,
341 struct device_attribute *attr, char *buf)
343 struct pyra_device *pyra =
344 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
345 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_profile);
348 static ssize_t pyra_sysfs_show_firmware_version(struct device *dev,
349 struct device_attribute *attr, char *buf)
351 struct pyra_device *pyra =
352 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
353 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->firmware_version);
356 static ssize_t pyra_sysfs_show_startup_profile(struct device *dev,
357 struct device_attribute *attr, char *buf)
359 struct pyra_device *pyra =
360 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
361 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->settings.startup_profile);
364 static struct device_attribute pyra_attributes[] = {
365 __ATTR(actual_cpi, 0440, pyra_sysfs_show_actual_cpi, NULL),
366 __ATTR(actual_profile, 0440, pyra_sysfs_show_actual_profile, NULL),
367 __ATTR(firmware_version, 0440,
368 pyra_sysfs_show_firmware_version, NULL),
369 __ATTR(startup_profile, 0440,
370 pyra_sysfs_show_startup_profile, NULL),
374 static struct bin_attribute pyra_bin_attributes[] = {
376 .attr = { .name = "profile_settings", .mode = 0220 },
377 .size = sizeof(struct pyra_profile_settings),
378 .write = pyra_sysfs_write_profile_settings
381 .attr = { .name = "profile1_settings", .mode = 0440 },
382 .size = sizeof(struct pyra_profile_settings),
383 .read = pyra_sysfs_read_profilex_settings,
384 .private = &profile_numbers[0]
387 .attr = { .name = "profile2_settings", .mode = 0440 },
388 .size = sizeof(struct pyra_profile_settings),
389 .read = pyra_sysfs_read_profilex_settings,
390 .private = &profile_numbers[1]
393 .attr = { .name = "profile3_settings", .mode = 0440 },
394 .size = sizeof(struct pyra_profile_settings),
395 .read = pyra_sysfs_read_profilex_settings,
396 .private = &profile_numbers[2]
399 .attr = { .name = "profile4_settings", .mode = 0440 },
400 .size = sizeof(struct pyra_profile_settings),
401 .read = pyra_sysfs_read_profilex_settings,
402 .private = &profile_numbers[3]
405 .attr = { .name = "profile5_settings", .mode = 0440 },
406 .size = sizeof(struct pyra_profile_settings),
407 .read = pyra_sysfs_read_profilex_settings,
408 .private = &profile_numbers[4]
411 .attr = { .name = "profile_buttons", .mode = 0220 },
412 .size = sizeof(struct pyra_profile_buttons),
413 .write = pyra_sysfs_write_profile_buttons
416 .attr = { .name = "profile1_buttons", .mode = 0440 },
417 .size = sizeof(struct pyra_profile_buttons),
418 .read = pyra_sysfs_read_profilex_buttons,
419 .private = &profile_numbers[0]
422 .attr = { .name = "profile2_buttons", .mode = 0440 },
423 .size = sizeof(struct pyra_profile_buttons),
424 .read = pyra_sysfs_read_profilex_buttons,
425 .private = &profile_numbers[1]
428 .attr = { .name = "profile3_buttons", .mode = 0440 },
429 .size = sizeof(struct pyra_profile_buttons),
430 .read = pyra_sysfs_read_profilex_buttons,
431 .private = &profile_numbers[2]
434 .attr = { .name = "profile4_buttons", .mode = 0440 },
435 .size = sizeof(struct pyra_profile_buttons),
436 .read = pyra_sysfs_read_profilex_buttons,
437 .private = &profile_numbers[3]
440 .attr = { .name = "profile5_buttons", .mode = 0440 },
441 .size = sizeof(struct pyra_profile_buttons),
442 .read = pyra_sysfs_read_profilex_buttons,
443 .private = &profile_numbers[4]
446 .attr = { .name = "settings", .mode = 0660 },
447 .size = sizeof(struct pyra_settings),
448 .read = pyra_sysfs_read_settings,
449 .write = pyra_sysfs_write_settings
454 static int pyra_init_pyra_device_struct(struct usb_device *usb_dev,
455 struct pyra_device *pyra)
457 struct pyra_info info;
460 mutex_init(&pyra->pyra_lock);
462 retval = pyra_get_info(usb_dev, &info);
466 pyra->firmware_version = info.firmware_version;
468 retval = pyra_get_settings(usb_dev, &pyra->settings);
472 for (i = 0; i < 5; ++i) {
473 retval = pyra_get_profile_settings(usb_dev,
474 &pyra->profile_settings[i], i);
478 retval = pyra_get_profile_buttons(usb_dev,
479 &pyra->profile_buttons[i], i);
484 profile_activated(pyra, pyra->settings.startup_profile);
489 static int pyra_init_specials(struct hid_device *hdev)
491 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
492 struct usb_device *usb_dev = interface_to_usbdev(intf);
493 struct pyra_device *pyra;
496 if (intf->cur_altsetting->desc.bInterfaceProtocol
497 == USB_INTERFACE_PROTOCOL_MOUSE) {
499 pyra = kzalloc(sizeof(*pyra), GFP_KERNEL);
501 hid_err(hdev, "can't alloc device descriptor\n");
504 hid_set_drvdata(hdev, pyra);
506 retval = pyra_init_pyra_device_struct(usb_dev, pyra);
508 hid_err(hdev, "couldn't init struct pyra_device\n");
512 retval = roccat_connect(pyra_class, hdev,
513 sizeof(struct pyra_roccat_report));
515 hid_err(hdev, "couldn't init char dev\n");
517 pyra->chrdev_minor = retval;
518 pyra->roccat_claimed = 1;
521 hid_set_drvdata(hdev, NULL);
530 static void pyra_remove_specials(struct hid_device *hdev)
532 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
533 struct pyra_device *pyra;
535 if (intf->cur_altsetting->desc.bInterfaceProtocol
536 == USB_INTERFACE_PROTOCOL_MOUSE) {
537 pyra = hid_get_drvdata(hdev);
538 if (pyra->roccat_claimed)
539 roccat_disconnect(pyra->chrdev_minor);
540 kfree(hid_get_drvdata(hdev));
544 static int pyra_probe(struct hid_device *hdev, const struct hid_device_id *id)
548 retval = hid_parse(hdev);
550 hid_err(hdev, "parse failed\n");
554 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
556 hid_err(hdev, "hw start failed\n");
560 retval = pyra_init_specials(hdev);
562 hid_err(hdev, "couldn't install mouse\n");
573 static void pyra_remove(struct hid_device *hdev)
575 pyra_remove_specials(hdev);
579 static void pyra_keep_values_up_to_date(struct pyra_device *pyra,
582 struct pyra_mouse_event_button const *button_event;
585 case PYRA_MOUSE_REPORT_NUMBER_BUTTON:
586 button_event = (struct pyra_mouse_event_button const *)data;
587 switch (button_event->type) {
588 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
589 profile_activated(pyra, button_event->data1 - 1);
591 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
592 pyra->actual_cpi = button_event->data1;
599 static void pyra_report_to_chrdev(struct pyra_device const *pyra,
602 struct pyra_roccat_report roccat_report;
603 struct pyra_mouse_event_button const *button_event;
605 if (data[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON)
608 button_event = (struct pyra_mouse_event_button const *)data;
610 switch (button_event->type) {
611 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
612 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
613 roccat_report.type = button_event->type;
614 roccat_report.value = button_event->data1;
615 roccat_report.key = 0;
616 roccat_report_event(pyra->chrdev_minor,
617 (uint8_t const *)&roccat_report);
619 case PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO:
620 case PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT:
621 case PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH:
622 if (button_event->data2 == PYRA_MOUSE_EVENT_BUTTON_PRESS) {
623 roccat_report.type = button_event->type;
624 roccat_report.key = button_event->data1;
626 * pyra reports profile numbers with range 1-5.
627 * Keeping this behaviour.
629 roccat_report.value = pyra->actual_profile + 1;
630 roccat_report_event(pyra->chrdev_minor,
631 (uint8_t const *)&roccat_report);
637 static int pyra_raw_event(struct hid_device *hdev, struct hid_report *report,
640 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
641 struct pyra_device *pyra = hid_get_drvdata(hdev);
643 if (intf->cur_altsetting->desc.bInterfaceProtocol
644 != USB_INTERFACE_PROTOCOL_MOUSE)
650 pyra_keep_values_up_to_date(pyra, data);
652 if (pyra->roccat_claimed)
653 pyra_report_to_chrdev(pyra, data);
658 static const struct hid_device_id pyra_devices[] = {
659 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
660 USB_DEVICE_ID_ROCCAT_PYRA_WIRED) },
661 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
662 USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS) },
666 MODULE_DEVICE_TABLE(hid, pyra_devices);
668 static struct hid_driver pyra_driver = {
670 .id_table = pyra_devices,
672 .remove = pyra_remove,
673 .raw_event = pyra_raw_event
676 static int __init pyra_init(void)
680 /* class name has to be same as driver name */
681 pyra_class = class_create(THIS_MODULE, "pyra");
682 if (IS_ERR(pyra_class))
683 return PTR_ERR(pyra_class);
684 pyra_class->dev_attrs = pyra_attributes;
685 pyra_class->dev_bin_attrs = pyra_bin_attributes;
687 retval = hid_register_driver(&pyra_driver);
689 class_destroy(pyra_class);
693 static void __exit pyra_exit(void)
695 hid_unregister_driver(&pyra_driver);
696 class_destroy(pyra_class);
699 module_init(pyra_init);
700 module_exit(pyra_exit);
702 MODULE_AUTHOR("Stefan Achatz");
703 MODULE_DESCRIPTION("USB Roccat Pyra driver");
704 MODULE_LICENSE("GPL v2");