Merge branch 'sched/urgent'
[linux-2.6/x86.git] / drivers / hid / hid-roccat-pyra.c
blob8140776bd8c51906f7f1296ef1d1ea5ff6d49299
1 /*
2 * Roccat Pyra driver for Linux
4 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
5 */
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.
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>
26 #include "hid-ids.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))
50 return -EINVAL;
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)
62 int retval;
63 struct pyra_control control;
65 do {
66 msleep(10);
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 &&
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;
84 static int pyra_get_profile_settings(struct usb_device *usb_dev,
85 struct pyra_profile_settings *buf, int number)
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));
96 static int pyra_get_profile_buttons(struct usb_device *usb_dev,
97 struct pyra_profile_buttons *buf, int number)
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));
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)
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);
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)
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));
160 if (off >= sizeof(struct pyra_profile_settings))
161 return 0;
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,
168 count);
169 mutex_unlock(&pyra->pyra_lock);
171 return count;
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)
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));
182 if (off >= sizeof(struct pyra_profile_buttons))
183 return 0;
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,
190 count);
191 mutex_unlock(&pyra->pyra_lock);
193 return count;
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)
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;
209 if (off != 0 || count != sizeof(struct pyra_profile_settings))
210 return -EINVAL;
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));
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));
225 mutex_unlock(&pyra->pyra_lock);
227 if (retval)
228 return retval;
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)
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;
246 if (off != 0 || count != sizeof(struct pyra_profile_buttons))
247 return -EINVAL;
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));
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));
262 mutex_unlock(&pyra->pyra_lock);
264 if (retval)
265 return retval;
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)
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));
278 if (off >= sizeof(struct pyra_settings))
279 return 0;
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);
288 return count;
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)
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;
302 if (off != 0 || count != sizeof(struct pyra_settings))
303 return -EINVAL;
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));
314 mutex_unlock(&pyra->pyra_lock);
316 if (retval)
317 return retval;
319 profile_activated(pyra, pyra->settings.startup_profile);
321 return sizeof(struct pyra_settings);
325 static ssize_t pyra_sysfs_show_actual_cpi(struct device *dev,
326 struct device_attribute *attr, char *buf)
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);
333 static ssize_t pyra_sysfs_show_actual_profile(struct device *dev,
334 struct device_attribute *attr, char *buf)
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);
341 static ssize_t pyra_sysfs_show_firmware_version(struct device *dev,
342 struct device_attribute *attr, char *buf)
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);
349 static ssize_t pyra_sysfs_show_startup_profile(struct device *dev,
350 struct device_attribute *attr, char *buf)
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);
357 static 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
367 static struct bin_attribute pyra_bin_attributes[] = {
369 .attr = { .name = "profile_settings", .mode = 0220 },
370 .size = sizeof(struct pyra_profile_settings),
371 .write = pyra_sysfs_write_profile_settings
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]
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]
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]
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]
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]
404 .attr = { .name = "profile_buttons", .mode = 0220 },
405 .size = sizeof(struct pyra_profile_buttons),
406 .write = pyra_sysfs_write_profile_buttons
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]
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]
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]
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]
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]
439 .attr = { .name = "settings", .mode = 0660 },
440 .size = sizeof(struct pyra_settings),
441 .read = pyra_sysfs_read_settings,
442 .write = pyra_sysfs_write_settings
444 __ATTR_NULL
447 static int pyra_init_pyra_device_struct(struct usb_device *usb_dev,
448 struct pyra_device *pyra)
450 struct pyra_info info;
451 int retval, i;
453 mutex_init(&pyra->pyra_lock);
455 retval = pyra_get_info(usb_dev, &info);
456 if (retval)
457 return retval;
459 pyra->firmware_version = info.firmware_version;
461 retval = pyra_get_settings(usb_dev, &pyra->settings);
462 if (retval)
463 return retval;
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;
471 retval = pyra_get_profile_buttons(usb_dev,
472 &pyra->profile_buttons[i], i);
473 if (retval)
474 return retval;
477 profile_activated(pyra, pyra->settings.startup_profile);
479 return 0;
482 static int pyra_init_specials(struct hid_device *hdev)
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;
489 if (intf->cur_altsetting->desc.bInterfaceProtocol
490 == USB_INTERFACE_PROTOCOL_MOUSE) {
492 pyra = kzalloc(sizeof(*pyra), GFP_KERNEL);
493 if (!pyra) {
494 hid_err(hdev, "can't alloc device descriptor\n");
495 return -ENOMEM;
497 hid_set_drvdata(hdev, pyra);
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;
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;
513 } else {
514 hid_set_drvdata(hdev, NULL);
517 return 0;
518 exit_free:
519 kfree(pyra);
520 return retval;
523 static void pyra_remove_specials(struct hid_device *hdev)
525 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
526 struct pyra_device *pyra;
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));
537 static int pyra_probe(struct hid_device *hdev, const struct hid_device_id *id)
539 int retval;
541 retval = hid_parse(hdev);
542 if (retval) {
543 hid_err(hdev, "parse failed\n");
544 goto exit;
547 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
548 if (retval) {
549 hid_err(hdev, "hw start failed\n");
550 goto exit;
553 retval = pyra_init_specials(hdev);
554 if (retval) {
555 hid_err(hdev, "couldn't install mouse\n");
556 goto exit_stop;
558 return 0;
560 exit_stop:
561 hid_hw_stop(hdev);
562 exit:
563 return retval;
566 static void pyra_remove(struct hid_device *hdev)
568 pyra_remove_specials(hdev);
569 hid_hw_stop(hdev);
572 static void pyra_keep_values_up_to_date(struct pyra_device *pyra,
573 u8 const *data)
575 struct pyra_mouse_event_button const *button_event;
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;
588 break;
592 static void pyra_report_to_chrdev(struct pyra_device const *pyra,
593 u8 const *data)
595 struct pyra_roccat_report roccat_report;
596 struct pyra_mouse_event_button const *button_event;
598 if (data[0] != PYRA_MOUSE_REPORT_NUMBER_BUTTON)
599 return;
601 button_event = (struct pyra_mouse_event_button const *)data;
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;
619 * pyra reports profile numbers with range 1-5.
620 * Keeping this behaviour.
622 roccat_report.value = pyra->actual_profile + 1;
623 roccat_report_event(pyra->chrdev_minor,
624 (uint8_t const *)&roccat_report);
626 break;
630 static int pyra_raw_event(struct hid_device *hdev, struct hid_report *report,
631 u8 *data, int size)
633 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
634 struct pyra_device *pyra = hid_get_drvdata(hdev);
636 if (intf->cur_altsetting->desc.bInterfaceProtocol
637 != USB_INTERFACE_PROTOCOL_MOUSE)
638 return 0;
640 if (pyra == NULL)
641 return 0;
643 pyra_keep_values_up_to_date(pyra, data);
645 if (pyra->roccat_claimed)
646 pyra_report_to_chrdev(pyra, data);
648 return 0;
651 static 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) },
659 MODULE_DEVICE_TABLE(hid, pyra_devices);
661 static 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
669 static int __init pyra_init(void)
671 int retval;
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;
680 retval = hid_register_driver(&pyra_driver);
681 if (retval)
682 class_destroy(pyra_class);
683 return retval;
686 static void __exit pyra_exit(void)
688 hid_unregister_driver(&pyra_driver);
689 class_destroy(pyra_class);
692 module_init(pyra_init);
693 module_exit(pyra_exit);
695 MODULE_AUTHOR("Stefan Achatz");
696 MODULE_DESCRIPTION("USB Roccat Pyra driver");
697 MODULE_LICENSE("GPL v2");