Use dentry_path() to create full path to inode object
[pohmelfs.git] / drivers / hid / hid-magicmouse.c
blob2ab71758e2e22940e0c53c1873a32a03152a9808
1 /*
2 * Apple "Magic" Wireless Mouse driver
4 * Copyright (c) 2010 Michael Poole <mdpoole@troilus.org>
5 * Copyright (c) 2010 Chase Douglas <chase.douglas@canonical.com>
6 */
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.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/device.h>
18 #include <linux/hid.h>
19 #include <linux/module.h>
20 #include <linux/slab.h>
21 #include <linux/usb.h>
23 #include "hid-ids.h"
25 static bool emulate_3button = true;
26 module_param(emulate_3button, bool, 0644);
27 MODULE_PARM_DESC(emulate_3button, "Emulate a middle button");
29 static int middle_button_start = -350;
30 static int middle_button_stop = +350;
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");
36 static unsigned int scroll_speed = 32;
37 static int param_set_scroll_speed(const char *val, struct kernel_param *kp) {
38 unsigned long speed;
39 if (!val || strict_strtoul(val, 0, &speed) || speed > 63)
40 return -EINVAL;
41 scroll_speed = speed;
42 return 0;
44 module_param_call(scroll_speed, param_set_scroll_speed, param_get_uint, &scroll_speed, 0644);
45 MODULE_PARM_DESC(scroll_speed, "Scroll speed, value from 0 (slow) to 63 (fast)");
47 static bool scroll_acceleration = false;
48 module_param(scroll_acceleration, bool, 0644);
49 MODULE_PARM_DESC(scroll_acceleration, "Accelerate sequential scroll events");
51 static bool report_touches = true;
52 module_param(report_touches, bool, 0644);
53 MODULE_PARM_DESC(report_touches, "Emit touch records (otherwise, only use them for emulation)");
55 static bool report_undeciphered;
56 module_param(report_undeciphered, bool, 0644);
57 MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state field using a MSC_RAW event");
59 #define TRACKPAD_REPORT_ID 0x28
60 #define MOUSE_REPORT_ID 0x29
61 #define DOUBLE_REPORT_ID 0xf7
62 /* These definitions are not precise, but they're close enough. (Bits
63 * 0x03 seem to indicate the aspect ratio of the touch, bits 0x70 seem
64 * to be some kind of bit mask -- 0x20 may be a near-field reading,
65 * and 0x40 is actual contact, and 0x10 may be a start/stop or change
66 * indication.)
68 #define TOUCH_STATE_MASK 0xf0
69 #define TOUCH_STATE_NONE 0x00
70 #define TOUCH_STATE_START 0x30
71 #define TOUCH_STATE_DRAG 0x40
73 #define SCROLL_ACCEL_DEFAULT 7
75 /* Single touch emulation should only begin when no touches are currently down.
76 * This is true when single_touch_id is equal to NO_TOUCHES. If multiple touches
77 * are down and the touch providing for single touch emulation is lifted,
78 * single_touch_id is equal to SINGLE_TOUCH_UP. While single touch emulation is
79 * occurring, single_touch_id corresponds with the tracking id of the touch used.
81 #define NO_TOUCHES -1
82 #define SINGLE_TOUCH_UP -2
84 /* Touch surface information. Dimension is in hundredths of a mm, min and max
85 * are in units. */
86 #define MOUSE_DIMENSION_X (float)9056
87 #define MOUSE_MIN_X -1100
88 #define MOUSE_MAX_X 1258
89 #define MOUSE_RES_X ((MOUSE_MAX_X - MOUSE_MIN_X) / (MOUSE_DIMENSION_X / 100))
90 #define MOUSE_DIMENSION_Y (float)5152
91 #define MOUSE_MIN_Y -1589
92 #define MOUSE_MAX_Y 2047
93 #define MOUSE_RES_Y ((MOUSE_MAX_Y - MOUSE_MIN_Y) / (MOUSE_DIMENSION_Y / 100))
95 #define TRACKPAD_DIMENSION_X (float)13000
96 #define TRACKPAD_MIN_X -2909
97 #define TRACKPAD_MAX_X 3167
98 #define TRACKPAD_RES_X \
99 ((TRACKPAD_MAX_X - TRACKPAD_MIN_X) / (TRACKPAD_DIMENSION_X / 100))
100 #define TRACKPAD_DIMENSION_Y (float)11000
101 #define TRACKPAD_MIN_Y -2456
102 #define TRACKPAD_MAX_Y 2565
103 #define TRACKPAD_RES_Y \
104 ((TRACKPAD_MAX_Y - TRACKPAD_MIN_Y) / (TRACKPAD_DIMENSION_Y / 100))
107 * struct magicmouse_sc - Tracks Magic Mouse-specific data.
108 * @input: Input device through which we report events.
109 * @quirks: Currently unused.
110 * @ntouches: Number of touches in most recent touch report.
111 * @scroll_accel: Number of consecutive scroll motions.
112 * @scroll_jiffies: Time of last scroll motion.
113 * @touches: Most recent data for a touch, indexed by tracking ID.
114 * @tracking_ids: Mapping of current touch input data to @touches.
116 struct magicmouse_sc {
117 struct input_dev *input;
118 unsigned long quirks;
120 int ntouches;
121 int scroll_accel;
122 unsigned long scroll_jiffies;
124 struct {
125 short x;
126 short y;
127 short scroll_x;
128 short scroll_y;
129 u8 size;
130 } touches[16];
131 int tracking_ids[16];
132 int single_touch_id;
135 static int magicmouse_firm_touch(struct magicmouse_sc *msc)
137 int touch = -1;
138 int ii;
140 /* If there is only one "firm" touch, set touch to its
141 * tracking ID.
143 for (ii = 0; ii < msc->ntouches; ii++) {
144 int idx = msc->tracking_ids[ii];
145 if (msc->touches[idx].size < 8) {
146 /* Ignore this touch. */
147 } else if (touch >= 0) {
148 touch = -1;
149 break;
150 } else {
151 touch = idx;
155 return touch;
158 static void magicmouse_emit_buttons(struct magicmouse_sc *msc, int state)
160 int last_state = test_bit(BTN_LEFT, msc->input->key) << 0 |
161 test_bit(BTN_RIGHT, msc->input->key) << 1 |
162 test_bit(BTN_MIDDLE, msc->input->key) << 2;
164 if (emulate_3button) {
165 int id;
167 /* If some button was pressed before, keep it held
168 * down. Otherwise, if there's exactly one firm
169 * touch, use that to override the mouse's guess.
171 if (state == 0) {
172 /* The button was released. */
173 } else if (last_state != 0) {
174 state = last_state;
175 } else if ((id = magicmouse_firm_touch(msc)) >= 0) {
176 int x = msc->touches[id].x;
177 if (x < middle_button_start)
178 state = 1;
179 else if (x > middle_button_stop)
180 state = 2;
181 else
182 state = 4;
183 } /* else: we keep the mouse's guess */
185 input_report_key(msc->input, BTN_MIDDLE, state & 4);
188 input_report_key(msc->input, BTN_LEFT, state & 1);
189 input_report_key(msc->input, BTN_RIGHT, state & 2);
191 if (state != last_state)
192 msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
195 static void magicmouse_emit_touch(struct magicmouse_sc *msc, int raw_id, u8 *tdata)
197 struct input_dev *input = msc->input;
198 int id, x, y, size, orientation, touch_major, touch_minor, state, down;
200 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
201 id = (tdata[6] << 2 | tdata[5] >> 6) & 0xf;
202 x = (tdata[1] << 28 | tdata[0] << 20) >> 20;
203 y = -((tdata[2] << 24 | tdata[1] << 16) >> 20);
204 size = tdata[5] & 0x3f;
205 orientation = (tdata[6] >> 2) - 32;
206 touch_major = tdata[3];
207 touch_minor = tdata[4];
208 state = tdata[7] & TOUCH_STATE_MASK;
209 down = state != TOUCH_STATE_NONE;
210 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
211 id = (tdata[7] << 2 | tdata[6] >> 6) & 0xf;
212 x = (tdata[1] << 27 | tdata[0] << 19) >> 19;
213 y = -((tdata[3] << 30 | tdata[2] << 22 | tdata[1] << 14) >> 19);
214 size = tdata[6] & 0x3f;
215 orientation = (tdata[7] >> 2) - 32;
216 touch_major = tdata[4];
217 touch_minor = tdata[5];
218 state = tdata[8] & TOUCH_STATE_MASK;
219 down = state != TOUCH_STATE_NONE;
222 /* Store tracking ID and other fields. */
223 msc->tracking_ids[raw_id] = id;
224 msc->touches[id].x = x;
225 msc->touches[id].y = y;
226 msc->touches[id].size = size;
228 /* If requested, emulate a scroll wheel by detecting small
229 * vertical touch motions.
231 if (emulate_scroll_wheel) {
232 unsigned long now = jiffies;
233 int step_x = msc->touches[id].scroll_x - x;
234 int step_y = msc->touches[id].scroll_y - y;
236 /* Calculate and apply the scroll motion. */
237 switch (state) {
238 case TOUCH_STATE_START:
239 msc->touches[id].scroll_x = x;
240 msc->touches[id].scroll_y = y;
242 /* Reset acceleration after half a second. */
243 if (scroll_acceleration && time_before(now,
244 msc->scroll_jiffies + HZ / 2))
245 msc->scroll_accel = max_t(int,
246 msc->scroll_accel - 1, 1);
247 else
248 msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
250 break;
251 case TOUCH_STATE_DRAG:
252 step_x /= (64 - (int)scroll_speed) * msc->scroll_accel;
253 if (step_x != 0) {
254 msc->touches[id].scroll_x -= step_x *
255 (64 - scroll_speed) * msc->scroll_accel;
256 msc->scroll_jiffies = now;
257 input_report_rel(input, REL_HWHEEL, -step_x);
260 step_y /= (64 - (int)scroll_speed) * msc->scroll_accel;
261 if (step_y != 0) {
262 msc->touches[id].scroll_y -= step_y *
263 (64 - scroll_speed) * msc->scroll_accel;
264 msc->scroll_jiffies = now;
265 input_report_rel(input, REL_WHEEL, step_y);
267 break;
271 if (down) {
272 msc->ntouches++;
273 if (msc->single_touch_id == NO_TOUCHES)
274 msc->single_touch_id = id;
275 } else if (msc->single_touch_id == id)
276 msc->single_touch_id = SINGLE_TOUCH_UP;
278 /* Generate the input events for this touch. */
279 if (report_touches && down) {
280 input_report_abs(input, ABS_MT_TRACKING_ID, id);
281 input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major << 2);
282 input_report_abs(input, ABS_MT_TOUCH_MINOR, touch_minor << 2);
283 input_report_abs(input, ABS_MT_ORIENTATION, -orientation);
284 input_report_abs(input, ABS_MT_POSITION_X, x);
285 input_report_abs(input, ABS_MT_POSITION_Y, y);
287 if (report_undeciphered) {
288 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
289 input_event(input, EV_MSC, MSC_RAW, tdata[7]);
290 else /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
291 input_event(input, EV_MSC, MSC_RAW, tdata[8]);
294 input_mt_sync(input);
298 static int magicmouse_raw_event(struct hid_device *hdev,
299 struct hid_report *report, u8 *data, int size)
301 struct magicmouse_sc *msc = hid_get_drvdata(hdev);
302 struct input_dev *input = msc->input;
303 int x = 0, y = 0, ii, clicks = 0, npoints;
305 switch (data[0]) {
306 case TRACKPAD_REPORT_ID:
307 /* Expect four bytes of prefix, and N*9 bytes of touch data. */
308 if (size < 4 || ((size - 4) % 9) != 0)
309 return 0;
310 npoints = (size - 4) / 9;
311 msc->ntouches = 0;
312 for (ii = 0; ii < npoints; ii++)
313 magicmouse_emit_touch(msc, ii, data + ii * 9 + 4);
315 /* We don't need an MT sync here because trackpad emits a
316 * BTN_TOUCH event in a new frame when all touches are released.
318 if (msc->ntouches == 0)
319 msc->single_touch_id = NO_TOUCHES;
321 clicks = data[1];
323 /* The following bits provide a device specific timestamp. They
324 * are unused here.
326 * ts = data[1] >> 6 | data[2] << 2 | data[3] << 10;
328 break;
329 case MOUSE_REPORT_ID:
330 /* Expect six bytes of prefix, and N*8 bytes of touch data. */
331 if (size < 6 || ((size - 6) % 8) != 0)
332 return 0;
333 npoints = (size - 6) / 8;
334 msc->ntouches = 0;
335 for (ii = 0; ii < npoints; ii++)
336 magicmouse_emit_touch(msc, ii, data + ii * 8 + 6);
338 if (report_touches && msc->ntouches == 0)
339 input_mt_sync(input);
341 /* When emulating three-button mode, it is important
342 * to have the current touch information before
343 * generating a click event.
345 x = (int)(((data[3] & 0x0c) << 28) | (data[1] << 22)) >> 22;
346 y = (int)(((data[3] & 0x30) << 26) | (data[2] << 22)) >> 22;
347 clicks = data[3];
349 /* The following bits provide a device specific timestamp. They
350 * are unused here.
352 * ts = data[3] >> 6 | data[4] << 2 | data[5] << 10;
354 break;
355 case DOUBLE_REPORT_ID:
356 /* Sometimes the trackpad sends two touch reports in one
357 * packet.
359 magicmouse_raw_event(hdev, report, data + 2, data[1]);
360 magicmouse_raw_event(hdev, report, data + 2 + data[1],
361 size - 2 - data[1]);
362 break;
363 default:
364 return 0;
367 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
368 magicmouse_emit_buttons(msc, clicks & 3);
369 input_report_rel(input, REL_X, x);
370 input_report_rel(input, REL_Y, y);
371 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
372 input_report_key(input, BTN_MOUSE, clicks & 1);
373 input_report_key(input, BTN_TOUCH, msc->ntouches > 0);
374 input_report_key(input, BTN_TOOL_FINGER, msc->ntouches == 1);
375 input_report_key(input, BTN_TOOL_DOUBLETAP, msc->ntouches == 2);
376 input_report_key(input, BTN_TOOL_TRIPLETAP, msc->ntouches == 3);
377 input_report_key(input, BTN_TOOL_QUADTAP, msc->ntouches == 4);
378 if (msc->single_touch_id >= 0) {
379 input_report_abs(input, ABS_X,
380 msc->touches[msc->single_touch_id].x);
381 input_report_abs(input, ABS_Y,
382 msc->touches[msc->single_touch_id].y);
386 input_sync(input);
387 return 1;
390 static void magicmouse_setup_input(struct input_dev *input, struct hid_device *hdev)
392 __set_bit(EV_KEY, input->evbit);
394 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
395 __set_bit(BTN_LEFT, input->keybit);
396 __set_bit(BTN_RIGHT, input->keybit);
397 if (emulate_3button)
398 __set_bit(BTN_MIDDLE, input->keybit);
400 __set_bit(EV_REL, input->evbit);
401 __set_bit(REL_X, input->relbit);
402 __set_bit(REL_Y, input->relbit);
403 if (emulate_scroll_wheel) {
404 __set_bit(REL_WHEEL, input->relbit);
405 __set_bit(REL_HWHEEL, input->relbit);
407 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
408 /* input->keybit is initialized with incorrect button info
409 * for Magic Trackpad. There really is only one physical
410 * button (BTN_LEFT == BTN_MOUSE). Make sure we don't
411 * advertise buttons that don't exist...
413 __clear_bit(BTN_RIGHT, input->keybit);
414 __clear_bit(BTN_MIDDLE, input->keybit);
415 __set_bit(BTN_MOUSE, input->keybit);
416 __set_bit(BTN_TOOL_FINGER, input->keybit);
417 __set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
418 __set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
419 __set_bit(BTN_TOOL_QUADTAP, input->keybit);
420 __set_bit(BTN_TOUCH, input->keybit);
423 if (report_touches) {
424 __set_bit(EV_ABS, input->evbit);
426 input_set_abs_params(input, ABS_MT_TRACKING_ID, 0, 15, 0, 0);
427 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 4, 0);
428 input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 4, 0);
429 input_set_abs_params(input, ABS_MT_ORIENTATION, -31, 32, 1, 0);
431 /* Note: Touch Y position from the device is inverted relative
432 * to how pointer motion is reported (and relative to how USB
433 * HID recommends the coordinates work). This driver keeps
434 * the origin at the same position, and just uses the additive
435 * inverse of the reported Y.
437 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
438 input_set_abs_params(input, ABS_MT_POSITION_X,
439 MOUSE_MIN_X, MOUSE_MAX_X, 4, 0);
440 input_set_abs_params(input, ABS_MT_POSITION_Y,
441 MOUSE_MIN_Y, MOUSE_MAX_Y, 4, 0);
443 input_abs_set_res(input, ABS_MT_POSITION_X,
444 MOUSE_RES_X);
445 input_abs_set_res(input, ABS_MT_POSITION_Y,
446 MOUSE_RES_Y);
447 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
448 input_set_abs_params(input, ABS_X, TRACKPAD_MIN_X,
449 TRACKPAD_MAX_X, 4, 0);
450 input_set_abs_params(input, ABS_Y, TRACKPAD_MIN_Y,
451 TRACKPAD_MAX_Y, 4, 0);
452 input_set_abs_params(input, ABS_MT_POSITION_X,
453 TRACKPAD_MIN_X, TRACKPAD_MAX_X, 4, 0);
454 input_set_abs_params(input, ABS_MT_POSITION_Y,
455 TRACKPAD_MIN_Y, TRACKPAD_MAX_Y, 4, 0);
457 input_abs_set_res(input, ABS_X, TRACKPAD_RES_X);
458 input_abs_set_res(input, ABS_Y, TRACKPAD_RES_Y);
459 input_abs_set_res(input, ABS_MT_POSITION_X,
460 TRACKPAD_RES_X);
461 input_abs_set_res(input, ABS_MT_POSITION_Y,
462 TRACKPAD_RES_Y);
465 input_set_events_per_packet(input, 60);
468 if (report_undeciphered) {
469 __set_bit(EV_MSC, input->evbit);
470 __set_bit(MSC_RAW, input->mscbit);
474 static int magicmouse_input_mapping(struct hid_device *hdev,
475 struct hid_input *hi, struct hid_field *field,
476 struct hid_usage *usage, unsigned long **bit, int *max)
478 struct magicmouse_sc *msc = hid_get_drvdata(hdev);
480 if (!msc->input)
481 msc->input = hi->input;
483 /* Magic Trackpad does not give relative data after switching to MT */
484 if (hi->input->id.product == USB_DEVICE_ID_APPLE_MAGICTRACKPAD &&
485 field->flags & HID_MAIN_ITEM_RELATIVE)
486 return -1;
488 return 0;
491 static int magicmouse_probe(struct hid_device *hdev,
492 const struct hid_device_id *id)
494 __u8 feature[] = { 0xd7, 0x01 };
495 struct magicmouse_sc *msc;
496 struct hid_report *report;
497 int ret;
499 msc = kzalloc(sizeof(*msc), GFP_KERNEL);
500 if (msc == NULL) {
501 hid_err(hdev, "can't alloc magicmouse descriptor\n");
502 return -ENOMEM;
505 msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
507 msc->quirks = id->driver_data;
508 hid_set_drvdata(hdev, msc);
510 msc->single_touch_id = NO_TOUCHES;
512 ret = hid_parse(hdev);
513 if (ret) {
514 hid_err(hdev, "magicmouse hid parse failed\n");
515 goto err_free;
518 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
519 if (ret) {
520 hid_err(hdev, "magicmouse hw start failed\n");
521 goto err_free;
524 /* We do this after hid-input is done parsing reports so that
525 * hid-input uses the most natural button and axis IDs.
527 if (msc->input)
528 magicmouse_setup_input(msc->input, hdev);
530 if (id->product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
531 report = hid_register_report(hdev, HID_INPUT_REPORT,
532 MOUSE_REPORT_ID);
533 else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
534 report = hid_register_report(hdev, HID_INPUT_REPORT,
535 TRACKPAD_REPORT_ID);
536 report = hid_register_report(hdev, HID_INPUT_REPORT,
537 DOUBLE_REPORT_ID);
540 if (!report) {
541 hid_err(hdev, "unable to register touch report\n");
542 ret = -ENOMEM;
543 goto err_stop_hw;
545 report->size = 6;
548 * Some devices repond with 'invalid report id' when feature
549 * report switching it into multitouch mode is sent to it.
551 * This results in -EIO from the _raw low-level transport callback,
552 * but there seems to be no other way of switching the mode.
553 * Thus the super-ugly hacky success check below.
555 ret = hdev->hid_output_raw_report(hdev, feature, sizeof(feature),
556 HID_FEATURE_REPORT);
557 if (ret != -EIO && ret != sizeof(feature)) {
558 hid_err(hdev, "unable to request touch data (%d)\n", ret);
559 goto err_stop_hw;
562 return 0;
563 err_stop_hw:
564 hid_hw_stop(hdev);
565 err_free:
566 kfree(msc);
567 return ret;
570 static void magicmouse_remove(struct hid_device *hdev)
572 struct magicmouse_sc *msc = hid_get_drvdata(hdev);
574 hid_hw_stop(hdev);
575 kfree(msc);
578 static const struct hid_device_id magic_mice[] = {
579 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
580 USB_DEVICE_ID_APPLE_MAGICMOUSE), .driver_data = 0 },
581 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
582 USB_DEVICE_ID_APPLE_MAGICTRACKPAD), .driver_data = 0 },
585 MODULE_DEVICE_TABLE(hid, magic_mice);
587 static struct hid_driver magicmouse_driver = {
588 .name = "magicmouse",
589 .id_table = magic_mice,
590 .probe = magicmouse_probe,
591 .remove = magicmouse_remove,
592 .raw_event = magicmouse_raw_event,
593 .input_mapping = magicmouse_input_mapping,
596 static int __init magicmouse_init(void)
598 int ret;
600 ret = hid_register_driver(&magicmouse_driver);
601 if (ret)
602 pr_err("can't register magicmouse driver\n");
604 return ret;
607 static void __exit magicmouse_exit(void)
609 hid_unregister_driver(&magicmouse_driver);
612 module_init(magicmouse_init);
613 module_exit(magicmouse_exit);
614 MODULE_LICENSE("GPL");