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