2 * Elantech Touchpad driver (v6)
4 * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
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.
10 * Trademarks are the property of their respective owners.
13 #include <linux/delay.h>
14 #include <linux/slab.h>
15 #include <linux/module.h>
16 #include <linux/input.h>
17 #include <linux/input/mt.h>
18 #include <linux/serio.h>
19 #include <linux/libps2.h>
23 #define elantech_debug(fmt, ...) \
26 psmouse_printk(KERN_DEBUG, psmouse, \
27 fmt, ##__VA_ARGS__); \
31 * Send a Synaptics style sliced query command
33 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
36 if (psmouse_sliced_command(psmouse, c) ||
37 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
38 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
46 * V3 and later support this fast command
48 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
51 struct ps2dev *ps2dev = &psmouse->ps2dev;
53 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
54 ps2_command(ps2dev, NULL, c) ||
55 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
56 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
64 * A retrying version of ps2_command
66 static int elantech_ps2_command(struct psmouse *psmouse,
67 unsigned char *param, int command)
69 struct ps2dev *ps2dev = &psmouse->ps2dev;
70 struct elantech_data *etd = psmouse->private;
72 int tries = ETP_PS2_COMMAND_TRIES;
75 rc = ps2_command(ps2dev, param, command);
79 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
81 msleep(ETP_PS2_COMMAND_DELAY);
85 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
91 * Send an Elantech style special command to read a value from a register
93 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
96 struct elantech_data *etd = psmouse->private;
97 unsigned char param[3];
100 if (reg < 0x07 || reg > 0x26)
103 if (reg > 0x11 && reg < 0x20)
106 switch (etd->hw_version) {
108 if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
109 psmouse_sliced_command(psmouse, reg) ||
110 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
116 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
117 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
118 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
119 elantech_ps2_command(psmouse, NULL, reg) ||
120 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
126 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
127 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
128 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
129 elantech_ps2_command(psmouse, NULL, reg) ||
130 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
137 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
138 else if (etd->hw_version != 4)
147 * Send an Elantech style special command to write a register with a value
149 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
152 struct elantech_data *etd = psmouse->private;
155 if (reg < 0x07 || reg > 0x26)
158 if (reg > 0x11 && reg < 0x20)
161 switch (etd->hw_version) {
163 if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
164 psmouse_sliced_command(psmouse, reg) ||
165 psmouse_sliced_command(psmouse, val) ||
166 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
172 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
173 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
174 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
175 elantech_ps2_command(psmouse, NULL, reg) ||
176 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
177 elantech_ps2_command(psmouse, NULL, val) ||
178 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
184 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
185 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
186 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
187 elantech_ps2_command(psmouse, NULL, reg) ||
188 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
189 elantech_ps2_command(psmouse, NULL, val) ||
190 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
196 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
197 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
198 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
199 elantech_ps2_command(psmouse, NULL, reg) ||
200 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
201 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
202 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
203 elantech_ps2_command(psmouse, NULL, val) ||
204 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
212 "failed to write register 0x%02x with value 0x%02x.\n",
219 * Dump a complete mouse movement packet to the syslog
221 static void elantech_packet_dump(struct psmouse *psmouse)
225 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [");
226 for (i = 0; i < psmouse->pktsize; i++)
227 printk("%s0x%02x ", i ? ", " : " ", psmouse->packet[i]);
232 * Interpret complete data packets and report absolute mode input events for
233 * hardware version 1. (4 byte packets)
235 static void elantech_report_absolute_v1(struct psmouse *psmouse)
237 struct input_dev *dev = psmouse->dev;
238 struct elantech_data *etd = psmouse->private;
239 unsigned char *packet = psmouse->packet;
242 if (etd->fw_version < 0x020000) {
244 * byte 0: D U p1 p2 1 p3 R L
245 * byte 1: f 0 th tw x9 x8 y9 y8
247 fingers = ((packet[1] & 0x80) >> 7) +
248 ((packet[1] & 0x30) >> 4);
251 * byte 0: n1 n0 p2 p1 1 p3 R L
252 * byte 1: 0 0 0 0 x9 x8 y9 y8
254 fingers = (packet[0] & 0xc0) >> 6;
257 if (etd->jumpy_cursor) {
259 etd->single_finger_reports = 0;
260 } else if (etd->single_finger_reports < 2) {
261 /* Discard first 2 reports of one finger, bogus */
262 etd->single_finger_reports++;
263 elantech_debug("discarding packet\n");
268 input_report_key(dev, BTN_TOUCH, fingers != 0);
271 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
272 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
275 input_report_abs(dev, ABS_X,
276 ((packet[1] & 0x0c) << 6) | packet[2]);
277 input_report_abs(dev, ABS_Y,
278 etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
281 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
282 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
283 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
284 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
285 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
287 if (etd->fw_version < 0x020000 &&
288 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
290 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
292 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
298 static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
299 unsigned int x, unsigned int y)
301 input_mt_slot(dev, slot);
302 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
304 input_report_abs(dev, ABS_MT_POSITION_X, x);
305 input_report_abs(dev, ABS_MT_POSITION_Y, y);
309 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
310 static void elantech_report_semi_mt_data(struct input_dev *dev,
311 unsigned int num_fingers,
312 unsigned int x1, unsigned int y1,
313 unsigned int x2, unsigned int y2)
315 elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
316 elantech_set_slot(dev, 1, num_fingers == 2, x2, y2);
320 * Interpret complete data packets and report absolute mode input events for
321 * hardware version 2. (6 byte packets)
323 static void elantech_report_absolute_v2(struct psmouse *psmouse)
325 struct elantech_data *etd = psmouse->private;
326 struct input_dev *dev = psmouse->dev;
327 unsigned char *packet = psmouse->packet;
328 unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
329 unsigned int width = 0, pres = 0;
331 /* byte 0: n1 n0 . . . . R L */
332 fingers = (packet[0] & 0xc0) >> 6;
337 * Same as one finger, except report of more than 3 fingers:
338 * byte 3: n4 . w1 w0 . . . .
340 if (packet[3] & 0x80)
342 /* pass through... */
345 * byte 1: . . . . x11 x10 x9 x8
346 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
348 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
350 * byte 4: . . . . y11 y10 y9 y8
351 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
353 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
355 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
356 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
361 * The coordinate of each finger is reported separately
362 * with a lower resolution for two finger touches:
363 * byte 0: . . ay8 ax8 . . . .
364 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
366 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
367 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
369 ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
371 * byte 3: . . by8 bx8 . . . .
372 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
374 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
375 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
377 ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
379 /* Unknown so just report sensible values */
385 input_report_key(dev, BTN_TOUCH, fingers != 0);
387 input_report_abs(dev, ABS_X, x1);
388 input_report_abs(dev, ABS_Y, y1);
390 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
391 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
392 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
393 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
394 input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
395 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
396 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
397 if (etd->reports_pressure) {
398 input_report_abs(dev, ABS_PRESSURE, pres);
399 input_report_abs(dev, ABS_TOOL_WIDTH, width);
406 * Interpret complete data packets and report absolute mode input events for
407 * hardware version 3. (12 byte packets for two fingers)
409 static void elantech_report_absolute_v3(struct psmouse *psmouse,
412 struct input_dev *dev = psmouse->dev;
413 struct elantech_data *etd = psmouse->private;
414 unsigned char *packet = psmouse->packet;
415 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
416 unsigned int width = 0, pres = 0;
418 /* byte 0: n1 n0 . . . . R L */
419 fingers = (packet[0] & 0xc0) >> 6;
425 * byte 1: . . . . x11 x10 x9 x8
426 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
428 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
430 * byte 4: . . . . y11 y10 y9 y8
431 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
433 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
437 if (packet_type == PACKET_V3_HEAD) {
439 * byte 1: . . . . ax11 ax10 ax9 ax8
440 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
442 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
444 * byte 4: . . . . ay11 ay10 ay9 ay8
445 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
447 etd->mt[0].y = etd->y_max -
448 (((packet[4] & 0x0f) << 8) | packet[5]);
450 * wait for next packet
455 /* packet_type == PACKET_V3_TAIL */
458 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
459 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
463 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
464 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
466 input_report_key(dev, BTN_TOUCH, fingers != 0);
468 input_report_abs(dev, ABS_X, x1);
469 input_report_abs(dev, ABS_Y, y1);
471 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
472 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
473 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
474 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
475 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
476 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
477 input_report_abs(dev, ABS_PRESSURE, pres);
478 input_report_abs(dev, ABS_TOOL_WIDTH, width);
483 static void elantech_input_sync_v4(struct psmouse *psmouse)
485 struct input_dev *dev = psmouse->dev;
486 unsigned char *packet = psmouse->packet;
488 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
489 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
490 input_mt_report_pointer_emulation(dev, true);
494 static void process_packet_status_v4(struct psmouse *psmouse)
496 struct input_dev *dev = psmouse->dev;
497 unsigned char *packet = psmouse->packet;
501 /* notify finger state change */
502 fingers = packet[1] & 0x1f;
503 for (i = 0; i < ETP_MAX_FINGERS; i++) {
504 if ((fingers & (1 << i)) == 0) {
505 input_mt_slot(dev, i);
506 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
510 elantech_input_sync_v4(psmouse);
513 static void process_packet_head_v4(struct psmouse *psmouse)
515 struct input_dev *dev = psmouse->dev;
516 struct elantech_data *etd = psmouse->private;
517 unsigned char *packet = psmouse->packet;
518 int id = ((packet[3] & 0xe0) >> 5) - 1;
524 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
525 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
526 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
527 traces = (packet[0] & 0xf0) >> 4;
529 input_mt_slot(dev, id);
530 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
532 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
533 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
534 input_report_abs(dev, ABS_MT_PRESSURE, pres);
535 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
536 /* report this for backwards compatibility */
537 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
539 elantech_input_sync_v4(psmouse);
542 static void process_packet_motion_v4(struct psmouse *psmouse)
544 struct input_dev *dev = psmouse->dev;
545 struct elantech_data *etd = psmouse->private;
546 unsigned char *packet = psmouse->packet;
547 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
550 id = ((packet[0] & 0xe0) >> 5) - 1;
554 sid = ((packet[3] & 0xe0) >> 5) - 1;
555 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
557 * Motion packets give us the delta of x, y values of specific fingers,
558 * but in two's complement. Let the compiler do the conversion for us.
559 * Also _enlarge_ the numbers to int, in case of overflow.
561 delta_x1 = (signed char)packet[1];
562 delta_y1 = (signed char)packet[2];
563 delta_x2 = (signed char)packet[4];
564 delta_y2 = (signed char)packet[5];
566 etd->mt[id].x += delta_x1 * weight;
567 etd->mt[id].y -= delta_y1 * weight;
568 input_mt_slot(dev, id);
569 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
570 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
573 etd->mt[sid].x += delta_x2 * weight;
574 etd->mt[sid].y -= delta_y2 * weight;
575 input_mt_slot(dev, sid);
576 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
577 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
580 elantech_input_sync_v4(psmouse);
583 static void elantech_report_absolute_v4(struct psmouse *psmouse,
586 switch (packet_type) {
587 case PACKET_V4_STATUS:
588 process_packet_status_v4(psmouse);
592 process_packet_head_v4(psmouse);
595 case PACKET_V4_MOTION:
596 process_packet_motion_v4(psmouse);
601 /* impossible to get here */
606 static int elantech_packet_check_v1(struct psmouse *psmouse)
608 struct elantech_data *etd = psmouse->private;
609 unsigned char *packet = psmouse->packet;
610 unsigned char p1, p2, p3;
612 /* Parity bits are placed differently */
613 if (etd->fw_version < 0x020000) {
614 /* byte 0: D U p1 p2 1 p3 R L */
615 p1 = (packet[0] & 0x20) >> 5;
616 p2 = (packet[0] & 0x10) >> 4;
618 /* byte 0: n1 n0 p2 p1 1 p3 R L */
619 p1 = (packet[0] & 0x10) >> 4;
620 p2 = (packet[0] & 0x20) >> 5;
623 p3 = (packet[0] & 0x04) >> 2;
625 return etd->parity[packet[1]] == p1 &&
626 etd->parity[packet[2]] == p2 &&
627 etd->parity[packet[3]] == p3;
630 static int elantech_debounce_check_v2(struct psmouse *psmouse)
633 * When we encounter packet that matches this exactly, it means the
634 * hardware is in debounce status. Just ignore the whole packet.
636 const u8 debounce_packet[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
637 unsigned char *packet = psmouse->packet;
639 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
642 static int elantech_packet_check_v2(struct psmouse *psmouse)
644 struct elantech_data *etd = psmouse->private;
645 unsigned char *packet = psmouse->packet;
648 * V2 hardware has two flavors. Older ones that do not report pressure,
649 * and newer ones that reports pressure and width. With newer ones, all
650 * packets (1, 2, 3 finger touch) have the same constant bits. With
651 * older ones, 1/3 finger touch packets and 2 finger touch packets
652 * have different constant bits.
653 * With all three cases, if the constant bits are not exactly what I
654 * expected, I consider them invalid.
656 if (etd->reports_pressure)
657 return (packet[0] & 0x0c) == 0x04 &&
658 (packet[3] & 0x0f) == 0x02;
660 if ((packet[0] & 0xc0) == 0x80)
661 return (packet[0] & 0x0c) == 0x0c &&
662 (packet[3] & 0x0e) == 0x08;
664 return (packet[0] & 0x3c) == 0x3c &&
665 (packet[1] & 0xf0) == 0x00 &&
666 (packet[3] & 0x3e) == 0x38 &&
667 (packet[4] & 0xf0) == 0x00;
671 * We check the constant bits to determine what packet type we get,
672 * so packet checking is mandatory for v3 and later hardware.
674 static int elantech_packet_check_v3(struct psmouse *psmouse)
676 const u8 debounce_packet[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
677 unsigned char *packet = psmouse->packet;
680 * check debounce first, it has the same signature in byte 0
681 * and byte 3 as PACKET_V3_HEAD.
683 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
684 return PACKET_DEBOUNCE;
686 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
687 return PACKET_V3_HEAD;
689 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
690 return PACKET_V3_TAIL;
692 return PACKET_UNKNOWN;
695 static int elantech_packet_check_v4(struct psmouse *psmouse)
697 unsigned char *packet = psmouse->packet;
699 if ((packet[0] & 0x0c) == 0x04 &&
700 (packet[3] & 0x1f) == 0x11)
701 return PACKET_V4_HEAD;
703 if ((packet[0] & 0x0c) == 0x04 &&
704 (packet[3] & 0x1f) == 0x12)
705 return PACKET_V4_MOTION;
707 if ((packet[0] & 0x0c) == 0x04 &&
708 (packet[3] & 0x1f) == 0x10)
709 return PACKET_V4_STATUS;
711 return PACKET_UNKNOWN;
715 * Process byte stream from mouse and handle complete packets
717 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
719 struct elantech_data *etd = psmouse->private;
722 if (psmouse->pktcnt < psmouse->pktsize)
723 return PSMOUSE_GOOD_DATA;
726 elantech_packet_dump(psmouse);
728 switch (etd->hw_version) {
730 if (etd->paritycheck && !elantech_packet_check_v1(psmouse))
731 return PSMOUSE_BAD_DATA;
733 elantech_report_absolute_v1(psmouse);
737 /* ignore debounce */
738 if (elantech_debounce_check_v2(psmouse))
739 return PSMOUSE_FULL_PACKET;
741 if (etd->paritycheck && !elantech_packet_check_v2(psmouse))
742 return PSMOUSE_BAD_DATA;
744 elantech_report_absolute_v2(psmouse);
748 packet_type = elantech_packet_check_v3(psmouse);
749 /* ignore debounce */
750 if (packet_type == PACKET_DEBOUNCE)
751 return PSMOUSE_FULL_PACKET;
753 if (packet_type == PACKET_UNKNOWN)
754 return PSMOUSE_BAD_DATA;
756 elantech_report_absolute_v3(psmouse, packet_type);
760 packet_type = elantech_packet_check_v4(psmouse);
761 if (packet_type == PACKET_UNKNOWN)
762 return PSMOUSE_BAD_DATA;
764 elantech_report_absolute_v4(psmouse, packet_type);
768 return PSMOUSE_FULL_PACKET;
772 * Put the touchpad into absolute mode
774 static int elantech_set_absolute_mode(struct psmouse *psmouse)
776 struct elantech_data *etd = psmouse->private;
778 int tries = ETP_READ_BACK_TRIES;
781 switch (etd->hw_version) {
785 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
786 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
792 /* Windows driver values */
794 etd->reg_11 = 0x88; /* 0x8a */
795 etd->reg_21 = 0x60; /* 0x00 */
796 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
797 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
798 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
805 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
812 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
815 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
820 * Read back reg 0x10. For hardware version 1 we must make
821 * sure the absolute mode bit is set. For hardware version 2
822 * the touchpad is probably initializing and not ready until
823 * we read back the value we just wrote.
826 rc = elantech_read_reg(psmouse, 0x10, &val);
830 elantech_debug("retrying read (%d).\n", tries);
831 msleep(ETP_READ_BACK_DELAY);
836 "failed to read back register 0x10.\n");
837 } else if (etd->hw_version == 1 &&
838 !(val & ETP_R10_ABSOLUTE_MODE)) {
840 "touchpad refuses to switch to absolute mode.\n");
845 skip_readback_reg_10:
847 psmouse_err(psmouse, "failed to initialise registers.\n");
852 static int elantech_set_range(struct psmouse *psmouse,
853 unsigned int *x_min, unsigned int *y_min,
854 unsigned int *x_max, unsigned int *y_max,
857 struct elantech_data *etd = psmouse->private;
858 unsigned char param[3];
859 unsigned char traces;
861 switch (etd->hw_version) {
863 *x_min = ETP_XMIN_V1;
864 *y_min = ETP_YMIN_V1;
865 *x_max = ETP_XMAX_V1;
866 *y_max = ETP_YMAX_V1;
870 if (etd->fw_version == 0x020800 ||
871 etd->fw_version == 0x020b00 ||
872 etd->fw_version == 0x020030) {
873 *x_min = ETP_XMIN_V2;
874 *y_min = ETP_YMIN_V2;
875 *x_max = ETP_XMAX_V2;
876 *y_max = ETP_YMAX_V2;
881 i = (etd->fw_version > 0x020800 &&
882 etd->fw_version < 0x020900) ? 1 : 2;
884 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
887 fixed_dpi = param[1] & 0x10;
889 if (((etd->fw_version >> 16) == 0x14) && fixed_dpi) {
890 if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
893 *x_max = (etd->capabilities[1] - i) * param[1] / 2;
894 *y_max = (etd->capabilities[2] - i) * param[2] / 2;
895 } else if (etd->fw_version == 0x040216) {
898 } else if (etd->fw_version == 0x040219 || etd->fw_version == 0x040215) {
902 *x_max = (etd->capabilities[1] - i) * 64;
903 *y_max = (etd->capabilities[2] - i) * 64;
909 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
912 *x_max = (0x0f & param[0]) << 8 | param[1];
913 *y_max = (0xf0 & param[0]) << 4 | param[2];
917 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
920 *x_max = (0x0f & param[0]) << 8 | param[1];
921 *y_max = (0xf0 & param[0]) << 4 | param[2];
922 traces = etd->capabilities[1];
923 if ((traces < 2) || (traces > *x_max))
926 *width = *x_max / (traces - 1);
934 * (value from firmware) * 10 + 790 = dpi
935 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
937 static unsigned int elantech_convert_res(unsigned int val)
939 return (val * 10 + 790) * 10 / 254;
942 static int elantech_get_resolution_v4(struct psmouse *psmouse,
946 unsigned char param[3];
948 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
951 *x_res = elantech_convert_res(param[1] & 0x0f);
952 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
958 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
959 * fw_version for this is based on the following fw_version & caps table:
961 * Laptop-model: fw_version: caps: buttons:
962 * Acer S3 0x461f00 10, 13, 0e clickpad
963 * Acer S7-392 0x581f01 50, 17, 0d clickpad
964 * Acer V5-131 0x461f02 01, 16, 0c clickpad
965 * Acer V5-551 0x461f00 ? clickpad
966 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
967 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
968 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
969 * Asus UX31 0x361f00 20, 15, 0e clickpad
970 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
971 * Avatar AVIU-145A2 0x361f00 ? clickpad
972 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
973 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
974 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
975 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
976 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
977 * Samsung NP900X3E-A02 0x575f03 ? clickpad
978 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
979 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
980 * Samsung RF710 0x450f00 ? 2 hw buttons
981 * System76 Pangolin 0x250f01 ? 2 hw buttons
982 * (*) + 3 trackpoint buttons
984 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
986 struct input_dev *dev = psmouse->dev;
987 struct elantech_data *etd = psmouse->private;
989 if (etd->fw_version & 0x001000) {
990 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
991 __clear_bit(BTN_RIGHT, dev->keybit);
996 * Set the appropriate event bits for the input subsystem
998 static int elantech_set_input_params(struct psmouse *psmouse)
1000 struct input_dev *dev = psmouse->dev;
1001 struct elantech_data *etd = psmouse->private;
1002 unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1003 unsigned int x_res = 0, y_res = 0;
1005 if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1008 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1009 __set_bit(EV_KEY, dev->evbit);
1010 __set_bit(EV_ABS, dev->evbit);
1011 __clear_bit(EV_REL, dev->evbit);
1013 __set_bit(BTN_LEFT, dev->keybit);
1014 __set_bit(BTN_RIGHT, dev->keybit);
1016 __set_bit(BTN_TOUCH, dev->keybit);
1017 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1018 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1019 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1021 switch (etd->hw_version) {
1024 if (etd->fw_version < 0x020000 &&
1025 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1026 __set_bit(BTN_FORWARD, dev->keybit);
1027 __set_bit(BTN_BACK, dev->keybit);
1029 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1030 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1034 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1035 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1038 if (etd->hw_version == 3)
1039 elantech_set_buttonpad_prop(psmouse);
1040 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1041 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1042 if (etd->reports_pressure) {
1043 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1045 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1048 input_mt_init_slots(dev, 2, 0);
1049 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1050 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1054 if (elantech_get_resolution_v4(psmouse, &x_res, &y_res)) {
1056 * if query failed, print a warning and leave the values
1057 * zero to resemble synaptics.c behavior.
1059 psmouse_warn(psmouse, "couldn't query resolution data.\n");
1061 elantech_set_buttonpad_prop(psmouse);
1062 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1063 /* For X to recognize me as touchpad. */
1064 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1065 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1066 input_abs_set_res(dev, ABS_X, x_res);
1067 input_abs_set_res(dev, ABS_Y, y_res);
1069 * range of pressure and width is the same as v2,
1070 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1072 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1074 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1076 /* Multitouch capable pad, up to 5 fingers. */
1077 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1078 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1079 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1080 input_abs_set_res(dev, ABS_MT_POSITION_X, x_res);
1081 input_abs_set_res(dev, ABS_MT_POSITION_Y, y_res);
1082 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1085 * The firmware reports how many trace lines the finger spans,
1086 * convert to surface unit as Protocol-B requires.
1088 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1089 ETP_WMAX_V2 * width, 0, 0);
1099 struct elantech_attr_data {
1100 size_t field_offset;
1105 * Display a register value by reading a sysfs entry
1107 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1110 struct elantech_data *etd = psmouse->private;
1111 struct elantech_attr_data *attr = data;
1112 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1116 rc = elantech_read_reg(psmouse, attr->reg, reg);
1118 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1122 * Write a register value by writing a sysfs entry
1124 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1125 void *data, const char *buf, size_t count)
1127 struct elantech_data *etd = psmouse->private;
1128 struct elantech_attr_data *attr = data;
1129 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1130 unsigned char value;
1133 err = kstrtou8(buf, 16, &value);
1137 /* Do we need to preserve some bits for version 2 hardware too? */
1138 if (etd->hw_version == 1) {
1139 if (attr->reg == 0x10)
1140 /* Force absolute mode always on */
1141 value |= ETP_R10_ABSOLUTE_MODE;
1142 else if (attr->reg == 0x11)
1143 /* Force 4 byte mode always on */
1144 value |= ETP_R11_4_BYTE_MODE;
1147 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1153 #define ELANTECH_INT_ATTR(_name, _register) \
1154 static struct elantech_attr_data elantech_attr_##_name = { \
1155 .field_offset = offsetof(struct elantech_data, _name), \
1158 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1159 &elantech_attr_##_name, \
1160 elantech_show_int_attr, \
1161 elantech_set_int_attr)
1163 ELANTECH_INT_ATTR(reg_07, 0x07);
1164 ELANTECH_INT_ATTR(reg_10, 0x10);
1165 ELANTECH_INT_ATTR(reg_11, 0x11);
1166 ELANTECH_INT_ATTR(reg_20, 0x20);
1167 ELANTECH_INT_ATTR(reg_21, 0x21);
1168 ELANTECH_INT_ATTR(reg_22, 0x22);
1169 ELANTECH_INT_ATTR(reg_23, 0x23);
1170 ELANTECH_INT_ATTR(reg_24, 0x24);
1171 ELANTECH_INT_ATTR(reg_25, 0x25);
1172 ELANTECH_INT_ATTR(reg_26, 0x26);
1173 ELANTECH_INT_ATTR(debug, 0);
1174 ELANTECH_INT_ATTR(paritycheck, 0);
1176 static struct attribute *elantech_attrs[] = {
1177 &psmouse_attr_reg_07.dattr.attr,
1178 &psmouse_attr_reg_10.dattr.attr,
1179 &psmouse_attr_reg_11.dattr.attr,
1180 &psmouse_attr_reg_20.dattr.attr,
1181 &psmouse_attr_reg_21.dattr.attr,
1182 &psmouse_attr_reg_22.dattr.attr,
1183 &psmouse_attr_reg_23.dattr.attr,
1184 &psmouse_attr_reg_24.dattr.attr,
1185 &psmouse_attr_reg_25.dattr.attr,
1186 &psmouse_attr_reg_26.dattr.attr,
1187 &psmouse_attr_debug.dattr.attr,
1188 &psmouse_attr_paritycheck.dattr.attr,
1192 static struct attribute_group elantech_attr_group = {
1193 .attrs = elantech_attrs,
1196 static bool elantech_is_signature_valid(const unsigned char *param)
1198 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1207 for (i = 0; i < ARRAY_SIZE(rates); i++)
1208 if (param[2] == rates[i])
1215 * Use magic knock to detect Elantech touchpad
1217 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1219 struct ps2dev *ps2dev = &psmouse->ps2dev;
1220 unsigned char param[3];
1222 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1224 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1225 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1226 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1227 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1228 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1229 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1234 * Report this in case there are Elantech models that use a different
1235 * set of magic numbers
1237 if (param[0] != 0x3c || param[1] != 0x03 ||
1238 (param[2] != 0xc8 && param[2] != 0x00)) {
1239 psmouse_dbg(psmouse,
1240 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1241 param[0], param[1], param[2]);
1246 * Query touchpad's firmware version and see if it reports known
1247 * value to avoid mis-detection. Logitech mice are known to respond
1248 * to Elantech magic knock and there might be more.
1250 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1251 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1255 psmouse_dbg(psmouse,
1256 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1257 param[0], param[1], param[2]);
1259 if (!elantech_is_signature_valid(param)) {
1260 psmouse_dbg(psmouse,
1261 "Probably not a real Elantech touchpad. Aborting.\n");
1265 if (set_properties) {
1266 psmouse->vendor = "Elantech";
1267 psmouse->name = "Touchpad";
1274 * Clean up sysfs entries when disconnecting
1276 static void elantech_disconnect(struct psmouse *psmouse)
1278 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1279 &elantech_attr_group);
1280 kfree(psmouse->private);
1281 psmouse->private = NULL;
1285 * Put the touchpad back into absolute mode when reconnecting
1287 static int elantech_reconnect(struct psmouse *psmouse)
1289 psmouse_reset(psmouse);
1291 if (elantech_detect(psmouse, 0))
1294 if (elantech_set_absolute_mode(psmouse)) {
1295 psmouse_err(psmouse,
1296 "failed to put touchpad back into absolute mode.\n");
1304 * determine hardware version and set some properties according to it.
1306 static int elantech_set_properties(struct elantech_data *etd)
1308 /* This represents the version of IC body. */
1309 int ver = (etd->fw_version & 0x0f0000) >> 16;
1311 /* Early version of Elan touchpads doesn't obey the rule. */
1312 if (etd->fw_version < 0x020030 || etd->fw_version == 0x020600)
1313 etd->hw_version = 1;
1318 etd->hw_version = 2;
1321 etd->hw_version = 3;
1324 etd->hw_version = 4;
1331 /* decide which send_cmd we're gonna use early */
1332 etd->send_cmd = etd->hw_version >= 3 ? elantech_send_cmd :
1335 /* Turn on packet checking by default */
1336 etd->paritycheck = 1;
1339 * This firmware suffers from misreporting coordinates when
1340 * a touch action starts causing the mouse cursor or scrolled page
1341 * to jump. Enable a workaround.
1344 (etd->fw_version == 0x020022 || etd->fw_version == 0x020600);
1346 if (etd->hw_version > 1) {
1347 /* For now show extra debug information */
1350 if (etd->fw_version >= 0x020800)
1351 etd->reports_pressure = true;
1358 * Initialize the touchpad and create sysfs entries
1360 int elantech_init(struct psmouse *psmouse)
1362 struct elantech_data *etd;
1364 unsigned char param[3];
1366 psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
1370 psmouse_reset(psmouse);
1373 for (i = 1; i < 256; i++)
1374 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1377 * Do the version query again so we can store the result
1379 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1380 psmouse_err(psmouse, "failed to query firmware version.\n");
1383 etd->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1385 if (elantech_set_properties(etd)) {
1386 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1389 psmouse_info(psmouse,
1390 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1391 etd->hw_version, param[0], param[1], param[2]);
1393 if (etd->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1394 etd->capabilities)) {
1395 psmouse_err(psmouse, "failed to query capabilities.\n");
1398 psmouse_info(psmouse,
1399 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1400 etd->capabilities[0], etd->capabilities[1],
1401 etd->capabilities[2]);
1403 if (elantech_set_absolute_mode(psmouse)) {
1404 psmouse_err(psmouse,
1405 "failed to put touchpad into absolute mode.\n");
1409 if (elantech_set_input_params(psmouse)) {
1410 psmouse_err(psmouse, "failed to query touchpad range.\n");
1414 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1415 &elantech_attr_group);
1417 psmouse_err(psmouse,
1418 "failed to create sysfs attributes, error: %d.\n",
1423 psmouse->protocol_handler = elantech_process_byte;
1424 psmouse->disconnect = elantech_disconnect;
1425 psmouse->reconnect = elantech_reconnect;
1426 psmouse->pktsize = etd->hw_version > 1 ? 6 : 4;