2 * Apple "Magic" Wireless Mouse driver
4 * Copyright (c) 2010 Michael Poole <mdpoole@troilus.org>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
14 #include <linux/device.h>
15 #include <linux/hid.h>
16 #include <linux/module.h>
17 #include <linux/usb.h>
21 static bool emulate_3button = 1;
22 module_param(emulate_3button, bool, 0644);
23 MODULE_PARM_DESC(emulate_3button, "Emulate a middle button");
25 static int middle_button_start = -350;
26 static int middle_button_stop = +350;
28 static bool emulate_scroll_wheel = 1;
29 module_param(emulate_scroll_wheel, bool, 0644);
30 MODULE_PARM_DESC(emulate_scroll_wheel, "Emulate a scroll wheel");
32 static bool report_touches = 1;
33 module_param(report_touches, bool, 0644);
34 MODULE_PARM_DESC(report_touches, "Emit touch records (otherwise, only use them for emulation)");
36 static bool report_undeciphered = 0;
37 module_param(report_undeciphered, bool, 0644);
38 MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state field using a MSC_RAW event");
40 #define TOUCH_REPORT_ID 0x29
41 /* These definitions are not precise, but they're close enough. (Bits
42 * 0x03 seem to indicate the aspect ratio of the touch, bits 0x70 seem
43 * to be some kind of bit mask -- 0x20 may be a near-field reading,
44 * and 0x40 is actual contact, and 0x10 may be a start/stop or change
47 #define TOUCH_STATE_MASK 0xf0
48 #define TOUCH_STATE_NONE 0x00
49 #define TOUCH_STATE_START 0x30
50 #define TOUCH_STATE_DRAG 0x40
53 * struct magicmouse_sc - Tracks Magic Mouse-specific data.
54 * @input: Input device through which we report events.
55 * @quirks: Currently unused.
56 * @last_timestamp: Timestamp from most recent (18-bit) touch report
57 * (units of milliseconds over short windows, but seems to
58 * increase faster when there are no touches).
59 * @delta_time: 18-bit difference between the two most recent touch
60 * reports from the mouse.
61 * @ntouches: Number of touches in most recent touch report.
62 * @scroll_accel: Number of consecutive scroll motions.
63 * @scroll_jiffies: Time of last scroll motion.
64 * @touches: Most recent data for a touch, indexed by tracking ID.
65 * @tracking_ids: Mapping of current touch input data to @touches.
67 struct magicmouse_sc {
68 struct input_dev *input;
75 unsigned long scroll_jiffies;
86 static int magicmouse_firm_touch(struct magicmouse_sc *msc)
91 /* If there is only one "firm" touch, set touch to its
94 for (ii = 0; ii < msc->ntouches; ii++) {
95 int idx = msc->tracking_ids[ii];
96 if (msc->touches[idx].size < 8) {
97 /* Ignore this touch. */
98 } else if (touch >= 0) {
109 static void magicmouse_emit_buttons(struct magicmouse_sc *msc, int state)
111 int last_state = test_bit(BTN_LEFT, msc->input->key) << 0 |
112 test_bit(BTN_RIGHT, msc->input->key) << 1 |
113 test_bit(BTN_MIDDLE, msc->input->key) << 2;
115 if (emulate_3button) {
118 /* If some button was pressed before, keep it held
119 * down. Otherwise, if there's exactly one firm
120 * touch, use that to override the mouse's guess.
123 /* The button was released. */
124 } else if (last_state != 0) {
126 } else if ((id = magicmouse_firm_touch(msc)) >= 0) {
127 int x = msc->touches[id].x;
128 if (x < middle_button_start)
130 else if (x > middle_button_stop)
134 } /* else: we keep the mouse's guess */
136 input_report_key(msc->input, BTN_MIDDLE, state & 4);
139 input_report_key(msc->input, BTN_LEFT, state & 1);
140 input_report_key(msc->input, BTN_RIGHT, state & 2);
142 if (state != last_state)
143 msc->scroll_accel = 0;
146 static void magicmouse_emit_touch(struct magicmouse_sc *msc, int raw_id, u8 *tdata)
148 struct input_dev *input = msc->input;
149 __s32 x_y = tdata[0] << 8 | tdata[1] << 16 | tdata[2] << 24;
150 int misc = tdata[5] | tdata[6] << 8;
151 int id = (misc >> 6) & 15;
152 int x = x_y << 12 >> 20;
153 int y = -(x_y >> 20);
155 /* Store tracking ID and other fields. */
156 msc->tracking_ids[raw_id] = id;
157 msc->touches[id].x = x;
158 msc->touches[id].y = y;
159 msc->touches[id].size = misc & 63;
161 /* If requested, emulate a scroll wheel by detecting small
162 * vertical touch motions along the middle of the mouse.
164 if (emulate_scroll_wheel &&
165 middle_button_start < x && x < middle_button_stop) {
166 static const int accel_profile[] = {
167 256, 228, 192, 160, 128, 96, 64, 32,
169 unsigned long now = jiffies;
170 int step = msc->touches[id].scroll_y - y;
172 /* Reset acceleration after half a second. */
173 if (time_after(now, msc->scroll_jiffies + HZ / 2))
174 msc->scroll_accel = 0;
176 /* Calculate and apply the scroll motion. */
177 switch (tdata[7] & TOUCH_STATE_MASK) {
178 case TOUCH_STATE_START:
179 msc->touches[id].scroll_y = y;
180 msc->scroll_accel = min_t(int, msc->scroll_accel + 1,
181 ARRAY_SIZE(accel_profile) - 1);
183 case TOUCH_STATE_DRAG:
184 step = step / accel_profile[msc->scroll_accel];
186 msc->touches[id].scroll_y = y;
187 msc->scroll_jiffies = now;
188 input_report_rel(input, REL_WHEEL, step);
194 /* Generate the input events for this touch. */
195 if (report_touches) {
196 int orientation = (misc >> 10) - 32;
198 input_report_abs(input, ABS_MT_TRACKING_ID, id);
199 input_report_abs(input, ABS_MT_TOUCH_MAJOR, tdata[3]);
200 input_report_abs(input, ABS_MT_TOUCH_MINOR, tdata[4]);
201 input_report_abs(input, ABS_MT_ORIENTATION, orientation);
202 input_report_abs(input, ABS_MT_POSITION_X, x);
203 input_report_abs(input, ABS_MT_POSITION_Y, y);
205 if (report_undeciphered) {
206 input_event(input, EV_MSC, MSC_RAW, tdata[7]);
209 input_mt_sync(input);
213 static int magicmouse_raw_event(struct hid_device *hdev,
214 struct hid_report *report, u8 *data, int size)
216 struct magicmouse_sc *msc = hid_get_drvdata(hdev);
217 struct input_dev *input = msc->input;
218 int x, y, ts, ii, clicks;
224 x = (__s16)(data[2] | data[3] << 8);
225 y = (__s16)(data[4] | data[5] << 8);
228 case TOUCH_REPORT_ID:
229 /* Expect six bytes of prefix, and N*8 bytes of touch data. */
230 if (size < 6 || ((size - 6) % 8) != 0)
232 ts = data[3] >> 6 | data[4] << 2 | data[5] << 10;
233 msc->delta_time = (ts - msc->last_timestamp) & 0x3ffff;
234 msc->last_timestamp = ts;
235 msc->ntouches = (size - 6) / 8;
236 for (ii = 0; ii < msc->ntouches; ii++)
237 magicmouse_emit_touch(msc, ii, data + ii * 8 + 6);
238 /* When emulating three-button mode, it is important
239 * to have the current touch information before
240 * generating a click event.
242 x = (signed char)data[1];
243 y = (signed char)data[2];
246 case 0x20: /* Theoretically battery status (0-100), but I have
247 * never seen it -- maybe it is only upon request.
249 case 0x60: /* Unknown, maybe laser on/off. */
250 case 0x61: /* Laser reflection status change.
251 * data[1]: 0 = spotted, 1 = lost
257 magicmouse_emit_buttons(msc, clicks & 3);
258 input_report_rel(input, REL_X, x);
259 input_report_rel(input, REL_Y, y);
264 static int magicmouse_input_open(struct input_dev *dev)
266 struct hid_device *hid = input_get_drvdata(dev);
268 return hid->ll_driver->open(hid);
271 static void magicmouse_input_close(struct input_dev *dev)
273 struct hid_device *hid = input_get_drvdata(dev);
275 hid->ll_driver->close(hid);
278 static void magicmouse_setup_input(struct input_dev *input, struct hid_device *hdev)
280 input_set_drvdata(input, hdev);
281 input->event = hdev->ll_driver->hidinput_input_event;
282 input->open = magicmouse_input_open;
283 input->close = magicmouse_input_close;
285 input->name = hdev->name;
286 input->phys = hdev->phys;
287 input->uniq = hdev->uniq;
288 input->id.bustype = hdev->bus;
289 input->id.vendor = hdev->vendor;
290 input->id.product = hdev->product;
291 input->id.version = hdev->version;
292 input->dev.parent = hdev->dev.parent;
294 set_bit(EV_KEY, input->evbit);
295 set_bit(BTN_LEFT, input->keybit);
296 set_bit(BTN_RIGHT, input->keybit);
298 set_bit(BTN_MIDDLE, input->keybit);
299 set_bit(BTN_TOOL_FINGER, input->keybit);
301 set_bit(EV_REL, input->evbit);
302 set_bit(REL_X, input->relbit);
303 set_bit(REL_Y, input->relbit);
304 if (emulate_scroll_wheel)
305 set_bit(REL_WHEEL, input->relbit);
307 if (report_touches) {
308 set_bit(EV_ABS, input->evbit);
310 set_bit(ABS_MT_TRACKING_ID, input->absbit);
311 input->absmin[ABS_MT_TRACKING_ID] = 0;
312 input->absmax[ABS_MT_TRACKING_ID] = 15;
313 input->absfuzz[ABS_MT_TRACKING_ID] = 0;
315 set_bit(ABS_MT_TOUCH_MAJOR, input->absbit);
316 input->absmin[ABS_MT_TOUCH_MAJOR] = 0;
317 input->absmax[ABS_MT_TOUCH_MAJOR] = 255;
318 input->absfuzz[ABS_MT_TOUCH_MAJOR] = 4;
320 set_bit(ABS_MT_TOUCH_MINOR, input->absbit);
321 input->absmin[ABS_MT_TOUCH_MINOR] = 0;
322 input->absmax[ABS_MT_TOUCH_MINOR] = 255;
323 input->absfuzz[ABS_MT_TOUCH_MINOR] = 4;
325 set_bit(ABS_MT_ORIENTATION, input->absbit);
326 input->absmin[ABS_MT_ORIENTATION] = -32;
327 input->absmax[ABS_MT_ORIENTATION] = 31;
328 input->absfuzz[ABS_MT_ORIENTATION] = 1;
330 set_bit(ABS_MT_POSITION_X, input->absbit);
331 input->absmin[ABS_MT_POSITION_X] = -1100;
332 input->absmax[ABS_MT_POSITION_X] = 1358;
333 input->absfuzz[ABS_MT_POSITION_X] = 4;
335 /* Note: Touch Y position from the device is inverted relative
336 * to how pointer motion is reported (and relative to how USB
337 * HID recommends the coordinates work). This driver keeps
338 * the origin at the same position, and just uses the additive
339 * inverse of the reported Y.
341 set_bit(ABS_MT_POSITION_Y, input->absbit);
342 input->absmin[ABS_MT_POSITION_Y] = -1589;
343 input->absmax[ABS_MT_POSITION_Y] = 2047;
344 input->absfuzz[ABS_MT_POSITION_Y] = 4;
347 if (report_undeciphered) {
348 set_bit(EV_MSC, input->evbit);
349 set_bit(MSC_RAW, input->mscbit);
353 static int magicmouse_probe(struct hid_device *hdev,
354 const struct hid_device_id *id)
356 __u8 feature_1[] = { 0xd7, 0x01 };
357 __u8 feature_2[] = { 0xf8, 0x01, 0x32 };
358 struct input_dev *input;
359 struct magicmouse_sc *msc;
360 struct hid_report *report;
363 msc = kzalloc(sizeof(*msc), GFP_KERNEL);
365 dev_err(&hdev->dev, "can't alloc magicmouse descriptor\n");
369 msc->quirks = id->driver_data;
370 hid_set_drvdata(hdev, msc);
372 ret = hid_parse(hdev);
374 dev_err(&hdev->dev, "magicmouse hid parse failed\n");
378 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
380 dev_err(&hdev->dev, "magicmouse hw start failed\n");
384 report = hid_register_report(hdev, HID_INPUT_REPORT, TOUCH_REPORT_ID);
386 dev_err(&hdev->dev, "unable to register touch report\n");
392 ret = hdev->hid_output_raw_report(hdev, feature_1, sizeof(feature_1),
394 if (ret != sizeof(feature_1)) {
395 dev_err(&hdev->dev, "unable to request touch data (1:%d)\n",
399 ret = hdev->hid_output_raw_report(hdev, feature_2,
400 sizeof(feature_2), HID_FEATURE_REPORT);
401 if (ret != sizeof(feature_2)) {
402 dev_err(&hdev->dev, "unable to request touch data (2:%d)\n",
407 input = input_allocate_device();
409 dev_err(&hdev->dev, "can't alloc input device\n");
413 magicmouse_setup_input(input, hdev);
415 ret = input_register_device(input);
417 dev_err(&hdev->dev, "input device registration failed\n");
424 input_free_device(input);
430 static void magicmouse_remove(struct hid_device *hdev)
433 kfree(hid_get_drvdata(hdev));
436 static const struct hid_device_id magic_mice[] = {
437 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGICMOUSE),
441 MODULE_DEVICE_TABLE(hid, magic_mice);
443 static struct hid_driver magicmouse_driver = {
444 .name = "magicmouse",
445 .id_table = magic_mice,
446 .probe = magicmouse_probe,
447 .remove = magicmouse_remove,
448 .raw_event = magicmouse_raw_event,
451 static int __init magicmouse_init(void)
455 ret = hid_register_driver(&magicmouse_driver);
457 printk(KERN_ERR "can't register magicmouse driver\n");
462 static void __exit magicmouse_exit(void)
464 hid_unregister_driver(&magicmouse_driver);
467 module_init(magicmouse_init);
468 module_exit(magicmouse_exit);
469 MODULE_LICENSE("GPL");