EDAC: i7core, sb_edac: Don't return NOTIFY_BAD from mce_decoder callback
[linux/fpc-iii.git] / drivers / input / mouse / alps.c
blob936f07a4e35f41265de96e84c2bab08f13544ad6
1 /*
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>
8 * Copyright (c) 2009 Sebastian Kapfer <sebastian_kapfer@gmx.net>
10 * ALPS detection, tap switching and status querying info is taken from
11 * tpconfig utility (by C. Scott Ananian and Bruce Kall).
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License version 2 as published by
15 * the Free Software Foundation.
18 #include <linux/slab.h>
19 #include <linux/input.h>
20 #include <linux/input/mt.h>
21 #include <linux/serio.h>
22 #include <linux/libps2.h>
23 #include <linux/dmi.h>
25 #include "psmouse.h"
26 #include "alps.h"
29 * Definitions for ALPS version 3 and 4 command mode protocol
31 #define ALPS_CMD_NIBBLE_10 0x01f2
33 #define ALPS_REG_BASE_RUSHMORE 0xc2c0
34 #define ALPS_REG_BASE_V7 0xc2c0
35 #define ALPS_REG_BASE_PINNACLE 0x0000
37 static const struct alps_nibble_commands alps_v3_nibble_commands[] = {
38 { PSMOUSE_CMD_SETPOLL, 0x00 }, /* 0 */
39 { PSMOUSE_CMD_RESET_DIS, 0x00 }, /* 1 */
40 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* 2 */
41 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 3 */
42 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 4 */
43 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 5 */
44 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 6 */
45 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 7 */
46 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 8 */
47 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 9 */
48 { ALPS_CMD_NIBBLE_10, 0x00 }, /* a */
49 { PSMOUSE_CMD_SETRES, 0x00 }, /* b */
50 { PSMOUSE_CMD_SETRES, 0x01 }, /* c */
51 { PSMOUSE_CMD_SETRES, 0x02 }, /* d */
52 { PSMOUSE_CMD_SETRES, 0x03 }, /* e */
53 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
56 static const struct alps_nibble_commands alps_v4_nibble_commands[] = {
57 { PSMOUSE_CMD_ENABLE, 0x00 }, /* 0 */
58 { PSMOUSE_CMD_RESET_DIS, 0x00 }, /* 1 */
59 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* 2 */
60 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 3 */
61 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 4 */
62 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 5 */
63 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 6 */
64 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 7 */
65 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 8 */
66 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 9 */
67 { ALPS_CMD_NIBBLE_10, 0x00 }, /* a */
68 { PSMOUSE_CMD_SETRES, 0x00 }, /* b */
69 { PSMOUSE_CMD_SETRES, 0x01 }, /* c */
70 { PSMOUSE_CMD_SETRES, 0x02 }, /* d */
71 { PSMOUSE_CMD_SETRES, 0x03 }, /* e */
72 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
75 static const struct alps_nibble_commands alps_v6_nibble_commands[] = {
76 { PSMOUSE_CMD_ENABLE, 0x00 }, /* 0 */
77 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 1 */
78 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 2 */
79 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 3 */
80 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 4 */
81 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 5 */
82 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 6 */
83 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 7 */
84 { PSMOUSE_CMD_GETID, 0x00 }, /* 8 */
85 { PSMOUSE_CMD_GETINFO, 0x00 }, /* 9 */
86 { PSMOUSE_CMD_SETRES, 0x00 }, /* a */
87 { PSMOUSE_CMD_SETRES, 0x01 }, /* b */
88 { PSMOUSE_CMD_SETRES, 0x02 }, /* c */
89 { PSMOUSE_CMD_SETRES, 0x03 }, /* d */
90 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* e */
91 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
95 #define ALPS_DUALPOINT 0x02 /* touchpad has trackstick */
96 #define ALPS_PASS 0x04 /* device has a pass-through port */
98 #define ALPS_WHEEL 0x08 /* hardware wheel present */
99 #define ALPS_FW_BK_1 0x10 /* front & back buttons present */
100 #define ALPS_FW_BK_2 0x20 /* front & back buttons present */
101 #define ALPS_FOUR_BUTTONS 0x40 /* 4 direction button present */
102 #define ALPS_PS2_INTERLEAVED 0x80 /* 3-byte PS/2 packet interleaved with
103 6-byte ALPS packet */
104 #define ALPS_STICK_BITS 0x100 /* separate stick button bits */
105 #define ALPS_BUTTONPAD 0x200 /* device is a clickpad */
107 static const struct alps_model_info alps_model_data[] = {
108 { { 0x32, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } }, /* Toshiba Salellite Pro M10 */
109 { { 0x33, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V1, 0x88, 0xf8, 0 } }, /* UMAX-530T */
110 { { 0x53, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
111 { { 0x53, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
112 { { 0x60, 0x03, 0xc8 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } }, /* HP ze1115 */
113 { { 0x63, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
114 { { 0x63, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
115 { { 0x63, 0x02, 0x28 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_FW_BK_2 } }, /* Fujitsu Siemens S6010 */
116 { { 0x63, 0x02, 0x3c }, 0x00, { ALPS_PROTO_V2, 0x8f, 0x8f, ALPS_WHEEL } }, /* Toshiba Satellite S2400-103 */
117 { { 0x63, 0x02, 0x50 }, 0x00, { ALPS_PROTO_V2, 0xef, 0xef, ALPS_FW_BK_1 } }, /* NEC Versa L320 */
118 { { 0x63, 0x02, 0x64 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
119 { { 0x63, 0x03, 0xc8 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } }, /* Dell Latitude D800 */
120 { { 0x73, 0x00, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_DUALPOINT } }, /* ThinkPad R61 8918-5QG */
121 { { 0x73, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
122 { { 0x73, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_FW_BK_2 } }, /* Ahtec Laptop */
125 * XXX This entry is suspicious. First byte has zero lower nibble,
126 * which is what a normal mouse would report. Also, the value 0x0e
127 * isn't valid per PS/2 spec.
129 { { 0x20, 0x02, 0x0e }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } },
131 { { 0x22, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } },
132 { { 0x22, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xff, 0xff, ALPS_PASS | ALPS_DUALPOINT } }, /* Dell Latitude D600 */
133 /* Dell Latitude E5500, E6400, E6500, Precision M4400 */
134 { { 0x62, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xcf, 0xcf,
135 ALPS_PASS | ALPS_DUALPOINT | ALPS_PS2_INTERLEAVED } },
136 { { 0x73, 0x00, 0x14 }, 0x00, { ALPS_PROTO_V6, 0xff, 0xff, ALPS_DUALPOINT } }, /* Dell XT2 */
137 { { 0x73, 0x02, 0x50 }, 0x00, { ALPS_PROTO_V2, 0xcf, 0xcf, ALPS_FOUR_BUTTONS } }, /* Dell Vostro 1400 */
138 { { 0x52, 0x01, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xff, 0xff,
139 ALPS_PASS | ALPS_DUALPOINT | ALPS_PS2_INTERLEAVED } }, /* Toshiba Tecra A11-11L */
140 { { 0x73, 0x02, 0x64 }, 0x8a, { ALPS_PROTO_V4, 0x8f, 0x8f, 0 } },
143 static const struct alps_protocol_info alps_v3_protocol_data = {
144 ALPS_PROTO_V3, 0x8f, 0x8f, ALPS_DUALPOINT
147 static const struct alps_protocol_info alps_v3_rushmore_data = {
148 ALPS_PROTO_V3_RUSHMORE, 0x8f, 0x8f, ALPS_DUALPOINT
151 static const struct alps_protocol_info alps_v5_protocol_data = {
152 ALPS_PROTO_V5, 0xc8, 0xd8, 0
155 static const struct alps_protocol_info alps_v7_protocol_data = {
156 ALPS_PROTO_V7, 0x48, 0x48, ALPS_DUALPOINT
159 static const struct alps_protocol_info alps_v8_protocol_data = {
160 ALPS_PROTO_V8, 0x18, 0x18, 0
164 * Some v2 models report the stick buttons in separate bits
166 static const struct dmi_system_id alps_dmi_has_separate_stick_buttons[] = {
167 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
169 /* Extrapolated from other entries */
170 .matches = {
171 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
172 DMI_MATCH(DMI_PRODUCT_NAME, "Latitude D420"),
176 /* Reported-by: Hans de Bruin <jmdebruin@xmsnet.nl> */
177 .matches = {
178 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
179 DMI_MATCH(DMI_PRODUCT_NAME, "Latitude D430"),
183 /* Reported-by: Hans de Goede <hdegoede@redhat.com> */
184 .matches = {
185 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
186 DMI_MATCH(DMI_PRODUCT_NAME, "Latitude D620"),
190 /* Extrapolated from other entries */
191 .matches = {
192 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
193 DMI_MATCH(DMI_PRODUCT_NAME, "Latitude D630"),
196 #endif
200 static void alps_set_abs_params_st(struct alps_data *priv,
201 struct input_dev *dev1);
202 static void alps_set_abs_params_semi_mt(struct alps_data *priv,
203 struct input_dev *dev1);
204 static void alps_set_abs_params_v7(struct alps_data *priv,
205 struct input_dev *dev1);
206 static void alps_set_abs_params_ss4_v2(struct alps_data *priv,
207 struct input_dev *dev1);
209 /* Packet formats are described in Documentation/input/alps.txt */
211 static bool alps_is_valid_first_byte(struct alps_data *priv,
212 unsigned char data)
214 return (data & priv->mask0) == priv->byte0;
217 static void alps_report_buttons(struct input_dev *dev1, struct input_dev *dev2,
218 int left, int right, int middle)
220 struct input_dev *dev;
223 * If shared button has already been reported on the
224 * other device (dev2) then this event should be also
225 * sent through that device.
227 dev = (dev2 && test_bit(BTN_LEFT, dev2->key)) ? dev2 : dev1;
228 input_report_key(dev, BTN_LEFT, left);
230 dev = (dev2 && test_bit(BTN_RIGHT, dev2->key)) ? dev2 : dev1;
231 input_report_key(dev, BTN_RIGHT, right);
233 dev = (dev2 && test_bit(BTN_MIDDLE, dev2->key)) ? dev2 : dev1;
234 input_report_key(dev, BTN_MIDDLE, middle);
237 * Sync the _other_ device now, we'll do the first
238 * device later once we report the rest of the events.
240 if (dev2)
241 input_sync(dev2);
244 static void alps_process_packet_v1_v2(struct psmouse *psmouse)
246 struct alps_data *priv = psmouse->private;
247 unsigned char *packet = psmouse->packet;
248 struct input_dev *dev = psmouse->dev;
249 struct input_dev *dev2 = priv->dev2;
250 int x, y, z, ges, fin, left, right, middle;
251 int back = 0, forward = 0;
253 if (priv->proto_version == ALPS_PROTO_V1) {
254 left = packet[2] & 0x10;
255 right = packet[2] & 0x08;
256 middle = 0;
257 x = packet[1] | ((packet[0] & 0x07) << 7);
258 y = packet[4] | ((packet[3] & 0x07) << 7);
259 z = packet[5];
260 } else {
261 left = packet[3] & 1;
262 right = packet[3] & 2;
263 middle = packet[3] & 4;
264 x = packet[1] | ((packet[2] & 0x78) << (7 - 3));
265 y = packet[4] | ((packet[3] & 0x70) << (7 - 4));
266 z = packet[5];
269 if (priv->flags & ALPS_FW_BK_1) {
270 back = packet[0] & 0x10;
271 forward = packet[2] & 4;
274 if (priv->flags & ALPS_FW_BK_2) {
275 back = packet[3] & 4;
276 forward = packet[2] & 4;
277 if ((middle = forward && back))
278 forward = back = 0;
281 ges = packet[2] & 1;
282 fin = packet[2] & 2;
284 if ((priv->flags & ALPS_DUALPOINT) && z == 127) {
285 input_report_rel(dev2, REL_X, (x > 383 ? (x - 768) : x));
286 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y));
288 alps_report_buttons(dev2, dev, left, right, middle);
290 input_sync(dev2);
291 return;
294 /* Some models have separate stick button bits */
295 if (priv->flags & ALPS_STICK_BITS) {
296 left |= packet[0] & 1;
297 right |= packet[0] & 2;
298 middle |= packet[0] & 4;
301 alps_report_buttons(dev, dev2, left, right, middle);
303 /* Convert hardware tap to a reasonable Z value */
304 if (ges && !fin)
305 z = 40;
308 * A "tap and drag" operation is reported by the hardware as a transition
309 * from (!fin && ges) to (fin && ges). This should be translated to the
310 * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
312 if (ges && fin && !priv->prev_fin) {
313 input_report_abs(dev, ABS_X, x);
314 input_report_abs(dev, ABS_Y, y);
315 input_report_abs(dev, ABS_PRESSURE, 0);
316 input_report_key(dev, BTN_TOOL_FINGER, 0);
317 input_sync(dev);
319 priv->prev_fin = fin;
321 if (z > 30)
322 input_report_key(dev, BTN_TOUCH, 1);
323 if (z < 25)
324 input_report_key(dev, BTN_TOUCH, 0);
326 if (z > 0) {
327 input_report_abs(dev, ABS_X, x);
328 input_report_abs(dev, ABS_Y, y);
331 input_report_abs(dev, ABS_PRESSURE, z);
332 input_report_key(dev, BTN_TOOL_FINGER, z > 0);
334 if (priv->flags & ALPS_WHEEL)
335 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07));
337 if (priv->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
338 input_report_key(dev, BTN_FORWARD, forward);
339 input_report_key(dev, BTN_BACK, back);
342 if (priv->flags & ALPS_FOUR_BUTTONS) {
343 input_report_key(dev, BTN_0, packet[2] & 4);
344 input_report_key(dev, BTN_1, packet[0] & 0x10);
345 input_report_key(dev, BTN_2, packet[3] & 4);
346 input_report_key(dev, BTN_3, packet[0] & 0x20);
349 input_sync(dev);
352 static void alps_get_bitmap_points(unsigned int map,
353 struct alps_bitmap_point *low,
354 struct alps_bitmap_point *high,
355 int *fingers)
357 struct alps_bitmap_point *point;
358 int i, bit, prev_bit = 0;
360 point = low;
361 for (i = 0; map != 0; i++, map >>= 1) {
362 bit = map & 1;
363 if (bit) {
364 if (!prev_bit) {
365 point->start_bit = i;
366 point->num_bits = 0;
367 (*fingers)++;
369 point->num_bits++;
370 } else {
371 if (prev_bit)
372 point = high;
374 prev_bit = bit;
379 * Process bitmap data from semi-mt protocols. Returns the number of
380 * fingers detected. A return value of 0 means at least one of the
381 * bitmaps was empty.
383 * The bitmaps don't have enough data to track fingers, so this function
384 * only generates points representing a bounding box of all contacts.
385 * These points are returned in fields->mt when the return value
386 * is greater than 0.
388 static int alps_process_bitmap(struct alps_data *priv,
389 struct alps_fields *fields)
391 int i, fingers_x = 0, fingers_y = 0, fingers, closest;
392 struct alps_bitmap_point x_low = {0,}, x_high = {0,};
393 struct alps_bitmap_point y_low = {0,}, y_high = {0,};
394 struct input_mt_pos corner[4];
396 if (!fields->x_map || !fields->y_map)
397 return 0;
399 alps_get_bitmap_points(fields->x_map, &x_low, &x_high, &fingers_x);
400 alps_get_bitmap_points(fields->y_map, &y_low, &y_high, &fingers_y);
403 * Fingers can overlap, so we use the maximum count of fingers
404 * on either axis as the finger count.
406 fingers = max(fingers_x, fingers_y);
409 * If an axis reports only a single contact, we have overlapping or
410 * adjacent fingers. Divide the single contact between the two points.
412 if (fingers_x == 1) {
413 i = (x_low.num_bits - 1) / 2;
414 x_low.num_bits = x_low.num_bits - i;
415 x_high.start_bit = x_low.start_bit + i;
416 x_high.num_bits = max(i, 1);
418 if (fingers_y == 1) {
419 i = (y_low.num_bits - 1) / 2;
420 y_low.num_bits = y_low.num_bits - i;
421 y_high.start_bit = y_low.start_bit + i;
422 y_high.num_bits = max(i, 1);
425 /* top-left corner */
426 corner[0].x =
427 (priv->x_max * (2 * x_low.start_bit + x_low.num_bits - 1)) /
428 (2 * (priv->x_bits - 1));
429 corner[0].y =
430 (priv->y_max * (2 * y_low.start_bit + y_low.num_bits - 1)) /
431 (2 * (priv->y_bits - 1));
433 /* top-right corner */
434 corner[1].x =
435 (priv->x_max * (2 * x_high.start_bit + x_high.num_bits - 1)) /
436 (2 * (priv->x_bits - 1));
437 corner[1].y =
438 (priv->y_max * (2 * y_low.start_bit + y_low.num_bits - 1)) /
439 (2 * (priv->y_bits - 1));
441 /* bottom-right corner */
442 corner[2].x =
443 (priv->x_max * (2 * x_high.start_bit + x_high.num_bits - 1)) /
444 (2 * (priv->x_bits - 1));
445 corner[2].y =
446 (priv->y_max * (2 * y_high.start_bit + y_high.num_bits - 1)) /
447 (2 * (priv->y_bits - 1));
449 /* bottom-left corner */
450 corner[3].x =
451 (priv->x_max * (2 * x_low.start_bit + x_low.num_bits - 1)) /
452 (2 * (priv->x_bits - 1));
453 corner[3].y =
454 (priv->y_max * (2 * y_high.start_bit + y_high.num_bits - 1)) /
455 (2 * (priv->y_bits - 1));
457 /* x-bitmap order is reversed on v5 touchpads */
458 if (priv->proto_version == ALPS_PROTO_V5) {
459 for (i = 0; i < 4; i++)
460 corner[i].x = priv->x_max - corner[i].x;
463 /* y-bitmap order is reversed on v3 and v4 touchpads */
464 if (priv->proto_version == ALPS_PROTO_V3 ||
465 priv->proto_version == ALPS_PROTO_V4) {
466 for (i = 0; i < 4; i++)
467 corner[i].y = priv->y_max - corner[i].y;
471 * We only select a corner for the second touch once per 2 finger
472 * touch sequence to avoid the chosen corner (and thus the coordinates)
473 * jumping around when the first touch is in the middle.
475 if (priv->second_touch == -1) {
476 /* Find corner closest to our st coordinates */
477 closest = 0x7fffffff;
478 for (i = 0; i < 4; i++) {
479 int dx = fields->st.x - corner[i].x;
480 int dy = fields->st.y - corner[i].y;
481 int distance = dx * dx + dy * dy;
483 if (distance < closest) {
484 priv->second_touch = i;
485 closest = distance;
488 /* And select the opposite corner to use for the 2nd touch */
489 priv->second_touch = (priv->second_touch + 2) % 4;
492 fields->mt[0] = fields->st;
493 fields->mt[1] = corner[priv->second_touch];
495 return fingers;
498 static void alps_set_slot(struct input_dev *dev, int slot, int x, int y)
500 input_mt_slot(dev, slot);
501 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
502 input_report_abs(dev, ABS_MT_POSITION_X, x);
503 input_report_abs(dev, ABS_MT_POSITION_Y, y);
506 static void alps_report_mt_data(struct psmouse *psmouse, int n)
508 struct alps_data *priv = psmouse->private;
509 struct input_dev *dev = psmouse->dev;
510 struct alps_fields *f = &priv->f;
511 int i, slot[MAX_TOUCHES];
513 input_mt_assign_slots(dev, slot, f->mt, n, 0);
514 for (i = 0; i < n; i++)
515 alps_set_slot(dev, slot[i], f->mt[i].x, f->mt[i].y);
517 input_mt_sync_frame(dev);
520 static void alps_report_semi_mt_data(struct psmouse *psmouse, int fingers)
522 struct alps_data *priv = psmouse->private;
523 struct input_dev *dev = psmouse->dev;
524 struct alps_fields *f = &priv->f;
526 /* Use st data when we don't have mt data */
527 if (fingers < 2) {
528 f->mt[0].x = f->st.x;
529 f->mt[0].y = f->st.y;
530 fingers = f->pressure > 0 ? 1 : 0;
531 priv->second_touch = -1;
534 if (fingers >= 1)
535 alps_set_slot(dev, 0, f->mt[0].x, f->mt[0].y);
536 if (fingers >= 2)
537 alps_set_slot(dev, 1, f->mt[1].x, f->mt[1].y);
538 input_mt_sync_frame(dev);
540 input_mt_report_finger_count(dev, fingers);
542 input_report_key(dev, BTN_LEFT, f->left);
543 input_report_key(dev, BTN_RIGHT, f->right);
544 input_report_key(dev, BTN_MIDDLE, f->middle);
546 input_report_abs(dev, ABS_PRESSURE, f->pressure);
548 input_sync(dev);
551 static void alps_process_trackstick_packet_v3(struct psmouse *psmouse)
553 struct alps_data *priv = psmouse->private;
554 unsigned char *packet = psmouse->packet;
555 struct input_dev *dev = priv->dev2;
556 int x, y, z, left, right, middle;
558 /* It should be a DualPoint when received trackstick packet */
559 if (!(priv->flags & ALPS_DUALPOINT)) {
560 psmouse_warn(psmouse,
561 "Rejected trackstick packet from non DualPoint device");
562 return;
565 /* Sanity check packet */
566 if (!(packet[0] & 0x40)) {
567 psmouse_dbg(psmouse, "Bad trackstick packet, discarding\n");
568 return;
572 * There's a special packet that seems to indicate the end
573 * of a stream of trackstick data. Filter these out.
575 if (packet[1] == 0x7f && packet[2] == 0x7f && packet[4] == 0x7f)
576 return;
578 x = (s8)(((packet[0] & 0x20) << 2) | (packet[1] & 0x7f));
579 y = (s8)(((packet[0] & 0x10) << 3) | (packet[2] & 0x7f));
580 z = (packet[4] & 0x7c) >> 2;
583 * The x and y values tend to be quite large, and when used
584 * alone the trackstick is difficult to use. Scale them down
585 * to compensate.
587 x /= 8;
588 y /= 8;
590 input_report_rel(dev, REL_X, x);
591 input_report_rel(dev, REL_Y, -y);
594 * Most ALPS models report the trackstick buttons in the touchpad
595 * packets, but a few report them here. No reliable way has been
596 * found to differentiate between the models upfront, so we enable
597 * the quirk in response to seeing a button press in the trackstick
598 * packet.
600 left = packet[3] & 0x01;
601 right = packet[3] & 0x02;
602 middle = packet[3] & 0x04;
604 if (!(priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS) &&
605 (left || right || middle))
606 priv->quirks |= ALPS_QUIRK_TRACKSTICK_BUTTONS;
608 if (priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS) {
609 input_report_key(dev, BTN_LEFT, left);
610 input_report_key(dev, BTN_RIGHT, right);
611 input_report_key(dev, BTN_MIDDLE, middle);
614 input_sync(dev);
615 return;
618 static void alps_decode_buttons_v3(struct alps_fields *f, unsigned char *p)
620 f->left = !!(p[3] & 0x01);
621 f->right = !!(p[3] & 0x02);
622 f->middle = !!(p[3] & 0x04);
624 f->ts_left = !!(p[3] & 0x10);
625 f->ts_right = !!(p[3] & 0x20);
626 f->ts_middle = !!(p[3] & 0x40);
629 static int alps_decode_pinnacle(struct alps_fields *f, unsigned char *p,
630 struct psmouse *psmouse)
632 f->first_mp = !!(p[4] & 0x40);
633 f->is_mp = !!(p[0] & 0x40);
635 if (f->is_mp) {
636 f->fingers = (p[5] & 0x3) + 1;
637 f->x_map = ((p[4] & 0x7e) << 8) |
638 ((p[1] & 0x7f) << 2) |
639 ((p[0] & 0x30) >> 4);
640 f->y_map = ((p[3] & 0x70) << 4) |
641 ((p[2] & 0x7f) << 1) |
642 (p[4] & 0x01);
643 } else {
644 f->st.x = ((p[1] & 0x7f) << 4) | ((p[4] & 0x30) >> 2) |
645 ((p[0] & 0x30) >> 4);
646 f->st.y = ((p[2] & 0x7f) << 4) | (p[4] & 0x0f);
647 f->pressure = p[5] & 0x7f;
649 alps_decode_buttons_v3(f, p);
652 return 0;
655 static int alps_decode_rushmore(struct alps_fields *f, unsigned char *p,
656 struct psmouse *psmouse)
658 f->first_mp = !!(p[4] & 0x40);
659 f->is_mp = !!(p[5] & 0x40);
661 if (f->is_mp) {
662 f->fingers = max((p[5] & 0x3), ((p[5] >> 2) & 0x3)) + 1;
663 f->x_map = ((p[5] & 0x10) << 11) |
664 ((p[4] & 0x7e) << 8) |
665 ((p[1] & 0x7f) << 2) |
666 ((p[0] & 0x30) >> 4);
667 f->y_map = ((p[5] & 0x20) << 6) |
668 ((p[3] & 0x70) << 4) |
669 ((p[2] & 0x7f) << 1) |
670 (p[4] & 0x01);
671 } else {
672 f->st.x = ((p[1] & 0x7f) << 4) | ((p[4] & 0x30) >> 2) |
673 ((p[0] & 0x30) >> 4);
674 f->st.y = ((p[2] & 0x7f) << 4) | (p[4] & 0x0f);
675 f->pressure = p[5] & 0x7f;
677 alps_decode_buttons_v3(f, p);
680 return 0;
683 static int alps_decode_dolphin(struct alps_fields *f, unsigned char *p,
684 struct psmouse *psmouse)
686 u64 palm_data = 0;
687 struct alps_data *priv = psmouse->private;
689 f->first_mp = !!(p[0] & 0x02);
690 f->is_mp = !!(p[0] & 0x20);
692 if (!f->is_mp) {
693 f->st.x = ((p[1] & 0x7f) | ((p[4] & 0x0f) << 7));
694 f->st.y = ((p[2] & 0x7f) | ((p[4] & 0xf0) << 3));
695 f->pressure = (p[0] & 4) ? 0 : p[5] & 0x7f;
696 alps_decode_buttons_v3(f, p);
697 } else {
698 f->fingers = ((p[0] & 0x6) >> 1 |
699 (p[0] & 0x10) >> 2);
701 palm_data = (p[1] & 0x7f) |
702 ((p[2] & 0x7f) << 7) |
703 ((p[4] & 0x7f) << 14) |
704 ((p[5] & 0x7f) << 21) |
705 ((p[3] & 0x07) << 28) |
706 (((u64)p[3] & 0x70) << 27) |
707 (((u64)p[0] & 0x01) << 34);
709 /* Y-profile is stored in P(0) to p(n-1), n = y_bits; */
710 f->y_map = palm_data & (BIT(priv->y_bits) - 1);
712 /* X-profile is stored in p(n) to p(n+m-1), m = x_bits; */
713 f->x_map = (palm_data >> priv->y_bits) &
714 (BIT(priv->x_bits) - 1);
717 return 0;
720 static void alps_process_touchpad_packet_v3_v5(struct psmouse *psmouse)
722 struct alps_data *priv = psmouse->private;
723 unsigned char *packet = psmouse->packet;
724 struct input_dev *dev2 = priv->dev2;
725 struct alps_fields *f = &priv->f;
726 int fingers = 0;
728 memset(f, 0, sizeof(*f));
730 priv->decode_fields(f, packet, psmouse);
733 * There's no single feature of touchpad position and bitmap packets
734 * that can be used to distinguish between them. We rely on the fact
735 * that a bitmap packet should always follow a position packet with
736 * bit 6 of packet[4] set.
738 if (priv->multi_packet) {
740 * Sometimes a position packet will indicate a multi-packet
741 * sequence, but then what follows is another position
742 * packet. Check for this, and when it happens process the
743 * position packet as usual.
745 if (f->is_mp) {
746 fingers = f->fingers;
748 * Bitmap processing uses position packet's coordinate
749 * data, so we need to do decode it first.
751 priv->decode_fields(f, priv->multi_data, psmouse);
752 if (alps_process_bitmap(priv, f) == 0)
753 fingers = 0; /* Use st data */
754 } else {
755 priv->multi_packet = 0;
760 * Bit 6 of byte 0 is not usually set in position packets. The only
761 * times it seems to be set is in situations where the data is
762 * suspect anyway, e.g. a palm resting flat on the touchpad. Given
763 * this combined with the fact that this bit is useful for filtering
764 * out misidentified bitmap packets, we reject anything with this
765 * bit set.
767 if (f->is_mp)
768 return;
770 if (!priv->multi_packet && f->first_mp) {
771 priv->multi_packet = 1;
772 memcpy(priv->multi_data, packet, sizeof(priv->multi_data));
773 return;
776 priv->multi_packet = 0;
779 * Sometimes the hardware sends a single packet with z = 0
780 * in the middle of a stream. Real releases generate packets
781 * with x, y, and z all zero, so these seem to be flukes.
782 * Ignore them.
784 if (f->st.x && f->st.y && !f->pressure)
785 return;
787 alps_report_semi_mt_data(psmouse, fingers);
789 if ((priv->flags & ALPS_DUALPOINT) &&
790 !(priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS)) {
791 input_report_key(dev2, BTN_LEFT, f->ts_left);
792 input_report_key(dev2, BTN_RIGHT, f->ts_right);
793 input_report_key(dev2, BTN_MIDDLE, f->ts_middle);
794 input_sync(dev2);
798 static void alps_process_packet_v3(struct psmouse *psmouse)
800 unsigned char *packet = psmouse->packet;
803 * v3 protocol packets come in three types, two representing
804 * touchpad data and one representing trackstick data.
805 * Trackstick packets seem to be distinguished by always
806 * having 0x3f in the last byte. This value has never been
807 * observed in the last byte of either of the other types
808 * of packets.
810 if (packet[5] == 0x3f) {
811 alps_process_trackstick_packet_v3(psmouse);
812 return;
815 alps_process_touchpad_packet_v3_v5(psmouse);
818 static void alps_process_packet_v6(struct psmouse *psmouse)
820 struct alps_data *priv = psmouse->private;
821 unsigned char *packet = psmouse->packet;
822 struct input_dev *dev = psmouse->dev;
823 struct input_dev *dev2 = priv->dev2;
824 int x, y, z, left, right, middle;
827 * We can use Byte5 to distinguish if the packet is from Touchpad
828 * or Trackpoint.
829 * Touchpad: 0 - 0x7E
830 * Trackpoint: 0x7F
832 if (packet[5] == 0x7F) {
833 /* It should be a DualPoint when received Trackpoint packet */
834 if (!(priv->flags & ALPS_DUALPOINT)) {
835 psmouse_warn(psmouse,
836 "Rejected trackstick packet from non DualPoint device");
837 return;
840 /* Trackpoint packet */
841 x = packet[1] | ((packet[3] & 0x20) << 2);
842 y = packet[2] | ((packet[3] & 0x40) << 1);
843 z = packet[4];
844 left = packet[3] & 0x01;
845 right = packet[3] & 0x02;
846 middle = packet[3] & 0x04;
848 /* To prevent the cursor jump when finger lifted */
849 if (x == 0x7F && y == 0x7F && z == 0x7F)
850 x = y = z = 0;
852 /* Divide 4 since trackpoint's speed is too fast */
853 input_report_rel(dev2, REL_X, (char)x / 4);
854 input_report_rel(dev2, REL_Y, -((char)y / 4));
856 input_report_key(dev2, BTN_LEFT, left);
857 input_report_key(dev2, BTN_RIGHT, right);
858 input_report_key(dev2, BTN_MIDDLE, middle);
860 input_sync(dev2);
861 return;
864 /* Touchpad packet */
865 x = packet[1] | ((packet[3] & 0x78) << 4);
866 y = packet[2] | ((packet[4] & 0x78) << 4);
867 z = packet[5];
868 left = packet[3] & 0x01;
869 right = packet[3] & 0x02;
871 if (z > 30)
872 input_report_key(dev, BTN_TOUCH, 1);
873 if (z < 25)
874 input_report_key(dev, BTN_TOUCH, 0);
876 if (z > 0) {
877 input_report_abs(dev, ABS_X, x);
878 input_report_abs(dev, ABS_Y, y);
881 input_report_abs(dev, ABS_PRESSURE, z);
882 input_report_key(dev, BTN_TOOL_FINGER, z > 0);
884 /* v6 touchpad does not have middle button */
885 input_report_key(dev, BTN_LEFT, left);
886 input_report_key(dev, BTN_RIGHT, right);
888 input_sync(dev);
891 static void alps_process_packet_v4(struct psmouse *psmouse)
893 struct alps_data *priv = psmouse->private;
894 unsigned char *packet = psmouse->packet;
895 struct alps_fields *f = &priv->f;
896 int offset;
899 * v4 has a 6-byte encoding for bitmap data, but this data is
900 * broken up between 3 normal packets. Use priv->multi_packet to
901 * track our position in the bitmap packet.
903 if (packet[6] & 0x40) {
904 /* sync, reset position */
905 priv->multi_packet = 0;
908 if (WARN_ON_ONCE(priv->multi_packet > 2))
909 return;
911 offset = 2 * priv->multi_packet;
912 priv->multi_data[offset] = packet[6];
913 priv->multi_data[offset + 1] = packet[7];
915 f->left = !!(packet[4] & 0x01);
916 f->right = !!(packet[4] & 0x02);
918 f->st.x = ((packet[1] & 0x7f) << 4) | ((packet[3] & 0x30) >> 2) |
919 ((packet[0] & 0x30) >> 4);
920 f->st.y = ((packet[2] & 0x7f) << 4) | (packet[3] & 0x0f);
921 f->pressure = packet[5] & 0x7f;
923 if (++priv->multi_packet > 2) {
924 priv->multi_packet = 0;
926 f->x_map = ((priv->multi_data[2] & 0x1f) << 10) |
927 ((priv->multi_data[3] & 0x60) << 3) |
928 ((priv->multi_data[0] & 0x3f) << 2) |
929 ((priv->multi_data[1] & 0x60) >> 5);
930 f->y_map = ((priv->multi_data[5] & 0x01) << 10) |
931 ((priv->multi_data[3] & 0x1f) << 5) |
932 (priv->multi_data[1] & 0x1f);
934 f->fingers = alps_process_bitmap(priv, f);
937 alps_report_semi_mt_data(psmouse, f->fingers);
940 static bool alps_is_valid_package_v7(struct psmouse *psmouse)
942 switch (psmouse->pktcnt) {
943 case 3:
944 return (psmouse->packet[2] & 0x40) == 0x40;
945 case 4:
946 return (psmouse->packet[3] & 0x48) == 0x48;
947 case 6:
948 return (psmouse->packet[5] & 0x40) == 0x00;
950 return true;
953 static unsigned char alps_get_packet_id_v7(char *byte)
955 unsigned char packet_id;
957 if (byte[4] & 0x40)
958 packet_id = V7_PACKET_ID_TWO;
959 else if (byte[4] & 0x01)
960 packet_id = V7_PACKET_ID_MULTI;
961 else if ((byte[0] & 0x10) && !(byte[4] & 0x43))
962 packet_id = V7_PACKET_ID_NEW;
963 else if (byte[1] == 0x00 && byte[4] == 0x00)
964 packet_id = V7_PACKET_ID_IDLE;
965 else
966 packet_id = V7_PACKET_ID_UNKNOWN;
968 return packet_id;
971 static void alps_get_finger_coordinate_v7(struct input_mt_pos *mt,
972 unsigned char *pkt,
973 unsigned char pkt_id)
975 mt[0].x = ((pkt[2] & 0x80) << 4);
976 mt[0].x |= ((pkt[2] & 0x3F) << 5);
977 mt[0].x |= ((pkt[3] & 0x30) >> 1);
978 mt[0].x |= (pkt[3] & 0x07);
979 mt[0].y = (pkt[1] << 3) | (pkt[0] & 0x07);
981 mt[1].x = ((pkt[3] & 0x80) << 4);
982 mt[1].x |= ((pkt[4] & 0x80) << 3);
983 mt[1].x |= ((pkt[4] & 0x3F) << 4);
984 mt[1].y = ((pkt[5] & 0x80) << 3);
985 mt[1].y |= ((pkt[5] & 0x3F) << 4);
987 switch (pkt_id) {
988 case V7_PACKET_ID_TWO:
989 mt[1].x &= ~0x000F;
990 mt[1].y |= 0x000F;
991 /* Detect false-postive touches where x & y report max value */
992 if (mt[1].y == 0x7ff && mt[1].x == 0xff0) {
993 mt[1].x = 0;
994 /* y gets set to 0 at the end of this function */
996 break;
998 case V7_PACKET_ID_MULTI:
999 mt[1].x &= ~0x003F;
1000 mt[1].y &= ~0x0020;
1001 mt[1].y |= ((pkt[4] & 0x02) << 4);
1002 mt[1].y |= 0x001F;
1003 break;
1005 case V7_PACKET_ID_NEW:
1006 mt[1].x &= ~0x003F;
1007 mt[1].x |= (pkt[0] & 0x20);
1008 mt[1].y |= 0x000F;
1009 break;
1012 mt[0].y = 0x7FF - mt[0].y;
1013 mt[1].y = 0x7FF - mt[1].y;
1016 static int alps_get_mt_count(struct input_mt_pos *mt)
1018 int i, fingers = 0;
1020 for (i = 0; i < MAX_TOUCHES; i++) {
1021 if (mt[i].x != 0 || mt[i].y != 0)
1022 fingers++;
1025 return fingers;
1028 static int alps_decode_packet_v7(struct alps_fields *f,
1029 unsigned char *p,
1030 struct psmouse *psmouse)
1032 struct alps_data *priv = psmouse->private;
1033 unsigned char pkt_id;
1035 pkt_id = alps_get_packet_id_v7(p);
1036 if (pkt_id == V7_PACKET_ID_IDLE)
1037 return 0;
1038 if (pkt_id == V7_PACKET_ID_UNKNOWN)
1039 return -1;
1041 * NEW packets are send to indicate a discontinuity in the finger
1042 * coordinate reporting. Specifically a finger may have moved from
1043 * slot 0 to 1 or vice versa. INPUT_MT_TRACK takes care of this for
1044 * us.
1046 * NEW packets have 3 problems:
1047 * 1) They do not contain middle / right button info (on non clickpads)
1048 * this can be worked around by preserving the old button state
1049 * 2) They do not contain an accurate fingercount, and they are
1050 * typically send when the number of fingers changes. We cannot use
1051 * the old finger count as that may mismatch with the amount of
1052 * touch coordinates we've available in the NEW packet
1053 * 3) Their x data for the second touch is inaccurate leading to
1054 * a possible jump of the x coordinate by 16 units when the first
1055 * non NEW packet comes in
1056 * Since problems 2 & 3 cannot be worked around, just ignore them.
1058 if (pkt_id == V7_PACKET_ID_NEW)
1059 return 1;
1061 alps_get_finger_coordinate_v7(f->mt, p, pkt_id);
1063 if (pkt_id == V7_PACKET_ID_TWO)
1064 f->fingers = alps_get_mt_count(f->mt);
1065 else /* pkt_id == V7_PACKET_ID_MULTI */
1066 f->fingers = 3 + (p[5] & 0x03);
1068 f->left = (p[0] & 0x80) >> 7;
1069 if (priv->flags & ALPS_BUTTONPAD) {
1070 if (p[0] & 0x20)
1071 f->fingers++;
1072 if (p[0] & 0x10)
1073 f->fingers++;
1074 } else {
1075 f->right = (p[0] & 0x20) >> 5;
1076 f->middle = (p[0] & 0x10) >> 4;
1079 /* Sometimes a single touch is reported in mt[1] rather then mt[0] */
1080 if (f->fingers == 1 && f->mt[0].x == 0 && f->mt[0].y == 0) {
1081 f->mt[0].x = f->mt[1].x;
1082 f->mt[0].y = f->mt[1].y;
1083 f->mt[1].x = 0;
1084 f->mt[1].y = 0;
1087 return 0;
1090 static void alps_process_trackstick_packet_v7(struct psmouse *psmouse)
1092 struct alps_data *priv = psmouse->private;
1093 unsigned char *packet = psmouse->packet;
1094 struct input_dev *dev2 = priv->dev2;
1095 int x, y, z, left, right, middle;
1097 /* It should be a DualPoint when received trackstick packet */
1098 if (!(priv->flags & ALPS_DUALPOINT)) {
1099 psmouse_warn(psmouse,
1100 "Rejected trackstick packet from non DualPoint device");
1101 return;
1104 x = ((packet[2] & 0xbf)) | ((packet[3] & 0x10) << 2);
1105 y = (packet[3] & 0x07) | (packet[4] & 0xb8) |
1106 ((packet[3] & 0x20) << 1);
1107 z = (packet[5] & 0x3f) | ((packet[3] & 0x80) >> 1);
1109 left = (packet[1] & 0x01);
1110 right = (packet[1] & 0x02) >> 1;
1111 middle = (packet[1] & 0x04) >> 2;
1113 input_report_rel(dev2, REL_X, (char)x);
1114 input_report_rel(dev2, REL_Y, -((char)y));
1116 input_report_key(dev2, BTN_LEFT, left);
1117 input_report_key(dev2, BTN_RIGHT, right);
1118 input_report_key(dev2, BTN_MIDDLE, middle);
1120 input_sync(dev2);
1123 static void alps_process_touchpad_packet_v7(struct psmouse *psmouse)
1125 struct alps_data *priv = psmouse->private;
1126 struct input_dev *dev = psmouse->dev;
1127 struct alps_fields *f = &priv->f;
1129 memset(f, 0, sizeof(*f));
1131 if (priv->decode_fields(f, psmouse->packet, psmouse))
1132 return;
1134 alps_report_mt_data(psmouse, alps_get_mt_count(f->mt));
1136 input_mt_report_finger_count(dev, f->fingers);
1138 input_report_key(dev, BTN_LEFT, f->left);
1139 input_report_key(dev, BTN_RIGHT, f->right);
1140 input_report_key(dev, BTN_MIDDLE, f->middle);
1142 input_sync(dev);
1145 static void alps_process_packet_v7(struct psmouse *psmouse)
1147 unsigned char *packet = psmouse->packet;
1149 if (packet[0] == 0x48 && (packet[4] & 0x47) == 0x06)
1150 alps_process_trackstick_packet_v7(psmouse);
1151 else
1152 alps_process_touchpad_packet_v7(psmouse);
1155 static unsigned char alps_get_pkt_id_ss4_v2(unsigned char *byte)
1157 unsigned char pkt_id = SS4_PACKET_ID_IDLE;
1159 if (byte[0] == 0x18 && byte[1] == 0x10 && byte[2] == 0x00 &&
1160 (byte[3] & 0x88) == 0x08 && byte[4] == 0x10 && byte[5] == 0x00) {
1161 pkt_id = SS4_PACKET_ID_IDLE;
1162 } else if (!(byte[3] & 0x10)) {
1163 pkt_id = SS4_PACKET_ID_ONE;
1164 } else if (!(byte[3] & 0x20)) {
1165 pkt_id = SS4_PACKET_ID_TWO;
1166 } else {
1167 pkt_id = SS4_PACKET_ID_MULTI;
1170 return pkt_id;
1173 static int alps_decode_ss4_v2(struct alps_fields *f,
1174 unsigned char *p, struct psmouse *psmouse)
1176 struct alps_data *priv = psmouse->private;
1177 unsigned char pkt_id;
1178 unsigned int no_data_x, no_data_y;
1180 pkt_id = alps_get_pkt_id_ss4_v2(p);
1182 /* Current packet is 1Finger coordinate packet */
1183 switch (pkt_id) {
1184 case SS4_PACKET_ID_ONE:
1185 f->mt[0].x = SS4_1F_X_V2(p);
1186 f->mt[0].y = SS4_1F_Y_V2(p);
1187 f->pressure = ((SS4_1F_Z_V2(p)) * 2) & 0x7f;
1188 f->fingers = 1;
1189 f->first_mp = 0;
1190 f->is_mp = 0;
1191 break;
1193 case SS4_PACKET_ID_TWO:
1194 if (priv->flags & ALPS_BUTTONPAD) {
1195 f->mt[0].x = SS4_BTL_MF_X_V2(p, 0);
1196 f->mt[0].y = SS4_BTL_MF_Y_V2(p, 0);
1197 f->mt[1].x = SS4_BTL_MF_X_V2(p, 1);
1198 f->mt[1].y = SS4_BTL_MF_Y_V2(p, 1);
1199 } else {
1200 f->mt[0].x = SS4_STD_MF_X_V2(p, 0);
1201 f->mt[0].y = SS4_STD_MF_Y_V2(p, 0);
1202 f->mt[1].x = SS4_STD_MF_X_V2(p, 1);
1203 f->mt[1].y = SS4_STD_MF_Y_V2(p, 1);
1205 f->pressure = SS4_MF_Z_V2(p, 0) ? 0x30 : 0;
1207 if (SS4_IS_MF_CONTINUE(p)) {
1208 f->first_mp = 1;
1209 } else {
1210 f->fingers = 2;
1211 f->first_mp = 0;
1213 f->is_mp = 0;
1215 break;
1217 case SS4_PACKET_ID_MULTI:
1218 if (priv->flags & ALPS_BUTTONPAD) {
1219 f->mt[2].x = SS4_BTL_MF_X_V2(p, 0);
1220 f->mt[2].y = SS4_BTL_MF_Y_V2(p, 0);
1221 f->mt[3].x = SS4_BTL_MF_X_V2(p, 1);
1222 f->mt[3].y = SS4_BTL_MF_Y_V2(p, 1);
1223 no_data_x = SS4_MFPACKET_NO_AX_BL;
1224 no_data_y = SS4_MFPACKET_NO_AY_BL;
1225 } else {
1226 f->mt[2].x = SS4_STD_MF_X_V2(p, 0);
1227 f->mt[2].y = SS4_STD_MF_Y_V2(p, 0);
1228 f->mt[3].x = SS4_STD_MF_X_V2(p, 1);
1229 f->mt[3].y = SS4_STD_MF_Y_V2(p, 1);
1230 no_data_x = SS4_MFPACKET_NO_AX;
1231 no_data_y = SS4_MFPACKET_NO_AY;
1234 f->first_mp = 0;
1235 f->is_mp = 1;
1237 if (SS4_IS_5F_DETECTED(p)) {
1238 f->fingers = 5;
1239 } else if (f->mt[3].x == no_data_x &&
1240 f->mt[3].y == no_data_y) {
1241 f->mt[3].x = 0;
1242 f->mt[3].y = 0;
1243 f->fingers = 3;
1244 } else {
1245 f->fingers = 4;
1247 break;
1249 case SS4_PACKET_ID_IDLE:
1250 default:
1251 memset(f, 0, sizeof(struct alps_fields));
1252 break;
1255 f->left = !!(SS4_BTN_V2(p) & 0x01);
1256 if (!(priv->flags & ALPS_BUTTONPAD)) {
1257 f->right = !!(SS4_BTN_V2(p) & 0x02);
1258 f->middle = !!(SS4_BTN_V2(p) & 0x04);
1261 return 0;
1264 static void alps_process_packet_ss4_v2(struct psmouse *psmouse)
1266 struct alps_data *priv = psmouse->private;
1267 unsigned char *packet = psmouse->packet;
1268 struct input_dev *dev = psmouse->dev;
1269 struct alps_fields *f = &priv->f;
1271 memset(f, 0, sizeof(struct alps_fields));
1272 priv->decode_fields(f, packet, psmouse);
1273 if (priv->multi_packet) {
1275 * Sometimes the first packet will indicate a multi-packet
1276 * sequence, but sometimes the next multi-packet would not
1277 * come. Check for this, and when it happens process the
1278 * position packet as usual.
1280 if (f->is_mp) {
1281 /* Now process the 1st packet */
1282 priv->decode_fields(f, priv->multi_data, psmouse);
1283 } else {
1284 priv->multi_packet = 0;
1289 * "f.is_mp" would always be '0' after merging the 1st and 2nd packet.
1290 * When it is set, it means 2nd packet comes without 1st packet come.
1292 if (f->is_mp)
1293 return;
1295 /* Save the first packet */
1296 if (!priv->multi_packet && f->first_mp) {
1297 priv->multi_packet = 1;
1298 memcpy(priv->multi_data, packet, sizeof(priv->multi_data));
1299 return;
1302 priv->multi_packet = 0;
1304 alps_report_mt_data(psmouse, (f->fingers <= 4) ? f->fingers : 4);
1306 input_mt_report_finger_count(dev, f->fingers);
1308 input_report_key(dev, BTN_LEFT, f->left);
1309 input_report_key(dev, BTN_RIGHT, f->right);
1310 input_report_key(dev, BTN_MIDDLE, f->middle);
1312 input_report_abs(dev, ABS_PRESSURE, f->pressure);
1313 input_sync(dev);
1316 static bool alps_is_valid_package_ss4_v2(struct psmouse *psmouse)
1318 if (psmouse->pktcnt == 4 && ((psmouse->packet[3] & 0x08) != 0x08))
1319 return false;
1320 if (psmouse->pktcnt == 6 && ((psmouse->packet[5] & 0x10) != 0x0))
1321 return false;
1322 return true;
1325 static DEFINE_MUTEX(alps_mutex);
1327 static void alps_register_bare_ps2_mouse(struct work_struct *work)
1329 struct alps_data *priv =
1330 container_of(work, struct alps_data, dev3_register_work.work);
1331 struct psmouse *psmouse = priv->psmouse;
1332 struct input_dev *dev3;
1333 int error = 0;
1335 mutex_lock(&alps_mutex);
1337 if (priv->dev3)
1338 goto out;
1340 dev3 = input_allocate_device();
1341 if (!dev3) {
1342 psmouse_err(psmouse, "failed to allocate secondary device\n");
1343 error = -ENOMEM;
1344 goto out;
1347 snprintf(priv->phys3, sizeof(priv->phys3), "%s/%s",
1348 psmouse->ps2dev.serio->phys,
1349 (priv->dev2 ? "input2" : "input1"));
1350 dev3->phys = priv->phys3;
1353 * format of input device name is: "protocol vendor name"
1354 * see function psmouse_switch_protocol() in psmouse-base.c
1356 dev3->name = "PS/2 ALPS Mouse";
1358 dev3->id.bustype = BUS_I8042;
1359 dev3->id.vendor = 0x0002;
1360 dev3->id.product = PSMOUSE_PS2;
1361 dev3->id.version = 0x0000;
1362 dev3->dev.parent = &psmouse->ps2dev.serio->dev;
1364 input_set_capability(dev3, EV_REL, REL_X);
1365 input_set_capability(dev3, EV_REL, REL_Y);
1366 input_set_capability(dev3, EV_KEY, BTN_LEFT);
1367 input_set_capability(dev3, EV_KEY, BTN_RIGHT);
1368 input_set_capability(dev3, EV_KEY, BTN_MIDDLE);
1370 __set_bit(INPUT_PROP_POINTER, dev3->propbit);
1372 error = input_register_device(dev3);
1373 if (error) {
1374 psmouse_err(psmouse,
1375 "failed to register secondary device: %d\n",
1376 error);
1377 input_free_device(dev3);
1378 goto out;
1381 priv->dev3 = dev3;
1383 out:
1385 * Save the error code so that we can detect that we
1386 * already tried to create the device.
1388 if (error)
1389 priv->dev3 = ERR_PTR(error);
1391 mutex_unlock(&alps_mutex);
1394 static void alps_report_bare_ps2_packet(struct psmouse *psmouse,
1395 unsigned char packet[],
1396 bool report_buttons)
1398 struct alps_data *priv = psmouse->private;
1399 struct input_dev *dev, *dev2 = NULL;
1401 /* Figure out which device to use to report the bare packet */
1402 if (priv->proto_version == ALPS_PROTO_V2 &&
1403 (priv->flags & ALPS_DUALPOINT)) {
1404 /* On V2 devices the DualPoint Stick reports bare packets */
1405 dev = priv->dev2;
1406 dev2 = psmouse->dev;
1407 } else if (unlikely(IS_ERR_OR_NULL(priv->dev3))) {
1408 /* Register dev3 mouse if we received PS/2 packet first time */
1409 if (!IS_ERR(priv->dev3))
1410 psmouse_queue_work(psmouse, &priv->dev3_register_work,
1412 return;
1413 } else {
1414 dev = priv->dev3;
1417 if (report_buttons)
1418 alps_report_buttons(dev, dev2,
1419 packet[0] & 1, packet[0] & 2, packet[0] & 4);
1421 input_report_rel(dev, REL_X,
1422 packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0);
1423 input_report_rel(dev, REL_Y,
1424 packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0);
1426 input_sync(dev);
1429 static psmouse_ret_t alps_handle_interleaved_ps2(struct psmouse *psmouse)
1431 struct alps_data *priv = psmouse->private;
1433 if (psmouse->pktcnt < 6)
1434 return PSMOUSE_GOOD_DATA;
1436 if (psmouse->pktcnt == 6) {
1438 * Start a timer to flush the packet if it ends up last
1439 * 6-byte packet in the stream. Timer needs to fire
1440 * psmouse core times out itself. 20 ms should be enough
1441 * to decide if we are getting more data or not.
1443 mod_timer(&priv->timer, jiffies + msecs_to_jiffies(20));
1444 return PSMOUSE_GOOD_DATA;
1447 del_timer(&priv->timer);
1449 if (psmouse->packet[6] & 0x80) {
1452 * Highest bit is set - that means we either had
1453 * complete ALPS packet and this is start of the
1454 * next packet or we got garbage.
1457 if (((psmouse->packet[3] |
1458 psmouse->packet[4] |
1459 psmouse->packet[5]) & 0x80) ||
1460 (!alps_is_valid_first_byte(priv, psmouse->packet[6]))) {
1461 psmouse_dbg(psmouse,
1462 "refusing packet %4ph (suspected interleaved ps/2)\n",
1463 psmouse->packet + 3);
1464 return PSMOUSE_BAD_DATA;
1467 priv->process_packet(psmouse);
1469 /* Continue with the next packet */
1470 psmouse->packet[0] = psmouse->packet[6];
1471 psmouse->pktcnt = 1;
1473 } else {
1476 * High bit is 0 - that means that we indeed got a PS/2
1477 * packet in the middle of ALPS packet.
1479 * There is also possibility that we got 6-byte ALPS
1480 * packet followed by 3-byte packet from trackpoint. We
1481 * can not distinguish between these 2 scenarios but
1482 * because the latter is unlikely to happen in course of
1483 * normal operation (user would need to press all
1484 * buttons on the pad and start moving trackpoint
1485 * without touching the pad surface) we assume former.
1486 * Even if we are wrong the wost thing that would happen
1487 * the cursor would jump but we should not get protocol
1488 * de-synchronization.
1491 alps_report_bare_ps2_packet(psmouse, &psmouse->packet[3],
1492 false);
1495 * Continue with the standard ALPS protocol handling,
1496 * but make sure we won't process it as an interleaved
1497 * packet again, which may happen if all buttons are
1498 * pressed. To avoid this let's reset the 4th bit which
1499 * is normally 1.
1501 psmouse->packet[3] = psmouse->packet[6] & 0xf7;
1502 psmouse->pktcnt = 4;
1505 return PSMOUSE_GOOD_DATA;
1508 static void alps_flush_packet(unsigned long data)
1510 struct psmouse *psmouse = (struct psmouse *)data;
1511 struct alps_data *priv = psmouse->private;
1513 serio_pause_rx(psmouse->ps2dev.serio);
1515 if (psmouse->pktcnt == psmouse->pktsize) {
1518 * We did not any more data in reasonable amount of time.
1519 * Validate the last 3 bytes and process as a standard
1520 * ALPS packet.
1522 if ((psmouse->packet[3] |
1523 psmouse->packet[4] |
1524 psmouse->packet[5]) & 0x80) {
1525 psmouse_dbg(psmouse,
1526 "refusing packet %3ph (suspected interleaved ps/2)\n",
1527 psmouse->packet + 3);
1528 } else {
1529 priv->process_packet(psmouse);
1531 psmouse->pktcnt = 0;
1534 serio_continue_rx(psmouse->ps2dev.serio);
1537 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse)
1539 struct alps_data *priv = psmouse->private;
1542 * Check if we are dealing with a bare PS/2 packet, presumably from
1543 * a device connected to the external PS/2 port. Because bare PS/2
1544 * protocol does not have enough constant bits to self-synchronize
1545 * properly we only do this if the device is fully synchronized.
1546 * Can not distinguish V8's first byte from PS/2 packet's
1548 if (priv->proto_version != ALPS_PROTO_V8 &&
1549 !psmouse->out_of_sync_cnt &&
1550 (psmouse->packet[0] & 0xc8) == 0x08) {
1552 if (psmouse->pktcnt == 3) {
1553 alps_report_bare_ps2_packet(psmouse, psmouse->packet,
1554 true);
1555 return PSMOUSE_FULL_PACKET;
1557 return PSMOUSE_GOOD_DATA;
1560 /* Check for PS/2 packet stuffed in the middle of ALPS packet. */
1562 if ((priv->flags & ALPS_PS2_INTERLEAVED) &&
1563 psmouse->pktcnt >= 4 && (psmouse->packet[3] & 0x0f) == 0x0f) {
1564 return alps_handle_interleaved_ps2(psmouse);
1567 if (!alps_is_valid_first_byte(priv, psmouse->packet[0])) {
1568 psmouse_dbg(psmouse,
1569 "refusing packet[0] = %x (mask0 = %x, byte0 = %x)\n",
1570 psmouse->packet[0], priv->mask0, priv->byte0);
1571 return PSMOUSE_BAD_DATA;
1574 /* Bytes 2 - pktsize should have 0 in the highest bit */
1575 if (priv->proto_version < ALPS_PROTO_V5 &&
1576 psmouse->pktcnt >= 2 && psmouse->pktcnt <= psmouse->pktsize &&
1577 (psmouse->packet[psmouse->pktcnt - 1] & 0x80)) {
1578 psmouse_dbg(psmouse, "refusing packet[%i] = %x\n",
1579 psmouse->pktcnt - 1,
1580 psmouse->packet[psmouse->pktcnt - 1]);
1582 if (priv->proto_version == ALPS_PROTO_V3_RUSHMORE &&
1583 psmouse->pktcnt == psmouse->pktsize) {
1585 * Some Dell boxes, such as Latitude E6440 or E7440
1586 * with closed lid, quite often smash last byte of
1587 * otherwise valid packet with 0xff. Given that the
1588 * next packet is very likely to be valid let's
1589 * report PSMOUSE_FULL_PACKET but not process data,
1590 * rather than reporting PSMOUSE_BAD_DATA and
1591 * filling the logs.
1593 return PSMOUSE_FULL_PACKET;
1596 return PSMOUSE_BAD_DATA;
1599 if ((priv->proto_version == ALPS_PROTO_V7 &&
1600 !alps_is_valid_package_v7(psmouse)) ||
1601 (priv->proto_version == ALPS_PROTO_V8 &&
1602 !alps_is_valid_package_ss4_v2(psmouse))) {
1603 psmouse_dbg(psmouse, "refusing packet[%i] = %x\n",
1604 psmouse->pktcnt - 1,
1605 psmouse->packet[psmouse->pktcnt - 1]);
1606 return PSMOUSE_BAD_DATA;
1609 if (psmouse->pktcnt == psmouse->pktsize) {
1610 priv->process_packet(psmouse);
1611 return PSMOUSE_FULL_PACKET;
1614 return PSMOUSE_GOOD_DATA;
1617 static int alps_command_mode_send_nibble(struct psmouse *psmouse, int nibble)
1619 struct ps2dev *ps2dev = &psmouse->ps2dev;
1620 struct alps_data *priv = psmouse->private;
1621 int command;
1622 unsigned char *param;
1623 unsigned char dummy[4];
1625 BUG_ON(nibble > 0xf);
1627 command = priv->nibble_commands[nibble].command;
1628 param = (command & 0x0f00) ?
1629 dummy : (unsigned char *)&priv->nibble_commands[nibble].data;
1631 if (ps2_command(ps2dev, param, command))
1632 return -1;
1634 return 0;
1637 static int alps_command_mode_set_addr(struct psmouse *psmouse, int addr)
1639 struct ps2dev *ps2dev = &psmouse->ps2dev;
1640 struct alps_data *priv = psmouse->private;
1641 int i, nibble;
1643 if (ps2_command(ps2dev, NULL, priv->addr_command))
1644 return -1;
1646 for (i = 12; i >= 0; i -= 4) {
1647 nibble = (addr >> i) & 0xf;
1648 if (alps_command_mode_send_nibble(psmouse, nibble))
1649 return -1;
1652 return 0;
1655 static int __alps_command_mode_read_reg(struct psmouse *psmouse, int addr)
1657 struct ps2dev *ps2dev = &psmouse->ps2dev;
1658 unsigned char param[4];
1660 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1661 return -1;
1664 * The address being read is returned in the first two bytes
1665 * of the result. Check that this address matches the expected
1666 * address.
1668 if (addr != ((param[0] << 8) | param[1]))
1669 return -1;
1671 return param[2];
1674 static int alps_command_mode_read_reg(struct psmouse *psmouse, int addr)
1676 if (alps_command_mode_set_addr(psmouse, addr))
1677 return -1;
1678 return __alps_command_mode_read_reg(psmouse, addr);
1681 static int __alps_command_mode_write_reg(struct psmouse *psmouse, u8 value)
1683 if (alps_command_mode_send_nibble(psmouse, (value >> 4) & 0xf))
1684 return -1;
1685 if (alps_command_mode_send_nibble(psmouse, value & 0xf))
1686 return -1;
1687 return 0;
1690 static int alps_command_mode_write_reg(struct psmouse *psmouse, int addr,
1691 u8 value)
1693 if (alps_command_mode_set_addr(psmouse, addr))
1694 return -1;
1695 return __alps_command_mode_write_reg(psmouse, value);
1698 static int alps_rpt_cmd(struct psmouse *psmouse, int init_command,
1699 int repeated_command, unsigned char *param)
1701 struct ps2dev *ps2dev = &psmouse->ps2dev;
1703 param[0] = 0;
1704 if (init_command && ps2_command(ps2dev, param, init_command))
1705 return -EIO;
1707 if (ps2_command(ps2dev, NULL, repeated_command) ||
1708 ps2_command(ps2dev, NULL, repeated_command) ||
1709 ps2_command(ps2dev, NULL, repeated_command))
1710 return -EIO;
1712 param[0] = param[1] = param[2] = 0xff;
1713 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1714 return -EIO;
1716 psmouse_dbg(psmouse, "%2.2X report: %3ph\n",
1717 repeated_command, param);
1718 return 0;
1721 static bool alps_check_valid_firmware_id(unsigned char id[])
1723 if (id[0] == 0x73)
1724 return true;
1726 if (id[0] == 0x88 &&
1727 (id[1] == 0x07 ||
1728 id[1] == 0x08 ||
1729 (id[1] & 0xf0) == 0xb0 ||
1730 (id[1] & 0xf0) == 0xc0)) {
1731 return true;
1734 return false;
1737 static int alps_enter_command_mode(struct psmouse *psmouse)
1739 unsigned char param[4];
1741 if (alps_rpt_cmd(psmouse, 0, PSMOUSE_CMD_RESET_WRAP, param)) {
1742 psmouse_err(psmouse, "failed to enter command mode\n");
1743 return -1;
1746 if (!alps_check_valid_firmware_id(param)) {
1747 psmouse_dbg(psmouse,
1748 "unknown response while entering command mode\n");
1749 return -1;
1751 return 0;
1754 static inline int alps_exit_command_mode(struct psmouse *psmouse)
1756 struct ps2dev *ps2dev = &psmouse->ps2dev;
1757 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM))
1758 return -1;
1759 return 0;
1763 * For DualPoint devices select the device that should respond to
1764 * subsequent commands. It looks like glidepad is behind stickpointer,
1765 * I'd thought it would be other way around...
1767 static int alps_passthrough_mode_v2(struct psmouse *psmouse, bool enable)
1769 struct ps2dev *ps2dev = &psmouse->ps2dev;
1770 int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11;
1772 if (ps2_command(ps2dev, NULL, cmd) ||
1773 ps2_command(ps2dev, NULL, cmd) ||
1774 ps2_command(ps2dev, NULL, cmd) ||
1775 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1776 return -1;
1778 /* we may get 3 more bytes, just ignore them */
1779 ps2_drain(ps2dev, 3, 100);
1781 return 0;
1784 static int alps_absolute_mode_v1_v2(struct psmouse *psmouse)
1786 struct ps2dev *ps2dev = &psmouse->ps2dev;
1788 /* Try ALPS magic knock - 4 disable before enable */
1789 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1790 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1791 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1792 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1793 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE))
1794 return -1;
1797 * Switch mouse to poll (remote) mode so motion data will not
1798 * get in our way
1800 return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL);
1803 static int alps_monitor_mode_send_word(struct psmouse *psmouse, u16 word)
1805 int i, nibble;
1808 * b0-b11 are valid bits, send sequence is inverse.
1809 * e.g. when word = 0x0123, nibble send sequence is 3, 2, 1
1811 for (i = 0; i <= 8; i += 4) {
1812 nibble = (word >> i) & 0xf;
1813 if (alps_command_mode_send_nibble(psmouse, nibble))
1814 return -1;
1817 return 0;
1820 static int alps_monitor_mode_write_reg(struct psmouse *psmouse,
1821 u16 addr, u16 value)
1823 struct ps2dev *ps2dev = &psmouse->ps2dev;
1825 /* 0x0A0 is the command to write the word */
1826 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE) ||
1827 alps_monitor_mode_send_word(psmouse, 0x0A0) ||
1828 alps_monitor_mode_send_word(psmouse, addr) ||
1829 alps_monitor_mode_send_word(psmouse, value) ||
1830 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1831 return -1;
1833 return 0;
1836 static int alps_monitor_mode(struct psmouse *psmouse, bool enable)
1838 struct ps2dev *ps2dev = &psmouse->ps2dev;
1840 if (enable) {
1841 /* EC E9 F5 F5 E7 E6 E7 E9 to enter monitor mode */
1842 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
1843 ps2_command(ps2dev, NULL, PSMOUSE_CMD_GETINFO) ||
1844 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1845 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1846 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1847 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1848 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1849 ps2_command(ps2dev, NULL, PSMOUSE_CMD_GETINFO))
1850 return -1;
1851 } else {
1852 /* EC to exit monitor mode */
1853 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP))
1854 return -1;
1857 return 0;
1860 static int alps_absolute_mode_v6(struct psmouse *psmouse)
1862 u16 reg_val = 0x181;
1863 int ret = -1;
1865 /* enter monitor mode, to write the register */
1866 if (alps_monitor_mode(psmouse, true))
1867 return -1;
1869 ret = alps_monitor_mode_write_reg(psmouse, 0x000, reg_val);
1871 if (alps_monitor_mode(psmouse, false))
1872 ret = -1;
1874 return ret;
1877 static int alps_get_status(struct psmouse *psmouse, char *param)
1879 /* Get status: 0xF5 0xF5 0xF5 0xE9 */
1880 if (alps_rpt_cmd(psmouse, 0, PSMOUSE_CMD_DISABLE, param))
1881 return -1;
1883 return 0;
1887 * Turn touchpad tapping on or off. The sequences are:
1888 * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
1889 * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
1890 * My guess that 0xE9 (GetInfo) is here as a sync point.
1891 * For models that also have stickpointer (DualPoints) its tapping
1892 * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
1893 * we don't fiddle with it.
1895 static int alps_tap_mode(struct psmouse *psmouse, int enable)
1897 struct ps2dev *ps2dev = &psmouse->ps2dev;
1898 int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES;
1899 unsigned char tap_arg = enable ? 0x0A : 0x00;
1900 unsigned char param[4];
1902 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) ||
1903 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1904 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1905 ps2_command(ps2dev, &tap_arg, cmd))
1906 return -1;
1908 if (alps_get_status(psmouse, param))
1909 return -1;
1911 return 0;
1915 * alps_poll() - poll the touchpad for current motion packet.
1916 * Used in resync.
1918 static int alps_poll(struct psmouse *psmouse)
1920 struct alps_data *priv = psmouse->private;
1921 unsigned char buf[sizeof(psmouse->packet)];
1922 bool poll_failed;
1924 if (priv->flags & ALPS_PASS)
1925 alps_passthrough_mode_v2(psmouse, true);
1927 poll_failed = ps2_command(&psmouse->ps2dev, buf,
1928 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0;
1930 if (priv->flags & ALPS_PASS)
1931 alps_passthrough_mode_v2(psmouse, false);
1933 if (poll_failed || (buf[0] & priv->mask0) != priv->byte0)
1934 return -1;
1936 if ((psmouse->badbyte & 0xc8) == 0x08) {
1938 * Poll the track stick ...
1940 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8)))
1941 return -1;
1944 memcpy(psmouse->packet, buf, sizeof(buf));
1945 return 0;
1948 static int alps_hw_init_v1_v2(struct psmouse *psmouse)
1950 struct alps_data *priv = psmouse->private;
1952 if ((priv->flags & ALPS_PASS) &&
1953 alps_passthrough_mode_v2(psmouse, true)) {
1954 return -1;
1957 if (alps_tap_mode(psmouse, true)) {
1958 psmouse_warn(psmouse, "Failed to enable hardware tapping\n");
1959 return -1;
1962 if (alps_absolute_mode_v1_v2(psmouse)) {
1963 psmouse_err(psmouse, "Failed to enable absolute mode\n");
1964 return -1;
1967 if ((priv->flags & ALPS_PASS) &&
1968 alps_passthrough_mode_v2(psmouse, false)) {
1969 return -1;
1972 /* ALPS needs stream mode, otherwise it won't report any data */
1973 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM)) {
1974 psmouse_err(psmouse, "Failed to enable stream mode\n");
1975 return -1;
1978 return 0;
1981 static int alps_hw_init_v6(struct psmouse *psmouse)
1983 unsigned char param[2] = {0xC8, 0x14};
1985 /* Enter passthrough mode to let trackpoint enter 6byte raw mode */
1986 if (alps_passthrough_mode_v2(psmouse, true))
1987 return -1;
1989 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1990 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1991 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1992 ps2_command(&psmouse->ps2dev, &param[0], PSMOUSE_CMD_SETRATE) ||
1993 ps2_command(&psmouse->ps2dev, &param[1], PSMOUSE_CMD_SETRATE))
1994 return -1;
1996 if (alps_passthrough_mode_v2(psmouse, false))
1997 return -1;
1999 if (alps_absolute_mode_v6(psmouse)) {
2000 psmouse_err(psmouse, "Failed to enable absolute mode\n");
2001 return -1;
2004 return 0;
2008 * Enable or disable passthrough mode to the trackstick.
2010 static int alps_passthrough_mode_v3(struct psmouse *psmouse,
2011 int reg_base, bool enable)
2013 int reg_val, ret = -1;
2015 if (alps_enter_command_mode(psmouse))
2016 return -1;
2018 reg_val = alps_command_mode_read_reg(psmouse, reg_base + 0x0008);
2019 if (reg_val == -1)
2020 goto error;
2022 if (enable)
2023 reg_val |= 0x01;
2024 else
2025 reg_val &= ~0x01;
2027 ret = __alps_command_mode_write_reg(psmouse, reg_val);
2029 error:
2030 if (alps_exit_command_mode(psmouse))
2031 ret = -1;
2032 return ret;
2035 /* Must be in command mode when calling this function */
2036 static int alps_absolute_mode_v3(struct psmouse *psmouse)
2038 int reg_val;
2040 reg_val = alps_command_mode_read_reg(psmouse, 0x0004);
2041 if (reg_val == -1)
2042 return -1;
2044 reg_val |= 0x06;
2045 if (__alps_command_mode_write_reg(psmouse, reg_val))
2046 return -1;
2048 return 0;
2051 static int alps_probe_trackstick_v3_v7(struct psmouse *psmouse, int reg_base)
2053 int ret = -EIO, reg_val;
2055 if (alps_enter_command_mode(psmouse))
2056 goto error;
2058 reg_val = alps_command_mode_read_reg(psmouse, reg_base + 0x08);
2059 if (reg_val == -1)
2060 goto error;
2062 /* bit 7: trackstick is present */
2063 ret = reg_val & 0x80 ? 0 : -ENODEV;
2065 error:
2066 alps_exit_command_mode(psmouse);
2067 return ret;
2070 static int alps_setup_trackstick_v3(struct psmouse *psmouse, int reg_base)
2072 struct ps2dev *ps2dev = &psmouse->ps2dev;
2073 int ret = 0;
2074 unsigned char param[4];
2076 if (alps_passthrough_mode_v3(psmouse, reg_base, true))
2077 return -EIO;
2080 * E7 report for the trackstick
2082 * There have been reports of failures to seem to trace back
2083 * to the above trackstick check failing. When these occur
2084 * this E7 report fails, so when that happens we continue
2085 * with the assumption that there isn't a trackstick after
2086 * all.
2088 if (alps_rpt_cmd(psmouse, 0, PSMOUSE_CMD_SETSCALE21, param)) {
2089 psmouse_warn(psmouse, "Failed to initialize trackstick (E7 report failed)\n");
2090 ret = -ENODEV;
2091 } else {
2092 psmouse_dbg(psmouse, "trackstick E7 report: %3ph\n", param);
2095 * Not sure what this does, but it is absolutely
2096 * essential. Without it, the touchpad does not
2097 * work at all and the trackstick just emits normal
2098 * PS/2 packets.
2100 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
2101 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
2102 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
2103 alps_command_mode_send_nibble(psmouse, 0x9) ||
2104 alps_command_mode_send_nibble(psmouse, 0x4)) {
2105 psmouse_err(psmouse,
2106 "Error sending magic E6 sequence\n");
2107 ret = -EIO;
2108 goto error;
2112 * This ensures the trackstick packets are in the format
2113 * supported by this driver. If bit 1 isn't set the packet
2114 * format is different.
2116 if (alps_enter_command_mode(psmouse) ||
2117 alps_command_mode_write_reg(psmouse,
2118 reg_base + 0x08, 0x82) ||
2119 alps_exit_command_mode(psmouse))
2120 ret = -EIO;
2123 error:
2124 if (alps_passthrough_mode_v3(psmouse, reg_base, false))
2125 ret = -EIO;
2127 return ret;
2130 static int alps_hw_init_v3(struct psmouse *psmouse)
2132 struct alps_data *priv = psmouse->private;
2133 struct ps2dev *ps2dev = &psmouse->ps2dev;
2134 int reg_val;
2135 unsigned char param[4];
2137 if ((priv->flags & ALPS_DUALPOINT) &&
2138 alps_setup_trackstick_v3(psmouse, ALPS_REG_BASE_PINNACLE) == -EIO)
2139 goto error;
2141 if (alps_enter_command_mode(psmouse) ||
2142 alps_absolute_mode_v3(psmouse)) {
2143 psmouse_err(psmouse, "Failed to enter absolute mode\n");
2144 goto error;
2147 reg_val = alps_command_mode_read_reg(psmouse, 0x0006);
2148 if (reg_val == -1)
2149 goto error;
2150 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x01))
2151 goto error;
2153 reg_val = alps_command_mode_read_reg(psmouse, 0x0007);
2154 if (reg_val == -1)
2155 goto error;
2156 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x01))
2157 goto error;
2159 if (alps_command_mode_read_reg(psmouse, 0x0144) == -1)
2160 goto error;
2161 if (__alps_command_mode_write_reg(psmouse, 0x04))
2162 goto error;
2164 if (alps_command_mode_read_reg(psmouse, 0x0159) == -1)
2165 goto error;
2166 if (__alps_command_mode_write_reg(psmouse, 0x03))
2167 goto error;
2169 if (alps_command_mode_read_reg(psmouse, 0x0163) == -1)
2170 goto error;
2171 if (alps_command_mode_write_reg(psmouse, 0x0163, 0x03))
2172 goto error;
2174 if (alps_command_mode_read_reg(psmouse, 0x0162) == -1)
2175 goto error;
2176 if (alps_command_mode_write_reg(psmouse, 0x0162, 0x04))
2177 goto error;
2179 alps_exit_command_mode(psmouse);
2181 /* Set rate and enable data reporting */
2182 param[0] = 0x64;
2183 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE) ||
2184 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
2185 psmouse_err(psmouse, "Failed to enable data reporting\n");
2186 return -1;
2189 return 0;
2191 error:
2193 * Leaving the touchpad in command mode will essentially render
2194 * it unusable until the machine reboots, so exit it here just
2195 * to be safe
2197 alps_exit_command_mode(psmouse);
2198 return -1;
2201 static int alps_get_v3_v7_resolution(struct psmouse *psmouse, int reg_pitch)
2203 int reg, x_pitch, y_pitch, x_electrode, y_electrode, x_phys, y_phys;
2204 struct alps_data *priv = psmouse->private;
2206 reg = alps_command_mode_read_reg(psmouse, reg_pitch);
2207 if (reg < 0)
2208 return reg;
2210 x_pitch = (char)(reg << 4) >> 4; /* sign extend lower 4 bits */
2211 x_pitch = 50 + 2 * x_pitch; /* In 0.1 mm units */
2213 y_pitch = (char)reg >> 4; /* sign extend upper 4 bits */
2214 y_pitch = 36 + 2 * y_pitch; /* In 0.1 mm units */
2216 reg = alps_command_mode_read_reg(psmouse, reg_pitch + 1);
2217 if (reg < 0)
2218 return reg;
2220 x_electrode = (char)(reg << 4) >> 4; /* sign extend lower 4 bits */
2221 x_electrode = 17 + x_electrode;
2223 y_electrode = (char)reg >> 4; /* sign extend upper 4 bits */
2224 y_electrode = 13 + y_electrode;
2226 x_phys = x_pitch * (x_electrode - 1); /* In 0.1 mm units */
2227 y_phys = y_pitch * (y_electrode - 1); /* In 0.1 mm units */
2229 priv->x_res = priv->x_max * 10 / x_phys; /* units / mm */
2230 priv->y_res = priv->y_max * 10 / y_phys; /* units / mm */
2232 psmouse_dbg(psmouse,
2233 "pitch %dx%d num-electrodes %dx%d physical size %dx%d mm res %dx%d\n",
2234 x_pitch, y_pitch, x_electrode, y_electrode,
2235 x_phys / 10, y_phys / 10, priv->x_res, priv->y_res);
2237 return 0;
2240 static int alps_hw_init_rushmore_v3(struct psmouse *psmouse)
2242 struct alps_data *priv = psmouse->private;
2243 struct ps2dev *ps2dev = &psmouse->ps2dev;
2244 int reg_val, ret = -1;
2246 if (priv->flags & ALPS_DUALPOINT) {
2247 reg_val = alps_setup_trackstick_v3(psmouse,
2248 ALPS_REG_BASE_RUSHMORE);
2249 if (reg_val == -EIO)
2250 goto error;
2253 if (alps_enter_command_mode(psmouse) ||
2254 alps_command_mode_read_reg(psmouse, 0xc2d9) == -1 ||
2255 alps_command_mode_write_reg(psmouse, 0xc2cb, 0x00))
2256 goto error;
2258 if (alps_get_v3_v7_resolution(psmouse, 0xc2da))
2259 goto error;
2261 reg_val = alps_command_mode_read_reg(psmouse, 0xc2c6);
2262 if (reg_val == -1)
2263 goto error;
2264 if (__alps_command_mode_write_reg(psmouse, reg_val & 0xfd))
2265 goto error;
2267 if (alps_command_mode_write_reg(psmouse, 0xc2c9, 0x64))
2268 goto error;
2270 /* enter absolute mode */
2271 reg_val = alps_command_mode_read_reg(psmouse, 0xc2c4);
2272 if (reg_val == -1)
2273 goto error;
2274 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x02))
2275 goto error;
2277 alps_exit_command_mode(psmouse);
2278 return ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE);
2280 error:
2281 alps_exit_command_mode(psmouse);
2282 return ret;
2285 /* Must be in command mode when calling this function */
2286 static int alps_absolute_mode_v4(struct psmouse *psmouse)
2288 int reg_val;
2290 reg_val = alps_command_mode_read_reg(psmouse, 0x0004);
2291 if (reg_val == -1)
2292 return -1;
2294 reg_val |= 0x02;
2295 if (__alps_command_mode_write_reg(psmouse, reg_val))
2296 return -1;
2298 return 0;
2301 static int alps_hw_init_v4(struct psmouse *psmouse)
2303 struct ps2dev *ps2dev = &psmouse->ps2dev;
2304 unsigned char param[4];
2306 if (alps_enter_command_mode(psmouse))
2307 goto error;
2309 if (alps_absolute_mode_v4(psmouse)) {
2310 psmouse_err(psmouse, "Failed to enter absolute mode\n");
2311 goto error;
2314 if (alps_command_mode_write_reg(psmouse, 0x0007, 0x8c))
2315 goto error;
2317 if (alps_command_mode_write_reg(psmouse, 0x0149, 0x03))
2318 goto error;
2320 if (alps_command_mode_write_reg(psmouse, 0x0160, 0x03))
2321 goto error;
2323 if (alps_command_mode_write_reg(psmouse, 0x017f, 0x15))
2324 goto error;
2326 if (alps_command_mode_write_reg(psmouse, 0x0151, 0x01))
2327 goto error;
2329 if (alps_command_mode_write_reg(psmouse, 0x0168, 0x03))
2330 goto error;
2332 if (alps_command_mode_write_reg(psmouse, 0x014a, 0x03))
2333 goto error;
2335 if (alps_command_mode_write_reg(psmouse, 0x0161, 0x03))
2336 goto error;
2338 alps_exit_command_mode(psmouse);
2341 * This sequence changes the output from a 9-byte to an
2342 * 8-byte format. All the same data seems to be present,
2343 * just in a more compact format.
2345 param[0] = 0xc8;
2346 param[1] = 0x64;
2347 param[2] = 0x50;
2348 if (ps2_command(ps2dev, &param[0], PSMOUSE_CMD_SETRATE) ||
2349 ps2_command(ps2dev, &param[1], PSMOUSE_CMD_SETRATE) ||
2350 ps2_command(ps2dev, &param[2], PSMOUSE_CMD_SETRATE) ||
2351 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
2352 return -1;
2354 /* Set rate and enable data reporting */
2355 param[0] = 0x64;
2356 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE) ||
2357 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
2358 psmouse_err(psmouse, "Failed to enable data reporting\n");
2359 return -1;
2362 return 0;
2364 error:
2366 * Leaving the touchpad in command mode will essentially render
2367 * it unusable until the machine reboots, so exit it here just
2368 * to be safe
2370 alps_exit_command_mode(psmouse);
2371 return -1;
2374 static int alps_get_otp_values_ss4_v2(struct psmouse *psmouse,
2375 unsigned char index, unsigned char otp[])
2377 struct ps2dev *ps2dev = &psmouse->ps2dev;
2379 switch (index) {
2380 case 0:
2381 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM) ||
2382 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM) ||
2383 ps2_command(ps2dev, otp, PSMOUSE_CMD_GETINFO))
2384 return -1;
2386 break;
2388 case 1:
2389 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETPOLL) ||
2390 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETPOLL) ||
2391 ps2_command(ps2dev, otp, PSMOUSE_CMD_GETINFO))
2392 return -1;
2394 break;
2397 return 0;
2400 static int alps_update_device_area_ss4_v2(unsigned char otp[][4],
2401 struct alps_data *priv)
2403 int num_x_electrode;
2404 int num_y_electrode;
2405 int x_pitch, y_pitch, x_phys, y_phys;
2407 num_x_electrode = SS4_NUMSENSOR_XOFFSET + (otp[1][0] & 0x0F);
2408 num_y_electrode = SS4_NUMSENSOR_YOFFSET + ((otp[1][0] >> 4) & 0x0F);
2410 priv->x_max = (num_x_electrode - 1) * SS4_COUNT_PER_ELECTRODE;
2411 priv->y_max = (num_y_electrode - 1) * SS4_COUNT_PER_ELECTRODE;
2413 x_pitch = ((otp[1][2] >> 2) & 0x07) + SS4_MIN_PITCH_MM;
2414 y_pitch = ((otp[1][2] >> 5) & 0x07) + SS4_MIN_PITCH_MM;
2416 x_phys = x_pitch * (num_x_electrode - 1); /* In 0.1 mm units */
2417 y_phys = y_pitch * (num_y_electrode - 1); /* In 0.1 mm units */
2419 priv->x_res = priv->x_max * 10 / x_phys; /* units / mm */
2420 priv->y_res = priv->y_max * 10 / y_phys; /* units / mm */
2422 return 0;
2425 static int alps_update_btn_info_ss4_v2(unsigned char otp[][4],
2426 struct alps_data *priv)
2428 unsigned char is_btnless;
2430 is_btnless = (otp[1][1] >> 3) & 0x01;
2432 if (is_btnless)
2433 priv->flags |= ALPS_BUTTONPAD;
2435 return 0;
2438 static int alps_set_defaults_ss4_v2(struct psmouse *psmouse,
2439 struct alps_data *priv)
2441 unsigned char otp[2][4];
2443 memset(otp, 0, sizeof(otp));
2445 if (alps_get_otp_values_ss4_v2(psmouse, 0, &otp[0][0]) ||
2446 alps_get_otp_values_ss4_v2(psmouse, 1, &otp[1][0]))
2447 return -1;
2449 alps_update_device_area_ss4_v2(otp, priv);
2451 alps_update_btn_info_ss4_v2(otp, priv);
2453 return 0;
2456 static int alps_dolphin_get_device_area(struct psmouse *psmouse,
2457 struct alps_data *priv)
2459 struct ps2dev *ps2dev = &psmouse->ps2dev;
2460 unsigned char param[4] = {0};
2461 int num_x_electrode, num_y_electrode;
2463 if (alps_enter_command_mode(psmouse))
2464 return -1;
2466 param[0] = 0x0a;
2467 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
2468 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETPOLL) ||
2469 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETPOLL) ||
2470 ps2_command(ps2dev, &param[0], PSMOUSE_CMD_SETRATE) ||
2471 ps2_command(ps2dev, &param[0], PSMOUSE_CMD_SETRATE))
2472 return -1;
2474 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
2475 return -1;
2478 * Dolphin's sensor line number is not fixed. It can be calculated
2479 * by adding the device's register value with DOLPHIN_PROFILE_X/YOFFSET.
2480 * Further more, we can get device's x_max and y_max by multiplying
2481 * sensor line number with DOLPHIN_COUNT_PER_ELECTRODE.
2483 * e.g. When we get register's sensor_x = 11 & sensor_y = 8,
2484 * real sensor line number X = 11 + 8 = 19, and
2485 * real sensor line number Y = 8 + 1 = 9.
2486 * So, x_max = (19 - 1) * 64 = 1152, and
2487 * y_max = (9 - 1) * 64 = 512.
2489 num_x_electrode = DOLPHIN_PROFILE_XOFFSET + (param[2] & 0x0F);
2490 num_y_electrode = DOLPHIN_PROFILE_YOFFSET + ((param[2] >> 4) & 0x0F);
2491 priv->x_bits = num_x_electrode;
2492 priv->y_bits = num_y_electrode;
2493 priv->x_max = (num_x_electrode - 1) * DOLPHIN_COUNT_PER_ELECTRODE;
2494 priv->y_max = (num_y_electrode - 1) * DOLPHIN_COUNT_PER_ELECTRODE;
2496 if (alps_exit_command_mode(psmouse))
2497 return -1;
2499 return 0;
2502 static int alps_hw_init_dolphin_v1(struct psmouse *psmouse)
2504 struct ps2dev *ps2dev = &psmouse->ps2dev;
2505 unsigned char param[2];
2507 /* This is dolphin "v1" as empirically defined by florin9doi */
2508 param[0] = 0x64;
2509 param[1] = 0x28;
2511 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM) ||
2512 ps2_command(ps2dev, &param[0], PSMOUSE_CMD_SETRATE) ||
2513 ps2_command(ps2dev, &param[1], PSMOUSE_CMD_SETRATE))
2514 return -1;
2516 return 0;
2519 static int alps_hw_init_v7(struct psmouse *psmouse)
2521 struct ps2dev *ps2dev = &psmouse->ps2dev;
2522 int reg_val, ret = -1;
2524 if (alps_enter_command_mode(psmouse) ||
2525 alps_command_mode_read_reg(psmouse, 0xc2d9) == -1)
2526 goto error;
2528 if (alps_get_v3_v7_resolution(psmouse, 0xc397))
2529 goto error;
2531 if (alps_command_mode_write_reg(psmouse, 0xc2c9, 0x64))
2532 goto error;
2534 reg_val = alps_command_mode_read_reg(psmouse, 0xc2c4);
2535 if (reg_val == -1)
2536 goto error;
2537 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x02))
2538 goto error;
2540 alps_exit_command_mode(psmouse);
2541 return ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE);
2543 error:
2544 alps_exit_command_mode(psmouse);
2545 return ret;
2548 static int alps_hw_init_ss4_v2(struct psmouse *psmouse)
2550 struct ps2dev *ps2dev = &psmouse->ps2dev;
2551 char param[2] = {0x64, 0x28};
2552 int ret = -1;
2554 /* enter absolute mode */
2555 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM) ||
2556 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM) ||
2557 ps2_command(ps2dev, &param[0], PSMOUSE_CMD_SETRATE) ||
2558 ps2_command(ps2dev, &param[1], PSMOUSE_CMD_SETRATE)) {
2559 goto error;
2562 /* T.B.D. Decread noise packet number, delete in the future */
2563 if (alps_exit_command_mode(psmouse) ||
2564 alps_enter_command_mode(psmouse) ||
2565 alps_command_mode_write_reg(psmouse, 0x001D, 0x20)) {
2566 goto error;
2568 alps_exit_command_mode(psmouse);
2570 return ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE);
2572 error:
2573 alps_exit_command_mode(psmouse);
2574 return ret;
2577 static int alps_set_protocol(struct psmouse *psmouse,
2578 struct alps_data *priv,
2579 const struct alps_protocol_info *protocol)
2581 psmouse->private = priv;
2583 setup_timer(&priv->timer, alps_flush_packet, (unsigned long)psmouse);
2585 priv->proto_version = protocol->version;
2586 priv->byte0 = protocol->byte0;
2587 priv->mask0 = protocol->mask0;
2588 priv->flags = protocol->flags;
2590 priv->x_max = 2000;
2591 priv->y_max = 1400;
2592 priv->x_bits = 15;
2593 priv->y_bits = 11;
2595 switch (priv->proto_version) {
2596 case ALPS_PROTO_V1:
2597 case ALPS_PROTO_V2:
2598 priv->hw_init = alps_hw_init_v1_v2;
2599 priv->process_packet = alps_process_packet_v1_v2;
2600 priv->set_abs_params = alps_set_abs_params_st;
2601 priv->x_max = 1023;
2602 priv->y_max = 767;
2603 if (dmi_check_system(alps_dmi_has_separate_stick_buttons))
2604 priv->flags |= ALPS_STICK_BITS;
2605 break;
2607 case ALPS_PROTO_V3:
2608 priv->hw_init = alps_hw_init_v3;
2609 priv->process_packet = alps_process_packet_v3;
2610 priv->set_abs_params = alps_set_abs_params_semi_mt;
2611 priv->decode_fields = alps_decode_pinnacle;
2612 priv->nibble_commands = alps_v3_nibble_commands;
2613 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2615 if (alps_probe_trackstick_v3_v7(psmouse,
2616 ALPS_REG_BASE_PINNACLE) < 0)
2617 priv->flags &= ~ALPS_DUALPOINT;
2619 break;
2621 case ALPS_PROTO_V3_RUSHMORE:
2622 priv->hw_init = alps_hw_init_rushmore_v3;
2623 priv->process_packet = alps_process_packet_v3;
2624 priv->set_abs_params = alps_set_abs_params_semi_mt;
2625 priv->decode_fields = alps_decode_rushmore;
2626 priv->nibble_commands = alps_v3_nibble_commands;
2627 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2628 priv->x_bits = 16;
2629 priv->y_bits = 12;
2631 if (alps_probe_trackstick_v3_v7(psmouse,
2632 ALPS_REG_BASE_RUSHMORE) < 0)
2633 priv->flags &= ~ALPS_DUALPOINT;
2635 break;
2637 case ALPS_PROTO_V4:
2638 priv->hw_init = alps_hw_init_v4;
2639 priv->process_packet = alps_process_packet_v4;
2640 priv->set_abs_params = alps_set_abs_params_semi_mt;
2641 priv->nibble_commands = alps_v4_nibble_commands;
2642 priv->addr_command = PSMOUSE_CMD_DISABLE;
2643 break;
2645 case ALPS_PROTO_V5:
2646 priv->hw_init = alps_hw_init_dolphin_v1;
2647 priv->process_packet = alps_process_touchpad_packet_v3_v5;
2648 priv->decode_fields = alps_decode_dolphin;
2649 priv->set_abs_params = alps_set_abs_params_semi_mt;
2650 priv->nibble_commands = alps_v3_nibble_commands;
2651 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2652 priv->x_bits = 23;
2653 priv->y_bits = 12;
2655 if (alps_dolphin_get_device_area(psmouse, priv))
2656 return -EIO;
2658 break;
2660 case ALPS_PROTO_V6:
2661 priv->hw_init = alps_hw_init_v6;
2662 priv->process_packet = alps_process_packet_v6;
2663 priv->set_abs_params = alps_set_abs_params_st;
2664 priv->nibble_commands = alps_v6_nibble_commands;
2665 priv->x_max = 2047;
2666 priv->y_max = 1535;
2667 break;
2669 case ALPS_PROTO_V7:
2670 priv->hw_init = alps_hw_init_v7;
2671 priv->process_packet = alps_process_packet_v7;
2672 priv->decode_fields = alps_decode_packet_v7;
2673 priv->set_abs_params = alps_set_abs_params_v7;
2674 priv->nibble_commands = alps_v3_nibble_commands;
2675 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2676 priv->x_max = 0xfff;
2677 priv->y_max = 0x7ff;
2679 if (priv->fw_ver[1] != 0xba)
2680 priv->flags |= ALPS_BUTTONPAD;
2682 if (alps_probe_trackstick_v3_v7(psmouse, ALPS_REG_BASE_V7) < 0)
2683 priv->flags &= ~ALPS_DUALPOINT;
2685 break;
2687 case ALPS_PROTO_V8:
2688 priv->hw_init = alps_hw_init_ss4_v2;
2689 priv->process_packet = alps_process_packet_ss4_v2;
2690 priv->decode_fields = alps_decode_ss4_v2;
2691 priv->set_abs_params = alps_set_abs_params_ss4_v2;
2692 priv->nibble_commands = alps_v3_nibble_commands;
2693 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2695 if (alps_set_defaults_ss4_v2(psmouse, priv))
2696 return -EIO;
2698 break;
2701 return 0;
2704 static const struct alps_protocol_info *alps_match_table(unsigned char *e7,
2705 unsigned char *ec)
2707 const struct alps_model_info *model;
2708 int i;
2710 for (i = 0; i < ARRAY_SIZE(alps_model_data); i++) {
2711 model = &alps_model_data[i];
2713 if (!memcmp(e7, model->signature, sizeof(model->signature)) &&
2714 (!model->command_mode_resp ||
2715 model->command_mode_resp == ec[2])) {
2717 return &model->protocol_info;
2721 return NULL;
2724 static int alps_identify(struct psmouse *psmouse, struct alps_data *priv)
2726 const struct alps_protocol_info *protocol;
2727 unsigned char e6[4], e7[4], ec[4];
2728 int error;
2731 * First try "E6 report".
2732 * ALPS should return 0,0,10 or 0,0,100 if no buttons are pressed.
2733 * The bits 0-2 of the first byte will be 1s if some buttons are
2734 * pressed.
2736 if (alps_rpt_cmd(psmouse, PSMOUSE_CMD_SETRES,
2737 PSMOUSE_CMD_SETSCALE11, e6))
2738 return -EIO;
2740 if ((e6[0] & 0xf8) != 0 || e6[1] != 0 || (e6[2] != 10 && e6[2] != 100))
2741 return -EINVAL;
2744 * Now get the "E7" and "EC" reports. These will uniquely identify
2745 * most ALPS touchpads.
2747 if (alps_rpt_cmd(psmouse, PSMOUSE_CMD_SETRES,
2748 PSMOUSE_CMD_SETSCALE21, e7) ||
2749 alps_rpt_cmd(psmouse, PSMOUSE_CMD_SETRES,
2750 PSMOUSE_CMD_RESET_WRAP, ec) ||
2751 alps_exit_command_mode(psmouse))
2752 return -EIO;
2754 protocol = alps_match_table(e7, ec);
2755 if (!protocol) {
2756 if (e7[0] == 0x73 && e7[1] == 0x03 && e7[2] == 0x50 &&
2757 ec[0] == 0x73 && (ec[1] == 0x01 || ec[1] == 0x02)) {
2758 protocol = &alps_v5_protocol_data;
2759 } else if (ec[0] == 0x88 &&
2760 ((ec[1] & 0xf0) == 0xb0 || (ec[1] & 0xf0) == 0xc0)) {
2761 protocol = &alps_v7_protocol_data;
2762 } else if (ec[0] == 0x88 && ec[1] == 0x08) {
2763 protocol = &alps_v3_rushmore_data;
2764 } else if (ec[0] == 0x88 && ec[1] == 0x07 &&
2765 ec[2] >= 0x90 && ec[2] <= 0x9d) {
2766 protocol = &alps_v3_protocol_data;
2767 } else if (e7[0] == 0x73 && e7[1] == 0x03 &&
2768 e7[2] == 0x14 && ec[1] == 0x02) {
2769 protocol = &alps_v8_protocol_data;
2770 } else {
2771 psmouse_dbg(psmouse,
2772 "Likely not an ALPS touchpad: E7=%3ph, EC=%3ph\n", e7, ec);
2773 return -EINVAL;
2777 if (priv) {
2778 /* Save the Firmware version */
2779 memcpy(priv->fw_ver, ec, 3);
2780 error = alps_set_protocol(psmouse, priv, protocol);
2781 if (error)
2782 return error;
2785 return 0;
2788 static int alps_reconnect(struct psmouse *psmouse)
2790 struct alps_data *priv = psmouse->private;
2792 psmouse_reset(psmouse);
2794 if (alps_identify(psmouse, priv) < 0)
2795 return -1;
2797 return priv->hw_init(psmouse);
2800 static void alps_disconnect(struct psmouse *psmouse)
2802 struct alps_data *priv = psmouse->private;
2804 psmouse_reset(psmouse);
2805 del_timer_sync(&priv->timer);
2806 if (priv->dev2)
2807 input_unregister_device(priv->dev2);
2808 if (!IS_ERR_OR_NULL(priv->dev3))
2809 input_unregister_device(priv->dev3);
2810 kfree(priv);
2813 static void alps_set_abs_params_st(struct alps_data *priv,
2814 struct input_dev *dev1)
2816 input_set_abs_params(dev1, ABS_X, 0, priv->x_max, 0, 0);
2817 input_set_abs_params(dev1, ABS_Y, 0, priv->y_max, 0, 0);
2818 input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
2821 static void alps_set_abs_params_mt_common(struct alps_data *priv,
2822 struct input_dev *dev1)
2824 input_set_abs_params(dev1, ABS_MT_POSITION_X, 0, priv->x_max, 0, 0);
2825 input_set_abs_params(dev1, ABS_MT_POSITION_Y, 0, priv->y_max, 0, 0);
2827 input_abs_set_res(dev1, ABS_MT_POSITION_X, priv->x_res);
2828 input_abs_set_res(dev1, ABS_MT_POSITION_Y, priv->y_res);
2830 set_bit(BTN_TOOL_TRIPLETAP, dev1->keybit);
2831 set_bit(BTN_TOOL_QUADTAP, dev1->keybit);
2834 static void alps_set_abs_params_semi_mt(struct alps_data *priv,
2835 struct input_dev *dev1)
2837 alps_set_abs_params_mt_common(priv, dev1);
2838 input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
2840 input_mt_init_slots(dev1, MAX_TOUCHES,
2841 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED |
2842 INPUT_MT_SEMI_MT);
2845 static void alps_set_abs_params_v7(struct alps_data *priv,
2846 struct input_dev *dev1)
2848 alps_set_abs_params_mt_common(priv, dev1);
2849 set_bit(BTN_TOOL_QUINTTAP, dev1->keybit);
2851 input_mt_init_slots(dev1, MAX_TOUCHES,
2852 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED |
2853 INPUT_MT_TRACK);
2855 set_bit(BTN_TOOL_QUINTTAP, dev1->keybit);
2858 static void alps_set_abs_params_ss4_v2(struct alps_data *priv,
2859 struct input_dev *dev1)
2861 alps_set_abs_params_mt_common(priv, dev1);
2862 input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
2863 set_bit(BTN_TOOL_QUINTTAP, dev1->keybit);
2865 input_mt_init_slots(dev1, MAX_TOUCHES,
2866 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED |
2867 INPUT_MT_TRACK);
2870 int alps_init(struct psmouse *psmouse)
2872 struct alps_data *priv = psmouse->private;
2873 struct input_dev *dev1 = psmouse->dev;
2874 int error;
2876 error = priv->hw_init(psmouse);
2877 if (error)
2878 goto init_fail;
2881 * Undo part of setup done for us by psmouse core since touchpad
2882 * is not a relative device.
2884 __clear_bit(EV_REL, dev1->evbit);
2885 __clear_bit(REL_X, dev1->relbit);
2886 __clear_bit(REL_Y, dev1->relbit);
2889 * Now set up our capabilities.
2891 dev1->evbit[BIT_WORD(EV_KEY)] |= BIT_MASK(EV_KEY);
2892 dev1->keybit[BIT_WORD(BTN_TOUCH)] |= BIT_MASK(BTN_TOUCH);
2893 dev1->keybit[BIT_WORD(BTN_TOOL_FINGER)] |= BIT_MASK(BTN_TOOL_FINGER);
2894 dev1->keybit[BIT_WORD(BTN_LEFT)] |=
2895 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
2897 dev1->evbit[BIT_WORD(EV_ABS)] |= BIT_MASK(EV_ABS);
2899 priv->set_abs_params(priv, dev1);
2901 if (priv->flags & ALPS_WHEEL) {
2902 dev1->evbit[BIT_WORD(EV_REL)] |= BIT_MASK(EV_REL);
2903 dev1->relbit[BIT_WORD(REL_WHEEL)] |= BIT_MASK(REL_WHEEL);
2906 if (priv->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
2907 dev1->keybit[BIT_WORD(BTN_FORWARD)] |= BIT_MASK(BTN_FORWARD);
2908 dev1->keybit[BIT_WORD(BTN_BACK)] |= BIT_MASK(BTN_BACK);
2911 if (priv->flags & ALPS_FOUR_BUTTONS) {
2912 dev1->keybit[BIT_WORD(BTN_0)] |= BIT_MASK(BTN_0);
2913 dev1->keybit[BIT_WORD(BTN_1)] |= BIT_MASK(BTN_1);
2914 dev1->keybit[BIT_WORD(BTN_2)] |= BIT_MASK(BTN_2);
2915 dev1->keybit[BIT_WORD(BTN_3)] |= BIT_MASK(BTN_3);
2916 } else if (priv->flags & ALPS_BUTTONPAD) {
2917 set_bit(INPUT_PROP_BUTTONPAD, dev1->propbit);
2918 clear_bit(BTN_RIGHT, dev1->keybit);
2919 } else {
2920 dev1->keybit[BIT_WORD(BTN_MIDDLE)] |= BIT_MASK(BTN_MIDDLE);
2923 if (priv->flags & ALPS_DUALPOINT) {
2924 struct input_dev *dev2;
2926 dev2 = input_allocate_device();
2927 if (!dev2) {
2928 psmouse_err(psmouse,
2929 "failed to allocate trackstick device\n");
2930 error = -ENOMEM;
2931 goto init_fail;
2934 snprintf(priv->phys2, sizeof(priv->phys2), "%s/input1",
2935 psmouse->ps2dev.serio->phys);
2936 dev2->phys = priv->phys2;
2939 * format of input device name is: "protocol vendor name"
2940 * see function psmouse_switch_protocol() in psmouse-base.c
2942 dev2->name = "AlpsPS/2 ALPS DualPoint Stick";
2944 dev2->id.bustype = BUS_I8042;
2945 dev2->id.vendor = 0x0002;
2946 dev2->id.product = PSMOUSE_ALPS;
2947 dev2->id.version = priv->proto_version;
2948 dev2->dev.parent = &psmouse->ps2dev.serio->dev;
2950 input_set_capability(dev2, EV_REL, REL_X);
2951 input_set_capability(dev2, EV_REL, REL_Y);
2952 input_set_capability(dev2, EV_KEY, BTN_LEFT);
2953 input_set_capability(dev2, EV_KEY, BTN_RIGHT);
2954 input_set_capability(dev2, EV_KEY, BTN_MIDDLE);
2956 __set_bit(INPUT_PROP_POINTER, dev2->propbit);
2957 __set_bit(INPUT_PROP_POINTING_STICK, dev2->propbit);
2959 error = input_register_device(dev2);
2960 if (error) {
2961 psmouse_err(psmouse,
2962 "failed to register trackstick device: %d\n",
2963 error);
2964 input_free_device(dev2);
2965 goto init_fail;
2968 priv->dev2 = dev2;
2971 priv->psmouse = psmouse;
2973 INIT_DELAYED_WORK(&priv->dev3_register_work,
2974 alps_register_bare_ps2_mouse);
2976 psmouse->protocol_handler = alps_process_byte;
2977 psmouse->poll = alps_poll;
2978 psmouse->disconnect = alps_disconnect;
2979 psmouse->reconnect = alps_reconnect;
2980 psmouse->pktsize = priv->proto_version == ALPS_PROTO_V4 ? 8 : 6;
2982 /* We are having trouble resyncing ALPS touchpads so disable it for now */
2983 psmouse->resync_time = 0;
2985 /* Allow 2 invalid packets without resetting device */
2986 psmouse->resetafter = psmouse->pktsize * 2;
2988 return 0;
2990 init_fail:
2991 psmouse_reset(psmouse);
2993 * Even though we did not allocate psmouse->private we do free
2994 * it here.
2996 kfree(psmouse->private);
2997 psmouse->private = NULL;
2998 return error;
3001 int alps_detect(struct psmouse *psmouse, bool set_properties)
3003 struct alps_data *priv;
3004 int error;
3006 error = alps_identify(psmouse, NULL);
3007 if (error)
3008 return error;
3011 * Reset the device to make sure it is fully operational:
3012 * on some laptops, like certain Dell Latitudes, we may
3013 * fail to properly detect presence of trackstick if device
3014 * has not been reset.
3016 psmouse_reset(psmouse);
3018 priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL);
3019 if (!priv)
3020 return -ENOMEM;
3022 error = alps_identify(psmouse, priv);
3023 if (error) {
3024 kfree(priv);
3025 return error;
3028 if (set_properties) {
3029 psmouse->vendor = "ALPS";
3030 psmouse->name = priv->flags & ALPS_DUALPOINT ?
3031 "DualPoint TouchPad" : "GlidePoint";
3032 psmouse->model = priv->proto_version;
3033 } else {
3035 * Destroy alps_data structure we allocated earlier since
3036 * this was just a "trial run". Otherwise we'll keep it
3037 * to be used by alps_init() which has to be called if
3038 * we succeed and set_properties is true.
3040 kfree(priv);
3041 psmouse->private = NULL;
3044 return 0;