projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Input: elantech - enable middle button of touchpads on ThinkPad P52
[linux-2.6-block.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 16#include <linux/module.h>
21c48dbd 17#include <linux/i2c.h>
2a0bd75e 18#include <linux/input.h>
89eec4d7 19#include <linux/input/mt.h>
21c48dbd 20#include <linux/platform_device.h>
2a0bd75e
AO		 21#include <linux/serio.h>
22#include <linux/libps2.h>
a2418fc4 23#include <asm/unaligned.h>
2a0bd75e
AO		 24#include "psmouse.h"
25#include "elantech.h"
21c48dbd 26#include "elan_i2c.h"
2a0bd75e 27
d4ae84a8
DT		 28#define elantech_debug(fmt, ...) \
29 do { \
f0787592 30 if (etd->info.debug) \
b5d21704
DT		 31 psmouse_printk(KERN_DEBUG, psmouse, \
32 fmt, ##__VA_ARGS__); \
2a0bd75e
AO		 33 } while (0)
34
35/*
36 * Send a Synaptics style sliced query command
37 */
38static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
39 unsigned char *param)
40{
08be954b 41 if (ps2_sliced_command(&psmouse->ps2dev, c) ||
2a0bd75e 42 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
b5d21704 43 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
2a0bd75e
AO		 44 return -1;
45 }
46
47 return 0;
48}
49
b56b92a9
JD		 50/*
51 * V3 and later support this fast command
52 */
53static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
54 unsigned char *param)
55{
56 struct ps2dev *ps2dev = &psmouse->ps2dev;
57
58 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
59 ps2_command(ps2dev, NULL, c) ||
60 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
61 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
62 return -1;
63 }
64
65 return 0;
66}
67
2a0bd75e
AO		 68/*
69 * A retrying version of ps2_command
70 */
71static int elantech_ps2_command(struct psmouse *psmouse,
72 unsigned char *param, int command)
73{
74 struct ps2dev *ps2dev = &psmouse->ps2dev;
75 struct elantech_data *etd = psmouse->private;
76 int rc;
77 int tries = ETP_PS2_COMMAND_TRIES;
78
79 do {
80 rc = ps2_command(ps2dev, param, command);
81 if (rc == 0)
82 break;
83 tries--;
d4ae84a8
DT		 84 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
85 command, tries);
2a0bd75e
AO		 86 msleep(ETP_PS2_COMMAND_DELAY);
87 } while (tries > 0);
88
89 if (rc)
b5d21704 90 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
2a0bd75e
AO		 91
92 return rc;
93}
94
95/*
96 * Send an Elantech style special command to read a value from a register
97 */
98static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
99 unsigned char *val)
100{
101 struct elantech_data *etd = psmouse->private;
102 unsigned char param[3];
103 int rc = 0;
104
1dc6edec 105 if (reg < 0x07 || reg > 0x26)
2a0bd75e
AO		 106 return -1;
107
108 if (reg > 0x11 && reg < 0x20)
109 return -1;
110
f0787592 111 switch (etd->info.hw_version) {
2a0bd75e 112 case 1:
08be954b
DT		 113 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_READ) ||
114 ps2_sliced_command(&psmouse->ps2dev, reg) ||
2a0bd75e
AO		 115 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
116 rc = -1;
117 }
118 break;
119
120 case 2:
121 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
122 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
123 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
124 elantech_ps2_command(psmouse, NULL, reg) ||
125 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
126 rc = -1;
127 }
128 break;
28f49616 129
1dc6edec 130 case 3 ... 4:
28f49616
JD		 131 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
132 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
133 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
134 elantech_ps2_command(psmouse, NULL, reg) ||
135 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
136 rc = -1;
137 }
138 break;
2a0bd75e
AO		 139 }
140
141 if (rc)
b5d21704 142 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
f0787592 143 else if (etd->info.hw_version != 4)
2a0bd75e 144 *val = param[0];
1dc6edec
JD		 145 else
146 *val = param[1];
2a0bd75e
AO		 147
148 return rc;
149}
150
151/*
152 * Send an Elantech style special command to write a register with a value
153 */
154static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
155 unsigned char val)
156{
157 struct elantech_data *etd = psmouse->private;
158 int rc = 0;
159
1dc6edec 160 if (reg < 0x07 || reg > 0x26)
2a0bd75e
AO		 161 return -1;
162
163 if (reg > 0x11 && reg < 0x20)
164 return -1;
165
f0787592 166 switch (etd->info.hw_version) {
2a0bd75e 167 case 1:
08be954b
DT		 168 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_WRITE) ||
169 ps2_sliced_command(&psmouse->ps2dev, reg) ||
170 ps2_sliced_command(&psmouse->ps2dev, val) ||
2a0bd75e
AO		 171 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
172 rc = -1;
173 }
174 break;
175
176 case 2:
177 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
178 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
179 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
180 elantech_ps2_command(psmouse, NULL, reg) ||
181 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
182 elantech_ps2_command(psmouse, NULL, val) ||
183 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
184 rc = -1;
185 }
186 break;
28f49616
JD		 187
188 case 3:
189 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
190 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
191 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
192 elantech_ps2_command(psmouse, NULL, reg) ||
193 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
194 elantech_ps2_command(psmouse, NULL, val) ||
195 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
196 rc = -1;
197 }
198 break;
1dc6edec
JD		 199
200 case 4:
201 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
202 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
203 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
204 elantech_ps2_command(psmouse, NULL, reg) ||
205 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
206 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
207 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
208 elantech_ps2_command(psmouse, NULL, val) ||
209 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
210 rc = -1;
211 }
212 break;
2a0bd75e
AO		 213 }
214
215 if (rc)
b5d21704
DT		 216 psmouse_err(psmouse,
217 "failed to write register 0x%02x with value 0x%02x.\n",
218 reg, val);
2a0bd75e
AO		 219
220 return rc;
221}
222
223/*
224 * Dump a complete mouse movement packet to the syslog
225 */
b5d21704 226static void elantech_packet_dump(struct psmouse *psmouse)
2a0bd75e 227{
014420fe
BT		 228 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [%*ph]\n",
229 psmouse->pktsize, psmouse->packet);
2a0bd75e
AO		 230}
231
232/*
233 * Interpret complete data packets and report absolute mode input events for
234 * hardware version 1. (4 byte packets)
235 */
236static void elantech_report_absolute_v1(struct psmouse *psmouse)
237{
238 struct input_dev *dev = psmouse->dev;
239 struct elantech_data *etd = psmouse->private;
240 unsigned char *packet = psmouse->packet;
241 int fingers;
242
f0787592 243 if (etd->info.fw_version < 0x020000) {
e938fbfd
FR		 244 /*
245 * byte 0: D U p1 p2 1 p3 R L
246 * byte 1: f 0 th tw x9 x8 y9 y8
247 */
2a0bd75e
AO		 248 fingers = ((packet[1] & 0x80) >> 7) +
249 ((packet[1] & 0x30) >> 4);
250 } else {
e938fbfd
FR		 251 /*
252 * byte 0: n1 n0 p2 p1 1 p3 R L
253 * byte 1: 0 0 0 0 x9 x8 y9 y8
254 */
2a0bd75e
AO		 255 fingers = (packet[0] & 0xc0) >> 6;
256 }
257
f0787592 258 if (etd->info.jumpy_cursor) {
7f29f17b
ÉP		 259 if (fingers != 1) {
260 etd->single_finger_reports = 0;
261 } else if (etd->single_finger_reports < 2) {
262 /* Discard first 2 reports of one finger, bogus */
263 etd->single_finger_reports++;
d4ae84a8 264 elantech_debug("discarding packet\n");
7f29f17b 265 return;
3f8c0df4
AO		 266 }
267 }
268
2a0bd75e
AO		 269 input_report_key(dev, BTN_TOUCH, fingers != 0);
270
e938fbfd
FR		 271 /*
272 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
273 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
274 */
2a0bd75e
AO		 275 if (fingers) {
276 input_report_abs(dev, ABS_X,
277 ((packet[1] & 0x0c) << 6) | packet[2]);
e938fbfd 278 input_report_abs(dev, ABS_Y,
230282a7 279 etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
2a0bd75e
AO		 280 }
281
282 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
283 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
284 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
1ef85805
DT		 285
286 psmouse_report_standard_buttons(dev, packet[0]);
2a0bd75e 287
f0787592
BT		 288 if (etd->info.fw_version < 0x020000 &&
289 (etd->info.capabilities[0] & ETP_CAP_HAS_ROCKER)) {
2a0bd75e
AO		 290 /* rocker up */
291 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
292 /* rocker down */
293 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
294 }
295
296 input_sync(dev);
297}
298
89eec4d7
ÉP		 299static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
300 unsigned int x, unsigned int y)
301{
302 input_mt_slot(dev, slot);
303 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
304 if (active) {
305 input_report_abs(dev, ABS_MT_POSITION_X, x);
306 input_report_abs(dev, ABS_MT_POSITION_Y, y);
307 }
308}
309
310/* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
311static void elantech_report_semi_mt_data(struct input_dev *dev,
312 unsigned int num_fingers,
313 unsigned int x1, unsigned int y1,
314 unsigned int x2, unsigned int y2)
315{
316 elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
3c0213d1 317 elantech_set_slot(dev, 1, num_fingers >= 2, x2, y2);
89eec4d7
ÉP		 318}
319
2a0bd75e
AO		 320/*
321 * Interpret complete data packets and report absolute mode input events for
322 * hardware version 2. (6 byte packets)
323 */
324static void elantech_report_absolute_v2(struct psmouse *psmouse)
325{
f941c705 326 struct elantech_data *etd = psmouse->private;
2a0bd75e
AO		 327 struct input_dev *dev = psmouse->dev;
328 unsigned char *packet = psmouse->packet;
461a7917
JD		 329 unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
330 unsigned int width = 0, pres = 0;
2a0bd75e
AO		 331
332 /* byte 0: n1 n0 . . . . R L */
333 fingers = (packet[0] & 0xc0) >> 6;
2a0bd75e
AO		 334
335 switch (fingers) {
22462d9f
ÉP		 336 case 3:
337 /*
338 * Same as one finger, except report of more than 3 fingers:
339 * byte 3: n4 . w1 w0 . . . .
340 */
341 if (packet[3] & 0x80)
342 fingers = 4;
343 /* pass through... */
2a0bd75e 344 case 1:
e938fbfd 345 /*
11559619 346 * byte 1: . . . . x11 x10 x9 x8
e938fbfd
FR		 347 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
348 */
11559619 349 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
e938fbfd 350 /*
11559619 351 * byte 4: . . . . y11 y10 y9 y8
e938fbfd
FR		 352 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
353 */
230282a7 354 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
89eec4d7 355
f941c705
ÉP		 356 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
357 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
2a0bd75e
AO		 358 break;
359
360 case 2:
e938fbfd
FR		 361 /*
362 * The coordinate of each finger is reported separately
363 * with a lower resolution for two finger touches:
364 * byte 0: . . ay8 ax8 . . . .
365 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
366 */
461a7917 367 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
2a0bd75e 368 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
230282a7 369 y1 = etd->y_max -
461a7917 370 ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
e938fbfd
FR		 371 /*
372 * byte 3: . . by8 bx8 . . . .
373 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
374 */
461a7917 375 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
2a0bd75e 376 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
230282a7 377 y2 = etd->y_max -
461a7917 378 ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
f941c705
ÉP		 379
380 /* Unknown so just report sensible values */
381 pres = 127;
382 width = 7;
2a0bd75e
AO		 383 break;
384 }
385
461a7917
JD		 386 input_report_key(dev, BTN_TOUCH, fingers != 0);
387 if (fingers != 0) {
388 input_report_abs(dev, ABS_X, x1);
389 input_report_abs(dev, ABS_Y, y1);
390 }
89eec4d7 391 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
2a0bd75e
AO		 392 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
393 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
394 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
22462d9f 395 input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
1ef85805 396 psmouse_report_standard_buttons(dev, packet[0]);
f0787592 397 if (etd->info.reports_pressure) {
f941c705
ÉP		 398 input_report_abs(dev, ABS_PRESSURE, pres);
399 input_report_abs(dev, ABS_TOOL_WIDTH, width);
400 }
2a0bd75e
AO		 401
402 input_sync(dev);
403}
404
a2418fc4
UDB		 405static void elantech_report_trackpoint(struct psmouse *psmouse,
406 int packet_type)
407{
408 /*
409 * byte 0: 0 0 sx sy 0 M R L
410 * byte 1:~sx 0 0 0 0 0 0 0
411 * byte 2:~sy 0 0 0 0 0 0 0
412 * byte 3: 0 0 ~sy ~sx 0 1 1 0
413 * byte 4: x7 x6 x5 x4 x3 x2 x1 x0
414 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
415 *
416 * x and y are written in two's complement spread
417 * over 9 bits with sx/sy the relative top bit and
418 * x7..x0 and y7..y0 the lower bits.
419 * The sign of y is opposite to what the input driver
420 * expects for a relative movement
421 */
422
423 struct elantech_data *etd = psmouse->private;
424 struct input_dev *tp_dev = etd->tp_dev;
425 unsigned char *packet = psmouse->packet;
426 int x, y;
427 u32 t;
428
a2418fc4
UDB		 429 t = get_unaligned_le32(&packet[0]);
430
431 switch (t & ~7U) {
432 case 0x06000030U:
433 case 0x16008020U:
434 case 0x26800010U:
435 case 0x36808000U:
436 x = packet[4] - (int)((packet[1]^0x80) << 1);
437 y = (int)((packet[2]^0x80) << 1) - packet[5];
438
1ef85805 439 psmouse_report_standard_buttons(tp_dev, packet[0]);
a2418fc4
UDB		 440
441 input_report_rel(tp_dev, REL_X, x);
442 input_report_rel(tp_dev, REL_Y, y);
443
444 input_sync(tp_dev);
445
446 break;
447
448 default:
449 /* Dump unexpected packet sequences if debug=1 (default) */
f0787592 450 if (etd->info.debug == 1)
a2418fc4
UDB		 451 elantech_packet_dump(psmouse);
452
453 break;
454 }
455}
456
28f49616
JD		 457/*
458 * Interpret complete data packets and report absolute mode input events for
459 * hardware version 3. (12 byte packets for two fingers)
460 */
461static void elantech_report_absolute_v3(struct psmouse *psmouse,
462 int packet_type)
463{
464 struct input_dev *dev = psmouse->dev;
465 struct elantech_data *etd = psmouse->private;
466 unsigned char *packet = psmouse->packet;
467 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
468 unsigned int width = 0, pres = 0;
469
470 /* byte 0: n1 n0 . . . . R L */
471 fingers = (packet[0] & 0xc0) >> 6;
472
473 switch (fingers) {
474 case 3:
475 case 1:
476 /*
477 * byte 1: . . . . x11 x10 x9 x8
478 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
479 */
480 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
481 /*
482 * byte 4: . . . . y11 y10 y9 y8
483 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
484 */
485 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
486 break;
487
488 case 2:
489 if (packet_type == PACKET_V3_HEAD) {
490 /*
491 * byte 1: . . . . ax11 ax10 ax9 ax8
492 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
493 */
1dc6edec 494 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
28f49616
JD		 495 /*
496 * byte 4: . . . . ay11 ay10 ay9 ay8
497 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
498 */
1dc6edec 499 etd->mt[0].y = etd->y_max -
28f49616
JD		 500 (((packet[4] & 0x0f) << 8) | packet[5]);
501 /*
502 * wait for next packet
503 */
504 return;
505 }
506
507 /* packet_type == PACKET_V3_TAIL */
1dc6edec
JD		 508 x1 = etd->mt[0].x;
509 y1 = etd->mt[0].y;
28f49616
JD		 510 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
511 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
512 break;
513 }
514
515 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
516 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
517
518 input_report_key(dev, BTN_TOUCH, fingers != 0);
519 if (fingers != 0) {
520 input_report_abs(dev, ABS_X, x1);
521 input_report_abs(dev, ABS_Y, y1);
522 }
523 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
524 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
525 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
526 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
cd9e83e2
HG		 527
528 /* For clickpads map both buttons to BTN_LEFT */
f0787592 529 if (etd->info.fw_version & 0x001000)
cd9e83e2 530 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
1ef85805
DT		 531 else
532 psmouse_report_standard_buttons(dev, packet[0]);
cd9e83e2 533
28f49616
JD		 534 input_report_abs(dev, ABS_PRESSURE, pres);
535 input_report_abs(dev, ABS_TOOL_WIDTH, width);
536
537 input_sync(dev);
538}
539
1dc6edec
JD		 540static void elantech_input_sync_v4(struct psmouse *psmouse)
541{
542 struct input_dev *dev = psmouse->dev;
cd9e83e2 543 struct elantech_data *etd = psmouse->private;
1dc6edec
JD		 544 unsigned char *packet = psmouse->packet;
545
cd9e83e2 546 /* For clickpads map both buttons to BTN_LEFT */
f0787592 547 if (etd->info.fw_version & 0x001000)
cd9e83e2 548 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
1ef85805
DT		 549 else
550 psmouse_report_standard_buttons(dev, packet[0]);
cd9e83e2 551
1dc6edec
JD		 552 input_mt_report_pointer_emulation(dev, true);
553 input_sync(dev);
554}
555
556static void process_packet_status_v4(struct psmouse *psmouse)
557{
558 struct input_dev *dev = psmouse->dev;
559 unsigned char *packet = psmouse->packet;
560 unsigned fingers;
561 int i;
562
563 /* notify finger state change */
564 fingers = packet[1] & 0x1f;
565 for (i = 0; i < ETP_MAX_FINGERS; i++) {
566 if ((fingers & (1 << i)) == 0) {
567 input_mt_slot(dev, i);
568 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
569 }
570 }
571
572 elantech_input_sync_v4(psmouse);
573}
574
575static void process_packet_head_v4(struct psmouse *psmouse)
576{
577 struct input_dev *dev = psmouse->dev;
578 struct elantech_data *etd = psmouse->private;
579 unsigned char *packet = psmouse->packet;
580 int id = ((packet[3] & 0xe0) >> 5) - 1;
581 int pres, traces;
582
583 if (id < 0)
584 return;
585
586 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
587 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
588 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
589 traces = (packet[0] & 0xf0) >> 4;
590
591 input_mt_slot(dev, id);
592 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
593
594 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
595 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
596 input_report_abs(dev, ABS_MT_PRESSURE, pres);
597 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
598 /* report this for backwards compatibility */
599 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
600
601 elantech_input_sync_v4(psmouse);
602}
603
604static void process_packet_motion_v4(struct psmouse *psmouse)
605{
606 struct input_dev *dev = psmouse->dev;
607 struct elantech_data *etd = psmouse->private;
608 unsigned char *packet = psmouse->packet;
609 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
610 int id, sid;
611
612 id = ((packet[0] & 0xe0) >> 5) - 1;
613 if (id < 0)
614 return;
615
616 sid = ((packet[3] & 0xe0) >> 5) - 1;
617 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
618 /*
619 * Motion packets give us the delta of x, y values of specific fingers,
620 * but in two's complement. Let the compiler do the conversion for us.
621 * Also _enlarge_ the numbers to int, in case of overflow.
622 */
623 delta_x1 = (signed char)packet[1];
624 delta_y1 = (signed char)packet[2];
625 delta_x2 = (signed char)packet[4];
626 delta_y2 = (signed char)packet[5];
627
628 etd->mt[id].x += delta_x1 * weight;
629 etd->mt[id].y -= delta_y1 * weight;
630 input_mt_slot(dev, id);
631 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
632 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
633
634 if (sid >= 0) {
635 etd->mt[sid].x += delta_x2 * weight;
636 etd->mt[sid].y -= delta_y2 * weight;
637 input_mt_slot(dev, sid);
638 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
639 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
640 }
641
642 elantech_input_sync_v4(psmouse);
643}
644
645static void elantech_report_absolute_v4(struct psmouse *psmouse,
646 int packet_type)
647{
648 switch (packet_type) {
649 case PACKET_V4_STATUS:
650 process_packet_status_v4(psmouse);
651 break;
652
653 case PACKET_V4_HEAD:
654 process_packet_head_v4(psmouse);
655 break;
656
657 case PACKET_V4_MOTION:
658 process_packet_motion_v4(psmouse);
659 break;
660
661 case PACKET_UNKNOWN:
662 default:
663 /* impossible to get here */
664 break;
665 }
666}
667
7894f21b 668static int elantech_packet_check_v1(struct psmouse *psmouse)
2a0bd75e
AO		 669{
670 struct elantech_data *etd = psmouse->private;
671 unsigned char *packet = psmouse->packet;
672 unsigned char p1, p2, p3;
673
674 /* Parity bits are placed differently */
f0787592 675 if (etd->info.fw_version < 0x020000) {
2a0bd75e
AO		 676 /* byte 0: D U p1 p2 1 p3 R L */
677 p1 = (packet[0] & 0x20) >> 5;
678 p2 = (packet[0] & 0x10) >> 4;
679 } else {
680 /* byte 0: n1 n0 p2 p1 1 p3 R L */
681 p1 = (packet[0] & 0x10) >> 4;
682 p2 = (packet[0] & 0x20) >> 5;
683 }
684
685 p3 = (packet[0] & 0x04) >> 2;
686
687 return etd->parity[packet[1]] == p1 &&
688 etd->parity[packet[2]] == p2 &&
689 etd->parity[packet[3]] == p3;
690}
691
84a90b61
JD		 692static int elantech_debounce_check_v2(struct psmouse *psmouse)
693{
694 /*
695 * When we encounter packet that matches this exactly, it means the
696 * hardware is in debounce status. Just ignore the whole packet.
697 */
4f1b461d
CIK		 698 static const u8 debounce_packet[] = {
699 0x84, 0xff, 0xff, 0x02, 0xff, 0xff
700 };
84a90b61
JD		 701 unsigned char *packet = psmouse->packet;
702
703 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
704}
705
7894f21b
JD		 706static int elantech_packet_check_v2(struct psmouse *psmouse)
707{
708 struct elantech_data *etd = psmouse->private;
709 unsigned char *packet = psmouse->packet;
710
711 /*
712 * V2 hardware has two flavors. Older ones that do not report pressure,
713 * and newer ones that reports pressure and width. With newer ones, all
714 * packets (1, 2, 3 finger touch) have the same constant bits. With
715 * older ones, 1/3 finger touch packets and 2 finger touch packets
716 * have different constant bits.
717 * With all three cases, if the constant bits are not exactly what I
718 * expected, I consider them invalid.
719 */
f0787592 720 if (etd->info.reports_pressure)
7894f21b
JD		 721 return (packet[0] & 0x0c) == 0x04 &&
722 (packet[3] & 0x0f) == 0x02;
723
724 if ((packet[0] & 0xc0) == 0x80)
725 return (packet[0] & 0x0c) == 0x0c &&
726 (packet[3] & 0x0e) == 0x08;
727
728 return (packet[0] & 0x3c) == 0x3c &&
729 (packet[1] & 0xf0) == 0x00 &&
730 (packet[3] & 0x3e) == 0x38 &&
731 (packet[4] & 0xf0) == 0x00;
732}
733
28f49616
JD		 734/*
735 * We check the constant bits to determine what packet type we get,
1dc6edec 736 * so packet checking is mandatory for v3 and later hardware.
28f49616
JD		 737 */
738static int elantech_packet_check_v3(struct psmouse *psmouse)
739{
acc0444b 740 struct elantech_data *etd = psmouse->private;
4f1b461d
CIK		 741 static const u8 debounce_packet[] = {
742 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff
743 };
28f49616
JD		 744 unsigned char *packet = psmouse->packet;
745
746 /*
747 * check debounce first, it has the same signature in byte 0
748 * and byte 3 as PACKET_V3_HEAD.
749 */
750 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
751 return PACKET_DEBOUNCE;
752
acc0444b
MD		 753 /*
754 * If the hardware flag 'crc_enabled' is set the packets have
755 * different signatures.
756 */
f0787592 757 if (etd->info.crc_enabled) {
acc0444b
MD		 758 if ((packet[3] & 0x09) == 0x08)
759 return PACKET_V3_HEAD;
760
761 if ((packet[3] & 0x09) == 0x09)
762 return PACKET_V3_TAIL;
763 } else {
764 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
765 return PACKET_V3_HEAD;
28f49616 766
acc0444b
MD		 767 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
768 return PACKET_V3_TAIL;
a2418fc4
UDB		 769 if ((packet[3] & 0x0f) == 0x06)
770 return PACKET_TRACKPOINT;
acc0444b 771 }
28f49616
JD		 772
773 return PACKET_UNKNOWN;
774}
775
1dc6edec
JD		 776static int elantech_packet_check_v4(struct psmouse *psmouse)
777{
acc0444b 778 struct elantech_data *etd = psmouse->private;
1dc6edec 779 unsigned char *packet = psmouse->packet;
9eebed7d 780 unsigned char packet_type = packet[3] & 0x03;
6b30c73e 781 unsigned int ic_version;
acc0444b
MD		 782 bool sanity_check;
783
d0ab5478 784 if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
caeb0d37
UDB		 785 return PACKET_TRACKPOINT;
786
6b30c73e 787 /* This represents the version of IC body. */
f0787592 788 ic_version = (etd->info.fw_version & 0x0f0000) >> 16;
6b30c73e 789
acc0444b
MD		 790 /*
791 * Sanity check based on the constant bits of a packet.
792 * The constant bits change depending on the value of
6b30c73e
DL		 793 * the hardware flag 'crc_enabled' and the version of
794 * the IC body, but are the same for every packet,
795 * regardless of the type.
acc0444b 796 */
f0787592 797 if (etd->info.crc_enabled)
acc0444b 798 sanity_check = ((packet[3] & 0x08) == 0x00);
f0787592 799 else if (ic_version == 7 && etd->info.samples[1] == 0x2A)
6b30c73e 800 sanity_check = ((packet[3] & 0x1c) == 0x10);
acc0444b
MD		 801 else
802 sanity_check = ((packet[0] & 0x0c) == 0x04 &&
803 (packet[3] & 0x1c) == 0x10);
804
805 if (!sanity_check)
806 return PACKET_UNKNOWN;
1dc6edec 807
9eebed7d
MD		 808 switch (packet_type) {
809 case 0:
810 return PACKET_V4_STATUS;
811
812 case 1:
1dc6edec
JD		 813 return PACKET_V4_HEAD;
814
9eebed7d 815 case 2:
1dc6edec 816 return PACKET_V4_MOTION;
9eebed7d 817 }
1dc6edec
JD		 818
819 return PACKET_UNKNOWN;
820}
821
2a0bd75e
AO		 822/*
823 * Process byte stream from mouse and handle complete packets
824 */
825static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
826{
827 struct elantech_data *etd = psmouse->private;
28f49616 828 int packet_type;
2a0bd75e
AO		 829
830 if (psmouse->pktcnt < psmouse->pktsize)
831 return PSMOUSE_GOOD_DATA;
832
f0787592 833 if (etd->info.debug > 1)
b5d21704 834 elantech_packet_dump(psmouse);
2a0bd75e 835
f0787592 836 switch (etd->info.hw_version) {
2a0bd75e 837 case 1:
f0787592 838 if (etd->info.paritycheck && !elantech_packet_check_v1(psmouse))
2a0bd75e
AO		 839 return PSMOUSE_BAD_DATA;
840
841 elantech_report_absolute_v1(psmouse);
842 break;
843
844 case 2:
84a90b61
JD		 845 /* ignore debounce */
846 if (elantech_debounce_check_v2(psmouse))
847 return PSMOUSE_FULL_PACKET;
848
f0787592 849 if (etd->info.paritycheck && !elantech_packet_check_v2(psmouse))
7894f21b
JD		 850 return PSMOUSE_BAD_DATA;
851
2a0bd75e
AO		 852 elantech_report_absolute_v2(psmouse);
853 break;
28f49616
JD		 854
855 case 3:
856 packet_type = elantech_packet_check_v3(psmouse);
a2418fc4
UDB		 857 switch (packet_type) {
858 case PACKET_UNKNOWN:
28f49616
JD		 859 return PSMOUSE_BAD_DATA;
860
a2418fc4
UDB		 861 case PACKET_DEBOUNCE:
862 /* ignore debounce */
863 break;
864
865 case PACKET_TRACKPOINT:
866 elantech_report_trackpoint(psmouse, packet_type);
867 break;
868
869 default:
870 elantech_report_absolute_v3(psmouse, packet_type);
871 break;
872 }
873
28f49616 874 break;
1dc6edec
JD		 875
876 case 4:
877 packet_type = elantech_packet_check_v4(psmouse);
caeb0d37
UDB		 878 switch (packet_type) {
879 case PACKET_UNKNOWN:
1dc6edec
JD		 880 return PSMOUSE_BAD_DATA;
881
caeb0d37
UDB		 882 case PACKET_TRACKPOINT:
883 elantech_report_trackpoint(psmouse, packet_type);
884 break;
885
886 default:
887 elantech_report_absolute_v4(psmouse, packet_type);
888 break;
889 }
890
1dc6edec 891 break;
2a0bd75e
AO		 892 }
893
894 return PSMOUSE_FULL_PACKET;
895}
896
bd884149
UDB		 897/*
898 * This writes the reg_07 value again to the hardware at the end of every
899 * set_rate call because the register loses its value. reg_07 allows setting
900 * absolute mode on v4 hardware
901 */
902static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
903 unsigned int rate)
904{
905 struct elantech_data *etd = psmouse->private;
906
907 etd->original_set_rate(psmouse, rate);
908 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
909 psmouse_err(psmouse, "restoring reg_07 failed\n");
910}
911
2a0bd75e
AO		 912/*
913 * Put the touchpad into absolute mode
914 */
915static int elantech_set_absolute_mode(struct psmouse *psmouse)
916{
917 struct elantech_data *etd = psmouse->private;
918 unsigned char val;
919 int tries = ETP_READ_BACK_TRIES;
920 int rc = 0;
921
f0787592 922 switch (etd->info.hw_version) {
2a0bd75e
AO		 923 case 1:
924 etd->reg_10 = 0x16;
925 etd->reg_11 = 0x8f;
926 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
927 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
928 rc = -1;
929 }
930 break;
931
932 case 2:
933 /* Windows driver values */
934 etd->reg_10 = 0x54;
935 etd->reg_11 = 0x88; /* 0x8a */
936 etd->reg_21 = 0x60; /* 0x00 */
937 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
938 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
939 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
940 rc = -1;
2a0bd75e 941 }
28f49616
JD		 942 break;
943
944 case 3:
f0787592 945 if (etd->info.set_hw_resolution)
36189cc3
HG		 946 etd->reg_10 = 0x0b;
947 else
fb4f8f56 948 etd->reg_10 = 0x01;
36189cc3 949
28f49616
JD		 950 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
951 rc = -1;
952
953 break;
1dc6edec
JD		 954
955 case 4:
956 etd->reg_07 = 0x01;
957 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
958 rc = -1;
959
960 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
b2546df6
AO		 961 }
962
963 if (rc == 0) {
2a0bd75e 964 /*
b2546df6
AO		 965 * Read back reg 0x10. For hardware version 1 we must make
966 * sure the absolute mode bit is set. For hardware version 2
b5d21704 967 * the touchpad is probably initializing and not ready until
b2546df6 968 * we read back the value we just wrote.
2a0bd75e
AO		 969 */
970 do {
971 rc = elantech_read_reg(psmouse, 0x10, &val);
972 if (rc == 0)
973 break;
974 tries--;
d4ae84a8 975 elantech_debug("retrying read (%d).\n", tries);
2a0bd75e
AO		 976 msleep(ETP_READ_BACK_DELAY);
977 } while (tries > 0);
b2546df6
AO		 978
979 if (rc) {
b5d21704
DT		 980 psmouse_err(psmouse,
981 "failed to read back register 0x10.\n");
f0787592 982 } else if (etd->info.hw_version == 1 &&
b2546df6 983 !(val & ETP_R10_ABSOLUTE_MODE)) {
b5d21704
DT		 984 psmouse_err(psmouse,
985 "touchpad refuses to switch to absolute mode.\n");
b2546df6
AO		 986 rc = -1;
987 }
2a0bd75e
AO		 988 }
989
1dc6edec 990 skip_readback_reg_10:
2a0bd75e 991 if (rc)
b5d21704 992 psmouse_err(psmouse, "failed to initialise registers.\n");
2a0bd75e
AO		 993
994 return rc;
995}
996
28f49616
JD		 997static int elantech_set_range(struct psmouse *psmouse,
998 unsigned int *x_min, unsigned int *y_min,
1dc6edec
JD		 999 unsigned int *x_max, unsigned int *y_max,
1000 unsigned int *width)
230282a7
JD		 1001{
1002 struct elantech_data *etd = psmouse->private;
f0787592 1003 struct elantech_device_info *info = &etd->info;
28f49616 1004 unsigned char param[3];
1dc6edec 1005 unsigned char traces;
230282a7 1006
f0787592 1007 switch (info->hw_version) {
230282a7
JD		 1008 case 1:
1009 *x_min = ETP_XMIN_V1;
1010 *y_min = ETP_YMIN_V1;
1011 *x_max = ETP_XMAX_V1;
1012 *y_max = ETP_YMAX_V1;
1013 break;
1014
1015 case 2:
f0787592
BT		 1016 if (info->fw_version == 0x020800 ||
1017 info->fw_version == 0x020b00 ||
1018 info->fw_version == 0x020030) {
230282a7
JD		 1019 *x_min = ETP_XMIN_V2;
1020 *y_min = ETP_YMIN_V2;
1021 *x_max = ETP_XMAX_V2;
1022 *y_max = ETP_YMAX_V2;
1023 } else {
84a90b61
JD		 1024 int i;
1025 int fixed_dpi;
1026
f0787592
BT		 1027 i = (info->fw_version > 0x020800 &&
1028 info->fw_version < 0x020900) ? 1 : 2;
84a90b61 1029
f0787592 1030 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
84a90b61
JD		 1031 return -1;
1032
1033 fixed_dpi = param[1] & 0x10;
1034
f0787592
BT		 1035 if (((info->fw_version >> 16) == 0x14) && fixed_dpi) {
1036 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
84a90b61
JD		 1037 return -1;
1038
f0787592
BT		 1039 *x_max = (info->capabilities[1] - i) * param[1] / 2;
1040 *y_max = (info->capabilities[2] - i) * param[2] / 2;
1041 } else if (info->fw_version == 0x040216) {
84a90b61
JD		 1042 *x_max = 819;
1043 *y_max = 405;
f0787592 1044 } else if (info->fw_version == 0x040219 || info->fw_version == 0x040215) {
84a90b61
JD		 1045 *x_max = 900;
1046 *y_max = 500;
1047 } else {
f0787592
BT		 1048 *x_max = (info->capabilities[1] - i) * 64;
1049 *y_max = (info->capabilities[2] - i) * 64;
84a90b61 1050 }
230282a7
JD		 1051 }
1052 break;
28f49616
JD		 1053
1054 case 3:
f0787592 1055 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
28f49616
JD		 1056 return -1;
1057
1058 *x_max = (0x0f & param[0]) << 8 | param[1];
1059 *y_max = (0xf0 & param[0]) << 4 | param[2];
1060 break;
1dc6edec
JD		 1061
1062 case 4:
f0787592 1063 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1dc6edec
JD		 1064 return -1;
1065
1066 *x_max = (0x0f & param[0]) << 8 | param[1];
1067 *y_max = (0xf0 & param[0]) << 4 | param[2];
f0787592 1068 traces = info->capabilities[1];
1dc6edec
JD		 1069 if ((traces < 2) || (traces > *x_max))
1070 return -1;
1071
1072 *width = *x_max / (traces - 1);
1073 break;
230282a7 1074 }
28f49616
JD		 1075
1076 return 0;
230282a7
JD		 1077}
1078
3d95fd6a
JD		 1079/*
1080 * (value from firmware) * 10 + 790 = dpi
1081 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1082 */
1083static unsigned int elantech_convert_res(unsigned int val)
1084{
1085 return (val * 10 + 790) * 10 / 254;
1086}
1087
1088static int elantech_get_resolution_v4(struct psmouse *psmouse,
1089 unsigned int *x_res,
21c48dbd
BT		 1090 unsigned int *y_res,
1091 unsigned int *bus)
3d95fd6a
JD		 1092{
1093 unsigned char param[3];
1094
1095 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1096 return -1;
1097
1098 *x_res = elantech_convert_res(param[1] & 0x0f);
1099 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
21c48dbd 1100 *bus = param[2];
3d95fd6a
JD		 1101
1102 return 0;
1103}
1104
c15bdfd5
HG		 1105/*
1106 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1107 * fw_version for this is based on the following fw_version & caps table:
1108 *
1109 * Laptop-model: fw_version: caps: buttons:
1110 * Acer S3 0x461f00 10, 13, 0e clickpad
1111 * Acer S7-392 0x581f01 50, 17, 0d clickpad
1112 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1113 * Acer V5-551 0x461f00 ? clickpad
1114 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1115 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1116 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
bd884149
UDB		 1117 * Asus TP500LN 0x381f17 10, 14, 0e clickpad
1118 * Asus X750JN 0x381f17 10, 14, 0e clickpad
c15bdfd5
HG		 1119 * Asus UX31 0x361f00 20, 15, 0e clickpad
1120 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1121 * Avatar AVIU-145A2 0x361f00 ? clickpad
47c1ffb2 1122 * Fujitsu LIFEBOOK E544 0x470f00 d0, 12, 09 2 hw buttons
47eb0c8b 1123 * Fujitsu LIFEBOOK E546 0x470f00 50, 12, 09 2 hw buttons
704de489 1124 * Fujitsu LIFEBOOK E547 0x470f00 50, 12, 09 2 hw buttons
47c1ffb2 1125 * Fujitsu LIFEBOOK E554 0x570f01 40, 14, 0c 2 hw buttons
47eb0c8b 1126 * Fujitsu LIFEBOOK E557 0x570f01 40, 14, 0c 2 hw buttons
6b30c73e 1127 * Fujitsu T725 0x470f01 05, 12, 09 2 hw buttons
a2418fc4 1128 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
c15bdfd5
HG		 1129 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1130 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
a2418fc4 1131 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
c15bdfd5
HG		 1132 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1133 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1134 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1135 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1136 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1137 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1138 * Samsung RF710 0x450f00 ? 2 hw buttons
1139 * System76 Pangolin 0x250f01 ? 2 hw buttons
1140 * (*) + 3 trackpoint buttons
a2418fc4 1141 * (**) + 0 trackpoint buttons
ad3cce06 1142 * Note: Lenovo L430 and Lenovo L530 have the same fw_version/caps
c15bdfd5
HG		 1143 */
1144static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1145{
1146 struct input_dev *dev = psmouse->dev;
1147 struct elantech_data *etd = psmouse->private;
1148
f0787592 1149 if (etd->info.fw_version & 0x001000) {
c15bdfd5
HG		 1150 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1151 __clear_bit(BTN_RIGHT, dev->keybit);
1152 }
1153}
1154
f386474e
UDB		 1155/*
1156 * Some hw_version 4 models do have a middle button
1157 */
1158static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1159#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1160 {
1161 /* Fujitsu H730 has a middle button */
1162 .matches = {
1163 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1164 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1165 },
1166 },
f9a703a5
MK		 1167 {
1168 /* Fujitsu H760 also has a middle button */
1169 .matches = {
1170 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1171 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1172 },
1173 },
f386474e
UDB		 1174#endif
1175 { }
1176};
1177
24bb555e
AM		 1178static const char * const middle_button_pnp_ids[] = {
1179 "LEN2131", /* ThinkPad P52 w/ NFC */
1180 "LEN2132", /* ThinkPad P52 */
1181 NULL
1182};
1183
2a0bd75e
AO		 1184/*
1185 * Set the appropriate event bits for the input subsystem
1186 */
28f49616 1187static int elantech_set_input_params(struct psmouse *psmouse)
2a0bd75e
AO		 1188{
1189 struct input_dev *dev = psmouse->dev;
1190 struct elantech_data *etd = psmouse->private;
f0787592 1191 struct elantech_device_info *info = &etd->info;
1dc6edec 1192 unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
230282a7 1193
1dc6edec 1194 if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
28f49616 1195 return -1;
2a0bd75e 1196
e3dde4fb 1197 __set_bit(INPUT_PROP_POINTER, dev->propbit);
2a0bd75e
AO		 1198 __set_bit(EV_KEY, dev->evbit);
1199 __set_bit(EV_ABS, dev->evbit);
c7a1f3cc 1200 __clear_bit(EV_REL, dev->evbit);
2a0bd75e
AO		 1201
1202 __set_bit(BTN_LEFT, dev->keybit);
24bb555e
AM		 1203 if (dmi_check_system(elantech_dmi_has_middle_button) ||
1204 psmouse_matches_pnp_id(psmouse, middle_button_pnp_ids))
f386474e 1205 __set_bit(BTN_MIDDLE, dev->keybit);
2a0bd75e
AO		 1206 __set_bit(BTN_RIGHT, dev->keybit);
1207
1208 __set_bit(BTN_TOUCH, dev->keybit);
1209 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1210 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1211 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1212
f0787592 1213 switch (info->hw_version) {
2a0bd75e
AO		 1214 case 1:
1215 /* Rocker button */
f0787592
BT		 1216 if (info->fw_version < 0x020000 &&
1217 (info->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
2a0bd75e
AO		 1218 __set_bit(BTN_FORWARD, dev->keybit);
1219 __set_bit(BTN_BACK, dev->keybit);
1220 }
230282a7
JD		 1221 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1222 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
2a0bd75e
AO		 1223 break;
1224
1225 case 2:
22462d9f 1226 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
28f49616
JD		 1227 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1228 /* fall through */
1229 case 3:
f0787592 1230 if (info->hw_version == 3)
c15bdfd5 1231 elantech_set_buttonpad_prop(psmouse);
230282a7
JD		 1232 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1233 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
f0787592 1234 if (info->reports_pressure) {
f941c705
ÉP		 1235 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1236 ETP_PMAX_V2, 0, 0);
1237 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1238 ETP_WMAX_V2, 0, 0);
1239 }
6544a1df 1240 input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
230282a7
JD		 1241 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1242 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
2a0bd75e 1243 break;
1dc6edec
JD		 1244
1245 case 4:
c15bdfd5 1246 elantech_set_buttonpad_prop(psmouse);
1dc6edec
JD		 1247 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1248 /* For X to recognize me as touchpad. */
1249 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1250 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1251 /*
1252 * range of pressure and width is the same as v2,
1253 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1254 */
1255 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1256 ETP_PMAX_V2, 0, 0);
1257 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1258 ETP_WMAX_V2, 0, 0);
1259 /* Multitouch capable pad, up to 5 fingers. */
b4adbbef 1260 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1dc6edec
JD		 1261 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1262 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1263 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1264 ETP_PMAX_V2, 0, 0);
1265 /*
1266 * The firmware reports how many trace lines the finger spans,
1267 * convert to surface unit as Protocol-B requires.
1268 */
1269 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1270 ETP_WMAX_V2 * width, 0, 0);
1271 break;
2a0bd75e 1272 }
230282a7 1273
80212ed7
BT		 1274 input_abs_set_res(dev, ABS_X, info->x_res);
1275 input_abs_set_res(dev, ABS_Y, info->y_res);
f0787592 1276 if (info->hw_version > 1) {
80212ed7
BT		 1277 input_abs_set_res(dev, ABS_MT_POSITION_X, info->x_res);
1278 input_abs_set_res(dev, ABS_MT_POSITION_Y, info->y_res);
d98399e6
PH		 1279 }
1280
230282a7 1281 etd->y_max = y_max;
1dc6edec 1282 etd->width = width;
28f49616
JD		 1283
1284 return 0;
2a0bd75e
AO		 1285}
1286
1287struct elantech_attr_data {
1288 size_t field_offset;
1289 unsigned char reg;
1290};
1291
1292/*
1293 * Display a register value by reading a sysfs entry
1294 */
1295static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1296 char *buf)
1297{
1298 struct elantech_data *etd = psmouse->private;
1299 struct elantech_attr_data *attr = data;
1300 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1301 int rc = 0;
1302
1303 if (attr->reg)
1304 rc = elantech_read_reg(psmouse, attr->reg, reg);
1305
1306 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1307}
1308
1309/*
1310 * Write a register value by writing a sysfs entry
1311 */
1312static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1313 void *data, const char *buf, size_t count)
1314{
1315 struct elantech_data *etd = psmouse->private;
1316 struct elantech_attr_data *attr = data;
1317 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
76496e7a 1318 unsigned char value;
2a0bd75e
AO		 1319 int err;
1320
76496e7a 1321 err = kstrtou8(buf, 16, &value);
2a0bd75e
AO		 1322 if (err)
1323 return err;
1324
2a0bd75e 1325 /* Do we need to preserve some bits for version 2 hardware too? */
f0787592 1326 if (etd->info.hw_version == 1) {
2a0bd75e
AO		 1327 if (attr->reg == 0x10)
1328 /* Force absolute mode always on */
1329 value |= ETP_R10_ABSOLUTE_MODE;
1330 else if (attr->reg == 0x11)
1331 /* Force 4 byte mode always on */
1332 value |= ETP_R11_4_BYTE_MODE;
1333 }
1334
1335 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1336 *reg = value;
1337
1338 return count;
1339}
1340
1341#define ELANTECH_INT_ATTR(_name, _register) \
1342 static struct elantech_attr_data elantech_attr_##_name = { \
1343 .field_offset = offsetof(struct elantech_data, _name), \
1344 .reg = _register, \
1345 }; \
f0787592 1346 PSMOUSE_DEFINE_ATTR(_name, 0644, \
2a0bd75e
AO		 1347 &elantech_attr_##_name, \
1348 elantech_show_int_attr, \
1349 elantech_set_int_attr)
1350
f0787592
BT		 1351#define ELANTECH_INFO_ATTR(_name) \
1352 static struct elantech_attr_data elantech_attr_##_name = { \
1353 .field_offset = offsetof(struct elantech_data, info) + \
1354 offsetof(struct elantech_device_info, _name), \
1355 .reg = 0, \
1356 }; \
1357 PSMOUSE_DEFINE_ATTR(_name, 0644, \
1358 &elantech_attr_##_name, \
1359 elantech_show_int_attr, \
1360 elantech_set_int_attr)
1361
1dc6edec 1362ELANTECH_INT_ATTR(reg_07, 0x07);
2a0bd75e
AO		 1363ELANTECH_INT_ATTR(reg_10, 0x10);
1364ELANTECH_INT_ATTR(reg_11, 0x11);
1365ELANTECH_INT_ATTR(reg_20, 0x20);
1366ELANTECH_INT_ATTR(reg_21, 0x21);
1367ELANTECH_INT_ATTR(reg_22, 0x22);
1368ELANTECH_INT_ATTR(reg_23, 0x23);
1369ELANTECH_INT_ATTR(reg_24, 0x24);
1370ELANTECH_INT_ATTR(reg_25, 0x25);
1371ELANTECH_INT_ATTR(reg_26, 0x26);
f0787592
BT		 1372ELANTECH_INFO_ATTR(debug);
1373ELANTECH_INFO_ATTR(paritycheck);
1374ELANTECH_INFO_ATTR(crc_enabled);
2a0bd75e
AO		 1375
1376static struct attribute *elantech_attrs[] = {
1dc6edec 1377 &psmouse_attr_reg_07.dattr.attr,
2a0bd75e
AO		 1378 &psmouse_attr_reg_10.dattr.attr,
1379 &psmouse_attr_reg_11.dattr.attr,
1380 &psmouse_attr_reg_20.dattr.attr,
1381 &psmouse_attr_reg_21.dattr.attr,
1382 &psmouse_attr_reg_22.dattr.attr,
1383 &psmouse_attr_reg_23.dattr.attr,
1384 &psmouse_attr_reg_24.dattr.attr,
1385 &psmouse_attr_reg_25.dattr.attr,
1386 &psmouse_attr_reg_26.dattr.attr,
1387 &psmouse_attr_debug.dattr.attr,
1388 &psmouse_attr_paritycheck.dattr.attr,
2d9eb81f 1389 &psmouse_attr_crc_enabled.dattr.attr,
2a0bd75e
AO		 1390 NULL
1391};
1392
57999433 1393static const struct attribute_group elantech_attr_group = {
2a0bd75e
AO		 1394 .attrs = elantech_attrs,
1395};
1396
a083632e
DT		 1397static bool elantech_is_signature_valid(const unsigned char *param)
1398{
1399 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1400 int i;
1401
1402 if (param[0] == 0)
1403 return false;
1404
1405 if (param[1] == 0)
1406 return true;
1407
271329b3 1408 /*
5f0ee9d1
HG		 1409 * Some hw_version >= 4 models have a revision higher then 20. Meaning
1410 * that param[2] may be 10 or 20, skip the rates check for these.
271329b3 1411 */
5f0ee9d1
HG		 1412 if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1413 param[2] < 40)
271329b3
HG		 1414 return true;
1415
a083632e
DT		 1416 for (i = 0; i < ARRAY_SIZE(rates); i++)
1417 if (param[2] == rates[i])
1418 return false;
1419
1420 return true;
1421}
1422
2a0bd75e
AO		 1423/*
1424 * Use magic knock to detect Elantech touchpad
1425 */
b7802c5c 1426int elantech_detect(struct psmouse *psmouse, bool set_properties)
2a0bd75e
AO		 1427{
1428 struct ps2dev *ps2dev = &psmouse->ps2dev;
1429 unsigned char param[3];
1430
ad56814f 1431 ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
2a0bd75e
AO		 1432
1433 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1434 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1435 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1436 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1437 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
b5d21704 1438 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
2a0bd75e
AO		 1439 return -1;
1440 }
1441
1442 /*
1443 * Report this in case there are Elantech models that use a different
1444 * set of magic numbers
1445 */
28f49616
JD		 1446 if (param[0] != 0x3c || param[1] != 0x03 ||
1447 (param[2] != 0xc8 && param[2] != 0x00)) {
b5d21704
DT		 1448 psmouse_dbg(psmouse,
1449 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1450 param[0], param[1], param[2]);
9ab7b25e
AO		 1451 return -1;
1452 }
1453
1454 /*
1455 * Query touchpad's firmware version and see if it reports known
1456 * value to avoid mis-detection. Logitech mice are known to respond
1457 * to Elantech magic knock and there might be more.
1458 */
1459 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
b5d21704 1460 psmouse_dbg(psmouse, "failed to query firmware version.\n");
9ab7b25e
AO		 1461 return -1;
1462 }
1463
b5d21704
DT		 1464 psmouse_dbg(psmouse,
1465 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1466 param[0], param[1], param[2]);
9ab7b25e 1467
a083632e 1468 if (!elantech_is_signature_valid(param)) {
b5d21704
DT		 1469 psmouse_dbg(psmouse,
1470 "Probably not a real Elantech touchpad. Aborting.\n");
4af61e90 1471 return -1;
2a0bd75e
AO		 1472 }
1473
1474 if (set_properties) {
1475 psmouse->vendor = "Elantech";
1476 psmouse->name = "Touchpad";
1477 }
1478
1479 return 0;
1480}
1481
1482/*
1483 * Clean up sysfs entries when disconnecting
1484 */
1485static void elantech_disconnect(struct psmouse *psmouse)
1486{
a2418fc4
UDB		 1487 struct elantech_data *etd = psmouse->private;
1488
21c48dbd
BT		 1489 /*
1490 * We might have left a breadcrumb when trying to
1491 * set up SMbus companion.
1492 */
1493 psmouse_smbus_cleanup(psmouse);
1494
a2418fc4
UDB		 1495 if (etd->tp_dev)
1496 input_unregister_device(etd->tp_dev);
2a0bd75e
AO		 1497 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1498 &elantech_attr_group);
1499 kfree(psmouse->private);
1500 psmouse->private = NULL;
1501}
1502
1503/*
1504 * Put the touchpad back into absolute mode when reconnecting
1505 */
1506static int elantech_reconnect(struct psmouse *psmouse)
1507{
a67ada7a
JD		 1508 psmouse_reset(psmouse);
1509
2a0bd75e
AO		 1510 if (elantech_detect(psmouse, 0))
1511 return -1;
1512
1513 if (elantech_set_absolute_mode(psmouse)) {
b5d21704
DT		 1514 psmouse_err(psmouse,
1515 "failed to put touchpad back into absolute mode.\n");
2a0bd75e
AO		 1516 return -1;
1517 }
1518
1519 return 0;
1520}
1521
0dc15879
UDB		 1522/*
1523 * Some hw_version 4 models do not work with crc_disabled
1524 */
1525static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1526#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1527 {
1528 /* Fujitsu H730 does not work with crc_enabled == 0 */
1529 .matches = {
1530 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1531 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1532 },
1533 },
f9a703a5
MK		 1534 {
1535 /* Fujitsu H760 does not work with crc_enabled == 0 */
1536 .matches = {
1537 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1538 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1539 },
1540 },
62837b3c
DT		 1541 {
1542 /* Fujitsu LIFEBOOK E544 does not work with crc_enabled == 0 */
1543 .matches = {
1544 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1545 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1546 },
1547 },
47eb0c8b
UDB		 1548 {
1549 /* Fujitsu LIFEBOOK E546 does not work with crc_enabled == 0 */
1550 .matches = {
1551 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1552 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1553 },
1554 },
704de489
TL		 1555 {
1556 /* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1557 .matches = {
1558 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1559 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1560 },
1561 },
47c1ffb2
RK		 1562 {
1563 /* Fujitsu LIFEBOOK E554 does not work with crc_enabled == 0 */
1564 .matches = {
1565 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1566 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1567 },
1568 },
1569 {
62837b3c 1570 /* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
47c1ffb2
RK		 1571 .matches = {
1572 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
62837b3c 1573 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
47c1ffb2
RK		 1574 },
1575 },
47eb0c8b
UDB		 1576 {
1577 /* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1578 .matches = {
1579 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1580 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1581 },
1582 },
60603950
TI		 1583 {
1584 /* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1585 .matches = {
1586 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1587 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1588 },
1589 },
0dc15879
UDB		 1590#endif
1591 { }
1592};
1593
36189cc3 1594/*
fb4f8f56
HG		 1595 * Some hw_version 3 models go into error state when we try to set
1596 * bit 3 and/or bit 1 of r10.
36189cc3
HG		 1597 */
1598static const struct dmi_system_id no_hw_res_dmi_table[] = {
1599#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1600 {
1601 /* Gigabyte U2442 */
1602 .matches = {
1603 DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1604 DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1605 },
1606 },
1607#endif
1608 { }
1609};
1610
3c8bbb95
JD		 1611/*
1612 * determine hardware version and set some properties according to it.
1613 */
f0787592 1614static int elantech_set_properties(struct elantech_device_info *info)
3c8bbb95 1615{
3940d618 1616 /* This represents the version of IC body. */
f0787592 1617 int ver = (info->fw_version & 0x0f0000) >> 16;
1dc6edec 1618
3940d618 1619 /* Early version of Elan touchpads doesn't obey the rule. */
f0787592
BT		 1620 if (info->fw_version < 0x020030 || info->fw_version == 0x020600)
1621 info->hw_version = 1;
3940d618
JD		 1622 else {
1623 switch (ver) {
1624 case 2:
1625 case 4:
f0787592 1626 info->hw_version = 2;
3940d618
JD		 1627 break;
1628 case 5:
f0787592 1629 info->hw_version = 3;
3940d618 1630 break;
10d90030 1631 case 6 ... 15:
f0787592 1632 info->hw_version = 4;
3940d618
JD		 1633 break;
1634 default:
1635 return -1;
1636 }
1637 }
3c8bbb95 1638
b56b92a9 1639 /* decide which send_cmd we're gonna use early */
f0787592
BT		 1640 info->send_cmd = info->hw_version >= 3 ? elantech_send_cmd :
1641 synaptics_send_cmd;
b56b92a9
JD		 1642
1643 /* Turn on packet checking by default */
f0787592 1644 info->paritycheck = 1;
3c8bbb95
JD		 1645
1646 /*
1647 * This firmware suffers from misreporting coordinates when
1648 * a touch action starts causing the mouse cursor or scrolled page
1649 * to jump. Enable a workaround.
1650 */
f0787592
BT		 1651 info->jumpy_cursor =
1652 (info->fw_version == 0x020022 || info->fw_version == 0x020600);
3c8bbb95 1653
f0787592 1654 if (info->hw_version > 1) {
3c8bbb95 1655 /* For now show extra debug information */
f0787592 1656 info->debug = 1;
3c8bbb95 1657
f0787592
BT		 1658 if (info->fw_version >= 0x020800)
1659 info->reports_pressure = true;
3c8bbb95 1660 }
28f49616 1661
acc0444b
MD		 1662 /*
1663 * The signatures of v3 and v4 packets change depending on the
1664 * value of this hardware flag.
1665 */
f0787592
BT		 1666 info->crc_enabled = (info->fw_version & 0x4000) == 0x4000 ||
1667 dmi_check_system(elantech_dmi_force_crc_enabled);
acc0444b 1668
36189cc3 1669 /* Enable real hardware resolution on hw_version 3 ? */
f0787592 1670 info->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
36189cc3 1671
28f49616 1672 return 0;
3c8bbb95
JD		 1673}
1674
f0787592
BT		 1675static int elantech_query_info(struct psmouse *psmouse,
1676 struct elantech_device_info *info)
2a0bd75e 1677{
2a0bd75e 1678 unsigned char param[3];
2a0bd75e 1679
21c48dbd
BT		 1680 memset(info, 0, sizeof(*info));
1681
2a0bd75e 1682 /*
9ab7b25e 1683 * Do the version query again so we can store the result
2a0bd75e
AO		 1684 */
1685 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
b5d21704 1686 psmouse_err(psmouse, "failed to query firmware version.\n");
f0787592 1687 return -EINVAL;
2a0bd75e 1688 }
f0787592 1689 info->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
28f49616 1690
f0787592 1691 if (elantech_set_properties(info)) {
b5d21704 1692 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
f0787592 1693 return -EINVAL;
28f49616 1694 }
b5d21704
DT		 1695 psmouse_info(psmouse,
1696 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
f0787592 1697 info->hw_version, param[0], param[1], param[2]);
2a0bd75e 1698
f0787592
BT		 1699 if (info->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1700 info->capabilities)) {
b5d21704 1701 psmouse_err(psmouse, "failed to query capabilities.\n");
f0787592 1702 return -EINVAL;
2a0bd75e 1703 }
b5d21704
DT		 1704 psmouse_info(psmouse,
1705 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
f0787592
BT		 1706 info->capabilities[0], info->capabilities[1],
1707 info->capabilities[2]);
2a0bd75e 1708
f0787592
BT		 1709 if (info->hw_version != 1) {
1710 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, info->samples)) {
6b30c73e 1711 psmouse_err(psmouse, "failed to query sample data\n");
f0787592 1712 return -EINVAL;
6b30c73e
DL		 1713 }
1714 psmouse_info(psmouse,
1715 "Elan sample query result %02x, %02x, %02x\n",
f0787592
BT		 1716 info->samples[0],
1717 info->samples[1],
1718 info->samples[2]);
6b30c73e
DL		 1719 }
1720
f0787592 1721 if (info->samples[1] == 0x74 && info->hw_version == 0x03) {
d899520b
KL		 1722 /*
1723 * This module has a bug which makes absolute mode
1724 * unusable, so let's abort so we'll be using standard
1725 * PS/2 protocol.
1726 */
1727 psmouse_info(psmouse,
1728 "absolute mode broken, forcing standard PS/2 protocol\n");
f0787592 1729 return -ENODEV;
d899520b
KL		 1730 }
1731
f0787592
BT		 1732 /* The MSB indicates the presence of the trackpoint */
1733 info->has_trackpoint = (info->capabilities[0] & 0x80) == 0x80;
1734
80212ed7
BT		 1735 info->x_res = 31;
1736 info->y_res = 31;
1737 if (info->hw_version == 4) {
1738 if (elantech_get_resolution_v4(psmouse,
1739 &info->x_res,
21c48dbd
BT		 1740 &info->y_res,
1741 &info->bus)) {
80212ed7
BT		 1742 psmouse_warn(psmouse,
1743 "failed to query resolution data.\n");
1744 }
1745 }
1746
f0787592
BT		 1747 return 0;
1748}
1749
21c48dbd
BT		 1750#if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
1751
1752/*
1753 * The newest Elantech device can use a secondary bus (over SMBus) which
1754 * provides a better bandwidth and allow a better control of the touchpads.
1755 * This is used to decide if we need to use this bus or not.
1756 */
1757enum {
1758 ELANTECH_SMBUS_NOT_SET = -1,
1759 ELANTECH_SMBUS_OFF,
1760 ELANTECH_SMBUS_ON,
1761};
1762
1763static int elantech_smbus = IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ?
1764 ELANTECH_SMBUS_NOT_SET : ELANTECH_SMBUS_OFF;
1765module_param_named(elantech_smbus, elantech_smbus, int, 0644);
1766MODULE_PARM_DESC(elantech_smbus, "Use a secondary bus for the Elantech device.");
1767
1768static int elantech_create_smbus(struct psmouse *psmouse,
1769 struct elantech_device_info *info,
1770 bool leave_breadcrumbs)
1771{
1772 const struct property_entry i2c_properties[] = {
1773 PROPERTY_ENTRY_BOOL("elan,trackpoint"),
1774 { },
1775 };
1776 struct i2c_board_info smbus_board = {
1777 I2C_BOARD_INFO("elan_i2c", 0x15),
1778 .flags = I2C_CLIENT_HOST_NOTIFY,
1779 };
1780
1781 if (info->has_trackpoint)
1782 smbus_board.properties = i2c_properties;
1783
bf232e46 1784 return psmouse_smbus_init(psmouse, &smbus_board, NULL, 0, false,
21c48dbd
BT		 1785 leave_breadcrumbs);
1786}
1787
1788/**
1789 * elantech_setup_smbus - called once the PS/2 devices are enumerated
1790 * and decides to instantiate a SMBus InterTouch device.
1791 */
1792static int elantech_setup_smbus(struct psmouse *psmouse,
1793 struct elantech_device_info *info,
1794 bool leave_breadcrumbs)
1795{
1796 int error;
1797
1798 if (elantech_smbus == ELANTECH_SMBUS_OFF)
1799 return -ENXIO;
1800
1801 if (elantech_smbus == ELANTECH_SMBUS_NOT_SET) {
1802 /*
df077237
BT		 1803 * New ICs are enabled by default.
1804 * Old ICs are up to the user to decide.
21c48dbd 1805 */
df077237
BT		 1806 if (!ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1807 return -ENXIO;
21c48dbd
BT		 1808 }
1809
1810 psmouse_info(psmouse, "Trying to set up SMBus access\n");
1811
1812 error = elantech_create_smbus(psmouse, info, leave_breadcrumbs);
1813 if (error) {
1814 if (error == -EAGAIN)
1815 psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1816 else
1817 psmouse_err(psmouse, "unable to create intertouch device\n");
1818
1819 return error;
1820 }
1821
1822 return 0;
1823}
1824
1825static bool elantech_use_host_notify(struct psmouse *psmouse,
1826 struct elantech_device_info *info)
1827{
df077237
BT		 1828 if (ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1829 return true;
1830
21c48dbd
BT		 1831 switch (info->bus) {
1832 case ETP_BUS_PS2_ONLY:
1833 /* expected case */
1834 break;
1835 case ETP_BUS_SMB_ALERT_ONLY:
1836 /* fall-through */
1837 case ETP_BUS_PS2_SMB_ALERT:
1838 psmouse_dbg(psmouse, "Ignoring SMBus provider through alert protocol.\n");
1839 break;
1840 case ETP_BUS_SMB_HST_NTFY_ONLY:
1841 /* fall-through */
1842 case ETP_BUS_PS2_SMB_HST_NTFY:
1843 return true;
1844 default:
1845 psmouse_dbg(psmouse,
1846 "Ignoring SMBus bus provider %d.\n",
1847 info->bus);
1848 }
1849
1850 return false;
1851}
1852
1853int elantech_init_smbus(struct psmouse *psmouse)
1854{
1855 struct elantech_device_info info;
1856 int error = -EINVAL;
1857
1858 psmouse_reset(psmouse);
1859
1860 error = elantech_query_info(psmouse, &info);
1861 if (error)
1862 goto init_fail;
1863
1864 if (info.hw_version < 4) {
1865 error = -ENXIO;
1866 goto init_fail;
1867 }
1868
1869 return elantech_create_smbus(psmouse, &info, false);
1870 init_fail:
1871 psmouse_reset(psmouse);
1872 return error;
1873}
1874#endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
1875
f0787592
BT		 1876/*
1877 * Initialize the touchpad and create sysfs entries
1878 */
1879static int elantech_setup_ps2(struct psmouse *psmouse,
1880 struct elantech_device_info *info)
1881{
1882 struct elantech_data *etd;
1883 int i;
21c48dbd 1884 int error = -EINVAL;
f0787592
BT		 1885 struct input_dev *tp_dev;
1886
1887 psmouse->private = etd = kzalloc(sizeof(*etd), GFP_KERNEL);
1888 if (!etd)
1889 return -ENOMEM;
1890
1891 etd->info = *info;
1892
1893 etd->parity[0] = 1;
1894 for (i = 1; i < 256; i++)
1895 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1896
2a0bd75e 1897 if (elantech_set_absolute_mode(psmouse)) {
b5d21704
DT		 1898 psmouse_err(psmouse,
1899 "failed to put touchpad into absolute mode.\n");
2a0bd75e
AO		 1900 goto init_fail;
1901 }
1902
f0787592 1903 if (info->fw_version == 0x381f17) {
bd884149
UDB		 1904 etd->original_set_rate = psmouse->set_rate;
1905 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1906 }
1907
28f49616 1908 if (elantech_set_input_params(psmouse)) {
b5d21704 1909 psmouse_err(psmouse, "failed to query touchpad range.\n");
28f49616
JD		 1910 goto init_fail;
1911 }
2a0bd75e
AO		 1912
1913 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1914 &elantech_attr_group);
1915 if (error) {
b5d21704
DT		 1916 psmouse_err(psmouse,
1917 "failed to create sysfs attributes, error: %d.\n",
1918 error);
2a0bd75e
AO		 1919 goto init_fail;
1920 }
1921
f0787592 1922 if (info->has_trackpoint) {
a2418fc4
UDB		 1923 tp_dev = input_allocate_device();
1924
1925 if (!tp_dev) {
1926 error = -ENOMEM;
1927 goto init_fail_tp_alloc;
1928 }
1929
1930 etd->tp_dev = tp_dev;
1931 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1932 psmouse->ps2dev.serio->phys);
1933 tp_dev->phys = etd->tp_phys;
9096a45d 1934 tp_dev->name = "ETPS/2 Elantech TrackPoint";
a2418fc4
UDB		 1935 tp_dev->id.bustype = BUS_I8042;
1936 tp_dev->id.vendor = 0x0002;
1937 tp_dev->id.product = PSMOUSE_ELANTECH;
1938 tp_dev->id.version = 0x0000;
1939 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1940 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1941 tp_dev->relbit[BIT_WORD(REL_X)] =
1942 BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1943 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1944 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1945 BIT_MASK(BTN_RIGHT);
7611392f 1946
01d4cd5c 1947 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
7611392f
HG		 1948 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1949
a2418fc4
UDB		 1950 error = input_register_device(etd->tp_dev);
1951 if (error < 0)
1952 goto init_fail_tp_reg;
1953 }
1954
2a0bd75e
AO		 1955 psmouse->protocol_handler = elantech_process_byte;
1956 psmouse->disconnect = elantech_disconnect;
1957 psmouse->reconnect = elantech_reconnect;
f0787592 1958 psmouse->pktsize = info->hw_version > 1 ? 6 : 4;
2a0bd75e
AO		 1959
1960 return 0;
a2418fc4
UDB		 1961 init_fail_tp_reg:
1962 input_free_device(tp_dev);
1963 init_fail_tp_alloc:
1964 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1965 &elantech_attr_group);
2a0bd75e
AO		 1966 init_fail:
1967 kfree(etd);
a2418fc4 1968 return error;
2a0bd75e 1969}
f0787592 1970
21c48dbd 1971int elantech_init_ps2(struct psmouse *psmouse)
f0787592
BT		 1972{
1973 struct elantech_device_info info;
1974 int error = -EINVAL;
1975
1976 psmouse_reset(psmouse);
1977
1978 error = elantech_query_info(psmouse, &info);
1979 if (error)
1980 goto init_fail;
1981
1982 error = elantech_setup_ps2(psmouse, &info);
1983 if (error)
1984 goto init_fail;
1985
1986 return 0;
1987 init_fail:
1988 psmouse_reset(psmouse);
1989 return error;
1990}
21c48dbd
BT		 1991
1992int elantech_init(struct psmouse *psmouse)
1993{
1994 struct elantech_device_info info;
1995 int error = -EINVAL;
1996
1997 psmouse_reset(psmouse);
1998
1999 error = elantech_query_info(psmouse, &info);
2000 if (error)
2001 goto init_fail;
2002
2003#if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
2004
2005 if (elantech_use_host_notify(psmouse, &info)) {
2006 if (!IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ||
2007 !IS_ENABLED(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)) {
2008 psmouse_warn(psmouse,
2009 "The touchpad can support a better bus than the too old PS/2 protocol. "
2010 "Make sure MOUSE_PS2_ELANTECH_SMBUS and MOUSE_ELAN_I2C_SMBUS are enabled to get a better touchpad experience.\n");
2011 }
2012 error = elantech_setup_smbus(psmouse, &info, true);
2013 if (!error)
2014 return PSMOUSE_ELANTECH_SMBUS;
2015 }
2016
2017#endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
2018
2019 error = elantech_setup_ps2(psmouse, &info);
2020 if (error < 0) {
2021 /*
2022 * Not using any flavor of Elantech support, so clean up
2023 * SMbus breadcrumbs, if any.
2024 */
2025 psmouse_smbus_cleanup(psmouse);
2026 goto init_fail;
2027 }
2028
2029 return PSMOUSE_ELANTECH;
2030 init_fail:
2031 psmouse_reset(psmouse);
2032 return error;
2033}
Linux 6.x block layer and io_uring tree(s)