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