hid-elan.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * HID Driver for ELAN Touchpad
  4. *
  5. * Currently only supports touchpad found on HP Pavilion X2 10
  6. *
  7. * Copyright (c) 2016 Alexandrov Stanislav <neko@nya.ai>
  8. */
  9. #include <linux/hid.h>
  10. #include <linux/input/mt.h>
  11. #include <linux/leds.h>
  12. #include <linux/module.h>
  13. #include <linux/usb.h>
  14. #include "hid-ids.h"
  15. #define ELAN_MT_I2C 0x5d
  16. #define ELAN_SINGLE_FINGER 0x81
  17. #define ELAN_MT_FIRST_FINGER 0x82
  18. #define ELAN_MT_SECOND_FINGER 0x83
  19. #define ELAN_INPUT_REPORT_SIZE 8
  20. #define ELAN_I2C_REPORT_SIZE 32
  21. #define ELAN_FINGER_DATA_LEN 5
  22. #define ELAN_MAX_FINGERS 5
  23. #define ELAN_MAX_PRESSURE 255
  24. #define ELAN_TP_USB_INTF 1
  25. #define ELAN_FEATURE_REPORT 0x0d
  26. #define ELAN_FEATURE_SIZE 5
  27. #define ELAN_PARAM_MAX_X 6
  28. #define ELAN_PARAM_MAX_Y 7
  29. #define ELAN_PARAM_RES 8
  30. #define ELAN_MUTE_LED_REPORT 0xBC
  31. #define ELAN_LED_REPORT_SIZE 8
  32. #define ELAN_HAS_LED BIT(0)
  33. struct elan_drvdata {
  34. struct input_dev *input;
  35. u8 prev_report[ELAN_INPUT_REPORT_SIZE];
  36. struct led_classdev mute_led;
  37. u8 mute_led_state;
  38. u16 max_x;
  39. u16 max_y;
  40. u16 res_x;
  41. u16 res_y;
  42. };
  43. static int is_not_elan_touchpad(struct hid_device *hdev)
  44. {
  45. if (hid_is_usb(hdev)) {
  46. struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
  47. return (intf->altsetting->desc.bInterfaceNumber !=
  48. ELAN_TP_USB_INTF);
  49. }
  50. return 0;
  51. }
  52. static int elan_input_mapping(struct hid_device *hdev, struct hid_input *hi,
  53. struct hid_field *field, struct hid_usage *usage,
  54. unsigned long **bit, int *max)
  55. {
  56. if (is_not_elan_touchpad(hdev))
  57. return 0;
  58. if (field->report->id == ELAN_SINGLE_FINGER ||
  59. field->report->id == ELAN_MT_FIRST_FINGER ||
  60. field->report->id == ELAN_MT_SECOND_FINGER ||
  61. field->report->id == ELAN_MT_I2C)
  62. return -1;
  63. return 0;
  64. }
  65. static int elan_get_device_param(struct hid_device *hdev,
  66. unsigned char *dmabuf, unsigned char param)
  67. {
  68. int ret;
  69. dmabuf[0] = ELAN_FEATURE_REPORT;
  70. dmabuf[1] = 0x05;
  71. dmabuf[2] = 0x03;
  72. dmabuf[3] = param;
  73. dmabuf[4] = 0x01;
  74. ret = hid_hw_raw_request(hdev, ELAN_FEATURE_REPORT, dmabuf,
  75. ELAN_FEATURE_SIZE, HID_FEATURE_REPORT,
  76. HID_REQ_SET_REPORT);
  77. if (ret != ELAN_FEATURE_SIZE) {
  78. hid_err(hdev, "Set report error for parm %d: %d\n", param, ret);
  79. return ret;
  80. }
  81. ret = hid_hw_raw_request(hdev, ELAN_FEATURE_REPORT, dmabuf,
  82. ELAN_FEATURE_SIZE, HID_FEATURE_REPORT,
  83. HID_REQ_GET_REPORT);
  84. if (ret != ELAN_FEATURE_SIZE) {
  85. hid_err(hdev, "Get report error for parm %d: %d\n", param, ret);
  86. return ret;
  87. }
  88. return 0;
  89. }
  90. static unsigned int elan_convert_res(char val)
  91. {
  92. /*
  93. * (value from firmware) * 10 + 790 = dpi
  94. * dpi * 10 / 254 = dots/mm
  95. */
  96. return (val * 10 + 790) * 10 / 254;
  97. }
  98. static int elan_get_device_params(struct hid_device *hdev)
  99. {
  100. struct elan_drvdata *drvdata = hid_get_drvdata(hdev);
  101. unsigned char *dmabuf;
  102. int ret;
  103. dmabuf = kmalloc(ELAN_FEATURE_SIZE, GFP_KERNEL);
  104. if (!dmabuf)
  105. return -ENOMEM;
  106. ret = elan_get_device_param(hdev, dmabuf, ELAN_PARAM_MAX_X);
  107. if (ret)
  108. goto err;
  109. drvdata->max_x = (dmabuf[4] << 8) | dmabuf[3];
  110. ret = elan_get_device_param(hdev, dmabuf, ELAN_PARAM_MAX_Y);
  111. if (ret)
  112. goto err;
  113. drvdata->max_y = (dmabuf[4] << 8) | dmabuf[3];
  114. ret = elan_get_device_param(hdev, dmabuf, ELAN_PARAM_RES);
  115. if (ret)
  116. goto err;
  117. drvdata->res_x = elan_convert_res(dmabuf[3]);
  118. drvdata->res_y = elan_convert_res(dmabuf[4]);
  119. err:
  120. kfree(dmabuf);
  121. return ret;
  122. }
  123. static int elan_input_configured(struct hid_device *hdev, struct hid_input *hi)
  124. {
  125. int ret;
  126. struct input_dev *input;
  127. struct elan_drvdata *drvdata = hid_get_drvdata(hdev);
  128. if (is_not_elan_touchpad(hdev))
  129. return 0;
  130. ret = elan_get_device_params(hdev);
  131. if (ret)
  132. return ret;
  133. input = devm_input_allocate_device(&hdev->dev);
  134. if (!input)
  135. return -ENOMEM;
  136. input->name = "Elan Touchpad";
  137. input->phys = hdev->phys;
  138. input->uniq = hdev->uniq;
  139. input->id.bustype = hdev->bus;
  140. input->id.vendor = hdev->vendor;
  141. input->id.product = hdev->product;
  142. input->id.version = hdev->version;
  143. input->dev.parent = &hdev->dev;
  144. input_set_abs_params(input, ABS_MT_POSITION_X, 0, drvdata->max_x,
  145. 0, 0);
  146. input_set_abs_params(input, ABS_MT_POSITION_Y, 0, drvdata->max_y,
  147. 0, 0);
  148. input_set_abs_params(input, ABS_MT_PRESSURE, 0, ELAN_MAX_PRESSURE,
  149. 0, 0);
  150. __set_bit(BTN_LEFT, input->keybit);
  151. __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
  152. ret = input_mt_init_slots(input, ELAN_MAX_FINGERS, INPUT_MT_POINTER);
  153. if (ret) {
  154. hid_err(hdev, "Failed to init elan MT slots: %d\n", ret);
  155. input_free_device(input);
  156. return ret;
  157. }
  158. input_abs_set_res(input, ABS_X, drvdata->res_x);
  159. input_abs_set_res(input, ABS_Y, drvdata->res_y);
  160. ret = input_register_device(input);
  161. if (ret) {
  162. hid_err(hdev, "Failed to register elan input device: %d\n",
  163. ret);
  164. input_mt_destroy_slots(input);
  165. input_free_device(input);
  166. return ret;
  167. }
  168. drvdata->input = input;
  169. return 0;
  170. }
  171. static void elan_report_mt_slot(struct elan_drvdata *drvdata, u8 *data,
  172. unsigned int slot_num)
  173. {
  174. struct input_dev *input = drvdata->input;
  175. int x, y, p;
  176. bool active = !!data;
  177. input_mt_slot(input, slot_num);
  178. input_mt_report_slot_state(input, MT_TOOL_FINGER, active);
  179. if (active) {
  180. x = ((data[0] & 0xF0) << 4) | data[1];
  181. y = drvdata->max_y -
  182. (((data[0] & 0x07) << 8) | data[2]);
  183. p = data[4];
  184. input_report_abs(input, ABS_MT_POSITION_X, x);
  185. input_report_abs(input, ABS_MT_POSITION_Y, y);
  186. input_report_abs(input, ABS_MT_PRESSURE, p);
  187. }
  188. }
  189. static void elan_usb_report_input(struct elan_drvdata *drvdata, u8 *data)
  190. {
  191. int i;
  192. struct input_dev *input = drvdata->input;
  193. /*
  194. * There is 3 types of reports: for single touch,
  195. * for multitouch - first finger and for multitouch - second finger
  196. *
  197. * packet structure for ELAN_SINGLE_FINGER and ELAN_MT_FIRST_FINGER:
  198. *
  199. * byte 1: 1 0 0 0 0 0 0 1 // 0x81 or 0x82
  200. * byte 2: 0 0 0 0 0 0 0 0 // looks like unused
  201. * byte 3: f5 f4 f3 f2 f1 0 0 L
  202. * byte 4: x12 x11 x10 x9 0? y11 y10 y9
  203. * byte 5: x8 x7 x6 x5 x4 x3 x2 x1
  204. * byte 6: y8 y7 y6 y5 y4 y3 y2 y1
  205. * byte 7: sy4 sy3 sy2 sy1 sx4 sx3 sx2 sx1
  206. * byte 8: p8 p7 p6 p5 p4 p3 p2 p1
  207. *
  208. * packet structure for ELAN_MT_SECOND_FINGER:
  209. *
  210. * byte 1: 1 0 0 0 0 0 1 1 // 0x83
  211. * byte 2: x12 x11 x10 x9 0 y11 y10 y9
  212. * byte 3: x8 x7 x6 x5 x4 x3 x2 x1
  213. * byte 4: y8 y7 y6 y5 y4 y3 y2 y1
  214. * byte 5: sy4 sy3 sy2 sy1 sx4 sx3 sx2 sx1
  215. * byte 6: p8 p7 p6 p5 p4 p3 p2 p1
  216. * byte 7: 0 0 0 0 0 0 0 0
  217. * byte 8: 0 0 0 0 0 0 0 0
  218. *
  219. * f5-f1: finger touch bits
  220. * L: clickpad button
  221. * sy / sx: finger width / height expressed in traces, the total number
  222. * of traces can be queried by doing a HID_REQ_SET_REPORT
  223. * { 0x0d, 0x05, 0x03, 0x05, 0x01 } followed by a GET, in the
  224. * returned buf, buf[3]=no-x-traces, buf[4]=no-y-traces.
  225. * p: pressure
  226. */
  227. if (data[0] == ELAN_SINGLE_FINGER) {
  228. for (i = 0; i < ELAN_MAX_FINGERS; i++) {
  229. if (data[2] & BIT(i + 3))
  230. elan_report_mt_slot(drvdata, data + 3, i);
  231. else
  232. elan_report_mt_slot(drvdata, NULL, i);
  233. }
  234. input_report_key(input, BTN_LEFT, data[2] & 0x01);
  235. }
  236. /*
  237. * When touched with two fingers Elan touchpad will emit two HID reports
  238. * first is ELAN_MT_FIRST_FINGER and second is ELAN_MT_SECOND_FINGER
  239. * we will save ELAN_MT_FIRST_FINGER report and wait for
  240. * ELAN_MT_SECOND_FINGER to finish multitouch
  241. */
  242. if (data[0] == ELAN_MT_FIRST_FINGER) {
  243. memcpy(drvdata->prev_report, data,
  244. sizeof(drvdata->prev_report));
  245. return;
  246. }
  247. if (data[0] == ELAN_MT_SECOND_FINGER) {
  248. int first = 0;
  249. u8 *prev_report = drvdata->prev_report;
  250. if (prev_report[0] != ELAN_MT_FIRST_FINGER)
  251. return;
  252. for (i = 0; i < ELAN_MAX_FINGERS; i++) {
  253. if (prev_report[2] & BIT(i + 3)) {
  254. if (!first) {
  255. first = 1;
  256. elan_report_mt_slot(drvdata, prev_report + 3, i);
  257. } else {
  258. elan_report_mt_slot(drvdata, data + 1, i);
  259. }
  260. } else {
  261. elan_report_mt_slot(drvdata, NULL, i);
  262. }
  263. }
  264. input_report_key(input, BTN_LEFT, prev_report[2] & 0x01);
  265. }
  266. input_mt_sync_frame(input);
  267. input_sync(input);
  268. }
  269. static void elan_i2c_report_input(struct elan_drvdata *drvdata, u8 *data)
  270. {
  271. struct input_dev *input = drvdata->input;
  272. u8 *finger_data;
  273. int i;
  274. /*
  275. * Elan MT touchpads in i2c mode send finger data in the same format
  276. * as in USB mode, but then with all fingers in a single packet.
  277. *
  278. * packet structure for ELAN_MT_I2C:
  279. *
  280. * byte 1: 1 0 0 1 1 1 0 1 // 0x5d
  281. * byte 2: f5 f4 f3 f2 f1 0 0 L
  282. * byte 3: x12 x11 x10 x9 0? y11 y10 y9
  283. * byte 4: x8 x7 x6 x5 x4 x3 x2 x1
  284. * byte 5: y8 y7 y6 y5 y4 y3 y2 y1
  285. * byte 6: sy4 sy3 sy2 sy1 sx4 sx3 sx2 sx1
  286. * byte 7: p8 p7 p6 p5 p4 p3 p2 p1
  287. * byte 8-12: Same as byte 3-7 for second finger down
  288. * byte 13-17: Same as byte 3-7 for third finger down
  289. * byte 18-22: Same as byte 3-7 for fourth finger down
  290. * byte 23-27: Same as byte 3-7 for fifth finger down
  291. */
  292. finger_data = data + 2;
  293. for (i = 0; i < ELAN_MAX_FINGERS; i++) {
  294. if (data[1] & BIT(i + 3)) {
  295. elan_report_mt_slot(drvdata, finger_data, i);
  296. finger_data += ELAN_FINGER_DATA_LEN;
  297. } else {
  298. elan_report_mt_slot(drvdata, NULL, i);
  299. }
  300. }
  301. input_report_key(input, BTN_LEFT, data[1] & 0x01);
  302. input_mt_sync_frame(input);
  303. input_sync(input);
  304. }
  305. static int elan_raw_event(struct hid_device *hdev,
  306. struct hid_report *report, u8 *data, int size)
  307. {
  308. struct elan_drvdata *drvdata = hid_get_drvdata(hdev);
  309. if (is_not_elan_touchpad(hdev))
  310. return 0;
  311. if (data[0] == ELAN_SINGLE_FINGER ||
  312. data[0] == ELAN_MT_FIRST_FINGER ||
  313. data[0] == ELAN_MT_SECOND_FINGER) {
  314. if (size == ELAN_INPUT_REPORT_SIZE) {
  315. elan_usb_report_input(drvdata, data);
  316. return 1;
  317. }
  318. }
  319. if (data[0] == ELAN_MT_I2C && size == ELAN_I2C_REPORT_SIZE) {
  320. elan_i2c_report_input(drvdata, data);
  321. return 1;
  322. }
  323. return 0;
  324. }
  325. static int elan_start_multitouch(struct hid_device *hdev)
  326. {
  327. int ret;
  328. /*
  329. * This byte sequence will enable multitouch mode and disable
  330. * mouse emulation
  331. */
  332. static const unsigned char buf[] = { 0x0D, 0x00, 0x03, 0x21, 0x00 };
  333. unsigned char *dmabuf = kmemdup(buf, sizeof(buf), GFP_KERNEL);
  334. if (!dmabuf)
  335. return -ENOMEM;
  336. ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, sizeof(buf),
  337. HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
  338. kfree(dmabuf);
  339. if (ret != sizeof(buf)) {
  340. hid_err(hdev, "Failed to start multitouch: %d\n", ret);
  341. return ret;
  342. }
  343. return 0;
  344. }
  345. static enum led_brightness elan_mute_led_get_brigtness(struct led_classdev *led_cdev)
  346. {
  347. struct device *dev = led_cdev->dev->parent;
  348. struct hid_device *hdev = to_hid_device(dev);
  349. struct elan_drvdata *drvdata = hid_get_drvdata(hdev);
  350. return drvdata->mute_led_state;
  351. }
  352. static int elan_mute_led_set_brigtness(struct led_classdev *led_cdev,
  353. enum led_brightness value)
  354. {
  355. int ret;
  356. u8 led_state;
  357. struct device *dev = led_cdev->dev->parent;
  358. struct hid_device *hdev = to_hid_device(dev);
  359. struct elan_drvdata *drvdata = hid_get_drvdata(hdev);
  360. unsigned char *dmabuf = kzalloc(ELAN_LED_REPORT_SIZE, GFP_KERNEL);
  361. if (!dmabuf)
  362. return -ENOMEM;
  363. led_state = !!value;
  364. dmabuf[0] = ELAN_MUTE_LED_REPORT;
  365. dmabuf[1] = 0x02;
  366. dmabuf[2] = led_state;
  367. ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, ELAN_LED_REPORT_SIZE,
  368. HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
  369. kfree(dmabuf);
  370. if (ret != ELAN_LED_REPORT_SIZE) {
  371. hid_err(hdev, "Failed to set mute led brightness: %d\n", ret);
  372. return ret;
  373. }
  374. drvdata->mute_led_state = led_state;
  375. return 0;
  376. }
  377. static int elan_init_mute_led(struct hid_device *hdev)
  378. {
  379. struct elan_drvdata *drvdata = hid_get_drvdata(hdev);
  380. struct led_classdev *mute_led = &drvdata->mute_led;
  381. mute_led->name = "elan:red:mute";
  382. mute_led->brightness_get = elan_mute_led_get_brigtness;
  383. mute_led->brightness_set_blocking = elan_mute_led_set_brigtness;
  384. mute_led->max_brightness = LED_ON;
  385. mute_led->dev = &hdev->dev;
  386. return devm_led_classdev_register(&hdev->dev, mute_led);
  387. }
  388. static int elan_probe(struct hid_device *hdev, const struct hid_device_id *id)
  389. {
  390. int ret;
  391. struct elan_drvdata *drvdata;
  392. drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
  393. if (!drvdata)
  394. return -ENOMEM;
  395. hid_set_drvdata(hdev, drvdata);
  396. ret = hid_parse(hdev);
  397. if (ret) {
  398. hid_err(hdev, "Hid Parse failed\n");
  399. return ret;
  400. }
  401. ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
  402. if (ret) {
  403. hid_err(hdev, "Hid hw start failed\n");
  404. return ret;
  405. }
  406. if (is_not_elan_touchpad(hdev))
  407. return 0;
  408. if (!drvdata->input) {
  409. hid_err(hdev, "Input device is not registered\n");
  410. ret = -ENAVAIL;
  411. goto err;
  412. }
  413. ret = elan_start_multitouch(hdev);
  414. if (ret)
  415. goto err;
  416. if (id->driver_data & ELAN_HAS_LED) {
  417. ret = elan_init_mute_led(hdev);
  418. if (ret)
  419. goto err;
  420. }
  421. return 0;
  422. err:
  423. hid_hw_stop(hdev);
  424. return ret;
  425. }
  426. static void elan_remove(struct hid_device *hdev)
  427. {
  428. hid_hw_stop(hdev);
  429. }
  430. static const struct hid_device_id elan_devices[] = {
  431. { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_HP_X2),
  432. .driver_data = ELAN_HAS_LED },
  433. { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_HP_X2_10_COVER),
  434. .driver_data = ELAN_HAS_LED },
  435. { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_TOSHIBA_CLICK_L9W) },
  436. { }
  437. };
  438. MODULE_DEVICE_TABLE(hid, elan_devices);
  439. static struct hid_driver elan_driver = {
  440. .name = "elan",
  441. .id_table = elan_devices,
  442. .input_mapping = elan_input_mapping,
  443. .input_configured = elan_input_configured,
  444. .raw_event = elan_raw_event,
  445. .probe = elan_probe,
  446. .remove = elan_remove,
  447. };
  448. module_hid_driver(elan_driver);
  449. MODULE_LICENSE("GPL");
  450. MODULE_AUTHOR("Alexandrov Stanislav");
  451. MODULE_DESCRIPTION("Driver for HID ELAN Touchpads");