hid-roccat-kone.c 23 KB

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