synaptics_usb.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * USB Synaptics device driver
  4. *
  5. * Copyright (c) 2002 Rob Miller (rob@inpharmatica . co . uk)
  6. * Copyright (c) 2003 Ron Lee (ron@debian.org)
  7. * cPad driver for kernel 2.4
  8. *
  9. * Copyright (c) 2004 Jan Steinhoff (cpad@jan-steinhoff . de)
  10. * Copyright (c) 2004 Ron Lee (ron@debian.org)
  11. * rewritten for kernel 2.6
  12. *
  13. * cPad display character device part is not included. It can be found at
  14. * http://jan-steinhoff.de/linux/synaptics-usb.html
  15. *
  16. * Bases on: usb_skeleton.c v2.2 by Greg Kroah-Hartman
  17. * drivers/hid/usbhid/usbmouse.c by Vojtech Pavlik
  18. * drivers/input/mouse/synaptics.c by Peter Osterlund
  19. *
  20. * Trademarks are the property of their respective owners.
  21. */
  22. /*
  23. * There are three different types of Synaptics USB devices: Touchpads,
  24. * touchsticks (or trackpoints), and touchscreens. Touchpads are well supported
  25. * by this driver, touchstick support has not been tested much yet, and
  26. * touchscreens have not been tested at all.
  27. *
  28. * Up to three alternate settings are possible:
  29. * setting 0: one int endpoint for relative movement (used by usbhid.ko)
  30. * setting 1: one int endpoint for absolute finger position
  31. * setting 2 (cPad only): one int endpoint for absolute finger position and
  32. * two bulk endpoints for the display (in/out)
  33. * This driver uses setting 1.
  34. */
  35. #include <linux/kernel.h>
  36. #include <linux/slab.h>
  37. #include <linux/module.h>
  38. #include <linux/moduleparam.h>
  39. #include <linux/usb.h>
  40. #include <linux/input.h>
  41. #include <linux/usb/input.h>
  42. #define USB_VENDOR_ID_SYNAPTICS 0x06cb
  43. #define USB_DEVICE_ID_SYNAPTICS_TP 0x0001 /* Synaptics USB TouchPad */
  44. #define USB_DEVICE_ID_SYNAPTICS_INT_TP 0x0002 /* Integrated USB TouchPad */
  45. #define USB_DEVICE_ID_SYNAPTICS_CPAD 0x0003 /* Synaptics cPad */
  46. #define USB_DEVICE_ID_SYNAPTICS_TS 0x0006 /* Synaptics TouchScreen */
  47. #define USB_DEVICE_ID_SYNAPTICS_STICK 0x0007 /* Synaptics USB Styk */
  48. #define USB_DEVICE_ID_SYNAPTICS_WP 0x0008 /* Synaptics USB WheelPad */
  49. #define USB_DEVICE_ID_SYNAPTICS_COMP_TP 0x0009 /* Composite USB TouchPad */
  50. #define USB_DEVICE_ID_SYNAPTICS_WTP 0x0010 /* Wireless TouchPad */
  51. #define USB_DEVICE_ID_SYNAPTICS_DPAD 0x0013 /* DisplayPad */
  52. #define SYNUSB_TOUCHPAD (1 << 0)
  53. #define SYNUSB_STICK (1 << 1)
  54. #define SYNUSB_TOUCHSCREEN (1 << 2)
  55. #define SYNUSB_AUXDISPLAY (1 << 3) /* For cPad */
  56. #define SYNUSB_COMBO (1 << 4) /* Composite device (TP + stick) */
  57. #define SYNUSB_IO_ALWAYS (1 << 5)
  58. #define USB_DEVICE_SYNAPTICS(prod, kind) \
  59. USB_DEVICE(USB_VENDOR_ID_SYNAPTICS, \
  60. USB_DEVICE_ID_SYNAPTICS_##prod), \
  61. .driver_info = (kind),
  62. #define SYNUSB_RECV_SIZE 8
  63. #define XMIN_NOMINAL 1472
  64. #define XMAX_NOMINAL 5472
  65. #define YMIN_NOMINAL 1408
  66. #define YMAX_NOMINAL 4448
  67. struct synusb {
  68. struct usb_device *udev;
  69. struct usb_interface *intf;
  70. struct urb *urb;
  71. unsigned char *data;
  72. /* serialize access to open/suspend */
  73. struct mutex pm_mutex;
  74. bool is_open;
  75. /* input device related data structures */
  76. struct input_dev *input;
  77. char name[128];
  78. char phys[64];
  79. /* characteristics of the device */
  80. unsigned long flags;
  81. };
  82. static void synusb_report_buttons(struct synusb *synusb)
  83. {
  84. struct input_dev *input_dev = synusb->input;
  85. input_report_key(input_dev, BTN_LEFT, synusb->data[1] & 0x04);
  86. input_report_key(input_dev, BTN_RIGHT, synusb->data[1] & 0x01);
  87. input_report_key(input_dev, BTN_MIDDLE, synusb->data[1] & 0x02);
  88. }
  89. static void synusb_report_stick(struct synusb *synusb)
  90. {
  91. struct input_dev *input_dev = synusb->input;
  92. int x, y;
  93. unsigned int pressure;
  94. pressure = synusb->data[6];
  95. x = (s16)(be16_to_cpup((__be16 *)&synusb->data[2]) << 3) >> 7;
  96. y = (s16)(be16_to_cpup((__be16 *)&synusb->data[4]) << 3) >> 7;
  97. if (pressure > 0) {
  98. input_report_rel(input_dev, REL_X, x);
  99. input_report_rel(input_dev, REL_Y, -y);
  100. }
  101. input_report_abs(input_dev, ABS_PRESSURE, pressure);
  102. synusb_report_buttons(synusb);
  103. input_sync(input_dev);
  104. }
  105. static void synusb_report_touchpad(struct synusb *synusb)
  106. {
  107. struct input_dev *input_dev = synusb->input;
  108. unsigned int num_fingers, tool_width;
  109. unsigned int x, y;
  110. unsigned int pressure, w;
  111. pressure = synusb->data[6];
  112. x = be16_to_cpup((__be16 *)&synusb->data[2]);
  113. y = be16_to_cpup((__be16 *)&synusb->data[4]);
  114. w = synusb->data[0] & 0x0f;
  115. if (pressure > 0) {
  116. num_fingers = 1;
  117. tool_width = 5;
  118. switch (w) {
  119. case 0 ... 1:
  120. num_fingers = 2 + w;
  121. break;
  122. case 2: /* pen, pretend its a finger */
  123. break;
  124. case 4 ... 15:
  125. tool_width = w;
  126. break;
  127. }
  128. } else {
  129. num_fingers = 0;
  130. tool_width = 0;
  131. }
  132. /*
  133. * Post events
  134. * BTN_TOUCH has to be first as mousedev relies on it when doing
  135. * absolute -> relative conversion
  136. */
  137. if (pressure > 30)
  138. input_report_key(input_dev, BTN_TOUCH, 1);
  139. if (pressure < 25)
  140. input_report_key(input_dev, BTN_TOUCH, 0);
  141. if (num_fingers > 0) {
  142. input_report_abs(input_dev, ABS_X, x);
  143. input_report_abs(input_dev, ABS_Y,
  144. YMAX_NOMINAL + YMIN_NOMINAL - y);
  145. }
  146. input_report_abs(input_dev, ABS_PRESSURE, pressure);
  147. input_report_abs(input_dev, ABS_TOOL_WIDTH, tool_width);
  148. input_report_key(input_dev, BTN_TOOL_FINGER, num_fingers == 1);
  149. input_report_key(input_dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
  150. input_report_key(input_dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
  151. synusb_report_buttons(synusb);
  152. if (synusb->flags & SYNUSB_AUXDISPLAY)
  153. input_report_key(input_dev, BTN_MIDDLE, synusb->data[1] & 0x08);
  154. input_sync(input_dev);
  155. }
  156. static void synusb_irq(struct urb *urb)
  157. {
  158. struct synusb *synusb = urb->context;
  159. int error;
  160. /* Check our status in case we need to bail out early. */
  161. switch (urb->status) {
  162. case 0:
  163. usb_mark_last_busy(synusb->udev);
  164. break;
  165. /* Device went away so don't keep trying to read from it. */
  166. case -ECONNRESET:
  167. case -ENOENT:
  168. case -ESHUTDOWN:
  169. return;
  170. default:
  171. goto resubmit;
  172. break;
  173. }
  174. if (synusb->flags & SYNUSB_STICK)
  175. synusb_report_stick(synusb);
  176. else
  177. synusb_report_touchpad(synusb);
  178. resubmit:
  179. error = usb_submit_urb(urb, GFP_ATOMIC);
  180. if (error && error != -EPERM)
  181. dev_err(&synusb->intf->dev,
  182. "%s - usb_submit_urb failed with result: %d",
  183. __func__, error);
  184. }
  185. static struct usb_endpoint_descriptor *
  186. synusb_get_in_endpoint(struct usb_host_interface *iface)
  187. {
  188. struct usb_endpoint_descriptor *endpoint;
  189. int i;
  190. for (i = 0; i < iface->desc.bNumEndpoints; ++i) {
  191. endpoint = &iface->endpoint[i].desc;
  192. if (usb_endpoint_is_int_in(endpoint)) {
  193. /* we found our interrupt in endpoint */
  194. return endpoint;
  195. }
  196. }
  197. return NULL;
  198. }
  199. static int synusb_open(struct input_dev *dev)
  200. {
  201. struct synusb *synusb = input_get_drvdata(dev);
  202. int retval;
  203. retval = usb_autopm_get_interface(synusb->intf);
  204. if (retval) {
  205. dev_err(&synusb->intf->dev,
  206. "%s - usb_autopm_get_interface failed, error: %d\n",
  207. __func__, retval);
  208. return retval;
  209. }
  210. mutex_lock(&synusb->pm_mutex);
  211. retval = usb_submit_urb(synusb->urb, GFP_KERNEL);
  212. if (retval) {
  213. dev_err(&synusb->intf->dev,
  214. "%s - usb_submit_urb failed, error: %d\n",
  215. __func__, retval);
  216. retval = -EIO;
  217. goto out;
  218. }
  219. synusb->intf->needs_remote_wakeup = 1;
  220. synusb->is_open = true;
  221. out:
  222. mutex_unlock(&synusb->pm_mutex);
  223. usb_autopm_put_interface(synusb->intf);
  224. return retval;
  225. }
  226. static void synusb_close(struct input_dev *dev)
  227. {
  228. struct synusb *synusb = input_get_drvdata(dev);
  229. int autopm_error;
  230. autopm_error = usb_autopm_get_interface(synusb->intf);
  231. mutex_lock(&synusb->pm_mutex);
  232. usb_kill_urb(synusb->urb);
  233. synusb->intf->needs_remote_wakeup = 0;
  234. synusb->is_open = false;
  235. mutex_unlock(&synusb->pm_mutex);
  236. if (!autopm_error)
  237. usb_autopm_put_interface(synusb->intf);
  238. }
  239. static int synusb_probe(struct usb_interface *intf,
  240. const struct usb_device_id *id)
  241. {
  242. struct usb_device *udev = interface_to_usbdev(intf);
  243. struct usb_endpoint_descriptor *ep;
  244. struct synusb *synusb;
  245. struct input_dev *input_dev;
  246. unsigned int intf_num = intf->cur_altsetting->desc.bInterfaceNumber;
  247. unsigned int altsetting = min(intf->num_altsetting, 1U);
  248. int error;
  249. error = usb_set_interface(udev, intf_num, altsetting);
  250. if (error) {
  251. dev_err(&udev->dev,
  252. "Can not set alternate setting to %i, error: %i",
  253. altsetting, error);
  254. return error;
  255. }
  256. ep = synusb_get_in_endpoint(intf->cur_altsetting);
  257. if (!ep)
  258. return -ENODEV;
  259. synusb = kzalloc(sizeof(*synusb), GFP_KERNEL);
  260. input_dev = input_allocate_device();
  261. if (!synusb || !input_dev) {
  262. error = -ENOMEM;
  263. goto err_free_mem;
  264. }
  265. synusb->udev = udev;
  266. synusb->intf = intf;
  267. synusb->input = input_dev;
  268. mutex_init(&synusb->pm_mutex);
  269. synusb->flags = id->driver_info;
  270. if (synusb->flags & SYNUSB_COMBO) {
  271. /*
  272. * This is a combo device, we need to set proper
  273. * capability, depending on the interface.
  274. */
  275. synusb->flags |= intf_num == 1 ?
  276. SYNUSB_STICK : SYNUSB_TOUCHPAD;
  277. }
  278. synusb->urb = usb_alloc_urb(0, GFP_KERNEL);
  279. if (!synusb->urb) {
  280. error = -ENOMEM;
  281. goto err_free_mem;
  282. }
  283. synusb->data = usb_alloc_coherent(udev, SYNUSB_RECV_SIZE, GFP_KERNEL,
  284. &synusb->urb->transfer_dma);
  285. if (!synusb->data) {
  286. error = -ENOMEM;
  287. goto err_free_urb;
  288. }
  289. usb_fill_int_urb(synusb->urb, udev,
  290. usb_rcvintpipe(udev, ep->bEndpointAddress),
  291. synusb->data, SYNUSB_RECV_SIZE,
  292. synusb_irq, synusb,
  293. ep->bInterval);
  294. synusb->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  295. if (udev->manufacturer)
  296. strlcpy(synusb->name, udev->manufacturer,
  297. sizeof(synusb->name));
  298. if (udev->product) {
  299. if (udev->manufacturer)
  300. strlcat(synusb->name, " ", sizeof(synusb->name));
  301. strlcat(synusb->name, udev->product, sizeof(synusb->name));
  302. }
  303. if (!strlen(synusb->name))
  304. snprintf(synusb->name, sizeof(synusb->name),
  305. "USB Synaptics Device %04x:%04x",
  306. le16_to_cpu(udev->descriptor.idVendor),
  307. le16_to_cpu(udev->descriptor.idProduct));
  308. if (synusb->flags & SYNUSB_STICK)
  309. strlcat(synusb->name, " (Stick)", sizeof(synusb->name));
  310. usb_make_path(udev, synusb->phys, sizeof(synusb->phys));
  311. strlcat(synusb->phys, "/input0", sizeof(synusb->phys));
  312. input_dev->name = synusb->name;
  313. input_dev->phys = synusb->phys;
  314. usb_to_input_id(udev, &input_dev->id);
  315. input_dev->dev.parent = &synusb->intf->dev;
  316. if (!(synusb->flags & SYNUSB_IO_ALWAYS)) {
  317. input_dev->open = synusb_open;
  318. input_dev->close = synusb_close;
  319. }
  320. input_set_drvdata(input_dev, synusb);
  321. __set_bit(EV_ABS, input_dev->evbit);
  322. __set_bit(EV_KEY, input_dev->evbit);
  323. if (synusb->flags & SYNUSB_STICK) {
  324. __set_bit(EV_REL, input_dev->evbit);
  325. __set_bit(REL_X, input_dev->relbit);
  326. __set_bit(REL_Y, input_dev->relbit);
  327. __set_bit(INPUT_PROP_POINTING_STICK, input_dev->propbit);
  328. input_set_abs_params(input_dev, ABS_PRESSURE, 0, 127, 0, 0);
  329. } else {
  330. input_set_abs_params(input_dev, ABS_X,
  331. XMIN_NOMINAL, XMAX_NOMINAL, 0, 0);
  332. input_set_abs_params(input_dev, ABS_Y,
  333. YMIN_NOMINAL, YMAX_NOMINAL, 0, 0);
  334. input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
  335. input_set_abs_params(input_dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
  336. __set_bit(BTN_TOUCH, input_dev->keybit);
  337. __set_bit(BTN_TOOL_FINGER, input_dev->keybit);
  338. __set_bit(BTN_TOOL_DOUBLETAP, input_dev->keybit);
  339. __set_bit(BTN_TOOL_TRIPLETAP, input_dev->keybit);
  340. }
  341. if (synusb->flags & SYNUSB_TOUCHSCREEN)
  342. __set_bit(INPUT_PROP_DIRECT, input_dev->propbit);
  343. else
  344. __set_bit(INPUT_PROP_POINTER, input_dev->propbit);
  345. __set_bit(BTN_LEFT, input_dev->keybit);
  346. __set_bit(BTN_RIGHT, input_dev->keybit);
  347. __set_bit(BTN_MIDDLE, input_dev->keybit);
  348. usb_set_intfdata(intf, synusb);
  349. if (synusb->flags & SYNUSB_IO_ALWAYS) {
  350. error = synusb_open(input_dev);
  351. if (error)
  352. goto err_free_dma;
  353. }
  354. error = input_register_device(input_dev);
  355. if (error) {
  356. dev_err(&udev->dev,
  357. "Failed to register input device, error %d\n",
  358. error);
  359. goto err_stop_io;
  360. }
  361. return 0;
  362. err_stop_io:
  363. if (synusb->flags & SYNUSB_IO_ALWAYS)
  364. synusb_close(synusb->input);
  365. err_free_dma:
  366. usb_free_coherent(udev, SYNUSB_RECV_SIZE, synusb->data,
  367. synusb->urb->transfer_dma);
  368. err_free_urb:
  369. usb_free_urb(synusb->urb);
  370. err_free_mem:
  371. input_free_device(input_dev);
  372. kfree(synusb);
  373. usb_set_intfdata(intf, NULL);
  374. return error;
  375. }
  376. static void synusb_disconnect(struct usb_interface *intf)
  377. {
  378. struct synusb *synusb = usb_get_intfdata(intf);
  379. struct usb_device *udev = interface_to_usbdev(intf);
  380. if (synusb->flags & SYNUSB_IO_ALWAYS)
  381. synusb_close(synusb->input);
  382. input_unregister_device(synusb->input);
  383. usb_free_coherent(udev, SYNUSB_RECV_SIZE, synusb->data,
  384. synusb->urb->transfer_dma);
  385. usb_free_urb(synusb->urb);
  386. kfree(synusb);
  387. usb_set_intfdata(intf, NULL);
  388. }
  389. static int synusb_suspend(struct usb_interface *intf, pm_message_t message)
  390. {
  391. struct synusb *synusb = usb_get_intfdata(intf);
  392. mutex_lock(&synusb->pm_mutex);
  393. usb_kill_urb(synusb->urb);
  394. mutex_unlock(&synusb->pm_mutex);
  395. return 0;
  396. }
  397. static int synusb_resume(struct usb_interface *intf)
  398. {
  399. struct synusb *synusb = usb_get_intfdata(intf);
  400. int retval = 0;
  401. mutex_lock(&synusb->pm_mutex);
  402. if ((synusb->is_open || (synusb->flags & SYNUSB_IO_ALWAYS)) &&
  403. usb_submit_urb(synusb->urb, GFP_NOIO) < 0) {
  404. retval = -EIO;
  405. }
  406. mutex_unlock(&synusb->pm_mutex);
  407. return retval;
  408. }
  409. static int synusb_pre_reset(struct usb_interface *intf)
  410. {
  411. struct synusb *synusb = usb_get_intfdata(intf);
  412. mutex_lock(&synusb->pm_mutex);
  413. usb_kill_urb(synusb->urb);
  414. return 0;
  415. }
  416. static int synusb_post_reset(struct usb_interface *intf)
  417. {
  418. struct synusb *synusb = usb_get_intfdata(intf);
  419. int retval = 0;
  420. if ((synusb->is_open || (synusb->flags & SYNUSB_IO_ALWAYS)) &&
  421. usb_submit_urb(synusb->urb, GFP_NOIO) < 0) {
  422. retval = -EIO;
  423. }
  424. mutex_unlock(&synusb->pm_mutex);
  425. return retval;
  426. }
  427. static int synusb_reset_resume(struct usb_interface *intf)
  428. {
  429. return synusb_resume(intf);
  430. }
  431. static const struct usb_device_id synusb_idtable[] = {
  432. { USB_DEVICE_SYNAPTICS(TP, SYNUSB_TOUCHPAD) },
  433. { USB_DEVICE_SYNAPTICS(INT_TP, SYNUSB_TOUCHPAD) },
  434. { USB_DEVICE_SYNAPTICS(CPAD,
  435. SYNUSB_TOUCHPAD | SYNUSB_AUXDISPLAY | SYNUSB_IO_ALWAYS) },
  436. { USB_DEVICE_SYNAPTICS(TS, SYNUSB_TOUCHSCREEN) },
  437. { USB_DEVICE_SYNAPTICS(STICK, SYNUSB_STICK) },
  438. { USB_DEVICE_SYNAPTICS(WP, SYNUSB_TOUCHPAD) },
  439. { USB_DEVICE_SYNAPTICS(COMP_TP, SYNUSB_COMBO) },
  440. { USB_DEVICE_SYNAPTICS(WTP, SYNUSB_TOUCHPAD) },
  441. { USB_DEVICE_SYNAPTICS(DPAD, SYNUSB_TOUCHPAD) },
  442. { }
  443. };
  444. MODULE_DEVICE_TABLE(usb, synusb_idtable);
  445. static struct usb_driver synusb_driver = {
  446. .name = "synaptics_usb",
  447. .probe = synusb_probe,
  448. .disconnect = synusb_disconnect,
  449. .id_table = synusb_idtable,
  450. .suspend = synusb_suspend,
  451. .resume = synusb_resume,
  452. .pre_reset = synusb_pre_reset,
  453. .post_reset = synusb_post_reset,
  454. .reset_resume = synusb_reset_resume,
  455. .supports_autosuspend = 1,
  456. };
  457. module_usb_driver(synusb_driver);
  458. MODULE_AUTHOR("Rob Miller <rob@inpharmatica.co.uk>, "
  459. "Ron Lee <ron@debian.org>, "
  460. "Jan Steinhoff <cpad@jan-steinhoff.de>");
  461. MODULE_DESCRIPTION("Synaptics USB device driver");
  462. MODULE_LICENSE("GPL");