bcm5974.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774
  1. /*
  2. * Apple USB BCM5974 (Macbook Air and Penryn Macbook Pro) multitouch driver
  3. *
  4. * Copyright (C) 2008 Henrik Rydberg (rydberg@euromail.se)
  5. *
  6. * The USB initialization and package decoding was made by
  7. * Scott Shawcroft as part of the touchd user-space driver project:
  8. * Copyright (C) 2008 Scott Shawcroft (scott.shawcroft@gmail.com)
  9. *
  10. * The BCM5974 driver is based on the appletouch driver:
  11. * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
  12. * Copyright (C) 2005 Johannes Berg (johannes@sipsolutions.net)
  13. * Copyright (C) 2005 Stelian Pop (stelian@popies.net)
  14. * Copyright (C) 2005 Frank Arnold (frank@scirocco-5v-turbo.de)
  15. * Copyright (C) 2005 Peter Osterlund (petero2@telia.com)
  16. * Copyright (C) 2005 Michael Hanselmann (linux-kernel@hansmi.ch)
  17. * Copyright (C) 2006 Nicolas Boichat (nicolas@boichat.ch)
  18. *
  19. * This program is free software; you can redistribute it and/or modify
  20. * it under the terms of the GNU General Public License as published by
  21. * the Free Software Foundation; either version 2 of the License, or
  22. * (at your option) any later version.
  23. *
  24. * This program is distributed in the hope that it will be useful,
  25. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  27. * GNU General Public License for more details.
  28. *
  29. * You should have received a copy of the GNU General Public License
  30. * along with this program; if not, write to the Free Software
  31. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  32. *
  33. */
  34. #include <linux/kernel.h>
  35. #include <linux/errno.h>
  36. #include <linux/init.h>
  37. #include <linux/slab.h>
  38. #include <linux/module.h>
  39. #include <linux/usb/input.h>
  40. #include <linux/hid.h>
  41. #include <linux/mutex.h>
  42. #define USB_VENDOR_ID_APPLE 0x05ac
  43. /* MacbookAir, aka wellspring */
  44. #define USB_DEVICE_ID_APPLE_WELLSPRING_ANSI 0x0223
  45. #define USB_DEVICE_ID_APPLE_WELLSPRING_ISO 0x0224
  46. #define USB_DEVICE_ID_APPLE_WELLSPRING_JIS 0x0225
  47. /* MacbookProPenryn, aka wellspring2 */
  48. #define USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI 0x0230
  49. #define USB_DEVICE_ID_APPLE_WELLSPRING2_ISO 0x0231
  50. #define USB_DEVICE_ID_APPLE_WELLSPRING2_JIS 0x0232
  51. /* Macbook5,1 (unibody), aka wellspring3 */
  52. #define USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI 0x0236
  53. #define USB_DEVICE_ID_APPLE_WELLSPRING3_ISO 0x0237
  54. #define USB_DEVICE_ID_APPLE_WELLSPRING3_JIS 0x0238
  55. #define BCM5974_DEVICE(prod) { \
  56. .match_flags = (USB_DEVICE_ID_MATCH_DEVICE | \
  57. USB_DEVICE_ID_MATCH_INT_CLASS | \
  58. USB_DEVICE_ID_MATCH_INT_PROTOCOL), \
  59. .idVendor = USB_VENDOR_ID_APPLE, \
  60. .idProduct = (prod), \
  61. .bInterfaceClass = USB_INTERFACE_CLASS_HID, \
  62. .bInterfaceProtocol = USB_INTERFACE_PROTOCOL_MOUSE \
  63. }
  64. /* table of devices that work with this driver */
  65. static const struct usb_device_id bcm5974_table[] = {
  66. /* MacbookAir1.1 */
  67. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
  68. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
  69. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
  70. /* MacbookProPenryn */
  71. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
  72. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
  73. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
  74. /* Macbook5,1 */
  75. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
  76. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
  77. BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
  78. /* Terminating entry */
  79. {}
  80. };
  81. MODULE_DEVICE_TABLE(usb, bcm5974_table);
  82. MODULE_AUTHOR("Henrik Rydberg");
  83. MODULE_DESCRIPTION("Apple USB BCM5974 multitouch driver");
  84. MODULE_LICENSE("GPL");
  85. #define dprintk(level, format, a...)\
  86. { if (debug >= level) printk(KERN_DEBUG format, ##a); }
  87. static int debug = 1;
  88. module_param(debug, int, 0644);
  89. MODULE_PARM_DESC(debug, "Activate debugging output");
  90. /* button data structure */
  91. struct bt_data {
  92. u8 unknown1; /* constant */
  93. u8 button; /* left button */
  94. u8 rel_x; /* relative x coordinate */
  95. u8 rel_y; /* relative y coordinate */
  96. };
  97. /* trackpad header types */
  98. enum tp_type {
  99. TYPE1, /* plain trackpad */
  100. TYPE2 /* button integrated in trackpad */
  101. };
  102. /* trackpad finger data offsets, le16-aligned */
  103. #define FINGER_TYPE1 (13 * sizeof(__le16))
  104. #define FINGER_TYPE2 (15 * sizeof(__le16))
  105. /* trackpad button data offsets */
  106. #define BUTTON_TYPE2 15
  107. /* list of device capability bits */
  108. #define HAS_INTEGRATED_BUTTON 1
  109. /* trackpad finger structure, le16-aligned */
  110. struct tp_finger {
  111. __le16 origin; /* zero when switching track finger */
  112. __le16 abs_x; /* absolute x coodinate */
  113. __le16 abs_y; /* absolute y coodinate */
  114. __le16 rel_x; /* relative x coodinate */
  115. __le16 rel_y; /* relative y coodinate */
  116. __le16 size_major; /* finger size, major axis? */
  117. __le16 size_minor; /* finger size, minor axis? */
  118. __le16 orientation; /* 16384 when point, else 15 bit angle */
  119. __le16 force_major; /* trackpad force, major axis? */
  120. __le16 force_minor; /* trackpad force, minor axis? */
  121. __le16 unused[3]; /* zeros */
  122. __le16 multi; /* one finger: varies, more fingers: constant */
  123. } __attribute__((packed,aligned(2)));
  124. /* trackpad finger data size, empirically at least ten fingers */
  125. #define SIZEOF_FINGER sizeof(struct tp_finger)
  126. #define SIZEOF_ALL_FINGERS (16 * SIZEOF_FINGER)
  127. /* device-specific parameters */
  128. struct bcm5974_param {
  129. int dim; /* logical dimension */
  130. int fuzz; /* logical noise value */
  131. int devmin; /* device minimum reading */
  132. int devmax; /* device maximum reading */
  133. };
  134. /* device-specific configuration */
  135. struct bcm5974_config {
  136. int ansi, iso, jis; /* the product id of this device */
  137. int caps; /* device capability bitmask */
  138. int bt_ep; /* the endpoint of the button interface */
  139. int bt_datalen; /* data length of the button interface */
  140. int tp_ep; /* the endpoint of the trackpad interface */
  141. enum tp_type tp_type; /* type of trackpad interface */
  142. int tp_offset; /* offset to trackpad finger data */
  143. int tp_datalen; /* data length of the trackpad interface */
  144. struct bcm5974_param p; /* finger pressure limits */
  145. struct bcm5974_param w; /* finger width limits */
  146. struct bcm5974_param x; /* horizontal limits */
  147. struct bcm5974_param y; /* vertical limits */
  148. };
  149. /* logical device structure */
  150. struct bcm5974 {
  151. char phys[64];
  152. struct usb_device *udev; /* usb device */
  153. struct usb_interface *intf; /* our interface */
  154. struct input_dev *input; /* input dev */
  155. struct bcm5974_config cfg; /* device configuration */
  156. struct mutex pm_mutex; /* serialize access to open/suspend */
  157. int opened; /* 1: opened, 0: closed */
  158. struct urb *bt_urb; /* button usb request block */
  159. struct bt_data *bt_data; /* button transferred data */
  160. struct urb *tp_urb; /* trackpad usb request block */
  161. u8 *tp_data; /* trackpad transferred data */
  162. int fingers; /* number of fingers on trackpad */
  163. };
  164. /* logical dimensions */
  165. #define DIM_PRESSURE 256 /* maximum finger pressure */
  166. #define DIM_WIDTH 16 /* maximum finger width */
  167. #define DIM_X 1280 /* maximum trackpad x value */
  168. #define DIM_Y 800 /* maximum trackpad y value */
  169. /* logical signal quality */
  170. #define SN_PRESSURE 45 /* pressure signal-to-noise ratio */
  171. #define SN_WIDTH 100 /* width signal-to-noise ratio */
  172. #define SN_COORD 250 /* coordinate signal-to-noise ratio */
  173. /* pressure thresholds */
  174. #define PRESSURE_LOW (2 * DIM_PRESSURE / SN_PRESSURE)
  175. #define PRESSURE_HIGH (3 * PRESSURE_LOW)
  176. /* device constants */
  177. static const struct bcm5974_config bcm5974_config_table[] = {
  178. {
  179. USB_DEVICE_ID_APPLE_WELLSPRING_ANSI,
  180. USB_DEVICE_ID_APPLE_WELLSPRING_ISO,
  181. USB_DEVICE_ID_APPLE_WELLSPRING_JIS,
  182. 0,
  183. 0x84, sizeof(struct bt_data),
  184. 0x81, TYPE1, FINGER_TYPE1, FINGER_TYPE1 + SIZEOF_ALL_FINGERS,
  185. { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 256 },
  186. { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
  187. { DIM_X, DIM_X / SN_COORD, -4824, 5342 },
  188. { DIM_Y, DIM_Y / SN_COORD, -172, 5820 }
  189. },
  190. {
  191. USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI,
  192. USB_DEVICE_ID_APPLE_WELLSPRING2_ISO,
  193. USB_DEVICE_ID_APPLE_WELLSPRING2_JIS,
  194. 0,
  195. 0x84, sizeof(struct bt_data),
  196. 0x81, TYPE1, FINGER_TYPE1, FINGER_TYPE1 + SIZEOF_ALL_FINGERS,
  197. { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 256 },
  198. { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
  199. { DIM_X, DIM_X / SN_COORD, -4824, 4824 },
  200. { DIM_Y, DIM_Y / SN_COORD, -172, 4290 }
  201. },
  202. {
  203. USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI,
  204. USB_DEVICE_ID_APPLE_WELLSPRING3_ISO,
  205. USB_DEVICE_ID_APPLE_WELLSPRING3_JIS,
  206. HAS_INTEGRATED_BUTTON,
  207. 0x84, sizeof(struct bt_data),
  208. 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
  209. { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
  210. { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
  211. { DIM_X, DIM_X / SN_COORD, -4460, 5166 },
  212. { DIM_Y, DIM_Y / SN_COORD, -75, 6700 }
  213. },
  214. {}
  215. };
  216. /* return the device-specific configuration by device */
  217. static const struct bcm5974_config *bcm5974_get_config(struct usb_device *udev)
  218. {
  219. u16 id = le16_to_cpu(udev->descriptor.idProduct);
  220. const struct bcm5974_config *cfg;
  221. for (cfg = bcm5974_config_table; cfg->ansi; ++cfg)
  222. if (cfg->ansi == id || cfg->iso == id || cfg->jis == id)
  223. return cfg;
  224. return bcm5974_config_table;
  225. }
  226. /* convert 16-bit little endian to signed integer */
  227. static inline int raw2int(__le16 x)
  228. {
  229. return (signed short)le16_to_cpu(x);
  230. }
  231. /* scale device data to logical dimensions (asserts devmin < devmax) */
  232. static inline int int2scale(const struct bcm5974_param *p, int x)
  233. {
  234. return x * p->dim / (p->devmax - p->devmin);
  235. }
  236. /* all logical value ranges are [0,dim). */
  237. static inline int int2bound(const struct bcm5974_param *p, int x)
  238. {
  239. int s = int2scale(p, x);
  240. return clamp_val(s, 0, p->dim - 1);
  241. }
  242. /* setup which logical events to report */
  243. static void setup_events_to_report(struct input_dev *input_dev,
  244. const struct bcm5974_config *cfg)
  245. {
  246. __set_bit(EV_ABS, input_dev->evbit);
  247. input_set_abs_params(input_dev, ABS_PRESSURE,
  248. 0, cfg->p.dim, cfg->p.fuzz, 0);
  249. input_set_abs_params(input_dev, ABS_TOOL_WIDTH,
  250. 0, cfg->w.dim, cfg->w.fuzz, 0);
  251. input_set_abs_params(input_dev, ABS_X,
  252. 0, cfg->x.dim, cfg->x.fuzz, 0);
  253. input_set_abs_params(input_dev, ABS_Y,
  254. 0, cfg->y.dim, cfg->y.fuzz, 0);
  255. __set_bit(EV_KEY, input_dev->evbit);
  256. __set_bit(BTN_TOUCH, input_dev->keybit);
  257. __set_bit(BTN_TOOL_FINGER, input_dev->keybit);
  258. __set_bit(BTN_TOOL_DOUBLETAP, input_dev->keybit);
  259. __set_bit(BTN_TOOL_TRIPLETAP, input_dev->keybit);
  260. __set_bit(BTN_TOOL_QUADTAP, input_dev->keybit);
  261. __set_bit(BTN_LEFT, input_dev->keybit);
  262. }
  263. /* report button data as logical button state */
  264. static int report_bt_state(struct bcm5974 *dev, int size)
  265. {
  266. if (size != sizeof(struct bt_data))
  267. return -EIO;
  268. input_report_key(dev->input, BTN_LEFT, dev->bt_data->button);
  269. input_sync(dev->input);
  270. return 0;
  271. }
  272. /* report trackpad data as logical trackpad state */
  273. static int report_tp_state(struct bcm5974 *dev, int size)
  274. {
  275. const struct bcm5974_config *c = &dev->cfg;
  276. const struct tp_finger *f;
  277. struct input_dev *input = dev->input;
  278. int raw_p, raw_w, raw_x, raw_y, raw_n;
  279. int ptest = 0, origin = 0, ibt = 0, nmin = 0, nmax = 0;
  280. int abs_p = 0, abs_w = 0, abs_x = 0, abs_y = 0;
  281. if (size < c->tp_offset || (size - c->tp_offset) % SIZEOF_FINGER != 0)
  282. return -EIO;
  283. /* finger data, le16-aligned */
  284. f = (const struct tp_finger *)(dev->tp_data + c->tp_offset);
  285. raw_n = (size - c->tp_offset) / SIZEOF_FINGER;
  286. /* always track the first finger; when detached, start over */
  287. if (raw_n) {
  288. raw_p = raw2int(f->force_major);
  289. raw_w = raw2int(f->size_major);
  290. raw_x = raw2int(f->abs_x);
  291. raw_y = raw2int(f->abs_y);
  292. dprintk(9,
  293. "bcm5974: raw: p: %+05d w: %+05d x: %+05d y: %+05d\n",
  294. raw_p, raw_w, raw_x, raw_y);
  295. ptest = int2bound(&c->p, raw_p);
  296. origin = raw2int(f->origin);
  297. /* set the integrated button if applicable */
  298. if (c->tp_type == TYPE2)
  299. ibt = raw2int(dev->tp_data[BUTTON_TYPE2]);
  300. }
  301. /* while tracking finger still valid, count all fingers */
  302. if (ptest > PRESSURE_LOW && origin) {
  303. abs_p = ptest;
  304. abs_w = int2bound(&c->w, raw_w);
  305. abs_x = int2bound(&c->x, raw_x - c->x.devmin);
  306. abs_y = int2bound(&c->y, c->y.devmax - raw_y);
  307. while (raw_n--) {
  308. ptest = int2bound(&c->p, raw2int(f->force_major));
  309. if (ptest > PRESSURE_LOW)
  310. nmax++;
  311. if (ptest > PRESSURE_HIGH)
  312. nmin++;
  313. f++;
  314. }
  315. }
  316. if (dev->fingers < nmin)
  317. dev->fingers = nmin;
  318. if (dev->fingers > nmax)
  319. dev->fingers = nmax;
  320. input_report_key(input, BTN_TOUCH, dev->fingers > 0);
  321. input_report_key(input, BTN_TOOL_FINGER, dev->fingers == 1);
  322. input_report_key(input, BTN_TOOL_DOUBLETAP, dev->fingers == 2);
  323. input_report_key(input, BTN_TOOL_TRIPLETAP, dev->fingers == 3);
  324. input_report_key(input, BTN_TOOL_QUADTAP, dev->fingers > 3);
  325. input_report_abs(input, ABS_PRESSURE, abs_p);
  326. input_report_abs(input, ABS_TOOL_WIDTH, abs_w);
  327. if (abs_p) {
  328. input_report_abs(input, ABS_X, abs_x);
  329. input_report_abs(input, ABS_Y, abs_y);
  330. dprintk(8,
  331. "bcm5974: abs: p: %+05d w: %+05d x: %+05d y: %+05d "
  332. "nmin: %d nmax: %d n: %d\n",
  333. abs_p, abs_w, abs_x, abs_y, nmin, nmax, dev->fingers);
  334. }
  335. /* type 2 reports button events via ibt only */
  336. if (c->tp_type == TYPE2)
  337. input_report_key(input, BTN_LEFT, ibt);
  338. input_sync(input);
  339. return 0;
  340. }
  341. /* Wellspring initialization constants */
  342. #define BCM5974_WELLSPRING_MODE_READ_REQUEST_ID 1
  343. #define BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID 9
  344. #define BCM5974_WELLSPRING_MODE_REQUEST_VALUE 0x300
  345. #define BCM5974_WELLSPRING_MODE_REQUEST_INDEX 0
  346. #define BCM5974_WELLSPRING_MODE_VENDOR_VALUE 0x01
  347. #define BCM5974_WELLSPRING_MODE_NORMAL_VALUE 0x08
  348. static int bcm5974_wellspring_mode(struct bcm5974 *dev, bool on)
  349. {
  350. char *data = kmalloc(8, GFP_KERNEL);
  351. int retval = 0, size;
  352. if (!data) {
  353. err("bcm5974: out of memory");
  354. retval = -ENOMEM;
  355. goto out;
  356. }
  357. /* read configuration */
  358. size = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
  359. BCM5974_WELLSPRING_MODE_READ_REQUEST_ID,
  360. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  361. BCM5974_WELLSPRING_MODE_REQUEST_VALUE,
  362. BCM5974_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
  363. if (size != 8) {
  364. err("bcm5974: could not read from device");
  365. retval = -EIO;
  366. goto out;
  367. }
  368. /* apply the mode switch */
  369. data[0] = on ?
  370. BCM5974_WELLSPRING_MODE_VENDOR_VALUE :
  371. BCM5974_WELLSPRING_MODE_NORMAL_VALUE;
  372. /* write configuration */
  373. size = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
  374. BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID,
  375. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  376. BCM5974_WELLSPRING_MODE_REQUEST_VALUE,
  377. BCM5974_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
  378. if (size != 8) {
  379. err("bcm5974: could not write to device");
  380. retval = -EIO;
  381. goto out;
  382. }
  383. dprintk(2, "bcm5974: switched to %s mode.\n",
  384. on ? "wellspring" : "normal");
  385. out:
  386. kfree(data);
  387. return retval;
  388. }
  389. static void bcm5974_irq_button(struct urb *urb)
  390. {
  391. struct bcm5974 *dev = urb->context;
  392. int error;
  393. switch (urb->status) {
  394. case 0:
  395. break;
  396. case -EOVERFLOW:
  397. case -ECONNRESET:
  398. case -ENOENT:
  399. case -ESHUTDOWN:
  400. dbg("bcm5974: button urb shutting down: %d", urb->status);
  401. return;
  402. default:
  403. dbg("bcm5974: button urb status: %d", urb->status);
  404. goto exit;
  405. }
  406. if (report_bt_state(dev, dev->bt_urb->actual_length))
  407. dprintk(1, "bcm5974: bad button package, length: %d\n",
  408. dev->bt_urb->actual_length);
  409. exit:
  410. error = usb_submit_urb(dev->bt_urb, GFP_ATOMIC);
  411. if (error)
  412. err("bcm5974: button urb failed: %d", error);
  413. }
  414. static void bcm5974_irq_trackpad(struct urb *urb)
  415. {
  416. struct bcm5974 *dev = urb->context;
  417. int error;
  418. switch (urb->status) {
  419. case 0:
  420. break;
  421. case -EOVERFLOW:
  422. case -ECONNRESET:
  423. case -ENOENT:
  424. case -ESHUTDOWN:
  425. dbg("bcm5974: trackpad urb shutting down: %d", urb->status);
  426. return;
  427. default:
  428. dbg("bcm5974: trackpad urb status: %d", urb->status);
  429. goto exit;
  430. }
  431. /* control response ignored */
  432. if (dev->tp_urb->actual_length == 2)
  433. goto exit;
  434. if (report_tp_state(dev, dev->tp_urb->actual_length))
  435. dprintk(1, "bcm5974: bad trackpad package, length: %d\n",
  436. dev->tp_urb->actual_length);
  437. exit:
  438. error = usb_submit_urb(dev->tp_urb, GFP_ATOMIC);
  439. if (error)
  440. err("bcm5974: trackpad urb failed: %d", error);
  441. }
  442. /*
  443. * The Wellspring trackpad, like many recent Apple trackpads, share
  444. * the usb device with the keyboard. Since keyboards are usually
  445. * handled by the HID system, the device ends up being handled by two
  446. * modules. Setting up the device therefore becomes slightly
  447. * complicated. To enable multitouch features, a mode switch is
  448. * required, which is usually applied via the control interface of the
  449. * device. It can be argued where this switch should take place. In
  450. * some drivers, like appletouch, the switch is made during
  451. * probe. However, the hid module may also alter the state of the
  452. * device, resulting in trackpad malfunction under certain
  453. * circumstances. To get around this problem, there is at least one
  454. * example that utilizes the USB_QUIRK_RESET_RESUME quirk in order to
  455. * recieve a reset_resume request rather than the normal resume.
  456. * Since the implementation of reset_resume is equal to mode switch
  457. * plus start_traffic, it seems easier to always do the switch when
  458. * starting traffic on the device.
  459. */
  460. static int bcm5974_start_traffic(struct bcm5974 *dev)
  461. {
  462. if (bcm5974_wellspring_mode(dev, true)) {
  463. dprintk(1, "bcm5974: mode switch failed\n");
  464. goto error;
  465. }
  466. if (usb_submit_urb(dev->bt_urb, GFP_KERNEL))
  467. goto error;
  468. if (usb_submit_urb(dev->tp_urb, GFP_KERNEL))
  469. goto err_kill_bt;
  470. return 0;
  471. err_kill_bt:
  472. usb_kill_urb(dev->bt_urb);
  473. error:
  474. return -EIO;
  475. }
  476. static void bcm5974_pause_traffic(struct bcm5974 *dev)
  477. {
  478. usb_kill_urb(dev->tp_urb);
  479. usb_kill_urb(dev->bt_urb);
  480. bcm5974_wellspring_mode(dev, false);
  481. }
  482. /*
  483. * The code below implements open/close and manual suspend/resume.
  484. * All functions may be called in random order.
  485. *
  486. * Opening a suspended device fails with EACCES - permission denied.
  487. *
  488. * Failing a resume leaves the device resumed but closed.
  489. */
  490. static int bcm5974_open(struct input_dev *input)
  491. {
  492. struct bcm5974 *dev = input_get_drvdata(input);
  493. int error;
  494. error = usb_autopm_get_interface(dev->intf);
  495. if (error)
  496. return error;
  497. mutex_lock(&dev->pm_mutex);
  498. error = bcm5974_start_traffic(dev);
  499. if (!error)
  500. dev->opened = 1;
  501. mutex_unlock(&dev->pm_mutex);
  502. if (error)
  503. usb_autopm_put_interface(dev->intf);
  504. return error;
  505. }
  506. static void bcm5974_close(struct input_dev *input)
  507. {
  508. struct bcm5974 *dev = input_get_drvdata(input);
  509. mutex_lock(&dev->pm_mutex);
  510. bcm5974_pause_traffic(dev);
  511. dev->opened = 0;
  512. mutex_unlock(&dev->pm_mutex);
  513. usb_autopm_put_interface(dev->intf);
  514. }
  515. static int bcm5974_suspend(struct usb_interface *iface, pm_message_t message)
  516. {
  517. struct bcm5974 *dev = usb_get_intfdata(iface);
  518. mutex_lock(&dev->pm_mutex);
  519. if (dev->opened)
  520. bcm5974_pause_traffic(dev);
  521. mutex_unlock(&dev->pm_mutex);
  522. return 0;
  523. }
  524. static int bcm5974_resume(struct usb_interface *iface)
  525. {
  526. struct bcm5974 *dev = usb_get_intfdata(iface);
  527. int error = 0;
  528. mutex_lock(&dev->pm_mutex);
  529. if (dev->opened)
  530. error = bcm5974_start_traffic(dev);
  531. mutex_unlock(&dev->pm_mutex);
  532. return error;
  533. }
  534. static int bcm5974_probe(struct usb_interface *iface,
  535. const struct usb_device_id *id)
  536. {
  537. struct usb_device *udev = interface_to_usbdev(iface);
  538. const struct bcm5974_config *cfg;
  539. struct bcm5974 *dev;
  540. struct input_dev *input_dev;
  541. int error = -ENOMEM;
  542. /* find the product index */
  543. cfg = bcm5974_get_config(udev);
  544. /* allocate memory for our device state and initialize it */
  545. dev = kzalloc(sizeof(struct bcm5974), GFP_KERNEL);
  546. input_dev = input_allocate_device();
  547. if (!dev || !input_dev) {
  548. err("bcm5974: out of memory");
  549. goto err_free_devs;
  550. }
  551. dev->udev = udev;
  552. dev->intf = iface;
  553. dev->input = input_dev;
  554. dev->cfg = *cfg;
  555. mutex_init(&dev->pm_mutex);
  556. /* setup urbs */
  557. dev->bt_urb = usb_alloc_urb(0, GFP_KERNEL);
  558. if (!dev->bt_urb)
  559. goto err_free_devs;
  560. dev->tp_urb = usb_alloc_urb(0, GFP_KERNEL);
  561. if (!dev->tp_urb)
  562. goto err_free_bt_urb;
  563. dev->bt_data = usb_buffer_alloc(dev->udev,
  564. dev->cfg.bt_datalen, GFP_KERNEL,
  565. &dev->bt_urb->transfer_dma);
  566. if (!dev->bt_data)
  567. goto err_free_urb;
  568. dev->tp_data = usb_buffer_alloc(dev->udev,
  569. dev->cfg.tp_datalen, GFP_KERNEL,
  570. &dev->tp_urb->transfer_dma);
  571. if (!dev->tp_data)
  572. goto err_free_bt_buffer;
  573. usb_fill_int_urb(dev->bt_urb, udev,
  574. usb_rcvintpipe(udev, cfg->bt_ep),
  575. dev->bt_data, dev->cfg.bt_datalen,
  576. bcm5974_irq_button, dev, 1);
  577. usb_fill_int_urb(dev->tp_urb, udev,
  578. usb_rcvintpipe(udev, cfg->tp_ep),
  579. dev->tp_data, dev->cfg.tp_datalen,
  580. bcm5974_irq_trackpad, dev, 1);
  581. /* create bcm5974 device */
  582. usb_make_path(udev, dev->phys, sizeof(dev->phys));
  583. strlcat(dev->phys, "/input0", sizeof(dev->phys));
  584. input_dev->name = "bcm5974";
  585. input_dev->phys = dev->phys;
  586. usb_to_input_id(dev->udev, &input_dev->id);
  587. /* report driver capabilities via the version field */
  588. input_dev->id.version = cfg->caps;
  589. input_dev->dev.parent = &iface->dev;
  590. input_set_drvdata(input_dev, dev);
  591. input_dev->open = bcm5974_open;
  592. input_dev->close = bcm5974_close;
  593. setup_events_to_report(input_dev, cfg);
  594. error = input_register_device(dev->input);
  595. if (error)
  596. goto err_free_buffer;
  597. /* save our data pointer in this interface device */
  598. usb_set_intfdata(iface, dev);
  599. return 0;
  600. err_free_buffer:
  601. usb_buffer_free(dev->udev, dev->cfg.tp_datalen,
  602. dev->tp_data, dev->tp_urb->transfer_dma);
  603. err_free_bt_buffer:
  604. usb_buffer_free(dev->udev, dev->cfg.bt_datalen,
  605. dev->bt_data, dev->bt_urb->transfer_dma);
  606. err_free_urb:
  607. usb_free_urb(dev->tp_urb);
  608. err_free_bt_urb:
  609. usb_free_urb(dev->bt_urb);
  610. err_free_devs:
  611. usb_set_intfdata(iface, NULL);
  612. input_free_device(input_dev);
  613. kfree(dev);
  614. return error;
  615. }
  616. static void bcm5974_disconnect(struct usb_interface *iface)
  617. {
  618. struct bcm5974 *dev = usb_get_intfdata(iface);
  619. usb_set_intfdata(iface, NULL);
  620. input_unregister_device(dev->input);
  621. usb_buffer_free(dev->udev, dev->cfg.tp_datalen,
  622. dev->tp_data, dev->tp_urb->transfer_dma);
  623. usb_buffer_free(dev->udev, dev->cfg.bt_datalen,
  624. dev->bt_data, dev->bt_urb->transfer_dma);
  625. usb_free_urb(dev->tp_urb);
  626. usb_free_urb(dev->bt_urb);
  627. kfree(dev);
  628. }
  629. static struct usb_driver bcm5974_driver = {
  630. .name = "bcm5974",
  631. .probe = bcm5974_probe,
  632. .disconnect = bcm5974_disconnect,
  633. .suspend = bcm5974_suspend,
  634. .resume = bcm5974_resume,
  635. .reset_resume = bcm5974_resume,
  636. .id_table = bcm5974_table,
  637. .supports_autosuspend = 1,
  638. };
  639. static int __init bcm5974_init(void)
  640. {
  641. return usb_register(&bcm5974_driver);
  642. }
  643. static void __exit bcm5974_exit(void)
  644. {
  645. usb_deregister(&bcm5974_driver);
  646. }
  647. module_init(bcm5974_init);
  648. module_exit(bcm5974_exit);