Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * Roccat Arvo driver for Linux
0004  *
0005  * Copyright (c) 2011 Stefan Achatz <erazor_de@users.sourceforge.net>
0006  */
0007 
0008 /*
0009  */
0010 
0011 /*
0012  * Roccat Arvo is a gamer keyboard with 5 macro keys that can be configured in
0013  * 5 profiles.
0014  */
0015 
0016 #include <linux/device.h>
0017 #include <linux/input.h>
0018 #include <linux/hid.h>
0019 #include <linux/module.h>
0020 #include <linux/slab.h>
0021 #include <linux/hid-roccat.h>
0022 #include "hid-ids.h"
0023 #include "hid-roccat-common.h"
0024 #include "hid-roccat-arvo.h"
0025 
0026 static struct class *arvo_class;
0027 
0028 static ssize_t arvo_sysfs_show_mode_key(struct device *dev,
0029         struct device_attribute *attr, char *buf)
0030 {
0031     struct arvo_device *arvo =
0032             hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
0033     struct usb_device *usb_dev =
0034             interface_to_usbdev(to_usb_interface(dev->parent->parent));
0035     struct arvo_mode_key temp_buf;
0036     int retval;
0037 
0038     mutex_lock(&arvo->arvo_lock);
0039     retval = roccat_common2_receive(usb_dev, ARVO_COMMAND_MODE_KEY,
0040             &temp_buf, sizeof(struct arvo_mode_key));
0041     mutex_unlock(&arvo->arvo_lock);
0042     if (retval)
0043         return retval;
0044 
0045     return sysfs_emit(buf, "%d\n", temp_buf.state);
0046 }
0047 
0048 static ssize_t arvo_sysfs_set_mode_key(struct device *dev,
0049         struct device_attribute *attr, char const *buf, size_t size)
0050 {
0051     struct arvo_device *arvo =
0052             hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
0053     struct usb_device *usb_dev =
0054             interface_to_usbdev(to_usb_interface(dev->parent->parent));
0055     struct arvo_mode_key temp_buf;
0056     unsigned long state;
0057     int retval;
0058 
0059     retval = kstrtoul(buf, 10, &state);
0060     if (retval)
0061         return retval;
0062 
0063     temp_buf.command = ARVO_COMMAND_MODE_KEY;
0064     temp_buf.state = state;
0065 
0066     mutex_lock(&arvo->arvo_lock);
0067     retval = roccat_common2_send(usb_dev, ARVO_COMMAND_MODE_KEY,
0068             &temp_buf, sizeof(struct arvo_mode_key));
0069     mutex_unlock(&arvo->arvo_lock);
0070     if (retval)
0071         return retval;
0072 
0073     return size;
0074 }
0075 static DEVICE_ATTR(mode_key, 0660,
0076            arvo_sysfs_show_mode_key, arvo_sysfs_set_mode_key);
0077 
0078 static ssize_t arvo_sysfs_show_key_mask(struct device *dev,
0079         struct device_attribute *attr, char *buf)
0080 {
0081     struct arvo_device *arvo =
0082             hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
0083     struct usb_device *usb_dev =
0084             interface_to_usbdev(to_usb_interface(dev->parent->parent));
0085     struct arvo_key_mask temp_buf;
0086     int retval;
0087 
0088     mutex_lock(&arvo->arvo_lock);
0089     retval = roccat_common2_receive(usb_dev, ARVO_COMMAND_KEY_MASK,
0090             &temp_buf, sizeof(struct arvo_key_mask));
0091     mutex_unlock(&arvo->arvo_lock);
0092     if (retval)
0093         return retval;
0094 
0095     return sysfs_emit(buf, "%d\n", temp_buf.key_mask);
0096 }
0097 
0098 static ssize_t arvo_sysfs_set_key_mask(struct device *dev,
0099         struct device_attribute *attr, char const *buf, size_t size)
0100 {
0101     struct arvo_device *arvo =
0102             hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
0103     struct usb_device *usb_dev =
0104             interface_to_usbdev(to_usb_interface(dev->parent->parent));
0105     struct arvo_key_mask temp_buf;
0106     unsigned long key_mask;
0107     int retval;
0108 
0109     retval = kstrtoul(buf, 10, &key_mask);
0110     if (retval)
0111         return retval;
0112 
0113     temp_buf.command = ARVO_COMMAND_KEY_MASK;
0114     temp_buf.key_mask = key_mask;
0115 
0116     mutex_lock(&arvo->arvo_lock);
0117     retval = roccat_common2_send(usb_dev, ARVO_COMMAND_KEY_MASK,
0118             &temp_buf, sizeof(struct arvo_key_mask));
0119     mutex_unlock(&arvo->arvo_lock);
0120     if (retval)
0121         return retval;
0122 
0123     return size;
0124 }
0125 static DEVICE_ATTR(key_mask, 0660,
0126            arvo_sysfs_show_key_mask, arvo_sysfs_set_key_mask);
0127 
0128 /* retval is 1-5 on success, < 0 on error */
0129 static int arvo_get_actual_profile(struct usb_device *usb_dev)
0130 {
0131     struct arvo_actual_profile temp_buf;
0132     int retval;
0133 
0134     retval = roccat_common2_receive(usb_dev, ARVO_COMMAND_ACTUAL_PROFILE,
0135             &temp_buf, sizeof(struct arvo_actual_profile));
0136 
0137     if (retval)
0138         return retval;
0139 
0140     return temp_buf.actual_profile;
0141 }
0142 
0143 static ssize_t arvo_sysfs_show_actual_profile(struct device *dev,
0144         struct device_attribute *attr, char *buf)
0145 {
0146     struct arvo_device *arvo =
0147             hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
0148 
0149     return sysfs_emit(buf, "%d\n", arvo->actual_profile);
0150 }
0151 
0152 static ssize_t arvo_sysfs_set_actual_profile(struct device *dev,
0153         struct device_attribute *attr, char const *buf, size_t size)
0154 {
0155     struct arvo_device *arvo =
0156             hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
0157     struct usb_device *usb_dev =
0158             interface_to_usbdev(to_usb_interface(dev->parent->parent));
0159     struct arvo_actual_profile temp_buf;
0160     unsigned long profile;
0161     int retval;
0162 
0163     retval = kstrtoul(buf, 10, &profile);
0164     if (retval)
0165         return retval;
0166 
0167     if (profile < 1 || profile > 5)
0168         return -EINVAL;
0169 
0170     temp_buf.command = ARVO_COMMAND_ACTUAL_PROFILE;
0171     temp_buf.actual_profile = profile;
0172 
0173     mutex_lock(&arvo->arvo_lock);
0174     retval = roccat_common2_send(usb_dev, ARVO_COMMAND_ACTUAL_PROFILE,
0175             &temp_buf, sizeof(struct arvo_actual_profile));
0176     if (!retval) {
0177         arvo->actual_profile = profile;
0178         retval = size;
0179     }
0180     mutex_unlock(&arvo->arvo_lock);
0181     return retval;
0182 }
0183 static DEVICE_ATTR(actual_profile, 0660,
0184            arvo_sysfs_show_actual_profile,
0185            arvo_sysfs_set_actual_profile);
0186 
0187 static ssize_t arvo_sysfs_write(struct file *fp,
0188         struct kobject *kobj, void const *buf,
0189         loff_t off, size_t count, size_t real_size, uint command)
0190 {
0191     struct device *dev = kobj_to_dev(kobj)->parent->parent;
0192     struct arvo_device *arvo = hid_get_drvdata(dev_get_drvdata(dev));
0193     struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
0194     int retval;
0195 
0196     if (off != 0 || count != real_size)
0197         return -EINVAL;
0198 
0199     mutex_lock(&arvo->arvo_lock);
0200     retval = roccat_common2_send(usb_dev, command, buf, real_size);
0201     mutex_unlock(&arvo->arvo_lock);
0202 
0203     return (retval ? retval : real_size);
0204 }
0205 
0206 static ssize_t arvo_sysfs_read(struct file *fp,
0207         struct kobject *kobj, void *buf, loff_t off,
0208         size_t count, size_t real_size, uint command)
0209 {
0210     struct device *dev = kobj_to_dev(kobj)->parent->parent;
0211     struct arvo_device *arvo = hid_get_drvdata(dev_get_drvdata(dev));
0212     struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
0213     int retval;
0214 
0215     if (off >= real_size)
0216         return 0;
0217 
0218     if (off != 0 || count != real_size)
0219         return -EINVAL;
0220 
0221     mutex_lock(&arvo->arvo_lock);
0222     retval = roccat_common2_receive(usb_dev, command, buf, real_size);
0223     mutex_unlock(&arvo->arvo_lock);
0224 
0225     return (retval ? retval : real_size);
0226 }
0227 
0228 static ssize_t arvo_sysfs_write_button(struct file *fp,
0229         struct kobject *kobj, struct bin_attribute *attr, char *buf,
0230         loff_t off, size_t count)
0231 {
0232     return arvo_sysfs_write(fp, kobj, buf, off, count,
0233             sizeof(struct arvo_button), ARVO_COMMAND_BUTTON);
0234 }
0235 static BIN_ATTR(button, 0220, NULL, arvo_sysfs_write_button,
0236         sizeof(struct arvo_button));
0237 
0238 static ssize_t arvo_sysfs_read_info(struct file *fp,
0239         struct kobject *kobj, struct bin_attribute *attr, char *buf,
0240         loff_t off, size_t count)
0241 {
0242     return arvo_sysfs_read(fp, kobj, buf, off, count,
0243             sizeof(struct arvo_info), ARVO_COMMAND_INFO);
0244 }
0245 static BIN_ATTR(info, 0440, arvo_sysfs_read_info, NULL,
0246         sizeof(struct arvo_info));
0247 
0248 static struct attribute *arvo_attrs[] = {
0249     &dev_attr_mode_key.attr,
0250     &dev_attr_key_mask.attr,
0251     &dev_attr_actual_profile.attr,
0252     NULL,
0253 };
0254 
0255 static struct bin_attribute *arvo_bin_attributes[] = {
0256     &bin_attr_button,
0257     &bin_attr_info,
0258     NULL,
0259 };
0260 
0261 static const struct attribute_group arvo_group = {
0262     .attrs = arvo_attrs,
0263     .bin_attrs = arvo_bin_attributes,
0264 };
0265 
0266 static const struct attribute_group *arvo_groups[] = {
0267     &arvo_group,
0268     NULL,
0269 };
0270 
0271 static int arvo_init_arvo_device_struct(struct usb_device *usb_dev,
0272         struct arvo_device *arvo)
0273 {
0274     int retval;
0275 
0276     mutex_init(&arvo->arvo_lock);
0277 
0278     retval = arvo_get_actual_profile(usb_dev);
0279     if (retval < 0)
0280         return retval;
0281     arvo->actual_profile = retval;
0282 
0283     return 0;
0284 }
0285 
0286 static int arvo_init_specials(struct hid_device *hdev)
0287 {
0288     struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
0289     struct usb_device *usb_dev = interface_to_usbdev(intf);
0290     struct arvo_device *arvo;
0291     int retval;
0292 
0293     if (intf->cur_altsetting->desc.bInterfaceProtocol
0294             == USB_INTERFACE_PROTOCOL_KEYBOARD) {
0295         hid_set_drvdata(hdev, NULL);
0296         return 0;
0297     }
0298 
0299     arvo = kzalloc(sizeof(*arvo), GFP_KERNEL);
0300     if (!arvo) {
0301         hid_err(hdev, "can't alloc device descriptor\n");
0302         return -ENOMEM;
0303     }
0304     hid_set_drvdata(hdev, arvo);
0305 
0306     retval = arvo_init_arvo_device_struct(usb_dev, arvo);
0307     if (retval) {
0308         hid_err(hdev, "couldn't init struct arvo_device\n");
0309         goto exit_free;
0310     }
0311 
0312     retval = roccat_connect(arvo_class, hdev,
0313             sizeof(struct arvo_roccat_report));
0314     if (retval < 0) {
0315         hid_err(hdev, "couldn't init char dev\n");
0316     } else {
0317         arvo->chrdev_minor = retval;
0318         arvo->roccat_claimed = 1;
0319     }
0320 
0321     return 0;
0322 exit_free:
0323     kfree(arvo);
0324     return retval;
0325 }
0326 
0327 static void arvo_remove_specials(struct hid_device *hdev)
0328 {
0329     struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
0330     struct arvo_device *arvo;
0331 
0332     if (intf->cur_altsetting->desc.bInterfaceProtocol
0333             == USB_INTERFACE_PROTOCOL_KEYBOARD)
0334         return;
0335 
0336     arvo = hid_get_drvdata(hdev);
0337     if (arvo->roccat_claimed)
0338         roccat_disconnect(arvo->chrdev_minor);
0339     kfree(arvo);
0340 }
0341 
0342 static int arvo_probe(struct hid_device *hdev,
0343         const struct hid_device_id *id)
0344 {
0345     int retval;
0346 
0347     if (!hid_is_usb(hdev))
0348         return -EINVAL;
0349 
0350     retval = hid_parse(hdev);
0351     if (retval) {
0352         hid_err(hdev, "parse failed\n");
0353         goto exit;
0354     }
0355 
0356     retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
0357     if (retval) {
0358         hid_err(hdev, "hw start failed\n");
0359         goto exit;
0360     }
0361 
0362     retval = arvo_init_specials(hdev);
0363     if (retval) {
0364         hid_err(hdev, "couldn't install keyboard\n");
0365         goto exit_stop;
0366     }
0367 
0368     return 0;
0369 
0370 exit_stop:
0371     hid_hw_stop(hdev);
0372 exit:
0373     return retval;
0374 }
0375 
0376 static void arvo_remove(struct hid_device *hdev)
0377 {
0378     arvo_remove_specials(hdev);
0379     hid_hw_stop(hdev);
0380 }
0381 
0382 static void arvo_report_to_chrdev(struct arvo_device const *arvo,
0383         u8 const *data)
0384 {
0385     struct arvo_special_report const *special_report;
0386     struct arvo_roccat_report roccat_report;
0387 
0388     special_report = (struct arvo_special_report const *)data;
0389 
0390     roccat_report.profile = arvo->actual_profile;
0391     roccat_report.button = special_report->event &
0392             ARVO_SPECIAL_REPORT_EVENT_MASK_BUTTON;
0393     if ((special_report->event & ARVO_SPECIAL_REPORT_EVENT_MASK_ACTION) ==
0394             ARVO_SPECIAL_REPORT_EVENT_ACTION_PRESS)
0395         roccat_report.action = ARVO_ROCCAT_REPORT_ACTION_PRESS;
0396     else
0397         roccat_report.action = ARVO_ROCCAT_REPORT_ACTION_RELEASE;
0398 
0399     roccat_report_event(arvo->chrdev_minor,
0400             (uint8_t const *)&roccat_report);
0401 }
0402 
0403 static int arvo_raw_event(struct hid_device *hdev,
0404         struct hid_report *report, u8 *data, int size)
0405 {
0406     struct arvo_device *arvo = hid_get_drvdata(hdev);
0407 
0408     if (size != 3)
0409         return 0;
0410 
0411     if (arvo && arvo->roccat_claimed)
0412         arvo_report_to_chrdev(arvo, data);
0413 
0414     return 0;
0415 }
0416 
0417 static const struct hid_device_id arvo_devices[] = {
0418     { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_ARVO) },
0419     { }
0420 };
0421 
0422 MODULE_DEVICE_TABLE(hid, arvo_devices);
0423 
0424 static struct hid_driver arvo_driver = {
0425     .name = "arvo",
0426     .id_table = arvo_devices,
0427     .probe = arvo_probe,
0428     .remove = arvo_remove,
0429     .raw_event = arvo_raw_event
0430 };
0431 
0432 static int __init arvo_init(void)
0433 {
0434     int retval;
0435 
0436     arvo_class = class_create(THIS_MODULE, "arvo");
0437     if (IS_ERR(arvo_class))
0438         return PTR_ERR(arvo_class);
0439     arvo_class->dev_groups = arvo_groups;
0440 
0441     retval = hid_register_driver(&arvo_driver);
0442     if (retval)
0443         class_destroy(arvo_class);
0444     return retval;
0445 }
0446 
0447 static void __exit arvo_exit(void)
0448 {
0449     hid_unregister_driver(&arvo_driver);
0450     class_destroy(arvo_class);
0451 }
0452 
0453 module_init(arvo_init);
0454 module_exit(arvo_exit);
0455 
0456 MODULE_AUTHOR("Stefan Achatz");
0457 MODULE_DESCRIPTION("USB Roccat Arvo driver");
0458 MODULE_LICENSE("GPL v2");
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!