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>
28 * Definitions for ALPS version 3 and 4 command mode protocol
30 #define ALPS_CMD_NIBBLE_10 0x01f2
32 #define ALPS_REG_BASE_RUSHMORE 0xc2c0
33 #define ALPS_REG_BASE_PINNACLE 0x0000
35 static const struct alps_nibble_commands alps_v3_nibble_commands[] = {
36 { PSMOUSE_CMD_SETPOLL, 0x00 }, /* 0 */
37 { PSMOUSE_CMD_RESET_DIS, 0x00 }, /* 1 */
38 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* 2 */
39 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 3 */
40 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 4 */
41 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 5 */
42 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 6 */
43 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 7 */
44 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 8 */
45 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 9 */
46 { ALPS_CMD_NIBBLE_10, 0x00 }, /* a */
47 { PSMOUSE_CMD_SETRES, 0x00 }, /* b */
48 { PSMOUSE_CMD_SETRES, 0x01 }, /* c */
49 { PSMOUSE_CMD_SETRES, 0x02 }, /* d */
50 { PSMOUSE_CMD_SETRES, 0x03 }, /* e */
51 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
54 static const struct alps_nibble_commands alps_v4_nibble_commands[] = {
55 { PSMOUSE_CMD_ENABLE, 0x00 }, /* 0 */
56 { PSMOUSE_CMD_RESET_DIS, 0x00 }, /* 1 */
57 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* 2 */
58 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 3 */
59 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 4 */
60 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 5 */
61 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 6 */
62 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 7 */
63 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 8 */
64 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 9 */
65 { ALPS_CMD_NIBBLE_10, 0x00 }, /* a */
66 { PSMOUSE_CMD_SETRES, 0x00 }, /* b */
67 { PSMOUSE_CMD_SETRES, 0x01 }, /* c */
68 { PSMOUSE_CMD_SETRES, 0x02 }, /* d */
69 { PSMOUSE_CMD_SETRES, 0x03 }, /* e */
70 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
73 static const struct alps_nibble_commands alps_v6_nibble_commands[] = {
74 { PSMOUSE_CMD_ENABLE, 0x00 }, /* 0 */
75 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 1 */
76 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 2 */
77 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 3 */
78 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 4 */
79 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 5 */
80 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 6 */
81 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 7 */
82 { PSMOUSE_CMD_GETID, 0x00 }, /* 8 */
83 { PSMOUSE_CMD_GETINFO, 0x00 }, /* 9 */
84 { PSMOUSE_CMD_SETRES, 0x00 }, /* a */
85 { PSMOUSE_CMD_SETRES, 0x01 }, /* b */
86 { PSMOUSE_CMD_SETRES, 0x02 }, /* c */
87 { PSMOUSE_CMD_SETRES, 0x03 }, /* d */
88 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* e */
89 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
93 #define ALPS_DUALPOINT 0x02 /* touchpad has trackstick */
94 #define ALPS_PASS 0x04 /* device has a pass-through port */
96 #define ALPS_WHEEL 0x08 /* hardware wheel present */
97 #define ALPS_FW_BK_1 0x10 /* front & back buttons present */
98 #define ALPS_FW_BK_2 0x20 /* front & back buttons present */
99 #define ALPS_FOUR_BUTTONS 0x40 /* 4 direction button present */
100 #define ALPS_PS2_INTERLEAVED 0x80 /* 3-byte PS/2 packet interleaved with
101 6-byte ALPS packet */
102 #define ALPS_BUTTONPAD 0x200 /* device is a clickpad */
104 static const struct alps_model_info alps_model_data[] = {
105 { { 0x32, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } }, /* Toshiba Salellite Pro M10 */
106 { { 0x33, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V1, 0x88, 0xf8, 0 } }, /* UMAX-530T */
107 { { 0x53, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
108 { { 0x53, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
109 { { 0x60, 0x03, 0xc8 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } }, /* HP ze1115 */
110 { { 0x63, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
111 { { 0x63, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
112 { { 0x63, 0x02, 0x28 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_FW_BK_2 } }, /* Fujitsu Siemens S6010 */
113 { { 0x63, 0x02, 0x3c }, 0x00, { ALPS_PROTO_V2, 0x8f, 0x8f, ALPS_WHEEL } }, /* Toshiba Satellite S2400-103 */
114 { { 0x63, 0x02, 0x50 }, 0x00, { ALPS_PROTO_V2, 0xef, 0xef, ALPS_FW_BK_1 } }, /* NEC Versa L320 */
115 { { 0x63, 0x02, 0x64 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
116 { { 0x63, 0x03, 0xc8 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } }, /* Dell Latitude D800 */
117 { { 0x73, 0x00, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_DUALPOINT } }, /* ThinkPad R61 8918-5QG */
118 { { 0x73, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, 0 } },
119 { { 0x73, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_FW_BK_2 } }, /* Ahtec Laptop */
122 * XXX This entry is suspicious. First byte has zero lower nibble,
123 * which is what a normal mouse would report. Also, the value 0x0e
124 * isn't valid per PS/2 spec.
126 { { 0x20, 0x02, 0x0e }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } },
128 { { 0x22, 0x02, 0x0a }, 0x00, { ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT } },
129 { { 0x22, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xff, 0xff, ALPS_PASS | ALPS_DUALPOINT } }, /* Dell Latitude D600 */
130 /* Dell Latitude E5500, E6400, E6500, Precision M4400 */
131 { { 0x62, 0x02, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xcf, 0xcf,
132 ALPS_PASS | ALPS_DUALPOINT | ALPS_PS2_INTERLEAVED } },
133 { { 0x73, 0x00, 0x14 }, 0x00, { ALPS_PROTO_V6, 0xff, 0xff, ALPS_DUALPOINT } }, /* Dell XT2 */
134 { { 0x73, 0x02, 0x50 }, 0x00, { ALPS_PROTO_V2, 0xcf, 0xcf, ALPS_FOUR_BUTTONS } }, /* Dell Vostro 1400 */
135 { { 0x52, 0x01, 0x14 }, 0x00, { ALPS_PROTO_V2, 0xff, 0xff,
136 ALPS_PASS | ALPS_DUALPOINT | ALPS_PS2_INTERLEAVED } }, /* Toshiba Tecra A11-11L */
137 { { 0x73, 0x02, 0x64 }, 0x8a, { ALPS_PROTO_V4, 0x8f, 0x8f, 0 } },
140 static const struct alps_protocol_info alps_v3_protocol_data = {
141 ALPS_PROTO_V3, 0x8f, 0x8f, ALPS_DUALPOINT
144 static const struct alps_protocol_info alps_v3_rushmore_data = {
145 ALPS_PROTO_V3_RUSHMORE, 0x8f, 0x8f, ALPS_DUALPOINT
148 static const struct alps_protocol_info alps_v5_protocol_data = {
149 ALPS_PROTO_V5, 0xc8, 0xd8, 0
152 static const struct alps_protocol_info alps_v7_protocol_data = {
153 ALPS_PROTO_V7, 0x48, 0x48, ALPS_DUALPOINT
156 static void alps_set_abs_params_st(struct alps_data *priv,
157 struct input_dev *dev1);
158 static void alps_set_abs_params_mt(struct alps_data *priv,
159 struct input_dev *dev1);
161 /* Packet formats are described in Documentation/input/alps.txt */
163 static bool alps_is_valid_first_byte(struct alps_data *priv,
166 return (data & priv->mask0) == priv->byte0;
169 static void alps_report_buttons(struct input_dev *dev1, struct input_dev *dev2,
170 int left, int right, int middle)
172 struct input_dev *dev;
175 * If shared button has already been reported on the
176 * other device (dev2) then this event should be also
177 * sent through that device.
179 dev = (dev2 && test_bit(BTN_LEFT, dev2->key)) ? dev2 : dev1;
180 input_report_key(dev, BTN_LEFT, left);
182 dev = (dev2 && test_bit(BTN_RIGHT, dev2->key)) ? dev2 : dev1;
183 input_report_key(dev, BTN_RIGHT, right);
185 dev = (dev2 && test_bit(BTN_MIDDLE, dev2->key)) ? dev2 : dev1;
186 input_report_key(dev, BTN_MIDDLE, middle);
189 * Sync the _other_ device now, we'll do the first
190 * device later once we report the rest of the events.
196 static void alps_process_packet_v1_v2(struct psmouse *psmouse)
198 struct alps_data *priv = psmouse->private;
199 unsigned char *packet = psmouse->packet;
200 struct input_dev *dev = psmouse->dev;
201 struct input_dev *dev2 = priv->dev2;
202 int x, y, z, ges, fin, left, right, middle;
203 int back = 0, forward = 0;
205 if (priv->proto_version == ALPS_PROTO_V1) {
206 left = packet[2] & 0x10;
207 right = packet[2] & 0x08;
209 x = packet[1] | ((packet[0] & 0x07) << 7);
210 y = packet[4] | ((packet[3] & 0x07) << 7);
213 left = packet[3] & 1;
214 right = packet[3] & 2;
215 middle = packet[3] & 4;
216 x = packet[1] | ((packet[2] & 0x78) << (7 - 3));
217 y = packet[4] | ((packet[3] & 0x70) << (7 - 4));
221 if (priv->flags & ALPS_FW_BK_1) {
222 back = packet[0] & 0x10;
223 forward = packet[2] & 4;
226 if (priv->flags & ALPS_FW_BK_2) {
227 back = packet[3] & 4;
228 forward = packet[2] & 4;
229 if ((middle = forward && back))
236 if ((priv->flags & ALPS_DUALPOINT) && z == 127) {
237 input_report_rel(dev2, REL_X, (x > 383 ? (x - 768) : x));
238 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y));
240 alps_report_buttons(dev2, dev, left, right, middle);
246 /* Non interleaved V2 dualpoint has separate stick button bits */
247 if (priv->proto_version == ALPS_PROTO_V2 &&
248 priv->flags == (ALPS_PASS | ALPS_DUALPOINT)) {
249 left |= packet[0] & 1;
250 right |= packet[0] & 2;
251 middle |= packet[0] & 4;
254 alps_report_buttons(dev, dev2, left, right, middle);
256 /* Convert hardware tap to a reasonable Z value */
261 * A "tap and drag" operation is reported by the hardware as a transition
262 * from (!fin && ges) to (fin && ges). This should be translated to the
263 * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
265 if (ges && fin && !priv->prev_fin) {
266 input_report_abs(dev, ABS_X, x);
267 input_report_abs(dev, ABS_Y, y);
268 input_report_abs(dev, ABS_PRESSURE, 0);
269 input_report_key(dev, BTN_TOOL_FINGER, 0);
272 priv->prev_fin = fin;
275 input_report_key(dev, BTN_TOUCH, 1);
277 input_report_key(dev, BTN_TOUCH, 0);
280 input_report_abs(dev, ABS_X, x);
281 input_report_abs(dev, ABS_Y, y);
284 input_report_abs(dev, ABS_PRESSURE, z);
285 input_report_key(dev, BTN_TOOL_FINGER, z > 0);
287 if (priv->flags & ALPS_WHEEL)
288 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07));
290 if (priv->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
291 input_report_key(dev, BTN_FORWARD, forward);
292 input_report_key(dev, BTN_BACK, back);
295 if (priv->flags & ALPS_FOUR_BUTTONS) {
296 input_report_key(dev, BTN_0, packet[2] & 4);
297 input_report_key(dev, BTN_1, packet[0] & 0x10);
298 input_report_key(dev, BTN_2, packet[3] & 4);
299 input_report_key(dev, BTN_3, packet[0] & 0x20);
306 * Process bitmap data for V5 protocols. Return value is null.
308 * The bitmaps don't have enough data to track fingers, so this function
309 * only generates points representing a bounding box of at most two contacts.
310 * These two points are returned in fields->mt.
312 static void alps_process_bitmap_dolphin(struct alps_data *priv,
313 struct alps_fields *fields)
315 int box_middle_x, box_middle_y;
316 unsigned int x_map, y_map;
317 unsigned char start_bit, end_bit;
318 unsigned char x_msb, x_lsb, y_msb, y_lsb;
320 x_map = fields->x_map;
321 y_map = fields->y_map;
323 if (!x_map || !y_map)
326 /* Get Most-significant and Least-significant bit */
332 /* Most-significant bit should never exceed max sensor line number */
333 if (x_msb > priv->x_bits || y_msb > priv->y_bits)
336 if (fields->fingers > 1) {
337 start_bit = priv->x_bits - x_msb;
338 end_bit = priv->x_bits - x_lsb;
339 box_middle_x = (priv->x_max * (start_bit + end_bit)) /
340 (2 * (priv->x_bits - 1));
342 start_bit = y_lsb - 1;
344 box_middle_y = (priv->y_max * (start_bit + end_bit)) /
345 (2 * (priv->y_bits - 1));
346 fields->mt[0] = fields->st;
347 fields->mt[1].x = 2 * box_middle_x - fields->mt[0].x;
348 fields->mt[1].y = 2 * box_middle_y - fields->mt[0].y;
352 static void alps_get_bitmap_points(unsigned int map,
353 struct alps_bitmap_point *low,
354 struct alps_bitmap_point *high,
357 struct alps_bitmap_point *point;
358 int i, bit, prev_bit = 0;
361 for (i = 0; map != 0; i++, map >>= 1) {
365 point->start_bit = i;
379 * Process bitmap data from v3 and v4 protocols. Returns the number of
380 * fingers detected. A return value of 0 means at least one of the
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
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;
392 struct alps_bitmap_point x_low = {0,}, x_high = {0,};
393 struct alps_bitmap_point y_low = {0,}, y_high = {0,};
395 if (!fields->x_map || !fields->y_map)
398 alps_get_bitmap_points(fields->x_map, &x_low, &x_high, &fingers_x);
399 alps_get_bitmap_points(fields->y_map, &y_low, &y_high, &fingers_y);
402 * Fingers can overlap, so we use the maximum count of fingers
403 * on either axis as the finger count.
405 fingers = max(fingers_x, fingers_y);
408 * If an axis reports only a single contact, we have overlapping or
409 * adjacent fingers. Divide the single contact between the two points.
411 if (fingers_x == 1) {
412 i = (x_low.num_bits - 1) / 2;
413 x_low.num_bits = x_low.num_bits - i;
414 x_high.start_bit = x_low.start_bit + i;
415 x_high.num_bits = max(i, 1);
417 if (fingers_y == 1) {
418 i = (y_low.num_bits - 1) / 2;
419 y_low.num_bits = y_low.num_bits - i;
420 y_high.start_bit = y_low.start_bit + i;
421 y_high.num_bits = max(i, 1);
425 (priv->x_max * (2 * x_low.start_bit + x_low.num_bits - 1)) /
426 (2 * (priv->x_bits - 1));
428 (priv->y_max * (2 * y_low.start_bit + y_low.num_bits - 1)) /
429 (2 * (priv->y_bits - 1));
432 (priv->x_max * (2 * x_high.start_bit + x_high.num_bits - 1)) /
433 (2 * (priv->x_bits - 1));
435 (priv->y_max * (2 * y_high.start_bit + y_high.num_bits - 1)) /
436 (2 * (priv->y_bits - 1));
438 /* y-bitmap order is reversed, except on rushmore */
439 if (priv->proto_version != ALPS_PROTO_V3_RUSHMORE) {
440 fields->mt[0].y = priv->y_max - fields->mt[0].y;
441 fields->mt[1].y = priv->y_max - fields->mt[1].y;
447 static void alps_set_slot(struct input_dev *dev, int slot, int x, int y)
449 input_mt_slot(dev, slot);
450 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
451 input_report_abs(dev, ABS_MT_POSITION_X, x);
452 input_report_abs(dev, ABS_MT_POSITION_Y, y);
455 static void alps_report_mt_data(struct psmouse *psmouse, int n)
457 struct alps_data *priv = psmouse->private;
458 struct input_dev *dev = psmouse->dev;
459 struct alps_fields *f = &priv->f;
460 int i, slot[MAX_TOUCHES];
462 input_mt_assign_slots(dev, slot, f->mt, n, 0);
463 for (i = 0; i < n; i++)
464 alps_set_slot(dev, slot[i], f->mt[i].x, f->mt[i].y);
466 input_mt_sync_frame(dev);
469 static void alps_report_semi_mt_data(struct psmouse *psmouse, int fingers)
471 struct alps_data *priv = psmouse->private;
472 struct input_dev *dev = psmouse->dev;
473 struct alps_fields *f = &priv->f;
475 /* Use st data when we don't have mt data */
477 f->mt[0].x = f->st.x;
478 f->mt[0].y = f->st.y;
479 fingers = f->pressure > 0 ? 1 : 0;
482 alps_report_mt_data(psmouse, (fingers <= 2) ? fingers : 2);
484 input_mt_report_finger_count(dev, fingers);
486 input_report_key(dev, BTN_LEFT, f->left);
487 input_report_key(dev, BTN_RIGHT, f->right);
488 input_report_key(dev, BTN_MIDDLE, f->middle);
490 input_report_abs(dev, ABS_PRESSURE, f->pressure);
495 static void alps_process_trackstick_packet_v3(struct psmouse *psmouse)
497 struct alps_data *priv = psmouse->private;
498 unsigned char *packet = psmouse->packet;
499 struct input_dev *dev = priv->dev2;
500 int x, y, z, left, right, middle;
502 /* It should be a DualPoint when received trackstick packet */
503 if (!(priv->flags & ALPS_DUALPOINT)) {
504 psmouse_warn(psmouse,
505 "Rejected trackstick packet from non DualPoint device");
509 /* Sanity check packet */
510 if (!(packet[0] & 0x40)) {
511 psmouse_dbg(psmouse, "Bad trackstick packet, discarding\n");
516 * There's a special packet that seems to indicate the end
517 * of a stream of trackstick data. Filter these out.
519 if (packet[1] == 0x7f && packet[2] == 0x7f && packet[4] == 0x7f)
522 x = (s8)(((packet[0] & 0x20) << 2) | (packet[1] & 0x7f));
523 y = (s8)(((packet[0] & 0x10) << 3) | (packet[2] & 0x7f));
524 z = (packet[4] & 0x7c) >> 2;
527 * The x and y values tend to be quite large, and when used
528 * alone the trackstick is difficult to use. Scale them down
534 input_report_rel(dev, REL_X, x);
535 input_report_rel(dev, REL_Y, -y);
538 * Most ALPS models report the trackstick buttons in the touchpad
539 * packets, but a few report them here. No reliable way has been
540 * found to differentiate between the models upfront, so we enable
541 * the quirk in response to seeing a button press in the trackstick
544 left = packet[3] & 0x01;
545 right = packet[3] & 0x02;
546 middle = packet[3] & 0x04;
548 if (!(priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS) &&
549 (left || right || middle))
550 priv->quirks |= ALPS_QUIRK_TRACKSTICK_BUTTONS;
552 if (priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS) {
553 input_report_key(dev, BTN_LEFT, left);
554 input_report_key(dev, BTN_RIGHT, right);
555 input_report_key(dev, BTN_MIDDLE, middle);
562 static void alps_decode_buttons_v3(struct alps_fields *f, unsigned char *p)
564 f->left = !!(p[3] & 0x01);
565 f->right = !!(p[3] & 0x02);
566 f->middle = !!(p[3] & 0x04);
568 f->ts_left = !!(p[3] & 0x10);
569 f->ts_right = !!(p[3] & 0x20);
570 f->ts_middle = !!(p[3] & 0x40);
573 static int alps_decode_pinnacle(struct alps_fields *f, unsigned char *p,
574 struct psmouse *psmouse)
576 f->first_mp = !!(p[4] & 0x40);
577 f->is_mp = !!(p[0] & 0x40);
579 f->fingers = (p[5] & 0x3) + 1;
580 f->x_map = ((p[4] & 0x7e) << 8) |
581 ((p[1] & 0x7f) << 2) |
582 ((p[0] & 0x30) >> 4);
583 f->y_map = ((p[3] & 0x70) << 4) |
584 ((p[2] & 0x7f) << 1) |
587 f->st.x = ((p[1] & 0x7f) << 4) | ((p[4] & 0x30) >> 2) |
588 ((p[0] & 0x30) >> 4);
589 f->st.y = ((p[2] & 0x7f) << 4) | (p[4] & 0x0f);
590 f->pressure = p[5] & 0x7f;
592 alps_decode_buttons_v3(f, p);
597 static int alps_decode_rushmore(struct alps_fields *f, unsigned char *p,
598 struct psmouse *psmouse)
600 alps_decode_pinnacle(f, p, psmouse);
602 /* Rushmore's packet decode has a bit difference with Pinnacle's */
603 f->is_mp = !!(p[5] & 0x40);
604 f->fingers = max((p[5] & 0x3), ((p[5] >> 2) & 0x3)) + 1;
605 f->x_map |= (p[5] & 0x10) << 11;
606 f->y_map |= (p[5] & 0x20) << 6;
611 static int alps_decode_dolphin(struct alps_fields *f, unsigned char *p,
612 struct psmouse *psmouse)
615 struct alps_data *priv = psmouse->private;
617 f->first_mp = !!(p[0] & 0x02);
618 f->is_mp = !!(p[0] & 0x20);
621 f->st.x = ((p[1] & 0x7f) | ((p[4] & 0x0f) << 7));
622 f->st.y = ((p[2] & 0x7f) | ((p[4] & 0xf0) << 3));
623 f->pressure = (p[0] & 4) ? 0 : p[5] & 0x7f;
624 alps_decode_buttons_v3(f, p);
626 f->fingers = ((p[0] & 0x6) >> 1 |
629 palm_data = (p[1] & 0x7f) |
630 ((p[2] & 0x7f) << 7) |
631 ((p[4] & 0x7f) << 14) |
632 ((p[5] & 0x7f) << 21) |
633 ((p[3] & 0x07) << 28) |
634 (((u64)p[3] & 0x70) << 27) |
635 (((u64)p[0] & 0x01) << 34);
637 /* Y-profile is stored in P(0) to p(n-1), n = y_bits; */
638 f->y_map = palm_data & (BIT(priv->y_bits) - 1);
640 /* X-profile is stored in p(n) to p(n+m-1), m = x_bits; */
641 f->x_map = (palm_data >> priv->y_bits) &
642 (BIT(priv->x_bits) - 1);
648 static void alps_process_touchpad_packet_v3_v5(struct psmouse *psmouse)
650 struct alps_data *priv = psmouse->private;
651 unsigned char *packet = psmouse->packet;
652 struct input_dev *dev2 = priv->dev2;
653 struct alps_fields *f = &priv->f;
656 memset(f, 0, sizeof(*f));
658 priv->decode_fields(f, packet, psmouse);
661 * There's no single feature of touchpad position and bitmap packets
662 * that can be used to distinguish between them. We rely on the fact
663 * that a bitmap packet should always follow a position packet with
664 * bit 6 of packet[4] set.
666 if (priv->multi_packet) {
668 * Sometimes a position packet will indicate a multi-packet
669 * sequence, but then what follows is another position
670 * packet. Check for this, and when it happens process the
671 * position packet as usual.
674 fingers = f->fingers;
675 if (priv->proto_version == ALPS_PROTO_V3 ||
676 priv->proto_version == ALPS_PROTO_V3_RUSHMORE) {
677 if (alps_process_bitmap(priv, f) == 0)
678 fingers = 0; /* Use st data */
680 /* Now process position packet */
681 priv->decode_fields(f, priv->multi_data,
685 * Because Dolphin uses position packet's
686 * coordinate data as Pt1 and uses it to
687 * calculate Pt2, so we need to do position
688 * packet decode first.
690 priv->decode_fields(f, priv->multi_data,
694 * Since Dolphin's finger number is reliable,
695 * there is no need to compare with bmap_fn.
697 alps_process_bitmap_dolphin(priv, f);
700 priv->multi_packet = 0;
705 * Bit 6 of byte 0 is not usually set in position packets. The only
706 * times it seems to be set is in situations where the data is
707 * suspect anyway, e.g. a palm resting flat on the touchpad. Given
708 * this combined with the fact that this bit is useful for filtering
709 * out misidentified bitmap packets, we reject anything with this
715 if (!priv->multi_packet && f->first_mp) {
716 priv->multi_packet = 1;
717 memcpy(priv->multi_data, packet, sizeof(priv->multi_data));
721 priv->multi_packet = 0;
724 * Sometimes the hardware sends a single packet with z = 0
725 * in the middle of a stream. Real releases generate packets
726 * with x, y, and z all zero, so these seem to be flukes.
729 if (f->st.x && f->st.y && !f->pressure)
732 alps_report_semi_mt_data(psmouse, fingers);
734 if ((priv->flags & ALPS_DUALPOINT) &&
735 !(priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS)) {
736 input_report_key(dev2, BTN_LEFT, f->ts_left);
737 input_report_key(dev2, BTN_RIGHT, f->ts_right);
738 input_report_key(dev2, BTN_MIDDLE, f->ts_middle);
743 static void alps_process_packet_v3(struct psmouse *psmouse)
745 unsigned char *packet = psmouse->packet;
748 * v3 protocol packets come in three types, two representing
749 * touchpad data and one representing trackstick data.
750 * Trackstick packets seem to be distinguished by always
751 * having 0x3f in the last byte. This value has never been
752 * observed in the last byte of either of the other types
755 if (packet[5] == 0x3f) {
756 alps_process_trackstick_packet_v3(psmouse);
760 alps_process_touchpad_packet_v3_v5(psmouse);
763 static void alps_process_packet_v6(struct psmouse *psmouse)
765 struct alps_data *priv = psmouse->private;
766 unsigned char *packet = psmouse->packet;
767 struct input_dev *dev = psmouse->dev;
768 struct input_dev *dev2 = priv->dev2;
769 int x, y, z, left, right, middle;
772 * We can use Byte5 to distinguish if the packet is from Touchpad
777 if (packet[5] == 0x7F) {
778 /* It should be a DualPoint when received Trackpoint packet */
779 if (!(priv->flags & ALPS_DUALPOINT)) {
780 psmouse_warn(psmouse,
781 "Rejected trackstick packet from non DualPoint device");
785 /* Trackpoint packet */
786 x = packet[1] | ((packet[3] & 0x20) << 2);
787 y = packet[2] | ((packet[3] & 0x40) << 1);
789 left = packet[3] & 0x01;
790 right = packet[3] & 0x02;
791 middle = packet[3] & 0x04;
793 /* To prevent the cursor jump when finger lifted */
794 if (x == 0x7F && y == 0x7F && z == 0x7F)
797 /* Divide 4 since trackpoint's speed is too fast */
798 input_report_rel(dev2, REL_X, (char)x / 4);
799 input_report_rel(dev2, REL_Y, -((char)y / 4));
801 input_report_key(dev2, BTN_LEFT, left);
802 input_report_key(dev2, BTN_RIGHT, right);
803 input_report_key(dev2, BTN_MIDDLE, middle);
809 /* Touchpad packet */
810 x = packet[1] | ((packet[3] & 0x78) << 4);
811 y = packet[2] | ((packet[4] & 0x78) << 4);
813 left = packet[3] & 0x01;
814 right = packet[3] & 0x02;
817 input_report_key(dev, BTN_TOUCH, 1);
819 input_report_key(dev, BTN_TOUCH, 0);
822 input_report_abs(dev, ABS_X, x);
823 input_report_abs(dev, ABS_Y, y);
826 input_report_abs(dev, ABS_PRESSURE, z);
827 input_report_key(dev, BTN_TOOL_FINGER, z > 0);
829 /* v6 touchpad does not have middle button */
830 input_report_key(dev, BTN_LEFT, left);
831 input_report_key(dev, BTN_RIGHT, right);
836 static void alps_process_packet_v4(struct psmouse *psmouse)
838 struct alps_data *priv = psmouse->private;
839 unsigned char *packet = psmouse->packet;
840 struct alps_fields *f = &priv->f;
844 * v4 has a 6-byte encoding for bitmap data, but this data is
845 * broken up between 3 normal packets. Use priv->multi_packet to
846 * track our position in the bitmap packet.
848 if (packet[6] & 0x40) {
849 /* sync, reset position */
850 priv->multi_packet = 0;
853 if (WARN_ON_ONCE(priv->multi_packet > 2))
856 offset = 2 * priv->multi_packet;
857 priv->multi_data[offset] = packet[6];
858 priv->multi_data[offset + 1] = packet[7];
860 if (++priv->multi_packet > 2) {
861 priv->multi_packet = 0;
863 f->x_map = ((priv->multi_data[2] & 0x1f) << 10) |
864 ((priv->multi_data[3] & 0x60) << 3) |
865 ((priv->multi_data[0] & 0x3f) << 2) |
866 ((priv->multi_data[1] & 0x60) >> 5);
867 f->y_map = ((priv->multi_data[5] & 0x01) << 10) |
868 ((priv->multi_data[3] & 0x1f) << 5) |
869 (priv->multi_data[1] & 0x1f);
871 f->fingers = alps_process_bitmap(priv, f);
874 f->left = !!(packet[4] & 0x01);
875 f->right = !!(packet[4] & 0x02);
877 f->st.x = ((packet[1] & 0x7f) << 4) | ((packet[3] & 0x30) >> 2) |
878 ((packet[0] & 0x30) >> 4);
879 f->st.y = ((packet[2] & 0x7f) << 4) | (packet[3] & 0x0f);
880 f->pressure = packet[5] & 0x7f;
882 alps_report_semi_mt_data(psmouse, f->fingers);
885 static bool alps_is_valid_package_v7(struct psmouse *psmouse)
887 switch (psmouse->pktcnt) {
889 return (psmouse->packet[2] & 0x40) == 0x40;
891 return (psmouse->packet[3] & 0x48) == 0x48;
893 return (psmouse->packet[5] & 0x40) == 0x00;
898 static unsigned char alps_get_packet_id_v7(char *byte)
900 unsigned char packet_id;
903 packet_id = V7_PACKET_ID_TWO;
904 else if (byte[4] & 0x01)
905 packet_id = V7_PACKET_ID_MULTI;
906 else if ((byte[0] & 0x10) && !(byte[4] & 0x43))
907 packet_id = V7_PACKET_ID_NEW;
908 else if (byte[1] == 0x00 && byte[4] == 0x00)
909 packet_id = V7_PACKET_ID_IDLE;
911 packet_id = V7_PACKET_ID_UNKNOWN;
916 static void alps_get_finger_coordinate_v7(struct input_mt_pos *mt,
918 unsigned char pkt_id)
920 mt[0].x = ((pkt[2] & 0x80) << 4);
921 mt[0].x |= ((pkt[2] & 0x3F) << 5);
922 mt[0].x |= ((pkt[3] & 0x30) >> 1);
923 mt[0].x |= (pkt[3] & 0x07);
924 mt[0].y = (pkt[1] << 3) | (pkt[0] & 0x07);
926 mt[1].x = ((pkt[3] & 0x80) << 4);
927 mt[1].x |= ((pkt[4] & 0x80) << 3);
928 mt[1].x |= ((pkt[4] & 0x3F) << 4);
929 mt[1].y = ((pkt[5] & 0x80) << 3);
930 mt[1].y |= ((pkt[5] & 0x3F) << 4);
933 case V7_PACKET_ID_TWO:
938 case V7_PACKET_ID_MULTI:
941 mt[1].y |= ((pkt[4] & 0x02) << 4);
945 case V7_PACKET_ID_NEW:
947 mt[1].x |= (pkt[0] & 0x20);
952 mt[0].y = 0x7FF - mt[0].y;
953 mt[1].y = 0x7FF - mt[1].y;
956 static int alps_get_mt_count(struct input_mt_pos *mt)
960 for (i = 0; i < MAX_TOUCHES; i++) {
961 if (mt[i].x != 0 || mt[i].y != 0)
968 static int alps_decode_packet_v7(struct alps_fields *f,
970 struct psmouse *psmouse)
972 struct alps_data *priv = psmouse->private;
973 unsigned char pkt_id;
975 pkt_id = alps_get_packet_id_v7(p);
976 if (pkt_id == V7_PACKET_ID_IDLE)
978 if (pkt_id == V7_PACKET_ID_UNKNOWN)
981 * NEW packets are send to indicate a discontinuity in the finger
982 * coordinate reporting. Specifically a finger may have moved from
983 * slot 0 to 1 or vice versa. INPUT_MT_TRACK takes care of this for
986 * NEW packets have 3 problems:
987 * 1) They do not contain middle / right button info (on non clickpads)
988 * this can be worked around by preserving the old button state
989 * 2) They do not contain an accurate fingercount, and they are
990 * typically send when the number of fingers changes. We cannot use
991 * the old finger count as that may mismatch with the amount of
992 * touch coordinates we've available in the NEW packet
993 * 3) Their x data for the second touch is inaccurate leading to
994 * a possible jump of the x coordinate by 16 units when the first
995 * non NEW packet comes in
996 * Since problems 2 & 3 cannot be worked around, just ignore them.
998 if (pkt_id == V7_PACKET_ID_NEW)
1001 alps_get_finger_coordinate_v7(f->mt, p, pkt_id);
1003 if (pkt_id == V7_PACKET_ID_TWO)
1004 f->fingers = alps_get_mt_count(f->mt);
1005 else /* pkt_id == V7_PACKET_ID_MULTI */
1006 f->fingers = 3 + (p[5] & 0x03);
1008 f->left = (p[0] & 0x80) >> 7;
1009 if (priv->flags & ALPS_BUTTONPAD) {
1015 f->right = (p[0] & 0x20) >> 5;
1016 f->middle = (p[0] & 0x10) >> 4;
1019 /* Sometimes a single touch is reported in mt[1] rather then mt[0] */
1020 if (f->fingers == 1 && f->mt[0].x == 0 && f->mt[0].y == 0) {
1021 f->mt[0].x = f->mt[1].x;
1022 f->mt[0].y = f->mt[1].y;
1030 static void alps_process_trackstick_packet_v7(struct psmouse *psmouse)
1032 struct alps_data *priv = psmouse->private;
1033 unsigned char *packet = psmouse->packet;
1034 struct input_dev *dev2 = priv->dev2;
1035 int x, y, z, left, right, middle;
1037 /* It should be a DualPoint when received trackstick packet */
1038 if (!(priv->flags & ALPS_DUALPOINT)) {
1039 psmouse_warn(psmouse,
1040 "Rejected trackstick packet from non DualPoint device");
1044 x = ((packet[2] & 0xbf)) | ((packet[3] & 0x10) << 2);
1045 y = (packet[3] & 0x07) | (packet[4] & 0xb8) |
1046 ((packet[3] & 0x20) << 1);
1047 z = (packet[5] & 0x3f) | ((packet[3] & 0x80) >> 1);
1049 left = (packet[1] & 0x01);
1050 right = (packet[1] & 0x02) >> 1;
1051 middle = (packet[1] & 0x04) >> 2;
1053 /* Divide 2 since trackpoint's speed is too fast */
1054 input_report_rel(dev2, REL_X, (char)x / 2);
1055 input_report_rel(dev2, REL_Y, -((char)y / 2));
1057 input_report_key(dev2, BTN_LEFT, left);
1058 input_report_key(dev2, BTN_RIGHT, right);
1059 input_report_key(dev2, BTN_MIDDLE, middle);
1064 static void alps_process_touchpad_packet_v7(struct psmouse *psmouse)
1066 struct alps_data *priv = psmouse->private;
1067 struct input_dev *dev = psmouse->dev;
1068 struct alps_fields *f = &priv->f;
1070 memset(f, 0, sizeof(*f));
1072 if (priv->decode_fields(f, psmouse->packet, psmouse))
1075 alps_report_mt_data(psmouse, alps_get_mt_count(f->mt));
1077 input_mt_report_finger_count(dev, f->fingers);
1079 input_report_key(dev, BTN_LEFT, f->left);
1080 input_report_key(dev, BTN_RIGHT, f->right);
1081 input_report_key(dev, BTN_MIDDLE, f->middle);
1086 static void alps_process_packet_v7(struct psmouse *psmouse)
1088 unsigned char *packet = psmouse->packet;
1090 if (packet[0] == 0x48 && (packet[4] & 0x47) == 0x06)
1091 alps_process_trackstick_packet_v7(psmouse);
1093 alps_process_touchpad_packet_v7(psmouse);
1096 static DEFINE_MUTEX(alps_mutex);
1098 static void alps_register_bare_ps2_mouse(struct work_struct *work)
1100 struct alps_data *priv =
1101 container_of(work, struct alps_data, dev3_register_work.work);
1102 struct psmouse *psmouse = priv->psmouse;
1103 struct input_dev *dev3;
1106 mutex_lock(&alps_mutex);
1111 dev3 = input_allocate_device();
1113 psmouse_err(psmouse, "failed to allocate secondary device\n");
1118 snprintf(priv->phys3, sizeof(priv->phys3), "%s/%s",
1119 psmouse->ps2dev.serio->phys,
1120 (priv->dev2 ? "input2" : "input1"));
1121 dev3->phys = priv->phys3;
1124 * format of input device name is: "protocol vendor name"
1125 * see function psmouse_switch_protocol() in psmouse-base.c
1127 dev3->name = "PS/2 ALPS Mouse";
1129 dev3->id.bustype = BUS_I8042;
1130 dev3->id.vendor = 0x0002;
1131 dev3->id.product = PSMOUSE_PS2;
1132 dev3->id.version = 0x0000;
1133 dev3->dev.parent = &psmouse->ps2dev.serio->dev;
1135 input_set_capability(dev3, EV_REL, REL_X);
1136 input_set_capability(dev3, EV_REL, REL_Y);
1137 input_set_capability(dev3, EV_KEY, BTN_LEFT);
1138 input_set_capability(dev3, EV_KEY, BTN_RIGHT);
1139 input_set_capability(dev3, EV_KEY, BTN_MIDDLE);
1141 __set_bit(INPUT_PROP_POINTER, dev3->propbit);
1143 error = input_register_device(dev3);
1145 psmouse_err(psmouse,
1146 "failed to register secondary device: %d\n",
1148 input_free_device(dev3);
1156 * Save the error code so that we can detect that we
1157 * already tried to create the device.
1160 priv->dev3 = ERR_PTR(error);
1162 mutex_unlock(&alps_mutex);
1165 static void alps_report_bare_ps2_packet(struct psmouse *psmouse,
1166 unsigned char packet[],
1167 bool report_buttons)
1169 struct alps_data *priv = psmouse->private;
1170 struct input_dev *dev, *dev2 = NULL;
1172 /* Figure out which device to use to report the bare packet */
1173 if (priv->proto_version == ALPS_PROTO_V2 &&
1174 (priv->flags & ALPS_DUALPOINT)) {
1175 /* On V2 devices the DualPoint Stick reports bare packets */
1177 dev2 = psmouse->dev;
1178 } else if (unlikely(IS_ERR_OR_NULL(priv->dev3))) {
1179 /* Register dev3 mouse if we received PS/2 packet first time */
1180 if (!IS_ERR(priv->dev3))
1181 psmouse_queue_work(psmouse, &priv->dev3_register_work,
1189 alps_report_buttons(dev, dev2,
1190 packet[0] & 1, packet[0] & 2, packet[0] & 4);
1192 input_report_rel(dev, REL_X,
1193 packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0);
1194 input_report_rel(dev, REL_Y,
1195 packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0);
1200 static psmouse_ret_t alps_handle_interleaved_ps2(struct psmouse *psmouse)
1202 struct alps_data *priv = psmouse->private;
1204 if (psmouse->pktcnt < 6)
1205 return PSMOUSE_GOOD_DATA;
1207 if (psmouse->pktcnt == 6) {
1209 * Start a timer to flush the packet if it ends up last
1210 * 6-byte packet in the stream. Timer needs to fire
1211 * psmouse core times out itself. 20 ms should be enough
1212 * to decide if we are getting more data or not.
1214 mod_timer(&priv->timer, jiffies + msecs_to_jiffies(20));
1215 return PSMOUSE_GOOD_DATA;
1218 del_timer(&priv->timer);
1220 if (psmouse->packet[6] & 0x80) {
1223 * Highest bit is set - that means we either had
1224 * complete ALPS packet and this is start of the
1225 * next packet or we got garbage.
1228 if (((psmouse->packet[3] |
1229 psmouse->packet[4] |
1230 psmouse->packet[5]) & 0x80) ||
1231 (!alps_is_valid_first_byte(priv, psmouse->packet[6]))) {
1232 psmouse_dbg(psmouse,
1233 "refusing packet %4ph (suspected interleaved ps/2)\n",
1234 psmouse->packet + 3);
1235 return PSMOUSE_BAD_DATA;
1238 priv->process_packet(psmouse);
1240 /* Continue with the next packet */
1241 psmouse->packet[0] = psmouse->packet[6];
1242 psmouse->pktcnt = 1;
1247 * High bit is 0 - that means that we indeed got a PS/2
1248 * packet in the middle of ALPS packet.
1250 * There is also possibility that we got 6-byte ALPS
1251 * packet followed by 3-byte packet from trackpoint. We
1252 * can not distinguish between these 2 scenarios but
1253 * because the latter is unlikely to happen in course of
1254 * normal operation (user would need to press all
1255 * buttons on the pad and start moving trackpoint
1256 * without touching the pad surface) we assume former.
1257 * Even if we are wrong the wost thing that would happen
1258 * the cursor would jump but we should not get protocol
1259 * de-synchronization.
1262 alps_report_bare_ps2_packet(psmouse, &psmouse->packet[3],
1266 * Continue with the standard ALPS protocol handling,
1267 * but make sure we won't process it as an interleaved
1268 * packet again, which may happen if all buttons are
1269 * pressed. To avoid this let's reset the 4th bit which
1272 psmouse->packet[3] = psmouse->packet[6] & 0xf7;
1273 psmouse->pktcnt = 4;
1276 return PSMOUSE_GOOD_DATA;
1279 static void alps_flush_packet(unsigned long data)
1281 struct psmouse *psmouse = (struct psmouse *)data;
1282 struct alps_data *priv = psmouse->private;
1284 serio_pause_rx(psmouse->ps2dev.serio);
1286 if (psmouse->pktcnt == psmouse->pktsize) {
1289 * We did not any more data in reasonable amount of time.
1290 * Validate the last 3 bytes and process as a standard
1293 if ((psmouse->packet[3] |
1294 psmouse->packet[4] |
1295 psmouse->packet[5]) & 0x80) {
1296 psmouse_dbg(psmouse,
1297 "refusing packet %3ph (suspected interleaved ps/2)\n",
1298 psmouse->packet + 3);
1300 priv->process_packet(psmouse);
1302 psmouse->pktcnt = 0;
1305 serio_continue_rx(psmouse->ps2dev.serio);
1308 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse)
1310 struct alps_data *priv = psmouse->private;
1313 * Check if we are dealing with a bare PS/2 packet, presumably from
1314 * a device connected to the external PS/2 port. Because bare PS/2
1315 * protocol does not have enough constant bits to self-synchronize
1316 * properly we only do this if the device is fully synchronized.
1318 if (!psmouse->out_of_sync_cnt && (psmouse->packet[0] & 0xc8) == 0x08) {
1319 if (psmouse->pktcnt == 3) {
1320 alps_report_bare_ps2_packet(psmouse, psmouse->packet,
1322 return PSMOUSE_FULL_PACKET;
1324 return PSMOUSE_GOOD_DATA;
1327 /* Check for PS/2 packet stuffed in the middle of ALPS packet. */
1329 if ((priv->flags & ALPS_PS2_INTERLEAVED) &&
1330 psmouse->pktcnt >= 4 && (psmouse->packet[3] & 0x0f) == 0x0f) {
1331 return alps_handle_interleaved_ps2(psmouse);
1334 if (!alps_is_valid_first_byte(priv, psmouse->packet[0])) {
1335 psmouse_dbg(psmouse,
1336 "refusing packet[0] = %x (mask0 = %x, byte0 = %x)\n",
1337 psmouse->packet[0], priv->mask0, priv->byte0);
1338 return PSMOUSE_BAD_DATA;
1341 /* Bytes 2 - pktsize should have 0 in the highest bit */
1342 if (priv->proto_version < ALPS_PROTO_V5 &&
1343 psmouse->pktcnt >= 2 && psmouse->pktcnt <= psmouse->pktsize &&
1344 (psmouse->packet[psmouse->pktcnt - 1] & 0x80)) {
1345 psmouse_dbg(psmouse, "refusing packet[%i] = %x\n",
1346 psmouse->pktcnt - 1,
1347 psmouse->packet[psmouse->pktcnt - 1]);
1349 if (priv->proto_version == ALPS_PROTO_V3_RUSHMORE &&
1350 psmouse->pktcnt == psmouse->pktsize) {
1352 * Some Dell boxes, such as Latitude E6440 or E7440
1353 * with closed lid, quite often smash last byte of
1354 * otherwise valid packet with 0xff. Given that the
1355 * next packet is very likely to be valid let's
1356 * report PSMOUSE_FULL_PACKET but not process data,
1357 * rather than reporting PSMOUSE_BAD_DATA and
1360 return PSMOUSE_FULL_PACKET;
1363 return PSMOUSE_BAD_DATA;
1366 if (priv->proto_version == ALPS_PROTO_V7 &&
1367 !alps_is_valid_package_v7(psmouse)) {
1368 psmouse_dbg(psmouse, "refusing packet[%i] = %x\n",
1369 psmouse->pktcnt - 1,
1370 psmouse->packet[psmouse->pktcnt - 1]);
1371 return PSMOUSE_BAD_DATA;
1374 if (psmouse->pktcnt == psmouse->pktsize) {
1375 priv->process_packet(psmouse);
1376 return PSMOUSE_FULL_PACKET;
1379 return PSMOUSE_GOOD_DATA;
1382 static int alps_command_mode_send_nibble(struct psmouse *psmouse, int nibble)
1384 struct ps2dev *ps2dev = &psmouse->ps2dev;
1385 struct alps_data *priv = psmouse->private;
1387 unsigned char *param;
1388 unsigned char dummy[4];
1390 BUG_ON(nibble > 0xf);
1392 command = priv->nibble_commands[nibble].command;
1393 param = (command & 0x0f00) ?
1394 dummy : (unsigned char *)&priv->nibble_commands[nibble].data;
1396 if (ps2_command(ps2dev, param, command))
1402 static int alps_command_mode_set_addr(struct psmouse *psmouse, int addr)
1404 struct ps2dev *ps2dev = &psmouse->ps2dev;
1405 struct alps_data *priv = psmouse->private;
1408 if (ps2_command(ps2dev, NULL, priv->addr_command))
1411 for (i = 12; i >= 0; i -= 4) {
1412 nibble = (addr >> i) & 0xf;
1413 if (alps_command_mode_send_nibble(psmouse, nibble))
1420 static int __alps_command_mode_read_reg(struct psmouse *psmouse, int addr)
1422 struct ps2dev *ps2dev = &psmouse->ps2dev;
1423 unsigned char param[4];
1425 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1429 * The address being read is returned in the first two bytes
1430 * of the result. Check that this address matches the expected
1433 if (addr != ((param[0] << 8) | param[1]))
1439 static int alps_command_mode_read_reg(struct psmouse *psmouse, int addr)
1441 if (alps_command_mode_set_addr(psmouse, addr))
1443 return __alps_command_mode_read_reg(psmouse, addr);
1446 static int __alps_command_mode_write_reg(struct psmouse *psmouse, u8 value)
1448 if (alps_command_mode_send_nibble(psmouse, (value >> 4) & 0xf))
1450 if (alps_command_mode_send_nibble(psmouse, value & 0xf))
1455 static int alps_command_mode_write_reg(struct psmouse *psmouse, int addr,
1458 if (alps_command_mode_set_addr(psmouse, addr))
1460 return __alps_command_mode_write_reg(psmouse, value);
1463 static int alps_rpt_cmd(struct psmouse *psmouse, int init_command,
1464 int repeated_command, unsigned char *param)
1466 struct ps2dev *ps2dev = &psmouse->ps2dev;
1469 if (init_command && ps2_command(ps2dev, param, init_command))
1472 if (ps2_command(ps2dev, NULL, repeated_command) ||
1473 ps2_command(ps2dev, NULL, repeated_command) ||
1474 ps2_command(ps2dev, NULL, repeated_command))
1477 param[0] = param[1] = param[2] = 0xff;
1478 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1481 psmouse_dbg(psmouse, "%2.2X report: %3ph\n",
1482 repeated_command, param);
1486 static bool alps_check_valid_firmware_id(unsigned char id[])
1491 if (id[0] == 0x88 &&
1494 (id[1] & 0xf0) == 0xb0 ||
1495 (id[1] & 0xf0) == 0xc0)) {
1502 static int alps_enter_command_mode(struct psmouse *psmouse)
1504 unsigned char param[4];
1506 if (alps_rpt_cmd(psmouse, 0, PSMOUSE_CMD_RESET_WRAP, param)) {
1507 psmouse_err(psmouse, "failed to enter command mode\n");
1511 if (!alps_check_valid_firmware_id(param)) {
1512 psmouse_dbg(psmouse,
1513 "unknown response while entering command mode\n");
1519 static inline int alps_exit_command_mode(struct psmouse *psmouse)
1521 struct ps2dev *ps2dev = &psmouse->ps2dev;
1522 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM))
1528 * For DualPoint devices select the device that should respond to
1529 * subsequent commands. It looks like glidepad is behind stickpointer,
1530 * I'd thought it would be other way around...
1532 static int alps_passthrough_mode_v2(struct psmouse *psmouse, bool enable)
1534 struct ps2dev *ps2dev = &psmouse->ps2dev;
1535 int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11;
1537 if (ps2_command(ps2dev, NULL, cmd) ||
1538 ps2_command(ps2dev, NULL, cmd) ||
1539 ps2_command(ps2dev, NULL, cmd) ||
1540 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1543 /* we may get 3 more bytes, just ignore them */
1544 ps2_drain(ps2dev, 3, 100);
1549 static int alps_absolute_mode_v1_v2(struct psmouse *psmouse)
1551 struct ps2dev *ps2dev = &psmouse->ps2dev;
1553 /* Try ALPS magic knock - 4 disable before enable */
1554 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1555 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1556 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1557 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1558 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE))
1562 * Switch mouse to poll (remote) mode so motion data will not
1565 return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL);
1568 static int alps_monitor_mode_send_word(struct psmouse *psmouse, u16 word)
1573 * b0-b11 are valid bits, send sequence is inverse.
1574 * e.g. when word = 0x0123, nibble send sequence is 3, 2, 1
1576 for (i = 0; i <= 8; i += 4) {
1577 nibble = (word >> i) & 0xf;
1578 if (alps_command_mode_send_nibble(psmouse, nibble))
1585 static int alps_monitor_mode_write_reg(struct psmouse *psmouse,
1586 u16 addr, u16 value)
1588 struct ps2dev *ps2dev = &psmouse->ps2dev;
1590 /* 0x0A0 is the command to write the word */
1591 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE) ||
1592 alps_monitor_mode_send_word(psmouse, 0x0A0) ||
1593 alps_monitor_mode_send_word(psmouse, addr) ||
1594 alps_monitor_mode_send_word(psmouse, value) ||
1595 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1601 static int alps_monitor_mode(struct psmouse *psmouse, bool enable)
1603 struct ps2dev *ps2dev = &psmouse->ps2dev;
1606 /* EC E9 F5 F5 E7 E6 E7 E9 to enter monitor mode */
1607 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
1608 ps2_command(ps2dev, NULL, PSMOUSE_CMD_GETINFO) ||
1609 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1610 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1611 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1612 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1613 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1614 ps2_command(ps2dev, NULL, PSMOUSE_CMD_GETINFO))
1617 /* EC to exit monitor mode */
1618 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP))
1625 static int alps_absolute_mode_v6(struct psmouse *psmouse)
1627 u16 reg_val = 0x181;
1630 /* enter monitor mode, to write the register */
1631 if (alps_monitor_mode(psmouse, true))
1634 ret = alps_monitor_mode_write_reg(psmouse, 0x000, reg_val);
1636 if (alps_monitor_mode(psmouse, false))
1642 static int alps_get_status(struct psmouse *psmouse, char *param)
1644 /* Get status: 0xF5 0xF5 0xF5 0xE9 */
1645 if (alps_rpt_cmd(psmouse, 0, PSMOUSE_CMD_DISABLE, param))
1652 * Turn touchpad tapping on or off. The sequences are:
1653 * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
1654 * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
1655 * My guess that 0xE9 (GetInfo) is here as a sync point.
1656 * For models that also have stickpointer (DualPoints) its tapping
1657 * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
1658 * we don't fiddle with it.
1660 static int alps_tap_mode(struct psmouse *psmouse, int enable)
1662 struct ps2dev *ps2dev = &psmouse->ps2dev;
1663 int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES;
1664 unsigned char tap_arg = enable ? 0x0A : 0x00;
1665 unsigned char param[4];
1667 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) ||
1668 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1669 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1670 ps2_command(ps2dev, &tap_arg, cmd))
1673 if (alps_get_status(psmouse, param))
1680 * alps_poll() - poll the touchpad for current motion packet.
1683 static int alps_poll(struct psmouse *psmouse)
1685 struct alps_data *priv = psmouse->private;
1686 unsigned char buf[sizeof(psmouse->packet)];
1689 if (priv->flags & ALPS_PASS)
1690 alps_passthrough_mode_v2(psmouse, true);
1692 poll_failed = ps2_command(&psmouse->ps2dev, buf,
1693 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0;
1695 if (priv->flags & ALPS_PASS)
1696 alps_passthrough_mode_v2(psmouse, false);
1698 if (poll_failed || (buf[0] & priv->mask0) != priv->byte0)
1701 if ((psmouse->badbyte & 0xc8) == 0x08) {
1703 * Poll the track stick ...
1705 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8)))
1709 memcpy(psmouse->packet, buf, sizeof(buf));
1713 static int alps_hw_init_v1_v2(struct psmouse *psmouse)
1715 struct alps_data *priv = psmouse->private;
1717 if ((priv->flags & ALPS_PASS) &&
1718 alps_passthrough_mode_v2(psmouse, true)) {
1722 if (alps_tap_mode(psmouse, true)) {
1723 psmouse_warn(psmouse, "Failed to enable hardware tapping\n");
1727 if (alps_absolute_mode_v1_v2(psmouse)) {
1728 psmouse_err(psmouse, "Failed to enable absolute mode\n");
1732 if ((priv->flags & ALPS_PASS) &&
1733 alps_passthrough_mode_v2(psmouse, false)) {
1737 /* ALPS needs stream mode, otherwise it won't report any data */
1738 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM)) {
1739 psmouse_err(psmouse, "Failed to enable stream mode\n");
1746 static int alps_hw_init_v6(struct psmouse *psmouse)
1748 unsigned char param[2] = {0xC8, 0x14};
1750 /* Enter passthrough mode to let trackpoint enter 6byte raw mode */
1751 if (alps_passthrough_mode_v2(psmouse, true))
1754 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1755 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1756 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1757 ps2_command(&psmouse->ps2dev, ¶m[0], PSMOUSE_CMD_SETRATE) ||
1758 ps2_command(&psmouse->ps2dev, ¶m[1], PSMOUSE_CMD_SETRATE))
1761 if (alps_passthrough_mode_v2(psmouse, false))
1764 if (alps_absolute_mode_v6(psmouse)) {
1765 psmouse_err(psmouse, "Failed to enable absolute mode\n");
1773 * Enable or disable passthrough mode to the trackstick.
1775 static int alps_passthrough_mode_v3(struct psmouse *psmouse,
1776 int reg_base, bool enable)
1778 int reg_val, ret = -1;
1780 if (alps_enter_command_mode(psmouse))
1783 reg_val = alps_command_mode_read_reg(psmouse, reg_base + 0x0008);
1792 ret = __alps_command_mode_write_reg(psmouse, reg_val);
1795 if (alps_exit_command_mode(psmouse))
1800 /* Must be in command mode when calling this function */
1801 static int alps_absolute_mode_v3(struct psmouse *psmouse)
1805 reg_val = alps_command_mode_read_reg(psmouse, 0x0004);
1810 if (__alps_command_mode_write_reg(psmouse, reg_val))
1816 static int alps_probe_trackstick_v3(struct psmouse *psmouse, int reg_base)
1818 int ret = -EIO, reg_val;
1820 if (alps_enter_command_mode(psmouse))
1823 reg_val = alps_command_mode_read_reg(psmouse, reg_base + 0x08);
1827 /* bit 7: trackstick is present */
1828 ret = reg_val & 0x80 ? 0 : -ENODEV;
1831 alps_exit_command_mode(psmouse);
1835 static int alps_setup_trackstick_v3(struct psmouse *psmouse, int reg_base)
1837 struct ps2dev *ps2dev = &psmouse->ps2dev;
1839 unsigned char param[4];
1841 if (alps_passthrough_mode_v3(psmouse, reg_base, true))
1845 * E7 report for the trackstick
1847 * There have been reports of failures to seem to trace back
1848 * to the above trackstick check failing. When these occur
1849 * this E7 report fails, so when that happens we continue
1850 * with the assumption that there isn't a trackstick after
1853 if (alps_rpt_cmd(psmouse, 0, PSMOUSE_CMD_SETSCALE21, param)) {
1854 psmouse_warn(psmouse, "Failed to initialize trackstick (E7 report failed)\n");
1857 psmouse_dbg(psmouse, "trackstick E7 report: %3ph\n", param);
1860 * Not sure what this does, but it is absolutely
1861 * essential. Without it, the touchpad does not
1862 * work at all and the trackstick just emits normal
1865 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1866 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1867 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1868 alps_command_mode_send_nibble(psmouse, 0x9) ||
1869 alps_command_mode_send_nibble(psmouse, 0x4)) {
1870 psmouse_err(psmouse,
1871 "Error sending magic E6 sequence\n");
1877 * This ensures the trackstick packets are in the format
1878 * supported by this driver. If bit 1 isn't set the packet
1879 * format is different.
1881 if (alps_enter_command_mode(psmouse) ||
1882 alps_command_mode_write_reg(psmouse,
1883 reg_base + 0x08, 0x82) ||
1884 alps_exit_command_mode(psmouse))
1889 if (alps_passthrough_mode_v3(psmouse, reg_base, false))
1895 static int alps_hw_init_v3(struct psmouse *psmouse)
1897 struct ps2dev *ps2dev = &psmouse->ps2dev;
1899 unsigned char param[4];
1901 reg_val = alps_probe_trackstick_v3(psmouse, ALPS_REG_BASE_PINNACLE);
1902 if (reg_val == -EIO)
1906 alps_setup_trackstick_v3(psmouse, ALPS_REG_BASE_PINNACLE) == -EIO)
1909 if (alps_enter_command_mode(psmouse) ||
1910 alps_absolute_mode_v3(psmouse)) {
1911 psmouse_err(psmouse, "Failed to enter absolute mode\n");
1915 reg_val = alps_command_mode_read_reg(psmouse, 0x0006);
1918 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x01))
1921 reg_val = alps_command_mode_read_reg(psmouse, 0x0007);
1924 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x01))
1927 if (alps_command_mode_read_reg(psmouse, 0x0144) == -1)
1929 if (__alps_command_mode_write_reg(psmouse, 0x04))
1932 if (alps_command_mode_read_reg(psmouse, 0x0159) == -1)
1934 if (__alps_command_mode_write_reg(psmouse, 0x03))
1937 if (alps_command_mode_read_reg(psmouse, 0x0163) == -1)
1939 if (alps_command_mode_write_reg(psmouse, 0x0163, 0x03))
1942 if (alps_command_mode_read_reg(psmouse, 0x0162) == -1)
1944 if (alps_command_mode_write_reg(psmouse, 0x0162, 0x04))
1947 alps_exit_command_mode(psmouse);
1949 /* Set rate and enable data reporting */
1951 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE) ||
1952 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
1953 psmouse_err(psmouse, "Failed to enable data reporting\n");
1961 * Leaving the touchpad in command mode will essentially render
1962 * it unusable until the machine reboots, so exit it here just
1965 alps_exit_command_mode(psmouse);
1969 static int alps_get_v3_v7_resolution(struct psmouse *psmouse, int reg_pitch)
1971 int reg, x_pitch, y_pitch, x_electrode, y_electrode, x_phys, y_phys;
1972 struct alps_data *priv = psmouse->private;
1974 reg = alps_command_mode_read_reg(psmouse, reg_pitch);
1978 x_pitch = (char)(reg << 4) >> 4; /* sign extend lower 4 bits */
1979 x_pitch = 50 + 2 * x_pitch; /* In 0.1 mm units */
1981 y_pitch = (char)reg >> 4; /* sign extend upper 4 bits */
1982 y_pitch = 36 + 2 * y_pitch; /* In 0.1 mm units */
1984 reg = alps_command_mode_read_reg(psmouse, reg_pitch + 1);
1988 x_electrode = (char)(reg << 4) >> 4; /* sign extend lower 4 bits */
1989 x_electrode = 17 + x_electrode;
1991 y_electrode = (char)reg >> 4; /* sign extend upper 4 bits */
1992 y_electrode = 13 + y_electrode;
1994 x_phys = x_pitch * (x_electrode - 1); /* In 0.1 mm units */
1995 y_phys = y_pitch * (y_electrode - 1); /* In 0.1 mm units */
1997 priv->x_res = priv->x_max * 10 / x_phys; /* units / mm */
1998 priv->y_res = priv->y_max * 10 / y_phys; /* units / mm */
2000 psmouse_dbg(psmouse,
2001 "pitch %dx%d num-electrodes %dx%d physical size %dx%d mm res %dx%d\n",
2002 x_pitch, y_pitch, x_electrode, y_electrode,
2003 x_phys / 10, y_phys / 10, priv->x_res, priv->y_res);
2008 static int alps_hw_init_rushmore_v3(struct psmouse *psmouse)
2010 struct alps_data *priv = psmouse->private;
2011 struct ps2dev *ps2dev = &psmouse->ps2dev;
2012 int reg_val, ret = -1;
2014 if (priv->flags & ALPS_DUALPOINT) {
2015 reg_val = alps_setup_trackstick_v3(psmouse,
2016 ALPS_REG_BASE_RUSHMORE);
2017 if (reg_val == -EIO)
2021 if (alps_enter_command_mode(psmouse) ||
2022 alps_command_mode_read_reg(psmouse, 0xc2d9) == -1 ||
2023 alps_command_mode_write_reg(psmouse, 0xc2cb, 0x00))
2026 if (alps_get_v3_v7_resolution(psmouse, 0xc2da))
2029 reg_val = alps_command_mode_read_reg(psmouse, 0xc2c6);
2032 if (__alps_command_mode_write_reg(psmouse, reg_val & 0xfd))
2035 if (alps_command_mode_write_reg(psmouse, 0xc2c9, 0x64))
2038 /* enter absolute mode */
2039 reg_val = alps_command_mode_read_reg(psmouse, 0xc2c4);
2042 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x02))
2045 alps_exit_command_mode(psmouse);
2046 return ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE);
2049 alps_exit_command_mode(psmouse);
2053 /* Must be in command mode when calling this function */
2054 static int alps_absolute_mode_v4(struct psmouse *psmouse)
2058 reg_val = alps_command_mode_read_reg(psmouse, 0x0004);
2063 if (__alps_command_mode_write_reg(psmouse, reg_val))
2069 static int alps_hw_init_v4(struct psmouse *psmouse)
2071 struct ps2dev *ps2dev = &psmouse->ps2dev;
2072 unsigned char param[4];
2074 if (alps_enter_command_mode(psmouse))
2077 if (alps_absolute_mode_v4(psmouse)) {
2078 psmouse_err(psmouse, "Failed to enter absolute mode\n");
2082 if (alps_command_mode_write_reg(psmouse, 0x0007, 0x8c))
2085 if (alps_command_mode_write_reg(psmouse, 0x0149, 0x03))
2088 if (alps_command_mode_write_reg(psmouse, 0x0160, 0x03))
2091 if (alps_command_mode_write_reg(psmouse, 0x017f, 0x15))
2094 if (alps_command_mode_write_reg(psmouse, 0x0151, 0x01))
2097 if (alps_command_mode_write_reg(psmouse, 0x0168, 0x03))
2100 if (alps_command_mode_write_reg(psmouse, 0x014a, 0x03))
2103 if (alps_command_mode_write_reg(psmouse, 0x0161, 0x03))
2106 alps_exit_command_mode(psmouse);
2109 * This sequence changes the output from a 9-byte to an
2110 * 8-byte format. All the same data seems to be present,
2111 * just in a more compact format.
2116 if (ps2_command(ps2dev, ¶m[0], PSMOUSE_CMD_SETRATE) ||
2117 ps2_command(ps2dev, ¶m[1], PSMOUSE_CMD_SETRATE) ||
2118 ps2_command(ps2dev, ¶m[2], PSMOUSE_CMD_SETRATE) ||
2119 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
2122 /* Set rate and enable data reporting */
2124 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE) ||
2125 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
2126 psmouse_err(psmouse, "Failed to enable data reporting\n");
2134 * Leaving the touchpad in command mode will essentially render
2135 * it unusable until the machine reboots, so exit it here just
2138 alps_exit_command_mode(psmouse);
2142 static int alps_dolphin_get_device_area(struct psmouse *psmouse,
2143 struct alps_data *priv)
2145 struct ps2dev *ps2dev = &psmouse->ps2dev;
2146 unsigned char param[4] = {0};
2147 int num_x_electrode, num_y_electrode;
2149 if (alps_enter_command_mode(psmouse))
2153 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
2154 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETPOLL) ||
2155 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETPOLL) ||
2156 ps2_command(ps2dev, ¶m[0], PSMOUSE_CMD_SETRATE) ||
2157 ps2_command(ps2dev, ¶m[0], PSMOUSE_CMD_SETRATE))
2160 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
2164 * Dolphin's sensor line number is not fixed. It can be calculated
2165 * by adding the device's register value with DOLPHIN_PROFILE_X/YOFFSET.
2166 * Further more, we can get device's x_max and y_max by multiplying
2167 * sensor line number with DOLPHIN_COUNT_PER_ELECTRODE.
2169 * e.g. When we get register's sensor_x = 11 & sensor_y = 8,
2170 * real sensor line number X = 11 + 8 = 19, and
2171 * real sensor line number Y = 8 + 1 = 9.
2172 * So, x_max = (19 - 1) * 64 = 1152, and
2173 * y_max = (9 - 1) * 64 = 512.
2175 num_x_electrode = DOLPHIN_PROFILE_XOFFSET + (param[2] & 0x0F);
2176 num_y_electrode = DOLPHIN_PROFILE_YOFFSET + ((param[2] >> 4) & 0x0F);
2177 priv->x_bits = num_x_electrode;
2178 priv->y_bits = num_y_electrode;
2179 priv->x_max = (num_x_electrode - 1) * DOLPHIN_COUNT_PER_ELECTRODE;
2180 priv->y_max = (num_y_electrode - 1) * DOLPHIN_COUNT_PER_ELECTRODE;
2182 if (alps_exit_command_mode(psmouse))
2188 static int alps_hw_init_dolphin_v1(struct psmouse *psmouse)
2190 struct ps2dev *ps2dev = &psmouse->ps2dev;
2191 unsigned char param[2];
2193 /* This is dolphin "v1" as empirically defined by florin9doi */
2197 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM) ||
2198 ps2_command(ps2dev, ¶m[0], PSMOUSE_CMD_SETRATE) ||
2199 ps2_command(ps2dev, ¶m[1], PSMOUSE_CMD_SETRATE))
2205 static int alps_hw_init_v7(struct psmouse *psmouse)
2207 struct ps2dev *ps2dev = &psmouse->ps2dev;
2208 int reg_val, ret = -1;
2210 if (alps_enter_command_mode(psmouse) ||
2211 alps_command_mode_read_reg(psmouse, 0xc2d9) == -1)
2214 if (alps_get_v3_v7_resolution(psmouse, 0xc397))
2217 if (alps_command_mode_write_reg(psmouse, 0xc2c9, 0x64))
2220 reg_val = alps_command_mode_read_reg(psmouse, 0xc2c4);
2223 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x02))
2226 alps_exit_command_mode(psmouse);
2227 return ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE);
2230 alps_exit_command_mode(psmouse);
2234 static int alps_set_protocol(struct psmouse *psmouse,
2235 struct alps_data *priv,
2236 const struct alps_protocol_info *protocol)
2238 psmouse->private = priv;
2240 setup_timer(&priv->timer, alps_flush_packet, (unsigned long)psmouse);
2242 priv->proto_version = protocol->version;
2243 priv->byte0 = protocol->byte0;
2244 priv->mask0 = protocol->mask0;
2245 priv->flags = protocol->flags;
2252 switch (priv->proto_version) {
2255 priv->hw_init = alps_hw_init_v1_v2;
2256 priv->process_packet = alps_process_packet_v1_v2;
2257 priv->set_abs_params = alps_set_abs_params_st;
2263 priv->hw_init = alps_hw_init_v3;
2264 priv->process_packet = alps_process_packet_v3;
2265 priv->set_abs_params = alps_set_abs_params_mt;
2266 priv->decode_fields = alps_decode_pinnacle;
2267 priv->nibble_commands = alps_v3_nibble_commands;
2268 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2271 case ALPS_PROTO_V3_RUSHMORE:
2272 priv->hw_init = alps_hw_init_rushmore_v3;
2273 priv->process_packet = alps_process_packet_v3;
2274 priv->set_abs_params = alps_set_abs_params_mt;
2275 priv->decode_fields = alps_decode_rushmore;
2276 priv->nibble_commands = alps_v3_nibble_commands;
2277 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2281 if (alps_probe_trackstick_v3(psmouse,
2282 ALPS_REG_BASE_RUSHMORE) < 0)
2283 priv->flags &= ~ALPS_DUALPOINT;
2288 priv->hw_init = alps_hw_init_v4;
2289 priv->process_packet = alps_process_packet_v4;
2290 priv->set_abs_params = alps_set_abs_params_mt;
2291 priv->nibble_commands = alps_v4_nibble_commands;
2292 priv->addr_command = PSMOUSE_CMD_DISABLE;
2296 priv->hw_init = alps_hw_init_dolphin_v1;
2297 priv->process_packet = alps_process_touchpad_packet_v3_v5;
2298 priv->decode_fields = alps_decode_dolphin;
2299 priv->set_abs_params = alps_set_abs_params_mt;
2300 priv->nibble_commands = alps_v3_nibble_commands;
2301 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2305 if (alps_dolphin_get_device_area(psmouse, priv))
2311 priv->hw_init = alps_hw_init_v6;
2312 priv->process_packet = alps_process_packet_v6;
2313 priv->set_abs_params = alps_set_abs_params_st;
2314 priv->nibble_commands = alps_v6_nibble_commands;
2320 priv->hw_init = alps_hw_init_v7;
2321 priv->process_packet = alps_process_packet_v7;
2322 priv->decode_fields = alps_decode_packet_v7;
2323 priv->set_abs_params = alps_set_abs_params_mt;
2324 priv->nibble_commands = alps_v3_nibble_commands;
2325 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
2326 priv->x_max = 0xfff;
2327 priv->y_max = 0x7ff;
2329 if (priv->fw_ver[1] != 0xba)
2330 priv->flags |= ALPS_BUTTONPAD;
2338 static const struct alps_protocol_info *alps_match_table(unsigned char *e7,
2341 const struct alps_model_info *model;
2344 for (i = 0; i < ARRAY_SIZE(alps_model_data); i++) {
2345 model = &alps_model_data[i];
2347 if (!memcmp(e7, model->signature, sizeof(model->signature)) &&
2348 (!model->command_mode_resp ||
2349 model->command_mode_resp == ec[2])) {
2351 return &model->protocol_info;
2358 static int alps_identify(struct psmouse *psmouse, struct alps_data *priv)
2360 const struct alps_protocol_info *protocol;
2361 unsigned char e6[4], e7[4], ec[4];
2365 * First try "E6 report".
2366 * ALPS should return 0,0,10 or 0,0,100 if no buttons are pressed.
2367 * The bits 0-2 of the first byte will be 1s if some buttons are
2370 if (alps_rpt_cmd(psmouse, PSMOUSE_CMD_SETRES,
2371 PSMOUSE_CMD_SETSCALE11, e6))
2374 if ((e6[0] & 0xf8) != 0 || e6[1] != 0 || (e6[2] != 10 && e6[2] != 100))
2378 * Now get the "E7" and "EC" reports. These will uniquely identify
2379 * most ALPS touchpads.
2381 if (alps_rpt_cmd(psmouse, PSMOUSE_CMD_SETRES,
2382 PSMOUSE_CMD_SETSCALE21, e7) ||
2383 alps_rpt_cmd(psmouse, PSMOUSE_CMD_SETRES,
2384 PSMOUSE_CMD_RESET_WRAP, ec) ||
2385 alps_exit_command_mode(psmouse))
2388 protocol = alps_match_table(e7, ec);
2390 if (e7[0] == 0x73 && e7[1] == 0x03 && e7[2] == 0x50 &&
2391 ec[0] == 0x73 && (ec[1] == 0x01 || ec[1] == 0x02)) {
2392 protocol = &alps_v5_protocol_data;
2393 } else if (ec[0] == 0x88 &&
2394 ((ec[1] & 0xf0) == 0xb0 || (ec[1] & 0xf0) == 0xc0)) {
2395 protocol = &alps_v7_protocol_data;
2396 } else if (ec[0] == 0x88 && ec[1] == 0x08) {
2397 protocol = &alps_v3_rushmore_data;
2398 } else if (ec[0] == 0x88 && ec[1] == 0x07 &&
2399 ec[2] >= 0x90 && ec[2] <= 0x9d) {
2400 protocol = &alps_v3_protocol_data;
2402 psmouse_dbg(psmouse,
2403 "Likely not an ALPS touchpad: E7=%3ph, EC=%3ph\n", e7, ec);
2409 /* Save the Firmware version */
2410 memcpy(priv->fw_ver, ec, 3);
2411 error = alps_set_protocol(psmouse, priv, protocol);
2419 static int alps_reconnect(struct psmouse *psmouse)
2421 struct alps_data *priv = psmouse->private;
2423 psmouse_reset(psmouse);
2425 if (alps_identify(psmouse, priv) < 0)
2428 return priv->hw_init(psmouse);
2431 static void alps_disconnect(struct psmouse *psmouse)
2433 struct alps_data *priv = psmouse->private;
2435 psmouse_reset(psmouse);
2436 del_timer_sync(&priv->timer);
2438 input_unregister_device(priv->dev2);
2439 if (!IS_ERR_OR_NULL(priv->dev3))
2440 input_unregister_device(priv->dev3);
2444 static void alps_set_abs_params_st(struct alps_data *priv,
2445 struct input_dev *dev1)
2447 input_set_abs_params(dev1, ABS_X, 0, priv->x_max, 0, 0);
2448 input_set_abs_params(dev1, ABS_Y, 0, priv->y_max, 0, 0);
2451 static void alps_set_abs_params_mt(struct alps_data *priv,
2452 struct input_dev *dev1)
2454 input_set_abs_params(dev1, ABS_MT_POSITION_X, 0, priv->x_max, 0, 0);
2455 input_set_abs_params(dev1, ABS_MT_POSITION_Y, 0, priv->y_max, 0, 0);
2457 input_abs_set_res(dev1, ABS_MT_POSITION_X, priv->x_res);
2458 input_abs_set_res(dev1, ABS_MT_POSITION_Y, priv->y_res);
2460 input_mt_init_slots(dev1, MAX_TOUCHES, INPUT_MT_POINTER |
2461 INPUT_MT_DROP_UNUSED | INPUT_MT_TRACK | INPUT_MT_SEMI_MT);
2463 set_bit(BTN_TOOL_TRIPLETAP, dev1->keybit);
2464 set_bit(BTN_TOOL_QUADTAP, dev1->keybit);
2466 /* V7 is real multi-touch */
2467 if (priv->proto_version == ALPS_PROTO_V7)
2468 clear_bit(INPUT_PROP_SEMI_MT, dev1->propbit);
2471 int alps_init(struct psmouse *psmouse)
2473 struct alps_data *priv = psmouse->private;
2474 struct input_dev *dev1 = psmouse->dev;
2477 error = priv->hw_init(psmouse);
2482 * Undo part of setup done for us by psmouse core since touchpad
2483 * is not a relative device.
2485 __clear_bit(EV_REL, dev1->evbit);
2486 __clear_bit(REL_X, dev1->relbit);
2487 __clear_bit(REL_Y, dev1->relbit);
2490 * Now set up our capabilities.
2492 dev1->evbit[BIT_WORD(EV_KEY)] |= BIT_MASK(EV_KEY);
2493 dev1->keybit[BIT_WORD(BTN_TOUCH)] |= BIT_MASK(BTN_TOUCH);
2494 dev1->keybit[BIT_WORD(BTN_TOOL_FINGER)] |= BIT_MASK(BTN_TOOL_FINGER);
2495 dev1->keybit[BIT_WORD(BTN_LEFT)] |=
2496 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
2498 dev1->evbit[BIT_WORD(EV_ABS)] |= BIT_MASK(EV_ABS);
2500 priv->set_abs_params(priv, dev1);
2501 /* No pressure on V7 */
2502 if (priv->proto_version != ALPS_PROTO_V7)
2503 input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
2505 if (priv->flags & ALPS_WHEEL) {
2506 dev1->evbit[BIT_WORD(EV_REL)] |= BIT_MASK(EV_REL);
2507 dev1->relbit[BIT_WORD(REL_WHEEL)] |= BIT_MASK(REL_WHEEL);
2510 if (priv->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
2511 dev1->keybit[BIT_WORD(BTN_FORWARD)] |= BIT_MASK(BTN_FORWARD);
2512 dev1->keybit[BIT_WORD(BTN_BACK)] |= BIT_MASK(BTN_BACK);
2515 if (priv->flags & ALPS_FOUR_BUTTONS) {
2516 dev1->keybit[BIT_WORD(BTN_0)] |= BIT_MASK(BTN_0);
2517 dev1->keybit[BIT_WORD(BTN_1)] |= BIT_MASK(BTN_1);
2518 dev1->keybit[BIT_WORD(BTN_2)] |= BIT_MASK(BTN_2);
2519 dev1->keybit[BIT_WORD(BTN_3)] |= BIT_MASK(BTN_3);
2520 } else if (priv->flags & ALPS_BUTTONPAD) {
2521 set_bit(INPUT_PROP_BUTTONPAD, dev1->propbit);
2522 clear_bit(BTN_RIGHT, dev1->keybit);
2524 dev1->keybit[BIT_WORD(BTN_MIDDLE)] |= BIT_MASK(BTN_MIDDLE);
2527 if (priv->flags & ALPS_DUALPOINT) {
2528 struct input_dev *dev2;
2530 dev2 = input_allocate_device();
2532 psmouse_err(psmouse,
2533 "failed to allocate trackstick device\n");
2538 snprintf(priv->phys2, sizeof(priv->phys2), "%s/input1",
2539 psmouse->ps2dev.serio->phys);
2540 dev2->phys = priv->phys2;
2543 * format of input device name is: "protocol vendor name"
2544 * see function psmouse_switch_protocol() in psmouse-base.c
2546 dev2->name = "AlpsPS/2 ALPS DualPoint Stick";
2548 dev2->id.bustype = BUS_I8042;
2549 dev2->id.vendor = 0x0002;
2550 dev2->id.product = PSMOUSE_ALPS;
2551 dev2->id.version = priv->proto_version;
2552 dev2->dev.parent = &psmouse->ps2dev.serio->dev;
2554 input_set_capability(dev2, EV_REL, REL_X);
2555 input_set_capability(dev2, EV_REL, REL_Y);
2556 input_set_capability(dev2, EV_KEY, BTN_LEFT);
2557 input_set_capability(dev2, EV_KEY, BTN_RIGHT);
2558 input_set_capability(dev2, EV_KEY, BTN_MIDDLE);
2560 __set_bit(INPUT_PROP_POINTER, dev2->propbit);
2561 __set_bit(INPUT_PROP_POINTING_STICK, dev2->propbit);
2563 error = input_register_device(dev2);
2565 psmouse_err(psmouse,
2566 "failed to register trackstick device: %d\n",
2568 input_free_device(dev2);
2575 priv->psmouse = psmouse;
2577 INIT_DELAYED_WORK(&priv->dev3_register_work,
2578 alps_register_bare_ps2_mouse);
2580 psmouse->protocol_handler = alps_process_byte;
2581 psmouse->poll = alps_poll;
2582 psmouse->disconnect = alps_disconnect;
2583 psmouse->reconnect = alps_reconnect;
2584 psmouse->pktsize = priv->proto_version == ALPS_PROTO_V4 ? 8 : 6;
2586 /* We are having trouble resyncing ALPS touchpads so disable it for now */
2587 psmouse->resync_time = 0;
2589 /* Allow 2 invalid packets without resetting device */
2590 psmouse->resetafter = psmouse->pktsize * 2;
2595 psmouse_reset(psmouse);
2597 * Even though we did not allocate psmouse->private we do free
2600 kfree(psmouse->private);
2601 psmouse->private = NULL;
2605 int alps_detect(struct psmouse *psmouse, bool set_properties)
2607 struct alps_data *priv;
2610 error = alps_identify(psmouse, NULL);
2615 * Reset the device to make sure it is fully operational:
2616 * on some laptops, like certain Dell Latitudes, we may
2617 * fail to properly detect presence of trackstick if device
2618 * has not been reset.
2620 psmouse_reset(psmouse);
2622 priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL);
2626 error = alps_identify(psmouse, priv);
2632 if (set_properties) {
2633 psmouse->vendor = "ALPS";
2634 psmouse->name = priv->flags & ALPS_DUALPOINT ?
2635 "DualPoint TouchPad" : "GlidePoint";
2636 psmouse->model = priv->proto_version;
2639 * Destroy alps_data structure we allocated earlier since
2640 * this was just a "trial run". Otherwise we'll keep it
2641 * to be used by alps_init() which has to be called if
2642 * we succeed and set_properties is true.
2645 psmouse->private = NULL;