Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[~shefty/rdma-dev.git] / drivers / input / mouse / bcm5974.c
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
35 #include <linux/kernel.h>
36 #include <linux/errno.h>
37 #include <linux/init.h>
38 #include <linux/slab.h>
39 #include <linux/module.h>
40 #include <linux/usb/input.h>
41 #include <linux/hid.h>
42 #include <linux/mutex.h>
43
44 #define USB_VENDOR_ID_APPLE             0x05ac
45
46 /* MacbookAir, aka wellspring */
47 #define USB_DEVICE_ID_APPLE_WELLSPRING_ANSI     0x0223
48 #define USB_DEVICE_ID_APPLE_WELLSPRING_ISO      0x0224
49 #define USB_DEVICE_ID_APPLE_WELLSPRING_JIS      0x0225
50 /* MacbookProPenryn, aka wellspring2 */
51 #define USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI    0x0230
52 #define USB_DEVICE_ID_APPLE_WELLSPRING2_ISO     0x0231
53 #define USB_DEVICE_ID_APPLE_WELLSPRING2_JIS     0x0232
54 /* Macbook5,1 (unibody), aka wellspring3 */
55 #define USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI    0x0236
56 #define USB_DEVICE_ID_APPLE_WELLSPRING3_ISO     0x0237
57 #define USB_DEVICE_ID_APPLE_WELLSPRING3_JIS     0x0238
58 /* MacbookAir3,2 (unibody), aka wellspring5 */
59 #define USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI    0x023f
60 #define USB_DEVICE_ID_APPLE_WELLSPRING4_ISO     0x0240
61 #define USB_DEVICE_ID_APPLE_WELLSPRING4_JIS     0x0241
62 /* MacbookAir3,1 (unibody), aka wellspring4 */
63 #define USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI   0x0242
64 #define USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO    0x0243
65 #define USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS    0x0244
66 /* Macbook8 (unibody, March 2011) */
67 #define USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI    0x0245
68 #define USB_DEVICE_ID_APPLE_WELLSPRING5_ISO     0x0246
69 #define USB_DEVICE_ID_APPLE_WELLSPRING5_JIS     0x0247
70 /* MacbookAir4,1 (unibody, July 2011) */
71 #define USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI   0x0249
72 #define USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO    0x024a
73 #define USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS    0x024b
74 /* MacbookAir4,2 (unibody, July 2011) */
75 #define USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI    0x024c
76 #define USB_DEVICE_ID_APPLE_WELLSPRING6_ISO     0x024d
77 #define USB_DEVICE_ID_APPLE_WELLSPRING6_JIS     0x024e
78 /* Macbook8,2 (unibody) */
79 #define USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI   0x0252
80 #define USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO    0x0253
81 #define USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS    0x0254
82
83 #define BCM5974_DEVICE(prod) {                                  \
84         .match_flags = (USB_DEVICE_ID_MATCH_DEVICE |            \
85                         USB_DEVICE_ID_MATCH_INT_CLASS |         \
86                         USB_DEVICE_ID_MATCH_INT_PROTOCOL),      \
87         .idVendor = USB_VENDOR_ID_APPLE,                        \
88         .idProduct = (prod),                                    \
89         .bInterfaceClass = USB_INTERFACE_CLASS_HID,             \
90         .bInterfaceProtocol = USB_INTERFACE_PROTOCOL_MOUSE      \
91 }
92
93 /* table of devices that work with this driver */
94 static const struct usb_device_id bcm5974_table[] = {
95         /* MacbookAir1.1 */
96         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
97         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
98         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
99         /* MacbookProPenryn */
100         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
101         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
102         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
103         /* Macbook5,1 */
104         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
105         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
106         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
107         /* MacbookAir3,2 */
108         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
109         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
110         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
111         /* MacbookAir3,1 */
112         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
113         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
114         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
115         /* MacbookPro8 */
116         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
117         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
118         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
119         /* MacbookAir4,1 */
120         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
121         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
122         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
123         /* MacbookAir4,2 */
124         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
125         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
126         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
127         /* MacbookPro8,2 */
128         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
129         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
130         BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
131         /* Terminating entry */
132         {}
133 };
134 MODULE_DEVICE_TABLE(usb, bcm5974_table);
135
136 MODULE_AUTHOR("Henrik Rydberg");
137 MODULE_DESCRIPTION("Apple USB BCM5974 multitouch driver");
138 MODULE_LICENSE("GPL");
139
140 #define dprintk(level, format, a...)\
141         { if (debug >= level) printk(KERN_DEBUG format, ##a); }
142
143 static int debug = 1;
144 module_param(debug, int, 0644);
145 MODULE_PARM_DESC(debug, "Activate debugging output");
146
147 /* button data structure */
148 struct bt_data {
149         u8 unknown1;            /* constant */
150         u8 button;              /* left button */
151         u8 rel_x;               /* relative x coordinate */
152         u8 rel_y;               /* relative y coordinate */
153 };
154
155 /* trackpad header types */
156 enum tp_type {
157         TYPE1,                  /* plain trackpad */
158         TYPE2                   /* button integrated in trackpad */
159 };
160
161 /* trackpad finger data offsets, le16-aligned */
162 #define FINGER_TYPE1            (13 * sizeof(__le16))
163 #define FINGER_TYPE2            (15 * sizeof(__le16))
164
165 /* trackpad button data offsets */
166 #define BUTTON_TYPE2            15
167
168 /* list of device capability bits */
169 #define HAS_INTEGRATED_BUTTON   1
170
171 /* trackpad finger structure, le16-aligned */
172 struct tp_finger {
173         __le16 origin;          /* zero when switching track finger */
174         __le16 abs_x;           /* absolute x coodinate */
175         __le16 abs_y;           /* absolute y coodinate */
176         __le16 rel_x;           /* relative x coodinate */
177         __le16 rel_y;           /* relative y coodinate */
178         __le16 size_major;      /* finger size, major axis? */
179         __le16 size_minor;      /* finger size, minor axis? */
180         __le16 orientation;     /* 16384 when point, else 15 bit angle */
181         __le16 force_major;     /* trackpad force, major axis? */
182         __le16 force_minor;     /* trackpad force, minor axis? */
183         __le16 unused[3];       /* zeros */
184         __le16 multi;           /* one finger: varies, more fingers: constant */
185 } __attribute__((packed,aligned(2)));
186
187 /* trackpad finger data size, empirically at least ten fingers */
188 #define SIZEOF_FINGER           sizeof(struct tp_finger)
189 #define SIZEOF_ALL_FINGERS      (16 * SIZEOF_FINGER)
190 #define MAX_FINGER_ORIENTATION  16384
191
192 /* device-specific parameters */
193 struct bcm5974_param {
194         int dim;                /* logical dimension */
195         int fuzz;               /* logical noise value */
196         int devmin;             /* device minimum reading */
197         int devmax;             /* device maximum reading */
198 };
199
200 /* device-specific configuration */
201 struct bcm5974_config {
202         int ansi, iso, jis;     /* the product id of this device */
203         int caps;               /* device capability bitmask */
204         int bt_ep;              /* the endpoint of the button interface */
205         int bt_datalen;         /* data length of the button interface */
206         int tp_ep;              /* the endpoint of the trackpad interface */
207         enum tp_type tp_type;   /* type of trackpad interface */
208         int tp_offset;          /* offset to trackpad finger data */
209         int tp_datalen;         /* data length of the trackpad interface */
210         struct bcm5974_param p; /* finger pressure limits */
211         struct bcm5974_param w; /* finger width limits */
212         struct bcm5974_param x; /* horizontal limits */
213         struct bcm5974_param y; /* vertical limits */
214 };
215
216 /* logical device structure */
217 struct bcm5974 {
218         char phys[64];
219         struct usb_device *udev;        /* usb device */
220         struct usb_interface *intf;     /* our interface */
221         struct input_dev *input;        /* input dev */
222         struct bcm5974_config cfg;      /* device configuration */
223         struct mutex pm_mutex;          /* serialize access to open/suspend */
224         int opened;                     /* 1: opened, 0: closed */
225         struct urb *bt_urb;             /* button usb request block */
226         struct bt_data *bt_data;        /* button transferred data */
227         struct urb *tp_urb;             /* trackpad usb request block */
228         u8 *tp_data;                    /* trackpad transferred data */
229         int fingers;                    /* number of fingers on trackpad */
230 };
231
232 /* logical dimensions */
233 #define DIM_PRESSURE    256             /* maximum finger pressure */
234 #define DIM_WIDTH       16              /* maximum finger width */
235 #define DIM_X           1280            /* maximum trackpad x value */
236 #define DIM_Y           800             /* maximum trackpad y value */
237
238 /* logical signal quality */
239 #define SN_PRESSURE     45              /* pressure signal-to-noise ratio */
240 #define SN_WIDTH        100             /* width signal-to-noise ratio */
241 #define SN_COORD        250             /* coordinate signal-to-noise ratio */
242
243 /* pressure thresholds */
244 #define PRESSURE_LOW    (2 * DIM_PRESSURE / SN_PRESSURE)
245 #define PRESSURE_HIGH   (3 * PRESSURE_LOW)
246
247 /* device constants */
248 static const struct bcm5974_config bcm5974_config_table[] = {
249         {
250                 USB_DEVICE_ID_APPLE_WELLSPRING_ANSI,
251                 USB_DEVICE_ID_APPLE_WELLSPRING_ISO,
252                 USB_DEVICE_ID_APPLE_WELLSPRING_JIS,
253                 0,
254                 0x84, sizeof(struct bt_data),
255                 0x81, TYPE1, FINGER_TYPE1, FINGER_TYPE1 + SIZEOF_ALL_FINGERS,
256                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 256 },
257                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
258                 { DIM_X, DIM_X / SN_COORD, -4824, 5342 },
259                 { DIM_Y, DIM_Y / SN_COORD, -172, 5820 }
260         },
261         {
262                 USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI,
263                 USB_DEVICE_ID_APPLE_WELLSPRING2_ISO,
264                 USB_DEVICE_ID_APPLE_WELLSPRING2_JIS,
265                 0,
266                 0x84, sizeof(struct bt_data),
267                 0x81, TYPE1, FINGER_TYPE1, FINGER_TYPE1 + SIZEOF_ALL_FINGERS,
268                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 256 },
269                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
270                 { DIM_X, DIM_X / SN_COORD, -4824, 4824 },
271                 { DIM_Y, DIM_Y / SN_COORD, -172, 4290 }
272         },
273         {
274                 USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI,
275                 USB_DEVICE_ID_APPLE_WELLSPRING3_ISO,
276                 USB_DEVICE_ID_APPLE_WELLSPRING3_JIS,
277                 HAS_INTEGRATED_BUTTON,
278                 0x84, sizeof(struct bt_data),
279                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
280                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
281                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
282                 { DIM_X, DIM_X / SN_COORD, -4460, 5166 },
283                 { DIM_Y, DIM_Y / SN_COORD, -75, 6700 }
284         },
285         {
286                 USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI,
287                 USB_DEVICE_ID_APPLE_WELLSPRING4_ISO,
288                 USB_DEVICE_ID_APPLE_WELLSPRING4_JIS,
289                 HAS_INTEGRATED_BUTTON,
290                 0x84, sizeof(struct bt_data),
291                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
292                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
293                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
294                 { DIM_X, DIM_X / SN_COORD, -4620, 5140 },
295                 { DIM_Y, DIM_Y / SN_COORD, -150, 6600 }
296         },
297         {
298                 USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI,
299                 USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO,
300                 USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS,
301                 HAS_INTEGRATED_BUTTON,
302                 0x84, sizeof(struct bt_data),
303                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
304                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
305                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
306                 { DIM_X, DIM_X / SN_COORD, -4616, 5112 },
307                 { DIM_Y, DIM_Y / SN_COORD, -142, 5234 }
308         },
309         {
310                 USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI,
311                 USB_DEVICE_ID_APPLE_WELLSPRING5_ISO,
312                 USB_DEVICE_ID_APPLE_WELLSPRING5_JIS,
313                 HAS_INTEGRATED_BUTTON,
314                 0x84, sizeof(struct bt_data),
315                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
316                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
317                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
318                 { DIM_X, DIM_X / SN_COORD, -4415, 5050 },
319                 { DIM_Y, DIM_Y / SN_COORD, -55, 6680 }
320         },
321         {
322                 USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI,
323                 USB_DEVICE_ID_APPLE_WELLSPRING6_ISO,
324                 USB_DEVICE_ID_APPLE_WELLSPRING6_JIS,
325                 HAS_INTEGRATED_BUTTON,
326                 0x84, sizeof(struct bt_data),
327                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
328                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
329                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
330                 { DIM_X, DIM_X / SN_COORD, -4620, 5140 },
331                 { DIM_Y, DIM_Y / SN_COORD, -150, 6600 }
332         },
333         {
334                 USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI,
335                 USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO,
336                 USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS,
337                 HAS_INTEGRATED_BUTTON,
338                 0x84, sizeof(struct bt_data),
339                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
340                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
341                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
342                 { DIM_X, DIM_X / SN_COORD, -4750, 5280 },
343                 { DIM_Y, DIM_Y / SN_COORD, -150, 6730 }
344         },
345         {
346                 USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI,
347                 USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO,
348                 USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS,
349                 HAS_INTEGRATED_BUTTON,
350                 0x84, sizeof(struct bt_data),
351                 0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
352                 { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
353                 { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
354                 { DIM_X, DIM_X / SN_COORD, -4620, 5140 },
355                 { DIM_Y, DIM_Y / SN_COORD, -150, 6600 }
356         },
357         {}
358 };
359
360 /* return the device-specific configuration by device */
361 static const struct bcm5974_config *bcm5974_get_config(struct usb_device *udev)
362 {
363         u16 id = le16_to_cpu(udev->descriptor.idProduct);
364         const struct bcm5974_config *cfg;
365
366         for (cfg = bcm5974_config_table; cfg->ansi; ++cfg)
367                 if (cfg->ansi == id || cfg->iso == id || cfg->jis == id)
368                         return cfg;
369
370         return bcm5974_config_table;
371 }
372
373 /* convert 16-bit little endian to signed integer */
374 static inline int raw2int(__le16 x)
375 {
376         return (signed short)le16_to_cpu(x);
377 }
378
379 /* scale device data to logical dimensions (asserts devmin < devmax) */
380 static inline int int2scale(const struct bcm5974_param *p, int x)
381 {
382         return x * p->dim / (p->devmax - p->devmin);
383 }
384
385 /* all logical value ranges are [0,dim). */
386 static inline int int2bound(const struct bcm5974_param *p, int x)
387 {
388         int s = int2scale(p, x);
389
390         return clamp_val(s, 0, p->dim - 1);
391 }
392
393 /* setup which logical events to report */
394 static void setup_events_to_report(struct input_dev *input_dev,
395                                    const struct bcm5974_config *cfg)
396 {
397         __set_bit(EV_ABS, input_dev->evbit);
398
399         input_set_abs_params(input_dev, ABS_PRESSURE,
400                                 0, cfg->p.dim, cfg->p.fuzz, 0);
401         input_set_abs_params(input_dev, ABS_TOOL_WIDTH,
402                                 0, cfg->w.dim, cfg->w.fuzz, 0);
403         input_set_abs_params(input_dev, ABS_X,
404                                 0, cfg->x.dim, cfg->x.fuzz, 0);
405         input_set_abs_params(input_dev, ABS_Y,
406                                 0, cfg->y.dim, cfg->y.fuzz, 0);
407
408         /* finger touch area */
409         input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
410                              cfg->w.devmin, cfg->w.devmax, 0, 0);
411         input_set_abs_params(input_dev, ABS_MT_TOUCH_MINOR,
412                              cfg->w.devmin, cfg->w.devmax, 0, 0);
413         /* finger approach area */
414         input_set_abs_params(input_dev, ABS_MT_WIDTH_MAJOR,
415                              cfg->w.devmin, cfg->w.devmax, 0, 0);
416         input_set_abs_params(input_dev, ABS_MT_WIDTH_MINOR,
417                              cfg->w.devmin, cfg->w.devmax, 0, 0);
418         /* finger orientation */
419         input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
420                              -MAX_FINGER_ORIENTATION,
421                              MAX_FINGER_ORIENTATION, 0, 0);
422         /* finger position */
423         input_set_abs_params(input_dev, ABS_MT_POSITION_X,
424                              cfg->x.devmin, cfg->x.devmax, 0, 0);
425         input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
426                              cfg->y.devmin, cfg->y.devmax, 0, 0);
427
428         __set_bit(EV_KEY, input_dev->evbit);
429         __set_bit(BTN_TOUCH, input_dev->keybit);
430         __set_bit(BTN_TOOL_FINGER, input_dev->keybit);
431         __set_bit(BTN_TOOL_DOUBLETAP, input_dev->keybit);
432         __set_bit(BTN_TOOL_TRIPLETAP, input_dev->keybit);
433         __set_bit(BTN_TOOL_QUADTAP, input_dev->keybit);
434         __set_bit(BTN_LEFT, input_dev->keybit);
435
436         if (cfg->caps & HAS_INTEGRATED_BUTTON)
437                 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
438
439         input_set_events_per_packet(input_dev, 60);
440 }
441
442 /* report button data as logical button state */
443 static int report_bt_state(struct bcm5974 *dev, int size)
444 {
445         if (size != sizeof(struct bt_data))
446                 return -EIO;
447
448         dprintk(7,
449                 "bcm5974: button data: %x %x %x %x\n",
450                 dev->bt_data->unknown1, dev->bt_data->button,
451                 dev->bt_data->rel_x, dev->bt_data->rel_y);
452
453         input_report_key(dev->input, BTN_LEFT, dev->bt_data->button);
454         input_sync(dev->input);
455
456         return 0;
457 }
458
459 static void report_finger_data(struct input_dev *input,
460                                const struct bcm5974_config *cfg,
461                                const struct tp_finger *f)
462 {
463         input_report_abs(input, ABS_MT_TOUCH_MAJOR,
464                          raw2int(f->force_major) << 1);
465         input_report_abs(input, ABS_MT_TOUCH_MINOR,
466                          raw2int(f->force_minor) << 1);
467         input_report_abs(input, ABS_MT_WIDTH_MAJOR,
468                          raw2int(f->size_major) << 1);
469         input_report_abs(input, ABS_MT_WIDTH_MINOR,
470                          raw2int(f->size_minor) << 1);
471         input_report_abs(input, ABS_MT_ORIENTATION,
472                          MAX_FINGER_ORIENTATION - raw2int(f->orientation));
473         input_report_abs(input, ABS_MT_POSITION_X, raw2int(f->abs_x));
474         input_report_abs(input, ABS_MT_POSITION_Y,
475                          cfg->y.devmin + cfg->y.devmax - raw2int(f->abs_y));
476         input_mt_sync(input);
477 }
478
479 /* report trackpad data as logical trackpad state */
480 static int report_tp_state(struct bcm5974 *dev, int size)
481 {
482         const struct bcm5974_config *c = &dev->cfg;
483         const struct tp_finger *f;
484         struct input_dev *input = dev->input;
485         int raw_p, raw_w, raw_x, raw_y, raw_n, i;
486         int ptest, origin, ibt = 0, nmin = 0, nmax = 0;
487         int abs_p = 0, abs_w = 0, abs_x = 0, abs_y = 0;
488
489         if (size < c->tp_offset || (size - c->tp_offset) % SIZEOF_FINGER != 0)
490                 return -EIO;
491
492         /* finger data, le16-aligned */
493         f = (const struct tp_finger *)(dev->tp_data + c->tp_offset);
494         raw_n = (size - c->tp_offset) / SIZEOF_FINGER;
495
496         /* always track the first finger; when detached, start over */
497         if (raw_n) {
498
499                 /* report raw trackpad data */
500                 for (i = 0; i < raw_n; i++)
501                         report_finger_data(input, c, &f[i]);
502
503                 raw_p = raw2int(f->force_major);
504                 raw_w = raw2int(f->size_major);
505                 raw_x = raw2int(f->abs_x);
506                 raw_y = raw2int(f->abs_y);
507
508                 dprintk(9,
509                         "bcm5974: "
510                         "raw: p: %+05d w: %+05d x: %+05d y: %+05d n: %d\n",
511                         raw_p, raw_w, raw_x, raw_y, raw_n);
512
513                 ptest = int2bound(&c->p, raw_p);
514                 origin = raw2int(f->origin);
515
516                 /* while tracking finger still valid, count all fingers */
517                 if (ptest > PRESSURE_LOW && origin) {
518                         abs_p = ptest;
519                         abs_w = int2bound(&c->w, raw_w);
520                         abs_x = int2bound(&c->x, raw_x - c->x.devmin);
521                         abs_y = int2bound(&c->y, c->y.devmax - raw_y);
522                         while (raw_n--) {
523                                 ptest = int2bound(&c->p,
524                                                   raw2int(f->force_major));
525                                 if (ptest > PRESSURE_LOW)
526                                         nmax++;
527                                 if (ptest > PRESSURE_HIGH)
528                                         nmin++;
529                                 f++;
530                         }
531                 }
532         }
533
534         /* set the integrated button if applicable */
535         if (c->tp_type == TYPE2)
536                 ibt = raw2int(dev->tp_data[BUTTON_TYPE2]);
537
538         if (dev->fingers < nmin)
539                 dev->fingers = nmin;
540         if (dev->fingers > nmax)
541                 dev->fingers = nmax;
542
543         input_report_key(input, BTN_TOUCH, dev->fingers > 0);
544         input_report_key(input, BTN_TOOL_FINGER, dev->fingers == 1);
545         input_report_key(input, BTN_TOOL_DOUBLETAP, dev->fingers == 2);
546         input_report_key(input, BTN_TOOL_TRIPLETAP, dev->fingers == 3);
547         input_report_key(input, BTN_TOOL_QUADTAP, dev->fingers > 3);
548
549         input_report_abs(input, ABS_PRESSURE, abs_p);
550         input_report_abs(input, ABS_TOOL_WIDTH, abs_w);
551
552         if (abs_p) {
553                 input_report_abs(input, ABS_X, abs_x);
554                 input_report_abs(input, ABS_Y, abs_y);
555
556                 dprintk(8,
557                         "bcm5974: abs: p: %+05d w: %+05d x: %+05d y: %+05d "
558                         "nmin: %d nmax: %d n: %d ibt: %d\n", abs_p, abs_w,
559                         abs_x, abs_y, nmin, nmax, dev->fingers, ibt);
560
561         }
562
563         /* type 2 reports button events via ibt only */
564         if (c->tp_type == TYPE2)
565                 input_report_key(input, BTN_LEFT, ibt);
566
567         input_sync(input);
568
569         return 0;
570 }
571
572 /* Wellspring initialization constants */
573 #define BCM5974_WELLSPRING_MODE_READ_REQUEST_ID         1
574 #define BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID        9
575 #define BCM5974_WELLSPRING_MODE_REQUEST_VALUE           0x300
576 #define BCM5974_WELLSPRING_MODE_REQUEST_INDEX           0
577 #define BCM5974_WELLSPRING_MODE_VENDOR_VALUE            0x01
578 #define BCM5974_WELLSPRING_MODE_NORMAL_VALUE            0x08
579
580 static int bcm5974_wellspring_mode(struct bcm5974 *dev, bool on)
581 {
582         char *data = kmalloc(8, GFP_KERNEL);
583         int retval = 0, size;
584
585         if (!data) {
586                 err("bcm5974: out of memory");
587                 retval = -ENOMEM;
588                 goto out;
589         }
590
591         /* read configuration */
592         size = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
593                         BCM5974_WELLSPRING_MODE_READ_REQUEST_ID,
594                         USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
595                         BCM5974_WELLSPRING_MODE_REQUEST_VALUE,
596                         BCM5974_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
597
598         if (size != 8) {
599                 err("bcm5974: could not read from device");
600                 retval = -EIO;
601                 goto out;
602         }
603
604         /* apply the mode switch */
605         data[0] = on ?
606                 BCM5974_WELLSPRING_MODE_VENDOR_VALUE :
607                 BCM5974_WELLSPRING_MODE_NORMAL_VALUE;
608
609         /* write configuration */
610         size = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
611                         BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID,
612                         USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
613                         BCM5974_WELLSPRING_MODE_REQUEST_VALUE,
614                         BCM5974_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
615
616         if (size != 8) {
617                 err("bcm5974: could not write to device");
618                 retval = -EIO;
619                 goto out;
620         }
621
622         dprintk(2, "bcm5974: switched to %s mode.\n",
623                 on ? "wellspring" : "normal");
624
625  out:
626         kfree(data);
627         return retval;
628 }
629
630 static void bcm5974_irq_button(struct urb *urb)
631 {
632         struct bcm5974 *dev = urb->context;
633         int error;
634
635         switch (urb->status) {
636         case 0:
637                 break;
638         case -EOVERFLOW:
639         case -ECONNRESET:
640         case -ENOENT:
641         case -ESHUTDOWN:
642                 dbg("bcm5974: button urb shutting down: %d", urb->status);
643                 return;
644         default:
645                 dbg("bcm5974: button urb status: %d", urb->status);
646                 goto exit;
647         }
648
649         if (report_bt_state(dev, dev->bt_urb->actual_length))
650                 dprintk(1, "bcm5974: bad button package, length: %d\n",
651                         dev->bt_urb->actual_length);
652
653 exit:
654         error = usb_submit_urb(dev->bt_urb, GFP_ATOMIC);
655         if (error)
656                 err("bcm5974: button urb failed: %d", error);
657 }
658
659 static void bcm5974_irq_trackpad(struct urb *urb)
660 {
661         struct bcm5974 *dev = urb->context;
662         int error;
663
664         switch (urb->status) {
665         case 0:
666                 break;
667         case -EOVERFLOW:
668         case -ECONNRESET:
669         case -ENOENT:
670         case -ESHUTDOWN:
671                 dbg("bcm5974: trackpad urb shutting down: %d", urb->status);
672                 return;
673         default:
674                 dbg("bcm5974: trackpad urb status: %d", urb->status);
675                 goto exit;
676         }
677
678         /* control response ignored */
679         if (dev->tp_urb->actual_length == 2)
680                 goto exit;
681
682         if (report_tp_state(dev, dev->tp_urb->actual_length))
683                 dprintk(1, "bcm5974: bad trackpad package, length: %d\n",
684                         dev->tp_urb->actual_length);
685
686 exit:
687         error = usb_submit_urb(dev->tp_urb, GFP_ATOMIC);
688         if (error)
689                 err("bcm5974: trackpad urb failed: %d", error);
690 }
691
692 /*
693  * The Wellspring trackpad, like many recent Apple trackpads, share
694  * the usb device with the keyboard. Since keyboards are usually
695  * handled by the HID system, the device ends up being handled by two
696  * modules. Setting up the device therefore becomes slightly
697  * complicated. To enable multitouch features, a mode switch is
698  * required, which is usually applied via the control interface of the
699  * device.  It can be argued where this switch should take place. In
700  * some drivers, like appletouch, the switch is made during
701  * probe. However, the hid module may also alter the state of the
702  * device, resulting in trackpad malfunction under certain
703  * circumstances. To get around this problem, there is at least one
704  * example that utilizes the USB_QUIRK_RESET_RESUME quirk in order to
705  * receive a reset_resume request rather than the normal resume.
706  * Since the implementation of reset_resume is equal to mode switch
707  * plus start_traffic, it seems easier to always do the switch when
708  * starting traffic on the device.
709  */
710 static int bcm5974_start_traffic(struct bcm5974 *dev)
711 {
712         int error;
713
714         error = bcm5974_wellspring_mode(dev, true);
715         if (error) {
716                 dprintk(1, "bcm5974: mode switch failed\n");
717                 goto err_out;
718         }
719
720         error = usb_submit_urb(dev->bt_urb, GFP_KERNEL);
721         if (error)
722                 goto err_reset_mode;
723
724         error = usb_submit_urb(dev->tp_urb, GFP_KERNEL);
725         if (error)
726                 goto err_kill_bt;
727
728         return 0;
729
730 err_kill_bt:
731         usb_kill_urb(dev->bt_urb);
732 err_reset_mode:
733         bcm5974_wellspring_mode(dev, false);
734 err_out:
735         return error;
736 }
737
738 static void bcm5974_pause_traffic(struct bcm5974 *dev)
739 {
740         usb_kill_urb(dev->tp_urb);
741         usb_kill_urb(dev->bt_urb);
742         bcm5974_wellspring_mode(dev, false);
743 }
744
745 /*
746  * The code below implements open/close and manual suspend/resume.
747  * All functions may be called in random order.
748  *
749  * Opening a suspended device fails with EACCES - permission denied.
750  *
751  * Failing a resume leaves the device resumed but closed.
752  */
753 static int bcm5974_open(struct input_dev *input)
754 {
755         struct bcm5974 *dev = input_get_drvdata(input);
756         int error;
757
758         error = usb_autopm_get_interface(dev->intf);
759         if (error)
760                 return error;
761
762         mutex_lock(&dev->pm_mutex);
763
764         error = bcm5974_start_traffic(dev);
765         if (!error)
766                 dev->opened = 1;
767
768         mutex_unlock(&dev->pm_mutex);
769
770         if (error)
771                 usb_autopm_put_interface(dev->intf);
772
773         return error;
774 }
775
776 static void bcm5974_close(struct input_dev *input)
777 {
778         struct bcm5974 *dev = input_get_drvdata(input);
779
780         mutex_lock(&dev->pm_mutex);
781
782         bcm5974_pause_traffic(dev);
783         dev->opened = 0;
784
785         mutex_unlock(&dev->pm_mutex);
786
787         usb_autopm_put_interface(dev->intf);
788 }
789
790 static int bcm5974_suspend(struct usb_interface *iface, pm_message_t message)
791 {
792         struct bcm5974 *dev = usb_get_intfdata(iface);
793
794         mutex_lock(&dev->pm_mutex);
795
796         if (dev->opened)
797                 bcm5974_pause_traffic(dev);
798
799         mutex_unlock(&dev->pm_mutex);
800
801         return 0;
802 }
803
804 static int bcm5974_resume(struct usb_interface *iface)
805 {
806         struct bcm5974 *dev = usb_get_intfdata(iface);
807         int error = 0;
808
809         mutex_lock(&dev->pm_mutex);
810
811         if (dev->opened)
812                 error = bcm5974_start_traffic(dev);
813
814         mutex_unlock(&dev->pm_mutex);
815
816         return error;
817 }
818
819 static int bcm5974_probe(struct usb_interface *iface,
820                          const struct usb_device_id *id)
821 {
822         struct usb_device *udev = interface_to_usbdev(iface);
823         const struct bcm5974_config *cfg;
824         struct bcm5974 *dev;
825         struct input_dev *input_dev;
826         int error = -ENOMEM;
827
828         /* find the product index */
829         cfg = bcm5974_get_config(udev);
830
831         /* allocate memory for our device state and initialize it */
832         dev = kzalloc(sizeof(struct bcm5974), GFP_KERNEL);
833         input_dev = input_allocate_device();
834         if (!dev || !input_dev) {
835                 err("bcm5974: out of memory");
836                 goto err_free_devs;
837         }
838
839         dev->udev = udev;
840         dev->intf = iface;
841         dev->input = input_dev;
842         dev->cfg = *cfg;
843         mutex_init(&dev->pm_mutex);
844
845         /* setup urbs */
846         dev->bt_urb = usb_alloc_urb(0, GFP_KERNEL);
847         if (!dev->bt_urb)
848                 goto err_free_devs;
849
850         dev->tp_urb = usb_alloc_urb(0, GFP_KERNEL);
851         if (!dev->tp_urb)
852                 goto err_free_bt_urb;
853
854         dev->bt_data = usb_alloc_coherent(dev->udev,
855                                           dev->cfg.bt_datalen, GFP_KERNEL,
856                                           &dev->bt_urb->transfer_dma);
857         if (!dev->bt_data)
858                 goto err_free_urb;
859
860         dev->tp_data = usb_alloc_coherent(dev->udev,
861                                           dev->cfg.tp_datalen, GFP_KERNEL,
862                                           &dev->tp_urb->transfer_dma);
863         if (!dev->tp_data)
864                 goto err_free_bt_buffer;
865
866         usb_fill_int_urb(dev->bt_urb, udev,
867                          usb_rcvintpipe(udev, cfg->bt_ep),
868                          dev->bt_data, dev->cfg.bt_datalen,
869                          bcm5974_irq_button, dev, 1);
870
871         usb_fill_int_urb(dev->tp_urb, udev,
872                          usb_rcvintpipe(udev, cfg->tp_ep),
873                          dev->tp_data, dev->cfg.tp_datalen,
874                          bcm5974_irq_trackpad, dev, 1);
875
876         /* create bcm5974 device */
877         usb_make_path(udev, dev->phys, sizeof(dev->phys));
878         strlcat(dev->phys, "/input0", sizeof(dev->phys));
879
880         input_dev->name = "bcm5974";
881         input_dev->phys = dev->phys;
882         usb_to_input_id(dev->udev, &input_dev->id);
883         /* report driver capabilities via the version field */
884         input_dev->id.version = cfg->caps;
885         input_dev->dev.parent = &iface->dev;
886
887         input_set_drvdata(input_dev, dev);
888
889         input_dev->open = bcm5974_open;
890         input_dev->close = bcm5974_close;
891
892         setup_events_to_report(input_dev, cfg);
893
894         error = input_register_device(dev->input);
895         if (error)
896                 goto err_free_buffer;
897
898         /* save our data pointer in this interface device */
899         usb_set_intfdata(iface, dev);
900
901         return 0;
902
903 err_free_buffer:
904         usb_free_coherent(dev->udev, dev->cfg.tp_datalen,
905                 dev->tp_data, dev->tp_urb->transfer_dma);
906 err_free_bt_buffer:
907         usb_free_coherent(dev->udev, dev->cfg.bt_datalen,
908                 dev->bt_data, dev->bt_urb->transfer_dma);
909 err_free_urb:
910         usb_free_urb(dev->tp_urb);
911 err_free_bt_urb:
912         usb_free_urb(dev->bt_urb);
913 err_free_devs:
914         usb_set_intfdata(iface, NULL);
915         input_free_device(input_dev);
916         kfree(dev);
917         return error;
918 }
919
920 static void bcm5974_disconnect(struct usb_interface *iface)
921 {
922         struct bcm5974 *dev = usb_get_intfdata(iface);
923
924         usb_set_intfdata(iface, NULL);
925
926         input_unregister_device(dev->input);
927         usb_free_coherent(dev->udev, dev->cfg.tp_datalen,
928                           dev->tp_data, dev->tp_urb->transfer_dma);
929         usb_free_coherent(dev->udev, dev->cfg.bt_datalen,
930                           dev->bt_data, dev->bt_urb->transfer_dma);
931         usb_free_urb(dev->tp_urb);
932         usb_free_urb(dev->bt_urb);
933         kfree(dev);
934 }
935
936 static struct usb_driver bcm5974_driver = {
937         .name                   = "bcm5974",
938         .probe                  = bcm5974_probe,
939         .disconnect             = bcm5974_disconnect,
940         .suspend                = bcm5974_suspend,
941         .resume                 = bcm5974_resume,
942         .id_table               = bcm5974_table,
943         .supports_autosuspend   = 1,
944 };
945
946 module_usb_driver(bcm5974_driver);