serial: pxa: fine-tune clk useage
[linux/fpc-iii.git] / drivers / input / mouse / alps.c
blobe229fa3cad965e7bdbe8ae1b5358f2335be5394f
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>
24 #include "psmouse.h"
25 #include "alps.h"
28 * Definitions for ALPS version 3 and 4 command mode protocol
30 #define ALPS_V3_X_MAX 2000
31 #define ALPS_V3_Y_MAX 1400
33 #define ALPS_BITMAP_X_BITS 15
34 #define ALPS_BITMAP_Y_BITS 11
36 #define ALPS_CMD_NIBBLE_10 0x01f2
38 static const struct alps_nibble_commands alps_v3_nibble_commands[] = {
39 { PSMOUSE_CMD_SETPOLL, 0x00 }, /* 0 */
40 { PSMOUSE_CMD_RESET_DIS, 0x00 }, /* 1 */
41 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* 2 */
42 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 3 */
43 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 4 */
44 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 5 */
45 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 6 */
46 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 7 */
47 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 8 */
48 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 9 */
49 { ALPS_CMD_NIBBLE_10, 0x00 }, /* a */
50 { PSMOUSE_CMD_SETRES, 0x00 }, /* b */
51 { PSMOUSE_CMD_SETRES, 0x01 }, /* c */
52 { PSMOUSE_CMD_SETRES, 0x02 }, /* d */
53 { PSMOUSE_CMD_SETRES, 0x03 }, /* e */
54 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
57 static const struct alps_nibble_commands alps_v4_nibble_commands[] = {
58 { PSMOUSE_CMD_ENABLE, 0x00 }, /* 0 */
59 { PSMOUSE_CMD_RESET_DIS, 0x00 }, /* 1 */
60 { PSMOUSE_CMD_SETSCALE21, 0x00 }, /* 2 */
61 { PSMOUSE_CMD_SETRATE, 0x0a }, /* 3 */
62 { PSMOUSE_CMD_SETRATE, 0x14 }, /* 4 */
63 { PSMOUSE_CMD_SETRATE, 0x28 }, /* 5 */
64 { PSMOUSE_CMD_SETRATE, 0x3c }, /* 6 */
65 { PSMOUSE_CMD_SETRATE, 0x50 }, /* 7 */
66 { PSMOUSE_CMD_SETRATE, 0x64 }, /* 8 */
67 { PSMOUSE_CMD_SETRATE, 0xc8 }, /* 9 */
68 { ALPS_CMD_NIBBLE_10, 0x00 }, /* a */
69 { PSMOUSE_CMD_SETRES, 0x00 }, /* b */
70 { PSMOUSE_CMD_SETRES, 0x01 }, /* c */
71 { PSMOUSE_CMD_SETRES, 0x02 }, /* d */
72 { PSMOUSE_CMD_SETRES, 0x03 }, /* e */
73 { PSMOUSE_CMD_SETSCALE11, 0x00 }, /* f */
77 #define ALPS_DUALPOINT 0x02 /* touchpad has trackstick */
78 #define ALPS_PASS 0x04 /* device has a pass-through port */
80 #define ALPS_WHEEL 0x08 /* hardware wheel present */
81 #define ALPS_FW_BK_1 0x10 /* front & back buttons present */
82 #define ALPS_FW_BK_2 0x20 /* front & back buttons present */
83 #define ALPS_FOUR_BUTTONS 0x40 /* 4 direction button present */
84 #define ALPS_PS2_INTERLEAVED 0x80 /* 3-byte PS/2 packet interleaved with
85 6-byte ALPS packet */
87 static const struct alps_model_info alps_model_data[] = {
88 { { 0x32, 0x02, 0x14 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, /* Toshiba Salellite Pro M10 */
89 { { 0x33, 0x02, 0x0a }, 0x00, ALPS_PROTO_V1, 0x88, 0xf8, 0 }, /* UMAX-530T */
90 { { 0x53, 0x02, 0x0a }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 },
91 { { 0x53, 0x02, 0x14 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 },
92 { { 0x60, 0x03, 0xc8 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 }, /* HP ze1115 */
93 { { 0x63, 0x02, 0x0a }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 },
94 { { 0x63, 0x02, 0x14 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 },
95 { { 0x63, 0x02, 0x28 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_FW_BK_2 }, /* Fujitsu Siemens S6010 */
96 { { 0x63, 0x02, 0x3c }, 0x00, ALPS_PROTO_V2, 0x8f, 0x8f, ALPS_WHEEL }, /* Toshiba Satellite S2400-103 */
97 { { 0x63, 0x02, 0x50 }, 0x00, ALPS_PROTO_V2, 0xef, 0xef, ALPS_FW_BK_1 }, /* NEC Versa L320 */
98 { { 0x63, 0x02, 0x64 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 },
99 { { 0x63, 0x03, 0xc8 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, /* Dell Latitude D800 */
100 { { 0x73, 0x00, 0x0a }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_DUALPOINT }, /* ThinkPad R61 8918-5QG */
101 { { 0x73, 0x02, 0x0a }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, 0 },
102 { { 0x73, 0x02, 0x14 }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_FW_BK_2 }, /* Ahtec Laptop */
103 { { 0x20, 0x02, 0x0e }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, /* XXX */
104 { { 0x22, 0x02, 0x0a }, 0x00, ALPS_PROTO_V2, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT },
105 { { 0x22, 0x02, 0x14 }, 0x00, ALPS_PROTO_V2, 0xff, 0xff, ALPS_PASS | ALPS_DUALPOINT }, /* Dell Latitude D600 */
106 /* Dell Latitude E5500, E6400, E6500, Precision M4400 */
107 { { 0x62, 0x02, 0x14 }, 0x00, ALPS_PROTO_V2, 0xcf, 0xcf,
108 ALPS_PASS | ALPS_DUALPOINT | ALPS_PS2_INTERLEAVED },
109 { { 0x73, 0x02, 0x50 }, 0x00, ALPS_PROTO_V2, 0xcf, 0xcf, ALPS_FOUR_BUTTONS }, /* Dell Vostro 1400 */
110 { { 0x52, 0x01, 0x14 }, 0x00, ALPS_PROTO_V2, 0xff, 0xff,
111 ALPS_PASS | ALPS_DUALPOINT | ALPS_PS2_INTERLEAVED }, /* Toshiba Tecra A11-11L */
112 { { 0x73, 0x02, 0x64 }, 0x9b, ALPS_PROTO_V3, 0x8f, 0x8f, ALPS_DUALPOINT },
113 { { 0x73, 0x02, 0x64 }, 0x9d, ALPS_PROTO_V3, 0x8f, 0x8f, ALPS_DUALPOINT },
114 { { 0x73, 0x02, 0x64 }, 0x8a, ALPS_PROTO_V4, 0x8f, 0x8f, 0 },
118 * XXX - this entry is suspicious. First byte has zero lower nibble,
119 * which is what a normal mouse would report. Also, the value 0x0e
120 * isn't valid per PS/2 spec.
123 /* Packet formats are described in Documentation/input/alps.txt */
125 static bool alps_is_valid_first_byte(const struct alps_model_info *model,
126 unsigned char data)
128 return (data & model->mask0) == model->byte0;
131 static void alps_report_buttons(struct psmouse *psmouse,
132 struct input_dev *dev1, struct input_dev *dev2,
133 int left, int right, int middle)
135 struct input_dev *dev;
138 * If shared button has already been reported on the
139 * other device (dev2) then this event should be also
140 * sent through that device.
142 dev = test_bit(BTN_LEFT, dev2->key) ? dev2 : dev1;
143 input_report_key(dev, BTN_LEFT, left);
145 dev = test_bit(BTN_RIGHT, dev2->key) ? dev2 : dev1;
146 input_report_key(dev, BTN_RIGHT, right);
148 dev = test_bit(BTN_MIDDLE, dev2->key) ? dev2 : dev1;
149 input_report_key(dev, BTN_MIDDLE, middle);
152 * Sync the _other_ device now, we'll do the first
153 * device later once we report the rest of the events.
155 input_sync(dev2);
158 static void alps_process_packet_v1_v2(struct psmouse *psmouse)
160 struct alps_data *priv = psmouse->private;
161 const struct alps_model_info *model = priv->i;
162 unsigned char *packet = psmouse->packet;
163 struct input_dev *dev = psmouse->dev;
164 struct input_dev *dev2 = priv->dev2;
165 int x, y, z, ges, fin, left, right, middle;
166 int back = 0, forward = 0;
168 if (model->proto_version == ALPS_PROTO_V1) {
169 left = packet[2] & 0x10;
170 right = packet[2] & 0x08;
171 middle = 0;
172 x = packet[1] | ((packet[0] & 0x07) << 7);
173 y = packet[4] | ((packet[3] & 0x07) << 7);
174 z = packet[5];
175 } else {
176 left = packet[3] & 1;
177 right = packet[3] & 2;
178 middle = packet[3] & 4;
179 x = packet[1] | ((packet[2] & 0x78) << (7 - 3));
180 y = packet[4] | ((packet[3] & 0x70) << (7 - 4));
181 z = packet[5];
184 if (model->flags & ALPS_FW_BK_1) {
185 back = packet[0] & 0x10;
186 forward = packet[2] & 4;
189 if (model->flags & ALPS_FW_BK_2) {
190 back = packet[3] & 4;
191 forward = packet[2] & 4;
192 if ((middle = forward && back))
193 forward = back = 0;
196 ges = packet[2] & 1;
197 fin = packet[2] & 2;
199 if ((model->flags & ALPS_DUALPOINT) && z == 127) {
200 input_report_rel(dev2, REL_X, (x > 383 ? (x - 768) : x));
201 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y));
203 alps_report_buttons(psmouse, dev2, dev, left, right, middle);
205 input_sync(dev2);
206 return;
209 alps_report_buttons(psmouse, dev, dev2, left, right, middle);
211 /* Convert hardware tap to a reasonable Z value */
212 if (ges && !fin)
213 z = 40;
216 * A "tap and drag" operation is reported by the hardware as a transition
217 * from (!fin && ges) to (fin && ges). This should be translated to the
218 * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
220 if (ges && fin && !priv->prev_fin) {
221 input_report_abs(dev, ABS_X, x);
222 input_report_abs(dev, ABS_Y, y);
223 input_report_abs(dev, ABS_PRESSURE, 0);
224 input_report_key(dev, BTN_TOOL_FINGER, 0);
225 input_sync(dev);
227 priv->prev_fin = fin;
229 if (z > 30)
230 input_report_key(dev, BTN_TOUCH, 1);
231 if (z < 25)
232 input_report_key(dev, BTN_TOUCH, 0);
234 if (z > 0) {
235 input_report_abs(dev, ABS_X, x);
236 input_report_abs(dev, ABS_Y, y);
239 input_report_abs(dev, ABS_PRESSURE, z);
240 input_report_key(dev, BTN_TOOL_FINGER, z > 0);
242 if (model->flags & ALPS_WHEEL)
243 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07));
245 if (model->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
246 input_report_key(dev, BTN_FORWARD, forward);
247 input_report_key(dev, BTN_BACK, back);
250 if (model->flags & ALPS_FOUR_BUTTONS) {
251 input_report_key(dev, BTN_0, packet[2] & 4);
252 input_report_key(dev, BTN_1, packet[0] & 0x10);
253 input_report_key(dev, BTN_2, packet[3] & 4);
254 input_report_key(dev, BTN_3, packet[0] & 0x20);
257 input_sync(dev);
261 * Process bitmap data from v3 and v4 protocols. Returns the number of
262 * fingers detected. A return value of 0 means at least one of the
263 * bitmaps was empty.
265 * The bitmaps don't have enough data to track fingers, so this function
266 * only generates points representing a bounding box of all contacts.
267 * These points are returned in x1, y1, x2, and y2 when the return value
268 * is greater than 0.
270 static int alps_process_bitmap(unsigned int x_map, unsigned int y_map,
271 int *x1, int *y1, int *x2, int *y2)
273 struct alps_bitmap_point {
274 int start_bit;
275 int num_bits;
278 int fingers_x = 0, fingers_y = 0, fingers;
279 int i, bit, prev_bit;
280 struct alps_bitmap_point x_low = {0,}, x_high = {0,};
281 struct alps_bitmap_point y_low = {0,}, y_high = {0,};
282 struct alps_bitmap_point *point;
284 if (!x_map || !y_map)
285 return 0;
287 *x1 = *y1 = *x2 = *y2 = 0;
289 prev_bit = 0;
290 point = &x_low;
291 for (i = 0; x_map != 0; i++, x_map >>= 1) {
292 bit = x_map & 1;
293 if (bit) {
294 if (!prev_bit) {
295 point->start_bit = i;
296 fingers_x++;
298 point->num_bits++;
299 } else {
300 if (prev_bit)
301 point = &x_high;
302 else
303 point->num_bits = 0;
305 prev_bit = bit;
309 * y bitmap is reversed for what we need (lower positions are in
310 * higher bits), so we process from the top end.
312 y_map = y_map << (sizeof(y_map) * BITS_PER_BYTE - ALPS_BITMAP_Y_BITS);
313 prev_bit = 0;
314 point = &y_low;
315 for (i = 0; y_map != 0; i++, y_map <<= 1) {
316 bit = y_map & (1 << (sizeof(y_map) * BITS_PER_BYTE - 1));
317 if (bit) {
318 if (!prev_bit) {
319 point->start_bit = i;
320 fingers_y++;
322 point->num_bits++;
323 } else {
324 if (prev_bit)
325 point = &y_high;
326 else
327 point->num_bits = 0;
329 prev_bit = bit;
333 * Fingers can overlap, so we use the maximum count of fingers
334 * on either axis as the finger count.
336 fingers = max(fingers_x, fingers_y);
339 * If total fingers is > 1 but either axis reports only a single
340 * contact, we have overlapping or adjacent fingers. For the
341 * purposes of creating a bounding box, divide the single contact
342 * (roughly) equally between the two points.
344 if (fingers > 1) {
345 if (fingers_x == 1) {
346 i = x_low.num_bits / 2;
347 x_low.num_bits = x_low.num_bits - i;
348 x_high.start_bit = x_low.start_bit + i;
349 x_high.num_bits = max(i, 1);
350 } else if (fingers_y == 1) {
351 i = y_low.num_bits / 2;
352 y_low.num_bits = y_low.num_bits - i;
353 y_high.start_bit = y_low.start_bit + i;
354 y_high.num_bits = max(i, 1);
358 *x1 = (ALPS_V3_X_MAX * (2 * x_low.start_bit + x_low.num_bits - 1)) /
359 (2 * (ALPS_BITMAP_X_BITS - 1));
360 *y1 = (ALPS_V3_Y_MAX * (2 * y_low.start_bit + y_low.num_bits - 1)) /
361 (2 * (ALPS_BITMAP_Y_BITS - 1));
363 if (fingers > 1) {
364 *x2 = (ALPS_V3_X_MAX * (2 * x_high.start_bit + x_high.num_bits - 1)) /
365 (2 * (ALPS_BITMAP_X_BITS - 1));
366 *y2 = (ALPS_V3_Y_MAX * (2 * y_high.start_bit + y_high.num_bits - 1)) /
367 (2 * (ALPS_BITMAP_Y_BITS - 1));
370 return fingers;
373 static void alps_set_slot(struct input_dev *dev, int slot, bool active,
374 int x, int y)
376 input_mt_slot(dev, slot);
377 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
378 if (active) {
379 input_report_abs(dev, ABS_MT_POSITION_X, x);
380 input_report_abs(dev, ABS_MT_POSITION_Y, y);
384 static void alps_report_semi_mt_data(struct input_dev *dev, int num_fingers,
385 int x1, int y1, int x2, int y2)
387 alps_set_slot(dev, 0, num_fingers != 0, x1, y1);
388 alps_set_slot(dev, 1, num_fingers == 2, x2, y2);
391 static void alps_process_trackstick_packet_v3(struct psmouse *psmouse)
393 struct alps_data *priv = psmouse->private;
394 unsigned char *packet = psmouse->packet;
395 struct input_dev *dev = priv->dev2;
396 int x, y, z, left, right, middle;
398 /* Sanity check packet */
399 if (!(packet[0] & 0x40)) {
400 psmouse_dbg(psmouse, "Bad trackstick packet, discarding\n");
401 return;
405 * There's a special packet that seems to indicate the end
406 * of a stream of trackstick data. Filter these out.
408 if (packet[1] == 0x7f && packet[2] == 0x7f && packet[4] == 0x7f)
409 return;
411 x = (s8)(((packet[0] & 0x20) << 2) | (packet[1] & 0x7f));
412 y = (s8)(((packet[0] & 0x10) << 3) | (packet[2] & 0x7f));
413 z = (packet[4] & 0x7c) >> 2;
416 * The x and y values tend to be quite large, and when used
417 * alone the trackstick is difficult to use. Scale them down
418 * to compensate.
420 x /= 8;
421 y /= 8;
423 input_report_rel(dev, REL_X, x);
424 input_report_rel(dev, REL_Y, -y);
427 * Most ALPS models report the trackstick buttons in the touchpad
428 * packets, but a few report them here. No reliable way has been
429 * found to differentiate between the models upfront, so we enable
430 * the quirk in response to seeing a button press in the trackstick
431 * packet.
433 left = packet[3] & 0x01;
434 right = packet[3] & 0x02;
435 middle = packet[3] & 0x04;
437 if (!(priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS) &&
438 (left || right || middle))
439 priv->quirks |= ALPS_QUIRK_TRACKSTICK_BUTTONS;
441 if (priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS) {
442 input_report_key(dev, BTN_LEFT, left);
443 input_report_key(dev, BTN_RIGHT, right);
444 input_report_key(dev, BTN_MIDDLE, middle);
447 input_sync(dev);
448 return;
451 static void alps_process_touchpad_packet_v3(struct psmouse *psmouse)
453 struct alps_data *priv = psmouse->private;
454 unsigned char *packet = psmouse->packet;
455 struct input_dev *dev = psmouse->dev;
456 struct input_dev *dev2 = priv->dev2;
457 int x, y, z;
458 int left, right, middle;
459 int x1 = 0, y1 = 0, x2 = 0, y2 = 0;
460 int fingers = 0, bmap_fingers;
461 unsigned int x_bitmap, y_bitmap;
464 * There's no single feature of touchpad position and bitmap packets
465 * that can be used to distinguish between them. We rely on the fact
466 * that a bitmap packet should always follow a position packet with
467 * bit 6 of packet[4] set.
469 if (priv->multi_packet) {
471 * Sometimes a position packet will indicate a multi-packet
472 * sequence, but then what follows is another position
473 * packet. Check for this, and when it happens process the
474 * position packet as usual.
476 if (packet[0] & 0x40) {
477 fingers = (packet[5] & 0x3) + 1;
478 x_bitmap = ((packet[4] & 0x7e) << 8) |
479 ((packet[1] & 0x7f) << 2) |
480 ((packet[0] & 0x30) >> 4);
481 y_bitmap = ((packet[3] & 0x70) << 4) |
482 ((packet[2] & 0x7f) << 1) |
483 (packet[4] & 0x01);
485 bmap_fingers = alps_process_bitmap(x_bitmap, y_bitmap,
486 &x1, &y1, &x2, &y2);
489 * We shouldn't report more than one finger if
490 * we don't have two coordinates.
492 if (fingers > 1 && bmap_fingers < 2)
493 fingers = bmap_fingers;
495 /* Now process position packet */
496 packet = priv->multi_data;
497 } else {
498 priv->multi_packet = 0;
503 * Bit 6 of byte 0 is not usually set in position packets. The only
504 * times it seems to be set is in situations where the data is
505 * suspect anyway, e.g. a palm resting flat on the touchpad. Given
506 * this combined with the fact that this bit is useful for filtering
507 * out misidentified bitmap packets, we reject anything with this
508 * bit set.
510 if (packet[0] & 0x40)
511 return;
513 if (!priv->multi_packet && (packet[4] & 0x40)) {
514 priv->multi_packet = 1;
515 memcpy(priv->multi_data, packet, sizeof(priv->multi_data));
516 return;
519 priv->multi_packet = 0;
521 left = packet[3] & 0x01;
522 right = packet[3] & 0x02;
523 middle = packet[3] & 0x04;
525 x = ((packet[1] & 0x7f) << 4) | ((packet[4] & 0x30) >> 2) |
526 ((packet[0] & 0x30) >> 4);
527 y = ((packet[2] & 0x7f) << 4) | (packet[4] & 0x0f);
528 z = packet[5] & 0x7f;
531 * Sometimes the hardware sends a single packet with z = 0
532 * in the middle of a stream. Real releases generate packets
533 * with x, y, and z all zero, so these seem to be flukes.
534 * Ignore them.
536 if (x && y && !z)
537 return;
540 * If we don't have MT data or the bitmaps were empty, we have
541 * to rely on ST data.
543 if (!fingers) {
544 x1 = x;
545 y1 = y;
546 fingers = z > 0 ? 1 : 0;
549 if (z >= 64)
550 input_report_key(dev, BTN_TOUCH, 1);
551 else
552 input_report_key(dev, BTN_TOUCH, 0);
554 alps_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
556 input_mt_report_finger_count(dev, fingers);
558 input_report_key(dev, BTN_LEFT, left);
559 input_report_key(dev, BTN_RIGHT, right);
560 input_report_key(dev, BTN_MIDDLE, middle);
562 if (z > 0) {
563 input_report_abs(dev, ABS_X, x);
564 input_report_abs(dev, ABS_Y, y);
566 input_report_abs(dev, ABS_PRESSURE, z);
568 input_sync(dev);
570 if (!(priv->quirks & ALPS_QUIRK_TRACKSTICK_BUTTONS)) {
571 left = packet[3] & 0x10;
572 right = packet[3] & 0x20;
573 middle = packet[3] & 0x40;
575 input_report_key(dev2, BTN_LEFT, left);
576 input_report_key(dev2, BTN_RIGHT, right);
577 input_report_key(dev2, BTN_MIDDLE, middle);
578 input_sync(dev2);
582 static void alps_process_packet_v3(struct psmouse *psmouse)
584 unsigned char *packet = psmouse->packet;
587 * v3 protocol packets come in three types, two representing
588 * touchpad data and one representing trackstick data.
589 * Trackstick packets seem to be distinguished by always
590 * having 0x3f in the last byte. This value has never been
591 * observed in the last byte of either of the other types
592 * of packets.
594 if (packet[5] == 0x3f) {
595 alps_process_trackstick_packet_v3(psmouse);
596 return;
599 alps_process_touchpad_packet_v3(psmouse);
602 static void alps_process_packet_v4(struct psmouse *psmouse)
604 struct alps_data *priv = psmouse->private;
605 unsigned char *packet = psmouse->packet;
606 struct input_dev *dev = psmouse->dev;
607 int offset;
608 int x, y, z;
609 int left, right;
610 int x1, y1, x2, y2;
611 int fingers = 0;
612 unsigned int x_bitmap, y_bitmap;
615 * v4 has a 6-byte encoding for bitmap data, but this data is
616 * broken up between 3 normal packets. Use priv->multi_packet to
617 * track our position in the bitmap packet.
619 if (packet[6] & 0x40) {
620 /* sync, reset position */
621 priv->multi_packet = 0;
624 if (WARN_ON_ONCE(priv->multi_packet > 2))
625 return;
627 offset = 2 * priv->multi_packet;
628 priv->multi_data[offset] = packet[6];
629 priv->multi_data[offset + 1] = packet[7];
631 if (++priv->multi_packet > 2) {
632 priv->multi_packet = 0;
634 x_bitmap = ((priv->multi_data[2] & 0x1f) << 10) |
635 ((priv->multi_data[3] & 0x60) << 3) |
636 ((priv->multi_data[0] & 0x3f) << 2) |
637 ((priv->multi_data[1] & 0x60) >> 5);
638 y_bitmap = ((priv->multi_data[5] & 0x01) << 10) |
639 ((priv->multi_data[3] & 0x1f) << 5) |
640 (priv->multi_data[1] & 0x1f);
642 fingers = alps_process_bitmap(x_bitmap, y_bitmap,
643 &x1, &y1, &x2, &y2);
645 /* Store MT data.*/
646 priv->fingers = fingers;
647 priv->x1 = x1;
648 priv->x2 = x2;
649 priv->y1 = y1;
650 priv->y2 = y2;
653 left = packet[4] & 0x01;
654 right = packet[4] & 0x02;
656 x = ((packet[1] & 0x7f) << 4) | ((packet[3] & 0x30) >> 2) |
657 ((packet[0] & 0x30) >> 4);
658 y = ((packet[2] & 0x7f) << 4) | (packet[3] & 0x0f);
659 z = packet[5] & 0x7f;
662 * If there were no contacts in the bitmap, use ST
663 * points in MT reports.
664 * If there were two contacts or more, report MT data.
666 if (priv->fingers < 2) {
667 x1 = x;
668 y1 = y;
669 fingers = z > 0 ? 1 : 0;
670 } else {
671 fingers = priv->fingers;
672 x1 = priv->x1;
673 x2 = priv->x2;
674 y1 = priv->y1;
675 y2 = priv->y2;
678 if (z >= 64)
679 input_report_key(dev, BTN_TOUCH, 1);
680 else
681 input_report_key(dev, BTN_TOUCH, 0);
683 alps_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
685 input_mt_report_finger_count(dev, fingers);
687 input_report_key(dev, BTN_LEFT, left);
688 input_report_key(dev, BTN_RIGHT, right);
690 if (z > 0) {
691 input_report_abs(dev, ABS_X, x);
692 input_report_abs(dev, ABS_Y, y);
694 input_report_abs(dev, ABS_PRESSURE, z);
696 input_sync(dev);
699 static void alps_process_packet(struct psmouse *psmouse)
701 struct alps_data *priv = psmouse->private;
702 const struct alps_model_info *model = priv->i;
704 switch (model->proto_version) {
705 case ALPS_PROTO_V1:
706 case ALPS_PROTO_V2:
707 alps_process_packet_v1_v2(psmouse);
708 break;
709 case ALPS_PROTO_V3:
710 alps_process_packet_v3(psmouse);
711 break;
712 case ALPS_PROTO_V4:
713 alps_process_packet_v4(psmouse);
714 break;
718 static void alps_report_bare_ps2_packet(struct psmouse *psmouse,
719 unsigned char packet[],
720 bool report_buttons)
722 struct alps_data *priv = psmouse->private;
723 struct input_dev *dev2 = priv->dev2;
725 if (report_buttons)
726 alps_report_buttons(psmouse, dev2, psmouse->dev,
727 packet[0] & 1, packet[0] & 2, packet[0] & 4);
729 input_report_rel(dev2, REL_X,
730 packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0);
731 input_report_rel(dev2, REL_Y,
732 packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0);
734 input_sync(dev2);
737 static psmouse_ret_t alps_handle_interleaved_ps2(struct psmouse *psmouse)
739 struct alps_data *priv = psmouse->private;
741 if (psmouse->pktcnt < 6)
742 return PSMOUSE_GOOD_DATA;
744 if (psmouse->pktcnt == 6) {
746 * Start a timer to flush the packet if it ends up last
747 * 6-byte packet in the stream. Timer needs to fire
748 * psmouse core times out itself. 20 ms should be enough
749 * to decide if we are getting more data or not.
751 mod_timer(&priv->timer, jiffies + msecs_to_jiffies(20));
752 return PSMOUSE_GOOD_DATA;
755 del_timer(&priv->timer);
757 if (psmouse->packet[6] & 0x80) {
760 * Highest bit is set - that means we either had
761 * complete ALPS packet and this is start of the
762 * next packet or we got garbage.
765 if (((psmouse->packet[3] |
766 psmouse->packet[4] |
767 psmouse->packet[5]) & 0x80) ||
768 (!alps_is_valid_first_byte(priv->i, psmouse->packet[6]))) {
769 psmouse_dbg(psmouse,
770 "refusing packet %4ph (suspected interleaved ps/2)\n",
771 psmouse->packet + 3);
772 return PSMOUSE_BAD_DATA;
775 alps_process_packet(psmouse);
777 /* Continue with the next packet */
778 psmouse->packet[0] = psmouse->packet[6];
779 psmouse->pktcnt = 1;
781 } else {
784 * High bit is 0 - that means that we indeed got a PS/2
785 * packet in the middle of ALPS packet.
787 * There is also possibility that we got 6-byte ALPS
788 * packet followed by 3-byte packet from trackpoint. We
789 * can not distinguish between these 2 scenarios but
790 * because the latter is unlikely to happen in course of
791 * normal operation (user would need to press all
792 * buttons on the pad and start moving trackpoint
793 * without touching the pad surface) we assume former.
794 * Even if we are wrong the wost thing that would happen
795 * the cursor would jump but we should not get protocol
796 * de-synchronization.
799 alps_report_bare_ps2_packet(psmouse, &psmouse->packet[3],
800 false);
803 * Continue with the standard ALPS protocol handling,
804 * but make sure we won't process it as an interleaved
805 * packet again, which may happen if all buttons are
806 * pressed. To avoid this let's reset the 4th bit which
807 * is normally 1.
809 psmouse->packet[3] = psmouse->packet[6] & 0xf7;
810 psmouse->pktcnt = 4;
813 return PSMOUSE_GOOD_DATA;
816 static void alps_flush_packet(unsigned long data)
818 struct psmouse *psmouse = (struct psmouse *)data;
820 serio_pause_rx(psmouse->ps2dev.serio);
822 if (psmouse->pktcnt == psmouse->pktsize) {
825 * We did not any more data in reasonable amount of time.
826 * Validate the last 3 bytes and process as a standard
827 * ALPS packet.
829 if ((psmouse->packet[3] |
830 psmouse->packet[4] |
831 psmouse->packet[5]) & 0x80) {
832 psmouse_dbg(psmouse,
833 "refusing packet %3ph (suspected interleaved ps/2)\n",
834 psmouse->packet + 3);
835 } else {
836 alps_process_packet(psmouse);
838 psmouse->pktcnt = 0;
841 serio_continue_rx(psmouse->ps2dev.serio);
844 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse)
846 struct alps_data *priv = psmouse->private;
847 const struct alps_model_info *model = priv->i;
849 if ((psmouse->packet[0] & 0xc8) == 0x08) { /* PS/2 packet */
850 if (psmouse->pktcnt == 3) {
851 alps_report_bare_ps2_packet(psmouse, psmouse->packet,
852 true);
853 return PSMOUSE_FULL_PACKET;
855 return PSMOUSE_GOOD_DATA;
858 /* Check for PS/2 packet stuffed in the middle of ALPS packet. */
860 if ((model->flags & ALPS_PS2_INTERLEAVED) &&
861 psmouse->pktcnt >= 4 && (psmouse->packet[3] & 0x0f) == 0x0f) {
862 return alps_handle_interleaved_ps2(psmouse);
865 if (!alps_is_valid_first_byte(model, psmouse->packet[0])) {
866 psmouse_dbg(psmouse,
867 "refusing packet[0] = %x (mask0 = %x, byte0 = %x)\n",
868 psmouse->packet[0], model->mask0, model->byte0);
869 return PSMOUSE_BAD_DATA;
872 /* Bytes 2 - pktsize should have 0 in the highest bit */
873 if (psmouse->pktcnt >= 2 && psmouse->pktcnt <= psmouse->pktsize &&
874 (psmouse->packet[psmouse->pktcnt - 1] & 0x80)) {
875 psmouse_dbg(psmouse, "refusing packet[%i] = %x\n",
876 psmouse->pktcnt - 1,
877 psmouse->packet[psmouse->pktcnt - 1]);
878 return PSMOUSE_BAD_DATA;
881 if (psmouse->pktcnt == psmouse->pktsize) {
882 alps_process_packet(psmouse);
883 return PSMOUSE_FULL_PACKET;
886 return PSMOUSE_GOOD_DATA;
889 static int alps_command_mode_send_nibble(struct psmouse *psmouse, int nibble)
891 struct ps2dev *ps2dev = &psmouse->ps2dev;
892 struct alps_data *priv = psmouse->private;
893 int command;
894 unsigned char *param;
895 unsigned char dummy[4];
897 BUG_ON(nibble > 0xf);
899 command = priv->nibble_commands[nibble].command;
900 param = (command & 0x0f00) ?
901 dummy : (unsigned char *)&priv->nibble_commands[nibble].data;
903 if (ps2_command(ps2dev, param, command))
904 return -1;
906 return 0;
909 static int alps_command_mode_set_addr(struct psmouse *psmouse, int addr)
911 struct ps2dev *ps2dev = &psmouse->ps2dev;
912 struct alps_data *priv = psmouse->private;
913 int i, nibble;
915 if (ps2_command(ps2dev, NULL, priv->addr_command))
916 return -1;
918 for (i = 12; i >= 0; i -= 4) {
919 nibble = (addr >> i) & 0xf;
920 if (alps_command_mode_send_nibble(psmouse, nibble))
921 return -1;
924 return 0;
927 static int __alps_command_mode_read_reg(struct psmouse *psmouse, int addr)
929 struct ps2dev *ps2dev = &psmouse->ps2dev;
930 unsigned char param[4];
932 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
933 return -1;
936 * The address being read is returned in the first two bytes
937 * of the result. Check that this address matches the expected
938 * address.
940 if (addr != ((param[0] << 8) | param[1]))
941 return -1;
943 return param[2];
946 static int alps_command_mode_read_reg(struct psmouse *psmouse, int addr)
948 if (alps_command_mode_set_addr(psmouse, addr))
949 return -1;
950 return __alps_command_mode_read_reg(psmouse, addr);
953 static int __alps_command_mode_write_reg(struct psmouse *psmouse, u8 value)
955 if (alps_command_mode_send_nibble(psmouse, (value >> 4) & 0xf))
956 return -1;
957 if (alps_command_mode_send_nibble(psmouse, value & 0xf))
958 return -1;
959 return 0;
962 static int alps_command_mode_write_reg(struct psmouse *psmouse, int addr,
963 u8 value)
965 if (alps_command_mode_set_addr(psmouse, addr))
966 return -1;
967 return __alps_command_mode_write_reg(psmouse, value);
970 static int alps_enter_command_mode(struct psmouse *psmouse,
971 unsigned char *resp)
973 unsigned char param[4];
974 struct ps2dev *ps2dev = &psmouse->ps2dev;
976 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
977 ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
978 ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_WRAP) ||
979 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
980 psmouse_err(psmouse, "failed to enter command mode\n");
981 return -1;
984 if (param[0] != 0x88 && param[1] != 0x07) {
985 psmouse_dbg(psmouse,
986 "unknown response while entering command mode: %2.2x %2.2x %2.2x\n",
987 param[0], param[1], param[2]);
988 return -1;
991 if (resp)
992 *resp = param[2];
993 return 0;
996 static inline int alps_exit_command_mode(struct psmouse *psmouse)
998 struct ps2dev *ps2dev = &psmouse->ps2dev;
999 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSTREAM))
1000 return -1;
1001 return 0;
1004 static const struct alps_model_info *alps_get_model(struct psmouse *psmouse, int *version)
1006 struct ps2dev *ps2dev = &psmouse->ps2dev;
1007 static const unsigned char rates[] = { 0, 10, 20, 40, 60, 80, 100, 200 };
1008 unsigned char param[4];
1009 const struct alps_model_info *model = NULL;
1010 int i;
1013 * First try "E6 report".
1014 * ALPS should return 0,0,10 or 0,0,100 if no buttons are pressed.
1015 * The bits 0-2 of the first byte will be 1s if some buttons are
1016 * pressed.
1018 param[0] = 0;
1019 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
1020 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1021 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1022 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11))
1023 return NULL;
1025 param[0] = param[1] = param[2] = 0xff;
1026 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1027 return NULL;
1029 psmouse_dbg(psmouse, "E6 report: %2.2x %2.2x %2.2x",
1030 param[0], param[1], param[2]);
1032 if ((param[0] & 0xf8) != 0 || param[1] != 0 ||
1033 (param[2] != 10 && param[2] != 100))
1034 return NULL;
1037 * Now try "E7 report". Allowed responses are in
1038 * alps_model_data[].signature
1040 param[0] = 0;
1041 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
1042 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1043 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1044 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21))
1045 return NULL;
1047 param[0] = param[1] = param[2] = 0xff;
1048 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1049 return NULL;
1051 psmouse_dbg(psmouse, "E7 report: %2.2x %2.2x %2.2x",
1052 param[0], param[1], param[2]);
1054 if (version) {
1055 for (i = 0; i < ARRAY_SIZE(rates) && param[2] != rates[i]; i++)
1056 /* empty */;
1057 *version = (param[0] << 8) | (param[1] << 4) | i;
1060 for (i = 0; i < ARRAY_SIZE(alps_model_data); i++) {
1061 if (!memcmp(param, alps_model_data[i].signature,
1062 sizeof(alps_model_data[i].signature))) {
1063 model = alps_model_data + i;
1064 break;
1068 if (model && model->proto_version > ALPS_PROTO_V2) {
1070 * Need to check command mode response to identify
1071 * model
1073 model = NULL;
1074 if (alps_enter_command_mode(psmouse, param)) {
1075 psmouse_warn(psmouse,
1076 "touchpad failed to enter command mode\n");
1077 } else {
1078 for (i = 0; i < ARRAY_SIZE(alps_model_data); i++) {
1079 if (alps_model_data[i].proto_version > ALPS_PROTO_V2 &&
1080 alps_model_data[i].command_mode_resp == param[0]) {
1081 model = alps_model_data + i;
1082 break;
1085 alps_exit_command_mode(psmouse);
1087 if (!model)
1088 psmouse_dbg(psmouse,
1089 "Unknown command mode response %2.2x\n",
1090 param[0]);
1094 return model;
1098 * For DualPoint devices select the device that should respond to
1099 * subsequent commands. It looks like glidepad is behind stickpointer,
1100 * I'd thought it would be other way around...
1102 static int alps_passthrough_mode_v2(struct psmouse *psmouse, bool enable)
1104 struct ps2dev *ps2dev = &psmouse->ps2dev;
1105 int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11;
1107 if (ps2_command(ps2dev, NULL, cmd) ||
1108 ps2_command(ps2dev, NULL, cmd) ||
1109 ps2_command(ps2dev, NULL, cmd) ||
1110 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1111 return -1;
1113 /* we may get 3 more bytes, just ignore them */
1114 ps2_drain(ps2dev, 3, 100);
1116 return 0;
1119 static int alps_absolute_mode_v1_v2(struct psmouse *psmouse)
1121 struct ps2dev *ps2dev = &psmouse->ps2dev;
1123 /* Try ALPS magic knock - 4 disable before enable */
1124 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1125 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1126 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1127 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1128 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE))
1129 return -1;
1132 * Switch mouse to poll (remote) mode so motion data will not
1133 * get in our way
1135 return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL);
1138 static int alps_get_status(struct psmouse *psmouse, char *param)
1140 struct ps2dev *ps2dev = &psmouse->ps2dev;
1142 /* Get status: 0xF5 0xF5 0xF5 0xE9 */
1143 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1144 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1145 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1146 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
1147 return -1;
1149 psmouse_dbg(psmouse, "Status: %2.2x %2.2x %2.2x",
1150 param[0], param[1], param[2]);
1152 return 0;
1156 * Turn touchpad tapping on or off. The sequences are:
1157 * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
1158 * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
1159 * My guess that 0xE9 (GetInfo) is here as a sync point.
1160 * For models that also have stickpointer (DualPoints) its tapping
1161 * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
1162 * we don't fiddle with it.
1164 static int alps_tap_mode(struct psmouse *psmouse, int enable)
1166 struct ps2dev *ps2dev = &psmouse->ps2dev;
1167 int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES;
1168 unsigned char tap_arg = enable ? 0x0A : 0x00;
1169 unsigned char param[4];
1171 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) ||
1172 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1173 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1174 ps2_command(ps2dev, &tap_arg, cmd))
1175 return -1;
1177 if (alps_get_status(psmouse, param))
1178 return -1;
1180 return 0;
1184 * alps_poll() - poll the touchpad for current motion packet.
1185 * Used in resync.
1187 static int alps_poll(struct psmouse *psmouse)
1189 struct alps_data *priv = psmouse->private;
1190 unsigned char buf[sizeof(psmouse->packet)];
1191 bool poll_failed;
1193 if (priv->i->flags & ALPS_PASS)
1194 alps_passthrough_mode_v2(psmouse, true);
1196 poll_failed = ps2_command(&psmouse->ps2dev, buf,
1197 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0;
1199 if (priv->i->flags & ALPS_PASS)
1200 alps_passthrough_mode_v2(psmouse, false);
1202 if (poll_failed || (buf[0] & priv->i->mask0) != priv->i->byte0)
1203 return -1;
1205 if ((psmouse->badbyte & 0xc8) == 0x08) {
1207 * Poll the track stick ...
1209 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8)))
1210 return -1;
1213 memcpy(psmouse->packet, buf, sizeof(buf));
1214 return 0;
1217 static int alps_hw_init_v1_v2(struct psmouse *psmouse)
1219 struct alps_data *priv = psmouse->private;
1220 const struct alps_model_info *model = priv->i;
1222 if ((model->flags & ALPS_PASS) &&
1223 alps_passthrough_mode_v2(psmouse, true)) {
1224 return -1;
1227 if (alps_tap_mode(psmouse, true)) {
1228 psmouse_warn(psmouse, "Failed to enable hardware tapping\n");
1229 return -1;
1232 if (alps_absolute_mode_v1_v2(psmouse)) {
1233 psmouse_err(psmouse, "Failed to enable absolute mode\n");
1234 return -1;
1237 if ((model->flags & ALPS_PASS) &&
1238 alps_passthrough_mode_v2(psmouse, false)) {
1239 return -1;
1242 /* ALPS needs stream mode, otherwise it won't report any data */
1243 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM)) {
1244 psmouse_err(psmouse, "Failed to enable stream mode\n");
1245 return -1;
1248 return 0;
1252 * Enable or disable passthrough mode to the trackstick. Must be in
1253 * command mode when calling this function.
1255 static int alps_passthrough_mode_v3(struct psmouse *psmouse, bool enable)
1257 int reg_val;
1259 reg_val = alps_command_mode_read_reg(psmouse, 0x0008);
1260 if (reg_val == -1)
1261 return -1;
1263 if (enable)
1264 reg_val |= 0x01;
1265 else
1266 reg_val &= ~0x01;
1268 if (__alps_command_mode_write_reg(psmouse, reg_val))
1269 return -1;
1271 return 0;
1274 /* Must be in command mode when calling this function */
1275 static int alps_absolute_mode_v3(struct psmouse *psmouse)
1277 int reg_val;
1279 reg_val = alps_command_mode_read_reg(psmouse, 0x0004);
1280 if (reg_val == -1)
1281 return -1;
1283 reg_val |= 0x06;
1284 if (__alps_command_mode_write_reg(psmouse, reg_val))
1285 return -1;
1287 return 0;
1290 static int alps_hw_init_v3(struct psmouse *psmouse)
1292 struct alps_data *priv = psmouse->private;
1293 struct ps2dev *ps2dev = &psmouse->ps2dev;
1294 int reg_val;
1295 unsigned char param[4];
1297 priv->nibble_commands = alps_v3_nibble_commands;
1298 priv->addr_command = PSMOUSE_CMD_RESET_WRAP;
1300 if (alps_enter_command_mode(psmouse, NULL))
1301 goto error;
1303 /* Check for trackstick */
1304 reg_val = alps_command_mode_read_reg(psmouse, 0x0008);
1305 if (reg_val == -1)
1306 goto error;
1307 if (reg_val & 0x80) {
1308 if (alps_passthrough_mode_v3(psmouse, true))
1309 goto error;
1310 if (alps_exit_command_mode(psmouse))
1311 goto error;
1314 * E7 report for the trackstick
1316 * There have been reports of failures to seem to trace back
1317 * to the above trackstick check failing. When these occur
1318 * this E7 report fails, so when that happens we continue
1319 * with the assumption that there isn't a trackstick after
1320 * all.
1322 param[0] = 0x64;
1323 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1324 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1325 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) ||
1326 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1327 psmouse_warn(psmouse, "trackstick E7 report failed\n");
1328 } else {
1329 psmouse_dbg(psmouse,
1330 "trackstick E7 report: %2.2x %2.2x %2.2x\n",
1331 param[0], param[1], param[2]);
1334 * Not sure what this does, but it is absolutely
1335 * essential. Without it, the touchpad does not
1336 * work at all and the trackstick just emits normal
1337 * PS/2 packets.
1339 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1340 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1341 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1342 alps_command_mode_send_nibble(psmouse, 0x9) ||
1343 alps_command_mode_send_nibble(psmouse, 0x4)) {
1344 psmouse_err(psmouse,
1345 "Error sending magic E6 sequence\n");
1346 goto error_passthrough;
1350 if (alps_enter_command_mode(psmouse, NULL))
1351 goto error_passthrough;
1352 if (alps_passthrough_mode_v3(psmouse, false))
1353 goto error;
1356 if (alps_absolute_mode_v3(psmouse)) {
1357 psmouse_err(psmouse, "Failed to enter absolute mode\n");
1358 goto error;
1361 reg_val = alps_command_mode_read_reg(psmouse, 0x0006);
1362 if (reg_val == -1)
1363 goto error;
1364 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x01))
1365 goto error;
1367 reg_val = alps_command_mode_read_reg(psmouse, 0x0007);
1368 if (reg_val == -1)
1369 goto error;
1370 if (__alps_command_mode_write_reg(psmouse, reg_val | 0x01))
1371 goto error;
1373 if (alps_command_mode_read_reg(psmouse, 0x0144) == -1)
1374 goto error;
1375 if (__alps_command_mode_write_reg(psmouse, 0x04))
1376 goto error;
1378 if (alps_command_mode_read_reg(psmouse, 0x0159) == -1)
1379 goto error;
1380 if (__alps_command_mode_write_reg(psmouse, 0x03))
1381 goto error;
1383 if (alps_command_mode_read_reg(psmouse, 0x0163) == -1)
1384 goto error;
1385 if (alps_command_mode_write_reg(psmouse, 0x0163, 0x03))
1386 goto error;
1388 if (alps_command_mode_read_reg(psmouse, 0x0162) == -1)
1389 goto error;
1390 if (alps_command_mode_write_reg(psmouse, 0x0162, 0x04))
1391 goto error;
1394 * This ensures the trackstick packets are in the format
1395 * supported by this driver. If bit 1 isn't set the packet
1396 * format is different.
1398 if (alps_command_mode_write_reg(psmouse, 0x0008, 0x82))
1399 goto error;
1401 alps_exit_command_mode(psmouse);
1403 /* Set rate and enable data reporting */
1404 param[0] = 0x64;
1405 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE) ||
1406 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
1407 psmouse_err(psmouse, "Failed to enable data reporting\n");
1408 return -1;
1411 return 0;
1413 error_passthrough:
1414 /* Something failed while in passthrough mode, so try to get out */
1415 if (!alps_enter_command_mode(psmouse, NULL))
1416 alps_passthrough_mode_v3(psmouse, false);
1417 error:
1419 * Leaving the touchpad in command mode will essentially render
1420 * it unusable until the machine reboots, so exit it here just
1421 * to be safe
1423 alps_exit_command_mode(psmouse);
1424 return -1;
1427 /* Must be in command mode when calling this function */
1428 static int alps_absolute_mode_v4(struct psmouse *psmouse)
1430 int reg_val;
1432 reg_val = alps_command_mode_read_reg(psmouse, 0x0004);
1433 if (reg_val == -1)
1434 return -1;
1436 reg_val |= 0x02;
1437 if (__alps_command_mode_write_reg(psmouse, reg_val))
1438 return -1;
1440 return 0;
1443 static int alps_hw_init_v4(struct psmouse *psmouse)
1445 struct alps_data *priv = psmouse->private;
1446 struct ps2dev *ps2dev = &psmouse->ps2dev;
1447 unsigned char param[4];
1449 priv->nibble_commands = alps_v4_nibble_commands;
1450 priv->addr_command = PSMOUSE_CMD_DISABLE;
1452 if (alps_enter_command_mode(psmouse, NULL))
1453 goto error;
1455 if (alps_absolute_mode_v4(psmouse)) {
1456 psmouse_err(psmouse, "Failed to enter absolute mode\n");
1457 goto error;
1460 if (alps_command_mode_write_reg(psmouse, 0x0007, 0x8c))
1461 goto error;
1463 if (alps_command_mode_write_reg(psmouse, 0x0149, 0x03))
1464 goto error;
1466 if (alps_command_mode_write_reg(psmouse, 0x0160, 0x03))
1467 goto error;
1469 if (alps_command_mode_write_reg(psmouse, 0x017f, 0x15))
1470 goto error;
1472 if (alps_command_mode_write_reg(psmouse, 0x0151, 0x01))
1473 goto error;
1475 if (alps_command_mode_write_reg(psmouse, 0x0168, 0x03))
1476 goto error;
1478 if (alps_command_mode_write_reg(psmouse, 0x014a, 0x03))
1479 goto error;
1481 if (alps_command_mode_write_reg(psmouse, 0x0161, 0x03))
1482 goto error;
1484 alps_exit_command_mode(psmouse);
1487 * This sequence changes the output from a 9-byte to an
1488 * 8-byte format. All the same data seems to be present,
1489 * just in a more compact format.
1491 param[0] = 0xc8;
1492 param[1] = 0x64;
1493 param[2] = 0x50;
1494 if (ps2_command(ps2dev, &param[0], PSMOUSE_CMD_SETRATE) ||
1495 ps2_command(ps2dev, &param[1], PSMOUSE_CMD_SETRATE) ||
1496 ps2_command(ps2dev, &param[2], PSMOUSE_CMD_SETRATE) ||
1497 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
1498 return -1;
1500 /* Set rate and enable data reporting */
1501 param[0] = 0x64;
1502 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE) ||
1503 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
1504 psmouse_err(psmouse, "Failed to enable data reporting\n");
1505 return -1;
1508 return 0;
1510 error:
1512 * Leaving the touchpad in command mode will essentially render
1513 * it unusable until the machine reboots, so exit it here just
1514 * to be safe
1516 alps_exit_command_mode(psmouse);
1517 return -1;
1520 static int alps_hw_init(struct psmouse *psmouse)
1522 struct alps_data *priv = psmouse->private;
1523 const struct alps_model_info *model = priv->i;
1524 int ret = -1;
1526 switch (model->proto_version) {
1527 case ALPS_PROTO_V1:
1528 case ALPS_PROTO_V2:
1529 ret = alps_hw_init_v1_v2(psmouse);
1530 break;
1531 case ALPS_PROTO_V3:
1532 ret = alps_hw_init_v3(psmouse);
1533 break;
1534 case ALPS_PROTO_V4:
1535 ret = alps_hw_init_v4(psmouse);
1536 break;
1539 return ret;
1542 static int alps_reconnect(struct psmouse *psmouse)
1544 const struct alps_model_info *model;
1546 psmouse_reset(psmouse);
1548 model = alps_get_model(psmouse, NULL);
1549 if (!model)
1550 return -1;
1552 return alps_hw_init(psmouse);
1555 static void alps_disconnect(struct psmouse *psmouse)
1557 struct alps_data *priv = psmouse->private;
1559 psmouse_reset(psmouse);
1560 del_timer_sync(&priv->timer);
1561 input_unregister_device(priv->dev2);
1562 kfree(priv);
1565 int alps_init(struct psmouse *psmouse)
1567 struct alps_data *priv;
1568 const struct alps_model_info *model;
1569 struct input_dev *dev1 = psmouse->dev, *dev2;
1570 int version;
1572 priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL);
1573 dev2 = input_allocate_device();
1574 if (!priv || !dev2)
1575 goto init_fail;
1577 priv->dev2 = dev2;
1578 setup_timer(&priv->timer, alps_flush_packet, (unsigned long)psmouse);
1580 psmouse->private = priv;
1582 psmouse_reset(psmouse);
1584 model = alps_get_model(psmouse, &version);
1585 if (!model)
1586 goto init_fail;
1588 priv->i = model;
1590 if (alps_hw_init(psmouse))
1591 goto init_fail;
1594 * Undo part of setup done for us by psmouse core since touchpad
1595 * is not a relative device.
1597 __clear_bit(EV_REL, dev1->evbit);
1598 __clear_bit(REL_X, dev1->relbit);
1599 __clear_bit(REL_Y, dev1->relbit);
1602 * Now set up our capabilities.
1604 dev1->evbit[BIT_WORD(EV_KEY)] |= BIT_MASK(EV_KEY);
1605 dev1->keybit[BIT_WORD(BTN_TOUCH)] |= BIT_MASK(BTN_TOUCH);
1606 dev1->keybit[BIT_WORD(BTN_TOOL_FINGER)] |= BIT_MASK(BTN_TOOL_FINGER);
1607 dev1->keybit[BIT_WORD(BTN_LEFT)] |=
1608 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
1610 dev1->evbit[BIT_WORD(EV_ABS)] |= BIT_MASK(EV_ABS);
1612 switch (model->proto_version) {
1613 case ALPS_PROTO_V1:
1614 case ALPS_PROTO_V2:
1615 input_set_abs_params(dev1, ABS_X, 0, 1023, 0, 0);
1616 input_set_abs_params(dev1, ABS_Y, 0, 767, 0, 0);
1617 break;
1618 case ALPS_PROTO_V3:
1619 case ALPS_PROTO_V4:
1620 set_bit(INPUT_PROP_SEMI_MT, dev1->propbit);
1621 input_mt_init_slots(dev1, 2, 0);
1622 input_set_abs_params(dev1, ABS_MT_POSITION_X, 0, ALPS_V3_X_MAX, 0, 0);
1623 input_set_abs_params(dev1, ABS_MT_POSITION_Y, 0, ALPS_V3_Y_MAX, 0, 0);
1625 set_bit(BTN_TOOL_DOUBLETAP, dev1->keybit);
1626 set_bit(BTN_TOOL_TRIPLETAP, dev1->keybit);
1627 set_bit(BTN_TOOL_QUADTAP, dev1->keybit);
1629 input_set_abs_params(dev1, ABS_X, 0, ALPS_V3_X_MAX, 0, 0);
1630 input_set_abs_params(dev1, ABS_Y, 0, ALPS_V3_Y_MAX, 0, 0);
1631 break;
1634 input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
1636 if (model->flags & ALPS_WHEEL) {
1637 dev1->evbit[BIT_WORD(EV_REL)] |= BIT_MASK(EV_REL);
1638 dev1->relbit[BIT_WORD(REL_WHEEL)] |= BIT_MASK(REL_WHEEL);
1641 if (model->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
1642 dev1->keybit[BIT_WORD(BTN_FORWARD)] |= BIT_MASK(BTN_FORWARD);
1643 dev1->keybit[BIT_WORD(BTN_BACK)] |= BIT_MASK(BTN_BACK);
1646 if (model->flags & ALPS_FOUR_BUTTONS) {
1647 dev1->keybit[BIT_WORD(BTN_0)] |= BIT_MASK(BTN_0);
1648 dev1->keybit[BIT_WORD(BTN_1)] |= BIT_MASK(BTN_1);
1649 dev1->keybit[BIT_WORD(BTN_2)] |= BIT_MASK(BTN_2);
1650 dev1->keybit[BIT_WORD(BTN_3)] |= BIT_MASK(BTN_3);
1651 } else {
1652 dev1->keybit[BIT_WORD(BTN_MIDDLE)] |= BIT_MASK(BTN_MIDDLE);
1655 snprintf(priv->phys, sizeof(priv->phys), "%s/input1", psmouse->ps2dev.serio->phys);
1656 dev2->phys = priv->phys;
1657 dev2->name = (model->flags & ALPS_DUALPOINT) ? "DualPoint Stick" : "PS/2 Mouse";
1658 dev2->id.bustype = BUS_I8042;
1659 dev2->id.vendor = 0x0002;
1660 dev2->id.product = PSMOUSE_ALPS;
1661 dev2->id.version = 0x0000;
1662 dev2->dev.parent = &psmouse->ps2dev.serio->dev;
1664 dev2->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1665 dev2->relbit[BIT_WORD(REL_X)] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1666 dev2->keybit[BIT_WORD(BTN_LEFT)] =
1667 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) | BIT_MASK(BTN_RIGHT);
1669 if (input_register_device(priv->dev2))
1670 goto init_fail;
1672 psmouse->protocol_handler = alps_process_byte;
1673 psmouse->poll = alps_poll;
1674 psmouse->disconnect = alps_disconnect;
1675 psmouse->reconnect = alps_reconnect;
1676 psmouse->pktsize = model->proto_version == ALPS_PROTO_V4 ? 8 : 6;
1678 /* We are having trouble resyncing ALPS touchpads so disable it for now */
1679 psmouse->resync_time = 0;
1681 return 0;
1683 init_fail:
1684 psmouse_reset(psmouse);
1685 input_free_device(dev2);
1686 kfree(priv);
1687 psmouse->private = NULL;
1688 return -1;
1691 int alps_detect(struct psmouse *psmouse, bool set_properties)
1693 int version;
1694 const struct alps_model_info *model;
1696 model = alps_get_model(psmouse, &version);
1697 if (!model)
1698 return -1;
1700 if (set_properties) {
1701 psmouse->vendor = "ALPS";
1702 psmouse->name = model->flags & ALPS_DUALPOINT ?
1703 "DualPoint TouchPad" : "GlidePoint";
1704 psmouse->model = version;
1706 return 0;