Input: alps - ignore bad data on Dell Latitudes E6440 and E7440
[deliverable/linux.git] / drivers / input / mouse / elantech.c
CommitLineData
2a0bd75e 1/*
3f8c0df4 2 * Elantech Touchpad driver (v6)
2a0bd75e 3 *
3f8c0df4 4 * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
2a0bd75e
AO
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published
8 * by the Free Software Foundation.
9 *
10 * Trademarks are the property of their respective owners.
11 */
12
13#include <linux/delay.h>
36189cc3 14#include <linux/dmi.h>
5a0e3ad6 15#include <linux/slab.h>
2a0bd75e
AO
16#include <linux/module.h>
17#include <linux/input.h>
89eec4d7 18#include <linux/input/mt.h>
2a0bd75e
AO
19#include <linux/serio.h>
20#include <linux/libps2.h>
a2418fc4 21#include <asm/unaligned.h>
2a0bd75e
AO
22#include "psmouse.h"
23#include "elantech.h"
24
d4ae84a8
DT
25#define elantech_debug(fmt, ...) \
26 do { \
27 if (etd->debug) \
b5d21704
DT
28 psmouse_printk(KERN_DEBUG, psmouse, \
29 fmt, ##__VA_ARGS__); \
2a0bd75e
AO
30 } while (0)
31
32/*
33 * Send a Synaptics style sliced query command
34 */
35static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
36 unsigned char *param)
37{
38 if (psmouse_sliced_command(psmouse, c) ||
39 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
b5d21704 40 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
2a0bd75e
AO
41 return -1;
42 }
43
44 return 0;
45}
46
b56b92a9
JD
47/*
48 * V3 and later support this fast command
49 */
50static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
51 unsigned char *param)
52{
53 struct ps2dev *ps2dev = &psmouse->ps2dev;
54
55 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
56 ps2_command(ps2dev, NULL, c) ||
57 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
58 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
59 return -1;
60 }
61
62 return 0;
63}
64
2a0bd75e
AO
65/*
66 * A retrying version of ps2_command
67 */
68static int elantech_ps2_command(struct psmouse *psmouse,
69 unsigned char *param, int command)
70{
71 struct ps2dev *ps2dev = &psmouse->ps2dev;
72 struct elantech_data *etd = psmouse->private;
73 int rc;
74 int tries = ETP_PS2_COMMAND_TRIES;
75
76 do {
77 rc = ps2_command(ps2dev, param, command);
78 if (rc == 0)
79 break;
80 tries--;
d4ae84a8
DT
81 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
82 command, tries);
2a0bd75e
AO
83 msleep(ETP_PS2_COMMAND_DELAY);
84 } while (tries > 0);
85
86 if (rc)
b5d21704 87 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
2a0bd75e
AO
88
89 return rc;
90}
91
92/*
93 * Send an Elantech style special command to read a value from a register
94 */
95static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
96 unsigned char *val)
97{
98 struct elantech_data *etd = psmouse->private;
99 unsigned char param[3];
100 int rc = 0;
101
1dc6edec 102 if (reg < 0x07 || reg > 0x26)
2a0bd75e
AO
103 return -1;
104
105 if (reg > 0x11 && reg < 0x20)
106 return -1;
107
108 switch (etd->hw_version) {
109 case 1:
110 if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
111 psmouse_sliced_command(psmouse, reg) ||
112 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
113 rc = -1;
114 }
115 break;
116
117 case 2:
118 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
119 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
120 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
121 elantech_ps2_command(psmouse, NULL, reg) ||
122 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
123 rc = -1;
124 }
125 break;
28f49616 126
1dc6edec 127 case 3 ... 4:
28f49616
JD
128 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
129 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
130 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
131 elantech_ps2_command(psmouse, NULL, reg) ||
132 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
133 rc = -1;
134 }
135 break;
2a0bd75e
AO
136 }
137
138 if (rc)
b5d21704 139 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
1dc6edec 140 else if (etd->hw_version != 4)
2a0bd75e 141 *val = param[0];
1dc6edec
JD
142 else
143 *val = param[1];
2a0bd75e
AO
144
145 return rc;
146}
147
148/*
149 * Send an Elantech style special command to write a register with a value
150 */
151static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
152 unsigned char val)
153{
154 struct elantech_data *etd = psmouse->private;
155 int rc = 0;
156
1dc6edec 157 if (reg < 0x07 || reg > 0x26)
2a0bd75e
AO
158 return -1;
159
160 if (reg > 0x11 && reg < 0x20)
161 return -1;
162
163 switch (etd->hw_version) {
164 case 1:
165 if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
166 psmouse_sliced_command(psmouse, reg) ||
167 psmouse_sliced_command(psmouse, val) ||
168 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
169 rc = -1;
170 }
171 break;
172
173 case 2:
174 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
175 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
176 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
177 elantech_ps2_command(psmouse, NULL, reg) ||
178 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
179 elantech_ps2_command(psmouse, NULL, val) ||
180 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
181 rc = -1;
182 }
183 break;
28f49616
JD
184
185 case 3:
186 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
187 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
188 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
189 elantech_ps2_command(psmouse, NULL, reg) ||
190 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
191 elantech_ps2_command(psmouse, NULL, val) ||
192 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
193 rc = -1;
194 }
195 break;
1dc6edec
JD
196
197 case 4:
198 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
199 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
200 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
201 elantech_ps2_command(psmouse, NULL, reg) ||
202 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
203 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
204 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
205 elantech_ps2_command(psmouse, NULL, val) ||
206 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
207 rc = -1;
208 }
209 break;
2a0bd75e
AO
210 }
211
212 if (rc)
b5d21704
DT
213 psmouse_err(psmouse,
214 "failed to write register 0x%02x with value 0x%02x.\n",
215 reg, val);
2a0bd75e
AO
216
217 return rc;
218}
219
220/*
221 * Dump a complete mouse movement packet to the syslog
222 */
b5d21704 223static void elantech_packet_dump(struct psmouse *psmouse)
2a0bd75e
AO
224{
225 int i;
226
b5d21704
DT
227 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [");
228 for (i = 0; i < psmouse->pktsize; i++)
229 printk("%s0x%02x ", i ? ", " : " ", psmouse->packet[i]);
2a0bd75e
AO
230 printk("]\n");
231}
232
233/*
234 * Interpret complete data packets and report absolute mode input events for
235 * hardware version 1. (4 byte packets)
236 */
237static void elantech_report_absolute_v1(struct psmouse *psmouse)
238{
239 struct input_dev *dev = psmouse->dev;
240 struct elantech_data *etd = psmouse->private;
241 unsigned char *packet = psmouse->packet;
242 int fingers;
243
504e8bee 244 if (etd->fw_version < 0x020000) {
e938fbfd
FR
245 /*
246 * byte 0: D U p1 p2 1 p3 R L
247 * byte 1: f 0 th tw x9 x8 y9 y8
248 */
2a0bd75e
AO
249 fingers = ((packet[1] & 0x80) >> 7) +
250 ((packet[1] & 0x30) >> 4);
251 } else {
e938fbfd
FR
252 /*
253 * byte 0: n1 n0 p2 p1 1 p3 R L
254 * byte 1: 0 0 0 0 x9 x8 y9 y8
255 */
2a0bd75e
AO
256 fingers = (packet[0] & 0xc0) >> 6;
257 }
258
3f8c0df4 259 if (etd->jumpy_cursor) {
7f29f17b
ÉP
260 if (fingers != 1) {
261 etd->single_finger_reports = 0;
262 } else if (etd->single_finger_reports < 2) {
263 /* Discard first 2 reports of one finger, bogus */
264 etd->single_finger_reports++;
d4ae84a8 265 elantech_debug("discarding packet\n");
7f29f17b 266 return;
3f8c0df4
AO
267 }
268 }
269
2a0bd75e
AO
270 input_report_key(dev, BTN_TOUCH, fingers != 0);
271
e938fbfd
FR
272 /*
273 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
274 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
275 */
2a0bd75e
AO
276 if (fingers) {
277 input_report_abs(dev, ABS_X,
278 ((packet[1] & 0x0c) << 6) | packet[2]);
e938fbfd 279 input_report_abs(dev, ABS_Y,
230282a7 280 etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
2a0bd75e
AO
281 }
282
283 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
284 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
285 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
286 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
287 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
288
504e8bee 289 if (etd->fw_version < 0x020000 &&
230282a7 290 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
2a0bd75e
AO
291 /* rocker up */
292 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
293 /* rocker down */
294 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
295 }
296
297 input_sync(dev);
298}
299
89eec4d7
ÉP
300static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
301 unsigned int x, unsigned int y)
302{
303 input_mt_slot(dev, slot);
304 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
305 if (active) {
306 input_report_abs(dev, ABS_MT_POSITION_X, x);
307 input_report_abs(dev, ABS_MT_POSITION_Y, y);
308 }
309}
310
311/* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
312static void elantech_report_semi_mt_data(struct input_dev *dev,
313 unsigned int num_fingers,
314 unsigned int x1, unsigned int y1,
315 unsigned int x2, unsigned int y2)
316{
317 elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
318 elantech_set_slot(dev, 1, num_fingers == 2, x2, y2);
319}
320
2a0bd75e
AO
321/*
322 * Interpret complete data packets and report absolute mode input events for
323 * hardware version 2. (6 byte packets)
324 */
325static void elantech_report_absolute_v2(struct psmouse *psmouse)
326{
f941c705 327 struct elantech_data *etd = psmouse->private;
2a0bd75e
AO
328 struct input_dev *dev = psmouse->dev;
329 unsigned char *packet = psmouse->packet;
461a7917
JD
330 unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
331 unsigned int width = 0, pres = 0;
2a0bd75e
AO
332
333 /* byte 0: n1 n0 . . . . R L */
334 fingers = (packet[0] & 0xc0) >> 6;
2a0bd75e
AO
335
336 switch (fingers) {
22462d9f
ÉP
337 case 3:
338 /*
339 * Same as one finger, except report of more than 3 fingers:
340 * byte 3: n4 . w1 w0 . . . .
341 */
342 if (packet[3] & 0x80)
343 fingers = 4;
344 /* pass through... */
2a0bd75e 345 case 1:
e938fbfd 346 /*
11559619 347 * byte 1: . . . . x11 x10 x9 x8
e938fbfd
FR
348 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
349 */
11559619 350 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
e938fbfd 351 /*
11559619 352 * byte 4: . . . . y11 y10 y9 y8
e938fbfd
FR
353 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
354 */
230282a7 355 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
89eec4d7 356
f941c705
ÉP
357 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
358 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
2a0bd75e
AO
359 break;
360
361 case 2:
e938fbfd
FR
362 /*
363 * The coordinate of each finger is reported separately
364 * with a lower resolution for two finger touches:
365 * byte 0: . . ay8 ax8 . . . .
366 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
367 */
461a7917 368 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
2a0bd75e 369 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
230282a7 370 y1 = etd->y_max -
461a7917 371 ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
e938fbfd
FR
372 /*
373 * byte 3: . . by8 bx8 . . . .
374 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
375 */
461a7917 376 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
2a0bd75e 377 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
230282a7 378 y2 = etd->y_max -
461a7917 379 ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
f941c705
ÉP
380
381 /* Unknown so just report sensible values */
382 pres = 127;
383 width = 7;
2a0bd75e
AO
384 break;
385 }
386
461a7917
JD
387 input_report_key(dev, BTN_TOUCH, fingers != 0);
388 if (fingers != 0) {
389 input_report_abs(dev, ABS_X, x1);
390 input_report_abs(dev, ABS_Y, y1);
391 }
89eec4d7 392 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
2a0bd75e
AO
393 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
394 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
395 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
22462d9f 396 input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
2a0bd75e
AO
397 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
398 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
f941c705
ÉP
399 if (etd->reports_pressure) {
400 input_report_abs(dev, ABS_PRESSURE, pres);
401 input_report_abs(dev, ABS_TOOL_WIDTH, width);
402 }
2a0bd75e
AO
403
404 input_sync(dev);
405}
406
a2418fc4
UDB
407static void elantech_report_trackpoint(struct psmouse *psmouse,
408 int packet_type)
409{
410 /*
411 * byte 0: 0 0 sx sy 0 M R L
412 * byte 1:~sx 0 0 0 0 0 0 0
413 * byte 2:~sy 0 0 0 0 0 0 0
414 * byte 3: 0 0 ~sy ~sx 0 1 1 0
415 * byte 4: x7 x6 x5 x4 x3 x2 x1 x0
416 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
417 *
418 * x and y are written in two's complement spread
419 * over 9 bits with sx/sy the relative top bit and
420 * x7..x0 and y7..y0 the lower bits.
421 * The sign of y is opposite to what the input driver
422 * expects for a relative movement
423 */
424
425 struct elantech_data *etd = psmouse->private;
426 struct input_dev *tp_dev = etd->tp_dev;
427 unsigned char *packet = psmouse->packet;
428 int x, y;
429 u32 t;
430
431 if (dev_WARN_ONCE(&psmouse->ps2dev.serio->dev,
432 !tp_dev,
433 psmouse_fmt("Unexpected trackpoint message\n"))) {
434 if (etd->debug == 1)
435 elantech_packet_dump(psmouse);
436 return;
437 }
438
439 t = get_unaligned_le32(&packet[0]);
440
441 switch (t & ~7U) {
442 case 0x06000030U:
443 case 0x16008020U:
444 case 0x26800010U:
445 case 0x36808000U:
446 x = packet[4] - (int)((packet[1]^0x80) << 1);
447 y = (int)((packet[2]^0x80) << 1) - packet[5];
448
449 input_report_key(tp_dev, BTN_LEFT, packet[0] & 0x01);
450 input_report_key(tp_dev, BTN_RIGHT, packet[0] & 0x02);
451 input_report_key(tp_dev, BTN_MIDDLE, packet[0] & 0x04);
452
453 input_report_rel(tp_dev, REL_X, x);
454 input_report_rel(tp_dev, REL_Y, y);
455
456 input_sync(tp_dev);
457
458 break;
459
460 default:
461 /* Dump unexpected packet sequences if debug=1 (default) */
462 if (etd->debug == 1)
463 elantech_packet_dump(psmouse);
464
465 break;
466 }
467}
468
28f49616
JD
469/*
470 * Interpret complete data packets and report absolute mode input events for
471 * hardware version 3. (12 byte packets for two fingers)
472 */
473static void elantech_report_absolute_v3(struct psmouse *psmouse,
474 int packet_type)
475{
476 struct input_dev *dev = psmouse->dev;
477 struct elantech_data *etd = psmouse->private;
478 unsigned char *packet = psmouse->packet;
479 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
480 unsigned int width = 0, pres = 0;
481
482 /* byte 0: n1 n0 . . . . R L */
483 fingers = (packet[0] & 0xc0) >> 6;
484
485 switch (fingers) {
486 case 3:
487 case 1:
488 /*
489 * byte 1: . . . . x11 x10 x9 x8
490 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
491 */
492 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
493 /*
494 * byte 4: . . . . y11 y10 y9 y8
495 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
496 */
497 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
498 break;
499
500 case 2:
501 if (packet_type == PACKET_V3_HEAD) {
502 /*
503 * byte 1: . . . . ax11 ax10 ax9 ax8
504 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
505 */
1dc6edec 506 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
28f49616
JD
507 /*
508 * byte 4: . . . . ay11 ay10 ay9 ay8
509 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
510 */
1dc6edec 511 etd->mt[0].y = etd->y_max -
28f49616
JD
512 (((packet[4] & 0x0f) << 8) | packet[5]);
513 /*
514 * wait for next packet
515 */
516 return;
517 }
518
519 /* packet_type == PACKET_V3_TAIL */
1dc6edec
JD
520 x1 = etd->mt[0].x;
521 y1 = etd->mt[0].y;
28f49616
JD
522 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
523 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
524 break;
525 }
526
527 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
528 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
529
530 input_report_key(dev, BTN_TOUCH, fingers != 0);
531 if (fingers != 0) {
532 input_report_abs(dev, ABS_X, x1);
533 input_report_abs(dev, ABS_Y, y1);
534 }
535 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
536 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
537 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
538 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
cd9e83e2
HG
539
540 /* For clickpads map both buttons to BTN_LEFT */
541 if (etd->fw_version & 0x001000) {
542 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
543 } else {
544 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
545 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
546 }
547
28f49616
JD
548 input_report_abs(dev, ABS_PRESSURE, pres);
549 input_report_abs(dev, ABS_TOOL_WIDTH, width);
550
551 input_sync(dev);
552}
553
1dc6edec
JD
554static void elantech_input_sync_v4(struct psmouse *psmouse)
555{
556 struct input_dev *dev = psmouse->dev;
cd9e83e2 557 struct elantech_data *etd = psmouse->private;
1dc6edec
JD
558 unsigned char *packet = psmouse->packet;
559
cd9e83e2
HG
560 /* For clickpads map both buttons to BTN_LEFT */
561 if (etd->fw_version & 0x001000) {
562 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
563 } else {
564 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
565 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
566 }
567
1dc6edec
JD
568 input_mt_report_pointer_emulation(dev, true);
569 input_sync(dev);
570}
571
572static void process_packet_status_v4(struct psmouse *psmouse)
573{
574 struct input_dev *dev = psmouse->dev;
575 unsigned char *packet = psmouse->packet;
576 unsigned fingers;
577 int i;
578
579 /* notify finger state change */
580 fingers = packet[1] & 0x1f;
581 for (i = 0; i < ETP_MAX_FINGERS; i++) {
582 if ((fingers & (1 << i)) == 0) {
583 input_mt_slot(dev, i);
584 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
585 }
586 }
587
588 elantech_input_sync_v4(psmouse);
589}
590
591static void process_packet_head_v4(struct psmouse *psmouse)
592{
593 struct input_dev *dev = psmouse->dev;
594 struct elantech_data *etd = psmouse->private;
595 unsigned char *packet = psmouse->packet;
596 int id = ((packet[3] & 0xe0) >> 5) - 1;
597 int pres, traces;
598
599 if (id < 0)
600 return;
601
602 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
603 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
604 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
605 traces = (packet[0] & 0xf0) >> 4;
606
607 input_mt_slot(dev, id);
608 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
609
610 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
611 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
612 input_report_abs(dev, ABS_MT_PRESSURE, pres);
613 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
614 /* report this for backwards compatibility */
615 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
616
617 elantech_input_sync_v4(psmouse);
618}
619
620static void process_packet_motion_v4(struct psmouse *psmouse)
621{
622 struct input_dev *dev = psmouse->dev;
623 struct elantech_data *etd = psmouse->private;
624 unsigned char *packet = psmouse->packet;
625 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
626 int id, sid;
627
628 id = ((packet[0] & 0xe0) >> 5) - 1;
629 if (id < 0)
630 return;
631
632 sid = ((packet[3] & 0xe0) >> 5) - 1;
633 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
634 /*
635 * Motion packets give us the delta of x, y values of specific fingers,
636 * but in two's complement. Let the compiler do the conversion for us.
637 * Also _enlarge_ the numbers to int, in case of overflow.
638 */
639 delta_x1 = (signed char)packet[1];
640 delta_y1 = (signed char)packet[2];
641 delta_x2 = (signed char)packet[4];
642 delta_y2 = (signed char)packet[5];
643
644 etd->mt[id].x += delta_x1 * weight;
645 etd->mt[id].y -= delta_y1 * weight;
646 input_mt_slot(dev, id);
647 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
648 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
649
650 if (sid >= 0) {
651 etd->mt[sid].x += delta_x2 * weight;
652 etd->mt[sid].y -= delta_y2 * weight;
653 input_mt_slot(dev, sid);
654 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
655 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
656 }
657
658 elantech_input_sync_v4(psmouse);
659}
660
661static void elantech_report_absolute_v4(struct psmouse *psmouse,
662 int packet_type)
663{
664 switch (packet_type) {
665 case PACKET_V4_STATUS:
666 process_packet_status_v4(psmouse);
667 break;
668
669 case PACKET_V4_HEAD:
670 process_packet_head_v4(psmouse);
671 break;
672
673 case PACKET_V4_MOTION:
674 process_packet_motion_v4(psmouse);
675 break;
676
677 case PACKET_UNKNOWN:
678 default:
679 /* impossible to get here */
680 break;
681 }
682}
683
7894f21b 684static int elantech_packet_check_v1(struct psmouse *psmouse)
2a0bd75e
AO
685{
686 struct elantech_data *etd = psmouse->private;
687 unsigned char *packet = psmouse->packet;
688 unsigned char p1, p2, p3;
689
690 /* Parity bits are placed differently */
504e8bee 691 if (etd->fw_version < 0x020000) {
2a0bd75e
AO
692 /* byte 0: D U p1 p2 1 p3 R L */
693 p1 = (packet[0] & 0x20) >> 5;
694 p2 = (packet[0] & 0x10) >> 4;
695 } else {
696 /* byte 0: n1 n0 p2 p1 1 p3 R L */
697 p1 = (packet[0] & 0x10) >> 4;
698 p2 = (packet[0] & 0x20) >> 5;
699 }
700
701 p3 = (packet[0] & 0x04) >> 2;
702
703 return etd->parity[packet[1]] == p1 &&
704 etd->parity[packet[2]] == p2 &&
705 etd->parity[packet[3]] == p3;
706}
707
84a90b61
JD
708static int elantech_debounce_check_v2(struct psmouse *psmouse)
709{
710 /*
711 * When we encounter packet that matches this exactly, it means the
712 * hardware is in debounce status. Just ignore the whole packet.
713 */
714 const u8 debounce_packet[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
715 unsigned char *packet = psmouse->packet;
716
717 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
718}
719
7894f21b
JD
720static int elantech_packet_check_v2(struct psmouse *psmouse)
721{
722 struct elantech_data *etd = psmouse->private;
723 unsigned char *packet = psmouse->packet;
724
725 /*
726 * V2 hardware has two flavors. Older ones that do not report pressure,
727 * and newer ones that reports pressure and width. With newer ones, all
728 * packets (1, 2, 3 finger touch) have the same constant bits. With
729 * older ones, 1/3 finger touch packets and 2 finger touch packets
730 * have different constant bits.
731 * With all three cases, if the constant bits are not exactly what I
732 * expected, I consider them invalid.
733 */
734 if (etd->reports_pressure)
735 return (packet[0] & 0x0c) == 0x04 &&
736 (packet[3] & 0x0f) == 0x02;
737
738 if ((packet[0] & 0xc0) == 0x80)
739 return (packet[0] & 0x0c) == 0x0c &&
740 (packet[3] & 0x0e) == 0x08;
741
742 return (packet[0] & 0x3c) == 0x3c &&
743 (packet[1] & 0xf0) == 0x00 &&
744 (packet[3] & 0x3e) == 0x38 &&
745 (packet[4] & 0xf0) == 0x00;
746}
747
28f49616
JD
748/*
749 * We check the constant bits to determine what packet type we get,
1dc6edec 750 * so packet checking is mandatory for v3 and later hardware.
28f49616
JD
751 */
752static int elantech_packet_check_v3(struct psmouse *psmouse)
753{
acc0444b 754 struct elantech_data *etd = psmouse->private;
28f49616
JD
755 const u8 debounce_packet[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
756 unsigned char *packet = psmouse->packet;
757
758 /*
759 * check debounce first, it has the same signature in byte 0
760 * and byte 3 as PACKET_V3_HEAD.
761 */
762 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
763 return PACKET_DEBOUNCE;
764
acc0444b
MD
765 /*
766 * If the hardware flag 'crc_enabled' is set the packets have
767 * different signatures.
768 */
769 if (etd->crc_enabled) {
770 if ((packet[3] & 0x09) == 0x08)
771 return PACKET_V3_HEAD;
772
773 if ((packet[3] & 0x09) == 0x09)
774 return PACKET_V3_TAIL;
775 } else {
776 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
777 return PACKET_V3_HEAD;
28f49616 778
acc0444b
MD
779 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
780 return PACKET_V3_TAIL;
a2418fc4
UDB
781 if ((packet[3] & 0x0f) == 0x06)
782 return PACKET_TRACKPOINT;
acc0444b 783 }
28f49616
JD
784
785 return PACKET_UNKNOWN;
786}
787
1dc6edec
JD
788static int elantech_packet_check_v4(struct psmouse *psmouse)
789{
acc0444b 790 struct elantech_data *etd = psmouse->private;
1dc6edec 791 unsigned char *packet = psmouse->packet;
9eebed7d 792 unsigned char packet_type = packet[3] & 0x03;
acc0444b
MD
793 bool sanity_check;
794
caeb0d37
UDB
795 if ((packet[3] & 0x0f) == 0x06)
796 return PACKET_TRACKPOINT;
797
acc0444b
MD
798 /*
799 * Sanity check based on the constant bits of a packet.
800 * The constant bits change depending on the value of
801 * the hardware flag 'crc_enabled' but are the same for
802 * every packet, regardless of the type.
803 */
804 if (etd->crc_enabled)
805 sanity_check = ((packet[3] & 0x08) == 0x00);
806 else
807 sanity_check = ((packet[0] & 0x0c) == 0x04 &&
808 (packet[3] & 0x1c) == 0x10);
809
810 if (!sanity_check)
811 return PACKET_UNKNOWN;
1dc6edec 812
9eebed7d
MD
813 switch (packet_type) {
814 case 0:
815 return PACKET_V4_STATUS;
816
817 case 1:
1dc6edec
JD
818 return PACKET_V4_HEAD;
819
9eebed7d 820 case 2:
1dc6edec 821 return PACKET_V4_MOTION;
9eebed7d 822 }
1dc6edec
JD
823
824 return PACKET_UNKNOWN;
825}
826
2a0bd75e
AO
827/*
828 * Process byte stream from mouse and handle complete packets
829 */
830static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
831{
832 struct elantech_data *etd = psmouse->private;
28f49616 833 int packet_type;
2a0bd75e
AO
834
835 if (psmouse->pktcnt < psmouse->pktsize)
836 return PSMOUSE_GOOD_DATA;
837
838 if (etd->debug > 1)
b5d21704 839 elantech_packet_dump(psmouse);
2a0bd75e
AO
840
841 switch (etd->hw_version) {
842 case 1:
7894f21b 843 if (etd->paritycheck && !elantech_packet_check_v1(psmouse))
2a0bd75e
AO
844 return PSMOUSE_BAD_DATA;
845
846 elantech_report_absolute_v1(psmouse);
847 break;
848
849 case 2:
84a90b61
JD
850 /* ignore debounce */
851 if (elantech_debounce_check_v2(psmouse))
852 return PSMOUSE_FULL_PACKET;
853
7894f21b
JD
854 if (etd->paritycheck && !elantech_packet_check_v2(psmouse))
855 return PSMOUSE_BAD_DATA;
856
2a0bd75e
AO
857 elantech_report_absolute_v2(psmouse);
858 break;
28f49616
JD
859
860 case 3:
861 packet_type = elantech_packet_check_v3(psmouse);
a2418fc4
UDB
862 switch (packet_type) {
863 case PACKET_UNKNOWN:
28f49616
JD
864 return PSMOUSE_BAD_DATA;
865
a2418fc4
UDB
866 case PACKET_DEBOUNCE:
867 /* ignore debounce */
868 break;
869
870 case PACKET_TRACKPOINT:
871 elantech_report_trackpoint(psmouse, packet_type);
872 break;
873
874 default:
875 elantech_report_absolute_v3(psmouse, packet_type);
876 break;
877 }
878
28f49616 879 break;
1dc6edec
JD
880
881 case 4:
882 packet_type = elantech_packet_check_v4(psmouse);
caeb0d37
UDB
883 switch (packet_type) {
884 case PACKET_UNKNOWN:
1dc6edec
JD
885 return PSMOUSE_BAD_DATA;
886
caeb0d37
UDB
887 case PACKET_TRACKPOINT:
888 elantech_report_trackpoint(psmouse, packet_type);
889 break;
890
891 default:
892 elantech_report_absolute_v4(psmouse, packet_type);
893 break;
894 }
895
1dc6edec 896 break;
2a0bd75e
AO
897 }
898
899 return PSMOUSE_FULL_PACKET;
900}
901
902/*
903 * Put the touchpad into absolute mode
904 */
905static int elantech_set_absolute_mode(struct psmouse *psmouse)
906{
907 struct elantech_data *etd = psmouse->private;
908 unsigned char val;
909 int tries = ETP_READ_BACK_TRIES;
910 int rc = 0;
911
912 switch (etd->hw_version) {
913 case 1:
914 etd->reg_10 = 0x16;
915 etd->reg_11 = 0x8f;
916 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
917 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
918 rc = -1;
919 }
920 break;
921
922 case 2:
923 /* Windows driver values */
924 etd->reg_10 = 0x54;
925 etd->reg_11 = 0x88; /* 0x8a */
926 etd->reg_21 = 0x60; /* 0x00 */
927 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
928 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
929 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
930 rc = -1;
2a0bd75e 931 }
28f49616
JD
932 break;
933
934 case 3:
36189cc3
HG
935 if (etd->set_hw_resolution)
936 etd->reg_10 = 0x0b;
937 else
fb4f8f56 938 etd->reg_10 = 0x01;
36189cc3 939
28f49616
JD
940 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
941 rc = -1;
942
943 break;
1dc6edec
JD
944
945 case 4:
946 etd->reg_07 = 0x01;
947 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
948 rc = -1;
949
950 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
b2546df6
AO
951 }
952
953 if (rc == 0) {
2a0bd75e 954 /*
b2546df6
AO
955 * Read back reg 0x10. For hardware version 1 we must make
956 * sure the absolute mode bit is set. For hardware version 2
b5d21704 957 * the touchpad is probably initializing and not ready until
b2546df6 958 * we read back the value we just wrote.
2a0bd75e
AO
959 */
960 do {
961 rc = elantech_read_reg(psmouse, 0x10, &val);
962 if (rc == 0)
963 break;
964 tries--;
d4ae84a8 965 elantech_debug("retrying read (%d).\n", tries);
2a0bd75e
AO
966 msleep(ETP_READ_BACK_DELAY);
967 } while (tries > 0);
b2546df6
AO
968
969 if (rc) {
b5d21704
DT
970 psmouse_err(psmouse,
971 "failed to read back register 0x10.\n");
b2546df6
AO
972 } else if (etd->hw_version == 1 &&
973 !(val & ETP_R10_ABSOLUTE_MODE)) {
b5d21704
DT
974 psmouse_err(psmouse,
975 "touchpad refuses to switch to absolute mode.\n");
b2546df6
AO
976 rc = -1;
977 }
2a0bd75e
AO
978 }
979
1dc6edec 980 skip_readback_reg_10:
2a0bd75e 981 if (rc)
b5d21704 982 psmouse_err(psmouse, "failed to initialise registers.\n");
2a0bd75e
AO
983
984 return rc;
985}
986
28f49616
JD
987static int elantech_set_range(struct psmouse *psmouse,
988 unsigned int *x_min, unsigned int *y_min,
1dc6edec
JD
989 unsigned int *x_max, unsigned int *y_max,
990 unsigned int *width)
230282a7
JD
991{
992 struct elantech_data *etd = psmouse->private;
28f49616 993 unsigned char param[3];
1dc6edec 994 unsigned char traces;
230282a7
JD
995
996 switch (etd->hw_version) {
997 case 1:
998 *x_min = ETP_XMIN_V1;
999 *y_min = ETP_YMIN_V1;
1000 *x_max = ETP_XMAX_V1;
1001 *y_max = ETP_YMAX_V1;
1002 break;
1003
1004 case 2:
1005 if (etd->fw_version == 0x020800 ||
1006 etd->fw_version == 0x020b00 ||
1007 etd->fw_version == 0x020030) {
1008 *x_min = ETP_XMIN_V2;
1009 *y_min = ETP_YMIN_V2;
1010 *x_max = ETP_XMAX_V2;
1011 *y_max = ETP_YMAX_V2;
1012 } else {
84a90b61
JD
1013 int i;
1014 int fixed_dpi;
1015
230282a7
JD
1016 i = (etd->fw_version > 0x020800 &&
1017 etd->fw_version < 0x020900) ? 1 : 2;
84a90b61 1018
b56b92a9 1019 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
84a90b61
JD
1020 return -1;
1021
1022 fixed_dpi = param[1] & 0x10;
1023
1024 if (((etd->fw_version >> 16) == 0x14) && fixed_dpi) {
b56b92a9 1025 if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
84a90b61
JD
1026 return -1;
1027
1028 *x_max = (etd->capabilities[1] - i) * param[1] / 2;
1029 *y_max = (etd->capabilities[2] - i) * param[2] / 2;
1030 } else if (etd->fw_version == 0x040216) {
1031 *x_max = 819;
1032 *y_max = 405;
1033 } else if (etd->fw_version == 0x040219 || etd->fw_version == 0x040215) {
1034 *x_max = 900;
1035 *y_max = 500;
1036 } else {
1037 *x_max = (etd->capabilities[1] - i) * 64;
1038 *y_max = (etd->capabilities[2] - i) * 64;
1039 }
230282a7
JD
1040 }
1041 break;
28f49616
JD
1042
1043 case 3:
b56b92a9 1044 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
28f49616
JD
1045 return -1;
1046
1047 *x_max = (0x0f & param[0]) << 8 | param[1];
1048 *y_max = (0xf0 & param[0]) << 4 | param[2];
1049 break;
1dc6edec
JD
1050
1051 case 4:
b56b92a9 1052 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1dc6edec
JD
1053 return -1;
1054
1055 *x_max = (0x0f & param[0]) << 8 | param[1];
1056 *y_max = (0xf0 & param[0]) << 4 | param[2];
1057 traces = etd->capabilities[1];
1058 if ((traces < 2) || (traces > *x_max))
1059 return -1;
1060
1061 *width = *x_max / (traces - 1);
1062 break;
230282a7 1063 }
28f49616
JD
1064
1065 return 0;
230282a7
JD
1066}
1067
3d95fd6a
JD
1068/*
1069 * (value from firmware) * 10 + 790 = dpi
1070 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1071 */
1072static unsigned int elantech_convert_res(unsigned int val)
1073{
1074 return (val * 10 + 790) * 10 / 254;
1075}
1076
1077static int elantech_get_resolution_v4(struct psmouse *psmouse,
1078 unsigned int *x_res,
1079 unsigned int *y_res)
1080{
1081 unsigned char param[3];
1082
1083 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1084 return -1;
1085
1086 *x_res = elantech_convert_res(param[1] & 0x0f);
1087 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
1088
1089 return 0;
1090}
1091
c15bdfd5
HG
1092/*
1093 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1094 * fw_version for this is based on the following fw_version & caps table:
1095 *
1096 * Laptop-model: fw_version: caps: buttons:
1097 * Acer S3 0x461f00 10, 13, 0e clickpad
1098 * Acer S7-392 0x581f01 50, 17, 0d clickpad
1099 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1100 * Acer V5-551 0x461f00 ? clickpad
1101 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1102 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1103 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
1104 * Asus UX31 0x361f00 20, 15, 0e clickpad
1105 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1106 * Avatar AVIU-145A2 0x361f00 ? clickpad
a2418fc4 1107 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
c15bdfd5
HG
1108 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1109 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
a2418fc4 1110 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
c15bdfd5
HG
1111 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1112 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1113 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1114 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1115 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1116 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1117 * Samsung RF710 0x450f00 ? 2 hw buttons
1118 * System76 Pangolin 0x250f01 ? 2 hw buttons
1119 * (*) + 3 trackpoint buttons
a2418fc4
UDB
1120 * (**) + 0 trackpoint buttons
1121 * Note: Lenovo L430 and Lenovo L430 have the same fw_version/caps
c15bdfd5
HG
1122 */
1123static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1124{
1125 struct input_dev *dev = psmouse->dev;
1126 struct elantech_data *etd = psmouse->private;
1127
1128 if (etd->fw_version & 0x001000) {
1129 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1130 __clear_bit(BTN_RIGHT, dev->keybit);
1131 }
1132}
1133
2a0bd75e
AO
1134/*
1135 * Set the appropriate event bits for the input subsystem
1136 */
28f49616 1137static int elantech_set_input_params(struct psmouse *psmouse)
2a0bd75e
AO
1138{
1139 struct input_dev *dev = psmouse->dev;
1140 struct elantech_data *etd = psmouse->private;
1dc6edec 1141 unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
3d95fd6a 1142 unsigned int x_res = 0, y_res = 0;
230282a7 1143
1dc6edec 1144 if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
28f49616 1145 return -1;
2a0bd75e 1146
e3dde4fb 1147 __set_bit(INPUT_PROP_POINTER, dev->propbit);
2a0bd75e
AO
1148 __set_bit(EV_KEY, dev->evbit);
1149 __set_bit(EV_ABS, dev->evbit);
c7a1f3cc 1150 __clear_bit(EV_REL, dev->evbit);
2a0bd75e
AO
1151
1152 __set_bit(BTN_LEFT, dev->keybit);
1153 __set_bit(BTN_RIGHT, dev->keybit);
1154
1155 __set_bit(BTN_TOUCH, dev->keybit);
1156 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1157 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1158 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1159
1160 switch (etd->hw_version) {
1161 case 1:
1162 /* Rocker button */
504e8bee 1163 if (etd->fw_version < 0x020000 &&
230282a7 1164 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
2a0bd75e
AO
1165 __set_bit(BTN_FORWARD, dev->keybit);
1166 __set_bit(BTN_BACK, dev->keybit);
1167 }
230282a7
JD
1168 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1169 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
2a0bd75e
AO
1170 break;
1171
1172 case 2:
22462d9f 1173 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
28f49616
JD
1174 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1175 /* fall through */
1176 case 3:
c15bdfd5
HG
1177 if (etd->hw_version == 3)
1178 elantech_set_buttonpad_prop(psmouse);
230282a7
JD
1179 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1180 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
f941c705
ÉP
1181 if (etd->reports_pressure) {
1182 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1183 ETP_PMAX_V2, 0, 0);
1184 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1185 ETP_WMAX_V2, 0, 0);
1186 }
b4adbbef 1187 input_mt_init_slots(dev, 2, 0);
230282a7
JD
1188 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1189 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
2a0bd75e 1190 break;
1dc6edec
JD
1191
1192 case 4:
3d95fd6a
JD
1193 if (elantech_get_resolution_v4(psmouse, &x_res, &y_res)) {
1194 /*
1195 * if query failed, print a warning and leave the values
1196 * zero to resemble synaptics.c behavior.
1197 */
1198 psmouse_warn(psmouse, "couldn't query resolution data.\n");
1199 }
c15bdfd5 1200 elantech_set_buttonpad_prop(psmouse);
1dc6edec
JD
1201 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1202 /* For X to recognize me as touchpad. */
1203 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1204 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
3d95fd6a
JD
1205 input_abs_set_res(dev, ABS_X, x_res);
1206 input_abs_set_res(dev, ABS_Y, y_res);
1dc6edec
JD
1207 /*
1208 * range of pressure and width is the same as v2,
1209 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1210 */
1211 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1212 ETP_PMAX_V2, 0, 0);
1213 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1214 ETP_WMAX_V2, 0, 0);
1215 /* Multitouch capable pad, up to 5 fingers. */
b4adbbef 1216 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1dc6edec
JD
1217 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1218 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
3d95fd6a
JD
1219 input_abs_set_res(dev, ABS_MT_POSITION_X, x_res);
1220 input_abs_set_res(dev, ABS_MT_POSITION_Y, y_res);
1dc6edec
JD
1221 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1222 ETP_PMAX_V2, 0, 0);
1223 /*
1224 * The firmware reports how many trace lines the finger spans,
1225 * convert to surface unit as Protocol-B requires.
1226 */
1227 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1228 ETP_WMAX_V2 * width, 0, 0);
1229 break;
2a0bd75e 1230 }
230282a7
JD
1231
1232 etd->y_max = y_max;
1dc6edec 1233 etd->width = width;
28f49616
JD
1234
1235 return 0;
2a0bd75e
AO
1236}
1237
1238struct elantech_attr_data {
1239 size_t field_offset;
1240 unsigned char reg;
1241};
1242
1243/*
1244 * Display a register value by reading a sysfs entry
1245 */
1246static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1247 char *buf)
1248{
1249 struct elantech_data *etd = psmouse->private;
1250 struct elantech_attr_data *attr = data;
1251 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1252 int rc = 0;
1253
1254 if (attr->reg)
1255 rc = elantech_read_reg(psmouse, attr->reg, reg);
1256
1257 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1258}
1259
1260/*
1261 * Write a register value by writing a sysfs entry
1262 */
1263static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1264 void *data, const char *buf, size_t count)
1265{
1266 struct elantech_data *etd = psmouse->private;
1267 struct elantech_attr_data *attr = data;
1268 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
76496e7a 1269 unsigned char value;
2a0bd75e
AO
1270 int err;
1271
76496e7a 1272 err = kstrtou8(buf, 16, &value);
2a0bd75e
AO
1273 if (err)
1274 return err;
1275
2a0bd75e
AO
1276 /* Do we need to preserve some bits for version 2 hardware too? */
1277 if (etd->hw_version == 1) {
1278 if (attr->reg == 0x10)
1279 /* Force absolute mode always on */
1280 value |= ETP_R10_ABSOLUTE_MODE;
1281 else if (attr->reg == 0x11)
1282 /* Force 4 byte mode always on */
1283 value |= ETP_R11_4_BYTE_MODE;
1284 }
1285
1286 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1287 *reg = value;
1288
1289 return count;
1290}
1291
1292#define ELANTECH_INT_ATTR(_name, _register) \
1293 static struct elantech_attr_data elantech_attr_##_name = { \
1294 .field_offset = offsetof(struct elantech_data, _name), \
1295 .reg = _register, \
1296 }; \
1297 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1298 &elantech_attr_##_name, \
1299 elantech_show_int_attr, \
1300 elantech_set_int_attr)
1301
1dc6edec 1302ELANTECH_INT_ATTR(reg_07, 0x07);
2a0bd75e
AO
1303ELANTECH_INT_ATTR(reg_10, 0x10);
1304ELANTECH_INT_ATTR(reg_11, 0x11);
1305ELANTECH_INT_ATTR(reg_20, 0x20);
1306ELANTECH_INT_ATTR(reg_21, 0x21);
1307ELANTECH_INT_ATTR(reg_22, 0x22);
1308ELANTECH_INT_ATTR(reg_23, 0x23);
1309ELANTECH_INT_ATTR(reg_24, 0x24);
1310ELANTECH_INT_ATTR(reg_25, 0x25);
1311ELANTECH_INT_ATTR(reg_26, 0x26);
1312ELANTECH_INT_ATTR(debug, 0);
1313ELANTECH_INT_ATTR(paritycheck, 0);
1314
1315static struct attribute *elantech_attrs[] = {
1dc6edec 1316 &psmouse_attr_reg_07.dattr.attr,
2a0bd75e
AO
1317 &psmouse_attr_reg_10.dattr.attr,
1318 &psmouse_attr_reg_11.dattr.attr,
1319 &psmouse_attr_reg_20.dattr.attr,
1320 &psmouse_attr_reg_21.dattr.attr,
1321 &psmouse_attr_reg_22.dattr.attr,
1322 &psmouse_attr_reg_23.dattr.attr,
1323 &psmouse_attr_reg_24.dattr.attr,
1324 &psmouse_attr_reg_25.dattr.attr,
1325 &psmouse_attr_reg_26.dattr.attr,
1326 &psmouse_attr_debug.dattr.attr,
1327 &psmouse_attr_paritycheck.dattr.attr,
1328 NULL
1329};
1330
1331static struct attribute_group elantech_attr_group = {
1332 .attrs = elantech_attrs,
1333};
1334
a083632e
DT
1335static bool elantech_is_signature_valid(const unsigned char *param)
1336{
1337 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1338 int i;
1339
1340 if (param[0] == 0)
1341 return false;
1342
1343 if (param[1] == 0)
1344 return true;
1345
271329b3
HG
1346 /*
1347 * Some models have a revision higher then 20. Meaning param[2] may
1348 * be 10 or 20, skip the rates check for these.
1349 */
1350 if (param[0] == 0x46 && (param[1] & 0xef) == 0x0f && param[2] < 40)
1351 return true;
1352
a083632e
DT
1353 for (i = 0; i < ARRAY_SIZE(rates); i++)
1354 if (param[2] == rates[i])
1355 return false;
1356
1357 return true;
1358}
1359
2a0bd75e
AO
1360/*
1361 * Use magic knock to detect Elantech touchpad
1362 */
b7802c5c 1363int elantech_detect(struct psmouse *psmouse, bool set_properties)
2a0bd75e
AO
1364{
1365 struct ps2dev *ps2dev = &psmouse->ps2dev;
1366 unsigned char param[3];
1367
1368 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1369
1370 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1371 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1372 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1373 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1374 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
b5d21704 1375 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
2a0bd75e
AO
1376 return -1;
1377 }
1378
1379 /*
1380 * Report this in case there are Elantech models that use a different
1381 * set of magic numbers
1382 */
28f49616
JD
1383 if (param[0] != 0x3c || param[1] != 0x03 ||
1384 (param[2] != 0xc8 && param[2] != 0x00)) {
b5d21704
DT
1385 psmouse_dbg(psmouse,
1386 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1387 param[0], param[1], param[2]);
9ab7b25e
AO
1388 return -1;
1389 }
1390
1391 /*
1392 * Query touchpad's firmware version and see if it reports known
1393 * value to avoid mis-detection. Logitech mice are known to respond
1394 * to Elantech magic knock and there might be more.
1395 */
1396 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
b5d21704 1397 psmouse_dbg(psmouse, "failed to query firmware version.\n");
9ab7b25e
AO
1398 return -1;
1399 }
1400
b5d21704
DT
1401 psmouse_dbg(psmouse,
1402 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1403 param[0], param[1], param[2]);
9ab7b25e 1404
a083632e 1405 if (!elantech_is_signature_valid(param)) {
b5d21704
DT
1406 psmouse_dbg(psmouse,
1407 "Probably not a real Elantech touchpad. Aborting.\n");
4af61e90 1408 return -1;
2a0bd75e
AO
1409 }
1410
1411 if (set_properties) {
1412 psmouse->vendor = "Elantech";
1413 psmouse->name = "Touchpad";
1414 }
1415
1416 return 0;
1417}
1418
1419/*
1420 * Clean up sysfs entries when disconnecting
1421 */
1422static void elantech_disconnect(struct psmouse *psmouse)
1423{
a2418fc4
UDB
1424 struct elantech_data *etd = psmouse->private;
1425
1426 if (etd->tp_dev)
1427 input_unregister_device(etd->tp_dev);
2a0bd75e
AO
1428 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1429 &elantech_attr_group);
1430 kfree(psmouse->private);
1431 psmouse->private = NULL;
1432}
1433
1434/*
1435 * Put the touchpad back into absolute mode when reconnecting
1436 */
1437static int elantech_reconnect(struct psmouse *psmouse)
1438{
a67ada7a
JD
1439 psmouse_reset(psmouse);
1440
2a0bd75e
AO
1441 if (elantech_detect(psmouse, 0))
1442 return -1;
1443
1444 if (elantech_set_absolute_mode(psmouse)) {
b5d21704
DT
1445 psmouse_err(psmouse,
1446 "failed to put touchpad back into absolute mode.\n");
2a0bd75e
AO
1447 return -1;
1448 }
1449
1450 return 0;
1451}
1452
0dc15879
UDB
1453/*
1454 * Some hw_version 4 models do not work with crc_disabled
1455 */
1456static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1457#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1458 {
1459 /* Fujitsu H730 does not work with crc_enabled == 0 */
1460 .matches = {
1461 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1462 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1463 },
1464 },
1465#endif
1466 { }
1467};
1468
36189cc3 1469/*
fb4f8f56
HG
1470 * Some hw_version 3 models go into error state when we try to set
1471 * bit 3 and/or bit 1 of r10.
36189cc3
HG
1472 */
1473static const struct dmi_system_id no_hw_res_dmi_table[] = {
1474#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1475 {
1476 /* Gigabyte U2442 */
1477 .matches = {
1478 DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1479 DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1480 },
1481 },
1482#endif
1483 { }
1484};
1485
3c8bbb95
JD
1486/*
1487 * determine hardware version and set some properties according to it.
1488 */
28f49616 1489static int elantech_set_properties(struct elantech_data *etd)
3c8bbb95 1490{
3940d618 1491 /* This represents the version of IC body. */
1dc6edec
JD
1492 int ver = (etd->fw_version & 0x0f0000) >> 16;
1493
3940d618 1494 /* Early version of Elan touchpads doesn't obey the rule. */
3c8bbb95
JD
1495 if (etd->fw_version < 0x020030 || etd->fw_version == 0x020600)
1496 etd->hw_version = 1;
3940d618
JD
1497 else {
1498 switch (ver) {
1499 case 2:
1500 case 4:
1501 etd->hw_version = 2;
1502 break;
1503 case 5:
1504 etd->hw_version = 3;
1505 break;
1506 case 6:
9eebed7d 1507 case 7:
9cb80b96 1508 case 8:
ae4bedf0 1509 case 9:
3940d618
JD
1510 etd->hw_version = 4;
1511 break;
1512 default:
1513 return -1;
1514 }
1515 }
3c8bbb95 1516
b56b92a9
JD
1517 /* decide which send_cmd we're gonna use early */
1518 etd->send_cmd = etd->hw_version >= 3 ? elantech_send_cmd :
1519 synaptics_send_cmd;
1520
1521 /* Turn on packet checking by default */
3c8bbb95
JD
1522 etd->paritycheck = 1;
1523
1524 /*
1525 * This firmware suffers from misreporting coordinates when
1526 * a touch action starts causing the mouse cursor or scrolled page
1527 * to jump. Enable a workaround.
1528 */
1529 etd->jumpy_cursor =
1530 (etd->fw_version == 0x020022 || etd->fw_version == 0x020600);
1531
28f49616 1532 if (etd->hw_version > 1) {
3c8bbb95
JD
1533 /* For now show extra debug information */
1534 etd->debug = 1;
1535
1536 if (etd->fw_version >= 0x020800)
1537 etd->reports_pressure = true;
1538 }
28f49616 1539
acc0444b
MD
1540 /*
1541 * The signatures of v3 and v4 packets change depending on the
1542 * value of this hardware flag.
1543 */
0dc15879
UDB
1544 etd->crc_enabled = (etd->fw_version & 0x4000) == 0x4000 ||
1545 dmi_check_system(elantech_dmi_force_crc_enabled);
acc0444b 1546
36189cc3
HG
1547 /* Enable real hardware resolution on hw_version 3 ? */
1548 etd->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1549
28f49616 1550 return 0;
3c8bbb95
JD
1551}
1552
2a0bd75e
AO
1553/*
1554 * Initialize the touchpad and create sysfs entries
1555 */
1556int elantech_init(struct psmouse *psmouse)
1557{
1558 struct elantech_data *etd;
a2418fc4
UDB
1559 int i;
1560 int error = -EINVAL;
2a0bd75e 1561 unsigned char param[3];
a2418fc4 1562 struct input_dev *tp_dev;
2a0bd75e 1563
9ab7b25e 1564 psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
2a0bd75e 1565 if (!etd)
6792cbbb 1566 return -ENOMEM;
2a0bd75e 1567
a67ada7a
JD
1568 psmouse_reset(psmouse);
1569
2a0bd75e
AO
1570 etd->parity[0] = 1;
1571 for (i = 1; i < 256; i++)
1572 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1573
1574 /*
9ab7b25e 1575 * Do the version query again so we can store the result
2a0bd75e
AO
1576 */
1577 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
b5d21704 1578 psmouse_err(psmouse, "failed to query firmware version.\n");
2a0bd75e
AO
1579 goto init_fail;
1580 }
504e8bee 1581 etd->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
28f49616
JD
1582
1583 if (elantech_set_properties(etd)) {
b5d21704 1584 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
28f49616
JD
1585 goto init_fail;
1586 }
b5d21704
DT
1587 psmouse_info(psmouse,
1588 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1589 etd->hw_version, param[0], param[1], param[2]);
2a0bd75e 1590
b56b92a9 1591 if (etd->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
230282a7 1592 etd->capabilities)) {
b5d21704 1593 psmouse_err(psmouse, "failed to query capabilities.\n");
2a0bd75e
AO
1594 goto init_fail;
1595 }
b5d21704
DT
1596 psmouse_info(psmouse,
1597 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1598 etd->capabilities[0], etd->capabilities[1],
1599 etd->capabilities[2]);
2a0bd75e
AO
1600
1601 if (elantech_set_absolute_mode(psmouse)) {
b5d21704
DT
1602 psmouse_err(psmouse,
1603 "failed to put touchpad into absolute mode.\n");
2a0bd75e
AO
1604 goto init_fail;
1605 }
1606
28f49616 1607 if (elantech_set_input_params(psmouse)) {
b5d21704 1608 psmouse_err(psmouse, "failed to query touchpad range.\n");
28f49616
JD
1609 goto init_fail;
1610 }
2a0bd75e
AO
1611
1612 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1613 &elantech_attr_group);
1614 if (error) {
b5d21704
DT
1615 psmouse_err(psmouse,
1616 "failed to create sysfs attributes, error: %d.\n",
1617 error);
2a0bd75e
AO
1618 goto init_fail;
1619 }
1620
a2418fc4
UDB
1621 /* The MSB indicates the presence of the trackpoint */
1622 if ((etd->capabilities[0] & 0x80) == 0x80) {
1623 tp_dev = input_allocate_device();
1624
1625 if (!tp_dev) {
1626 error = -ENOMEM;
1627 goto init_fail_tp_alloc;
1628 }
1629
1630 etd->tp_dev = tp_dev;
1631 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1632 psmouse->ps2dev.serio->phys);
1633 tp_dev->phys = etd->tp_phys;
1634 tp_dev->name = "Elantech PS/2 TrackPoint";
1635 tp_dev->id.bustype = BUS_I8042;
1636 tp_dev->id.vendor = 0x0002;
1637 tp_dev->id.product = PSMOUSE_ELANTECH;
1638 tp_dev->id.version = 0x0000;
1639 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1640 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1641 tp_dev->relbit[BIT_WORD(REL_X)] =
1642 BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1643 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1644 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1645 BIT_MASK(BTN_RIGHT);
7611392f 1646
01d4cd5c 1647 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
7611392f
HG
1648 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1649
a2418fc4
UDB
1650 error = input_register_device(etd->tp_dev);
1651 if (error < 0)
1652 goto init_fail_tp_reg;
1653 }
1654
2a0bd75e
AO
1655 psmouse->protocol_handler = elantech_process_byte;
1656 psmouse->disconnect = elantech_disconnect;
1657 psmouse->reconnect = elantech_reconnect;
28f49616 1658 psmouse->pktsize = etd->hw_version > 1 ? 6 : 4;
2a0bd75e
AO
1659
1660 return 0;
a2418fc4
UDB
1661 init_fail_tp_reg:
1662 input_free_device(tp_dev);
1663 init_fail_tp_alloc:
1664 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1665 &elantech_attr_group);
2a0bd75e 1666 init_fail:
ac84eba2 1667 psmouse_reset(psmouse);
2a0bd75e 1668 kfree(etd);
a2418fc4 1669 return error;
2a0bd75e 1670}
This page took 0.312972 seconds and 5 git commands to generate.