Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Roccat Pyra driver for Linux
4 *
5 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
6 */
7
8/*
9 */
10
11/*
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
15 */
16
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>
23#include "hid-ids.h"
24#include "hid-roccat-common.h"
25#include "hid-roccat-pyra.h"
26
27static uint profile_numbers[5] = {0, 1, 2, 3, 4};
28
29/* pyra_class is used for creating sysfs attributes via roccat char device */
30static struct class *pyra_class;
31
32static void profile_activated(struct pyra_device *pyra,
33 unsigned int new_profile)
34{
35 if (new_profile >= ARRAY_SIZE(pyra->profile_settings))
36 return;
37 pyra->actual_profile = new_profile;
38 pyra->actual_cpi = pyra->profile_settings[pyra->actual_profile].y_cpi;
39}
40
41static int pyra_send_control(struct usb_device *usb_dev, int value,
42 enum pyra_control_requests request)
43{
44 struct roccat_common2_control control;
45
46 if ((request == PYRA_CONTROL_REQUEST_PROFILE_SETTINGS ||
47 request == PYRA_CONTROL_REQUEST_PROFILE_BUTTONS) &&
48 (value < 0 || value > 4))
49 return -EINVAL;
50
51 control.command = ROCCAT_COMMON_COMMAND_CONTROL;
52 control.value = value;
53 control.request = request;
54
55 return roccat_common2_send(usb_dev, ROCCAT_COMMON_COMMAND_CONTROL,
56 &control, sizeof(struct roccat_common2_control));
57}
58
59static int pyra_get_profile_settings(struct usb_device *usb_dev,
60 struct pyra_profile_settings *buf, int number)
61{
62 int retval;
63 retval = pyra_send_control(usb_dev, number,
64 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
65 if (retval)
66 return retval;
67 return roccat_common2_receive(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS,
68 buf, PYRA_SIZE_PROFILE_SETTINGS);
69}
70
71static int pyra_get_settings(struct usb_device *usb_dev,
72 struct pyra_settings *buf)
73{
74 return roccat_common2_receive(usb_dev, PYRA_COMMAND_SETTINGS,
75 buf, PYRA_SIZE_SETTINGS);
76}
77
78static int pyra_set_settings(struct usb_device *usb_dev,
79 struct pyra_settings const *settings)
80{
81 return roccat_common2_send_with_status(usb_dev,
82 PYRA_COMMAND_SETTINGS, settings,
83 PYRA_SIZE_SETTINGS);
84}
85
86static ssize_t pyra_sysfs_read(struct file *fp, struct kobject *kobj,
87 char *buf, loff_t off, size_t count,
88 size_t real_size, uint command)
89{
90 struct device *dev = kobj_to_dev(kobj)->parent->parent;
91 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
92 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
93 int retval;
94
95 if (off >= real_size)
96 return 0;
97
98 if (off != 0 || count != real_size)
99 return -EINVAL;
100
101 mutex_lock(&pyra->pyra_lock);
102 retval = roccat_common2_receive(usb_dev, command, buf, real_size);
103 mutex_unlock(&pyra->pyra_lock);
104
105 if (retval)
106 return retval;
107
108 return real_size;
109}
110
111static ssize_t pyra_sysfs_write(struct file *fp, struct kobject *kobj,
112 void const *buf, loff_t off, size_t count,
113 size_t real_size, uint command)
114{
115 struct device *dev = kobj_to_dev(kobj)->parent->parent;
116 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
117 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
118 int retval;
119
120 if (off != 0 || count != real_size)
121 return -EINVAL;
122
123 mutex_lock(&pyra->pyra_lock);
124 retval = roccat_common2_send_with_status(usb_dev, command, (void *)buf, real_size);
125 mutex_unlock(&pyra->pyra_lock);
126
127 if (retval)
128 return retval;
129
130 return real_size;
131}
132
133#define PYRA_SYSFS_W(thingy, THINGY) \
134static ssize_t pyra_sysfs_write_ ## thingy(struct file *fp, \
135 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
136 loff_t off, size_t count) \
137{ \
138 return pyra_sysfs_write(fp, kobj, buf, off, count, \
139 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
140}
141
142#define PYRA_SYSFS_R(thingy, THINGY) \
143static ssize_t pyra_sysfs_read_ ## thingy(struct file *fp, \
144 struct kobject *kobj, struct bin_attribute *attr, char *buf, \
145 loff_t off, size_t count) \
146{ \
147 return pyra_sysfs_read(fp, kobj, buf, off, count, \
148 PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
149}
150
151#define PYRA_SYSFS_RW(thingy, THINGY) \
152PYRA_SYSFS_W(thingy, THINGY) \
153PYRA_SYSFS_R(thingy, THINGY)
154
155#define PYRA_BIN_ATTRIBUTE_RW(thingy, THINGY) \
156PYRA_SYSFS_RW(thingy, THINGY); \
157static struct bin_attribute bin_attr_##thingy = { \
158 .attr = { .name = #thingy, .mode = 0660 }, \
159 .size = PYRA_SIZE_ ## THINGY, \
160 .read = pyra_sysfs_read_ ## thingy, \
161 .write = pyra_sysfs_write_ ## thingy \
162}
163
164#define PYRA_BIN_ATTRIBUTE_R(thingy, THINGY) \
165PYRA_SYSFS_R(thingy, THINGY); \
166static struct bin_attribute bin_attr_##thingy = { \
167 .attr = { .name = #thingy, .mode = 0440 }, \
168 .size = PYRA_SIZE_ ## THINGY, \
169 .read = pyra_sysfs_read_ ## thingy, \
170}
171
172#define PYRA_BIN_ATTRIBUTE_W(thingy, THINGY) \
173PYRA_SYSFS_W(thingy, THINGY); \
174static struct bin_attribute bin_attr_##thingy = { \
175 .attr = { .name = #thingy, .mode = 0220 }, \
176 .size = PYRA_SIZE_ ## THINGY, \
177 .write = pyra_sysfs_write_ ## thingy \
178}
179
180PYRA_BIN_ATTRIBUTE_W(control, CONTROL);
181PYRA_BIN_ATTRIBUTE_RW(info, INFO);
182PYRA_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS);
183PYRA_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS);
184
185static ssize_t pyra_sysfs_read_profilex_settings(struct file *fp,
186 struct kobject *kobj, struct bin_attribute *attr, char *buf,
187 loff_t off, size_t count)
188{
189 struct device *dev = kobj_to_dev(kobj)->parent->parent;
190 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
191 ssize_t retval;
192
193 retval = pyra_send_control(usb_dev, *(uint *)(attr->private),
194 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
195 if (retval)
196 return retval;
197
198 return pyra_sysfs_read(fp, kobj, buf, off, count,
199 PYRA_SIZE_PROFILE_SETTINGS,
200 PYRA_COMMAND_PROFILE_SETTINGS);
201}
202
203static ssize_t pyra_sysfs_read_profilex_buttons(struct file *fp,
204 struct kobject *kobj, struct bin_attribute *attr, char *buf,
205 loff_t off, size_t count)
206{
207 struct device *dev = kobj_to_dev(kobj)->parent->parent;
208 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
209 ssize_t retval;
210
211 retval = pyra_send_control(usb_dev, *(uint *)(attr->private),
212 PYRA_CONTROL_REQUEST_PROFILE_BUTTONS);
213 if (retval)
214 return retval;
215
216 return pyra_sysfs_read(fp, kobj, buf, off, count,
217 PYRA_SIZE_PROFILE_BUTTONS,
218 PYRA_COMMAND_PROFILE_BUTTONS);
219}
220
221#define PROFILE_ATTR(number) \
222static struct bin_attribute bin_attr_profile##number##_settings = { \
223 .attr = { .name = "profile" #number "_settings", .mode = 0440 }, \
224 .size = PYRA_SIZE_PROFILE_SETTINGS, \
225 .read = pyra_sysfs_read_profilex_settings, \
226 .private = &profile_numbers[number-1], \
227}; \
228static struct bin_attribute bin_attr_profile##number##_buttons = { \
229 .attr = { .name = "profile" #number "_buttons", .mode = 0440 }, \
230 .size = PYRA_SIZE_PROFILE_BUTTONS, \
231 .read = pyra_sysfs_read_profilex_buttons, \
232 .private = &profile_numbers[number-1], \
233};
234PROFILE_ATTR(1);
235PROFILE_ATTR(2);
236PROFILE_ATTR(3);
237PROFILE_ATTR(4);
238PROFILE_ATTR(5);
239
240static ssize_t pyra_sysfs_write_settings(struct file *fp,
241 struct kobject *kobj, struct bin_attribute *attr, char *buf,
242 loff_t off, size_t count)
243{
244 struct device *dev = kobj_to_dev(kobj)->parent->parent;
245 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
246 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
247 int retval = 0;
248 struct pyra_roccat_report roccat_report;
249 struct pyra_settings const *settings;
250
251 if (off != 0 || count != PYRA_SIZE_SETTINGS)
252 return -EINVAL;
253
254 settings = (struct pyra_settings const *)buf;
255 if (settings->startup_profile >= ARRAY_SIZE(pyra->profile_settings))
256 return -EINVAL;
257
258 mutex_lock(&pyra->pyra_lock);
259
260 retval = pyra_set_settings(usb_dev, settings);
261 if (retval) {
262 mutex_unlock(&pyra->pyra_lock);
263 return retval;
264 }
265
266 profile_activated(pyra, settings->startup_profile);
267
268 roccat_report.type = PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2;
269 roccat_report.value = settings->startup_profile + 1;
270 roccat_report.key = 0;
271 roccat_report_event(pyra->chrdev_minor,
272 (uint8_t const *)&roccat_report);
273
274 mutex_unlock(&pyra->pyra_lock);
275 return PYRA_SIZE_SETTINGS;
276}
277
278PYRA_SYSFS_R(settings, SETTINGS);
279static struct bin_attribute bin_attr_settings =
280 __BIN_ATTR(settings, (S_IWUSR | S_IRUGO),
281 pyra_sysfs_read_settings, pyra_sysfs_write_settings,
282 PYRA_SIZE_SETTINGS);
283
284static ssize_t pyra_sysfs_show_actual_cpi(struct device *dev,
285 struct device_attribute *attr, char *buf)
286{
287 struct pyra_device *pyra =
288 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
289 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_cpi);
290}
291static DEVICE_ATTR(actual_cpi, 0440, pyra_sysfs_show_actual_cpi, NULL);
292
293static ssize_t pyra_sysfs_show_actual_profile(struct device *dev,
294 struct device_attribute *attr, char *buf)
295{
296 struct pyra_device *pyra =
297 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
298 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
299 struct pyra_settings settings;
300
301 mutex_lock(&pyra->pyra_lock);
302 roccat_common2_receive(usb_dev, PYRA_COMMAND_SETTINGS,
303 &settings, PYRA_SIZE_SETTINGS);
304 mutex_unlock(&pyra->pyra_lock);
305
306 return snprintf(buf, PAGE_SIZE, "%d\n", settings.startup_profile);
307}
308static DEVICE_ATTR(actual_profile, 0440, pyra_sysfs_show_actual_profile, NULL);
309static DEVICE_ATTR(startup_profile, 0440, pyra_sysfs_show_actual_profile, NULL);
310
311static ssize_t pyra_sysfs_show_firmware_version(struct device *dev,
312 struct device_attribute *attr, char *buf)
313{
314 struct pyra_device *pyra;
315 struct usb_device *usb_dev;
316 struct pyra_info info;
317
318 dev = dev->parent->parent;
319 pyra = hid_get_drvdata(dev_get_drvdata(dev));
320 usb_dev = interface_to_usbdev(to_usb_interface(dev));
321
322 mutex_lock(&pyra->pyra_lock);
323 roccat_common2_receive(usb_dev, PYRA_COMMAND_INFO,
324 &info, PYRA_SIZE_INFO);
325 mutex_unlock(&pyra->pyra_lock);
326
327 return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
328}
329static DEVICE_ATTR(firmware_version, 0440, pyra_sysfs_show_firmware_version,
330 NULL);
331
332static struct attribute *pyra_attrs[] = {
333 &dev_attr_actual_cpi.attr,
334 &dev_attr_actual_profile.attr,
335 &dev_attr_firmware_version.attr,
336 &dev_attr_startup_profile.attr,
337 NULL,
338};
339
340static struct bin_attribute *pyra_bin_attributes[] = {
341 &bin_attr_control,
342 &bin_attr_info,
343 &bin_attr_profile_settings,
344 &bin_attr_profile_buttons,
345 &bin_attr_settings,
346 &bin_attr_profile1_settings,
347 &bin_attr_profile2_settings,
348 &bin_attr_profile3_settings,
349 &bin_attr_profile4_settings,
350 &bin_attr_profile5_settings,
351 &bin_attr_profile1_buttons,
352 &bin_attr_profile2_buttons,
353 &bin_attr_profile3_buttons,
354 &bin_attr_profile4_buttons,
355 &bin_attr_profile5_buttons,
356 NULL,
357};
358
359static const struct attribute_group pyra_group = {
360 .attrs = pyra_attrs,
361 .bin_attrs = pyra_bin_attributes,
362};
363
364static const struct attribute_group *pyra_groups[] = {
365 &pyra_group,
366 NULL,
367};
368
369static int pyra_init_pyra_device_struct(struct usb_device *usb_dev,
370 struct pyra_device *pyra)
371{
372 struct pyra_settings settings;
373 int retval, i;
374
375 mutex_init(&pyra->pyra_lock);
376
377 retval = pyra_get_settings(usb_dev, &settings);
378 if (retval)
379 return retval;
380
381 for (i = 0; i < 5; ++i) {
382 retval = pyra_get_profile_settings(usb_dev,
383 &pyra->profile_settings[i], i);
384 if (retval)
385 return retval;
386 }
387
388 profile_activated(pyra, settings.startup_profile);
389
390 return 0;
391}
392
393static int pyra_init_specials(struct hid_device *hdev)
394{
395 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
396 struct usb_device *usb_dev = interface_to_usbdev(intf);
397 struct pyra_device *pyra;
398 int retval;
399
400 if (intf->cur_altsetting->desc.bInterfaceProtocol
401 == USB_INTERFACE_PROTOCOL_MOUSE) {
402
403 pyra = kzalloc(sizeof(*pyra), GFP_KERNEL);
404 if (!pyra) {
405 hid_err(hdev, "can't alloc device descriptor\n");
406 return -ENOMEM;
407 }
408 hid_set_drvdata(hdev, pyra);
409
410 retval = pyra_init_pyra_device_struct(usb_dev, pyra);
411 if (retval) {
412 hid_err(hdev, "couldn't init struct pyra_device\n");
413 goto exit_free;
414 }
415
416 retval = roccat_connect(pyra_class, hdev,
417 sizeof(struct pyra_roccat_report));
418 if (retval < 0) {
419 hid_err(hdev, "couldn't init char dev\n");
420 } else {
421 pyra->chrdev_minor = retval;
422 pyra->roccat_claimed = 1;
423 }
424 } else {
425 hid_set_drvdata(hdev, NULL);
426 }
427
428 return 0;
429exit_free:
430 kfree(pyra);
431 return retval;
432}
433
434static void pyra_remove_specials(struct hid_device *hdev)
435{
436 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
437 struct pyra_device *pyra;
438
439 if (intf->cur_altsetting->desc.bInterfaceProtocol
440 == USB_INTERFACE_PROTOCOL_MOUSE) {
441 pyra = hid_get_drvdata(hdev);
442 if (pyra->roccat_claimed)
443 roccat_disconnect(pyra->chrdev_minor);
444 kfree(hid_get_drvdata(hdev));
445 }
446}
447
448static int pyra_probe(struct hid_device *hdev, const struct hid_device_id *id)
449{
450 int retval;
451
452 retval = hid_parse(hdev);
453 if (retval) {
454 hid_err(hdev, "parse failed\n");
455 goto exit;
456 }
457
458 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
459 if (retval) {
460 hid_err(hdev, "hw start failed\n");
461 goto exit;
462 }
463
464 retval = pyra_init_specials(hdev);
465 if (retval) {
466 hid_err(hdev, "couldn't install mouse\n");
467 goto exit_stop;
468 }
469 return 0;
470
471exit_stop:
472 hid_hw_stop(hdev);
473exit:
474 return retval;
475}
476
477static void pyra_remove(struct hid_device *hdev)
478{
479 pyra_remove_specials(hdev);
480 hid_hw_stop(hdev);
481}
482
483static void pyra_keep_values_up_to_date(struct pyra_device *pyra,
484 u8 const *data)
485{
486 struct pyra_mouse_event_button const *button_event;
487
488 switch (data[0]) {
489 case PYRA_MOUSE_REPORT_NUMBER_BUTTON:
490 button_event = (struct pyra_mouse_event_button const *)data;
491 switch (button_event->type) {
492 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
493 profile_activated(pyra, button_event->data1 - 1);
494 break;
495 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
496 pyra->actual_cpi = button_event->data1;
497 break;
498 }
499 break;
500 }
501}
502
503static void pyra_report_to_chrdev(struct pyra_device const *pyra,
504 u8 const *data)
505{
506 struct pyra_roccat_report roccat_report;
507 struct pyra_mouse_event_button const *button_event;
508
509 if (data[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON)
510 return;
511
512 button_event = (struct pyra_mouse_event_button const *)data;
513
514 switch (button_event->type) {
515 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
516 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
517 roccat_report.type = button_event->type;
518 roccat_report.value = button_event->data1;
519 roccat_report.key = 0;
520 roccat_report_event(pyra->chrdev_minor,
521 (uint8_t const *)&roccat_report);
522 break;
523 case PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO:
524 case PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT:
525 case PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH:
526 if (button_event->data2 == PYRA_MOUSE_EVENT_BUTTON_PRESS) {
527 roccat_report.type = button_event->type;
528 roccat_report.key = button_event->data1;
529 /*
530 * pyra reports profile numbers with range 1-5.
531 * Keeping this behaviour.
532 */
533 roccat_report.value = pyra->actual_profile + 1;
534 roccat_report_event(pyra->chrdev_minor,
535 (uint8_t const *)&roccat_report);
536 }
537 break;
538 }
539}
540
541static int pyra_raw_event(struct hid_device *hdev, struct hid_report *report,
542 u8 *data, int size)
543{
544 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
545 struct pyra_device *pyra = hid_get_drvdata(hdev);
546
547 if (intf->cur_altsetting->desc.bInterfaceProtocol
548 != USB_INTERFACE_PROTOCOL_MOUSE)
549 return 0;
550
551 if (pyra == NULL)
552 return 0;
553
554 pyra_keep_values_up_to_date(pyra, data);
555
556 if (pyra->roccat_claimed)
557 pyra_report_to_chrdev(pyra, data);
558
559 return 0;
560}
561
562static const struct hid_device_id pyra_devices[] = {
563 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
564 USB_DEVICE_ID_ROCCAT_PYRA_WIRED) },
565 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
566 USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS) },
567 { }
568};
569
570MODULE_DEVICE_TABLE(hid, pyra_devices);
571
572static struct hid_driver pyra_driver = {
573 .name = "pyra",
574 .id_table = pyra_devices,
575 .probe = pyra_probe,
576 .remove = pyra_remove,
577 .raw_event = pyra_raw_event
578};
579
580static int __init pyra_init(void)
581{
582 int retval;
583
584 /* class name has to be same as driver name */
585 pyra_class = class_create(THIS_MODULE, "pyra");
586 if (IS_ERR(pyra_class))
587 return PTR_ERR(pyra_class);
588 pyra_class->dev_groups = pyra_groups;
589
590 retval = hid_register_driver(&pyra_driver);
591 if (retval)
592 class_destroy(pyra_class);
593 return retval;
594}
595
596static void __exit pyra_exit(void)
597{
598 hid_unregister_driver(&pyra_driver);
599 class_destroy(pyra_class);
600}
601
602module_init(pyra_init);
603module_exit(pyra_exit);
604
605MODULE_AUTHOR("Stefan Achatz");
606MODULE_DESCRIPTION("USB Roccat Pyra driver");
607MODULE_LICENSE("GPL v2");
1/*
2 * Roccat Pyra driver for Linux
3 *
4 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
5 */
6
7/*
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)
11 * any later version.
12 */
13
14/*
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
18 */
19
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>
26#include "hid-ids.h"
27#include "hid-roccat-common.h"
28#include "hid-roccat-pyra.h"
29
30static uint profile_numbers[5] = {0, 1, 2, 3, 4};
31
32/* pyra_class is used for creating sysfs attributes via roccat char device */
33static struct class *pyra_class;
34
35static void profile_activated(struct pyra_device *pyra,
36 unsigned int new_profile)
37{
38 pyra->actual_profile = new_profile;
39 pyra->actual_cpi = pyra->profile_settings[pyra->actual_profile].y_cpi;
40}
41
42static int pyra_send_control(struct usb_device *usb_dev, int value,
43 enum pyra_control_requests request)
44{
45 struct pyra_control control;
46
47 if ((request == PYRA_CONTROL_REQUEST_PROFILE_SETTINGS ||
48 request == PYRA_CONTROL_REQUEST_PROFILE_BUTTONS) &&
49 (value < 0 || value > 4))
50 return -EINVAL;
51
52 control.command = PYRA_COMMAND_CONTROL;
53 control.value = value;
54 control.request = request;
55
56 return roccat_common_send(usb_dev, PYRA_COMMAND_CONTROL,
57 &control, sizeof(struct pyra_control));
58}
59
60static int pyra_receive_control_status(struct usb_device *usb_dev)
61{
62 int retval;
63 struct pyra_control control;
64
65 do {
66 msleep(10);
67 retval = roccat_common_receive(usb_dev, PYRA_COMMAND_CONTROL,
68 &control, sizeof(struct pyra_control));
69
70 /* requested too early, try again */
71 } while (retval == -EPROTO);
72
73 if (!retval && control.command == PYRA_COMMAND_CONTROL &&
74 control.request == PYRA_CONTROL_REQUEST_STATUS &&
75 control.value == 1)
76 return 0;
77 else {
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;
81 }
82}
83
84static int pyra_get_profile_settings(struct usb_device *usb_dev,
85 struct pyra_profile_settings *buf, int number)
86{
87 int retval;
88 retval = pyra_send_control(usb_dev, number,
89 PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
90 if (retval)
91 return retval;
92 return roccat_common_receive(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS,
93 buf, sizeof(struct pyra_profile_settings));
94}
95
96static int pyra_get_profile_buttons(struct usb_device *usb_dev,
97 struct pyra_profile_buttons *buf, int number)
98{
99 int retval;
100 retval = pyra_send_control(usb_dev, number,
101 PYRA_CONTROL_REQUEST_PROFILE_BUTTONS);
102 if (retval)
103 return retval;
104 return roccat_common_receive(usb_dev, PYRA_COMMAND_PROFILE_BUTTONS,
105 buf, sizeof(struct pyra_profile_buttons));
106}
107
108static int pyra_get_settings(struct usb_device *usb_dev,
109 struct pyra_settings *buf)
110{
111 return roccat_common_receive(usb_dev, PYRA_COMMAND_SETTINGS,
112 buf, sizeof(struct pyra_settings));
113}
114
115static int pyra_get_info(struct usb_device *usb_dev, struct pyra_info *buf)
116{
117 return roccat_common_receive(usb_dev, PYRA_COMMAND_INFO,
118 buf, sizeof(struct pyra_info));
119}
120
121static int pyra_send(struct usb_device *usb_dev, uint command,
122 void const *buf, uint size)
123{
124 int retval;
125 retval = roccat_common_send(usb_dev, command, buf, size);
126 if (retval)
127 return retval;
128 return pyra_receive_control_status(usb_dev);
129}
130
131static int pyra_set_profile_settings(struct usb_device *usb_dev,
132 struct pyra_profile_settings const *settings)
133{
134 return pyra_send(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS, settings,
135 sizeof(struct pyra_profile_settings));
136}
137
138static int pyra_set_profile_buttons(struct usb_device *usb_dev,
139 struct pyra_profile_buttons const *buttons)
140{
141 return pyra_send(usb_dev, PYRA_COMMAND_PROFILE_BUTTONS, buttons,
142 sizeof(struct pyra_profile_buttons));
143}
144
145static int pyra_set_settings(struct usb_device *usb_dev,
146 struct pyra_settings const *settings)
147{
148 return pyra_send(usb_dev, PYRA_COMMAND_SETTINGS, settings,
149 sizeof(struct pyra_settings));
150}
151
152static 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)
155{
156 struct device *dev =
157 container_of(kobj, struct device, kobj)->parent->parent;
158 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
159
160 if (off >= sizeof(struct pyra_profile_settings))
161 return 0;
162
163 if (off + count > sizeof(struct pyra_profile_settings))
164 count = sizeof(struct pyra_profile_settings) - off;
165
166 mutex_lock(&pyra->pyra_lock);
167 memcpy(buf, ((char const *)&pyra->profile_settings[*(uint *)(attr->private)]) + off,
168 count);
169 mutex_unlock(&pyra->pyra_lock);
170
171 return count;
172}
173
174static 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)
177{
178 struct device *dev =
179 container_of(kobj, struct device, kobj)->parent->parent;
180 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
181
182 if (off >= sizeof(struct pyra_profile_buttons))
183 return 0;
184
185 if (off + count > sizeof(struct pyra_profile_buttons))
186 count = sizeof(struct pyra_profile_buttons) - off;
187
188 mutex_lock(&pyra->pyra_lock);
189 memcpy(buf, ((char const *)&pyra->profile_buttons[*(uint *)(attr->private)]) + off,
190 count);
191 mutex_unlock(&pyra->pyra_lock);
192
193 return count;
194}
195
196static 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)
199{
200 struct device *dev =
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));
204 int retval = 0;
205 int difference;
206 int profile_number;
207 struct pyra_profile_settings *profile_settings;
208
209 if (off != 0 || count != sizeof(struct pyra_profile_settings))
210 return -EINVAL;
211
212 profile_number = ((struct pyra_profile_settings const *)buf)->number;
213 profile_settings = &pyra->profile_settings[profile_number];
214
215 mutex_lock(&pyra->pyra_lock);
216 difference = memcmp(buf, profile_settings,
217 sizeof(struct pyra_profile_settings));
218 if (difference) {
219 retval = pyra_set_profile_settings(usb_dev,
220 (struct pyra_profile_settings const *)buf);
221 if (!retval)
222 memcpy(profile_settings, buf,
223 sizeof(struct pyra_profile_settings));
224 }
225 mutex_unlock(&pyra->pyra_lock);
226
227 if (retval)
228 return retval;
229
230 return sizeof(struct pyra_profile_settings);
231}
232
233static 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)
236{
237 struct device *dev =
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));
241 int retval = 0;
242 int difference;
243 int profile_number;
244 struct pyra_profile_buttons *profile_buttons;
245
246 if (off != 0 || count != sizeof(struct pyra_profile_buttons))
247 return -EINVAL;
248
249 profile_number = ((struct pyra_profile_buttons const *)buf)->number;
250 profile_buttons = &pyra->profile_buttons[profile_number];
251
252 mutex_lock(&pyra->pyra_lock);
253 difference = memcmp(buf, profile_buttons,
254 sizeof(struct pyra_profile_buttons));
255 if (difference) {
256 retval = pyra_set_profile_buttons(usb_dev,
257 (struct pyra_profile_buttons const *)buf);
258 if (!retval)
259 memcpy(profile_buttons, buf,
260 sizeof(struct pyra_profile_buttons));
261 }
262 mutex_unlock(&pyra->pyra_lock);
263
264 if (retval)
265 return retval;
266
267 return sizeof(struct pyra_profile_buttons);
268}
269
270static 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)
273{
274 struct device *dev =
275 container_of(kobj, struct device, kobj)->parent->parent;
276 struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
277
278 if (off >= sizeof(struct pyra_settings))
279 return 0;
280
281 if (off + count > sizeof(struct pyra_settings))
282 count = sizeof(struct pyra_settings) - off;
283
284 mutex_lock(&pyra->pyra_lock);
285 memcpy(buf, ((char const *)&pyra->settings) + off, count);
286 mutex_unlock(&pyra->pyra_lock);
287
288 return count;
289}
290
291static 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)
294{
295 struct device *dev =
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));
299 int retval = 0;
300 int difference;
301
302 if (off != 0 || count != sizeof(struct pyra_settings))
303 return -EINVAL;
304
305 mutex_lock(&pyra->pyra_lock);
306 difference = memcmp(buf, &pyra->settings, sizeof(struct pyra_settings));
307 if (difference) {
308 retval = pyra_set_settings(usb_dev,
309 (struct pyra_settings const *)buf);
310 if (!retval)
311 memcpy(&pyra->settings, buf,
312 sizeof(struct pyra_settings));
313 }
314 mutex_unlock(&pyra->pyra_lock);
315
316 if (retval)
317 return retval;
318
319 profile_activated(pyra, pyra->settings.startup_profile);
320
321 return sizeof(struct pyra_settings);
322}
323
324
325static ssize_t pyra_sysfs_show_actual_cpi(struct device *dev,
326 struct device_attribute *attr, char *buf)
327{
328 struct pyra_device *pyra =
329 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
330 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_cpi);
331}
332
333static ssize_t pyra_sysfs_show_actual_profile(struct device *dev,
334 struct device_attribute *attr, char *buf)
335{
336 struct pyra_device *pyra =
337 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
338 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_profile);
339}
340
341static ssize_t pyra_sysfs_show_firmware_version(struct device *dev,
342 struct device_attribute *attr, char *buf)
343{
344 struct pyra_device *pyra =
345 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
346 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->firmware_version);
347}
348
349static ssize_t pyra_sysfs_show_startup_profile(struct device *dev,
350 struct device_attribute *attr, char *buf)
351{
352 struct pyra_device *pyra =
353 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
354 return snprintf(buf, PAGE_SIZE, "%d\n", pyra->settings.startup_profile);
355}
356
357static struct device_attribute pyra_attributes[] = {
358 __ATTR(actual_cpi, 0440, pyra_sysfs_show_actual_cpi, NULL),
359 __ATTR(actual_profile, 0440, pyra_sysfs_show_actual_profile, NULL),
360 __ATTR(firmware_version, 0440,
361 pyra_sysfs_show_firmware_version, NULL),
362 __ATTR(startup_profile, 0440,
363 pyra_sysfs_show_startup_profile, NULL),
364 __ATTR_NULL
365};
366
367static struct bin_attribute pyra_bin_attributes[] = {
368 {
369 .attr = { .name = "profile_settings", .mode = 0220 },
370 .size = sizeof(struct pyra_profile_settings),
371 .write = pyra_sysfs_write_profile_settings
372 },
373 {
374 .attr = { .name = "profile1_settings", .mode = 0440 },
375 .size = sizeof(struct pyra_profile_settings),
376 .read = pyra_sysfs_read_profilex_settings,
377 .private = &profile_numbers[0]
378 },
379 {
380 .attr = { .name = "profile2_settings", .mode = 0440 },
381 .size = sizeof(struct pyra_profile_settings),
382 .read = pyra_sysfs_read_profilex_settings,
383 .private = &profile_numbers[1]
384 },
385 {
386 .attr = { .name = "profile3_settings", .mode = 0440 },
387 .size = sizeof(struct pyra_profile_settings),
388 .read = pyra_sysfs_read_profilex_settings,
389 .private = &profile_numbers[2]
390 },
391 {
392 .attr = { .name = "profile4_settings", .mode = 0440 },
393 .size = sizeof(struct pyra_profile_settings),
394 .read = pyra_sysfs_read_profilex_settings,
395 .private = &profile_numbers[3]
396 },
397 {
398 .attr = { .name = "profile5_settings", .mode = 0440 },
399 .size = sizeof(struct pyra_profile_settings),
400 .read = pyra_sysfs_read_profilex_settings,
401 .private = &profile_numbers[4]
402 },
403 {
404 .attr = { .name = "profile_buttons", .mode = 0220 },
405 .size = sizeof(struct pyra_profile_buttons),
406 .write = pyra_sysfs_write_profile_buttons
407 },
408 {
409 .attr = { .name = "profile1_buttons", .mode = 0440 },
410 .size = sizeof(struct pyra_profile_buttons),
411 .read = pyra_sysfs_read_profilex_buttons,
412 .private = &profile_numbers[0]
413 },
414 {
415 .attr = { .name = "profile2_buttons", .mode = 0440 },
416 .size = sizeof(struct pyra_profile_buttons),
417 .read = pyra_sysfs_read_profilex_buttons,
418 .private = &profile_numbers[1]
419 },
420 {
421 .attr = { .name = "profile3_buttons", .mode = 0440 },
422 .size = sizeof(struct pyra_profile_buttons),
423 .read = pyra_sysfs_read_profilex_buttons,
424 .private = &profile_numbers[2]
425 },
426 {
427 .attr = { .name = "profile4_buttons", .mode = 0440 },
428 .size = sizeof(struct pyra_profile_buttons),
429 .read = pyra_sysfs_read_profilex_buttons,
430 .private = &profile_numbers[3]
431 },
432 {
433 .attr = { .name = "profile5_buttons", .mode = 0440 },
434 .size = sizeof(struct pyra_profile_buttons),
435 .read = pyra_sysfs_read_profilex_buttons,
436 .private = &profile_numbers[4]
437 },
438 {
439 .attr = { .name = "settings", .mode = 0660 },
440 .size = sizeof(struct pyra_settings),
441 .read = pyra_sysfs_read_settings,
442 .write = pyra_sysfs_write_settings
443 },
444 __ATTR_NULL
445};
446
447static int pyra_init_pyra_device_struct(struct usb_device *usb_dev,
448 struct pyra_device *pyra)
449{
450 struct pyra_info info;
451 int retval, i;
452
453 mutex_init(&pyra->pyra_lock);
454
455 retval = pyra_get_info(usb_dev, &info);
456 if (retval)
457 return retval;
458
459 pyra->firmware_version = info.firmware_version;
460
461 retval = pyra_get_settings(usb_dev, &pyra->settings);
462 if (retval)
463 return retval;
464
465 for (i = 0; i < 5; ++i) {
466 retval = pyra_get_profile_settings(usb_dev,
467 &pyra->profile_settings[i], i);
468 if (retval)
469 return retval;
470
471 retval = pyra_get_profile_buttons(usb_dev,
472 &pyra->profile_buttons[i], i);
473 if (retval)
474 return retval;
475 }
476
477 profile_activated(pyra, pyra->settings.startup_profile);
478
479 return 0;
480}
481
482static int pyra_init_specials(struct hid_device *hdev)
483{
484 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
485 struct usb_device *usb_dev = interface_to_usbdev(intf);
486 struct pyra_device *pyra;
487 int retval;
488
489 if (intf->cur_altsetting->desc.bInterfaceProtocol
490 == USB_INTERFACE_PROTOCOL_MOUSE) {
491
492 pyra = kzalloc(sizeof(*pyra), GFP_KERNEL);
493 if (!pyra) {
494 hid_err(hdev, "can't alloc device descriptor\n");
495 return -ENOMEM;
496 }
497 hid_set_drvdata(hdev, pyra);
498
499 retval = pyra_init_pyra_device_struct(usb_dev, pyra);
500 if (retval) {
501 hid_err(hdev, "couldn't init struct pyra_device\n");
502 goto exit_free;
503 }
504
505 retval = roccat_connect(pyra_class, hdev,
506 sizeof(struct pyra_roccat_report));
507 if (retval < 0) {
508 hid_err(hdev, "couldn't init char dev\n");
509 } else {
510 pyra->chrdev_minor = retval;
511 pyra->roccat_claimed = 1;
512 }
513 } else {
514 hid_set_drvdata(hdev, NULL);
515 }
516
517 return 0;
518exit_free:
519 kfree(pyra);
520 return retval;
521}
522
523static void pyra_remove_specials(struct hid_device *hdev)
524{
525 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
526 struct pyra_device *pyra;
527
528 if (intf->cur_altsetting->desc.bInterfaceProtocol
529 == USB_INTERFACE_PROTOCOL_MOUSE) {
530 pyra = hid_get_drvdata(hdev);
531 if (pyra->roccat_claimed)
532 roccat_disconnect(pyra->chrdev_minor);
533 kfree(hid_get_drvdata(hdev));
534 }
535}
536
537static int pyra_probe(struct hid_device *hdev, const struct hid_device_id *id)
538{
539 int retval;
540
541 retval = hid_parse(hdev);
542 if (retval) {
543 hid_err(hdev, "parse failed\n");
544 goto exit;
545 }
546
547 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
548 if (retval) {
549 hid_err(hdev, "hw start failed\n");
550 goto exit;
551 }
552
553 retval = pyra_init_specials(hdev);
554 if (retval) {
555 hid_err(hdev, "couldn't install mouse\n");
556 goto exit_stop;
557 }
558 return 0;
559
560exit_stop:
561 hid_hw_stop(hdev);
562exit:
563 return retval;
564}
565
566static void pyra_remove(struct hid_device *hdev)
567{
568 pyra_remove_specials(hdev);
569 hid_hw_stop(hdev);
570}
571
572static void pyra_keep_values_up_to_date(struct pyra_device *pyra,
573 u8 const *data)
574{
575 struct pyra_mouse_event_button const *button_event;
576
577 switch (data[0]) {
578 case PYRA_MOUSE_REPORT_NUMBER_BUTTON:
579 button_event = (struct pyra_mouse_event_button const *)data;
580 switch (button_event->type) {
581 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
582 profile_activated(pyra, button_event->data1 - 1);
583 break;
584 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
585 pyra->actual_cpi = button_event->data1;
586 break;
587 }
588 break;
589 }
590}
591
592static void pyra_report_to_chrdev(struct pyra_device const *pyra,
593 u8 const *data)
594{
595 struct pyra_roccat_report roccat_report;
596 struct pyra_mouse_event_button const *button_event;
597
598 if (data[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON)
599 return;
600
601 button_event = (struct pyra_mouse_event_button const *)data;
602
603 switch (button_event->type) {
604 case PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2:
605 case PYRA_MOUSE_EVENT_BUTTON_TYPE_CPI:
606 roccat_report.type = button_event->type;
607 roccat_report.value = button_event->data1;
608 roccat_report.key = 0;
609 roccat_report_event(pyra->chrdev_minor,
610 (uint8_t const *)&roccat_report);
611 break;
612 case PYRA_MOUSE_EVENT_BUTTON_TYPE_MACRO:
613 case PYRA_MOUSE_EVENT_BUTTON_TYPE_SHORTCUT:
614 case PYRA_MOUSE_EVENT_BUTTON_TYPE_QUICKLAUNCH:
615 if (button_event->data2 == PYRA_MOUSE_EVENT_BUTTON_PRESS) {
616 roccat_report.type = button_event->type;
617 roccat_report.key = button_event->data1;
618 /*
619 * pyra reports profile numbers with range 1-5.
620 * Keeping this behaviour.
621 */
622 roccat_report.value = pyra->actual_profile + 1;
623 roccat_report_event(pyra->chrdev_minor,
624 (uint8_t const *)&roccat_report);
625 }
626 break;
627 }
628}
629
630static int pyra_raw_event(struct hid_device *hdev, struct hid_report *report,
631 u8 *data, int size)
632{
633 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
634 struct pyra_device *pyra = hid_get_drvdata(hdev);
635
636 if (intf->cur_altsetting->desc.bInterfaceProtocol
637 != USB_INTERFACE_PROTOCOL_MOUSE)
638 return 0;
639
640 if (pyra == NULL)
641 return 0;
642
643 pyra_keep_values_up_to_date(pyra, data);
644
645 if (pyra->roccat_claimed)
646 pyra_report_to_chrdev(pyra, data);
647
648 return 0;
649}
650
651static const struct hid_device_id pyra_devices[] = {
652 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
653 USB_DEVICE_ID_ROCCAT_PYRA_WIRED) },
654 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT,
655 USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS) },
656 { }
657};
658
659MODULE_DEVICE_TABLE(hid, pyra_devices);
660
661static struct hid_driver pyra_driver = {
662 .name = "pyra",
663 .id_table = pyra_devices,
664 .probe = pyra_probe,
665 .remove = pyra_remove,
666 .raw_event = pyra_raw_event
667};
668
669static int __init pyra_init(void)
670{
671 int retval;
672
673 /* class name has to be same as driver name */
674 pyra_class = class_create(THIS_MODULE, "pyra");
675 if (IS_ERR(pyra_class))
676 return PTR_ERR(pyra_class);
677 pyra_class->dev_attrs = pyra_attributes;
678 pyra_class->dev_bin_attrs = pyra_bin_attributes;
679
680 retval = hid_register_driver(&pyra_driver);
681 if (retval)
682 class_destroy(pyra_class);
683 return retval;
684}
685
686static void __exit pyra_exit(void)
687{
688 hid_unregister_driver(&pyra_driver);
689 class_destroy(pyra_class);
690}
691
692module_init(pyra_init);
693module_exit(pyra_exit);
694
695MODULE_AUTHOR("Stefan Achatz");
696MODULE_DESCRIPTION("USB Roccat Pyra driver");
697MODULE_LICENSE("GPL v2");