1 /* 2 * Apple "Magic" Wireless Mouse driver 3 * 4 * Copyright (c) 2010 Michael Poole <mdpoole@troilus.org> 5 * Copyright (c) 2010 Chase Douglas <chase.douglas@canonical.com> 6 */ 7 8 /* 9 * This program is free software; you can redistribute it and/or modify it 10 * under the terms of the GNU General Public License as published by the Free 11 * Software Foundation; either version 2 of the License, or (at your option) 12 * any later version. 13 */ 14 15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 16 17 #include <linux/device.h> 18 #include <linux/hid.h> 19 #include <linux/input/mt.h> 20 #include <linux/module.h> 21 #include <linux/slab.h> 22 23 #include "hid-ids.h" 24 25 static bool emulate_3button = true; 26 module_param(emulate_3button, bool, 0644); 27 MODULE_PARM_DESC(emulate_3button, "Emulate a middle button"); 28 29 static int middle_button_start = -350; 30 static int middle_button_stop = +350; 31 32 static bool emulate_scroll_wheel = true; 33 module_param(emulate_scroll_wheel, bool, 0644); 34 MODULE_PARM_DESC(emulate_scroll_wheel, "Emulate a scroll wheel"); 35 36 static unsigned int scroll_speed = 32; 37 static int param_set_scroll_speed(const char *val, 38 const struct kernel_param *kp) { 39 unsigned long speed; 40 if (!val || kstrtoul(val, 0, &speed) || speed > 63) 41 return -EINVAL; 42 scroll_speed = speed; 43 return 0; 44 } 45 module_param_call(scroll_speed, param_set_scroll_speed, param_get_uint, &scroll_speed, 0644); 46 MODULE_PARM_DESC(scroll_speed, "Scroll speed, value from 0 (slow) to 63 (fast)"); 47 48 static bool scroll_acceleration = false; 49 module_param(scroll_acceleration, bool, 0644); 50 MODULE_PARM_DESC(scroll_acceleration, "Accelerate sequential scroll events"); 51 52 static bool report_undeciphered; 53 module_param(report_undeciphered, bool, 0644); 54 MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state field using a MSC_RAW event"); 55 56 #define TRACKPAD_REPORT_ID 0x28 57 #define MOUSE_REPORT_ID 0x29 58 #define DOUBLE_REPORT_ID 0xf7 59 /* These definitions are not precise, but they're close enough. (Bits 60 * 0x03 seem to indicate the aspect ratio of the touch, bits 0x70 seem 61 * to be some kind of bit mask -- 0x20 may be a near-field reading, 62 * and 0x40 is actual contact, and 0x10 may be a start/stop or change 63 * indication.) 64 */ 65 #define TOUCH_STATE_MASK 0xf0 66 #define TOUCH_STATE_NONE 0x00 67 #define TOUCH_STATE_START 0x30 68 #define TOUCH_STATE_DRAG 0x40 69 70 #define SCROLL_ACCEL_DEFAULT 7 71 72 /* Touch surface information. Dimension is in hundredths of a mm, min and max 73 * are in units. */ 74 #define MOUSE_DIMENSION_X (float)9056 75 #define MOUSE_MIN_X -1100 76 #define MOUSE_MAX_X 1258 77 #define MOUSE_RES_X ((MOUSE_MAX_X - MOUSE_MIN_X) / (MOUSE_DIMENSION_X / 100)) 78 #define MOUSE_DIMENSION_Y (float)5152 79 #define MOUSE_MIN_Y -1589 80 #define MOUSE_MAX_Y 2047 81 #define MOUSE_RES_Y ((MOUSE_MAX_Y - MOUSE_MIN_Y) / (MOUSE_DIMENSION_Y / 100)) 82 83 #define TRACKPAD_DIMENSION_X (float)13000 84 #define TRACKPAD_MIN_X -2909 85 #define TRACKPAD_MAX_X 3167 86 #define TRACKPAD_RES_X \ 87 ((TRACKPAD_MAX_X - TRACKPAD_MIN_X) / (TRACKPAD_DIMENSION_X / 100)) 88 #define TRACKPAD_DIMENSION_Y (float)11000 89 #define TRACKPAD_MIN_Y -2456 90 #define TRACKPAD_MAX_Y 2565 91 #define TRACKPAD_RES_Y \ 92 ((TRACKPAD_MAX_Y - TRACKPAD_MIN_Y) / (TRACKPAD_DIMENSION_Y / 100)) 93 94 /** 95 * struct magicmouse_sc - Tracks Magic Mouse-specific data. 96 * @input: Input device through which we report events. 97 * @quirks: Currently unused. 98 * @ntouches: Number of touches in most recent touch report. 99 * @scroll_accel: Number of consecutive scroll motions. 100 * @scroll_jiffies: Time of last scroll motion. 101 * @touches: Most recent data for a touch, indexed by tracking ID. 102 * @tracking_ids: Mapping of current touch input data to @touches. 103 */ 104 struct magicmouse_sc { 105 struct input_dev *input; 106 unsigned long quirks; 107 108 int ntouches; 109 int scroll_accel; 110 unsigned long scroll_jiffies; 111 112 struct { 113 short x; 114 short y; 115 short scroll_x; 116 short scroll_y; 117 u8 size; 118 } touches[16]; 119 int tracking_ids[16]; 120 }; 121 122 static int magicmouse_firm_touch(struct magicmouse_sc *msc) 123 { 124 int touch = -1; 125 int ii; 126 127 /* If there is only one "firm" touch, set touch to its 128 * tracking ID. 129 */ 130 for (ii = 0; ii < msc->ntouches; ii++) { 131 int idx = msc->tracking_ids[ii]; 132 if (msc->touches[idx].size < 8) { 133 /* Ignore this touch. */ 134 } else if (touch >= 0) { 135 touch = -1; 136 break; 137 } else { 138 touch = idx; 139 } 140 } 141 142 return touch; 143 } 144 145 static void magicmouse_emit_buttons(struct magicmouse_sc *msc, int state) 146 { 147 int last_state = test_bit(BTN_LEFT, msc->input->key) << 0 | 148 test_bit(BTN_RIGHT, msc->input->key) << 1 | 149 test_bit(BTN_MIDDLE, msc->input->key) << 2; 150 151 if (emulate_3button) { 152 int id; 153 154 /* If some button was pressed before, keep it held 155 * down. Otherwise, if there's exactly one firm 156 * touch, use that to override the mouse's guess. 157 */ 158 if (state == 0) { 159 /* The button was released. */ 160 } else if (last_state != 0) { 161 state = last_state; 162 } else if ((id = magicmouse_firm_touch(msc)) >= 0) { 163 int x = msc->touches[id].x; 164 if (x < middle_button_start) 165 state = 1; 166 else if (x > middle_button_stop) 167 state = 2; 168 else 169 state = 4; 170 } /* else: we keep the mouse's guess */ 171 172 input_report_key(msc->input, BTN_MIDDLE, state & 4); 173 } 174 175 input_report_key(msc->input, BTN_LEFT, state & 1); 176 input_report_key(msc->input, BTN_RIGHT, state & 2); 177 178 if (state != last_state) 179 msc->scroll_accel = SCROLL_ACCEL_DEFAULT; 180 } 181 182 static void magicmouse_emit_touch(struct magicmouse_sc *msc, int raw_id, u8 *tdata) 183 { 184 struct input_dev *input = msc->input; 185 int id, x, y, size, orientation, touch_major, touch_minor, state, down; 186 187 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) { 188 id = (tdata[6] << 2 | tdata[5] >> 6) & 0xf; 189 x = (tdata[1] << 28 | tdata[0] << 20) >> 20; 190 y = -((tdata[2] << 24 | tdata[1] << 16) >> 20); 191 size = tdata[5] & 0x3f; 192 orientation = (tdata[6] >> 2) - 32; 193 touch_major = tdata[3]; 194 touch_minor = tdata[4]; 195 state = tdata[7] & TOUCH_STATE_MASK; 196 down = state != TOUCH_STATE_NONE; 197 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */ 198 id = (tdata[7] << 2 | tdata[6] >> 6) & 0xf; 199 x = (tdata[1] << 27 | tdata[0] << 19) >> 19; 200 y = -((tdata[3] << 30 | tdata[2] << 22 | tdata[1] << 14) >> 19); 201 size = tdata[6] & 0x3f; 202 orientation = (tdata[7] >> 2) - 32; 203 touch_major = tdata[4]; 204 touch_minor = tdata[5]; 205 state = tdata[8] & TOUCH_STATE_MASK; 206 down = state != TOUCH_STATE_NONE; 207 } 208 209 /* Store tracking ID and other fields. */ 210 msc->tracking_ids[raw_id] = id; 211 msc->touches[id].x = x; 212 msc->touches[id].y = y; 213 msc->touches[id].size = size; 214 215 /* If requested, emulate a scroll wheel by detecting small 216 * vertical touch motions. 217 */ 218 if (emulate_scroll_wheel) { 219 unsigned long now = jiffies; 220 int step_x = msc->touches[id].scroll_x - x; 221 int step_y = msc->touches[id].scroll_y - y; 222 223 /* Calculate and apply the scroll motion. */ 224 switch (state) { 225 case TOUCH_STATE_START: 226 msc->touches[id].scroll_x = x; 227 msc->touches[id].scroll_y = y; 228 229 /* Reset acceleration after half a second. */ 230 if (scroll_acceleration && time_before(now, 231 msc->scroll_jiffies + HZ / 2)) 232 msc->scroll_accel = max_t(int, 233 msc->scroll_accel - 1, 1); 234 else 235 msc->scroll_accel = SCROLL_ACCEL_DEFAULT; 236 237 break; 238 case TOUCH_STATE_DRAG: 239 step_x /= (64 - (int)scroll_speed) * msc->scroll_accel; 240 if (step_x != 0) { 241 msc->touches[id].scroll_x -= step_x * 242 (64 - scroll_speed) * msc->scroll_accel; 243 msc->scroll_jiffies = now; 244 input_report_rel(input, REL_HWHEEL, -step_x); 245 } 246 247 step_y /= (64 - (int)scroll_speed) * msc->scroll_accel; 248 if (step_y != 0) { 249 msc->touches[id].scroll_y -= step_y * 250 (64 - scroll_speed) * msc->scroll_accel; 251 msc->scroll_jiffies = now; 252 input_report_rel(input, REL_WHEEL, step_y); 253 } 254 break; 255 } 256 } 257 258 if (down) 259 msc->ntouches++; 260 261 input_mt_slot(input, id); 262 input_mt_report_slot_state(input, MT_TOOL_FINGER, down); 263 264 /* Generate the input events for this touch. */ 265 if (down) { 266 input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major << 2); 267 input_report_abs(input, ABS_MT_TOUCH_MINOR, touch_minor << 2); 268 input_report_abs(input, ABS_MT_ORIENTATION, -orientation); 269 input_report_abs(input, ABS_MT_POSITION_X, x); 270 input_report_abs(input, ABS_MT_POSITION_Y, y); 271 272 if (report_undeciphered) { 273 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) 274 input_event(input, EV_MSC, MSC_RAW, tdata[7]); 275 else /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */ 276 input_event(input, EV_MSC, MSC_RAW, tdata[8]); 277 } 278 } 279 } 280 281 static int magicmouse_raw_event(struct hid_device *hdev, 282 struct hid_report *report, u8 *data, int size) 283 { 284 struct magicmouse_sc *msc = hid_get_drvdata(hdev); 285 struct input_dev *input = msc->input; 286 int x = 0, y = 0, ii, clicks = 0, npoints; 287 288 switch (data[0]) { 289 case TRACKPAD_REPORT_ID: 290 /* Expect four bytes of prefix, and N*9 bytes of touch data. */ 291 if (size < 4 || ((size - 4) % 9) != 0) 292 return 0; 293 npoints = (size - 4) / 9; 294 if (npoints > 15) { 295 hid_warn(hdev, "invalid size value (%d) for TRACKPAD_REPORT_ID\n", 296 size); 297 return 0; 298 } 299 msc->ntouches = 0; 300 for (ii = 0; ii < npoints; ii++) 301 magicmouse_emit_touch(msc, ii, data + ii * 9 + 4); 302 303 clicks = data[1]; 304 305 /* The following bits provide a device specific timestamp. They 306 * are unused here. 307 * 308 * ts = data[1] >> 6 | data[2] << 2 | data[3] << 10; 309 */ 310 break; 311 case MOUSE_REPORT_ID: 312 /* Expect six bytes of prefix, and N*8 bytes of touch data. */ 313 if (size < 6 || ((size - 6) % 8) != 0) 314 return 0; 315 npoints = (size - 6) / 8; 316 if (npoints > 15) { 317 hid_warn(hdev, "invalid size value (%d) for MOUSE_REPORT_ID\n", 318 size); 319 return 0; 320 } 321 msc->ntouches = 0; 322 for (ii = 0; ii < npoints; ii++) 323 magicmouse_emit_touch(msc, ii, data + ii * 8 + 6); 324 325 /* When emulating three-button mode, it is important 326 * to have the current touch information before 327 * generating a click event. 328 */ 329 x = (int)(((data[3] & 0x0c) << 28) | (data[1] << 22)) >> 22; 330 y = (int)(((data[3] & 0x30) << 26) | (data[2] << 22)) >> 22; 331 clicks = data[3]; 332 333 /* The following bits provide a device specific timestamp. They 334 * are unused here. 335 * 336 * ts = data[3] >> 6 | data[4] << 2 | data[5] << 10; 337 */ 338 break; 339 case DOUBLE_REPORT_ID: 340 /* Sometimes the trackpad sends two touch reports in one 341 * packet. 342 */ 343 magicmouse_raw_event(hdev, report, data + 2, data[1]); 344 magicmouse_raw_event(hdev, report, data + 2 + data[1], 345 size - 2 - data[1]); 346 break; 347 default: 348 return 0; 349 } 350 351 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) { 352 magicmouse_emit_buttons(msc, clicks & 3); 353 input_report_rel(input, REL_X, x); 354 input_report_rel(input, REL_Y, y); 355 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */ 356 input_report_key(input, BTN_MOUSE, clicks & 1); 357 input_mt_report_pointer_emulation(input, true); 358 } 359 360 input_sync(input); 361 return 1; 362 } 363 364 static int magicmouse_setup_input(struct input_dev *input, struct hid_device *hdev) 365 { 366 int error; 367 368 __set_bit(EV_KEY, input->evbit); 369 370 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) { 371 __set_bit(BTN_LEFT, input->keybit); 372 __set_bit(BTN_RIGHT, input->keybit); 373 if (emulate_3button) 374 __set_bit(BTN_MIDDLE, input->keybit); 375 376 __set_bit(EV_REL, input->evbit); 377 __set_bit(REL_X, input->relbit); 378 __set_bit(REL_Y, input->relbit); 379 if (emulate_scroll_wheel) { 380 __set_bit(REL_WHEEL, input->relbit); 381 __set_bit(REL_HWHEEL, input->relbit); 382 } 383 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */ 384 /* input->keybit is initialized with incorrect button info 385 * for Magic Trackpad. There really is only one physical 386 * button (BTN_LEFT == BTN_MOUSE). Make sure we don't 387 * advertise buttons that don't exist... 388 */ 389 __clear_bit(BTN_RIGHT, input->keybit); 390 __clear_bit(BTN_MIDDLE, input->keybit); 391 __set_bit(BTN_MOUSE, input->keybit); 392 __set_bit(BTN_TOOL_FINGER, input->keybit); 393 __set_bit(BTN_TOOL_DOUBLETAP, input->keybit); 394 __set_bit(BTN_TOOL_TRIPLETAP, input->keybit); 395 __set_bit(BTN_TOOL_QUADTAP, input->keybit); 396 __set_bit(BTN_TOOL_QUINTTAP, input->keybit); 397 __set_bit(BTN_TOUCH, input->keybit); 398 __set_bit(INPUT_PROP_POINTER, input->propbit); 399 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit); 400 } 401 402 403 __set_bit(EV_ABS, input->evbit); 404 405 error = input_mt_init_slots(input, 16, 0); 406 if (error) 407 return error; 408 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255 << 2, 409 4, 0); 410 input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255 << 2, 411 4, 0); 412 input_set_abs_params(input, ABS_MT_ORIENTATION, -31, 32, 1, 0); 413 414 /* Note: Touch Y position from the device is inverted relative 415 * to how pointer motion is reported (and relative to how USB 416 * HID recommends the coordinates work). This driver keeps 417 * the origin at the same position, and just uses the additive 418 * inverse of the reported Y. 419 */ 420 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) { 421 input_set_abs_params(input, ABS_MT_POSITION_X, 422 MOUSE_MIN_X, MOUSE_MAX_X, 4, 0); 423 input_set_abs_params(input, ABS_MT_POSITION_Y, 424 MOUSE_MIN_Y, MOUSE_MAX_Y, 4, 0); 425 426 input_abs_set_res(input, ABS_MT_POSITION_X, 427 MOUSE_RES_X); 428 input_abs_set_res(input, ABS_MT_POSITION_Y, 429 MOUSE_RES_Y); 430 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */ 431 input_set_abs_params(input, ABS_X, TRACKPAD_MIN_X, 432 TRACKPAD_MAX_X, 4, 0); 433 input_set_abs_params(input, ABS_Y, TRACKPAD_MIN_Y, 434 TRACKPAD_MAX_Y, 4, 0); 435 input_set_abs_params(input, ABS_MT_POSITION_X, 436 TRACKPAD_MIN_X, TRACKPAD_MAX_X, 4, 0); 437 input_set_abs_params(input, ABS_MT_POSITION_Y, 438 TRACKPAD_MIN_Y, TRACKPAD_MAX_Y, 4, 0); 439 440 input_abs_set_res(input, ABS_X, TRACKPAD_RES_X); 441 input_abs_set_res(input, ABS_Y, TRACKPAD_RES_Y); 442 input_abs_set_res(input, ABS_MT_POSITION_X, 443 TRACKPAD_RES_X); 444 input_abs_set_res(input, ABS_MT_POSITION_Y, 445 TRACKPAD_RES_Y); 446 } 447 448 input_set_events_per_packet(input, 60); 449 450 if (report_undeciphered) { 451 __set_bit(EV_MSC, input->evbit); 452 __set_bit(MSC_RAW, input->mscbit); 453 } 454 455 return 0; 456 } 457 458 static int magicmouse_input_mapping(struct hid_device *hdev, 459 struct hid_input *hi, struct hid_field *field, 460 struct hid_usage *usage, unsigned long **bit, int *max) 461 { 462 struct magicmouse_sc *msc = hid_get_drvdata(hdev); 463 464 if (!msc->input) 465 msc->input = hi->input; 466 467 /* Magic Trackpad does not give relative data after switching to MT */ 468 if (hi->input->id.product == USB_DEVICE_ID_APPLE_MAGICTRACKPAD && 469 field->flags & HID_MAIN_ITEM_RELATIVE) 470 return -1; 471 472 return 0; 473 } 474 475 static int magicmouse_input_configured(struct hid_device *hdev, 476 struct hid_input *hi) 477 478 { 479 struct magicmouse_sc *msc = hid_get_drvdata(hdev); 480 int ret; 481 482 ret = magicmouse_setup_input(msc->input, hdev); 483 if (ret) { 484 hid_err(hdev, "magicmouse setup input failed (%d)\n", ret); 485 /* clean msc->input to notify probe() of the failure */ 486 msc->input = NULL; 487 return ret; 488 } 489 490 return 0; 491 } 492 493 494 static int magicmouse_probe(struct hid_device *hdev, 495 const struct hid_device_id *id) 496 { 497 const u8 feature[] = { 0xd7, 0x01 }; 498 u8 *buf; 499 struct magicmouse_sc *msc; 500 struct hid_report *report; 501 int ret; 502 503 msc = devm_kzalloc(&hdev->dev, sizeof(*msc), GFP_KERNEL); 504 if (msc == NULL) { 505 hid_err(hdev, "can't alloc magicmouse descriptor\n"); 506 return -ENOMEM; 507 } 508 509 msc->scroll_accel = SCROLL_ACCEL_DEFAULT; 510 511 msc->quirks = id->driver_data; 512 hid_set_drvdata(hdev, msc); 513 514 ret = hid_parse(hdev); 515 if (ret) { 516 hid_err(hdev, "magicmouse hid parse failed\n"); 517 return ret; 518 } 519 520 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT); 521 if (ret) { 522 hid_err(hdev, "magicmouse hw start failed\n"); 523 return ret; 524 } 525 526 if (!msc->input) { 527 hid_err(hdev, "magicmouse input not registered\n"); 528 ret = -ENOMEM; 529 goto err_stop_hw; 530 } 531 532 if (id->product == USB_DEVICE_ID_APPLE_MAGICMOUSE) 533 report = hid_register_report(hdev, HID_INPUT_REPORT, 534 MOUSE_REPORT_ID); 535 else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */ 536 report = hid_register_report(hdev, HID_INPUT_REPORT, 537 TRACKPAD_REPORT_ID); 538 report = hid_register_report(hdev, HID_INPUT_REPORT, 539 DOUBLE_REPORT_ID); 540 } 541 542 if (!report) { 543 hid_err(hdev, "unable to register touch report\n"); 544 ret = -ENOMEM; 545 goto err_stop_hw; 546 } 547 report->size = 6; 548 549 buf = kmemdup(feature, sizeof(feature), GFP_KERNEL); 550 if (!buf) { 551 ret = -ENOMEM; 552 goto err_stop_hw; 553 } 554 555 /* 556 * Some devices repond with 'invalid report id' when feature 557 * report switching it into multitouch mode is sent to it. 558 * 559 * This results in -EIO from the _raw low-level transport callback, 560 * but there seems to be no other way of switching the mode. 561 * Thus the super-ugly hacky success check below. 562 */ 563 ret = hid_hw_raw_request(hdev, buf[0], buf, sizeof(feature), 564 HID_FEATURE_REPORT, HID_REQ_SET_REPORT); 565 kfree(buf); 566 if (ret != -EIO && ret != sizeof(feature)) { 567 hid_err(hdev, "unable to request touch data (%d)\n", ret); 568 goto err_stop_hw; 569 } 570 571 return 0; 572 err_stop_hw: 573 hid_hw_stop(hdev); 574 return ret; 575 } 576 577 static const struct hid_device_id magic_mice[] = { 578 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 579 USB_DEVICE_ID_APPLE_MAGICMOUSE), .driver_data = 0 }, 580 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 581 USB_DEVICE_ID_APPLE_MAGICTRACKPAD), .driver_data = 0 }, 582 { } 583 }; 584 MODULE_DEVICE_TABLE(hid, magic_mice); 585 586 static struct hid_driver magicmouse_driver = { 587 .name = "magicmouse", 588 .id_table = magic_mice, 589 .probe = magicmouse_probe, 590 .raw_event = magicmouse_raw_event, 591 .input_mapping = magicmouse_input_mapping, 592 .input_configured = magicmouse_input_configured, 593 }; 594 module_hid_driver(magicmouse_driver); 595 596 MODULE_LICENSE("GPL"); 597