1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Roccat Pyra driver for Linux
5 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
12 * Roccat Pyra is a mobile gamer mouse which comes in wired and wireless
13 * variant. Wireless variant is not tested.
14 * Userland tools can be found at http://sourceforge.net/projects/roccat
17 #include <linux/device.h>
18 #include <linux/input.h>
19 #include <linux/hid.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/hid-roccat.h>
24 #include "hid-roccat-common.h"
25 #include "hid-roccat-pyra.h"
27 static uint profile_numbers[5] = {0, 1, 2, 3, 4};
29 static void profile_activated(struct pyra_device *pyra,
30 unsigned int new_profile)
32 if (new_profile >= ARRAY_SIZE(pyra->profile_settings))
34 pyra->actual_profile = new_profile;
35 pyra->actual_cpi = pyra->profile_settings[pyra->actual_profile].y_cpi;
38 static int pyra_send_control(struct usb_device *usb_dev, int value,
39 enum pyra_control_requests request)
41 struct roccat_common2_control control;
43 if ((request == PYRA_CONTROL_REQUEST_PROFILE_SETTINGS ||
44 request == PYRA_CONTROL_REQUEST_PROFILE_BUTTONS) &&
45 (value < 0 || value > 4))
48 control.command = ROCCAT_COMMON_COMMAND_CONTROL;
49 control.value = value;
50 control.request = request;
52 return roccat_common2_send(usb_dev, ROCCAT_COMMON_COMMAND_CONTROL,
53 &control, sizeof(struct roccat_common2_control));
56 static int pyra_get_profile_settings(struct usb_device *usb_dev,
57 struct pyra_profile_settings *buf, int number)
60 retval = pyra_send_control(usb_dev, number,
61 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
64 return roccat_common2_receive(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS,
65 buf, PYRA_SIZE_PROFILE_SETTINGS);
68 static int pyra_get_settings(struct usb_device *usb_dev,
69 struct pyra_settings *buf)
71 return roccat_common2_receive(usb_dev, PYRA_COMMAND_SETTINGS,
72 buf, PYRA_SIZE_SETTINGS);
75 static int pyra_set_settings(struct usb_device *usb_dev,
76 struct pyra_settings const *settings)
78 return roccat_common2_send_with_status(usb_dev,
79 PYRA_COMMAND_SETTINGS, settings,
83 static ssize_t pyra_sysfs_read(struct file *fp, struct kobject *kobj,
84 char *buf, loff_t off, size_t count,
85 size_t real_size, uint command)
87 struct device *dev = kobj_to_dev(kobj)->parent->parent;
88 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
89 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
95 if (off != 0 || count != real_size)
98 mutex_lock(&pyra->pyra_lock);
99 retval = roccat_common2_receive(usb_dev, command, buf, real_size);
100 mutex_unlock(&pyra->pyra_lock);
108 static ssize_t pyra_sysfs_write(struct file *fp, struct kobject *kobj,
109 void const *buf, loff_t off, size_t count,
110 size_t real_size, uint command)
112 struct device *dev = kobj_to_dev(kobj)->parent->parent;
113 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
114 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
117 if (off != 0 || count != real_size)
120 mutex_lock(&pyra->pyra_lock);
121 retval = roccat_common2_send_with_status(usb_dev, command, (void *)buf, real_size);
122 mutex_unlock(&pyra->pyra_lock);
130 #define PYRA_SYSFS_W(thingy, THINGY) \
131 static ssize_t pyra_sysfs_write_ ## thingy(struct file *fp, \
132 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
133 loff_t off, size_t count) \
135 return pyra_sysfs_write(fp, kobj, buf, off, count, \
136 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
139 #define PYRA_SYSFS_R(thingy, THINGY) \
140 static ssize_t pyra_sysfs_read_ ## thingy(struct file *fp, \
141 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
142 loff_t off, size_t count) \
144 return pyra_sysfs_read(fp, kobj, buf, off, count, \
145 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
148 #define PYRA_SYSFS_RW(thingy, THINGY) \
149 PYRA_SYSFS_W(thingy, THINGY) \
150 PYRA_SYSFS_R(thingy, THINGY)
152 #define PYRA_BIN_ATTRIBUTE_RW(thingy, THINGY) \
153 PYRA_SYSFS_RW(thingy, THINGY); \
154 static struct bin_attribute bin_attr_##thingy = { \
155 .attr = { .name = #thingy, .mode = 0660 }, \
156 .size = PYRA_SIZE_ ## THINGY, \
157 .read = pyra_sysfs_read_ ## thingy, \
158 .write = pyra_sysfs_write_ ## thingy \
161 #define PYRA_BIN_ATTRIBUTE_R(thingy, THINGY) \
162 PYRA_SYSFS_R(thingy, THINGY); \
163 static struct bin_attribute bin_attr_##thingy = { \
164 .attr = { .name = #thingy, .mode = 0440 }, \
165 .size = PYRA_SIZE_ ## THINGY, \
166 .read = pyra_sysfs_read_ ## thingy, \
169 #define PYRA_BIN_ATTRIBUTE_W(thingy, THINGY) \
170 PYRA_SYSFS_W(thingy, THINGY); \
171 static struct bin_attribute bin_attr_##thingy = { \
172 .attr = { .name = #thingy, .mode = 0220 }, \
173 .size = PYRA_SIZE_ ## THINGY, \
174 .write = pyra_sysfs_write_ ## thingy \
177 PYRA_BIN_ATTRIBUTE_W(control, CONTROL);
178 PYRA_BIN_ATTRIBUTE_RW(info, INFO);
179 PYRA_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS);
180 PYRA_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS);
182 static ssize_t pyra_sysfs_read_profilex_settings(struct file *fp,
183 struct kobject *kobj, struct bin_attribute *attr, char *buf,
184 loff_t off, size_t count)
186 struct device *dev = kobj_to_dev(kobj)->parent->parent;
187 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
190 retval = pyra_send_control(usb_dev, *(uint *)(attr->private),
191 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
195 return pyra_sysfs_read(fp, kobj, buf, off, count,
196 PYRA_SIZE_PROFILE_SETTINGS,
197 PYRA_COMMAND_PROFILE_SETTINGS);
200 static ssize_t pyra_sysfs_read_profilex_buttons(struct file *fp,
201 struct kobject *kobj, struct bin_attribute *attr, char *buf,
202 loff_t off, size_t count)
204 struct device *dev = kobj_to_dev(kobj)->parent->parent;
205 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
208 retval = pyra_send_control(usb_dev, *(uint *)(attr->private),
209 PYRA_CONTROL_REQUEST_PROFILE_BUTTONS);
213 return pyra_sysfs_read(fp, kobj, buf, off, count,
214 PYRA_SIZE_PROFILE_BUTTONS,
215 PYRA_COMMAND_PROFILE_BUTTONS);
218 #define PROFILE_ATTR(number) \
219 static struct bin_attribute bin_attr_profile##number##_settings = { \
220 .attr = { .name = "profile" #number "_settings", .mode = 0440 }, \
221 .size = PYRA_SIZE_PROFILE_SETTINGS, \
222 .read = pyra_sysfs_read_profilex_settings, \
223 .private = &profile_numbers[number-1], \
225 static struct bin_attribute bin_attr_profile##number##_buttons = { \
226 .attr = { .name = "profile" #number "_buttons", .mode = 0440 }, \
227 .size = PYRA_SIZE_PROFILE_BUTTONS, \
228 .read = pyra_sysfs_read_profilex_buttons, \
229 .private = &profile_numbers[number-1], \
237 static ssize_t pyra_sysfs_write_settings(struct file *fp,
238 struct kobject *kobj, struct bin_attribute *attr, char *buf,
239 loff_t off, size_t count)
241 struct device *dev = kobj_to_dev(kobj)->parent->parent;
242 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
243 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
245 struct pyra_roccat_report roccat_report;
246 struct pyra_settings const *settings;
248 if (off != 0 || count != PYRA_SIZE_SETTINGS)
251 settings = (struct pyra_settings const *)buf;
252 if (settings->startup_profile >= ARRAY_SIZE(pyra->profile_settings))
255 mutex_lock(&pyra->pyra_lock);
257 retval = pyra_set_settings(usb_dev, settings);
259 mutex_unlock(&pyra->pyra_lock);
263 profile_activated(pyra, settings->startup_profile);
265 roccat_report.type = PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2;
266 roccat_report.value = settings->startup_profile + 1;
267 roccat_report.key = 0;
268 roccat_report_event(pyra->chrdev_minor,
269 (uint8_t const *)&roccat_report);
271 mutex_unlock(&pyra->pyra_lock);
272 return PYRA_SIZE_SETTINGS;
275 PYRA_SYSFS_R(settings, SETTINGS);
276 static struct bin_attribute bin_attr_settings =
277 __BIN_ATTR(settings, (S_IWUSR | S_IRUGO),
278 pyra_sysfs_read_settings, pyra_sysfs_write_settings,
281 static ssize_t pyra_sysfs_show_actual_cpi(struct device *dev,
282 struct device_attribute *attr, char *buf)
284 struct pyra_device *pyra =
285 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
286 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_cpi);
288 static DEVICE_ATTR(actual_cpi, 0440, pyra_sysfs_show_actual_cpi, NULL);
290 static ssize_t pyra_sysfs_show_actual_profile(struct device *dev,
291 struct device_attribute *attr, char *buf)
293 struct pyra_device *pyra =
294 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
295 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
296 struct pyra_settings settings;
298 mutex_lock(&pyra->pyra_lock);
299 roccat_common2_receive(usb_dev, PYRA_COMMAND_SETTINGS,
300 &settings, PYRA_SIZE_SETTINGS);
301 mutex_unlock(&pyra->pyra_lock);
303 return snprintf(buf, PAGE_SIZE, "%d\n", settings.startup_profile);
305 static DEVICE_ATTR(actual_profile, 0440, pyra_sysfs_show_actual_profile, NULL);
306 static DEVICE_ATTR(startup_profile, 0440, pyra_sysfs_show_actual_profile, NULL);
308 static ssize_t pyra_sysfs_show_firmware_version(struct device *dev,
309 struct device_attribute *attr, char *buf)
311 struct pyra_device *pyra;
312 struct usb_device *usb_dev;
313 struct pyra_info info;
315 dev = dev->parent->parent;
316 pyra = hid_get_drvdata(dev_get_drvdata(dev));
317 usb_dev = interface_to_usbdev(to_usb_interface(dev));
319 mutex_lock(&pyra->pyra_lock);
320 roccat_common2_receive(usb_dev, PYRA_COMMAND_INFO,
321 &info, PYRA_SIZE_INFO);
322 mutex_unlock(&pyra->pyra_lock);
324 return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
326 static DEVICE_ATTR(firmware_version, 0440, pyra_sysfs_show_firmware_version,
329 static struct attribute *pyra_attrs[] = {
330 &dev_attr_actual_cpi.attr,
331 &dev_attr_actual_profile.attr,
332 &dev_attr_firmware_version.attr,
333 &dev_attr_startup_profile.attr,
337 static struct bin_attribute *pyra_bin_attributes[] = {
340 &bin_attr_profile_settings,
341 &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 pyra_group = {
358 .bin_attrs = pyra_bin_attributes,
361 static const struct attribute_group *pyra_groups[] = {
366 /* pyra_class is used for creating sysfs attributes via roccat char device */
367 static const struct class pyra_class = {
369 .dev_groups = 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 if (!hid_is_usb(hdev))
458 retval = hid_parse(hdev);
460 hid_err(hdev, "parse failed\n");
464 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
466 hid_err(hdev, "hw start failed\n");
470 retval = pyra_init_specials(hdev);
472 hid_err(hdev, "couldn't install mouse\n");
483 static void pyra_remove(struct hid_device *hdev)
485 pyra_remove_specials(hdev);
489 static void pyra_keep_values_up_to_date(struct pyra_device *pyra,
492 struct pyra_mouse_event_button const *button_event;
495 case PYRA_MOUSE_REPORT_NUMBER_BUTTON:
496 button_event = (struct pyra_mouse_event_button const *)data;
497 switch (button_event->type) {
498 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
499 profile_activated(pyra, button_event->data1 - 1);
501 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
502 pyra->actual_cpi = button_event->data1;
509 static void pyra_report_to_chrdev(struct pyra_device const *pyra,
512 struct pyra_roccat_report roccat_report;
513 struct pyra_mouse_event_button const *button_event;
515 if (data[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON)
518 button_event = (struct pyra_mouse_event_button const *)data;
520 switch (button_event->type) {
521 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
522 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
523 roccat_report.type = button_event->type;
524 roccat_report.value = button_event->data1;
525 roccat_report.key = 0;
526 roccat_report_event(pyra->chrdev_minor,
527 (uint8_t const *)&roccat_report);
529 case PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO:
530 case PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT:
531 case PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH:
532 if (button_event->data2 == PYRA_MOUSE_EVENT_BUTTON_PRESS) {
533 roccat_report.type = button_event->type;
534 roccat_report.key = button_event->data1;
536 * pyra reports profile numbers with range 1-5.
537 * Keeping this behaviour.
539 roccat_report.value = pyra->actual_profile + 1;
540 roccat_report_event(pyra->chrdev_minor,
541 (uint8_t const *)&roccat_report);
547 static int pyra_raw_event(struct hid_device *hdev, struct hid_report *report,
550 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
551 struct pyra_device *pyra = hid_get_drvdata(hdev);
553 if (intf->cur_altsetting->desc.bInterfaceProtocol
554 != USB_INTERFACE_PROTOCOL_MOUSE)
560 pyra_keep_values_up_to_date(pyra, data);
562 if (pyra->roccat_claimed)
563 pyra_report_to_chrdev(pyra, data);
568 static const struct hid_device_id pyra_devices[] = {
569 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
570 USB_DEVICE_ID_ROCCAT_PYRA_WIRED) },
571 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
572 USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS) },
576 MODULE_DEVICE_TABLE(hid, pyra_devices);
578 static struct hid_driver pyra_driver = {
580 .id_table = pyra_devices,
582 .remove = pyra_remove,
583 .raw_event = pyra_raw_event
586 static int __init pyra_init(void)
590 /* class name has to be same as driver name */
591 retval = class_register(&pyra_class);
595 retval = hid_register_driver(&pyra_driver);
597 class_unregister(&pyra_class);
601 static void __exit pyra_exit(void)
603 hid_unregister_driver(&pyra_driver);
604 class_unregister(&pyra_class);
607 module_init(pyra_init);
608 module_exit(pyra_exit);
610 MODULE_AUTHOR("Stefan Achatz");
611 MODULE_DESCRIPTION("USB Roccat Pyra driver");
612 MODULE_LICENSE("GPL v2");