hid-roccat-kone.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914
  1. /*
  2. * Roccat Kone driver for Linux
  3. *
  4. * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
  5. */
  6. /*
  7. * This program is free software; you can redistribute it and/or modify it
  8. * under the terms of the GNU General Public License as published by the Free
  9. * Software Foundation; either version 2 of the License, or (at your option)
  10. * any later version.
  11. */
  12. /*
  13. * Roccat Kone is a gamer mouse which consists of a mouse part and a keyboard
  14. * part. The keyboard part enables the mouse to execute stored macros with mixed
  15. * key- and button-events.
  16. *
  17. * TODO implement on-the-fly polling-rate change
  18. * The windows driver has the ability to change the polling rate of the
  19. * device on the press of a mousebutton.
  20. * Is it possible to remove and reinstall the urb in raw-event- or any
  21. * other handler, or to defer this action to be executed somewhere else?
  22. *
  23. * TODO is it possible to overwrite group for sysfs attributes via udev?
  24. */
  25. #include <linux/device.h>
  26. #include <linux/input.h>
  27. #include <linux/hid.h>
  28. #include <linux/module.h>
  29. #include <linux/slab.h>
  30. #include <linux/hid-roccat.h>
  31. #include "hid-ids.h"
  32. #include "hid-roccat-common.h"
  33. #include "hid-roccat-kone.h"
  34. static uint profile_numbers[5] = {0, 1, 2, 3, 4};
  35. static void kone_profile_activated(struct kone_device *kone, uint new_profile)
  36. {
  37. kone->actual_profile = new_profile;
  38. kone->actual_dpi = kone->profiles[new_profile - 1].startup_dpi;
  39. }
  40. static void kone_profile_report(struct kone_device *kone, uint new_profile)
  41. {
  42. struct kone_roccat_report roccat_report;
  43. roccat_report.event = kone_mouse_event_switch_profile;
  44. roccat_report.value = new_profile;
  45. roccat_report.key = 0;
  46. roccat_report_event(kone->chrdev_minor, (uint8_t *)&roccat_report);
  47. }
  48. static int kone_receive(struct usb_device *usb_dev, uint usb_command,
  49. void *data, uint size)
  50. {
  51. char *buf;
  52. int len;
  53. buf = kmalloc(size, GFP_KERNEL);
  54. if (buf == NULL)
  55. return -ENOMEM;
  56. len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
  57. HID_REQ_GET_REPORT,
  58. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
  59. usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
  60. memcpy(data, buf, size);
  61. kfree(buf);
  62. return ((len < 0) ? len : ((len != size) ? -EIO : 0));
  63. }
  64. static int kone_send(struct usb_device *usb_dev, uint usb_command,
  65. void const *data, uint size)
  66. {
  67. char *buf;
  68. int len;
  69. buf = kmemdup(data, size, GFP_KERNEL);
  70. if (buf == NULL)
  71. return -ENOMEM;
  72. len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
  73. HID_REQ_SET_REPORT,
  74. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
  75. usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
  76. kfree(buf);
  77. return ((len < 0) ? len : ((len != size) ? -EIO : 0));
  78. }
  79. /* kone_class is used for creating sysfs attributes via roccat char device */
  80. static struct class *kone_class;
  81. static void kone_set_settings_checksum(struct kone_settings *settings)
  82. {
  83. uint16_t checksum = 0;
  84. unsigned char *address = (unsigned char *)settings;
  85. int i;
  86. for (i = 0; i < sizeof(struct kone_settings) - 2; ++i, ++address)
  87. checksum += *address;
  88. settings->checksum = cpu_to_le16(checksum);
  89. }
  90. /*
  91. * Checks success after writing data to mouse
  92. * On success returns 0
  93. * On failure returns errno
  94. */
  95. static int kone_check_write(struct usb_device *usb_dev)
  96. {
  97. int retval;
  98. uint8_t data;
  99. do {
  100. /*
  101. * Mouse needs 50 msecs until it says ok, but there are
  102. * 30 more msecs needed for next write to work.
  103. */
  104. msleep(80);
  105. retval = kone_receive(usb_dev,
  106. kone_command_confirm_write, &data, 1);
  107. if (retval)
  108. return retval;
  109. /*
  110. * value of 3 seems to mean something like
  111. * "not finished yet, but it looks good"
  112. * So check again after a moment.
  113. */
  114. } while (data == 3);
  115. if (data == 1) /* everything alright */
  116. return 0;
  117. /* unknown answer */
  118. hid_err(usb_dev, "got retval %d when checking write\n", data);
  119. return -EIO;
  120. }
  121. /*
  122. * Reads settings from mouse and stores it in @buf
  123. * On success returns 0
  124. * On failure returns errno
  125. */
  126. static int kone_get_settings(struct usb_device *usb_dev,
  127. struct kone_settings *buf)
  128. {
  129. return kone_receive(usb_dev, kone_command_settings, buf,
  130. sizeof(struct kone_settings));
  131. }
  132. /*
  133. * Writes settings from @buf to mouse
  134. * On success returns 0
  135. * On failure returns errno
  136. */
  137. static int kone_set_settings(struct usb_device *usb_dev,
  138. struct kone_settings const *settings)
  139. {
  140. int retval;
  141. retval = kone_send(usb_dev, kone_command_settings,
  142. settings, sizeof(struct kone_settings));
  143. if (retval)
  144. return retval;
  145. return kone_check_write(usb_dev);
  146. }
  147. /*
  148. * Reads profile data from mouse and stores it in @buf
  149. * @number: profile number to read
  150. * On success returns 0
  151. * On failure returns errno
  152. */
  153. static int kone_get_profile(struct usb_device *usb_dev,
  154. struct kone_profile *buf, int number)
  155. {
  156. int len;
  157. if (number < 1 || number > 5)
  158. return -EINVAL;
  159. len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
  160. USB_REQ_CLEAR_FEATURE,
  161. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
  162. kone_command_profile, number, buf,
  163. sizeof(struct kone_profile), USB_CTRL_SET_TIMEOUT);
  164. if (len != sizeof(struct kone_profile))
  165. return -EIO;
  166. return 0;
  167. }
  168. /*
  169. * Writes profile data to mouse.
  170. * @number: profile number to write
  171. * On success returns 0
  172. * On failure returns errno
  173. */
  174. static int kone_set_profile(struct usb_device *usb_dev,
  175. struct kone_profile const *profile, int number)
  176. {
  177. int len;
  178. if (number < 1 || number > 5)
  179. return -EINVAL;
  180. len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
  181. USB_REQ_SET_CONFIGURATION,
  182. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
  183. kone_command_profile, number, (void *)profile,
  184. sizeof(struct kone_profile),
  185. USB_CTRL_SET_TIMEOUT);
  186. if (len != sizeof(struct kone_profile))
  187. return len;
  188. if (kone_check_write(usb_dev))
  189. return -EIO;
  190. return 0;
  191. }
  192. /*
  193. * Reads value of "fast-clip-weight" and stores it in @result
  194. * On success returns 0
  195. * On failure returns errno
  196. */
  197. static int kone_get_weight(struct usb_device *usb_dev, int *result)
  198. {
  199. int retval;
  200. uint8_t data;
  201. retval = kone_receive(usb_dev, kone_command_weight, &data, 1);
  202. if (retval)
  203. return retval;
  204. *result = (int)data;
  205. return 0;
  206. }
  207. /*
  208. * Reads firmware_version of mouse and stores it in @result
  209. * On success returns 0
  210. * On failure returns errno
  211. */
  212. static int kone_get_firmware_version(struct usb_device *usb_dev, int *result)
  213. {
  214. int retval;
  215. uint16_t data;
  216. retval = kone_receive(usb_dev, kone_command_firmware_version,
  217. &data, 2);
  218. if (retval)
  219. return retval;
  220. *result = le16_to_cpu(data);
  221. return 0;
  222. }
  223. static ssize_t kone_sysfs_read_settings(struct file *fp, struct kobject *kobj,
  224. struct bin_attribute *attr, char *buf,
  225. loff_t off, size_t count) {
  226. struct device *dev =
  227. container_of(kobj, struct device, kobj)->parent->parent;
  228. struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
  229. if (off >= sizeof(struct kone_settings))
  230. return 0;
  231. if (off + count > sizeof(struct kone_settings))
  232. count = sizeof(struct kone_settings) - off;
  233. mutex_lock(&kone->kone_lock);
  234. memcpy(buf, ((char const *)&kone->settings) + off, count);
  235. mutex_unlock(&kone->kone_lock);
  236. return count;
  237. }
  238. /*
  239. * Writing settings automatically activates startup_profile.
  240. * This function keeps values in kone_device up to date and assumes that in
  241. * case of error the old data is still valid
  242. */
  243. static ssize_t kone_sysfs_write_settings(struct file *fp, struct kobject *kobj,
  244. struct bin_attribute *attr, char *buf,
  245. loff_t off, size_t count) {
  246. struct device *dev =
  247. container_of(kobj, struct device, kobj)->parent->parent;
  248. struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
  249. struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
  250. int retval = 0, difference, old_profile;
  251. /* I need to get my data in one piece */
  252. if (off != 0 || count != sizeof(struct kone_settings))
  253. return -EINVAL;
  254. mutex_lock(&kone->kone_lock);
  255. difference = memcmp(buf, &kone->settings, sizeof(struct kone_settings));
  256. if (difference) {
  257. retval = kone_set_settings(usb_dev,
  258. (struct kone_settings const *)buf);
  259. if (retval) {
  260. mutex_unlock(&kone->kone_lock);
  261. return retval;
  262. }
  263. old_profile = kone->settings.startup_profile;
  264. memcpy(&kone->settings, buf, sizeof(struct kone_settings));
  265. kone_profile_activated(kone, kone->settings.startup_profile);
  266. if (kone->settings.startup_profile != old_profile)
  267. kone_profile_report(kone, kone->settings.startup_profile);
  268. }
  269. mutex_unlock(&kone->kone_lock);
  270. return sizeof(struct kone_settings);
  271. }
  272. static ssize_t kone_sysfs_read_profilex(struct file *fp,
  273. struct kobject *kobj, struct bin_attribute *attr,
  274. char *buf, loff_t off, size_t count) {
  275. struct device *dev =
  276. container_of(kobj, struct device, kobj)->parent->parent;
  277. struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
  278. if (off >= sizeof(struct kone_profile))
  279. return 0;
  280. if (off + count > sizeof(struct kone_profile))
  281. count = sizeof(struct kone_profile) - off;
  282. mutex_lock(&kone->kone_lock);
  283. memcpy(buf, ((char const *)&kone->profiles[*(uint *)(attr->private)]) + off, count);
  284. mutex_unlock(&kone->kone_lock);
  285. return count;
  286. }
  287. /* Writes data only if different to stored data */
  288. static ssize_t kone_sysfs_write_profilex(struct file *fp,
  289. struct kobject *kobj, struct bin_attribute *attr,
  290. char *buf, loff_t off, size_t count) {
  291. struct device *dev =
  292. container_of(kobj, struct device, kobj)->parent->parent;
  293. struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
  294. struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
  295. struct kone_profile *profile;
  296. int retval = 0, difference;
  297. /* I need to get my data in one piece */
  298. if (off != 0 || count != sizeof(struct kone_profile))
  299. return -EINVAL;
  300. profile = &kone->profiles[*(uint *)(attr->private)];
  301. mutex_lock(&kone->kone_lock);
  302. difference = memcmp(buf, profile, sizeof(struct kone_profile));
  303. if (difference) {
  304. retval = kone_set_profile(usb_dev,
  305. (struct kone_profile const *)buf,
  306. *(uint *)(attr->private) + 1);
  307. if (!retval)
  308. memcpy(profile, buf, sizeof(struct kone_profile));
  309. }
  310. mutex_unlock(&kone->kone_lock);
  311. if (retval)
  312. return retval;
  313. return sizeof(struct kone_profile);
  314. }
  315. static ssize_t kone_sysfs_show_actual_profile(struct device *dev,
  316. struct device_attribute *attr, char *buf)
  317. {
  318. struct kone_device *kone =
  319. hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
  320. return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_profile);
  321. }
  322. static ssize_t kone_sysfs_show_actual_dpi(struct device *dev,
  323. struct device_attribute *attr, char *buf)
  324. {
  325. struct kone_device *kone =
  326. hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
  327. return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_dpi);
  328. }
  329. /* weight is read each time, since we don't get informed when it's changed */
  330. static ssize_t kone_sysfs_show_weight(struct device *dev,
  331. struct device_attribute *attr, char *buf)
  332. {
  333. struct kone_device *kone;
  334. struct usb_device *usb_dev;
  335. int weight = 0;
  336. int retval;
  337. dev = dev->parent->parent;
  338. kone = hid_get_drvdata(dev_get_drvdata(dev));
  339. usb_dev = interface_to_usbdev(to_usb_interface(dev));
  340. mutex_lock(&kone->kone_lock);
  341. retval = kone_get_weight(usb_dev, &weight);
  342. mutex_unlock(&kone->kone_lock);
  343. if (retval)
  344. return retval;
  345. return snprintf(buf, PAGE_SIZE, "%d\n", weight);
  346. }
  347. static ssize_t kone_sysfs_show_firmware_version(struct device *dev,
  348. struct device_attribute *attr, char *buf)
  349. {
  350. struct kone_device *kone =
  351. hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
  352. return snprintf(buf, PAGE_SIZE, "%d\n", kone->firmware_version);
  353. }
  354. static ssize_t kone_sysfs_show_tcu(struct device *dev,
  355. struct device_attribute *attr, char *buf)
  356. {
  357. struct kone_device *kone =
  358. hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
  359. return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.tcu);
  360. }
  361. static int kone_tcu_command(struct usb_device *usb_dev, int number)
  362. {
  363. unsigned char value;
  364. value = number;
  365. return kone_send(usb_dev, kone_command_calibrate, &value, 1);
  366. }
  367. /*
  368. * Calibrating the tcu is the only action that changes settings data inside the
  369. * mouse, so this data needs to be reread
  370. */
  371. static ssize_t kone_sysfs_set_tcu(struct device *dev,
  372. struct device_attribute *attr, char const *buf, size_t size)
  373. {
  374. struct kone_device *kone;
  375. struct usb_device *usb_dev;
  376. int retval;
  377. unsigned long state;
  378. dev = dev->parent->parent;
  379. kone = hid_get_drvdata(dev_get_drvdata(dev));
  380. usb_dev = interface_to_usbdev(to_usb_interface(dev));
  381. retval = strict_strtoul(buf, 10, &state);
  382. if (retval)
  383. return retval;
  384. if (state != 0 && state != 1)
  385. return -EINVAL;
  386. mutex_lock(&kone->kone_lock);
  387. if (state == 1) { /* state activate */
  388. retval = kone_tcu_command(usb_dev, 1);
  389. if (retval)
  390. goto exit_unlock;
  391. retval = kone_tcu_command(usb_dev, 2);
  392. if (retval)
  393. goto exit_unlock;
  394. ssleep(5); /* tcu needs this time for calibration */
  395. retval = kone_tcu_command(usb_dev, 3);
  396. if (retval)
  397. goto exit_unlock;
  398. retval = kone_tcu_command(usb_dev, 0);
  399. if (retval)
  400. goto exit_unlock;
  401. retval = kone_tcu_command(usb_dev, 4);
  402. if (retval)
  403. goto exit_unlock;
  404. /*
  405. * Kone needs this time to settle things.
  406. * Reading settings too early will result in invalid data.
  407. * Roccat's driver waits 1 sec, maybe this time could be
  408. * shortened.
  409. */
  410. ssleep(1);
  411. }
  412. /* calibration changes values in settings, so reread */
  413. retval = kone_get_settings(usb_dev, &kone->settings);
  414. if (retval)
  415. goto exit_no_settings;
  416. /* only write settings back if activation state is different */
  417. if (kone->settings.tcu != state) {
  418. kone->settings.tcu = state;
  419. kone_set_settings_checksum(&kone->settings);
  420. retval = kone_set_settings(usb_dev, &kone->settings);
  421. if (retval) {
  422. hid_err(usb_dev, "couldn't set tcu state\n");
  423. /*
  424. * try to reread valid settings into buffer overwriting
  425. * first error code
  426. */
  427. retval = kone_get_settings(usb_dev, &kone->settings);
  428. if (retval)
  429. goto exit_no_settings;
  430. goto exit_unlock;
  431. }
  432. /* calibration resets profile */
  433. kone_profile_activated(kone, kone->settings.startup_profile);
  434. }
  435. retval = size;
  436. exit_no_settings:
  437. hid_err(usb_dev, "couldn't read settings\n");
  438. exit_unlock:
  439. mutex_unlock(&kone->kone_lock);
  440. return retval;
  441. }
  442. static ssize_t kone_sysfs_show_startup_profile(struct device *dev,
  443. struct device_attribute *attr, char *buf)
  444. {
  445. struct kone_device *kone =
  446. hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
  447. return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.startup_profile);
  448. }
  449. static ssize_t kone_sysfs_set_startup_profile(struct device *dev,
  450. struct device_attribute *attr, char const *buf, size_t size)
  451. {
  452. struct kone_device *kone;
  453. struct usb_device *usb_dev;
  454. int retval;
  455. unsigned long new_startup_profile;
  456. dev = dev->parent->parent;
  457. kone = hid_get_drvdata(dev_get_drvdata(dev));
  458. usb_dev = interface_to_usbdev(to_usb_interface(dev));
  459. retval = strict_strtoul(buf, 10, &new_startup_profile);
  460. if (retval)
  461. return retval;
  462. if (new_startup_profile < 1 || new_startup_profile > 5)
  463. return -EINVAL;
  464. mutex_lock(&kone->kone_lock);
  465. kone->settings.startup_profile = new_startup_profile;
  466. kone_set_settings_checksum(&kone->settings);
  467. retval = kone_set_settings(usb_dev, &kone->settings);
  468. if (retval) {
  469. mutex_unlock(&kone->kone_lock);
  470. return retval;
  471. }
  472. /* changing the startup profile immediately activates this profile */
  473. kone_profile_activated(kone, new_startup_profile);
  474. kone_profile_report(kone, new_startup_profile);
  475. mutex_unlock(&kone->kone_lock);
  476. return size;
  477. }
  478. static struct device_attribute kone_attributes[] = {
  479. /*
  480. * Read actual dpi settings.
  481. * Returns raw value for further processing. Refer to enum
  482. * kone_polling_rates to get real value.
  483. */
  484. __ATTR(actual_dpi, 0440, kone_sysfs_show_actual_dpi, NULL),
  485. __ATTR(actual_profile, 0440, kone_sysfs_show_actual_profile, NULL),
  486. /*
  487. * The mouse can be equipped with one of four supplied weights from 5
  488. * to 20 grams which are recognized and its value can be read out.
  489. * This returns the raw value reported by the mouse for easy evaluation
  490. * by software. Refer to enum kone_weights to get corresponding real
  491. * weight.
  492. */
  493. __ATTR(weight, 0440, kone_sysfs_show_weight, NULL),
  494. /*
  495. * Prints firmware version stored in mouse as integer.
  496. * The raw value reported by the mouse is returned for easy evaluation,
  497. * to get the real version number the decimal point has to be shifted 2
  498. * positions to the left. E.g. a value of 138 means 1.38.
  499. */
  500. __ATTR(firmware_version, 0440,
  501. kone_sysfs_show_firmware_version, NULL),
  502. /*
  503. * Prints state of Tracking Control Unit as number where 0 = off and
  504. * 1 = on. Writing 0 deactivates tcu and writing 1 calibrates and
  505. * activates the tcu
  506. */
  507. __ATTR(tcu, 0660, kone_sysfs_show_tcu, kone_sysfs_set_tcu),
  508. /* Prints and takes the number of the profile the mouse starts with */
  509. __ATTR(startup_profile, 0660,
  510. kone_sysfs_show_startup_profile,
  511. kone_sysfs_set_startup_profile),
  512. __ATTR_NULL
  513. };
  514. static struct bin_attribute kone_bin_attributes[] = {
  515. {
  516. .attr = { .name = "settings", .mode = 0660 },
  517. .size = sizeof(struct kone_settings),
  518. .read = kone_sysfs_read_settings,
  519. .write = kone_sysfs_write_settings
  520. },
  521. {
  522. .attr = { .name = "profile1", .mode = 0660 },
  523. .size = sizeof(struct kone_profile),
  524. .read = kone_sysfs_read_profilex,
  525. .write = kone_sysfs_write_profilex,
  526. .private = &profile_numbers[0]
  527. },
  528. {
  529. .attr = { .name = "profile2", .mode = 0660 },
  530. .size = sizeof(struct kone_profile),
  531. .read = kone_sysfs_read_profilex,
  532. .write = kone_sysfs_write_profilex,
  533. .private = &profile_numbers[1]
  534. },
  535. {
  536. .attr = { .name = "profile3", .mode = 0660 },
  537. .size = sizeof(struct kone_profile),
  538. .read = kone_sysfs_read_profilex,
  539. .write = kone_sysfs_write_profilex,
  540. .private = &profile_numbers[2]
  541. },
  542. {
  543. .attr = { .name = "profile4", .mode = 0660 },
  544. .size = sizeof(struct kone_profile),
  545. .read = kone_sysfs_read_profilex,
  546. .write = kone_sysfs_write_profilex,
  547. .private = &profile_numbers[3]
  548. },
  549. {
  550. .attr = { .name = "profile5", .mode = 0660 },
  551. .size = sizeof(struct kone_profile),
  552. .read = kone_sysfs_read_profilex,
  553. .write = kone_sysfs_write_profilex,
  554. .private = &profile_numbers[4]
  555. },
  556. __ATTR_NULL
  557. };
  558. static int kone_init_kone_device_struct(struct usb_device *usb_dev,
  559. struct kone_device *kone)
  560. {
  561. uint i;
  562. int retval;
  563. mutex_init(&kone->kone_lock);
  564. for (i = 0; i < 5; ++i) {
  565. retval = kone_get_profile(usb_dev, &kone->profiles[i], i + 1);
  566. if (retval)
  567. return retval;
  568. }
  569. retval = kone_get_settings(usb_dev, &kone->settings);
  570. if (retval)
  571. return retval;
  572. retval = kone_get_firmware_version(usb_dev, &kone->firmware_version);
  573. if (retval)
  574. return retval;
  575. kone_profile_activated(kone, kone->settings.startup_profile);
  576. return 0;
  577. }
  578. /*
  579. * Since IGNORE_MOUSE quirk moved to hid-apple, there is no way to bind only to
  580. * mousepart if usb_hid is compiled into the kernel and kone is compiled as
  581. * module.
  582. * Secial behaviour is bound only to mousepart since only mouseevents contain
  583. * additional notifications.
  584. */
  585. static int kone_init_specials(struct hid_device *hdev)
  586. {
  587. struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
  588. struct usb_device *usb_dev = interface_to_usbdev(intf);
  589. struct kone_device *kone;
  590. int retval;
  591. if (intf->cur_altsetting->desc.bInterfaceProtocol
  592. == USB_INTERFACE_PROTOCOL_MOUSE) {
  593. kone = kzalloc(sizeof(*kone), GFP_KERNEL);
  594. if (!kone) {
  595. hid_err(hdev, "can't alloc device descriptor\n");
  596. return -ENOMEM;
  597. }
  598. hid_set_drvdata(hdev, kone);
  599. retval = kone_init_kone_device_struct(usb_dev, kone);
  600. if (retval) {
  601. hid_err(hdev, "couldn't init struct kone_device\n");
  602. goto exit_free;
  603. }
  604. retval = roccat_connect(kone_class, hdev,
  605. sizeof(struct kone_roccat_report));
  606. if (retval < 0) {
  607. hid_err(hdev, "couldn't init char dev\n");
  608. /* be tolerant about not getting chrdev */
  609. } else {
  610. kone->roccat_claimed = 1;
  611. kone->chrdev_minor = retval;
  612. }
  613. } else {
  614. hid_set_drvdata(hdev, NULL);
  615. }
  616. return 0;
  617. exit_free:
  618. kfree(kone);
  619. return retval;
  620. }
  621. static void kone_remove_specials(struct hid_device *hdev)
  622. {
  623. struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
  624. struct kone_device *kone;
  625. if (intf->cur_altsetting->desc.bInterfaceProtocol
  626. == USB_INTERFACE_PROTOCOL_MOUSE) {
  627. kone = hid_get_drvdata(hdev);
  628. if (kone->roccat_claimed)
  629. roccat_disconnect(kone->chrdev_minor);
  630. kfree(hid_get_drvdata(hdev));
  631. }
  632. }
  633. static int kone_probe(struct hid_device *hdev, const struct hid_device_id *id)
  634. {
  635. int retval;
  636. retval = hid_parse(hdev);
  637. if (retval) {
  638. hid_err(hdev, "parse failed\n");
  639. goto exit;
  640. }
  641. retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
  642. if (retval) {
  643. hid_err(hdev, "hw start failed\n");
  644. goto exit;
  645. }
  646. retval = kone_init_specials(hdev);
  647. if (retval) {
  648. hid_err(hdev, "couldn't install mouse\n");
  649. goto exit_stop;
  650. }
  651. return 0;
  652. exit_stop:
  653. hid_hw_stop(hdev);
  654. exit:
  655. return retval;
  656. }
  657. static void kone_remove(struct hid_device *hdev)
  658. {
  659. kone_remove_specials(hdev);
  660. hid_hw_stop(hdev);
  661. }
  662. /* handle special events and keep actual profile and dpi values up to date */
  663. static void kone_keep_values_up_to_date(struct kone_device *kone,
  664. struct kone_mouse_event const *event)
  665. {
  666. switch (event->event) {
  667. case kone_mouse_event_switch_profile:
  668. kone->actual_dpi = kone->profiles[event->value - 1].
  669. startup_dpi;
  670. case kone_mouse_event_osd_profile:
  671. kone->actual_profile = event->value;
  672. break;
  673. case kone_mouse_event_switch_dpi:
  674. case kone_mouse_event_osd_dpi:
  675. kone->actual_dpi = event->value;
  676. break;
  677. }
  678. }
  679. static void kone_report_to_chrdev(struct kone_device const *kone,
  680. struct kone_mouse_event const *event)
  681. {
  682. struct kone_roccat_report roccat_report;
  683. switch (event->event) {
  684. case kone_mouse_event_switch_profile:
  685. case kone_mouse_event_switch_dpi:
  686. case kone_mouse_event_osd_profile:
  687. case kone_mouse_event_osd_dpi:
  688. roccat_report.event = event->event;
  689. roccat_report.value = event->value;
  690. roccat_report.key = 0;
  691. roccat_report_event(kone->chrdev_minor,
  692. (uint8_t *)&roccat_report);
  693. break;
  694. case kone_mouse_event_call_overlong_macro:
  695. if (event->value == kone_keystroke_action_press) {
  696. roccat_report.event = kone_mouse_event_call_overlong_macro;
  697. roccat_report.value = kone->actual_profile;
  698. roccat_report.key = event->macro_key;
  699. roccat_report_event(kone->chrdev_minor,
  700. (uint8_t *)&roccat_report);
  701. }
  702. break;
  703. }
  704. }
  705. /*
  706. * Is called for keyboard- and mousepart.
  707. * Only mousepart gets informations about special events in its extended event
  708. * structure.
  709. */
  710. static int kone_raw_event(struct hid_device *hdev, struct hid_report *report,
  711. u8 *data, int size)
  712. {
  713. struct kone_device *kone = hid_get_drvdata(hdev);
  714. struct kone_mouse_event *event = (struct kone_mouse_event *)data;
  715. /* keyboard events are always processed by default handler */
  716. if (size != sizeof(struct kone_mouse_event))
  717. return 0;
  718. if (kone == NULL)
  719. return 0;
  720. /*
  721. * Firmware 1.38 introduced new behaviour for tilt and special buttons.
  722. * Pressed button is reported in each movement event.
  723. * Workaround sends only one event per press.
  724. */
  725. if (memcmp(&kone->last_mouse_event.tilt, &event->tilt, 5))
  726. memcpy(&kone->last_mouse_event, event,
  727. sizeof(struct kone_mouse_event));
  728. else
  729. memset(&event->tilt, 0, 5);
  730. kone_keep_values_up_to_date(kone, event);
  731. if (kone->roccat_claimed)
  732. kone_report_to_chrdev(kone, event);
  733. return 0; /* always do further processing */
  734. }
  735. static const struct hid_device_id kone_devices[] = {
  736. { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONE) },
  737. { }
  738. };
  739. MODULE_DEVICE_TABLE(hid, kone_devices);
  740. static struct hid_driver kone_driver = {
  741. .name = "kone",
  742. .id_table = kone_devices,
  743. .probe = kone_probe,
  744. .remove = kone_remove,
  745. .raw_event = kone_raw_event
  746. };
  747. static int __init kone_init(void)
  748. {
  749. int retval;
  750. /* class name has to be same as driver name */
  751. kone_class = class_create(THIS_MODULE, "kone");
  752. if (IS_ERR(kone_class))
  753. return PTR_ERR(kone_class);
  754. kone_class->dev_attrs = kone_attributes;
  755. kone_class->dev_bin_attrs = kone_bin_attributes;
  756. retval = hid_register_driver(&kone_driver);
  757. if (retval)
  758. class_destroy(kone_class);
  759. return retval;
  760. }
  761. static void __exit kone_exit(void)
  762. {
  763. hid_unregister_driver(&kone_driver);
  764. class_destroy(kone_class);
  765. }
  766. module_init(kone_init);
  767. module_exit(kone_exit);
  768. MODULE_AUTHOR("Stefan Achatz");
  769. MODULE_DESCRIPTION("USB Roccat Kone driver");
  770. MODULE_LICENSE("GPL v2");