HID: hid-magicmouse: Increase evdev buffer size
[linux-2.6.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/module.h>
20 #include <linux/slab.h>
21 #include <linux/usb.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 || strict_strtoul(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_touches = true;
52 module_param(report_touches, bool, 0644);
53 MODULE_PARM_DESC(report_touches, "Emit touch records (otherwise, only use them for emulation)");
54
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");
58
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.)
67  */
68 #define TOUCH_STATE_MASK  0xf0
69 #define TOUCH_STATE_NONE  0x00
70 #define TOUCH_STATE_START 0x30
71 #define TOUCH_STATE_DRAG  0x40
72
73 #define SCROLL_ACCEL_DEFAULT 7
74
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  * occuring, single_touch_id corresponds with the tracking id of the touch used.
80  */
81 #define NO_TOUCHES -1
82 #define SINGLE_TOUCH_UP -2
83
84 /**
85  * struct magicmouse_sc - Tracks Magic Mouse-specific data.
86  * @input: Input device through which we report events.
87  * @quirks: Currently unused.
88  * @ntouches: Number of touches in most recent touch report.
89  * @scroll_accel: Number of consecutive scroll motions.
90  * @scroll_jiffies: Time of last scroll motion.
91  * @touches: Most recent data for a touch, indexed by tracking ID.
92  * @tracking_ids: Mapping of current touch input data to @touches.
93  */
94 struct magicmouse_sc {
95         struct input_dev *input;
96         unsigned long quirks;
97
98         int ntouches;
99         int scroll_accel;
100         unsigned long scroll_jiffies;
101
102         struct {
103                 short x;
104                 short y;
105                 short scroll_x;
106                 short scroll_y;
107                 u8 size;
108         } touches[16];
109         int tracking_ids[16];
110         int single_touch_id;
111 };
112
113 static int magicmouse_firm_touch(struct magicmouse_sc *msc)
114 {
115         int touch = -1;
116         int ii;
117
118         /* If there is only one "firm" touch, set touch to its
119          * tracking ID.
120          */
121         for (ii = 0; ii < msc->ntouches; ii++) {
122                 int idx = msc->tracking_ids[ii];
123                 if (msc->touches[idx].size < 8) {
124                         /* Ignore this touch. */
125                 } else if (touch >= 0) {
126                         touch = -1;
127                         break;
128                 } else {
129                         touch = idx;
130                 }
131         }
132
133         return touch;
134 }
135
136 static void magicmouse_emit_buttons(struct magicmouse_sc *msc, int state)
137 {
138         int last_state = test_bit(BTN_LEFT, msc->input->key) << 0 |
139                 test_bit(BTN_RIGHT, msc->input->key) << 1 |
140                 test_bit(BTN_MIDDLE, msc->input->key) << 2;
141
142         if (emulate_3button) {
143                 int id;
144
145                 /* If some button was pressed before, keep it held
146                  * down.  Otherwise, if there's exactly one firm
147                  * touch, use that to override the mouse's guess.
148                  */
149                 if (state == 0) {
150                         /* The button was released. */
151                 } else if (last_state != 0) {
152                         state = last_state;
153                 } else if ((id = magicmouse_firm_touch(msc)) >= 0) {
154                         int x = msc->touches[id].x;
155                         if (x < middle_button_start)
156                                 state = 1;
157                         else if (x > middle_button_stop)
158                                 state = 2;
159                         else
160                                 state = 4;
161                 } /* else: we keep the mouse's guess */
162
163                 input_report_key(msc->input, BTN_MIDDLE, state & 4);
164         }
165
166         input_report_key(msc->input, BTN_LEFT, state & 1);
167         input_report_key(msc->input, BTN_RIGHT, state & 2);
168
169         if (state != last_state)
170                 msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
171 }
172
173 static void magicmouse_emit_touch(struct magicmouse_sc *msc, int raw_id, u8 *tdata)
174 {
175         struct input_dev *input = msc->input;
176         int id, x, y, size, orientation, touch_major, touch_minor, state, down;
177
178         if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
179                 id = (tdata[6] << 2 | tdata[5] >> 6) & 0xf;
180                 x = (tdata[1] << 28 | tdata[0] << 20) >> 20;
181                 y = -((tdata[2] << 24 | tdata[1] << 16) >> 20);
182                 size = tdata[5] & 0x3f;
183                 orientation = (tdata[6] >> 2) - 32;
184                 touch_major = tdata[3];
185                 touch_minor = tdata[4];
186                 state = tdata[7] & TOUCH_STATE_MASK;
187                 down = state != TOUCH_STATE_NONE;
188         } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
189                 id = (tdata[7] << 2 | tdata[6] >> 6) & 0xf;
190                 x = (tdata[1] << 27 | tdata[0] << 19) >> 19;
191                 y = -((tdata[3] << 30 | tdata[2] << 22 | tdata[1] << 14) >> 19);
192                 size = tdata[6] & 0x3f;
193                 orientation = (tdata[7] >> 2) - 32;
194                 touch_major = tdata[4];
195                 touch_minor = tdata[5];
196                 state = tdata[8] & TOUCH_STATE_MASK;
197                 down = state != TOUCH_STATE_NONE;
198         }
199
200         /* Store tracking ID and other fields. */
201         msc->tracking_ids[raw_id] = id;
202         msc->touches[id].x = x;
203         msc->touches[id].y = y;
204         msc->touches[id].size = size;
205
206         /* If requested, emulate a scroll wheel by detecting small
207          * vertical touch motions.
208          */
209         if (emulate_scroll_wheel) {
210                 unsigned long now = jiffies;
211                 int step_x = msc->touches[id].scroll_x - x;
212                 int step_y = msc->touches[id].scroll_y - y;
213
214                 /* Calculate and apply the scroll motion. */
215                 switch (state) {
216                 case TOUCH_STATE_START:
217                         msc->touches[id].scroll_x = x;
218                         msc->touches[id].scroll_y = y;
219
220                         /* Reset acceleration after half a second. */
221                         if (scroll_acceleration && time_before(now,
222                                                 msc->scroll_jiffies + HZ / 2))
223                                 msc->scroll_accel = max_t(int,
224                                                 msc->scroll_accel - 1, 1);
225                         else
226                                 msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
227
228                         break;
229                 case TOUCH_STATE_DRAG:
230                         step_x /= (64 - (int)scroll_speed) * msc->scroll_accel;
231                         if (step_x != 0) {
232                                 msc->touches[id].scroll_x -= step_x *
233                                         (64 - scroll_speed) * msc->scroll_accel;
234                                 msc->scroll_jiffies = now;
235                                 input_report_rel(input, REL_HWHEEL, -step_x);
236                         }
237
238                         step_y /= (64 - (int)scroll_speed) * msc->scroll_accel;
239                         if (step_y != 0) {
240                                 msc->touches[id].scroll_y -= step_y *
241                                         (64 - scroll_speed) * msc->scroll_accel;
242                                 msc->scroll_jiffies = now;
243                                 input_report_rel(input, REL_WHEEL, step_y);
244                         }
245                         break;
246                 }
247         }
248
249         if (down) {
250                 msc->ntouches++;
251                 if (msc->single_touch_id == NO_TOUCHES)
252                         msc->single_touch_id = id;
253         } else if (msc->single_touch_id == id)
254                 msc->single_touch_id = SINGLE_TOUCH_UP;
255
256         /* Generate the input events for this touch. */
257         if (report_touches && down) {
258                 input_report_abs(input, ABS_MT_TRACKING_ID, id);
259                 input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major << 2);
260                 input_report_abs(input, ABS_MT_TOUCH_MINOR, touch_minor << 2);
261                 input_report_abs(input, ABS_MT_ORIENTATION, -orientation);
262                 input_report_abs(input, ABS_MT_POSITION_X, x);
263                 input_report_abs(input, ABS_MT_POSITION_Y, y);
264
265                 if (report_undeciphered) {
266                         if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
267                                 input_event(input, EV_MSC, MSC_RAW, tdata[7]);
268                         else /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
269                                 input_event(input, EV_MSC, MSC_RAW, tdata[8]);
270                 }
271
272                 input_mt_sync(input);
273         }
274 }
275
276 static int magicmouse_raw_event(struct hid_device *hdev,
277                 struct hid_report *report, u8 *data, int size)
278 {
279         struct magicmouse_sc *msc = hid_get_drvdata(hdev);
280         struct input_dev *input = msc->input;
281         int x = 0, y = 0, ii, clicks = 0, npoints;
282
283         switch (data[0]) {
284         case TRACKPAD_REPORT_ID:
285                 /* Expect four bytes of prefix, and N*9 bytes of touch data. */
286                 if (size < 4 || ((size - 4) % 9) != 0)
287                         return 0;
288                 npoints = (size - 4) / 9;
289                 msc->ntouches = 0;
290                 for (ii = 0; ii < npoints; ii++)
291                         magicmouse_emit_touch(msc, ii, data + ii * 9 + 4);
292
293                 /* We don't need an MT sync here because trackpad emits a
294                  * BTN_TOUCH event in a new frame when all touches are released.
295                  */
296                 if (msc->ntouches == 0)
297                         msc->single_touch_id = NO_TOUCHES;
298
299                 clicks = data[1];
300
301                 /* The following bits provide a device specific timestamp. They
302                  * are unused here.
303                  *
304                  * ts = data[1] >> 6 | data[2] << 2 | data[3] << 10;
305                  */
306                 break;
307         case MOUSE_REPORT_ID:
308                 /* Expect six bytes of prefix, and N*8 bytes of touch data. */
309                 if (size < 6 || ((size - 6) % 8) != 0)
310                         return 0;
311                 npoints = (size - 6) / 8;
312                 msc->ntouches = 0;
313                 for (ii = 0; ii < npoints; ii++)
314                         magicmouse_emit_touch(msc, ii, data + ii * 8 + 6);
315
316                 if (report_touches && msc->ntouches == 0)
317                         input_mt_sync(input);
318
319                 /* When emulating three-button mode, it is important
320                  * to have the current touch information before
321                  * generating a click event.
322                  */
323                 x = (int)(((data[3] & 0x0c) << 28) | (data[1] << 22)) >> 22;
324                 y = (int)(((data[3] & 0x30) << 26) | (data[2] << 22)) >> 22;
325                 clicks = data[3];
326
327                 /* The following bits provide a device specific timestamp. They
328                  * are unused here.
329                  *
330                  * ts = data[3] >> 6 | data[4] << 2 | data[5] << 10;
331                  */
332                 break;
333         case DOUBLE_REPORT_ID:
334                 /* Sometimes the trackpad sends two touch reports in one
335                  * packet.
336                  */
337                 magicmouse_raw_event(hdev, report, data + 2, data[1]);
338                 magicmouse_raw_event(hdev, report, data + 2 + data[1],
339                         size - 2 - data[1]);
340                 break;
341         default:
342                 return 0;
343         }
344
345         if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
346                 magicmouse_emit_buttons(msc, clicks & 3);
347                 input_report_rel(input, REL_X, x);
348                 input_report_rel(input, REL_Y, y);
349         } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
350                 input_report_key(input, BTN_MOUSE, clicks & 1);
351                 input_report_key(input, BTN_TOUCH, msc->ntouches > 0);
352                 input_report_key(input, BTN_TOOL_FINGER, msc->ntouches == 1);
353                 input_report_key(input, BTN_TOOL_DOUBLETAP, msc->ntouches == 2);
354                 input_report_key(input, BTN_TOOL_TRIPLETAP, msc->ntouches == 3);
355                 input_report_key(input, BTN_TOOL_QUADTAP, msc->ntouches == 4);
356                 if (msc->single_touch_id >= 0) {
357                         input_report_abs(input, ABS_X,
358                                 msc->touches[msc->single_touch_id].x);
359                         input_report_abs(input, ABS_Y,
360                                 msc->touches[msc->single_touch_id].y);
361                 }
362         }
363
364         input_sync(input);
365         return 1;
366 }
367
368 static void magicmouse_setup_input(struct input_dev *input, struct hid_device *hdev)
369 {
370         __set_bit(EV_KEY, input->evbit);
371
372         if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
373                 __set_bit(BTN_LEFT, input->keybit);
374                 __set_bit(BTN_RIGHT, input->keybit);
375                 if (emulate_3button)
376                         __set_bit(BTN_MIDDLE, input->keybit);
377
378                 __set_bit(EV_REL, input->evbit);
379                 __set_bit(REL_X, input->relbit);
380                 __set_bit(REL_Y, input->relbit);
381                 if (emulate_scroll_wheel) {
382                         __set_bit(REL_WHEEL, input->relbit);
383                         __set_bit(REL_HWHEEL, input->relbit);
384                 }
385         } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
386                 __set_bit(BTN_MOUSE, input->keybit);
387                 __set_bit(BTN_TOOL_FINGER, input->keybit);
388                 __set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
389                 __set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
390                 __set_bit(BTN_TOOL_QUADTAP, input->keybit);
391                 __set_bit(BTN_TOUCH, input->keybit);
392         }
393
394         if (report_touches) {
395                 __set_bit(EV_ABS, input->evbit);
396
397                 input_set_abs_params(input, ABS_MT_TRACKING_ID, 0, 15, 0, 0);
398                 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 4, 0);
399                 input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 4, 0);
400                 input_set_abs_params(input, ABS_MT_ORIENTATION, -31, 32, 1, 0);
401
402                 /* Note: Touch Y position from the device is inverted relative
403                  * to how pointer motion is reported (and relative to how USB
404                  * HID recommends the coordinates work).  This driver keeps
405                  * the origin at the same position, and just uses the additive
406                  * inverse of the reported Y.
407                  */
408                 if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
409                         input_set_abs_params(input, ABS_MT_POSITION_X, -1100,
410                                 1358, 4, 0);
411                         input_set_abs_params(input, ABS_MT_POSITION_Y, -1589,
412                                 2047, 4, 0);
413                 } else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
414                         input_set_abs_params(input, ABS_X, -2909, 3167, 4, 0);
415                         input_set_abs_params(input, ABS_Y, -2456, 2565, 4, 0);
416                         input_set_abs_params(input, ABS_MT_POSITION_X, -2909,
417                                 3167, 4, 0);
418                         input_set_abs_params(input, ABS_MT_POSITION_Y, -2456,
419                                 2565, 4, 0);
420                 }
421
422                 input_set_events_per_packet(input, 60);
423         }
424
425         if (report_undeciphered) {
426                 __set_bit(EV_MSC, input->evbit);
427                 __set_bit(MSC_RAW, input->mscbit);
428         }
429 }
430
431 static int magicmouse_input_mapping(struct hid_device *hdev,
432                 struct hid_input *hi, struct hid_field *field,
433                 struct hid_usage *usage, unsigned long **bit, int *max)
434 {
435         struct magicmouse_sc *msc = hid_get_drvdata(hdev);
436
437         if (!msc->input)
438                 msc->input = hi->input;
439
440         /* Magic Trackpad does not give relative data after switching to MT */
441         if (hi->input->id.product == USB_DEVICE_ID_APPLE_MAGICTRACKPAD &&
442             field->flags & HID_MAIN_ITEM_RELATIVE)
443                 return -1;
444
445         return 0;
446 }
447
448 static int magicmouse_probe(struct hid_device *hdev,
449         const struct hid_device_id *id)
450 {
451         __u8 feature[] = { 0xd7, 0x01 };
452         struct magicmouse_sc *msc;
453         struct hid_report *report;
454         int ret;
455
456         msc = kzalloc(sizeof(*msc), GFP_KERNEL);
457         if (msc == NULL) {
458                 hid_err(hdev, "can't alloc magicmouse descriptor\n");
459                 return -ENOMEM;
460         }
461
462         msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
463
464         msc->quirks = id->driver_data;
465         hid_set_drvdata(hdev, msc);
466
467         msc->single_touch_id = NO_TOUCHES;
468
469         ret = hid_parse(hdev);
470         if (ret) {
471                 hid_err(hdev, "magicmouse hid parse failed\n");
472                 goto err_free;
473         }
474
475         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
476         if (ret) {
477                 hid_err(hdev, "magicmouse hw start failed\n");
478                 goto err_free;
479         }
480
481         /* We do this after hid-input is done parsing reports so that
482          * hid-input uses the most natural button and axis IDs.
483          */
484         if (msc->input)
485                 magicmouse_setup_input(msc->input, hdev);
486
487         if (id->product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
488                 report = hid_register_report(hdev, HID_INPUT_REPORT,
489                         MOUSE_REPORT_ID);
490         else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
491                 report = hid_register_report(hdev, HID_INPUT_REPORT,
492                         TRACKPAD_REPORT_ID);
493                 report = hid_register_report(hdev, HID_INPUT_REPORT,
494                         DOUBLE_REPORT_ID);
495         }
496
497         if (!report) {
498                 hid_err(hdev, "unable to register touch report\n");
499                 ret = -ENOMEM;
500                 goto err_stop_hw;
501         }
502         report->size = 6;
503
504         ret = hdev->hid_output_raw_report(hdev, feature, sizeof(feature),
505                         HID_FEATURE_REPORT);
506         if (ret != sizeof(feature)) {
507                 hid_err(hdev, "unable to request touch data (%d)\n", ret);
508                 goto err_stop_hw;
509         }
510
511         return 0;
512 err_stop_hw:
513         hid_hw_stop(hdev);
514 err_free:
515         kfree(msc);
516         return ret;
517 }
518
519 static void magicmouse_remove(struct hid_device *hdev)
520 {
521         struct magicmouse_sc *msc = hid_get_drvdata(hdev);
522
523         hid_hw_stop(hdev);
524         kfree(msc);
525 }
526
527 static const struct hid_device_id magic_mice[] = {
528         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
529                 USB_DEVICE_ID_APPLE_MAGICMOUSE), .driver_data = 0 },
530         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
531                 USB_DEVICE_ID_APPLE_MAGICTRACKPAD), .driver_data = 0 },
532         { }
533 };
534 MODULE_DEVICE_TABLE(hid, magic_mice);
535
536 static struct hid_driver magicmouse_driver = {
537         .name = "magicmouse",
538         .id_table = magic_mice,
539         .probe = magicmouse_probe,
540         .remove = magicmouse_remove,
541         .raw_event = magicmouse_raw_event,
542         .input_mapping = magicmouse_input_mapping,
543 };
544
545 static int __init magicmouse_init(void)
546 {
547         int ret;
548
549         ret = hid_register_driver(&magicmouse_driver);
550         if (ret)
551                 pr_err("can't register magicmouse driver\n");
552
553         return ret;
554 }
555
556 static void __exit magicmouse_exit(void)
557 {
558         hid_unregister_driver(&magicmouse_driver);
559 }
560
561 module_init(magicmouse_init);
562 module_exit(magicmouse_exit);
563 MODULE_LICENSE("GPL");