2 * Apple USB BCM5974 (Macbook Air and Penryn Macbook Pro) multitouch driver
4 * Copyright (C) 2008 Henrik Rydberg (rydberg@euromail.se)
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)
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)
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.
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.
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.
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>
44 #define USB_VENDOR_ID_APPLE 0x05ac
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
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 \
65 /* table of devices that work with this driver */
66 static const struct usb_device_id bcm5974_table
[] = {
68 BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ANSI
),
69 BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ISO
),
70 BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_JIS
),
71 /* MacbookProPenryn */
72 BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI
),
73 BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ISO
),
74 BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_JIS
),
75 /* Terminating entry */
78 MODULE_DEVICE_TABLE(usb
, bcm5974_table
);
80 MODULE_AUTHOR("Henrik Rydberg");
81 MODULE_DESCRIPTION("Apple USB BCM5974 multitouch driver");
82 MODULE_LICENSE("GPL");
84 #define dprintk(level, format, a...)\
85 { if (debug >= level) printk(KERN_DEBUG format, ##a); }
88 module_param(debug
, int, 0644);
89 MODULE_PARM_DESC(debug
, "Activate debugging output");
91 /* button data structure */
93 u8 unknown1
; /* constant */
94 u8 button
; /* left button */
95 u8 rel_x
; /* relative x coordinate */
96 u8 rel_y
; /* relative y coordinate */
99 /* trackpad header structure */
101 u8 unknown1
[16]; /* constants, timers, etc */
102 u8 fingers
; /* number of fingers on trackpad */
103 u8 unknown2
[9]; /* constants, timers, etc */
106 /* trackpad finger structure */
108 __le16 origin
; /* left/right origin? */
109 __le16 abs_x
; /* absolute x coodinate */
110 __le16 abs_y
; /* absolute y coodinate */
111 __le16 rel_x
; /* relative x coodinate */
112 __le16 rel_y
; /* relative y coodinate */
113 __le16 size_major
; /* finger size, major axis? */
114 __le16 size_minor
; /* finger size, minor axis? */
115 __le16 orientation
; /* 16384 when point, else 15 bit angle */
116 __le16 force_major
; /* trackpad force, major axis? */
117 __le16 force_minor
; /* trackpad force, minor axis? */
118 __le16 unused
[3]; /* zeros */
119 __le16 multi
; /* one finger: varies, more fingers: constant */
122 /* trackpad data structure, empirically at least ten fingers */
124 struct tp_header header
;
125 struct tp_finger finger
[16];
128 /* device-specific parameters */
129 struct bcm5974_param
{
130 int dim
; /* logical dimension */
131 int fuzz
; /* logical noise value */
132 int devmin
; /* device minimum reading */
133 int devmax
; /* device maximum reading */
136 /* device-specific configuration */
137 struct bcm5974_config
{
138 int ansi
, iso
, jis
; /* the product id of this device */
139 int bt_ep
; /* the endpoint of the button interface */
140 int bt_datalen
; /* data length of the button interface */
141 int tp_ep
; /* the endpoint of the trackpad interface */
142 int tp_datalen
; /* data length of the trackpad interface */
143 struct bcm5974_param p
; /* finger pressure limits */
144 struct bcm5974_param w
; /* finger width limits */
145 struct bcm5974_param x
; /* horizontal limits */
146 struct bcm5974_param y
; /* vertical limits */
149 /* logical device structure */
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 struct tp_data
*tp_data
; /* trackpad transferred data */
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 */
170 /* logical signal quality */
171 #define SN_PRESSURE 45 /* pressure signal-to-noise ratio */
172 #define SN_WIDTH 100 /* width signal-to-noise ratio */
173 #define SN_COORD 250 /* coordinate signal-to-noise ratio */
175 /* device constants */
176 static const struct bcm5974_config bcm5974_config_table
[] = {
178 USB_DEVICE_ID_APPLE_WELLSPRING_ANSI
,
179 USB_DEVICE_ID_APPLE_WELLSPRING_ISO
,
180 USB_DEVICE_ID_APPLE_WELLSPRING_JIS
,
181 0x84, sizeof(struct bt_data
),
182 0x81, sizeof(struct tp_data
),
183 { DIM_PRESSURE
, DIM_PRESSURE
/ SN_PRESSURE
, 0, 256 },
184 { DIM_WIDTH
, DIM_WIDTH
/ SN_WIDTH
, 0, 2048 },
185 { DIM_X
, DIM_X
/ SN_COORD
, -4824, 5342 },
186 { DIM_Y
, DIM_Y
/ SN_COORD
, -172, 5820 }
189 USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI
,
190 USB_DEVICE_ID_APPLE_WELLSPRING2_ISO
,
191 USB_DEVICE_ID_APPLE_WELLSPRING2_JIS
,
192 0x84, sizeof(struct bt_data
),
193 0x81, sizeof(struct tp_data
),
194 { DIM_PRESSURE
, DIM_PRESSURE
/ SN_PRESSURE
, 0, 256 },
195 { DIM_WIDTH
, DIM_WIDTH
/ SN_WIDTH
, 0, 2048 },
196 { DIM_X
, DIM_X
/ SN_COORD
, -4824, 4824 },
197 { DIM_Y
, DIM_Y
/ SN_COORD
, -172, 4290 }
202 /* return the device-specific configuration by device */
203 static const struct bcm5974_config
*bcm5974_get_config(struct usb_device
*udev
)
205 u16 id
= le16_to_cpu(udev
->descriptor
.idProduct
);
206 const struct bcm5974_config
*cfg
;
208 for (cfg
= bcm5974_config_table
; cfg
->ansi
; ++cfg
)
209 if (cfg
->ansi
== id
|| cfg
->iso
== id
|| cfg
->jis
== id
)
212 return bcm5974_config_table
;
215 /* convert 16-bit little endian to signed integer */
216 static inline int raw2int(__le16 x
)
218 return (signed short)le16_to_cpu(x
);
221 /* scale device data to logical dimensions (asserts devmin < devmax) */
222 static inline int int2scale(const struct bcm5974_param
*p
, int x
)
224 return x
* p
->dim
/ (p
->devmax
- p
->devmin
);
227 /* all logical value ranges are [0,dim). */
228 static inline int int2bound(const struct bcm5974_param
*p
, int x
)
230 int s
= int2scale(p
, x
);
232 return clamp_val(s
, 0, p
->dim
- 1);
235 /* setup which logical events to report */
236 static void setup_events_to_report(struct input_dev
*input_dev
,
237 const struct bcm5974_config
*cfg
)
239 __set_bit(EV_ABS
, input_dev
->evbit
);
241 input_set_abs_params(input_dev
, ABS_PRESSURE
,
242 0, cfg
->p
.dim
, cfg
->p
.fuzz
, 0);
243 input_set_abs_params(input_dev
, ABS_TOOL_WIDTH
,
244 0, cfg
->w
.dim
, cfg
->w
.fuzz
, 0);
245 input_set_abs_params(input_dev
, ABS_X
,
246 0, cfg
->x
.dim
, cfg
->x
.fuzz
, 0);
247 input_set_abs_params(input_dev
, ABS_Y
,
248 0, cfg
->y
.dim
, cfg
->y
.fuzz
, 0);
250 __set_bit(EV_KEY
, input_dev
->evbit
);
251 __set_bit(BTN_TOOL_FINGER
, input_dev
->keybit
);
252 __set_bit(BTN_TOOL_DOUBLETAP
, input_dev
->keybit
);
253 __set_bit(BTN_TOOL_TRIPLETAP
, input_dev
->keybit
);
254 __set_bit(BTN_LEFT
, input_dev
->keybit
);
257 /* report button data as logical button state */
258 static int report_bt_state(struct bcm5974
*dev
, int size
)
260 if (size
!= sizeof(struct bt_data
))
263 input_report_key(dev
->input
, BTN_LEFT
, dev
->bt_data
->button
);
264 input_sync(dev
->input
);
269 /* report trackpad data as logical trackpad state */
270 static int report_tp_state(struct bcm5974
*dev
, int size
)
272 const struct bcm5974_config
*c
= &dev
->cfg
;
273 const struct tp_finger
*f
= dev
->tp_data
->finger
;
274 struct input_dev
*input
= dev
->input
;
275 const int fingers
= (size
- 26) / 28;
276 int p
= 0, w
, x
, y
, n
= 0;
278 if (size
< 26 || (size
- 26) % 28 != 0)
282 p
= raw2int(f
->force_major
);
283 w
= raw2int(f
->size_major
);
284 x
= raw2int(f
->abs_x
);
285 y
= raw2int(f
->abs_y
);
286 n
= p
> 0 ? fingers
: 0;
289 "bcm5974: p: %+05d w: %+05d x: %+05d y: %+05d n: %d\n",
292 input_report_abs(input
, ABS_TOOL_WIDTH
, int2bound(&c
->w
, w
));
293 input_report_abs(input
, ABS_X
, int2bound(&c
->x
, x
- c
->x
.devmin
));
294 input_report_abs(input
, ABS_Y
, int2bound(&c
->y
, c
->y
.devmax
- y
));
297 input_report_abs(input
, ABS_PRESSURE
, int2bound(&c
->p
, p
));
299 input_report_key(input
, BTN_TOOL_FINGER
, n
== 1);
300 input_report_key(input
, BTN_TOOL_DOUBLETAP
, n
== 2);
301 input_report_key(input
, BTN_TOOL_TRIPLETAP
, n
> 2);
308 /* Wellspring initialization constants */
309 #define BCM5974_WELLSPRING_MODE_READ_REQUEST_ID 1
310 #define BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID 9
311 #define BCM5974_WELLSPRING_MODE_REQUEST_VALUE 0x300
312 #define BCM5974_WELLSPRING_MODE_REQUEST_INDEX 0
313 #define BCM5974_WELLSPRING_MODE_VENDOR_VALUE 0x01
315 static int bcm5974_wellspring_mode(struct bcm5974
*dev
)
317 char *data
= kmalloc(8, GFP_KERNEL
);
318 int retval
= 0, size
;
321 err("bcm5974: out of memory");
326 /* read configuration */
327 size
= usb_control_msg(dev
->udev
, usb_rcvctrlpipe(dev
->udev
, 0),
328 BCM5974_WELLSPRING_MODE_READ_REQUEST_ID
,
329 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
330 BCM5974_WELLSPRING_MODE_REQUEST_VALUE
,
331 BCM5974_WELLSPRING_MODE_REQUEST_INDEX
, data
, 8, 5000);
334 err("bcm5974: could not read from device");
339 /* apply the mode switch */
340 data
[0] = BCM5974_WELLSPRING_MODE_VENDOR_VALUE
;
342 /* write configuration */
343 size
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, 0),
344 BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID
,
345 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
346 BCM5974_WELLSPRING_MODE_REQUEST_VALUE
,
347 BCM5974_WELLSPRING_MODE_REQUEST_INDEX
, data
, 8, 5000);
350 err("bcm5974: could not write to device");
355 dprintk(2, "bcm5974: switched to wellspring mode.\n");
362 static void bcm5974_irq_button(struct urb
*urb
)
364 struct bcm5974
*dev
= urb
->context
;
367 switch (urb
->status
) {
374 dbg("bcm5974: button urb shutting down: %d", urb
->status
);
377 dbg("bcm5974: button urb status: %d", urb
->status
);
381 if (report_bt_state(dev
, dev
->bt_urb
->actual_length
))
382 dprintk(1, "bcm5974: bad button package, length: %d\n",
383 dev
->bt_urb
->actual_length
);
386 error
= usb_submit_urb(dev
->bt_urb
, GFP_ATOMIC
);
388 err("bcm5974: button urb failed: %d", error
);
391 static void bcm5974_irq_trackpad(struct urb
*urb
)
393 struct bcm5974
*dev
= urb
->context
;
396 switch (urb
->status
) {
403 dbg("bcm5974: trackpad urb shutting down: %d", urb
->status
);
406 dbg("bcm5974: trackpad urb status: %d", urb
->status
);
410 /* control response ignored */
411 if (dev
->tp_urb
->actual_length
== 2)
414 if (report_tp_state(dev
, dev
->tp_urb
->actual_length
))
415 dprintk(1, "bcm5974: bad trackpad package, length: %d\n",
416 dev
->tp_urb
->actual_length
);
419 error
= usb_submit_urb(dev
->tp_urb
, GFP_ATOMIC
);
421 err("bcm5974: trackpad urb failed: %d", error
);
425 * The Wellspring trackpad, like many recent Apple trackpads, share
426 * the usb device with the keyboard. Since keyboards are usually
427 * handled by the HID system, the device ends up being handled by two
428 * modules. Setting up the device therefore becomes slightly
429 * complicated. To enable multitouch features, a mode switch is
430 * required, which is usually applied via the control interface of the
431 * device. It can be argued where this switch should take place. In
432 * some drivers, like appletouch, the switch is made during
433 * probe. However, the hid module may also alter the state of the
434 * device, resulting in trackpad malfunction under certain
435 * circumstances. To get around this problem, there is at least one
436 * example that utilizes the USB_QUIRK_RESET_RESUME quirk in order to
437 * recieve a reset_resume request rather than the normal resume.
438 * Since the implementation of reset_resume is equal to mode switch
439 * plus start_traffic, it seems easier to always do the switch when
440 * starting traffic on the device.
442 static int bcm5974_start_traffic(struct bcm5974
*dev
)
444 if (bcm5974_wellspring_mode(dev
)) {
445 dprintk(1, "bcm5974: mode switch failed\n");
449 if (usb_submit_urb(dev
->bt_urb
, GFP_KERNEL
))
452 if (usb_submit_urb(dev
->tp_urb
, GFP_KERNEL
))
458 usb_kill_urb(dev
->bt_urb
);
463 static void bcm5974_pause_traffic(struct bcm5974
*dev
)
465 usb_kill_urb(dev
->tp_urb
);
466 usb_kill_urb(dev
->bt_urb
);
470 * The code below implements open/close and manual suspend/resume.
471 * All functions may be called in random order.
473 * Opening a suspended device fails with EACCES - permission denied.
475 * Failing a resume leaves the device resumed but closed.
477 static int bcm5974_open(struct input_dev
*input
)
479 struct bcm5974
*dev
= input_get_drvdata(input
);
482 error
= usb_autopm_get_interface(dev
->intf
);
486 mutex_lock(&dev
->pm_mutex
);
488 error
= bcm5974_start_traffic(dev
);
492 mutex_unlock(&dev
->pm_mutex
);
495 usb_autopm_put_interface(dev
->intf
);
500 static void bcm5974_close(struct input_dev
*input
)
502 struct bcm5974
*dev
= input_get_drvdata(input
);
504 mutex_lock(&dev
->pm_mutex
);
506 bcm5974_pause_traffic(dev
);
509 mutex_unlock(&dev
->pm_mutex
);
511 usb_autopm_put_interface(dev
->intf
);
514 static int bcm5974_suspend(struct usb_interface
*iface
, pm_message_t message
)
516 struct bcm5974
*dev
= usb_get_intfdata(iface
);
518 mutex_lock(&dev
->pm_mutex
);
521 bcm5974_pause_traffic(dev
);
523 mutex_unlock(&dev
->pm_mutex
);
528 static int bcm5974_resume(struct usb_interface
*iface
)
530 struct bcm5974
*dev
= usb_get_intfdata(iface
);
533 mutex_lock(&dev
->pm_mutex
);
536 error
= bcm5974_start_traffic(dev
);
538 mutex_unlock(&dev
->pm_mutex
);
543 static int bcm5974_probe(struct usb_interface
*iface
,
544 const struct usb_device_id
*id
)
546 struct usb_device
*udev
= interface_to_usbdev(iface
);
547 const struct bcm5974_config
*cfg
;
549 struct input_dev
*input_dev
;
552 /* find the product index */
553 cfg
= bcm5974_get_config(udev
);
555 /* allocate memory for our device state and initialize it */
556 dev
= kzalloc(sizeof(struct bcm5974
), GFP_KERNEL
);
557 input_dev
= input_allocate_device();
558 if (!dev
|| !input_dev
) {
559 err("bcm5974: out of memory");
565 dev
->input
= input_dev
;
567 mutex_init(&dev
->pm_mutex
);
570 dev
->bt_urb
= usb_alloc_urb(0, GFP_KERNEL
);
574 dev
->tp_urb
= usb_alloc_urb(0, GFP_KERNEL
);
576 goto err_free_bt_urb
;
578 dev
->bt_data
= usb_buffer_alloc(dev
->udev
,
579 dev
->cfg
.bt_datalen
, GFP_KERNEL
,
580 &dev
->bt_urb
->transfer_dma
);
584 dev
->tp_data
= usb_buffer_alloc(dev
->udev
,
585 dev
->cfg
.tp_datalen
, GFP_KERNEL
,
586 &dev
->tp_urb
->transfer_dma
);
588 goto err_free_bt_buffer
;
590 usb_fill_int_urb(dev
->bt_urb
, udev
,
591 usb_rcvintpipe(udev
, cfg
->bt_ep
),
592 dev
->bt_data
, dev
->cfg
.bt_datalen
,
593 bcm5974_irq_button
, dev
, 1);
595 usb_fill_int_urb(dev
->tp_urb
, udev
,
596 usb_rcvintpipe(udev
, cfg
->tp_ep
),
597 dev
->tp_data
, dev
->cfg
.tp_datalen
,
598 bcm5974_irq_trackpad
, dev
, 1);
600 /* create bcm5974 device */
601 usb_make_path(udev
, dev
->phys
, sizeof(dev
->phys
));
602 strlcat(dev
->phys
, "/input0", sizeof(dev
->phys
));
604 input_dev
->name
= "bcm5974";
605 input_dev
->phys
= dev
->phys
;
606 usb_to_input_id(dev
->udev
, &input_dev
->id
);
607 input_dev
->dev
.parent
= &iface
->dev
;
609 input_set_drvdata(input_dev
, dev
);
611 input_dev
->open
= bcm5974_open
;
612 input_dev
->close
= bcm5974_close
;
614 setup_events_to_report(input_dev
, cfg
);
616 error
= input_register_device(dev
->input
);
618 goto err_free_buffer
;
620 /* save our data pointer in this interface device */
621 usb_set_intfdata(iface
, dev
);
626 usb_buffer_free(dev
->udev
, dev
->cfg
.tp_datalen
,
627 dev
->tp_data
, dev
->tp_urb
->transfer_dma
);
629 usb_buffer_free(dev
->udev
, dev
->cfg
.bt_datalen
,
630 dev
->bt_data
, dev
->bt_urb
->transfer_dma
);
632 usb_free_urb(dev
->tp_urb
);
634 usb_free_urb(dev
->bt_urb
);
636 usb_set_intfdata(iface
, NULL
);
637 input_free_device(input_dev
);
642 static void bcm5974_disconnect(struct usb_interface
*iface
)
644 struct bcm5974
*dev
= usb_get_intfdata(iface
);
646 usb_set_intfdata(iface
, NULL
);
648 input_unregister_device(dev
->input
);
649 usb_buffer_free(dev
->udev
, dev
->cfg
.tp_datalen
,
650 dev
->tp_data
, dev
->tp_urb
->transfer_dma
);
651 usb_buffer_free(dev
->udev
, dev
->cfg
.bt_datalen
,
652 dev
->bt_data
, dev
->bt_urb
->transfer_dma
);
653 usb_free_urb(dev
->tp_urb
);
654 usb_free_urb(dev
->bt_urb
);
658 static struct usb_driver bcm5974_driver
= {
660 .probe
= bcm5974_probe
,
661 .disconnect
= bcm5974_disconnect
,
662 .suspend
= bcm5974_suspend
,
663 .resume
= bcm5974_resume
,
664 .reset_resume
= bcm5974_resume
,
665 .id_table
= bcm5974_table
,
666 .supports_autosuspend
= 1,
669 static int __init
bcm5974_init(void)
671 return usb_register(&bcm5974_driver
);
674 static void __exit
bcm5974_exit(void)
676 usb_deregister(&bcm5974_driver
);
679 module_init(bcm5974_init
);
680 module_exit(bcm5974_exit
);