Merge branch 'i2c-for-linus' of git://jdelvare.pck.nerim.net/jdelvare-2.6
[linux-2.6.git] / drivers / input / mouse / alps.c
1 /*
2  * ALPS touchpad PS/2 mouse driver
3  *
4  * Copyright (c) 2003 Neil Brown <neilb@cse.unsw.edu.au>
5  * Copyright (c) 2003-2005 Peter Osterlund <petero2@telia.com>
6  * Copyright (c) 2004 Dmitry Torokhov <dtor@mail.ru>
7  * Copyright (c) 2005 Vojtech Pavlik <vojtech@suse.cz>
8  *
9  * ALPS detection, tap switching and status querying info is taken from
10  * tpconfig utility (by C. Scott Ananian and Bruce Kall).
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU General Public License version 2 as published by
14  * the Free Software Foundation.
15  */
16
17 #include <linux/input.h>
18 #include <linux/serio.h>
19 #include <linux/libps2.h>
20
21 #include "psmouse.h"
22 #include "alps.h"
23
24 #undef DEBUG
25 #ifdef DEBUG
26 #define dbg(format, arg...) printk(KERN_INFO "alps.c: " format "\n", ## arg)
27 #else
28 #define dbg(format, arg...) do {} while (0)
29 #endif
30
31 #define ALPS_DUALPOINT  0x01
32 #define ALPS_WHEEL      0x02
33 #define ALPS_FW_BK_1    0x04
34 #define ALPS_4BTN       0x08
35 #define ALPS_OLDPROTO   0x10
36 #define ALPS_PASS       0x20
37 #define ALPS_FW_BK_2    0x40
38
39 static const struct alps_model_info alps_model_data[] = {
40         { { 0x33, 0x02, 0x0a }, 0x88, 0xf8, ALPS_OLDPROTO },            /* UMAX-530T */
41         { { 0x53, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
42         { { 0x53, 0x02, 0x14 }, 0xf8, 0xf8, 0 },
43         { { 0x60, 0x03, 0xc8 }, 0xf8, 0xf8, 0 },                        /* HP ze1115 */
44         { { 0x63, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
45         { { 0x63, 0x02, 0x14 }, 0xf8, 0xf8, 0 },
46         { { 0x63, 0x02, 0x28 }, 0xf8, 0xf8, ALPS_FW_BK_2 },             /* Fujitsu Siemens S6010 */
47         { { 0x63, 0x02, 0x3c }, 0x8f, 0x8f, ALPS_WHEEL },               /* Toshiba Satellite S2400-103 */
48         { { 0x63, 0x02, 0x50 }, 0xef, 0xef, ALPS_FW_BK_1 },             /* NEC Versa L320 */
49         { { 0x63, 0x02, 0x64 }, 0xf8, 0xf8, 0 },
50         { { 0x63, 0x03, 0xc8 }, 0xf8, 0xf8, ALPS_PASS },                /* Dell Latitude D800 */
51         { { 0x73, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
52         { { 0x73, 0x02, 0x14 }, 0xf8, 0xf8, ALPS_FW_BK_2 },             /* Ahtec Laptop */
53         { { 0x20, 0x02, 0x0e }, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, /* XXX */
54         { { 0x22, 0x02, 0x0a }, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT },
55         { { 0x22, 0x02, 0x14 }, 0xff, 0xff, ALPS_PASS | ALPS_DUALPOINT }, /* Dell Latitude D600 */
56 };
57
58 /*
59  * XXX - this entry is suspicious. First byte has zero lower nibble,
60  * which is what a normal mouse would report. Also, the value 0x0e
61  * isn't valid per PS/2 spec.
62  */
63
64 /*
65  * ALPS abolute Mode - new format
66  *
67  * byte 0:  1    ?    ?    ?    1    ?    ?    ?
68  * byte 1:  0   x6   x5   x4   x3   x2   x1   x0
69  * byte 2:  0   x10  x9   x8   x7    ?  fin  ges
70  * byte 3:  0   y9   y8   y7    1    M    R    L
71  * byte 4:  0   y6   y5   y4   y3   y2   y1   y0
72  * byte 5:  0   z6   z5   z4   z3   z2   z1   z0
73  *
74  * ?'s can have different meanings on different models,
75  * such as wheel rotation, extra buttons, stick buttons
76  * on a dualpoint, etc.
77  */
78
79 static void alps_process_packet(struct psmouse *psmouse)
80 {
81         struct alps_data *priv = psmouse->private;
82         unsigned char *packet = psmouse->packet;
83         struct input_dev *dev = psmouse->dev;
84         struct input_dev *dev2 = priv->dev2;
85         int x, y, z, ges, fin, left, right, middle;
86         int back = 0, forward = 0;
87
88         if ((packet[0] & 0xc8) == 0x08) {   /* 3-byte PS/2 packet */
89                 input_report_key(dev2, BTN_LEFT,   packet[0] & 1);
90                 input_report_key(dev2, BTN_RIGHT,  packet[0] & 2);
91                 input_report_key(dev2, BTN_MIDDLE, packet[0] & 4);
92                 input_report_rel(dev2, REL_X,
93                         packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0);
94                 input_report_rel(dev2, REL_Y,
95                         packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0);
96                 input_sync(dev2);
97                 return;
98         }
99
100         if (priv->i->flags & ALPS_OLDPROTO) {
101                 left = packet[2] & 0x10;
102                 right = packet[2] & 0x08;
103                 middle = 0;
104                 x = packet[1] | ((packet[0] & 0x07) << 7);
105                 y = packet[4] | ((packet[3] & 0x07) << 7);
106                 z = packet[5];
107         } else {
108                 left = packet[3] & 1;
109                 right = packet[3] & 2;
110                 middle = packet[3] & 4;
111                 x = packet[1] | ((packet[2] & 0x78) << (7 - 3));
112                 y = packet[4] | ((packet[3] & 0x70) << (7 - 4));
113                 z = packet[5];
114         }
115
116         if (priv->i->flags & ALPS_FW_BK_1) {
117                 back = packet[2] & 4;
118                 forward = packet[0] & 0x10;
119         }
120
121         if (priv->i->flags & ALPS_FW_BK_2) {
122                 back = packet[3] & 4;
123                 forward = packet[2] & 4;
124                 if ((middle = forward && back))
125                         forward = back = 0;
126         }
127
128         ges = packet[2] & 1;
129         fin = packet[2] & 2;
130
131         input_report_key(dev, BTN_LEFT, left);
132         input_report_key(dev, BTN_RIGHT, right);
133         input_report_key(dev, BTN_MIDDLE, middle);
134
135         if ((priv->i->flags & ALPS_DUALPOINT) && z == 127) {
136                 input_report_rel(dev2, REL_X,  (x > 383 ? (x - 768) : x));
137                 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y));
138                 input_sync(dev);
139                 input_sync(dev2);
140                 return;
141         }
142
143         /* Convert hardware tap to a reasonable Z value */
144         if (ges && !fin) z = 40;
145
146         /*
147          * A "tap and drag" operation is reported by the hardware as a transition
148          * from (!fin && ges) to (fin && ges). This should be translated to the
149          * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
150          */
151         if (ges && fin && !priv->prev_fin) {
152                 input_report_abs(dev, ABS_X, x);
153                 input_report_abs(dev, ABS_Y, y);
154                 input_report_abs(dev, ABS_PRESSURE, 0);
155                 input_report_key(dev, BTN_TOOL_FINGER, 0);
156                 input_sync(dev);
157         }
158         priv->prev_fin = fin;
159
160         if (z > 30) input_report_key(dev, BTN_TOUCH, 1);
161         if (z < 25) input_report_key(dev, BTN_TOUCH, 0);
162
163         if (z > 0) {
164                 input_report_abs(dev, ABS_X, x);
165                 input_report_abs(dev, ABS_Y, y);
166         }
167
168         input_report_abs(dev, ABS_PRESSURE, z);
169         input_report_key(dev, BTN_TOOL_FINGER, z > 0);
170
171         if (priv->i->flags & ALPS_WHEEL)
172                 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07));
173
174         if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
175                 input_report_key(dev, BTN_FORWARD, forward);
176                 input_report_key(dev, BTN_BACK, back);
177         }
178
179         input_sync(dev);
180 }
181
182 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse)
183 {
184         struct alps_data *priv = psmouse->private;
185
186         if ((psmouse->packet[0] & 0xc8) == 0x08) { /* PS/2 packet */
187                 if (psmouse->pktcnt == 3) {
188                         alps_process_packet(psmouse);
189                         return PSMOUSE_FULL_PACKET;
190                 }
191                 return PSMOUSE_GOOD_DATA;
192         }
193
194         if ((psmouse->packet[0] & priv->i->mask0) != priv->i->byte0)
195                 return PSMOUSE_BAD_DATA;
196
197         /* Bytes 2 - 6 should have 0 in the highest bit */
198         if (psmouse->pktcnt >= 2 && psmouse->pktcnt <= 6 &&
199             (psmouse->packet[psmouse->pktcnt - 1] & 0x80))
200                 return PSMOUSE_BAD_DATA;
201
202         if (psmouse->pktcnt == 6) {
203                 alps_process_packet(psmouse);
204                 return PSMOUSE_FULL_PACKET;
205         }
206
207         return PSMOUSE_GOOD_DATA;
208 }
209
210 static const struct alps_model_info *alps_get_model(struct psmouse *psmouse, int *version)
211 {
212         struct ps2dev *ps2dev = &psmouse->ps2dev;
213         static const unsigned char rates[] = { 0, 10, 20, 40, 60, 80, 100, 200 };
214         unsigned char param[4];
215         int i;
216
217         /*
218          * First try "E6 report".
219          * ALPS should return 0,0,10 or 0,0,100
220          */
221         param[0] = 0;
222         if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
223             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
224             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
225             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11))
226                 return NULL;
227
228         param[0] = param[1] = param[2] = 0xff;
229         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
230                 return NULL;
231
232         dbg("E6 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
233
234         if (param[0] != 0 || param[1] != 0 || (param[2] != 10 && param[2] != 100))
235                 return NULL;
236
237         /*
238          * Now try "E7 report". Allowed responses are in
239          * alps_model_data[].signature
240          */
241         param[0] = 0;
242         if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
243             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21) ||
244             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21) ||
245             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21))
246                 return NULL;
247
248         param[0] = param[1] = param[2] = 0xff;
249         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
250                 return NULL;
251
252         dbg("E7 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
253
254         for (i = 0; i < ARRAY_SIZE(rates) && param[2] != rates[i]; i++);
255         *version = (param[0] << 8) | (param[1] << 4) | i;
256
257         for (i = 0; i < ARRAY_SIZE(alps_model_data); i++)
258                 if (!memcmp(param, alps_model_data[i].signature, sizeof(alps_model_data[i].signature)))
259                         return alps_model_data + i;
260
261         return NULL;
262 }
263
264 /*
265  * For DualPoint devices select the device that should respond to
266  * subsequent commands. It looks like glidepad is behind stickpointer,
267  * I'd thought it would be other way around...
268  */
269 static int alps_passthrough_mode(struct psmouse *psmouse, int enable)
270 {
271         struct ps2dev *ps2dev = &psmouse->ps2dev;
272         int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11;
273
274         if (ps2_command(ps2dev, NULL, cmd) ||
275             ps2_command(ps2dev, NULL, cmd) ||
276             ps2_command(ps2dev, NULL, cmd) ||
277             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
278                 return -1;
279
280         /* we may get 3 more bytes, just ignore them */
281         ps2_drain(ps2dev, 3, 100);
282
283         return 0;
284 }
285
286 static int alps_absolute_mode(struct psmouse *psmouse)
287 {
288         struct ps2dev *ps2dev = &psmouse->ps2dev;
289
290         /* Try ALPS magic knock - 4 disable before enable */
291         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
292             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
293             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
294             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
295             ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE))
296                 return -1;
297
298         /*
299          * Switch mouse to poll (remote) mode so motion data will not
300          * get in our way
301          */
302         return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL);
303 }
304
305 static int alps_get_status(struct psmouse *psmouse, char *param)
306 {
307         struct ps2dev *ps2dev = &psmouse->ps2dev;
308
309         /* Get status: 0xF5 0xF5 0xF5 0xE9 */
310         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
311             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
312             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
313             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
314                 return -1;
315
316         dbg("Status: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
317
318         return 0;
319 }
320
321 /*
322  * Turn touchpad tapping on or off. The sequences are:
323  * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
324  * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
325  * My guess that 0xE9 (GetInfo) is here as a sync point.
326  * For models that also have stickpointer (DualPoints) its tapping
327  * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
328  * we don't fiddle with it.
329  */
330 static int alps_tap_mode(struct psmouse *psmouse, int enable)
331 {
332         struct ps2dev *ps2dev = &psmouse->ps2dev;
333         int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES;
334         unsigned char tap_arg = enable ? 0x0A : 0x00;
335         unsigned char param[4];
336
337         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) ||
338             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
339             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
340             ps2_command(ps2dev, &tap_arg, cmd))
341                 return -1;
342
343         if (alps_get_status(psmouse, param))
344                 return -1;
345
346         return 0;
347 }
348
349 /*
350  * alps_poll() - poll the touchpad for current motion packet.
351  * Used in resync.
352  */
353 static int alps_poll(struct psmouse *psmouse)
354 {
355         struct alps_data *priv = psmouse->private;
356         unsigned char buf[6];
357         int poll_failed;
358
359         if (priv->i->flags & ALPS_PASS)
360                 alps_passthrough_mode(psmouse, 1);
361
362         poll_failed = ps2_command(&psmouse->ps2dev, buf,
363                                   PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0;
364
365         if (priv->i->flags & ALPS_PASS)
366                 alps_passthrough_mode(psmouse, 0);
367
368         if (poll_failed || (buf[0] & priv->i->mask0) != priv->i->byte0)
369                 return -1;
370
371         if ((psmouse->badbyte & 0xc8) == 0x08) {
372 /*
373  * Poll the track stick ...
374  */
375                 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8)))
376                         return -1;
377         }
378
379         memcpy(psmouse->packet, buf, sizeof(buf));
380         return 0;
381 }
382
383 static int alps_reconnect(struct psmouse *psmouse)
384 {
385         struct alps_data *priv = psmouse->private;
386         int version;
387
388         psmouse_reset(psmouse);
389
390         if (!(priv->i = alps_get_model(psmouse, &version)))
391                 return -1;
392
393         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1))
394                 return -1;
395
396         if (alps_tap_mode(psmouse, 1)) {
397                 printk(KERN_WARNING "alps.c: Failed to reenable hardware tapping\n");
398                 return -1;
399         }
400
401         if (alps_absolute_mode(psmouse)) {
402                 printk(KERN_ERR "alps.c: Failed to reenable absolute mode\n");
403                 return -1;
404         }
405
406         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0))
407                 return -1;
408
409         return 0;
410 }
411
412 static void alps_disconnect(struct psmouse *psmouse)
413 {
414         struct alps_data *priv = psmouse->private;
415
416         psmouse_reset(psmouse);
417         input_unregister_device(priv->dev2);
418         kfree(priv);
419 }
420
421 int alps_init(struct psmouse *psmouse)
422 {
423         struct alps_data *priv;
424         struct input_dev *dev1 = psmouse->dev, *dev2;
425         int version;
426
427         priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL);
428         dev2 = input_allocate_device();
429         if (!priv || !dev2)
430                 goto init_fail;
431
432         priv->dev2 = dev2;
433
434         priv->i = alps_get_model(psmouse, &version);
435         if (!priv->i)
436                 goto init_fail;
437
438         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1))
439                 goto init_fail;
440
441         if (alps_tap_mode(psmouse, 1))
442                 printk(KERN_WARNING "alps.c: Failed to enable hardware tapping\n");
443
444         if (alps_absolute_mode(psmouse)) {
445                 printk(KERN_ERR "alps.c: Failed to enable absolute mode\n");
446                 goto init_fail;
447         }
448
449         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0))
450                 goto init_fail;
451
452         dev1->evbit[LONG(EV_KEY)] |= BIT(EV_KEY);
453         dev1->keybit[LONG(BTN_TOUCH)] |= BIT(BTN_TOUCH);
454         dev1->keybit[LONG(BTN_TOOL_FINGER)] |= BIT(BTN_TOOL_FINGER);
455         dev1->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
456
457         dev1->evbit[LONG(EV_ABS)] |= BIT(EV_ABS);
458         input_set_abs_params(dev1, ABS_X, 0, 1023, 0, 0);
459         input_set_abs_params(dev1, ABS_Y, 0, 767, 0, 0);
460         input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
461
462         if (priv->i->flags & ALPS_WHEEL) {
463                 dev1->evbit[LONG(EV_REL)] |= BIT(EV_REL);
464                 dev1->relbit[LONG(REL_WHEEL)] |= BIT(REL_WHEEL);
465         }
466
467         if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
468                 dev1->keybit[LONG(BTN_FORWARD)] |= BIT(BTN_FORWARD);
469                 dev1->keybit[LONG(BTN_BACK)] |= BIT(BTN_BACK);
470         }
471
472         snprintf(priv->phys, sizeof(priv->phys), "%s/input1", psmouse->ps2dev.serio->phys);
473         dev2->phys = priv->phys;
474         dev2->name = (priv->i->flags & ALPS_DUALPOINT) ? "DualPoint Stick" : "PS/2 Mouse";
475         dev2->id.bustype = BUS_I8042;
476         dev2->id.vendor  = 0x0002;
477         dev2->id.product = PSMOUSE_ALPS;
478         dev2->id.version = 0x0000;
479
480         dev2->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
481         dev2->relbit[LONG(REL_X)] |= BIT(REL_X) | BIT(REL_Y);
482         dev2->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
483
484         if (input_register_device(priv->dev2))
485                 goto init_fail;
486
487         psmouse->protocol_handler = alps_process_byte;
488         psmouse->poll = alps_poll;
489         psmouse->disconnect = alps_disconnect;
490         psmouse->reconnect = alps_reconnect;
491         psmouse->pktsize = 6;
492
493         /* We are having trouble resyncing ALPS touchpads so disable it for now */
494         psmouse->resync_time = 0;
495
496         psmouse->private = priv;
497         return 0;
498
499 init_fail:
500         psmouse_reset(psmouse);
501         input_free_device(dev2);
502         kfree(priv);
503         return -1;
504 }
505
506 int alps_detect(struct psmouse *psmouse, int set_properties)
507 {
508         int version;
509         const struct alps_model_info *model;
510
511         model = alps_get_model(psmouse, &version);
512         if (!model)
513                 return -1;
514
515         if (set_properties) {
516                 psmouse->vendor = "ALPS";
517                 psmouse->name = model->flags & ALPS_DUALPOINT ?
518                                 "DualPoint TouchPad" : "GlidePoint";
519                 psmouse->model = version;
520         }
521         return 0;
522 }
523