drivers/hid/hid-roccat-isku.c

   1 /*
   2  * Roccat Isku driver for Linux
   3  *
   4  * Copyright (c) 2011 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 Isku is a gamer keyboard with macro keys that can be configured in
  16  * 5 profiles.
  17  */
  18
  19 #include <linux/device.h>
  20 #include <linux/input.h>
  21 #include <linux/hid.h>
  22 #include <linux/module.h>
  23 #include <linux/slab.h>
  24 #include <linux/hid-roccat.h>
  25 #include "hid-ids.h"
  26 #include "hid-roccat-common.h"
  27 #include "hid-roccat-isku.h"
  28
  29 static struct class *isku_class;
  30
  31 static void isku_profile_activated(struct isku_device *isku, uint new_profile)
  32 {
  33         isku->actual_profile = new_profile;
  34 }
  35
  36 static int isku_receive(struct usb_device *usb_dev, uint command,
  37                 void *buf, uint size)
  38 {
  39         return roccat_common2_receive(usb_dev, command, buf, size);
  40 }
  41
  42 static int isku_get_actual_profile(struct usb_device *usb_dev)
  43 {
  44         struct isku_actual_profile buf;
  45         int retval;
  46
  47         retval = isku_receive(usb_dev, ISKU_COMMAND_ACTUAL_PROFILE,
  48                         &buf, sizeof(struct isku_actual_profile));
  49         return retval ? retval : buf.actual_profile;
  50 }
  51
  52 static int isku_set_actual_profile(struct usb_device *usb_dev, int new_profile)
  53 {
  54         struct isku_actual_profile buf;
  55
  56         buf.command = ISKU_COMMAND_ACTUAL_PROFILE;
  57         buf.size = sizeof(struct isku_actual_profile);
  58         buf.actual_profile = new_profile;
  59         return roccat_common2_send_with_status(usb_dev,
  60                         ISKU_COMMAND_ACTUAL_PROFILE, &buf,
  61                         sizeof(struct isku_actual_profile));
  62 }
  63
  64 static ssize_t isku_sysfs_show_actual_profile(struct device *dev,
  65                 struct device_attribute *attr, char *buf)
  66 {
  67         struct isku_device *isku =
  68                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
  69         return snprintf(buf, PAGE_SIZE, "%d\n", isku->actual_profile);
  70 }
  71
  72 static ssize_t isku_sysfs_set_actual_profile(struct device *dev,
  73                 struct device_attribute *attr, char const *buf, size_t size)
  74 {
  75         struct isku_device *isku;
  76         struct usb_device *usb_dev;
  77         unsigned long profile;
  78         int retval;
  79         struct isku_roccat_report roccat_report;
  80
  81         dev = dev->parent->parent;
  82         isku = hid_get_drvdata(dev_get_drvdata(dev));
  83         usb_dev = interface_to_usbdev(to_usb_interface(dev));
  84
  85         retval = strict_strtoul(buf, 10, &profile);
  86         if (retval)
  87                 return retval;
  88
  89         if (profile > 4)
  90                 return -EINVAL;
  91
  92         mutex_lock(&isku->isku_lock);
  93
  94         retval = isku_set_actual_profile(usb_dev, profile);
  95         if (retval) {
  96                 mutex_unlock(&isku->isku_lock);
  97                 return retval;
  98         }
  99
 100         isku_profile_activated(isku, profile);
 101
 102         roccat_report.event = ISKU_REPORT_BUTTON_EVENT_PROFILE;
 103         roccat_report.data1 = profile + 1;
 104         roccat_report.data2 = 0;
 105         roccat_report.profile = profile + 1;
 106         roccat_report_event(isku->chrdev_minor, (uint8_t const *)&roccat_report);
 107
 108         mutex_unlock(&isku->isku_lock);
 109
 110         return size;
 111 }
 112 static DEVICE_ATTR(actual_profile, 0660, isku_sysfs_show_actual_profile,
 113                    isku_sysfs_set_actual_profile);
 114
 115 static struct attribute *isku_attrs[] = {
 116         &dev_attr_actual_profile.attr,
 117         NULL,
 118 };
 119 ATTRIBUTE_GROUPS(isku);
 120
 121 static ssize_t isku_sysfs_read(struct file *fp, struct kobject *kobj,
 122                 char *buf, loff_t off, size_t count,
 123                 size_t real_size, uint command)
 124 {
 125         struct device *dev =
 126                         container_of(kobj, struct device, kobj)->parent->parent;
 127         struct isku_device *isku = hid_get_drvdata(dev_get_drvdata(dev));
 128         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
 129         int retval;
 130
 131         if (off >= real_size)
 132                 return 0;
 133
 134         if (off != 0 || count > real_size)
 135                 return -EINVAL;
 136
 137         mutex_lock(&isku->isku_lock);
 138         retval = isku_receive(usb_dev, command, buf, count);
 139         mutex_unlock(&isku->isku_lock);
 140
 141         return retval ? retval : count;
 142 }
 143
 144 static ssize_t isku_sysfs_write(struct file *fp, struct kobject *kobj,
 145                 void const *buf, loff_t off, size_t count,
 146                 size_t real_size, uint command)
 147 {
 148         struct device *dev =
 149                         container_of(kobj, struct device, kobj)->parent->parent;
 150         struct isku_device *isku = hid_get_drvdata(dev_get_drvdata(dev));
 151         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
 152         int retval;
 153
 154         if (off != 0 || count > real_size)
 155                 return -EINVAL;
 156
 157         mutex_lock(&isku->isku_lock);
 158         retval = roccat_common2_send_with_status(usb_dev, command,
 159                         (void *)buf, count);
 160         mutex_unlock(&isku->isku_lock);
 161
 162         return retval ? retval : count;
 163 }
 164
 165 #define ISKU_SYSFS_W(thingy, THINGY) \
 166 static ssize_t isku_sysfs_write_ ## thingy(struct file *fp, struct kobject *kobj, \
 167                 struct bin_attribute *attr, char *buf, \
 168                 loff_t off, size_t count) \
 169 { \
 170         return isku_sysfs_write(fp, kobj, buf, off, count, \
 171                         ISKU_SIZE_ ## THINGY, ISKU_COMMAND_ ## THINGY); \
 172 }
 173
 174 #define ISKU_SYSFS_R(thingy, THINGY) \
 175 static ssize_t isku_sysfs_read_ ## thingy(struct file *fp, struct kobject *kobj, \
 176                 struct bin_attribute *attr, char *buf, \
 177                 loff_t off, size_t count) \
 178 { \
 179         return isku_sysfs_read(fp, kobj, buf, off, count, \
 180                         ISKU_SIZE_ ## THINGY, ISKU_COMMAND_ ## THINGY); \
 181 }
 182
 183 #define ISKU_SYSFS_RW(thingy, THINGY) \
 184 ISKU_SYSFS_R(thingy, THINGY) \
 185 ISKU_SYSFS_W(thingy, THINGY)
 186
 187 #define ISKU_BIN_ATTR_RW(thingy, THINGY) \
 188 { \
 189         .attr = { .name = #thingy, .mode = 0660 }, \
 190         .size = ISKU_SIZE_ ## THINGY, \
 191         .read = isku_sysfs_read_ ## thingy, \
 192         .write = isku_sysfs_write_ ## thingy \
 193 }
 194
 195 #define ISKU_BIN_ATTR_R(thingy, THINGY) \
 196 { \
 197         .attr = { .name = #thingy, .mode = 0440 }, \
 198         .size = ISKU_SIZE_ ## THINGY, \
 199         .read = isku_sysfs_read_ ## thingy, \
 200 }
 201
 202 #define ISKU_BIN_ATTR_W(thingy, THINGY) \
 203 { \
 204         .attr = { .name = #thingy, .mode = 0220 }, \
 205         .size = ISKU_SIZE_ ## THINGY, \
 206         .write = isku_sysfs_write_ ## thingy \
 207 }
 208
 209 ISKU_SYSFS_RW(macro, MACRO)
 210 ISKU_SYSFS_RW(keys_function, KEYS_FUNCTION)
 211 ISKU_SYSFS_RW(keys_easyzone, KEYS_EASYZONE)
 212 ISKU_SYSFS_RW(keys_media, KEYS_MEDIA)
 213 ISKU_SYSFS_RW(keys_thumbster, KEYS_THUMBSTER)
 214 ISKU_SYSFS_RW(keys_macro, KEYS_MACRO)
 215 ISKU_SYSFS_RW(keys_capslock, KEYS_CAPSLOCK)
 216 ISKU_SYSFS_RW(light, LIGHT)
 217 ISKU_SYSFS_RW(key_mask, KEY_MASK)
 218 ISKU_SYSFS_RW(last_set, LAST_SET)
 219 ISKU_SYSFS_W(talk, TALK)
 220 ISKU_SYSFS_W(talkfx, TALKFX)
 221 ISKU_SYSFS_R(info, INFO)
 222 ISKU_SYSFS_W(control, CONTROL)
 223 ISKU_SYSFS_W(reset, RESET)
 224
 225 static struct bin_attribute isku_bin_attributes[] = {
 226         ISKU_BIN_ATTR_RW(macro, MACRO),
 227         ISKU_BIN_ATTR_RW(keys_function, KEYS_FUNCTION),
 228         ISKU_BIN_ATTR_RW(keys_easyzone, KEYS_EASYZONE),
 229         ISKU_BIN_ATTR_RW(keys_media, KEYS_MEDIA),
 230         ISKU_BIN_ATTR_RW(keys_thumbster, KEYS_THUMBSTER),
 231         ISKU_BIN_ATTR_RW(keys_macro, KEYS_MACRO),
 232         ISKU_BIN_ATTR_RW(keys_capslock, KEYS_CAPSLOCK),
 233         ISKU_BIN_ATTR_RW(light, LIGHT),
 234         ISKU_BIN_ATTR_RW(key_mask, KEY_MASK),
 235         ISKU_BIN_ATTR_RW(last_set, LAST_SET),
 236         ISKU_BIN_ATTR_W(talk, TALK),
 237         ISKU_BIN_ATTR_W(talkfx, TALKFX),
 238         ISKU_BIN_ATTR_R(info, INFO),
 239         ISKU_BIN_ATTR_W(control, CONTROL),
 240         ISKU_BIN_ATTR_W(reset, RESET),
 241         __ATTR_NULL
 242 };
 243
 244 static int isku_init_isku_device_struct(struct usb_device *usb_dev,
 245                 struct isku_device *isku)
 246 {
 247         int retval;
 248
 249         mutex_init(&isku->isku_lock);
 250
 251         retval = isku_get_actual_profile(usb_dev);
 252         if (retval < 0)
 253                 return retval;
 254         isku_profile_activated(isku, retval);
 255
 256         return 0;
 257 }
 258
 259 static int isku_init_specials(struct hid_device *hdev)
 260 {
 261         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 262         struct usb_device *usb_dev = interface_to_usbdev(intf);
 263         struct isku_device *isku;
 264         int retval;
 265
 266         if (intf->cur_altsetting->desc.bInterfaceProtocol
 267                         != ISKU_USB_INTERFACE_PROTOCOL) {
 268                 hid_set_drvdata(hdev, NULL);
 269                 return 0;
 270         }
 271
 272         isku = kzalloc(sizeof(*isku), GFP_KERNEL);
 273         if (!isku) {
 274                 hid_err(hdev, "can't alloc device descriptor\n");
 275                 return -ENOMEM;
 276         }
 277         hid_set_drvdata(hdev, isku);
 278
 279         retval = isku_init_isku_device_struct(usb_dev, isku);
 280         if (retval) {
 281                 hid_err(hdev, "couldn't init struct isku_device\n");
 282                 goto exit_free;
 283         }
 284
 285         retval = roccat_connect(isku_class, hdev,
 286                         sizeof(struct isku_roccat_report));
 287         if (retval < 0) {
 288                 hid_err(hdev, "couldn't init char dev\n");
 289         } else {
 290                 isku->chrdev_minor = retval;
 291                 isku->roccat_claimed = 1;
 292         }
 293
 294         return 0;
 295 exit_free:
 296         kfree(isku);
 297         return retval;
 298 }
 299
 300 static void isku_remove_specials(struct hid_device *hdev)
 301 {
 302         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 303         struct isku_device *isku;
 304
 305         if (intf->cur_altsetting->desc.bInterfaceProtocol
 306                         != ISKU_USB_INTERFACE_PROTOCOL)
 307                 return;
 308
 309         isku = hid_get_drvdata(hdev);
 310         if (isku->roccat_claimed)
 311                 roccat_disconnect(isku->chrdev_minor);
 312         kfree(isku);
 313 }
 314
 315 static int isku_probe(struct hid_device *hdev,
 316                 const struct hid_device_id *id)
 317 {
 318         int retval;
 319
 320         retval = hid_parse(hdev);
 321         if (retval) {
 322                 hid_err(hdev, "parse failed\n");
 323                 goto exit;
 324         }
 325
 326         retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 327         if (retval) {
 328                 hid_err(hdev, "hw start failed\n");
 329                 goto exit;
 330         }
 331
 332         retval = isku_init_specials(hdev);
 333         if (retval) {
 334                 hid_err(hdev, "couldn't install keyboard\n");
 335                 goto exit_stop;
 336         }
 337
 338         return 0;
 339
 340 exit_stop:
 341         hid_hw_stop(hdev);
 342 exit:
 343         return retval;
 344 }
 345
 346 static void isku_remove(struct hid_device *hdev)
 347 {
 348         isku_remove_specials(hdev);
 349         hid_hw_stop(hdev);
 350 }
 351
 352 static void isku_keep_values_up_to_date(struct isku_device *isku,
 353                 u8 const *data)
 354 {
 355         struct isku_report_button const *button_report;
 356
 357         switch (data[0]) {
 358         case ISKU_REPORT_NUMBER_BUTTON:
 359                 button_report = (struct isku_report_button const *)data;
 360                 switch (button_report->event) {
 361                 case ISKU_REPORT_BUTTON_EVENT_PROFILE:
 362                         isku_profile_activated(isku, button_report->data1 - 1);
 363                         break;
 364                 }
 365                 break;
 366         }
 367 }
 368
 369 static void isku_report_to_chrdev(struct isku_device const *isku,
 370                 u8 const *data)
 371 {
 372         struct isku_roccat_report roccat_report;
 373         struct isku_report_button const *button_report;
 374
 375         if (data[0] != ISKU_REPORT_NUMBER_BUTTON)
 376                 return;
 377
 378         button_report = (struct isku_report_button const *)data;
 379
 380         roccat_report.event = button_report->event;
 381         roccat_report.data1 = button_report->data1;
 382         roccat_report.data2 = button_report->data2;
 383         roccat_report.profile = isku->actual_profile + 1;
 384         roccat_report_event(isku->chrdev_minor,
 385                         (uint8_t const *)&roccat_report);
 386 }
 387
 388 static int isku_raw_event(struct hid_device *hdev,
 389                 struct hid_report *report, u8 *data, int size)
 390 {
 391         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 392         struct isku_device *isku = hid_get_drvdata(hdev);
 393
 394         if (intf->cur_altsetting->desc.bInterfaceProtocol
 395                         != ISKU_USB_INTERFACE_PROTOCOL)
 396                 return 0;
 397
 398         if (isku == NULL)
 399                 return 0;
 400
 401         isku_keep_values_up_to_date(isku, data);
 402
 403         if (isku->roccat_claimed)
 404                 isku_report_to_chrdev(isku, data);
 405
 406         return 0;
 407 }
 408
 409 static const struct hid_device_id isku_devices[] = {
 410         { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_ISKU) },
 411         { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_ISKUFX) },
 412         { }
 413 };
 414
 415 MODULE_DEVICE_TABLE(hid, isku_devices);
 416
 417 static struct hid_driver isku_driver = {
 418                 .name = "isku",
 419                 .id_table = isku_devices,
 420                 .probe = isku_probe,
 421                 .remove = isku_remove,
 422                 .raw_event = isku_raw_event
 423 };
 424
 425 static int __init isku_init(void)
 426 {
 427         int retval;
 428         isku_class = class_create(THIS_MODULE, "isku");
 429         if (IS_ERR(isku_class))
 430                 return PTR_ERR(isku_class);
 431         isku_class->dev_groups = isku_groups;
 432         isku_class->dev_bin_attrs = isku_bin_attributes;
 433
 434         retval = hid_register_driver(&isku_driver);
 435         if (retval)
 436                 class_destroy(isku_class);
 437         return retval;
 438 }
 439
 440 static void __exit isku_exit(void)
 441 {
 442         hid_unregister_driver(&isku_driver);
 443         class_destroy(isku_class);
 444 }
 445
 446 module_init(isku_init);
 447 module_exit(isku_exit);
 448
 449 MODULE_AUTHOR("Stefan Achatz");
 450 MODULE_DESCRIPTION("USB Roccat Isku/FX driver");
 451 MODULE_LICENSE("GPL v2");