2 * ALPS touchpad PS/2 mouse driver
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>
9 * ALPS detection, tap switching and status querying info is taken from
10 * tpconfig utility (by C. Scott Ananian and Bruce Kall).
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.
17 #include <linux/input.h>
18 #include <linux/serio.h>
19 #include <linux/libps2.h>
26 #define dbg(format, arg...) printk(KERN_INFO "alps.c: " format "\n", ## arg)
28 #define dbg(format, arg...) do {} while (0)
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
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, 0x00, 0x0a }, 0xf8, 0xf8, ALPS_DUALPOINT
}, /* ThinkPad R61 8918-5QG */
52 { { 0x73, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
53 { { 0x73, 0x02, 0x14 }, 0xf8, 0xf8, ALPS_FW_BK_2
}, /* Ahtec Laptop */
54 { { 0x20, 0x02, 0x0e }, 0xf8, 0xf8, ALPS_PASS
| ALPS_DUALPOINT
}, /* XXX */
55 { { 0x22, 0x02, 0x0a }, 0xf8, 0xf8, ALPS_PASS
| ALPS_DUALPOINT
},
56 { { 0x22, 0x02, 0x14 }, 0xff, 0xff, ALPS_PASS
| ALPS_DUALPOINT
}, /* Dell Latitude D600 */
57 { { 0x73, 0x02, 0x50 }, 0xcf, 0xcf, ALPS_FW_BK_1
} /* Dell Vostro 1400 */
61 * XXX - this entry is suspicious. First byte has zero lower nibble,
62 * which is what a normal mouse would report. Also, the value 0x0e
63 * isn't valid per PS/2 spec.
67 * ALPS abolute Mode - new format
69 * byte 0: 1 ? ? ? 1 ? ? ?
70 * byte 1: 0 x6 x5 x4 x3 x2 x1 x0
71 * byte 2: 0 x10 x9 x8 x7 ? fin ges
72 * byte 3: 0 y9 y8 y7 1 M R L
73 * byte 4: 0 y6 y5 y4 y3 y2 y1 y0
74 * byte 5: 0 z6 z5 z4 z3 z2 z1 z0
76 * ?'s can have different meanings on different models,
77 * such as wheel rotation, extra buttons, stick buttons
78 * on a dualpoint, etc.
81 static void alps_process_packet(struct psmouse
*psmouse
)
83 struct alps_data
*priv
= psmouse
->private;
84 unsigned char *packet
= psmouse
->packet
;
85 struct input_dev
*dev
= psmouse
->dev
;
86 struct input_dev
*dev2
= priv
->dev2
;
87 int x
, y
, z
, ges
, fin
, left
, right
, middle
;
88 int back
= 0, forward
= 0;
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);
102 if (priv
->i
->flags
& ALPS_OLDPROTO
) {
103 left
= packet
[2] & 0x10;
104 right
= packet
[2] & 0x08;
106 x
= packet
[1] | ((packet
[0] & 0x07) << 7);
107 y
= packet
[4] | ((packet
[3] & 0x07) << 7);
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));
118 if (priv
->i
->flags
& ALPS_FW_BK_1
) {
119 back
= packet
[2] & 4;
120 forward
= packet
[0] & 0x10;
123 if (priv
->i
->flags
& ALPS_FW_BK_2
) {
124 back
= packet
[3] & 4;
125 forward
= packet
[2] & 4;
126 if ((middle
= forward
&& back
))
133 input_report_key(dev
, BTN_LEFT
, left
);
134 input_report_key(dev
, BTN_RIGHT
, right
);
135 input_report_key(dev
, BTN_MIDDLE
, middle
);
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
));
145 /* Convert hardware tap to a reasonable Z value */
146 if (ges
&& !fin
) z
= 40;
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.
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);
160 priv
->prev_fin
= fin
;
162 if (z
> 30) input_report_key(dev
, BTN_TOUCH
, 1);
163 if (z
< 25) input_report_key(dev
, BTN_TOUCH
, 0);
166 input_report_abs(dev
, ABS_X
, x
);
167 input_report_abs(dev
, ABS_Y
, y
);
170 input_report_abs(dev
, ABS_PRESSURE
, z
);
171 input_report_key(dev
, BTN_TOOL_FINGER
, z
> 0);
173 if (priv
->i
->flags
& ALPS_WHEEL
)
174 input_report_rel(dev
, REL_WHEEL
, ((packet
[2] << 1) & 0x08) - ((packet
[0] >> 4) & 0x07));
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
);
184 static psmouse_ret_t
alps_process_byte(struct psmouse
*psmouse
)
186 struct alps_data
*priv
= psmouse
->private;
188 if ((psmouse
->packet
[0] & 0xc8) == 0x08) { /* PS/2 packet */
189 if (psmouse
->pktcnt
== 3) {
190 alps_process_packet(psmouse
);
191 return PSMOUSE_FULL_PACKET
;
193 return PSMOUSE_GOOD_DATA
;
196 if ((psmouse
->packet
[0] & priv
->i
->mask0
) != priv
->i
->byte0
)
197 return PSMOUSE_BAD_DATA
;
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
;
204 if (psmouse
->pktcnt
== 6) {
205 alps_process_packet(psmouse
);
206 return PSMOUSE_FULL_PACKET
;
209 return PSMOUSE_GOOD_DATA
;
212 static const struct alps_model_info
*alps_get_model(struct psmouse
*psmouse
, int *version
)
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];
220 * First try "E6 report".
221 * ALPS should return 0,0,10 or 0,0,100
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
))
230 param
[0] = param
[1] = param
[2] = 0xff;
231 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
))
234 dbg("E6 report: %2.2x %2.2x %2.2x", param
[0], param
[1], param
[2]);
236 if (param
[0] != 0 || param
[1] != 0 || (param
[2] != 10 && param
[2] != 100))
240 * Now try "E7 report". Allowed responses are in
241 * alps_model_data[].signature
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
))
250 param
[0] = param
[1] = param
[2] = 0xff;
251 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
))
254 dbg("E7 report: %2.2x %2.2x %2.2x", param
[0], param
[1], param
[2]);
257 for (i
= 0; i
< ARRAY_SIZE(rates
) && param
[2] != rates
[i
]; i
++)
259 *version
= (param
[0] << 8) | (param
[1] << 4) | i
;
262 for (i
= 0; i
< ARRAY_SIZE(alps_model_data
); i
++)
263 if (!memcmp(param
, alps_model_data
[i
].signature
,
264 sizeof(alps_model_data
[i
].signature
)))
265 return alps_model_data
+ i
;
271 * For DualPoint devices select the device that should respond to
272 * subsequent commands. It looks like glidepad is behind stickpointer,
273 * I'd thought it would be other way around...
275 static int alps_passthrough_mode(struct psmouse
*psmouse
, int enable
)
277 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
278 int cmd
= enable
? PSMOUSE_CMD_SETSCALE21
: PSMOUSE_CMD_SETSCALE11
;
280 if (ps2_command(ps2dev
, NULL
, cmd
) ||
281 ps2_command(ps2dev
, NULL
, cmd
) ||
282 ps2_command(ps2dev
, NULL
, cmd
) ||
283 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
))
286 /* we may get 3 more bytes, just ignore them */
287 ps2_drain(ps2dev
, 3, 100);
292 static int alps_absolute_mode(struct psmouse
*psmouse
)
294 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
296 /* Try ALPS magic knock - 4 disable before enable */
297 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
298 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
299 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
300 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
301 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
))
305 * Switch mouse to poll (remote) mode so motion data will not
308 return ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETPOLL
);
311 static int alps_get_status(struct psmouse
*psmouse
, char *param
)
313 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
315 /* Get status: 0xF5 0xF5 0xF5 0xE9 */
316 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
317 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
318 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
319 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
))
322 dbg("Status: %2.2x %2.2x %2.2x", param
[0], param
[1], param
[2]);
328 * Turn touchpad tapping on or off. The sequences are:
329 * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
330 * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
331 * My guess that 0xE9 (GetInfo) is here as a sync point.
332 * For models that also have stickpointer (DualPoints) its tapping
333 * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
334 * we don't fiddle with it.
336 static int alps_tap_mode(struct psmouse
*psmouse
, int enable
)
338 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
339 int cmd
= enable
? PSMOUSE_CMD_SETRATE
: PSMOUSE_CMD_SETRES
;
340 unsigned char tap_arg
= enable
? 0x0A : 0x00;
341 unsigned char param
[4];
343 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
) ||
344 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
345 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
346 ps2_command(ps2dev
, &tap_arg
, cmd
))
349 if (alps_get_status(psmouse
, param
))
356 * alps_poll() - poll the touchpad for current motion packet.
359 static int alps_poll(struct psmouse
*psmouse
)
361 struct alps_data
*priv
= psmouse
->private;
362 unsigned char buf
[6];
365 if (priv
->i
->flags
& ALPS_PASS
)
366 alps_passthrough_mode(psmouse
, 1);
368 poll_failed
= ps2_command(&psmouse
->ps2dev
, buf
,
369 PSMOUSE_CMD_POLL
| (psmouse
->pktsize
<< 8)) < 0;
371 if (priv
->i
->flags
& ALPS_PASS
)
372 alps_passthrough_mode(psmouse
, 0);
374 if (poll_failed
|| (buf
[0] & priv
->i
->mask0
) != priv
->i
->byte0
)
377 if ((psmouse
->badbyte
& 0xc8) == 0x08) {
379 * Poll the track stick ...
381 if (ps2_command(&psmouse
->ps2dev
, buf
, PSMOUSE_CMD_POLL
| (3 << 8)))
385 memcpy(psmouse
->packet
, buf
, sizeof(buf
));
389 static int alps_hw_init(struct psmouse
*psmouse
, int *version
)
391 struct alps_data
*priv
= psmouse
->private;
393 priv
->i
= alps_get_model(psmouse
, version
);
397 if ((priv
->i
->flags
& ALPS_PASS
) && alps_passthrough_mode(psmouse
, 1))
400 if (alps_tap_mode(psmouse
, 1)) {
401 printk(KERN_WARNING
"alps.c: Failed to enable hardware tapping\n");
405 if (alps_absolute_mode(psmouse
)) {
406 printk(KERN_ERR
"alps.c: Failed to enable absolute mode\n");
410 if ((priv
->i
->flags
& ALPS_PASS
) && alps_passthrough_mode(psmouse
, 0))
413 /* ALPS needs stream mode, otherwise it won't report any data */
414 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSTREAM
)) {
415 printk(KERN_ERR
"alps.c: Failed to enable stream mode\n");
422 static int alps_reconnect(struct psmouse
*psmouse
)
424 psmouse_reset(psmouse
);
426 if (alps_hw_init(psmouse
, NULL
))
432 static void alps_disconnect(struct psmouse
*psmouse
)
434 struct alps_data
*priv
= psmouse
->private;
436 psmouse_reset(psmouse
);
437 input_unregister_device(priv
->dev2
);
441 int alps_init(struct psmouse
*psmouse
)
443 struct alps_data
*priv
;
444 struct input_dev
*dev1
= psmouse
->dev
, *dev2
;
447 priv
= kzalloc(sizeof(struct alps_data
), GFP_KERNEL
);
448 dev2
= input_allocate_device();
453 psmouse
->private = priv
;
455 if (alps_hw_init(psmouse
, &version
))
458 dev1
->evbit
[BIT_WORD(EV_KEY
)] |= BIT_MASK(EV_KEY
);
459 dev1
->keybit
[BIT_WORD(BTN_TOUCH
)] |= BIT_MASK(BTN_TOUCH
);
460 dev1
->keybit
[BIT_WORD(BTN_TOOL_FINGER
)] |= BIT_MASK(BTN_TOOL_FINGER
);
461 dev1
->keybit
[BIT_WORD(BTN_LEFT
)] |= BIT_MASK(BTN_LEFT
) |
462 BIT_MASK(BTN_MIDDLE
) | BIT_MASK(BTN_RIGHT
);
464 dev1
->evbit
[BIT_WORD(EV_ABS
)] |= BIT_MASK(EV_ABS
);
465 input_set_abs_params(dev1
, ABS_X
, 0, 1023, 0, 0);
466 input_set_abs_params(dev1
, ABS_Y
, 0, 767, 0, 0);
467 input_set_abs_params(dev1
, ABS_PRESSURE
, 0, 127, 0, 0);
469 if (priv
->i
->flags
& ALPS_WHEEL
) {
470 dev1
->evbit
[BIT_WORD(EV_REL
)] |= BIT_MASK(EV_REL
);
471 dev1
->relbit
[BIT_WORD(REL_WHEEL
)] |= BIT_MASK(REL_WHEEL
);
474 if (priv
->i
->flags
& (ALPS_FW_BK_1
| ALPS_FW_BK_2
)) {
475 dev1
->keybit
[BIT_WORD(BTN_FORWARD
)] |= BIT_MASK(BTN_FORWARD
);
476 dev1
->keybit
[BIT_WORD(BTN_BACK
)] |= BIT_MASK(BTN_BACK
);
479 snprintf(priv
->phys
, sizeof(priv
->phys
), "%s/input1", psmouse
->ps2dev
.serio
->phys
);
480 dev2
->phys
= priv
->phys
;
481 dev2
->name
= (priv
->i
->flags
& ALPS_DUALPOINT
) ? "DualPoint Stick" : "PS/2 Mouse";
482 dev2
->id
.bustype
= BUS_I8042
;
483 dev2
->id
.vendor
= 0x0002;
484 dev2
->id
.product
= PSMOUSE_ALPS
;
485 dev2
->id
.version
= 0x0000;
487 dev2
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REL
);
488 dev2
->relbit
[BIT_WORD(REL_X
)] |= BIT_MASK(REL_X
) | BIT_MASK(REL_Y
);
489 dev2
->keybit
[BIT_WORD(BTN_LEFT
)] |= BIT_MASK(BTN_LEFT
) |
490 BIT_MASK(BTN_MIDDLE
) | BIT_MASK(BTN_RIGHT
);
492 if (input_register_device(priv
->dev2
))
495 psmouse
->protocol_handler
= alps_process_byte
;
496 psmouse
->poll
= alps_poll
;
497 psmouse
->disconnect
= alps_disconnect
;
498 psmouse
->reconnect
= alps_reconnect
;
499 psmouse
->pktsize
= 6;
501 /* We are having trouble resyncing ALPS touchpads so disable it for now */
502 psmouse
->resync_time
= 0;
507 psmouse_reset(psmouse
);
508 input_free_device(dev2
);
510 psmouse
->private = NULL
;
514 int alps_detect(struct psmouse
*psmouse
, int set_properties
)
517 const struct alps_model_info
*model
;
519 model
= alps_get_model(psmouse
, &version
);
523 if (set_properties
) {
524 psmouse
->vendor
= "ALPS";
525 psmouse
->name
= model
->flags
& ALPS_DUALPOINT
?
526 "DualPoint TouchPad" : "GlidePoint";
527 psmouse
->model
= version
;