2 * Apple USB Touchpad (for post-February 2005 PowerBooks and MacBooks) driver
4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2005 Johannes Berg (johannes@sipsolutions.net)
6 * Copyright (C) 2005 Stelian Pop (stelian@popies.net)
7 * Copyright (C) 2005 Frank Arnold (frank@scirocco-5v-turbo.de)
8 * Copyright (C) 2005 Peter Osterlund (petero2@telia.com)
9 * Copyright (C) 2005 Michael Hanselmann (linux-kernel@hansmi.ch)
10 * Copyright (C) 2006 Nicolas Boichat (nicolas@boichat.ch)
12 * Thanks to Alex Harper <basilisk@foobox.net> for his inputs.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 #include <linux/kernel.h>
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/slab.h>
34 #include <linux/module.h>
35 #include <linux/usb/input.h>
37 /* Apple has powerbooks which have the keyboard with different Product IDs */
38 #define APPLE_VENDOR_ID 0x05AC
40 /* These names come from Info.plist in AppleUSBTrackpad.kext */
41 #define GEYSER_ANSI_PRODUCT_ID 0x0214
42 #define GEYSER_ISO_PRODUCT_ID 0x0215
43 #define GEYSER_JIS_PRODUCT_ID 0x0216
46 #define GEYSER3_ANSI_PRODUCT_ID 0x0217
47 #define GEYSER3_ISO_PRODUCT_ID 0x0218
48 #define GEYSER3_JIS_PRODUCT_ID 0x0219
50 #define ATP_DEVICE(prod) \
51 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
52 USB_DEVICE_ID_MATCH_INT_CLASS | \
53 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
54 .idVendor = APPLE_VENDOR_ID, \
55 .idProduct = (prod), \
56 .bInterfaceClass = 0x03, \
57 .bInterfaceProtocol = 0x02
59 /* table of devices that work with this driver */
60 static struct usb_device_id atp_table
[] = {
61 { ATP_DEVICE(0x020E) },
62 { ATP_DEVICE(0x020F) },
63 { ATP_DEVICE(0x030A) },
64 { ATP_DEVICE(0x030B) },
66 /* PowerBooks Oct 2005 */
67 { ATP_DEVICE(GEYSER_ANSI_PRODUCT_ID
) },
68 { ATP_DEVICE(GEYSER_ISO_PRODUCT_ID
) },
69 { ATP_DEVICE(GEYSER_JIS_PRODUCT_ID
) },
71 { ATP_DEVICE(GEYSER3_ANSI_PRODUCT_ID
) },
72 { ATP_DEVICE(GEYSER3_ISO_PRODUCT_ID
) },
73 { ATP_DEVICE(GEYSER3_JIS_PRODUCT_ID
) },
75 /* Terminating entry */
78 MODULE_DEVICE_TABLE (usb
, atp_table
);
81 * number of sensors. Note that only 16 instead of 26 X (horizontal)
82 * sensors exist on 12" and 15" PowerBooks. All models have 16 Y
85 #define ATP_XSENSORS 26
86 #define ATP_YSENSORS 16
88 /* amount of fuzz this touchpad generates */
91 /* maximum pressure this driver will report */
92 #define ATP_PRESSURE 300
94 * multiplication factor for the X and Y coordinates.
95 * We try to keep the touchpad aspect ratio while still doing only simple
97 * The factors below give coordinates like:
98 * 0 <= x < 960 on 12" and 15" Powerbooks
99 * 0 <= x < 1600 on 17" Powerbooks
106 * Threshold for the touchpad sensors. Any change less than ATP_THRESHOLD is
109 #define ATP_THRESHOLD 5
111 /* MacBook Pro (Geyser 3) initialization constants */
112 #define ATP_GEYSER3_MODE_READ_REQUEST_ID 1
113 #define ATP_GEYSER3_MODE_WRITE_REQUEST_ID 9
114 #define ATP_GEYSER3_MODE_REQUEST_VALUE 0x300
115 #define ATP_GEYSER3_MODE_REQUEST_INDEX 0
116 #define ATP_GEYSER3_MODE_VENDOR_VALUE 0x04
118 /* Structure to hold all of our device specific stuff */
121 struct usb_device
* udev
; /* usb device */
122 struct urb
* urb
; /* usb request block */
123 signed char * data
; /* transferred data */
124 int open
; /* non-zero if opened */
125 struct input_dev
*input
; /* input dev */
126 int valid
; /* are the sensors valid ? */
127 int x_old
; /* last reported x/y, */
128 int y_old
; /* used for smoothing */
129 /* current value of the sensors */
130 signed char xy_cur
[ATP_XSENSORS
+ ATP_YSENSORS
];
131 /* last value of the sensors */
132 signed char xy_old
[ATP_XSENSORS
+ ATP_YSENSORS
];
133 /* accumulated sensors */
134 int xy_acc
[ATP_XSENSORS
+ ATP_YSENSORS
];
135 int overflowwarn
; /* overflow warning printed? */
136 int datalen
; /* size of an USB urb transfer */
139 #define dbg_dump(msg, tab) \
142 printk("appletouch: %s %lld", msg, (long long)jiffies); \
143 for (i = 0; i < ATP_XSENSORS + ATP_YSENSORS; i++) \
144 printk(" %02x", tab[i]); \
148 #define dprintk(format, a...) \
150 if (debug) printk(format, ##a); \
153 MODULE_AUTHOR("Johannes Berg, Stelian Pop, Frank Arnold, Michael Hanselmann");
154 MODULE_DESCRIPTION("Apple PowerBooks USB touchpad driver");
155 MODULE_LICENSE("GPL");
157 static int debug
= 1;
158 module_param(debug
, int, 0644);
159 MODULE_PARM_DESC(debug
, "Activate debugging output");
161 /* Checks if the device a Geyser 2 (ANSI, ISO, JIS) */
162 static inline int atp_is_geyser_2(struct atp
*dev
)
164 u16 productId
= le16_to_cpu(dev
->udev
->descriptor
.idProduct
);
166 return (productId
== GEYSER_ANSI_PRODUCT_ID
) ||
167 (productId
== GEYSER_ISO_PRODUCT_ID
) ||
168 (productId
== GEYSER_JIS_PRODUCT_ID
);
171 static inline int atp_is_geyser_3(struct atp
*dev
)
173 u16 productId
= le16_to_cpu(dev
->udev
->descriptor
.idProduct
);
175 return (productId
== GEYSER3_ANSI_PRODUCT_ID
) ||
176 (productId
== GEYSER3_ISO_PRODUCT_ID
) ||
177 (productId
== GEYSER3_JIS_PRODUCT_ID
);
180 static int atp_calculate_abs(int *xy_sensors
, int nb_sensors
, int fact
,
181 int *z
, int *fingers
)
184 /* values to calculate mean */
185 int pcum
= 0, psum
= 0;
189 for (i
= 0; i
< nb_sensors
; i
++) {
190 if (xy_sensors
[i
] < ATP_THRESHOLD
)
192 if ((i
- 1 < 0) || (xy_sensors
[i
- 1] < ATP_THRESHOLD
))
194 pcum
+= xy_sensors
[i
] * i
;
195 psum
+= xy_sensors
[i
];
200 return pcum
* fact
/ psum
;
206 static inline void atp_report_fingers(struct input_dev
*input
, int fingers
)
208 input_report_key(input
, BTN_TOOL_FINGER
, fingers
== 1);
209 input_report_key(input
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
210 input_report_key(input
, BTN_TOOL_TRIPLETAP
, fingers
> 2);
213 static void atp_complete(struct urb
* urb
, struct pt_regs
* regs
)
215 int x
, y
, x_z
, y_z
, x_f
, y_f
;
217 struct atp
*dev
= urb
->context
;
219 switch (urb
->status
) {
224 if(!dev
->overflowwarn
) {
225 printk("appletouch: OVERFLOW with data "
226 "length %d, actual length is %d\n",
227 dev
->datalen
, dev
->urb
->actual_length
);
228 dev
->overflowwarn
= 1;
233 /* This urb is terminated, clean up */
234 dbg("%s - urb shutting down with status: %d",
235 __FUNCTION__
, urb
->status
);
238 dbg("%s - nonzero urb status received: %d",
239 __FUNCTION__
, urb
->status
);
243 /* drop incomplete datasets */
244 if (dev
->urb
->actual_length
!= dev
->datalen
) {
245 dprintk("appletouch: incomplete data package"
246 " (first byte: %d, length: %d).\n",
247 dev
->data
[0], dev
->urb
->actual_length
);
251 /* reorder the sensors values */
252 if (atp_is_geyser_3(dev
)) {
253 memset(dev
->xy_cur
, 0, sizeof(dev
->xy_cur
));
256 * The values are laid out like this:
257 * -, Y1, Y2, -, Y3, Y4, -, ..., -, X1, X2, -, X3, X4, ...
258 * '-' is an unused value.
262 for (i
= 0, j
= 19; i
< 20; i
+= 2, j
+= 3) {
263 dev
->xy_cur
[i
] = dev
->data
[j
+ 1];
264 dev
->xy_cur
[i
+ 1] = dev
->data
[j
+ 2];
267 for (i
= 0, j
= 1; i
< 9; i
+= 2, j
+= 3) {
268 dev
->xy_cur
[ATP_XSENSORS
+ i
] = dev
->data
[j
+ 1];
269 dev
->xy_cur
[ATP_XSENSORS
+ i
+ 1] = dev
->data
[j
+ 2];
271 } else if (atp_is_geyser_2(dev
)) {
272 memset(dev
->xy_cur
, 0, sizeof(dev
->xy_cur
));
275 * The values are laid out like this:
276 * Y1, Y2, -, Y3, Y4, -, ..., X1, X2, -, X3, X4, -, ...
277 * '-' is an unused value.
281 for (i
= 0, j
= 19; i
< 20; i
+= 2, j
+= 3) {
282 dev
->xy_cur
[i
] = dev
->data
[j
];
283 dev
->xy_cur
[i
+ 1] = dev
->data
[j
+ 1];
287 for (i
= 0, j
= 1; i
< 9; i
+= 2, j
+= 3) {
288 dev
->xy_cur
[ATP_XSENSORS
+ i
] = dev
->data
[j
];
289 dev
->xy_cur
[ATP_XSENSORS
+ i
+ 1] = dev
->data
[j
+ 1];
292 for (i
= 0; i
< 8; i
++) {
294 dev
->xy_cur
[i
] = dev
->data
[5 * i
+ 2];
295 dev
->xy_cur
[i
+ 8] = dev
->data
[5 * i
+ 4];
296 dev
->xy_cur
[i
+ 16] = dev
->data
[5 * i
+ 42];
298 dev
->xy_cur
[i
+ 24] = dev
->data
[5 * i
+ 44];
301 dev
->xy_cur
[i
+ 26] = dev
->data
[5 * i
+ 1];
302 dev
->xy_cur
[i
+ 34] = dev
->data
[5 * i
+ 3];
306 dbg_dump("sample", dev
->xy_cur
);
311 dev
->x_old
= dev
->y_old
= -1;
312 memcpy(dev
->xy_old
, dev
->xy_cur
, sizeof(dev
->xy_old
));
314 if (atp_is_geyser_3(dev
)) /* No 17" Macbooks (yet) */
317 /* 17" Powerbooks have extra X sensors */
318 for (i
= (atp_is_geyser_2(dev
)?15:16); i
< ATP_XSENSORS
; i
++) {
319 if (!dev
->xy_cur
[i
]) continue;
321 printk("appletouch: 17\" model detected.\n");
322 if(atp_is_geyser_2(dev
))
323 input_set_abs_params(dev
->input
, ABS_X
, 0,
328 input_set_abs_params(dev
->input
, ABS_X
, 0,
339 for (i
= 0; i
< ATP_XSENSORS
+ ATP_YSENSORS
; i
++) {
340 /* accumulate the change */
341 signed char change
= dev
->xy_old
[i
] - dev
->xy_cur
[i
];
342 dev
->xy_acc
[i
] -= change
;
344 /* prevent down drifting */
345 if (dev
->xy_acc
[i
] < 0)
349 memcpy(dev
->xy_old
, dev
->xy_cur
, sizeof(dev
->xy_old
));
351 dbg_dump("accumulator", dev
->xy_acc
);
353 x
= atp_calculate_abs(dev
->xy_acc
, ATP_XSENSORS
,
354 ATP_XFACT
, &x_z
, &x_f
);
355 y
= atp_calculate_abs(dev
->xy_acc
+ ATP_XSENSORS
, ATP_YSENSORS
,
356 ATP_YFACT
, &y_z
, &y_f
);
359 if (dev
->x_old
!= -1) {
360 x
= (dev
->x_old
* 3 + x
) >> 2;
361 y
= (dev
->y_old
* 3 + y
) >> 2;
366 printk("appletouch: X: %3d Y: %3d "
370 input_report_key(dev
->input
, BTN_TOUCH
, 1);
371 input_report_abs(dev
->input
, ABS_X
, x
);
372 input_report_abs(dev
->input
, ABS_Y
, y
);
373 input_report_abs(dev
->input
, ABS_PRESSURE
,
374 min(ATP_PRESSURE
, x_z
+ y_z
));
375 atp_report_fingers(dev
->input
, max(x_f
, y_f
));
382 dev
->x_old
= dev
->y_old
= -1;
383 input_report_key(dev
->input
, BTN_TOUCH
, 0);
384 input_report_abs(dev
->input
, ABS_PRESSURE
, 0);
385 atp_report_fingers(dev
->input
, 0);
387 /* reset the accumulator on release */
388 memset(dev
->xy_acc
, 0, sizeof(dev
->xy_acc
));
391 input_report_key(dev
->input
, BTN_LEFT
,
392 !!dev
->data
[dev
->datalen
- 1]);
394 input_sync(dev
->input
);
397 retval
= usb_submit_urb(dev
->urb
, GFP_ATOMIC
);
399 err("%s - usb_submit_urb failed with result %d",
400 __FUNCTION__
, retval
);
404 static int atp_open(struct input_dev
*input
)
406 struct atp
*dev
= input
->private;
408 if (usb_submit_urb(dev
->urb
, GFP_ATOMIC
))
415 static void atp_close(struct input_dev
*input
)
417 struct atp
*dev
= input
->private;
419 usb_kill_urb(dev
->urb
);
423 static int atp_probe(struct usb_interface
*iface
, const struct usb_device_id
*id
)
426 struct input_dev
*input_dev
;
427 struct usb_device
*udev
= interface_to_usbdev(iface
);
428 struct usb_host_interface
*iface_desc
;
429 struct usb_endpoint_descriptor
*endpoint
;
430 int int_in_endpointAddr
= 0;
431 int i
, retval
= -ENOMEM
;
434 /* set up the endpoint information */
435 /* use only the first interrupt-in endpoint */
436 iface_desc
= iface
->cur_altsetting
;
437 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; i
++) {
438 endpoint
= &iface_desc
->endpoint
[i
].desc
;
439 if (!int_in_endpointAddr
&& usb_endpoint_is_int_in(endpoint
)) {
440 /* we found an interrupt in endpoint */
441 int_in_endpointAddr
= endpoint
->bEndpointAddress
;
445 if (!int_in_endpointAddr
) {
446 err("Could not find int-in endpoint");
450 /* allocate memory for our device state and initialize it */
451 dev
= kzalloc(sizeof(struct atp
), GFP_KERNEL
);
452 input_dev
= input_allocate_device();
453 if (!dev
|| !input_dev
) {
454 err("Out of memory");
459 dev
->input
= input_dev
;
460 dev
->overflowwarn
= 0;
461 if (atp_is_geyser_3(dev
))
463 else if (atp_is_geyser_2(dev
))
468 if (atp_is_geyser_3(dev
)) {
470 * By default Geyser 3 device sends standard USB HID mouse
471 * packets (Report ID 2). This code changes device mode, so it
472 * sends raw sensor reports (Report ID 5).
477 size
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
478 ATP_GEYSER3_MODE_READ_REQUEST_ID
,
479 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
480 ATP_GEYSER3_MODE_REQUEST_VALUE
,
481 ATP_GEYSER3_MODE_REQUEST_INDEX
, &data
, 8, 5000);
484 err("Could not do mode read request from device"
489 /* Apply the mode switch */
490 data
[0] = ATP_GEYSER3_MODE_VENDOR_VALUE
;
492 size
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
493 ATP_GEYSER3_MODE_WRITE_REQUEST_ID
,
494 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
495 ATP_GEYSER3_MODE_REQUEST_VALUE
,
496 ATP_GEYSER3_MODE_REQUEST_INDEX
, &data
, 8, 5000);
499 err("Could not do mode write request to device"
503 printk("appletouch Geyser 3 inited.\n");
506 dev
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
512 dev
->data
= usb_buffer_alloc(dev
->udev
, dev
->datalen
, GFP_KERNEL
,
513 &dev
->urb
->transfer_dma
);
519 usb_fill_int_urb(dev
->urb
, udev
,
520 usb_rcvintpipe(udev
, int_in_endpointAddr
),
521 dev
->data
, dev
->datalen
, atp_complete
, dev
, 1);
523 usb_make_path(udev
, dev
->phys
, sizeof(dev
->phys
));
524 strlcat(dev
->phys
, "/input0", sizeof(dev
->phys
));
526 input_dev
->name
= "appletouch";
527 input_dev
->phys
= dev
->phys
;
528 usb_to_input_id(dev
->udev
, &input_dev
->id
);
529 input_dev
->cdev
.dev
= &iface
->dev
;
531 input_dev
->private = dev
;
532 input_dev
->open
= atp_open
;
533 input_dev
->close
= atp_close
;
535 set_bit(EV_ABS
, input_dev
->evbit
);
537 if (atp_is_geyser_3(dev
)) {
539 * MacBook have 20 X sensors, 10 Y sensors
541 input_set_abs_params(input_dev
, ABS_X
, 0,
542 ((20 - 1) * ATP_XFACT
) - 1, ATP_FUZZ
, 0);
543 input_set_abs_params(input_dev
, ABS_Y
, 0,
544 ((10 - 1) * ATP_YFACT
) - 1, ATP_FUZZ
, 0);
545 } else if (atp_is_geyser_2(dev
)) {
547 * Oct 2005 15" PowerBooks have 15 X sensors, 17" are detected
550 input_set_abs_params(input_dev
, ABS_X
, 0,
551 ((15 - 1) * ATP_XFACT
) - 1, ATP_FUZZ
, 0);
552 input_set_abs_params(input_dev
, ABS_Y
, 0,
553 ((9 - 1) * ATP_YFACT
) - 1, ATP_FUZZ
, 0);
556 * 12" and 15" Powerbooks only have 16 x sensors,
557 * 17" models are detected later.
559 input_set_abs_params(input_dev
, ABS_X
, 0,
560 (16 - 1) * ATP_XFACT
- 1, ATP_FUZZ
, 0);
561 input_set_abs_params(input_dev
, ABS_Y
, 0,
562 (ATP_YSENSORS
- 1) * ATP_YFACT
- 1, ATP_FUZZ
, 0);
564 input_set_abs_params(input_dev
, ABS_PRESSURE
, 0, ATP_PRESSURE
, 0, 0);
566 set_bit(EV_KEY
, input_dev
->evbit
);
567 set_bit(BTN_TOUCH
, input_dev
->keybit
);
568 set_bit(BTN_TOOL_FINGER
, input_dev
->keybit
);
569 set_bit(BTN_TOOL_DOUBLETAP
, input_dev
->keybit
);
570 set_bit(BTN_TOOL_TRIPLETAP
, input_dev
->keybit
);
571 set_bit(BTN_LEFT
, input_dev
->keybit
);
573 input_register_device(dev
->input
);
575 /* save our data pointer in this interface device */
576 usb_set_intfdata(iface
, dev
);
581 usb_free_urb(dev
->urb
);
583 usb_set_intfdata(iface
, NULL
);
585 input_free_device(input_dev
);
589 static void atp_disconnect(struct usb_interface
*iface
)
591 struct atp
*dev
= usb_get_intfdata(iface
);
593 usb_set_intfdata(iface
, NULL
);
595 usb_kill_urb(dev
->urb
);
596 input_unregister_device(dev
->input
);
597 usb_buffer_free(dev
->udev
, dev
->datalen
,
598 dev
->data
, dev
->urb
->transfer_dma
);
599 usb_free_urb(dev
->urb
);
602 printk(KERN_INFO
"input: appletouch disconnected\n");
605 static int atp_suspend(struct usb_interface
*iface
, pm_message_t message
)
607 struct atp
*dev
= usb_get_intfdata(iface
);
608 usb_kill_urb(dev
->urb
);
613 static int atp_resume(struct usb_interface
*iface
)
615 struct atp
*dev
= usb_get_intfdata(iface
);
616 if (dev
->open
&& usb_submit_urb(dev
->urb
, GFP_ATOMIC
))
622 static struct usb_driver atp_driver
= {
623 .name
= "appletouch",
625 .disconnect
= atp_disconnect
,
626 .suspend
= atp_suspend
,
627 .resume
= atp_resume
,
628 .id_table
= atp_table
,
631 static int __init
atp_init(void)
633 return usb_register(&atp_driver
);
636 static void __exit
atp_exit(void)
638 usb_deregister(&atp_driver
);
641 module_init(atp_init
);
642 module_exit(atp_exit
);