hid-corsair.c 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754
  1. /*
  2. * HID driver for Corsair devices
  3. *
  4. * Supported devices:
  5. * - Vengeance K70 Keyboard
  6. * - K70 RAPIDFIRE Keyboard
  7. * - Vengeance K90 Keyboard
  8. * - Scimitar PRO RGB Gaming Mouse
  9. *
  10. * Copyright (c) 2015 Clement Vuchener
  11. * Copyright (c) 2017 Oscar Campos
  12. * Copyright (c) 2017 Aaron Bottegal
  13. */
  14. /*
  15. * This program is free software; you can redistribute it and/or modify it
  16. * under the terms of the GNU General Public License as published by the Free
  17. * Software Foundation; either version 2 of the License, or (at your option)
  18. * any later version.
  19. */
  20. #include <linux/hid.h>
  21. #include <linux/module.h>
  22. #include <linux/usb.h>
  23. #include <linux/leds.h>
  24. #include "hid-ids.h"
  25. #define CORSAIR_USE_K90_MACRO (1<<0)
  26. #define CORSAIR_USE_K90_BACKLIGHT (1<<1)
  27. struct k90_led {
  28. struct led_classdev cdev;
  29. int brightness;
  30. struct work_struct work;
  31. bool removed;
  32. };
  33. struct k90_drvdata {
  34. struct k90_led record_led;
  35. };
  36. struct corsair_drvdata {
  37. unsigned long quirks;
  38. struct k90_drvdata *k90;
  39. struct k90_led *backlight;
  40. };
  41. #define K90_GKEY_COUNT 18
  42. static int corsair_usage_to_gkey(unsigned int usage)
  43. {
  44. /* G1 (0xd0) to G16 (0xdf) */
  45. if (usage >= 0xd0 && usage <= 0xdf)
  46. return usage - 0xd0 + 1;
  47. /* G17 (0xe8) to G18 (0xe9) */
  48. if (usage >= 0xe8 && usage <= 0xe9)
  49. return usage - 0xe8 + 17;
  50. return 0;
  51. }
  52. static unsigned short corsair_gkey_map[K90_GKEY_COUNT] = {
  53. BTN_TRIGGER_HAPPY1,
  54. BTN_TRIGGER_HAPPY2,
  55. BTN_TRIGGER_HAPPY3,
  56. BTN_TRIGGER_HAPPY4,
  57. BTN_TRIGGER_HAPPY5,
  58. BTN_TRIGGER_HAPPY6,
  59. BTN_TRIGGER_HAPPY7,
  60. BTN_TRIGGER_HAPPY8,
  61. BTN_TRIGGER_HAPPY9,
  62. BTN_TRIGGER_HAPPY10,
  63. BTN_TRIGGER_HAPPY11,
  64. BTN_TRIGGER_HAPPY12,
  65. BTN_TRIGGER_HAPPY13,
  66. BTN_TRIGGER_HAPPY14,
  67. BTN_TRIGGER_HAPPY15,
  68. BTN_TRIGGER_HAPPY16,
  69. BTN_TRIGGER_HAPPY17,
  70. BTN_TRIGGER_HAPPY18,
  71. };
  72. module_param_array_named(gkey_codes, corsair_gkey_map, ushort, NULL, S_IRUGO);
  73. MODULE_PARM_DESC(gkey_codes, "Key codes for the G-keys");
  74. static unsigned short corsair_record_keycodes[2] = {
  75. BTN_TRIGGER_HAPPY19,
  76. BTN_TRIGGER_HAPPY20
  77. };
  78. module_param_array_named(recordkey_codes, corsair_record_keycodes, ushort,
  79. NULL, S_IRUGO);
  80. MODULE_PARM_DESC(recordkey_codes, "Key codes for the MR (start and stop record) button");
  81. static unsigned short corsair_profile_keycodes[3] = {
  82. BTN_TRIGGER_HAPPY21,
  83. BTN_TRIGGER_HAPPY22,
  84. BTN_TRIGGER_HAPPY23
  85. };
  86. module_param_array_named(profilekey_codes, corsair_profile_keycodes, ushort,
  87. NULL, S_IRUGO);
  88. MODULE_PARM_DESC(profilekey_codes, "Key codes for the profile buttons");
  89. #define CORSAIR_USAGE_SPECIAL_MIN 0xf0
  90. #define CORSAIR_USAGE_SPECIAL_MAX 0xff
  91. #define CORSAIR_USAGE_MACRO_RECORD_START 0xf6
  92. #define CORSAIR_USAGE_MACRO_RECORD_STOP 0xf7
  93. #define CORSAIR_USAGE_PROFILE 0xf1
  94. #define CORSAIR_USAGE_M1 0xf1
  95. #define CORSAIR_USAGE_M2 0xf2
  96. #define CORSAIR_USAGE_M3 0xf3
  97. #define CORSAIR_USAGE_PROFILE_MAX 0xf3
  98. #define CORSAIR_USAGE_META_OFF 0xf4
  99. #define CORSAIR_USAGE_META_ON 0xf5
  100. #define CORSAIR_USAGE_LIGHT 0xfa
  101. #define CORSAIR_USAGE_LIGHT_OFF 0xfa
  102. #define CORSAIR_USAGE_LIGHT_DIM 0xfb
  103. #define CORSAIR_USAGE_LIGHT_MEDIUM 0xfc
  104. #define CORSAIR_USAGE_LIGHT_BRIGHT 0xfd
  105. #define CORSAIR_USAGE_LIGHT_MAX 0xfd
  106. /* USB control protocol */
  107. #define K90_REQUEST_BRIGHTNESS 49
  108. #define K90_REQUEST_MACRO_MODE 2
  109. #define K90_REQUEST_STATUS 4
  110. #define K90_REQUEST_GET_MODE 5
  111. #define K90_REQUEST_PROFILE 20
  112. #define K90_MACRO_MODE_SW 0x0030
  113. #define K90_MACRO_MODE_HW 0x0001
  114. #define K90_MACRO_LED_ON 0x0020
  115. #define K90_MACRO_LED_OFF 0x0040
  116. /*
  117. * LED class devices
  118. */
  119. #define K90_BACKLIGHT_LED_SUFFIX "::backlight"
  120. #define K90_RECORD_LED_SUFFIX "::record"
  121. static enum led_brightness k90_backlight_get(struct led_classdev *led_cdev)
  122. {
  123. int ret;
  124. struct k90_led *led = container_of(led_cdev, struct k90_led, cdev);
  125. struct device *dev = led->cdev.dev->parent;
  126. struct usb_interface *usbif = to_usb_interface(dev->parent);
  127. struct usb_device *usbdev = interface_to_usbdev(usbif);
  128. int brightness;
  129. char *data;
  130. data = kmalloc(8, GFP_KERNEL);
  131. if (!data)
  132. return -ENOMEM;
  133. ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
  134. K90_REQUEST_STATUS,
  135. USB_DIR_IN | USB_TYPE_VENDOR |
  136. USB_RECIP_DEVICE, 0, 0, data, 8,
  137. USB_CTRL_SET_TIMEOUT);
  138. if (ret < 5) {
  139. dev_warn(dev, "Failed to get K90 initial state (error %d).\n",
  140. ret);
  141. ret = -EIO;
  142. goto out;
  143. }
  144. brightness = data[4];
  145. if (brightness < 0 || brightness > 3) {
  146. dev_warn(dev,
  147. "Read invalid backlight brightness: %02hhx.\n",
  148. data[4]);
  149. ret = -EIO;
  150. goto out;
  151. }
  152. ret = brightness;
  153. out:
  154. kfree(data);
  155. return ret;
  156. }
  157. static enum led_brightness k90_record_led_get(struct led_classdev *led_cdev)
  158. {
  159. struct k90_led *led = container_of(led_cdev, struct k90_led, cdev);
  160. return led->brightness;
  161. }
  162. static void k90_brightness_set(struct led_classdev *led_cdev,
  163. enum led_brightness brightness)
  164. {
  165. struct k90_led *led = container_of(led_cdev, struct k90_led, cdev);
  166. led->brightness = brightness;
  167. schedule_work(&led->work);
  168. }
  169. static void k90_backlight_work(struct work_struct *work)
  170. {
  171. int ret;
  172. struct k90_led *led = container_of(work, struct k90_led, work);
  173. struct device *dev;
  174. struct usb_interface *usbif;
  175. struct usb_device *usbdev;
  176. if (led->removed)
  177. return;
  178. dev = led->cdev.dev->parent;
  179. usbif = to_usb_interface(dev->parent);
  180. usbdev = interface_to_usbdev(usbif);
  181. ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
  182. K90_REQUEST_BRIGHTNESS,
  183. USB_DIR_OUT | USB_TYPE_VENDOR |
  184. USB_RECIP_DEVICE, led->brightness, 0,
  185. NULL, 0, USB_CTRL_SET_TIMEOUT);
  186. if (ret != 0)
  187. dev_warn(dev, "Failed to set backlight brightness (error: %d).\n",
  188. ret);
  189. }
  190. static void k90_record_led_work(struct work_struct *work)
  191. {
  192. int ret;
  193. struct k90_led *led = container_of(work, struct k90_led, work);
  194. struct device *dev;
  195. struct usb_interface *usbif;
  196. struct usb_device *usbdev;
  197. int value;
  198. if (led->removed)
  199. return;
  200. dev = led->cdev.dev->parent;
  201. usbif = to_usb_interface(dev->parent);
  202. usbdev = interface_to_usbdev(usbif);
  203. if (led->brightness > 0)
  204. value = K90_MACRO_LED_ON;
  205. else
  206. value = K90_MACRO_LED_OFF;
  207. ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
  208. K90_REQUEST_MACRO_MODE,
  209. USB_DIR_OUT | USB_TYPE_VENDOR |
  210. USB_RECIP_DEVICE, value, 0, NULL, 0,
  211. USB_CTRL_SET_TIMEOUT);
  212. if (ret != 0)
  213. dev_warn(dev, "Failed to set record LED state (error: %d).\n",
  214. ret);
  215. }
  216. /*
  217. * Keyboard attributes
  218. */
  219. static ssize_t k90_show_macro_mode(struct device *dev,
  220. struct device_attribute *attr, char *buf)
  221. {
  222. int ret;
  223. struct usb_interface *usbif = to_usb_interface(dev->parent);
  224. struct usb_device *usbdev = interface_to_usbdev(usbif);
  225. const char *macro_mode;
  226. char *data;
  227. data = kmalloc(2, GFP_KERNEL);
  228. if (!data)
  229. return -ENOMEM;
  230. ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
  231. K90_REQUEST_GET_MODE,
  232. USB_DIR_IN | USB_TYPE_VENDOR |
  233. USB_RECIP_DEVICE, 0, 0, data, 2,
  234. USB_CTRL_SET_TIMEOUT);
  235. if (ret < 1) {
  236. dev_warn(dev, "Failed to get K90 initial mode (error %d).\n",
  237. ret);
  238. ret = -EIO;
  239. goto out;
  240. }
  241. switch (data[0]) {
  242. case K90_MACRO_MODE_HW:
  243. macro_mode = "HW";
  244. break;
  245. case K90_MACRO_MODE_SW:
  246. macro_mode = "SW";
  247. break;
  248. default:
  249. dev_warn(dev, "K90 in unknown mode: %02hhx.\n",
  250. data[0]);
  251. ret = -EIO;
  252. goto out;
  253. }
  254. ret = snprintf(buf, PAGE_SIZE, "%s\n", macro_mode);
  255. out:
  256. kfree(data);
  257. return ret;
  258. }
  259. static ssize_t k90_store_macro_mode(struct device *dev,
  260. struct device_attribute *attr,
  261. const char *buf, size_t count)
  262. {
  263. int ret;
  264. struct usb_interface *usbif = to_usb_interface(dev->parent);
  265. struct usb_device *usbdev = interface_to_usbdev(usbif);
  266. __u16 value;
  267. if (strncmp(buf, "SW", 2) == 0)
  268. value = K90_MACRO_MODE_SW;
  269. else if (strncmp(buf, "HW", 2) == 0)
  270. value = K90_MACRO_MODE_HW;
  271. else
  272. return -EINVAL;
  273. ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
  274. K90_REQUEST_MACRO_MODE,
  275. USB_DIR_OUT | USB_TYPE_VENDOR |
  276. USB_RECIP_DEVICE, value, 0, NULL, 0,
  277. USB_CTRL_SET_TIMEOUT);
  278. if (ret != 0) {
  279. dev_warn(dev, "Failed to set macro mode.\n");
  280. return ret;
  281. }
  282. return count;
  283. }
  284. static ssize_t k90_show_current_profile(struct device *dev,
  285. struct device_attribute *attr,
  286. char *buf)
  287. {
  288. int ret;
  289. struct usb_interface *usbif = to_usb_interface(dev->parent);
  290. struct usb_device *usbdev = interface_to_usbdev(usbif);
  291. int current_profile;
  292. char *data;
  293. data = kmalloc(8, GFP_KERNEL);
  294. if (!data)
  295. return -ENOMEM;
  296. ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
  297. K90_REQUEST_STATUS,
  298. USB_DIR_IN | USB_TYPE_VENDOR |
  299. USB_RECIP_DEVICE, 0, 0, data, 8,
  300. USB_CTRL_SET_TIMEOUT);
  301. if (ret < 8) {
  302. dev_warn(dev, "Failed to get K90 initial state (error %d).\n",
  303. ret);
  304. ret = -EIO;
  305. goto out;
  306. }
  307. current_profile = data[7];
  308. if (current_profile < 1 || current_profile > 3) {
  309. dev_warn(dev, "Read invalid current profile: %02hhx.\n",
  310. data[7]);
  311. ret = -EIO;
  312. goto out;
  313. }
  314. ret = snprintf(buf, PAGE_SIZE, "%d\n", current_profile);
  315. out:
  316. kfree(data);
  317. return ret;
  318. }
  319. static ssize_t k90_store_current_profile(struct device *dev,
  320. struct device_attribute *attr,
  321. const char *buf, size_t count)
  322. {
  323. int ret;
  324. struct usb_interface *usbif = to_usb_interface(dev->parent);
  325. struct usb_device *usbdev = interface_to_usbdev(usbif);
  326. int profile;
  327. if (kstrtoint(buf, 10, &profile))
  328. return -EINVAL;
  329. if (profile < 1 || profile > 3)
  330. return -EINVAL;
  331. ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0),
  332. K90_REQUEST_PROFILE,
  333. USB_DIR_OUT | USB_TYPE_VENDOR |
  334. USB_RECIP_DEVICE, profile, 0, NULL, 0,
  335. USB_CTRL_SET_TIMEOUT);
  336. if (ret != 0) {
  337. dev_warn(dev, "Failed to change current profile (error %d).\n",
  338. ret);
  339. return ret;
  340. }
  341. return count;
  342. }
  343. static DEVICE_ATTR(macro_mode, 0644, k90_show_macro_mode, k90_store_macro_mode);
  344. static DEVICE_ATTR(current_profile, 0644, k90_show_current_profile,
  345. k90_store_current_profile);
  346. static struct attribute *k90_attrs[] = {
  347. &dev_attr_macro_mode.attr,
  348. &dev_attr_current_profile.attr,
  349. NULL
  350. };
  351. static const struct attribute_group k90_attr_group = {
  352. .attrs = k90_attrs,
  353. };
  354. /*
  355. * Driver functions
  356. */
  357. static int k90_init_backlight(struct hid_device *dev)
  358. {
  359. int ret;
  360. struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
  361. size_t name_sz;
  362. char *name;
  363. drvdata->backlight = kzalloc(sizeof(struct k90_led), GFP_KERNEL);
  364. if (!drvdata->backlight) {
  365. ret = -ENOMEM;
  366. goto fail_backlight_alloc;
  367. }
  368. name_sz =
  369. strlen(dev_name(&dev->dev)) + sizeof(K90_BACKLIGHT_LED_SUFFIX);
  370. name = kzalloc(name_sz, GFP_KERNEL);
  371. if (!name) {
  372. ret = -ENOMEM;
  373. goto fail_name_alloc;
  374. }
  375. snprintf(name, name_sz, "%s" K90_BACKLIGHT_LED_SUFFIX,
  376. dev_name(&dev->dev));
  377. drvdata->backlight->removed = false;
  378. drvdata->backlight->cdev.name = name;
  379. drvdata->backlight->cdev.max_brightness = 3;
  380. drvdata->backlight->cdev.brightness_set = k90_brightness_set;
  381. drvdata->backlight->cdev.brightness_get = k90_backlight_get;
  382. INIT_WORK(&drvdata->backlight->work, k90_backlight_work);
  383. ret = led_classdev_register(&dev->dev, &drvdata->backlight->cdev);
  384. if (ret != 0)
  385. goto fail_register_cdev;
  386. return 0;
  387. fail_register_cdev:
  388. kfree(drvdata->backlight->cdev.name);
  389. fail_name_alloc:
  390. kfree(drvdata->backlight);
  391. drvdata->backlight = NULL;
  392. fail_backlight_alloc:
  393. return ret;
  394. }
  395. static int k90_init_macro_functions(struct hid_device *dev)
  396. {
  397. int ret;
  398. struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
  399. struct k90_drvdata *k90;
  400. size_t name_sz;
  401. char *name;
  402. k90 = kzalloc(sizeof(struct k90_drvdata), GFP_KERNEL);
  403. if (!k90) {
  404. ret = -ENOMEM;
  405. goto fail_drvdata;
  406. }
  407. drvdata->k90 = k90;
  408. /* Init LED device for record LED */
  409. name_sz = strlen(dev_name(&dev->dev)) + sizeof(K90_RECORD_LED_SUFFIX);
  410. name = kzalloc(name_sz, GFP_KERNEL);
  411. if (!name) {
  412. ret = -ENOMEM;
  413. goto fail_record_led_alloc;
  414. }
  415. snprintf(name, name_sz, "%s" K90_RECORD_LED_SUFFIX,
  416. dev_name(&dev->dev));
  417. k90->record_led.removed = false;
  418. k90->record_led.cdev.name = name;
  419. k90->record_led.cdev.max_brightness = 1;
  420. k90->record_led.cdev.brightness_set = k90_brightness_set;
  421. k90->record_led.cdev.brightness_get = k90_record_led_get;
  422. INIT_WORK(&k90->record_led.work, k90_record_led_work);
  423. k90->record_led.brightness = 0;
  424. ret = led_classdev_register(&dev->dev, &k90->record_led.cdev);
  425. if (ret != 0)
  426. goto fail_record_led;
  427. /* Init attributes */
  428. ret = sysfs_create_group(&dev->dev.kobj, &k90_attr_group);
  429. if (ret != 0)
  430. goto fail_sysfs;
  431. return 0;
  432. fail_sysfs:
  433. k90->record_led.removed = true;
  434. led_classdev_unregister(&k90->record_led.cdev);
  435. cancel_work_sync(&k90->record_led.work);
  436. fail_record_led:
  437. kfree(k90->record_led.cdev.name);
  438. fail_record_led_alloc:
  439. kfree(k90);
  440. fail_drvdata:
  441. drvdata->k90 = NULL;
  442. return ret;
  443. }
  444. static void k90_cleanup_backlight(struct hid_device *dev)
  445. {
  446. struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
  447. if (drvdata->backlight) {
  448. drvdata->backlight->removed = true;
  449. led_classdev_unregister(&drvdata->backlight->cdev);
  450. cancel_work_sync(&drvdata->backlight->work);
  451. kfree(drvdata->backlight->cdev.name);
  452. kfree(drvdata->backlight);
  453. }
  454. }
  455. static void k90_cleanup_macro_functions(struct hid_device *dev)
  456. {
  457. struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
  458. struct k90_drvdata *k90 = drvdata->k90;
  459. if (k90) {
  460. sysfs_remove_group(&dev->dev.kobj, &k90_attr_group);
  461. k90->record_led.removed = true;
  462. led_classdev_unregister(&k90->record_led.cdev);
  463. cancel_work_sync(&k90->record_led.work);
  464. kfree(k90->record_led.cdev.name);
  465. kfree(k90);
  466. }
  467. }
  468. static int corsair_probe(struct hid_device *dev, const struct hid_device_id *id)
  469. {
  470. int ret;
  471. unsigned long quirks = id->driver_data;
  472. struct corsair_drvdata *drvdata;
  473. struct usb_interface *usbif = to_usb_interface(dev->dev.parent);
  474. drvdata = devm_kzalloc(&dev->dev, sizeof(struct corsair_drvdata),
  475. GFP_KERNEL);
  476. if (drvdata == NULL)
  477. return -ENOMEM;
  478. drvdata->quirks = quirks;
  479. hid_set_drvdata(dev, drvdata);
  480. ret = hid_parse(dev);
  481. if (ret != 0) {
  482. hid_err(dev, "parse failed\n");
  483. return ret;
  484. }
  485. ret = hid_hw_start(dev, HID_CONNECT_DEFAULT);
  486. if (ret != 0) {
  487. hid_err(dev, "hw start failed\n");
  488. return ret;
  489. }
  490. if (usbif->cur_altsetting->desc.bInterfaceNumber == 0) {
  491. if (quirks & CORSAIR_USE_K90_MACRO) {
  492. ret = k90_init_macro_functions(dev);
  493. if (ret != 0)
  494. hid_warn(dev, "Failed to initialize K90 macro functions.\n");
  495. }
  496. if (quirks & CORSAIR_USE_K90_BACKLIGHT) {
  497. ret = k90_init_backlight(dev);
  498. if (ret != 0)
  499. hid_warn(dev, "Failed to initialize K90 backlight.\n");
  500. }
  501. }
  502. return 0;
  503. }
  504. static void corsair_remove(struct hid_device *dev)
  505. {
  506. k90_cleanup_macro_functions(dev);
  507. k90_cleanup_backlight(dev);
  508. hid_hw_stop(dev);
  509. }
  510. static int corsair_event(struct hid_device *dev, struct hid_field *field,
  511. struct hid_usage *usage, __s32 value)
  512. {
  513. struct corsair_drvdata *drvdata = hid_get_drvdata(dev);
  514. if (!drvdata->k90)
  515. return 0;
  516. switch (usage->hid & HID_USAGE) {
  517. case CORSAIR_USAGE_MACRO_RECORD_START:
  518. drvdata->k90->record_led.brightness = 1;
  519. break;
  520. case CORSAIR_USAGE_MACRO_RECORD_STOP:
  521. drvdata->k90->record_led.brightness = 0;
  522. break;
  523. default:
  524. break;
  525. }
  526. return 0;
  527. }
  528. static int corsair_input_mapping(struct hid_device *dev,
  529. struct hid_input *input,
  530. struct hid_field *field,
  531. struct hid_usage *usage, unsigned long **bit,
  532. int *max)
  533. {
  534. int gkey;
  535. if ((usage->hid & HID_USAGE_PAGE) != HID_UP_KEYBOARD)
  536. return 0;
  537. gkey = corsair_usage_to_gkey(usage->hid & HID_USAGE);
  538. if (gkey != 0) {
  539. hid_map_usage_clear(input, usage, bit, max, EV_KEY,
  540. corsair_gkey_map[gkey - 1]);
  541. return 1;
  542. }
  543. if ((usage->hid & HID_USAGE) >= CORSAIR_USAGE_SPECIAL_MIN &&
  544. (usage->hid & HID_USAGE) <= CORSAIR_USAGE_SPECIAL_MAX) {
  545. switch (usage->hid & HID_USAGE) {
  546. case CORSAIR_USAGE_MACRO_RECORD_START:
  547. hid_map_usage_clear(input, usage, bit, max, EV_KEY,
  548. corsair_record_keycodes[0]);
  549. return 1;
  550. case CORSAIR_USAGE_MACRO_RECORD_STOP:
  551. hid_map_usage_clear(input, usage, bit, max, EV_KEY,
  552. corsair_record_keycodes[1]);
  553. return 1;
  554. case CORSAIR_USAGE_M1:
  555. hid_map_usage_clear(input, usage, bit, max, EV_KEY,
  556. corsair_profile_keycodes[0]);
  557. return 1;
  558. case CORSAIR_USAGE_M2:
  559. hid_map_usage_clear(input, usage, bit, max, EV_KEY,
  560. corsair_profile_keycodes[1]);
  561. return 1;
  562. case CORSAIR_USAGE_M3:
  563. hid_map_usage_clear(input, usage, bit, max, EV_KEY,
  564. corsair_profile_keycodes[2]);
  565. return 1;
  566. default:
  567. return -1;
  568. }
  569. }
  570. return 0;
  571. }
  572. /*
  573. * The report descriptor of some of the Corsair gaming mice is
  574. * non parseable as they define two consecutive Logical Minimum for
  575. * the Usage Page (Consumer) in rdescs bytes 75 and 77 being 77 0x16
  576. * that should be obviousy 0x26 for Logical Magimum of 16 bits. This
  577. * prevents poper parsing of the report descriptor due Logical
  578. * Minimum being larger than Logical Maximum.
  579. *
  580. * This driver fixes the report descriptor for:
  581. * - USB ID 1b1c:1b34, sold as GLAIVE RGB Gaming mouse
  582. * - USB ID 1b1c:1b3e, sold as Scimitar RGB Pro Gaming mouse
  583. */
  584. static __u8 *corsair_mouse_report_fixup(struct hid_device *hdev, __u8 *rdesc,
  585. unsigned int *rsize)
  586. {
  587. struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
  588. if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
  589. /*
  590. * Corsair GLAIVE RGB and Scimitar RGB Pro report descriptor is
  591. * broken and defines two different Logical Minimum for the
  592. * Consumer Application. The byte 77 should be a 0x26 defining
  593. * a 16 bits integer for the Logical Maximum but it is a 0x16
  594. * instead (Logical Minimum)
  595. */
  596. switch (hdev->product) {
  597. case USB_DEVICE_ID_CORSAIR_GLAIVE_RGB:
  598. case USB_DEVICE_ID_CORSAIR_SCIMITAR_PRO_RGB:
  599. if (*rsize >= 172 && rdesc[75] == 0x15 && rdesc[77] == 0x16
  600. && rdesc[78] == 0xff && rdesc[79] == 0x0f) {
  601. hid_info(hdev, "Fixing up report descriptor\n");
  602. rdesc[77] = 0x26;
  603. }
  604. break;
  605. }
  606. }
  607. return rdesc;
  608. }
  609. static const struct hid_device_id corsair_devices[] = {
  610. { HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR, USB_DEVICE_ID_CORSAIR_K90),
  611. .driver_data = CORSAIR_USE_K90_MACRO |
  612. CORSAIR_USE_K90_BACKLIGHT },
  613. { HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR,
  614. USB_DEVICE_ID_CORSAIR_GLAIVE_RGB) },
  615. { HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR,
  616. USB_DEVICE_ID_CORSAIR_SCIMITAR_PRO_RGB) },
  617. /*
  618. * Vengeance K70 and K70 RAPIDFIRE share product IDs.
  619. */
  620. { HID_USB_DEVICE(USB_VENDOR_ID_CORSAIR,
  621. USB_DEVICE_ID_CORSAIR_K70R) },
  622. {}
  623. };
  624. MODULE_DEVICE_TABLE(hid, corsair_devices);
  625. static struct hid_driver corsair_driver = {
  626. .name = "corsair",
  627. .id_table = corsair_devices,
  628. .probe = corsair_probe,
  629. .event = corsair_event,
  630. .remove = corsair_remove,
  631. .input_mapping = corsair_input_mapping,
  632. .report_fixup = corsair_mouse_report_fixup,
  633. };
  634. module_hid_driver(corsair_driver);
  635. MODULE_LICENSE("GPL");
  636. /* Original K90 driver author */
  637. MODULE_AUTHOR("Clement Vuchener");
  638. /* Scimitar PRO RGB driver author */
  639. MODULE_AUTHOR("Oscar Campos");
  640. MODULE_DESCRIPTION("HID driver for Corsair devices");