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