Input: constify psmouse driver
[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, struct pt_regs *regs)
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         input_regs(dev, regs);
89
90         if ((packet[0] & 0xc8) == 0x08) {   /* 3-byte PS/2 packet */
91                 input_report_key(dev2, BTN_LEFT,   packet[0] & 1);
92                 input_report_key(dev2, BTN_RIGHT,  packet[0] & 2);
93                 input_report_key(dev2, BTN_MIDDLE, packet[0] & 4);
94                 input_report_rel(dev2, REL_X,
95                         packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0);
96                 input_report_rel(dev2, REL_Y,
97                         packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0);
98                 input_sync(dev2);
99                 return;
100         }
101
102         if (priv->i->flags & ALPS_OLDPROTO) {
103                 left = packet[2] & 0x10;
104                 right = packet[2] & 0x08;
105                 middle = 0;
106                 x = packet[1] | ((packet[0] & 0x07) << 7);
107                 y = packet[4] | ((packet[3] & 0x07) << 7);
108                 z = packet[5];
109         } else {
110                 left = packet[3] & 1;
111                 right = packet[3] & 2;
112                 middle = packet[3] & 4;
113                 x = packet[1] | ((packet[2] & 0x78) << (7 - 3));
114                 y = packet[4] | ((packet[3] & 0x70) << (7 - 4));
115                 z = packet[5];
116         }
117
118         if (priv->i->flags & ALPS_FW_BK_1) {
119                 back = packet[2] & 4;
120                 forward = packet[0] & 0x10;
121         }
122
123         if (priv->i->flags & ALPS_FW_BK_2) {
124                 back = packet[3] & 4;
125                 forward = packet[2] & 4;
126                 if ((middle = forward && back))
127                         forward = back = 0;
128         }
129
130         ges = packet[2] & 1;
131         fin = packet[2] & 2;
132
133         input_report_key(dev, BTN_LEFT, left);
134         input_report_key(dev, BTN_RIGHT, right);
135         input_report_key(dev, BTN_MIDDLE, middle);
136
137         if ((priv->i->flags & ALPS_DUALPOINT) && z == 127) {
138                 input_report_rel(dev2, REL_X,  (x > 383 ? (x - 768) : x));
139                 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y));
140                 input_sync(dev);
141                 input_sync(dev2);
142                 return;
143         }
144
145         /* Convert hardware tap to a reasonable Z value */
146         if (ges && !fin) z = 40;
147
148         /*
149          * A "tap and drag" operation is reported by the hardware as a transition
150          * from (!fin && ges) to (fin && ges). This should be translated to the
151          * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
152          */
153         if (ges && fin && !priv->prev_fin) {
154                 input_report_abs(dev, ABS_X, x);
155                 input_report_abs(dev, ABS_Y, y);
156                 input_report_abs(dev, ABS_PRESSURE, 0);
157                 input_report_key(dev, BTN_TOOL_FINGER, 0);
158                 input_sync(dev);
159         }
160         priv->prev_fin = fin;
161
162         if (z > 30) input_report_key(dev, BTN_TOUCH, 1);
163         if (z < 25) input_report_key(dev, BTN_TOUCH, 0);
164
165         if (z > 0) {
166                 input_report_abs(dev, ABS_X, x);
167                 input_report_abs(dev, ABS_Y, y);
168         }
169
170         input_report_abs(dev, ABS_PRESSURE, z);
171         input_report_key(dev, BTN_TOOL_FINGER, z > 0);
172
173         if (priv->i->flags & ALPS_WHEEL)
174                 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07));
175
176         if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
177                 input_report_key(dev, BTN_FORWARD, forward);
178                 input_report_key(dev, BTN_BACK, back);
179         }
180
181         input_sync(dev);
182 }
183
184 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
185 {
186         struct alps_data *priv = psmouse->private;
187
188         if ((psmouse->packet[0] & 0xc8) == 0x08) { /* PS/2 packet */
189                 if (psmouse->pktcnt == 3) {
190                         alps_process_packet(psmouse, regs);
191                         return PSMOUSE_FULL_PACKET;
192                 }
193                 return PSMOUSE_GOOD_DATA;
194         }
195
196         if ((psmouse->packet[0] & priv->i->mask0) != priv->i->byte0)
197                 return PSMOUSE_BAD_DATA;
198
199         /* Bytes 2 - 6 should have 0 in the highest bit */
200         if (psmouse->pktcnt >= 2 && psmouse->pktcnt <= 6 &&
201             (psmouse->packet[psmouse->pktcnt - 1] & 0x80))
202                 return PSMOUSE_BAD_DATA;
203
204         if (psmouse->pktcnt == 6) {
205                 alps_process_packet(psmouse, regs);
206                 return PSMOUSE_FULL_PACKET;
207         }
208
209         return PSMOUSE_GOOD_DATA;
210 }
211
212 static const struct alps_model_info *alps_get_model(struct psmouse *psmouse, int *version)
213 {
214         struct ps2dev *ps2dev = &psmouse->ps2dev;
215         static const unsigned char rates[] = { 0, 10, 20, 40, 60, 80, 100, 200 };
216         unsigned char param[4];
217         int i;
218
219         /*
220          * First try "E6 report".
221          * ALPS should return 0,0,10 or 0,0,100
222          */
223         param[0] = 0;
224         if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
225             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
226             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
227             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11))
228                 return NULL;
229
230         param[0] = param[1] = param[2] = 0xff;
231         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
232                 return NULL;
233
234         dbg("E6 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
235
236         if (param[0] != 0 || param[1] != 0 || (param[2] != 10 && param[2] != 100))
237                 return NULL;
238
239         /*
240          * Now try "E7 report". Allowed responses are in
241          * alps_model_data[].signature
242          */
243         param[0] = 0;
244         if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
245             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21) ||
246             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21) ||
247             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21))
248                 return NULL;
249
250         param[0] = param[1] = param[2] = 0xff;
251         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
252                 return NULL;
253
254         dbg("E7 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
255
256         for (i = 0; i < ARRAY_SIZE(rates) && param[2] != rates[i]; i++);
257         *version = (param[0] << 8) | (param[1] << 4) | i;
258
259         for (i = 0; i < ARRAY_SIZE(alps_model_data); i++)
260                 if (!memcmp(param, alps_model_data[i].signature, sizeof(alps_model_data[i].signature)))
261                         return alps_model_data + i;
262
263         return NULL;
264 }
265
266 /*
267  * For DualPoint devices select the device that should respond to
268  * subsequent commands. It looks like glidepad is behind stickpointer,
269  * I'd thought it would be other way around...
270  */
271 static int alps_passthrough_mode(struct psmouse *psmouse, int enable)
272 {
273         struct ps2dev *ps2dev = &psmouse->ps2dev;
274         int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11;
275
276         if (ps2_command(ps2dev, NULL, cmd) ||
277             ps2_command(ps2dev, NULL, cmd) ||
278             ps2_command(ps2dev, NULL, cmd) ||
279             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
280                 return -1;
281
282         /* we may get 3 more bytes, just ignore them */
283         ps2_drain(ps2dev, 3, 100);
284
285         return 0;
286 }
287
288 static int alps_absolute_mode(struct psmouse *psmouse)
289 {
290         struct ps2dev *ps2dev = &psmouse->ps2dev;
291
292         /* Try ALPS magic knock - 4 disable before enable */
293         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
294             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
295             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
296             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
297             ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE))
298                 return -1;
299
300         /*
301          * Switch mouse to poll (remote) mode so motion data will not
302          * get in our way
303          */
304         return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL);
305 }
306
307 static int alps_get_status(struct psmouse *psmouse, char *param)
308 {
309         struct ps2dev *ps2dev = &psmouse->ps2dev;
310
311         /* Get status: 0xF5 0xF5 0xF5 0xE9 */
312         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
313             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
314             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
315             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
316                 return -1;
317
318         dbg("Status: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
319
320         return 0;
321 }
322
323 /*
324  * Turn touchpad tapping on or off. The sequences are:
325  * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
326  * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
327  * My guess that 0xE9 (GetInfo) is here as a sync point.
328  * For models that also have stickpointer (DualPoints) its tapping
329  * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
330  * we don't fiddle with it.
331  */
332 static int alps_tap_mode(struct psmouse *psmouse, int enable)
333 {
334         struct ps2dev *ps2dev = &psmouse->ps2dev;
335         int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES;
336         unsigned char tap_arg = enable ? 0x0A : 0x00;
337         unsigned char param[4];
338
339         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) ||
340             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
341             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
342             ps2_command(ps2dev, &tap_arg, cmd))
343                 return -1;
344
345         if (alps_get_status(psmouse, param))
346                 return -1;
347
348         return 0;
349 }
350
351 /*
352  * alps_poll() - poll the touchpad for current motion packet.
353  * Used in resync.
354  */
355 static int alps_poll(struct psmouse *psmouse)
356 {
357         struct alps_data *priv = psmouse->private;
358         unsigned char buf[6];
359         int poll_failed;
360
361         if (priv->i->flags & ALPS_PASS)
362                 alps_passthrough_mode(psmouse, 1);
363
364         poll_failed = ps2_command(&psmouse->ps2dev, buf,
365                                   PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0;
366
367         if (priv->i->flags & ALPS_PASS)
368                 alps_passthrough_mode(psmouse, 0);
369
370         if (poll_failed || (buf[0] & priv->i->mask0) != priv->i->byte0)
371                 return -1;
372
373         if ((psmouse->badbyte & 0xc8) == 0x08) {
374 /*
375  * Poll the track stick ...
376  */
377                 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8)))
378                         return -1;
379         }
380
381         memcpy(psmouse->packet, buf, sizeof(buf));
382         return 0;
383 }
384
385 static int alps_reconnect(struct psmouse *psmouse)
386 {
387         struct alps_data *priv = psmouse->private;
388         int version;
389
390         psmouse_reset(psmouse);
391
392         if (!(priv->i = alps_get_model(psmouse, &version)))
393                 return -1;
394
395         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1))
396                 return -1;
397
398         if (alps_tap_mode(psmouse, 1)) {
399                 printk(KERN_WARNING "alps.c: Failed to reenable hardware tapping\n");
400                 return -1;
401         }
402
403         if (alps_absolute_mode(psmouse)) {
404                 printk(KERN_ERR "alps.c: Failed to reenable absolute mode\n");
405                 return -1;
406         }
407
408         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0))
409                 return -1;
410
411         return 0;
412 }
413
414 static void alps_disconnect(struct psmouse *psmouse)
415 {
416         struct alps_data *priv = psmouse->private;
417
418         psmouse_reset(psmouse);
419         input_unregister_device(priv->dev2);
420         kfree(priv);
421 }
422
423 int alps_init(struct psmouse *psmouse)
424 {
425         struct alps_data *priv;
426         struct input_dev *dev1 = psmouse->dev, *dev2;
427         int version;
428
429         psmouse->private = priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL);
430         dev2 = input_allocate_device();
431         if (!priv || !dev2)
432                 goto init_fail;
433
434         priv->dev2 = dev2;
435
436         if (!(priv->i = alps_get_model(psmouse, &version)))
437                 goto init_fail;
438
439         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1))
440                 goto init_fail;
441
442         if (alps_tap_mode(psmouse, 1))
443                 printk(KERN_WARNING "alps.c: Failed to enable hardware tapping\n");
444
445         if (alps_absolute_mode(psmouse)) {
446                 printk(KERN_ERR "alps.c: Failed to enable absolute mode\n");
447                 goto init_fail;
448         }
449
450         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0))
451                 goto init_fail;
452
453         dev1->evbit[LONG(EV_KEY)] |= BIT(EV_KEY);
454         dev1->keybit[LONG(BTN_TOUCH)] |= BIT(BTN_TOUCH);
455         dev1->keybit[LONG(BTN_TOOL_FINGER)] |= BIT(BTN_TOOL_FINGER);
456         dev1->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
457
458         dev1->evbit[LONG(EV_ABS)] |= BIT(EV_ABS);
459         input_set_abs_params(dev1, ABS_X, 0, 1023, 0, 0);
460         input_set_abs_params(dev1, ABS_Y, 0, 767, 0, 0);
461         input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
462
463         if (priv->i->flags & ALPS_WHEEL) {
464                 dev1->evbit[LONG(EV_REL)] |= BIT(EV_REL);
465                 dev1->relbit[LONG(REL_WHEEL)] |= BIT(REL_WHEEL);
466         }
467
468         if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
469                 dev1->keybit[LONG(BTN_FORWARD)] |= BIT(BTN_FORWARD);
470                 dev1->keybit[LONG(BTN_BACK)] |= BIT(BTN_BACK);
471         }
472
473         snprintf(priv->phys, sizeof(priv->phys), "%s/input1", psmouse->ps2dev.serio->phys);
474         dev2->phys = priv->phys;
475         dev2->name = (priv->i->flags & ALPS_DUALPOINT) ? "DualPoint Stick" : "PS/2 Mouse";
476         dev2->id.bustype = BUS_I8042;
477         dev2->id.vendor  = 0x0002;
478         dev2->id.product = PSMOUSE_ALPS;
479         dev2->id.version = 0x0000;
480
481         dev2->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
482         dev2->relbit[LONG(REL_X)] |= BIT(REL_X) | BIT(REL_Y);
483         dev2->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
484
485         input_register_device(priv->dev2);
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         return 0;
497
498 init_fail:
499         input_free_device(dev2);
500         kfree(priv);
501         return -1;
502 }
503
504 int alps_detect(struct psmouse *psmouse, int set_properties)
505 {
506         int version;
507         const struct alps_model_info *model;
508
509         if (!(model = alps_get_model(psmouse, &version)))
510                 return -1;
511
512         if (set_properties) {
513                 psmouse->vendor = "ALPS";
514                 psmouse->name = model->flags & ALPS_DUALPOINT ?
515                                 "DualPoint TouchPad" : "GlidePoint";
516                 psmouse->model = version;
517         }
518         return 0;
519 }
520