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/dmi.h>
15 #include <linux/slab.h>
16 #include <linux/module.h>
17 #include <linux/input.h>
18 #include <linux/input/mt.h>
19 #include <linux/serio.h>
20 #include <linux/libps2.h>
24 #define elantech_debug(fmt, ...) \
27 psmouse_printk(KERN_DEBUG, psmouse, \
28 fmt, ##__VA_ARGS__); \
32 * Send a Synaptics style sliced query command
34 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
37 if (psmouse_sliced_command(psmouse, c) ||
38 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
39 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
47 * V3 and later support this fast command
49 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
52 struct ps2dev *ps2dev = &psmouse->ps2dev;
54 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
55 ps2_command(ps2dev, NULL, c) ||
56 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
57 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
65 * A retrying version of ps2_command
67 static int elantech_ps2_command(struct psmouse *psmouse,
68 unsigned char *param, int command)
70 struct ps2dev *ps2dev = &psmouse->ps2dev;
71 struct elantech_data *etd = psmouse->private;
73 int tries = ETP_PS2_COMMAND_TRIES;
76 rc = ps2_command(ps2dev, param, command);
80 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
82 msleep(ETP_PS2_COMMAND_DELAY);
86 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
92 * Send an Elantech style special command to read a value from a register
94 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
97 struct elantech_data *etd = psmouse->private;
98 unsigned char param[3];
101 if (reg < 0x07 || reg > 0x26)
104 if (reg > 0x11 && reg < 0x20)
107 switch (etd->hw_version) {
109 if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
110 psmouse_sliced_command(psmouse, reg) ||
111 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
117 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
118 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
119 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
120 elantech_ps2_command(psmouse, NULL, reg) ||
121 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
127 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
128 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
129 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
130 elantech_ps2_command(psmouse, NULL, reg) ||
131 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
138 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
139 else if (etd->hw_version != 4)
148 * Send an Elantech style special command to write a register with a value
150 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
153 struct elantech_data *etd = psmouse->private;
156 if (reg < 0x07 || reg > 0x26)
159 if (reg > 0x11 && reg < 0x20)
162 switch (etd->hw_version) {
164 if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
165 psmouse_sliced_command(psmouse, reg) ||
166 psmouse_sliced_command(psmouse, val) ||
167 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
173 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
174 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
175 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
176 elantech_ps2_command(psmouse, NULL, reg) ||
177 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
178 elantech_ps2_command(psmouse, NULL, val) ||
179 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
185 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
186 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
187 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
188 elantech_ps2_command(psmouse, NULL, reg) ||
189 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
190 elantech_ps2_command(psmouse, NULL, val) ||
191 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
197 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
198 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
199 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
200 elantech_ps2_command(psmouse, NULL, reg) ||
201 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, val) ||
205 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
213 "failed to write register 0x%02x with value 0x%02x.\n",
220 * Dump a complete mouse movement packet to the syslog
222 static void elantech_packet_dump(struct psmouse *psmouse)
226 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [");
227 for (i = 0; i < psmouse->pktsize; i++)
228 printk("%s0x%02x ", i ? ", " : " ", psmouse->packet[i]);
233 * Interpret complete data packets and report absolute mode input events for
234 * hardware version 1. (4 byte packets)
236 static void elantech_report_absolute_v1(struct psmouse *psmouse)
238 struct input_dev *dev = psmouse->dev;
239 struct elantech_data *etd = psmouse->private;
240 unsigned char *packet = psmouse->packet;
243 if (etd->fw_version < 0x020000) {
245 * byte 0: D U p1 p2 1 p3 R L
246 * byte 1: f 0 th tw x9 x8 y9 y8
248 fingers = ((packet[1] & 0x80) >> 7) +
249 ((packet[1] & 0x30) >> 4);
252 * byte 0: n1 n0 p2 p1 1 p3 R L
253 * byte 1: 0 0 0 0 x9 x8 y9 y8
255 fingers = (packet[0] & 0xc0) >> 6;
258 if (etd->jumpy_cursor) {
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++;
264 elantech_debug("discarding packet\n");
269 input_report_key(dev, BTN_TOUCH, fingers != 0);
272 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
273 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
276 input_report_abs(dev, ABS_X,
277 ((packet[1] & 0x0c) << 6) | packet[2]);
278 input_report_abs(dev, ABS_Y,
279 etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
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);
285 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
286 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
288 if (etd->fw_version < 0x020000 &&
289 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
291 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
293 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
299 static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
300 unsigned int x, unsigned int y)
302 input_mt_slot(dev, slot);
303 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
305 input_report_abs(dev, ABS_MT_POSITION_X, x);
306 input_report_abs(dev, ABS_MT_POSITION_Y, y);
310 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
311 static 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)
316 elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
317 elantech_set_slot(dev, 1, num_fingers == 2, x2, y2);
321 * Interpret complete data packets and report absolute mode input events for
322 * hardware version 2. (6 byte packets)
324 static void elantech_report_absolute_v2(struct psmouse *psmouse)
326 struct elantech_data *etd = psmouse->private;
327 struct input_dev *dev = psmouse->dev;
328 unsigned char *packet = psmouse->packet;
329 unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
330 unsigned int width = 0, pres = 0;
332 /* byte 0: n1 n0 . . . . R L */
333 fingers = (packet[0] & 0xc0) >> 6;
338 * Same as one finger, except report of more than 3 fingers:
339 * byte 3: n4 . w1 w0 . . . .
341 if (packet[3] & 0x80)
343 /* pass through... */
346 * byte 1: . . . . x11 x10 x9 x8
347 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
349 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
351 * byte 4: . . . . y11 y10 y9 y8
352 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
354 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
356 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
357 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
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
367 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
368 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
370 ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
372 * byte 3: . . by8 bx8 . . . .
373 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
375 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
376 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
378 ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
380 /* Unknown so just report sensible values */
386 input_report_key(dev, BTN_TOUCH, fingers != 0);
388 input_report_abs(dev, ABS_X, x1);
389 input_report_abs(dev, ABS_Y, y1);
391 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
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);
395 input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
396 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
397 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
398 if (etd->reports_pressure) {
399 input_report_abs(dev, ABS_PRESSURE, pres);
400 input_report_abs(dev, ABS_TOOL_WIDTH, width);
407 * Interpret complete data packets and report absolute mode input events for
408 * hardware version 3. (12 byte packets for two fingers)
410 static void elantech_report_absolute_v3(struct psmouse *psmouse,
413 struct input_dev *dev = psmouse->dev;
414 struct elantech_data *etd = psmouse->private;
415 unsigned char *packet = psmouse->packet;
416 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
417 unsigned int width = 0, pres = 0;
419 /* byte 0: n1 n0 . . . . R L */
420 fingers = (packet[0] & 0xc0) >> 6;
426 * byte 1: . . . . x11 x10 x9 x8
427 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
429 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
431 * byte 4: . . . . y11 y10 y9 y8
432 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
434 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
438 if (packet_type == PACKET_V3_HEAD) {
440 * byte 1: . . . . ax11 ax10 ax9 ax8
441 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
443 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
445 * byte 4: . . . . ay11 ay10 ay9 ay8
446 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
448 etd->mt[0].y = etd->y_max -
449 (((packet[4] & 0x0f) << 8) | packet[5]);
451 * wait for next packet
456 /* packet_type == PACKET_V3_TAIL */
459 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
460 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
464 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
465 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
467 input_report_key(dev, BTN_TOUCH, fingers != 0);
469 input_report_abs(dev, ABS_X, x1);
470 input_report_abs(dev, ABS_Y, y1);
472 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
473 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
474 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
475 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
476 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
477 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
478 input_report_abs(dev, ABS_PRESSURE, pres);
479 input_report_abs(dev, ABS_TOOL_WIDTH, width);
484 static void elantech_input_sync_v4(struct psmouse *psmouse)
486 struct input_dev *dev = psmouse->dev;
487 unsigned char *packet = psmouse->packet;
489 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
490 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
491 input_mt_report_pointer_emulation(dev, true);
495 static void process_packet_status_v4(struct psmouse *psmouse)
497 struct input_dev *dev = psmouse->dev;
498 unsigned char *packet = psmouse->packet;
502 /* notify finger state change */
503 fingers = packet[1] & 0x1f;
504 for (i = 0; i < ETP_MAX_FINGERS; i++) {
505 if ((fingers & (1 << i)) == 0) {
506 input_mt_slot(dev, i);
507 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
511 elantech_input_sync_v4(psmouse);
514 static void process_packet_head_v4(struct psmouse *psmouse)
516 struct input_dev *dev = psmouse->dev;
517 struct elantech_data *etd = psmouse->private;
518 unsigned char *packet = psmouse->packet;
519 int id = ((packet[3] & 0xe0) >> 5) - 1;
525 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
526 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
527 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
528 traces = (packet[0] & 0xf0) >> 4;
530 input_mt_slot(dev, id);
531 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
533 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
534 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
535 input_report_abs(dev, ABS_MT_PRESSURE, pres);
536 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
537 /* report this for backwards compatibility */
538 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
540 elantech_input_sync_v4(psmouse);
543 static void process_packet_motion_v4(struct psmouse *psmouse)
545 struct input_dev *dev = psmouse->dev;
546 struct elantech_data *etd = psmouse->private;
547 unsigned char *packet = psmouse->packet;
548 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
551 id = ((packet[0] & 0xe0) >> 5) - 1;
555 sid = ((packet[3] & 0xe0) >> 5) - 1;
556 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
558 * Motion packets give us the delta of x, y values of specific fingers,
559 * but in two's complement. Let the compiler do the conversion for us.
560 * Also _enlarge_ the numbers to int, in case of overflow.
562 delta_x1 = (signed char)packet[1];
563 delta_y1 = (signed char)packet[2];
564 delta_x2 = (signed char)packet[4];
565 delta_y2 = (signed char)packet[5];
567 etd->mt[id].x += delta_x1 * weight;
568 etd->mt[id].y -= delta_y1 * weight;
569 input_mt_slot(dev, id);
570 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
571 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
574 etd->mt[sid].x += delta_x2 * weight;
575 etd->mt[sid].y -= delta_y2 * weight;
576 input_mt_slot(dev, sid);
577 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
578 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
581 elantech_input_sync_v4(psmouse);
584 static void elantech_report_absolute_v4(struct psmouse *psmouse,
587 switch (packet_type) {
588 case PACKET_V4_STATUS:
589 process_packet_status_v4(psmouse);
593 process_packet_head_v4(psmouse);
596 case PACKET_V4_MOTION:
597 process_packet_motion_v4(psmouse);
602 /* impossible to get here */
607 static int elantech_packet_check_v1(struct psmouse *psmouse)
609 struct elantech_data *etd = psmouse->private;
610 unsigned char *packet = psmouse->packet;
611 unsigned char p1, p2, p3;
613 /* Parity bits are placed differently */
614 if (etd->fw_version < 0x020000) {
615 /* byte 0: D U p1 p2 1 p3 R L */
616 p1 = (packet[0] & 0x20) >> 5;
617 p2 = (packet[0] & 0x10) >> 4;
619 /* byte 0: n1 n0 p2 p1 1 p3 R L */
620 p1 = (packet[0] & 0x10) >> 4;
621 p2 = (packet[0] & 0x20) >> 5;
624 p3 = (packet[0] & 0x04) >> 2;
626 return etd->parity[packet[1]] == p1 &&
627 etd->parity[packet[2]] == p2 &&
628 etd->parity[packet[3]] == p3;
631 static int elantech_debounce_check_v2(struct psmouse *psmouse)
634 * When we encounter packet that matches this exactly, it means the
635 * hardware is in debounce status. Just ignore the whole packet.
637 const u8 debounce_packet[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
638 unsigned char *packet = psmouse->packet;
640 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
643 static int elantech_packet_check_v2(struct psmouse *psmouse)
645 struct elantech_data *etd = psmouse->private;
646 unsigned char *packet = psmouse->packet;
649 * V2 hardware has two flavors. Older ones that do not report pressure,
650 * and newer ones that reports pressure and width. With newer ones, all
651 * packets (1, 2, 3 finger touch) have the same constant bits. With
652 * older ones, 1/3 finger touch packets and 2 finger touch packets
653 * have different constant bits.
654 * With all three cases, if the constant bits are not exactly what I
655 * expected, I consider them invalid.
657 if (etd->reports_pressure)
658 return (packet[0] & 0x0c) == 0x04 &&
659 (packet[3] & 0x0f) == 0x02;
661 if ((packet[0] & 0xc0) == 0x80)
662 return (packet[0] & 0x0c) == 0x0c &&
663 (packet[3] & 0x0e) == 0x08;
665 return (packet[0] & 0x3c) == 0x3c &&
666 (packet[1] & 0xf0) == 0x00 &&
667 (packet[3] & 0x3e) == 0x38 &&
668 (packet[4] & 0xf0) == 0x00;
672 * We check the constant bits to determine what packet type we get,
673 * so packet checking is mandatory for v3 and later hardware.
675 static int elantech_packet_check_v3(struct psmouse *psmouse)
677 struct elantech_data *etd = psmouse->private;
678 const u8 debounce_packet[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
679 unsigned char *packet = psmouse->packet;
682 * check debounce first, it has the same signature in byte 0
683 * and byte 3 as PACKET_V3_HEAD.
685 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
686 return PACKET_DEBOUNCE;
689 * If the hardware flag 'crc_enabled' is set the packets have
690 * different signatures.
692 if (etd->crc_enabled) {
693 if ((packet[3] & 0x09) == 0x08)
694 return PACKET_V3_HEAD;
696 if ((packet[3] & 0x09) == 0x09)
697 return PACKET_V3_TAIL;
699 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
700 return PACKET_V3_HEAD;
702 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
703 return PACKET_V3_TAIL;
706 return PACKET_UNKNOWN;
709 static int elantech_packet_check_v4(struct psmouse *psmouse)
711 struct elantech_data *etd = psmouse->private;
712 unsigned char *packet = psmouse->packet;
713 unsigned char packet_type = packet[3] & 0x03;
717 * Sanity check based on the constant bits of a packet.
718 * The constant bits change depending on the value of
719 * the hardware flag 'crc_enabled' but are the same for
720 * every packet, regardless of the type.
722 if (etd->crc_enabled)
723 sanity_check = ((packet[3] & 0x08) == 0x00);
725 sanity_check = ((packet[0] & 0x0c) == 0x04 &&
726 (packet[3] & 0x1c) == 0x10);
729 return PACKET_UNKNOWN;
731 switch (packet_type) {
733 return PACKET_V4_STATUS;
736 return PACKET_V4_HEAD;
739 return PACKET_V4_MOTION;
742 return PACKET_UNKNOWN;
746 * Process byte stream from mouse and handle complete packets
748 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
750 struct elantech_data *etd = psmouse->private;
753 if (psmouse->pktcnt < psmouse->pktsize)
754 return PSMOUSE_GOOD_DATA;
757 elantech_packet_dump(psmouse);
759 switch (etd->hw_version) {
761 if (etd->paritycheck && !elantech_packet_check_v1(psmouse))
762 return PSMOUSE_BAD_DATA;
764 elantech_report_absolute_v1(psmouse);
768 /* ignore debounce */
769 if (elantech_debounce_check_v2(psmouse))
770 return PSMOUSE_FULL_PACKET;
772 if (etd->paritycheck && !elantech_packet_check_v2(psmouse))
773 return PSMOUSE_BAD_DATA;
775 elantech_report_absolute_v2(psmouse);
779 packet_type = elantech_packet_check_v3(psmouse);
780 /* ignore debounce */
781 if (packet_type == PACKET_DEBOUNCE)
782 return PSMOUSE_FULL_PACKET;
784 if (packet_type == PACKET_UNKNOWN)
785 return PSMOUSE_BAD_DATA;
787 elantech_report_absolute_v3(psmouse, packet_type);
791 packet_type = elantech_packet_check_v4(psmouse);
792 if (packet_type == PACKET_UNKNOWN)
793 return PSMOUSE_BAD_DATA;
795 elantech_report_absolute_v4(psmouse, packet_type);
799 return PSMOUSE_FULL_PACKET;
803 * Put the touchpad into absolute mode
805 static int elantech_set_absolute_mode(struct psmouse *psmouse)
807 struct elantech_data *etd = psmouse->private;
809 int tries = ETP_READ_BACK_TRIES;
812 switch (etd->hw_version) {
816 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
817 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
823 /* Windows driver values */
825 etd->reg_11 = 0x88; /* 0x8a */
826 etd->reg_21 = 0x60; /* 0x00 */
827 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
828 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
829 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
835 if (etd->set_hw_resolution)
840 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
847 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
850 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
855 * Read back reg 0x10. For hardware version 1 we must make
856 * sure the absolute mode bit is set. For hardware version 2
857 * the touchpad is probably initializing and not ready until
858 * we read back the value we just wrote.
861 rc = elantech_read_reg(psmouse, 0x10, &val);
865 elantech_debug("retrying read (%d).\n", tries);
866 msleep(ETP_READ_BACK_DELAY);
871 "failed to read back register 0x10.\n");
872 } else if (etd->hw_version == 1 &&
873 !(val & ETP_R10_ABSOLUTE_MODE)) {
875 "touchpad refuses to switch to absolute mode.\n");
880 skip_readback_reg_10:
882 psmouse_err(psmouse, "failed to initialise registers.\n");
887 static int elantech_set_range(struct psmouse *psmouse,
888 unsigned int *x_min, unsigned int *y_min,
889 unsigned int *x_max, unsigned int *y_max,
892 struct elantech_data *etd = psmouse->private;
893 unsigned char param[3];
894 unsigned char traces;
896 switch (etd->hw_version) {
898 *x_min = ETP_XMIN_V1;
899 *y_min = ETP_YMIN_V1;
900 *x_max = ETP_XMAX_V1;
901 *y_max = ETP_YMAX_V1;
905 if (etd->fw_version == 0x020800 ||
906 etd->fw_version == 0x020b00 ||
907 etd->fw_version == 0x020030) {
908 *x_min = ETP_XMIN_V2;
909 *y_min = ETP_YMIN_V2;
910 *x_max = ETP_XMAX_V2;
911 *y_max = ETP_YMAX_V2;
916 i = (etd->fw_version > 0x020800 &&
917 etd->fw_version < 0x020900) ? 1 : 2;
919 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
922 fixed_dpi = param[1] & 0x10;
924 if (((etd->fw_version >> 16) == 0x14) && fixed_dpi) {
925 if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
928 *x_max = (etd->capabilities[1] - i) * param[1] / 2;
929 *y_max = (etd->capabilities[2] - i) * param[2] / 2;
930 } else if (etd->fw_version == 0x040216) {
933 } else if (etd->fw_version == 0x040219 || etd->fw_version == 0x040215) {
937 *x_max = (etd->capabilities[1] - i) * 64;
938 *y_max = (etd->capabilities[2] - i) * 64;
944 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
947 *x_max = (0x0f & param[0]) << 8 | param[1];
948 *y_max = (0xf0 & param[0]) << 4 | param[2];
952 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
955 *x_max = (0x0f & param[0]) << 8 | param[1];
956 *y_max = (0xf0 & param[0]) << 4 | param[2];
957 traces = etd->capabilities[1];
958 if ((traces < 2) || (traces > *x_max))
961 *width = *x_max / (traces - 1);
969 * (value from firmware) * 10 + 790 = dpi
970 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
972 static unsigned int elantech_convert_res(unsigned int val)
974 return (val * 10 + 790) * 10 / 254;
977 static int elantech_get_resolution_v4(struct psmouse *psmouse,
981 unsigned char param[3];
983 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
986 *x_res = elantech_convert_res(param[1] & 0x0f);
987 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
993 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
994 * fw_version for this is based on the following fw_version & caps table:
996 * Laptop-model: fw_version: caps: buttons:
997 * Acer S3 0x461f00 10, 13, 0e clickpad
998 * Acer S7-392 0x581f01 50, 17, 0d clickpad
999 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1000 * Acer V5-551 0x461f00 ? clickpad
1001 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1002 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1003 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
1004 * Asus UX31 0x361f00 20, 15, 0e clickpad
1005 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1006 * Avatar AVIU-145A2 0x361f00 ? clickpad
1007 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1008 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
1009 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1010 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1011 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1012 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1013 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1014 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1015 * Samsung RF710 0x450f00 ? 2 hw buttons
1016 * System76 Pangolin 0x250f01 ? 2 hw buttons
1017 * (*) + 3 trackpoint buttons
1019 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1021 struct input_dev *dev = psmouse->dev;
1022 struct elantech_data *etd = psmouse->private;
1024 if (etd->fw_version & 0x001000) {
1025 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1026 __clear_bit(BTN_RIGHT, dev->keybit);
1031 * Set the appropriate event bits for the input subsystem
1033 static int elantech_set_input_params(struct psmouse *psmouse)
1035 struct input_dev *dev = psmouse->dev;
1036 struct elantech_data *etd = psmouse->private;
1037 unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1038 unsigned int x_res = 0, y_res = 0;
1040 if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1043 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1044 __set_bit(EV_KEY, dev->evbit);
1045 __set_bit(EV_ABS, dev->evbit);
1046 __clear_bit(EV_REL, dev->evbit);
1048 __set_bit(BTN_LEFT, dev->keybit);
1049 __set_bit(BTN_RIGHT, dev->keybit);
1051 __set_bit(BTN_TOUCH, dev->keybit);
1052 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1053 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1054 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1056 switch (etd->hw_version) {
1059 if (etd->fw_version < 0x020000 &&
1060 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1061 __set_bit(BTN_FORWARD, dev->keybit);
1062 __set_bit(BTN_BACK, dev->keybit);
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);
1069 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1070 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1073 if (etd->hw_version == 3)
1074 elantech_set_buttonpad_prop(psmouse);
1075 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1076 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1077 if (etd->reports_pressure) {
1078 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1080 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1083 input_mt_init_slots(dev, 2, 0);
1084 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1085 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1089 if (elantech_get_resolution_v4(psmouse, &x_res, &y_res)) {
1091 * if query failed, print a warning and leave the values
1092 * zero to resemble synaptics.c behavior.
1094 psmouse_warn(psmouse, "couldn't query resolution data.\n");
1096 elantech_set_buttonpad_prop(psmouse);
1097 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1098 /* For X to recognize me as touchpad. */
1099 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1100 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1101 input_abs_set_res(dev, ABS_X, x_res);
1102 input_abs_set_res(dev, ABS_Y, y_res);
1104 * range of pressure and width is the same as v2,
1105 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1107 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1109 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1111 /* Multitouch capable pad, up to 5 fingers. */
1112 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1113 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1114 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1115 input_abs_set_res(dev, ABS_MT_POSITION_X, x_res);
1116 input_abs_set_res(dev, ABS_MT_POSITION_Y, y_res);
1117 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1120 * The firmware reports how many trace lines the finger spans,
1121 * convert to surface unit as Protocol-B requires.
1123 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1124 ETP_WMAX_V2 * width, 0, 0);
1134 struct elantech_attr_data {
1135 size_t field_offset;
1140 * Display a register value by reading a sysfs entry
1142 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1145 struct elantech_data *etd = psmouse->private;
1146 struct elantech_attr_data *attr = data;
1147 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1151 rc = elantech_read_reg(psmouse, attr->reg, reg);
1153 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1157 * Write a register value by writing a sysfs entry
1159 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1160 void *data, const char *buf, size_t count)
1162 struct elantech_data *etd = psmouse->private;
1163 struct elantech_attr_data *attr = data;
1164 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1165 unsigned char value;
1168 err = kstrtou8(buf, 16, &value);
1172 /* Do we need to preserve some bits for version 2 hardware too? */
1173 if (etd->hw_version == 1) {
1174 if (attr->reg == 0x10)
1175 /* Force absolute mode always on */
1176 value |= ETP_R10_ABSOLUTE_MODE;
1177 else if (attr->reg == 0x11)
1178 /* Force 4 byte mode always on */
1179 value |= ETP_R11_4_BYTE_MODE;
1182 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1188 #define ELANTECH_INT_ATTR(_name, _register) \
1189 static struct elantech_attr_data elantech_attr_##_name = { \
1190 .field_offset = offsetof(struct elantech_data, _name), \
1193 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1194 &elantech_attr_##_name, \
1195 elantech_show_int_attr, \
1196 elantech_set_int_attr)
1198 ELANTECH_INT_ATTR(reg_07, 0x07);
1199 ELANTECH_INT_ATTR(reg_10, 0x10);
1200 ELANTECH_INT_ATTR(reg_11, 0x11);
1201 ELANTECH_INT_ATTR(reg_20, 0x20);
1202 ELANTECH_INT_ATTR(reg_21, 0x21);
1203 ELANTECH_INT_ATTR(reg_22, 0x22);
1204 ELANTECH_INT_ATTR(reg_23, 0x23);
1205 ELANTECH_INT_ATTR(reg_24, 0x24);
1206 ELANTECH_INT_ATTR(reg_25, 0x25);
1207 ELANTECH_INT_ATTR(reg_26, 0x26);
1208 ELANTECH_INT_ATTR(debug, 0);
1209 ELANTECH_INT_ATTR(paritycheck, 0);
1211 static struct attribute *elantech_attrs[] = {
1212 &psmouse_attr_reg_07.dattr.attr,
1213 &psmouse_attr_reg_10.dattr.attr,
1214 &psmouse_attr_reg_11.dattr.attr,
1215 &psmouse_attr_reg_20.dattr.attr,
1216 &psmouse_attr_reg_21.dattr.attr,
1217 &psmouse_attr_reg_22.dattr.attr,
1218 &psmouse_attr_reg_23.dattr.attr,
1219 &psmouse_attr_reg_24.dattr.attr,
1220 &psmouse_attr_reg_25.dattr.attr,
1221 &psmouse_attr_reg_26.dattr.attr,
1222 &psmouse_attr_debug.dattr.attr,
1223 &psmouse_attr_paritycheck.dattr.attr,
1227 static struct attribute_group elantech_attr_group = {
1228 .attrs = elantech_attrs,
1231 static bool elantech_is_signature_valid(const unsigned char *param)
1233 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1242 for (i = 0; i < ARRAY_SIZE(rates); i++)
1243 if (param[2] == rates[i])
1250 * Use magic knock to detect Elantech touchpad
1252 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1254 struct ps2dev *ps2dev = &psmouse->ps2dev;
1255 unsigned char param[3];
1257 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1259 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1260 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1261 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1262 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1263 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1264 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1269 * Report this in case there are Elantech models that use a different
1270 * set of magic numbers
1272 if (param[0] != 0x3c || param[1] != 0x03 ||
1273 (param[2] != 0xc8 && param[2] != 0x00)) {
1274 psmouse_dbg(psmouse,
1275 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1276 param[0], param[1], param[2]);
1281 * Query touchpad's firmware version and see if it reports known
1282 * value to avoid mis-detection. Logitech mice are known to respond
1283 * to Elantech magic knock and there might be more.
1285 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1286 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1290 psmouse_dbg(psmouse,
1291 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1292 param[0], param[1], param[2]);
1294 if (!elantech_is_signature_valid(param)) {
1295 psmouse_dbg(psmouse,
1296 "Probably not a real Elantech touchpad. Aborting.\n");
1300 if (set_properties) {
1301 psmouse->vendor = "Elantech";
1302 psmouse->name = "Touchpad";
1309 * Clean up sysfs entries when disconnecting
1311 static void elantech_disconnect(struct psmouse *psmouse)
1313 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1314 &elantech_attr_group);
1315 kfree(psmouse->private);
1316 psmouse->private = NULL;
1320 * Put the touchpad back into absolute mode when reconnecting
1322 static int elantech_reconnect(struct psmouse *psmouse)
1324 psmouse_reset(psmouse);
1326 if (elantech_detect(psmouse, 0))
1329 if (elantech_set_absolute_mode(psmouse)) {
1330 psmouse_err(psmouse,
1331 "failed to put touchpad back into absolute mode.\n");
1339 * Some hw_version 3 models go into error state when we try to set bit 3 of r10
1341 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1342 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1344 /* Gigabyte U2442 */
1346 DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1347 DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1355 * determine hardware version and set some properties according to it.
1357 static int elantech_set_properties(struct elantech_data *etd)
1359 /* This represents the version of IC body. */
1360 int ver = (etd->fw_version & 0x0f0000) >> 16;
1362 /* Early version of Elan touchpads doesn't obey the rule. */
1363 if (etd->fw_version < 0x020030 || etd->fw_version == 0x020600)
1364 etd->hw_version = 1;
1369 etd->hw_version = 2;
1372 etd->hw_version = 3;
1378 etd->hw_version = 4;
1385 /* decide which send_cmd we're gonna use early */
1386 etd->send_cmd = etd->hw_version >= 3 ? elantech_send_cmd :
1389 /* Turn on packet checking by default */
1390 etd->paritycheck = 1;
1393 * This firmware suffers from misreporting coordinates when
1394 * a touch action starts causing the mouse cursor or scrolled page
1395 * to jump. Enable a workaround.
1398 (etd->fw_version == 0x020022 || etd->fw_version == 0x020600);
1400 if (etd->hw_version > 1) {
1401 /* For now show extra debug information */
1404 if (etd->fw_version >= 0x020800)
1405 etd->reports_pressure = true;
1409 * The signatures of v3 and v4 packets change depending on the
1410 * value of this hardware flag.
1412 etd->crc_enabled = ((etd->fw_version & 0x4000) == 0x4000);
1414 /* Enable real hardware resolution on hw_version 3 ? */
1415 etd->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1421 * Initialize the touchpad and create sysfs entries
1423 int elantech_init(struct psmouse *psmouse)
1425 struct elantech_data *etd;
1427 unsigned char param[3];
1429 psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
1433 psmouse_reset(psmouse);
1436 for (i = 1; i < 256; i++)
1437 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1440 * Do the version query again so we can store the result
1442 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1443 psmouse_err(psmouse, "failed to query firmware version.\n");
1446 etd->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1448 if (elantech_set_properties(etd)) {
1449 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1452 psmouse_info(psmouse,
1453 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1454 etd->hw_version, param[0], param[1], param[2]);
1456 if (etd->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1457 etd->capabilities)) {
1458 psmouse_err(psmouse, "failed to query capabilities.\n");
1461 psmouse_info(psmouse,
1462 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1463 etd->capabilities[0], etd->capabilities[1],
1464 etd->capabilities[2]);
1466 if (elantech_set_absolute_mode(psmouse)) {
1467 psmouse_err(psmouse,
1468 "failed to put touchpad into absolute mode.\n");
1472 if (elantech_set_input_params(psmouse)) {
1473 psmouse_err(psmouse, "failed to query touchpad range.\n");
1477 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1478 &elantech_attr_group);
1480 psmouse_err(psmouse,
1481 "failed to create sysfs attributes, error: %d.\n",
1486 psmouse->protocol_handler = elantech_process_byte;
1487 psmouse->disconnect = elantech_disconnect;
1488 psmouse->reconnect = elantech_reconnect;
1489 psmouse->pktsize = etd->hw_version > 1 ? 6 : 4;