Root/drivers/hid/hid-magicmouse.c

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#include <linux/usb.h>
23
24#include "hid-ids.h"
25
26static bool emulate_3button = true;
27module_param(emulate_3button, bool, 0644);
28MODULE_PARM_DESC(emulate_3button, "Emulate a middle button");
29
30static int middle_button_start = -350;
31static int middle_button_stop = +350;
32
33static bool emulate_scroll_wheel = true;
34module_param(emulate_scroll_wheel, bool, 0644);
35MODULE_PARM_DESC(emulate_scroll_wheel, "Emulate a scroll wheel");
36
37static unsigned int scroll_speed = 32;
38static int param_set_scroll_speed(const char *val, struct kernel_param *kp) {
39    unsigned long speed;
40    if (!val || strict_strtoul(val, 0, &speed) || speed > 63)
41        return -EINVAL;
42    scroll_speed = speed;
43    return 0;
44}
45module_param_call(scroll_speed, param_set_scroll_speed, param_get_uint, &scroll_speed, 0644);
46MODULE_PARM_DESC(scroll_speed, "Scroll speed, value from 0 (slow) to 63 (fast)");
47
48static bool scroll_acceleration = false;
49module_param(scroll_acceleration, bool, 0644);
50MODULE_PARM_DESC(scroll_acceleration, "Accelerate sequential scroll events");
51
52static bool report_undeciphered;
53module_param(report_undeciphered, bool, 0644);
54MODULE_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 */
104struct 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
122static 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
145static 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
182static 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
281static 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        msc->ntouches = 0;
295        for (ii = 0; ii < npoints; ii++)
296            magicmouse_emit_touch(msc, ii, data + ii * 9 + 4);
297
298        clicks = data[1];
299
300        /* The following bits provide a device specific timestamp. They
301         * are unused here.
302         *
303         * ts = data[1] >> 6 | data[2] << 2 | data[3] << 10;
304         */
305        break;
306    case MOUSE_REPORT_ID:
307        /* Expect six bytes of prefix, and N*8 bytes of touch data. */
308        if (size < 6 || ((size - 6) % 8) != 0)
309            return 0;
310        npoints = (size - 6) / 8;
311        msc->ntouches = 0;
312        for (ii = 0; ii < npoints; ii++)
313            magicmouse_emit_touch(msc, ii, data + ii * 8 + 6);
314
315        /* When emulating three-button mode, it is important
316         * to have the current touch information before
317         * generating a click event.
318         */
319        x = (int)(((data[3] & 0x0c) << 28) | (data[1] << 22)) >> 22;
320        y = (int)(((data[3] & 0x30) << 26) | (data[2] << 22)) >> 22;
321        clicks = data[3];
322
323        /* The following bits provide a device specific timestamp. They
324         * are unused here.
325         *
326         * ts = data[3] >> 6 | data[4] << 2 | data[5] << 10;
327         */
328        break;
329    case DOUBLE_REPORT_ID:
330        /* Sometimes the trackpad sends two touch reports in one
331         * packet.
332         */
333        magicmouse_raw_event(hdev, report, data + 2, data[1]);
334        magicmouse_raw_event(hdev, report, data + 2 + data[1],
335            size - 2 - data[1]);
336        break;
337    default:
338        return 0;
339    }
340
341    if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
342        magicmouse_emit_buttons(msc, clicks & 3);
343        input_report_rel(input, REL_X, x);
344        input_report_rel(input, REL_Y, y);
345    } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
346        input_report_key(input, BTN_MOUSE, clicks & 1);
347        input_mt_report_pointer_emulation(input, true);
348    }
349
350    input_sync(input);
351    return 1;
352}
353
354static int magicmouse_setup_input(struct input_dev *input, struct hid_device *hdev)
355{
356    int error;
357
358    __set_bit(EV_KEY, input->evbit);
359
360    if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
361        __set_bit(BTN_LEFT, input->keybit);
362        __set_bit(BTN_RIGHT, input->keybit);
363        if (emulate_3button)
364            __set_bit(BTN_MIDDLE, input->keybit);
365
366        __set_bit(EV_REL, input->evbit);
367        __set_bit(REL_X, input->relbit);
368        __set_bit(REL_Y, input->relbit);
369        if (emulate_scroll_wheel) {
370            __set_bit(REL_WHEEL, input->relbit);
371            __set_bit(REL_HWHEEL, input->relbit);
372        }
373    } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
374        /* input->keybit is initialized with incorrect button info
375         * for Magic Trackpad. There really is only one physical
376         * button (BTN_LEFT == BTN_MOUSE). Make sure we don't
377         * advertise buttons that don't exist...
378         */
379        __clear_bit(BTN_RIGHT, input->keybit);
380        __clear_bit(BTN_MIDDLE, input->keybit);
381        __set_bit(BTN_MOUSE, input->keybit);
382        __set_bit(BTN_TOOL_FINGER, input->keybit);
383        __set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
384        __set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
385        __set_bit(BTN_TOOL_QUADTAP, input->keybit);
386        __set_bit(BTN_TOOL_QUINTTAP, input->keybit);
387        __set_bit(BTN_TOUCH, input->keybit);
388        __set_bit(INPUT_PROP_POINTER, input->propbit);
389        __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
390    }
391
392
393    __set_bit(EV_ABS, input->evbit);
394
395    error = input_mt_init_slots(input, 16);
396    if (error)
397        return error;
398    input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255 << 2,
399                 4, 0);
400    input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255 << 2,
401                 4, 0);
402    input_set_abs_params(input, ABS_MT_ORIENTATION, -31, 32, 1, 0);
403
404    /* Note: Touch Y position from the device is inverted relative
405     * to how pointer motion is reported (and relative to how USB
406     * HID recommends the coordinates work). This driver keeps
407     * the origin at the same position, and just uses the additive
408     * inverse of the reported Y.
409     */
410    if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
411        input_set_abs_params(input, ABS_MT_POSITION_X,
412                     MOUSE_MIN_X, MOUSE_MAX_X, 4, 0);
413        input_set_abs_params(input, ABS_MT_POSITION_Y,
414                     MOUSE_MIN_Y, MOUSE_MAX_Y, 4, 0);
415
416        input_abs_set_res(input, ABS_MT_POSITION_X,
417                  MOUSE_RES_X);
418        input_abs_set_res(input, ABS_MT_POSITION_Y,
419                  MOUSE_RES_Y);
420    } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
421        input_set_abs_params(input, ABS_X, TRACKPAD_MIN_X,
422                     TRACKPAD_MAX_X, 4, 0);
423        input_set_abs_params(input, ABS_Y, TRACKPAD_MIN_Y,
424                     TRACKPAD_MAX_Y, 4, 0);
425        input_set_abs_params(input, ABS_MT_POSITION_X,
426                     TRACKPAD_MIN_X, TRACKPAD_MAX_X, 4, 0);
427        input_set_abs_params(input, ABS_MT_POSITION_Y,
428                     TRACKPAD_MIN_Y, TRACKPAD_MAX_Y, 4, 0);
429
430        input_abs_set_res(input, ABS_X, TRACKPAD_RES_X);
431        input_abs_set_res(input, ABS_Y, TRACKPAD_RES_Y);
432        input_abs_set_res(input, ABS_MT_POSITION_X,
433                  TRACKPAD_RES_X);
434        input_abs_set_res(input, ABS_MT_POSITION_Y,
435                  TRACKPAD_RES_Y);
436    }
437
438    input_set_events_per_packet(input, 60);
439
440    if (report_undeciphered) {
441        __set_bit(EV_MSC, input->evbit);
442        __set_bit(MSC_RAW, input->mscbit);
443    }
444
445    return 0;
446}
447
448static int magicmouse_input_mapping(struct hid_device *hdev,
449        struct hid_input *hi, struct hid_field *field,
450        struct hid_usage *usage, unsigned long **bit, int *max)
451{
452    struct magicmouse_sc *msc = hid_get_drvdata(hdev);
453
454    if (!msc->input)
455        msc->input = hi->input;
456
457    /* Magic Trackpad does not give relative data after switching to MT */
458    if (hi->input->id.product == USB_DEVICE_ID_APPLE_MAGICTRACKPAD &&
459        field->flags & HID_MAIN_ITEM_RELATIVE)
460        return -1;
461
462    return 0;
463}
464
465static int magicmouse_probe(struct hid_device *hdev,
466    const struct hid_device_id *id)
467{
468    __u8 feature[] = { 0xd7, 0x01 };
469    struct magicmouse_sc *msc;
470    struct hid_report *report;
471    int ret;
472
473    msc = kzalloc(sizeof(*msc), GFP_KERNEL);
474    if (msc == NULL) {
475        hid_err(hdev, "can't alloc magicmouse descriptor\n");
476        return -ENOMEM;
477    }
478
479    msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
480
481    msc->quirks = id->driver_data;
482    hid_set_drvdata(hdev, msc);
483
484    ret = hid_parse(hdev);
485    if (ret) {
486        hid_err(hdev, "magicmouse hid parse failed\n");
487        goto err_free;
488    }
489
490    ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
491    if (ret) {
492        hid_err(hdev, "magicmouse hw start failed\n");
493        goto err_free;
494    }
495
496    /* We do this after hid-input is done parsing reports so that
497     * hid-input uses the most natural button and axis IDs.
498     */
499    if (msc->input) {
500        ret = magicmouse_setup_input(msc->input, hdev);
501        if (ret) {
502            hid_err(hdev, "magicmouse setup input failed (%d)\n", ret);
503            goto err_stop_hw;
504        }
505    }
506
507    if (id->product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
508        report = hid_register_report(hdev, HID_INPUT_REPORT,
509            MOUSE_REPORT_ID);
510    else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
511        report = hid_register_report(hdev, HID_INPUT_REPORT,
512            TRACKPAD_REPORT_ID);
513        report = hid_register_report(hdev, HID_INPUT_REPORT,
514            DOUBLE_REPORT_ID);
515    }
516
517    if (!report) {
518        hid_err(hdev, "unable to register touch report\n");
519        ret = -ENOMEM;
520        goto err_stop_hw;
521    }
522    report->size = 6;
523
524    /*
525     * Some devices repond with 'invalid report id' when feature
526     * report switching it into multitouch mode is sent to it.
527     *
528     * This results in -EIO from the _raw low-level transport callback,
529     * but there seems to be no other way of switching the mode.
530     * Thus the super-ugly hacky success check below.
531     */
532    ret = hdev->hid_output_raw_report(hdev, feature, sizeof(feature),
533            HID_FEATURE_REPORT);
534    if (ret != -EIO && ret != sizeof(feature)) {
535        hid_err(hdev, "unable to request touch data (%d)\n", ret);
536        goto err_stop_hw;
537    }
538
539    return 0;
540err_stop_hw:
541    hid_hw_stop(hdev);
542err_free:
543    kfree(msc);
544    return ret;
545}
546
547static void magicmouse_remove(struct hid_device *hdev)
548{
549    struct magicmouse_sc *msc = hid_get_drvdata(hdev);
550
551    hid_hw_stop(hdev);
552    kfree(msc);
553}
554
555static const struct hid_device_id magic_mice[] = {
556    { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
557        USB_DEVICE_ID_APPLE_MAGICMOUSE), .driver_data = 0 },
558    { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
559        USB_DEVICE_ID_APPLE_MAGICTRACKPAD), .driver_data = 0 },
560    { }
561};
562MODULE_DEVICE_TABLE(hid, magic_mice);
563
564static struct hid_driver magicmouse_driver = {
565    .name = "magicmouse",
566    .id_table = magic_mice,
567    .probe = magicmouse_probe,
568    .remove = magicmouse_remove,
569    .raw_event = magicmouse_raw_event,
570    .input_mapping = magicmouse_input_mapping,
571};
572
573static int __init magicmouse_init(void)
574{
575    int ret;
576
577    ret = hid_register_driver(&magicmouse_driver);
578    if (ret)
579        pr_err("can't register magicmouse driver\n");
580
581    return ret;
582}
583
584static void __exit magicmouse_exit(void)
585{
586    hid_unregister_driver(&magicmouse_driver);
587}
588
589module_init(magicmouse_init);
590module_exit(magicmouse_exit);
591MODULE_LICENSE("GPL");
592

Archive Download this file

Branches:
ben-wpan
ben-wpan-stefan
javiroman/ks7010
jz-2.6.34
jz-2.6.34-rc5
jz-2.6.34-rc6
jz-2.6.34-rc7
jz-2.6.35
jz-2.6.36
jz-2.6.37
jz-2.6.38
jz-2.6.39
jz-3.0
jz-3.1
jz-3.11
jz-3.12
jz-3.13
jz-3.15
jz-3.16
jz-3.18-dt
jz-3.2
jz-3.3
jz-3.4
jz-3.5
jz-3.6
jz-3.6-rc2-pwm
jz-3.9
jz-3.9-clk
jz-3.9-rc8
jz47xx
jz47xx-2.6.38
master

Tags:
od-2011-09-04
od-2011-09-18
v2.6.34-rc5
v2.6.34-rc6
v2.6.34-rc7
v3.9



interactive