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 { { 0x32, 0x02, 0x14 }, 0xf8, 0xf8, ALPS_PASS
| ALPS_DUALPOINT
}, /* Toshiba Salellite Pro M10 */
41 { { 0x33, 0x02, 0x0a }, 0x88, 0xf8, ALPS_OLDPROTO
}, /* UMAX-530T */
42 { { 0x53, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
43 { { 0x53, 0x02, 0x14 }, 0xf8, 0xf8, 0 },
44 { { 0x60, 0x03, 0xc8 }, 0xf8, 0xf8, 0 }, /* HP ze1115 */
45 { { 0x63, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
46 { { 0x63, 0x02, 0x14 }, 0xf8, 0xf8, 0 },
47 { { 0x63, 0x02, 0x28 }, 0xf8, 0xf8, ALPS_FW_BK_2
}, /* Fujitsu Siemens S6010 */
48 { { 0x63, 0x02, 0x3c }, 0x8f, 0x8f, ALPS_WHEEL
}, /* Toshiba Satellite S2400-103 */
49 { { 0x63, 0x02, 0x50 }, 0xef, 0xef, ALPS_FW_BK_1
}, /* NEC Versa L320 */
50 { { 0x63, 0x02, 0x64 }, 0xf8, 0xf8, 0 },
51 { { 0x63, 0x03, 0xc8 }, 0xf8, 0xf8, ALPS_PASS
}, /* Dell Latitude D800 */
52 { { 0x73, 0x00, 0x0a }, 0xf8, 0xf8, ALPS_DUALPOINT
}, /* ThinkPad R61 8918-5QG */
53 { { 0x73, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
54 { { 0x73, 0x02, 0x14 }, 0xf8, 0xf8, ALPS_FW_BK_2
}, /* Ahtec Laptop */
55 { { 0x20, 0x02, 0x0e }, 0xf8, 0xf8, ALPS_PASS
| ALPS_DUALPOINT
}, /* XXX */
56 { { 0x22, 0x02, 0x0a }, 0xf8, 0xf8, ALPS_PASS
| ALPS_DUALPOINT
},
57 { { 0x22, 0x02, 0x14 }, 0xff, 0xff, ALPS_PASS
| ALPS_DUALPOINT
}, /* Dell Latitude D600 */
58 { { 0x62, 0x02, 0x14 }, 0xcf, 0xcf, ALPS_PASS
| ALPS_DUALPOINT
}, /* Dell Latitude E6500 */
59 { { 0x73, 0x02, 0x50 }, 0xcf, 0xcf, ALPS_FW_BK_1
} /* Dell Vostro 1400 */
63 * XXX - this entry is suspicious. First byte has zero lower nibble,
64 * which is what a normal mouse would report. Also, the value 0x0e
65 * isn't valid per PS/2 spec.
69 * ALPS abolute Mode - new format
71 * byte 0: 1 ? ? ? 1 ? ? ?
72 * byte 1: 0 x6 x5 x4 x3 x2 x1 x0
73 * byte 2: 0 x10 x9 x8 x7 ? fin ges
74 * byte 3: 0 y9 y8 y7 1 M R L
75 * byte 4: 0 y6 y5 y4 y3 y2 y1 y0
76 * byte 5: 0 z6 z5 z4 z3 z2 z1 z0
78 * ?'s can have different meanings on different models,
79 * such as wheel rotation, extra buttons, stick buttons
80 * on a dualpoint, etc.
83 static void alps_process_packet(struct psmouse
*psmouse
)
85 struct alps_data
*priv
= psmouse
->private;
86 unsigned char *packet
= psmouse
->packet
;
87 struct input_dev
*dev
= psmouse
->dev
;
88 struct input_dev
*dev2
= priv
->dev2
;
89 int x
, y
, z
, ges
, fin
, left
, right
, middle
;
90 int back
= 0, forward
= 0;
92 if ((packet
[0] & 0xc8) == 0x08) { /* 3-byte PS/2 packet */
93 input_report_key(dev2
, BTN_LEFT
, packet
[0] & 1);
94 input_report_key(dev2
, BTN_RIGHT
, packet
[0] & 2);
95 input_report_key(dev2
, BTN_MIDDLE
, packet
[0] & 4);
96 input_report_rel(dev2
, REL_X
,
97 packet
[1] ? packet
[1] - ((packet
[0] << 4) & 0x100) : 0);
98 input_report_rel(dev2
, REL_Y
,
99 packet
[2] ? ((packet
[0] << 3) & 0x100) - packet
[2] : 0);
104 if (priv
->i
->flags
& ALPS_OLDPROTO
) {
105 left
= packet
[2] & 0x10;
106 right
= packet
[2] & 0x08;
108 x
= packet
[1] | ((packet
[0] & 0x07) << 7);
109 y
= packet
[4] | ((packet
[3] & 0x07) << 7);
112 left
= packet
[3] & 1;
113 right
= packet
[3] & 2;
114 middle
= packet
[3] & 4;
115 x
= packet
[1] | ((packet
[2] & 0x78) << (7 - 3));
116 y
= packet
[4] | ((packet
[3] & 0x70) << (7 - 4));
120 if (priv
->i
->flags
& ALPS_FW_BK_1
) {
121 back
= packet
[0] & 0x10;
122 forward
= packet
[2] & 4;
125 if (priv
->i
->flags
& ALPS_FW_BK_2
) {
126 back
= packet
[3] & 4;
127 forward
= packet
[2] & 4;
128 if ((middle
= forward
&& back
))
135 input_report_key(dev
, BTN_LEFT
, left
);
136 input_report_key(dev
, BTN_RIGHT
, right
);
137 input_report_key(dev
, BTN_MIDDLE
, middle
);
139 if ((priv
->i
->flags
& ALPS_DUALPOINT
) && z
== 127) {
140 input_report_rel(dev2
, REL_X
, (x
> 383 ? (x
- 768) : x
));
141 input_report_rel(dev2
, REL_Y
, -(y
> 255 ? (y
- 512) : y
));
147 /* Convert hardware tap to a reasonable Z value */
148 if (ges
&& !fin
) z
= 40;
151 * A "tap and drag" operation is reported by the hardware as a transition
152 * from (!fin && ges) to (fin && ges). This should be translated to the
153 * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
155 if (ges
&& fin
&& !priv
->prev_fin
) {
156 input_report_abs(dev
, ABS_X
, x
);
157 input_report_abs(dev
, ABS_Y
, y
);
158 input_report_abs(dev
, ABS_PRESSURE
, 0);
159 input_report_key(dev
, BTN_TOOL_FINGER
, 0);
162 priv
->prev_fin
= fin
;
164 if (z
> 30) input_report_key(dev
, BTN_TOUCH
, 1);
165 if (z
< 25) input_report_key(dev
, BTN_TOUCH
, 0);
168 input_report_abs(dev
, ABS_X
, x
);
169 input_report_abs(dev
, ABS_Y
, y
);
172 input_report_abs(dev
, ABS_PRESSURE
, z
);
173 input_report_key(dev
, BTN_TOOL_FINGER
, z
> 0);
175 if (priv
->i
->flags
& ALPS_WHEEL
)
176 input_report_rel(dev
, REL_WHEEL
, ((packet
[2] << 1) & 0x08) - ((packet
[0] >> 4) & 0x07));
178 if (priv
->i
->flags
& (ALPS_FW_BK_1
| ALPS_FW_BK_2
)) {
179 input_report_key(dev
, BTN_FORWARD
, forward
);
180 input_report_key(dev
, BTN_BACK
, back
);
186 static psmouse_ret_t
alps_process_byte(struct psmouse
*psmouse
)
188 struct alps_data
*priv
= psmouse
->private;
190 if ((psmouse
->packet
[0] & 0xc8) == 0x08) { /* PS/2 packet */
191 if (psmouse
->pktcnt
== 3) {
192 alps_process_packet(psmouse
);
193 return PSMOUSE_FULL_PACKET
;
195 return PSMOUSE_GOOD_DATA
;
198 if ((psmouse
->packet
[0] & priv
->i
->mask0
) != priv
->i
->byte0
)
199 return PSMOUSE_BAD_DATA
;
201 /* Bytes 2 - 6 should have 0 in the highest bit */
202 if (psmouse
->pktcnt
>= 2 && psmouse
->pktcnt
<= 6 &&
203 (psmouse
->packet
[psmouse
->pktcnt
- 1] & 0x80))
204 return PSMOUSE_BAD_DATA
;
206 if (psmouse
->pktcnt
== 6) {
207 alps_process_packet(psmouse
);
208 return PSMOUSE_FULL_PACKET
;
211 return PSMOUSE_GOOD_DATA
;
214 static const struct alps_model_info
*alps_get_model(struct psmouse
*psmouse
, int *version
)
216 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
217 static const unsigned char rates
[] = { 0, 10, 20, 40, 60, 80, 100, 200 };
218 unsigned char param
[4];
222 * First try "E6 report".
223 * ALPS should return 0,0,10 or 0,0,100
226 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
) ||
227 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
228 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
229 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
))
232 param
[0] = param
[1] = param
[2] = 0xff;
233 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
))
236 dbg("E6 report: %2.2x %2.2x %2.2x", param
[0], param
[1], param
[2]);
238 if (param
[0] != 0 || param
[1] != 0 || (param
[2] != 10 && param
[2] != 100))
242 * Now try "E7 report". Allowed responses are in
243 * alps_model_data[].signature
246 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
) ||
247 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE21
) ||
248 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE21
) ||
249 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE21
))
252 param
[0] = param
[1] = param
[2] = 0xff;
253 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
))
256 dbg("E7 report: %2.2x %2.2x %2.2x", param
[0], param
[1], param
[2]);
259 for (i
= 0; i
< ARRAY_SIZE(rates
) && param
[2] != rates
[i
]; i
++)
261 *version
= (param
[0] << 8) | (param
[1] << 4) | i
;
264 for (i
= 0; i
< ARRAY_SIZE(alps_model_data
); i
++)
265 if (!memcmp(param
, alps_model_data
[i
].signature
,
266 sizeof(alps_model_data
[i
].signature
)))
267 return alps_model_data
+ i
;
273 * For DualPoint devices select the device that should respond to
274 * subsequent commands. It looks like glidepad is behind stickpointer,
275 * I'd thought it would be other way around...
277 static int alps_passthrough_mode(struct psmouse
*psmouse
, int enable
)
279 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
280 int cmd
= enable
? PSMOUSE_CMD_SETSCALE21
: PSMOUSE_CMD_SETSCALE11
;
282 if (ps2_command(ps2dev
, NULL
, cmd
) ||
283 ps2_command(ps2dev
, NULL
, cmd
) ||
284 ps2_command(ps2dev
, NULL
, cmd
) ||
285 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
))
288 /* we may get 3 more bytes, just ignore them */
289 ps2_drain(ps2dev
, 3, 100);
294 static int alps_absolute_mode(struct psmouse
*psmouse
)
296 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
298 /* Try ALPS magic knock - 4 disable before enable */
299 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
300 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
301 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
302 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
303 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
))
307 * Switch mouse to poll (remote) mode so motion data will not
310 return ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETPOLL
);
313 static int alps_get_status(struct psmouse
*psmouse
, char *param
)
315 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
317 /* Get status: 0xF5 0xF5 0xF5 0xE9 */
318 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
319 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
320 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
321 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
))
324 dbg("Status: %2.2x %2.2x %2.2x", param
[0], param
[1], param
[2]);
330 * Turn touchpad tapping on or off. The sequences are:
331 * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
332 * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
333 * My guess that 0xE9 (GetInfo) is here as a sync point.
334 * For models that also have stickpointer (DualPoints) its tapping
335 * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
336 * we don't fiddle with it.
338 static int alps_tap_mode(struct psmouse
*psmouse
, int enable
)
340 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
341 int cmd
= enable
? PSMOUSE_CMD_SETRATE
: PSMOUSE_CMD_SETRES
;
342 unsigned char tap_arg
= enable
? 0x0A : 0x00;
343 unsigned char param
[4];
345 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
) ||
346 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
347 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
348 ps2_command(ps2dev
, &tap_arg
, cmd
))
351 if (alps_get_status(psmouse
, param
))
358 * alps_poll() - poll the touchpad for current motion packet.
361 static int alps_poll(struct psmouse
*psmouse
)
363 struct alps_data
*priv
= psmouse
->private;
364 unsigned char buf
[6];
367 if (priv
->i
->flags
& ALPS_PASS
)
368 alps_passthrough_mode(psmouse
, 1);
370 poll_failed
= ps2_command(&psmouse
->ps2dev
, buf
,
371 PSMOUSE_CMD_POLL
| (psmouse
->pktsize
<< 8)) < 0;
373 if (priv
->i
->flags
& ALPS_PASS
)
374 alps_passthrough_mode(psmouse
, 0);
376 if (poll_failed
|| (buf
[0] & priv
->i
->mask0
) != priv
->i
->byte0
)
379 if ((psmouse
->badbyte
& 0xc8) == 0x08) {
381 * Poll the track stick ...
383 if (ps2_command(&psmouse
->ps2dev
, buf
, PSMOUSE_CMD_POLL
| (3 << 8)))
387 memcpy(psmouse
->packet
, buf
, sizeof(buf
));
391 static int alps_hw_init(struct psmouse
*psmouse
, int *version
)
393 struct alps_data
*priv
= psmouse
->private;
395 priv
->i
= alps_get_model(psmouse
, version
);
399 if ((priv
->i
->flags
& ALPS_PASS
) && alps_passthrough_mode(psmouse
, 1))
402 if (alps_tap_mode(psmouse
, 1)) {
403 printk(KERN_WARNING
"alps.c: Failed to enable hardware tapping\n");
407 if (alps_absolute_mode(psmouse
)) {
408 printk(KERN_ERR
"alps.c: Failed to enable absolute mode\n");
412 if ((priv
->i
->flags
& ALPS_PASS
) && alps_passthrough_mode(psmouse
, 0))
415 /* ALPS needs stream mode, otherwise it won't report any data */
416 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSTREAM
)) {
417 printk(KERN_ERR
"alps.c: Failed to enable stream mode\n");
424 static int alps_reconnect(struct psmouse
*psmouse
)
426 psmouse_reset(psmouse
);
428 if (alps_hw_init(psmouse
, NULL
))
434 static void alps_disconnect(struct psmouse
*psmouse
)
436 struct alps_data
*priv
= psmouse
->private;
438 psmouse_reset(psmouse
);
439 input_unregister_device(priv
->dev2
);
443 int alps_init(struct psmouse
*psmouse
)
445 struct alps_data
*priv
;
446 struct input_dev
*dev1
= psmouse
->dev
, *dev2
;
449 priv
= kzalloc(sizeof(struct alps_data
), GFP_KERNEL
);
450 dev2
= input_allocate_device();
455 psmouse
->private = priv
;
457 if (alps_hw_init(psmouse
, &version
))
460 dev1
->evbit
[BIT_WORD(EV_KEY
)] |= BIT_MASK(EV_KEY
);
461 dev1
->keybit
[BIT_WORD(BTN_TOUCH
)] |= BIT_MASK(BTN_TOUCH
);
462 dev1
->keybit
[BIT_WORD(BTN_TOOL_FINGER
)] |= BIT_MASK(BTN_TOOL_FINGER
);
463 dev1
->keybit
[BIT_WORD(BTN_LEFT
)] |= BIT_MASK(BTN_LEFT
) |
464 BIT_MASK(BTN_MIDDLE
) | BIT_MASK(BTN_RIGHT
);
466 dev1
->evbit
[BIT_WORD(EV_ABS
)] |= BIT_MASK(EV_ABS
);
467 input_set_abs_params(dev1
, ABS_X
, 0, 1023, 0, 0);
468 input_set_abs_params(dev1
, ABS_Y
, 0, 767, 0, 0);
469 input_set_abs_params(dev1
, ABS_PRESSURE
, 0, 127, 0, 0);
471 if (priv
->i
->flags
& ALPS_WHEEL
) {
472 dev1
->evbit
[BIT_WORD(EV_REL
)] |= BIT_MASK(EV_REL
);
473 dev1
->relbit
[BIT_WORD(REL_WHEEL
)] |= BIT_MASK(REL_WHEEL
);
476 if (priv
->i
->flags
& (ALPS_FW_BK_1
| ALPS_FW_BK_2
)) {
477 dev1
->keybit
[BIT_WORD(BTN_FORWARD
)] |= BIT_MASK(BTN_FORWARD
);
478 dev1
->keybit
[BIT_WORD(BTN_BACK
)] |= BIT_MASK(BTN_BACK
);
481 snprintf(priv
->phys
, sizeof(priv
->phys
), "%s/input1", psmouse
->ps2dev
.serio
->phys
);
482 dev2
->phys
= priv
->phys
;
483 dev2
->name
= (priv
->i
->flags
& ALPS_DUALPOINT
) ? "DualPoint Stick" : "PS/2 Mouse";
484 dev2
->id
.bustype
= BUS_I8042
;
485 dev2
->id
.vendor
= 0x0002;
486 dev2
->id
.product
= PSMOUSE_ALPS
;
487 dev2
->id
.version
= 0x0000;
488 dev2
->dev
.parent
= &psmouse
->ps2dev
.serio
->dev
;
490 dev2
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REL
);
491 dev2
->relbit
[BIT_WORD(REL_X
)] |= BIT_MASK(REL_X
) | BIT_MASK(REL_Y
);
492 dev2
->keybit
[BIT_WORD(BTN_LEFT
)] |= BIT_MASK(BTN_LEFT
) |
493 BIT_MASK(BTN_MIDDLE
) | BIT_MASK(BTN_RIGHT
);
495 if (input_register_device(priv
->dev2
))
498 psmouse
->protocol_handler
= alps_process_byte
;
499 psmouse
->poll
= alps_poll
;
500 psmouse
->disconnect
= alps_disconnect
;
501 psmouse
->reconnect
= alps_reconnect
;
502 psmouse
->pktsize
= 6;
504 /* We are having trouble resyncing ALPS touchpads so disable it for now */
505 psmouse
->resync_time
= 0;
510 psmouse_reset(psmouse
);
511 input_free_device(dev2
);
513 psmouse
->private = NULL
;
517 int alps_detect(struct psmouse
*psmouse
, int set_properties
)
520 const struct alps_model_info
*model
;
522 model
= alps_get_model(psmouse
, &version
);
526 if (set_properties
) {
527 psmouse
->vendor
= "ALPS";
528 psmouse
->name
= model
->flags
& ALPS_DUALPOINT
?
529 "DualPoint TouchPad" : "GlidePoint";
530 psmouse
->model
= version
;