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>
21 #include <asm/unaligned.h>
25 #define elantech_debug(fmt, ...) \
28 psmouse_printk(KERN_DEBUG, psmouse, \
29 fmt, ##__VA_ARGS__); \
33 * Send a Synaptics style sliced query command
35 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
38 if (psmouse_sliced_command(psmouse, c) ||
39 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
40 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
48 * V3 and later support this fast command
50 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
53 struct ps2dev *ps2dev = &psmouse->ps2dev;
55 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
56 ps2_command(ps2dev, NULL, c) ||
57 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
58 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
66 * A retrying version of ps2_command
68 static int elantech_ps2_command(struct psmouse *psmouse,
69 unsigned char *param, int command)
71 struct ps2dev *ps2dev = &psmouse->ps2dev;
72 struct elantech_data *etd = psmouse->private;
74 int tries = ETP_PS2_COMMAND_TRIES;
77 rc = ps2_command(ps2dev, param, command);
81 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
83 msleep(ETP_PS2_COMMAND_DELAY);
87 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
93 * Send an Elantech style special command to read a value from a register
95 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
98 struct elantech_data *etd = psmouse->private;
99 unsigned char param[3];
102 if (reg < 0x07 || reg > 0x26)
105 if (reg > 0x11 && reg < 0x20)
108 switch (etd->hw_version) {
110 if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
111 psmouse_sliced_command(psmouse, reg) ||
112 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
118 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
119 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
120 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
121 elantech_ps2_command(psmouse, NULL, reg) ||
122 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
128 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
129 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
130 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
131 elantech_ps2_command(psmouse, NULL, reg) ||
132 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
139 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
140 else if (etd->hw_version != 4)
149 * Send an Elantech style special command to write a register with a value
151 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
154 struct elantech_data *etd = psmouse->private;
157 if (reg < 0x07 || reg > 0x26)
160 if (reg > 0x11 && reg < 0x20)
163 switch (etd->hw_version) {
165 if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
166 psmouse_sliced_command(psmouse, reg) ||
167 psmouse_sliced_command(psmouse, val) ||
168 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
174 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
175 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
176 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
177 elantech_ps2_command(psmouse, NULL, reg) ||
178 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
179 elantech_ps2_command(psmouse, NULL, val) ||
180 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
186 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
187 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
188 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
189 elantech_ps2_command(psmouse, NULL, reg) ||
190 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
191 elantech_ps2_command(psmouse, NULL, val) ||
192 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
198 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
199 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
200 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
201 elantech_ps2_command(psmouse, NULL, reg) ||
202 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
203 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
204 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
205 elantech_ps2_command(psmouse, NULL, val) ||
206 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
214 "failed to write register 0x%02x with value 0x%02x.\n",
221 * Dump a complete mouse movement packet to the syslog
223 static void elantech_packet_dump(struct psmouse *psmouse)
225 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [%*ph]\n",
226 psmouse->pktsize, psmouse->packet);
230 * Interpret complete data packets and report absolute mode input events for
231 * hardware version 1. (4 byte packets)
233 static void elantech_report_absolute_v1(struct psmouse *psmouse)
235 struct input_dev *dev = psmouse->dev;
236 struct elantech_data *etd = psmouse->private;
237 unsigned char *packet = psmouse->packet;
240 if (etd->fw_version < 0x020000) {
242 * byte 0: D U p1 p2 1 p3 R L
243 * byte 1: f 0 th tw x9 x8 y9 y8
245 fingers = ((packet[1] & 0x80) >> 7) +
246 ((packet[1] & 0x30) >> 4);
249 * byte 0: n1 n0 p2 p1 1 p3 R L
250 * byte 1: 0 0 0 0 x9 x8 y9 y8
252 fingers = (packet[0] & 0xc0) >> 6;
255 if (etd->jumpy_cursor) {
257 etd->single_finger_reports = 0;
258 } else if (etd->single_finger_reports < 2) {
259 /* Discard first 2 reports of one finger, bogus */
260 etd->single_finger_reports++;
261 elantech_debug("discarding packet\n");
266 input_report_key(dev, BTN_TOUCH, fingers != 0);
269 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
270 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
273 input_report_abs(dev, ABS_X,
274 ((packet[1] & 0x0c) << 6) | packet[2]);
275 input_report_abs(dev, ABS_Y,
276 etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
279 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
280 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
281 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
282 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
283 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
285 if (etd->fw_version < 0x020000 &&
286 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
288 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
290 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
296 static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
297 unsigned int x, unsigned int y)
299 input_mt_slot(dev, slot);
300 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
302 input_report_abs(dev, ABS_MT_POSITION_X, x);
303 input_report_abs(dev, ABS_MT_POSITION_Y, y);
307 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
308 static void elantech_report_semi_mt_data(struct input_dev *dev,
309 unsigned int num_fingers,
310 unsigned int x1, unsigned int y1,
311 unsigned int x2, unsigned int y2)
313 elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
314 elantech_set_slot(dev, 1, num_fingers >= 2, x2, y2);
318 * Interpret complete data packets and report absolute mode input events for
319 * hardware version 2. (6 byte packets)
321 static void elantech_report_absolute_v2(struct psmouse *psmouse)
323 struct elantech_data *etd = psmouse->private;
324 struct input_dev *dev = psmouse->dev;
325 unsigned char *packet = psmouse->packet;
326 unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
327 unsigned int width = 0, pres = 0;
329 /* byte 0: n1 n0 . . . . R L */
330 fingers = (packet[0] & 0xc0) >> 6;
335 * Same as one finger, except report of more than 3 fingers:
336 * byte 3: n4 . w1 w0 . . . .
338 if (packet[3] & 0x80)
340 /* pass through... */
343 * byte 1: . . . . x11 x10 x9 x8
344 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
346 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
348 * byte 4: . . . . y11 y10 y9 y8
349 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
351 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
353 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
354 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
359 * The coordinate of each finger is reported separately
360 * with a lower resolution for two finger touches:
361 * byte 0: . . ay8 ax8 . . . .
362 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
364 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
365 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
367 ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
369 * byte 3: . . by8 bx8 . . . .
370 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
372 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
373 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
375 ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
377 /* Unknown so just report sensible values */
383 input_report_key(dev, BTN_TOUCH, fingers != 0);
385 input_report_abs(dev, ABS_X, x1);
386 input_report_abs(dev, ABS_Y, y1);
388 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
389 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
390 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
391 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
392 input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
393 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
394 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
395 if (etd->reports_pressure) {
396 input_report_abs(dev, ABS_PRESSURE, pres);
397 input_report_abs(dev, ABS_TOOL_WIDTH, width);
403 static void elantech_report_trackpoint(struct psmouse *psmouse,
407 * byte 0: 0 0 sx sy 0 M R L
408 * byte 1:~sx 0 0 0 0 0 0 0
409 * byte 2:~sy 0 0 0 0 0 0 0
410 * byte 3: 0 0 ~sy ~sx 0 1 1 0
411 * byte 4: x7 x6 x5 x4 x3 x2 x1 x0
412 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
414 * x and y are written in two's complement spread
415 * over 9 bits with sx/sy the relative top bit and
416 * x7..x0 and y7..y0 the lower bits.
417 * The sign of y is opposite to what the input driver
418 * expects for a relative movement
421 struct elantech_data *etd = psmouse->private;
422 struct input_dev *tp_dev = etd->tp_dev;
423 unsigned char *packet = psmouse->packet;
427 t = get_unaligned_le32(&packet[0]);
436 * This firmware misreport coordinates for trackpoint
437 * occasionally. Discard packets outside of [-127, 127] range
438 * to prevent cursor jumps.
440 if (packet[4] == 0x80 || packet[5] == 0x80 ||
441 packet[1] >> 7 == packet[4] >> 7 ||
442 packet[2] >> 7 == packet[5] >> 7) {
443 elantech_debug("discarding packet [%6ph]\n", packet);
447 x = packet[4] - (int)((packet[1]^0x80) << 1);
448 y = (int)((packet[2]^0x80) << 1) - packet[5];
450 input_report_key(tp_dev, BTN_LEFT, packet[0] & 0x01);
451 input_report_key(tp_dev, BTN_RIGHT, packet[0] & 0x02);
452 input_report_key(tp_dev, BTN_MIDDLE, packet[0] & 0x04);
454 input_report_rel(tp_dev, REL_X, x);
455 input_report_rel(tp_dev, REL_Y, y);
462 /* Dump unexpected packet sequences if debug=1 (default) */
464 elantech_packet_dump(psmouse);
471 * Interpret complete data packets and report absolute mode input events for
472 * hardware version 3. (12 byte packets for two fingers)
474 static void elantech_report_absolute_v3(struct psmouse *psmouse,
477 struct input_dev *dev = psmouse->dev;
478 struct elantech_data *etd = psmouse->private;
479 unsigned char *packet = psmouse->packet;
480 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
481 unsigned int width = 0, pres = 0;
483 /* byte 0: n1 n0 . . . . R L */
484 fingers = (packet[0] & 0xc0) >> 6;
490 * byte 1: . . . . x11 x10 x9 x8
491 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
493 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
495 * byte 4: . . . . y11 y10 y9 y8
496 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
498 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
502 if (packet_type == PACKET_V3_HEAD) {
504 * byte 1: . . . . ax11 ax10 ax9 ax8
505 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
507 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
509 * byte 4: . . . . ay11 ay10 ay9 ay8
510 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
512 etd->mt[0].y = etd->y_max -
513 (((packet[4] & 0x0f) << 8) | packet[5]);
515 * wait for next packet
520 /* packet_type == PACKET_V3_TAIL */
523 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
524 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
528 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
529 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
531 input_report_key(dev, BTN_TOUCH, fingers != 0);
533 input_report_abs(dev, ABS_X, x1);
534 input_report_abs(dev, ABS_Y, y1);
536 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
537 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
538 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
539 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
541 /* For clickpads map both buttons to BTN_LEFT */
542 if (etd->fw_version & 0x001000) {
543 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
545 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
546 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
549 input_report_abs(dev, ABS_PRESSURE, pres);
550 input_report_abs(dev, ABS_TOOL_WIDTH, width);
555 static void elantech_input_sync_v4(struct psmouse *psmouse)
557 struct input_dev *dev = psmouse->dev;
558 struct elantech_data *etd = psmouse->private;
559 unsigned char *packet = psmouse->packet;
561 /* For clickpads map both buttons to BTN_LEFT */
562 if (etd->fw_version & 0x001000) {
563 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
565 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
566 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
567 input_report_key(dev, BTN_MIDDLE, packet[0] & 0x04);
570 input_mt_report_pointer_emulation(dev, true);
574 static void process_packet_status_v4(struct psmouse *psmouse)
576 struct input_dev *dev = psmouse->dev;
577 unsigned char *packet = psmouse->packet;
581 /* notify finger state change */
582 fingers = packet[1] & 0x1f;
583 for (i = 0; i < ETP_MAX_FINGERS; i++) {
584 if ((fingers & (1 << i)) == 0) {
585 input_mt_slot(dev, i);
586 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
590 elantech_input_sync_v4(psmouse);
593 static void process_packet_head_v4(struct psmouse *psmouse)
595 struct input_dev *dev = psmouse->dev;
596 struct elantech_data *etd = psmouse->private;
597 unsigned char *packet = psmouse->packet;
598 int id = ((packet[3] & 0xe0) >> 5) - 1;
604 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
605 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
606 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
607 traces = (packet[0] & 0xf0) >> 4;
609 input_mt_slot(dev, id);
610 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
612 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
613 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
614 input_report_abs(dev, ABS_MT_PRESSURE, pres);
615 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
616 /* report this for backwards compatibility */
617 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
619 elantech_input_sync_v4(psmouse);
622 static void process_packet_motion_v4(struct psmouse *psmouse)
624 struct input_dev *dev = psmouse->dev;
625 struct elantech_data *etd = psmouse->private;
626 unsigned char *packet = psmouse->packet;
627 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
630 id = ((packet[0] & 0xe0) >> 5) - 1;
634 sid = ((packet[3] & 0xe0) >> 5) - 1;
635 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
637 * Motion packets give us the delta of x, y values of specific fingers,
638 * but in two's complement. Let the compiler do the conversion for us.
639 * Also _enlarge_ the numbers to int, in case of overflow.
641 delta_x1 = (signed char)packet[1];
642 delta_y1 = (signed char)packet[2];
643 delta_x2 = (signed char)packet[4];
644 delta_y2 = (signed char)packet[5];
646 etd->mt[id].x += delta_x1 * weight;
647 etd->mt[id].y -= delta_y1 * weight;
648 input_mt_slot(dev, id);
649 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
650 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
653 etd->mt[sid].x += delta_x2 * weight;
654 etd->mt[sid].y -= delta_y2 * weight;
655 input_mt_slot(dev, sid);
656 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
657 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
660 elantech_input_sync_v4(psmouse);
663 static void elantech_report_absolute_v4(struct psmouse *psmouse,
666 switch (packet_type) {
667 case PACKET_V4_STATUS:
668 process_packet_status_v4(psmouse);
672 process_packet_head_v4(psmouse);
675 case PACKET_V4_MOTION:
676 process_packet_motion_v4(psmouse);
681 /* impossible to get here */
686 static int elantech_packet_check_v1(struct psmouse *psmouse)
688 struct elantech_data *etd = psmouse->private;
689 unsigned char *packet = psmouse->packet;
690 unsigned char p1, p2, p3;
692 /* Parity bits are placed differently */
693 if (etd->fw_version < 0x020000) {
694 /* byte 0: D U p1 p2 1 p3 R L */
695 p1 = (packet[0] & 0x20) >> 5;
696 p2 = (packet[0] & 0x10) >> 4;
698 /* byte 0: n1 n0 p2 p1 1 p3 R L */
699 p1 = (packet[0] & 0x10) >> 4;
700 p2 = (packet[0] & 0x20) >> 5;
703 p3 = (packet[0] & 0x04) >> 2;
705 return etd->parity[packet[1]] == p1 &&
706 etd->parity[packet[2]] == p2 &&
707 etd->parity[packet[3]] == p3;
710 static int elantech_debounce_check_v2(struct psmouse *psmouse)
713 * When we encounter packet that matches this exactly, it means the
714 * hardware is in debounce status. Just ignore the whole packet.
716 static const u8 debounce_packet[] = {
717 0x84, 0xff, 0xff, 0x02, 0xff, 0xff
719 unsigned char *packet = psmouse->packet;
721 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
724 static int elantech_packet_check_v2(struct psmouse *psmouse)
726 struct elantech_data *etd = psmouse->private;
727 unsigned char *packet = psmouse->packet;
730 * V2 hardware has two flavors. Older ones that do not report pressure,
731 * and newer ones that reports pressure and width. With newer ones, all
732 * packets (1, 2, 3 finger touch) have the same constant bits. With
733 * older ones, 1/3 finger touch packets and 2 finger touch packets
734 * have different constant bits.
735 * With all three cases, if the constant bits are not exactly what I
736 * expected, I consider them invalid.
738 if (etd->reports_pressure)
739 return (packet[0] & 0x0c) == 0x04 &&
740 (packet[3] & 0x0f) == 0x02;
742 if ((packet[0] & 0xc0) == 0x80)
743 return (packet[0] & 0x0c) == 0x0c &&
744 (packet[3] & 0x0e) == 0x08;
746 return (packet[0] & 0x3c) == 0x3c &&
747 (packet[1] & 0xf0) == 0x00 &&
748 (packet[3] & 0x3e) == 0x38 &&
749 (packet[4] & 0xf0) == 0x00;
753 * We check the constant bits to determine what packet type we get,
754 * so packet checking is mandatory for v3 and later hardware.
756 static int elantech_packet_check_v3(struct psmouse *psmouse)
758 struct elantech_data *etd = psmouse->private;
759 static const u8 debounce_packet[] = {
760 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff
762 unsigned char *packet = psmouse->packet;
765 * check debounce first, it has the same signature in byte 0
766 * and byte 3 as PACKET_V3_HEAD.
768 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
769 return PACKET_DEBOUNCE;
772 * If the hardware flag 'crc_enabled' is set the packets have
773 * different signatures.
775 if (etd->crc_enabled) {
776 if ((packet[3] & 0x09) == 0x08)
777 return PACKET_V3_HEAD;
779 if ((packet[3] & 0x09) == 0x09)
780 return PACKET_V3_TAIL;
782 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
783 return PACKET_V3_HEAD;
785 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
786 return PACKET_V3_TAIL;
787 if ((packet[3] & 0x0f) == 0x06)
788 return PACKET_TRACKPOINT;
791 return PACKET_UNKNOWN;
794 static int elantech_packet_check_v4(struct psmouse *psmouse)
796 struct elantech_data *etd = psmouse->private;
797 unsigned char *packet = psmouse->packet;
798 unsigned char packet_type = packet[3] & 0x03;
799 unsigned int ic_version;
802 if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
803 return PACKET_TRACKPOINT;
805 /* This represents the version of IC body. */
806 ic_version = (etd->fw_version & 0x0f0000) >> 16;
809 * Sanity check based on the constant bits of a packet.
810 * The constant bits change depending on the value of
811 * the hardware flag 'crc_enabled' and the version of
812 * the IC body, but are the same for every packet,
813 * regardless of the type.
815 if (etd->crc_enabled)
816 sanity_check = ((packet[3] & 0x08) == 0x00);
817 else if (ic_version == 7 && etd->samples[1] == 0x2A)
818 sanity_check = ((packet[3] & 0x1c) == 0x10);
820 sanity_check = ((packet[0] & 0x08) == 0x00 &&
821 (packet[3] & 0x1c) == 0x10);
824 return PACKET_UNKNOWN;
826 switch (packet_type) {
828 return PACKET_V4_STATUS;
831 return PACKET_V4_HEAD;
834 return PACKET_V4_MOTION;
837 return PACKET_UNKNOWN;
841 * Process byte stream from mouse and handle complete packets
843 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
845 struct elantech_data *etd = psmouse->private;
848 if (psmouse->pktcnt < psmouse->pktsize)
849 return PSMOUSE_GOOD_DATA;
852 elantech_packet_dump(psmouse);
854 switch (etd->hw_version) {
856 if (etd->paritycheck && !elantech_packet_check_v1(psmouse))
857 return PSMOUSE_BAD_DATA;
859 elantech_report_absolute_v1(psmouse);
863 /* ignore debounce */
864 if (elantech_debounce_check_v2(psmouse))
865 return PSMOUSE_FULL_PACKET;
867 if (etd->paritycheck && !elantech_packet_check_v2(psmouse))
868 return PSMOUSE_BAD_DATA;
870 elantech_report_absolute_v2(psmouse);
874 packet_type = elantech_packet_check_v3(psmouse);
875 switch (packet_type) {
877 return PSMOUSE_BAD_DATA;
879 case PACKET_DEBOUNCE:
880 /* ignore debounce */
883 case PACKET_TRACKPOINT:
884 elantech_report_trackpoint(psmouse, packet_type);
888 elantech_report_absolute_v3(psmouse, packet_type);
895 packet_type = elantech_packet_check_v4(psmouse);
896 switch (packet_type) {
898 return PSMOUSE_BAD_DATA;
900 case PACKET_TRACKPOINT:
901 elantech_report_trackpoint(psmouse, packet_type);
905 elantech_report_absolute_v4(psmouse, packet_type);
912 return PSMOUSE_FULL_PACKET;
916 * This writes the reg_07 value again to the hardware at the end of every
917 * set_rate call because the register loses its value. reg_07 allows setting
918 * absolute mode on v4 hardware
920 static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
923 struct elantech_data *etd = psmouse->private;
925 etd->original_set_rate(psmouse, rate);
926 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
927 psmouse_err(psmouse, "restoring reg_07 failed\n");
931 * Put the touchpad into absolute mode
933 static int elantech_set_absolute_mode(struct psmouse *psmouse)
935 struct elantech_data *etd = psmouse->private;
937 int tries = ETP_READ_BACK_TRIES;
940 switch (etd->hw_version) {
944 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
945 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
951 /* Windows driver values */
953 etd->reg_11 = 0x88; /* 0x8a */
954 etd->reg_21 = 0x60; /* 0x00 */
955 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
956 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
957 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
963 if (etd->set_hw_resolution)
968 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
975 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
978 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
983 * Read back reg 0x10. For hardware version 1 we must make
984 * sure the absolute mode bit is set. For hardware version 2
985 * the touchpad is probably initializing and not ready until
986 * we read back the value we just wrote.
989 rc = elantech_read_reg(psmouse, 0x10, &val);
993 elantech_debug("retrying read (%d).\n", tries);
994 msleep(ETP_READ_BACK_DELAY);
999 "failed to read back register 0x10.\n");
1000 } else if (etd->hw_version == 1 &&
1001 !(val & ETP_R10_ABSOLUTE_MODE)) {
1002 psmouse_err(psmouse,
1003 "touchpad refuses to switch to absolute mode.\n");
1008 skip_readback_reg_10:
1010 psmouse_err(psmouse, "failed to initialise registers.\n");
1015 static int elantech_set_range(struct psmouse *psmouse,
1016 unsigned int *x_min, unsigned int *y_min,
1017 unsigned int *x_max, unsigned int *y_max,
1018 unsigned int *width)
1020 struct elantech_data *etd = psmouse->private;
1021 unsigned char param[3];
1022 unsigned char traces;
1024 switch (etd->hw_version) {
1026 *x_min = ETP_XMIN_V1;
1027 *y_min = ETP_YMIN_V1;
1028 *x_max = ETP_XMAX_V1;
1029 *y_max = ETP_YMAX_V1;
1033 if (etd->fw_version == 0x020800 ||
1034 etd->fw_version == 0x020b00 ||
1035 etd->fw_version == 0x020030) {
1036 *x_min = ETP_XMIN_V2;
1037 *y_min = ETP_YMIN_V2;
1038 *x_max = ETP_XMAX_V2;
1039 *y_max = ETP_YMAX_V2;
1044 i = (etd->fw_version > 0x020800 &&
1045 etd->fw_version < 0x020900) ? 1 : 2;
1047 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1050 fixed_dpi = param[1] & 0x10;
1052 if (((etd->fw_version >> 16) == 0x14) && fixed_dpi) {
1053 if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
1056 *x_max = (etd->capabilities[1] - i) * param[1] / 2;
1057 *y_max = (etd->capabilities[2] - i) * param[2] / 2;
1058 } else if (etd->fw_version == 0x040216) {
1061 } else if (etd->fw_version == 0x040219 || etd->fw_version == 0x040215) {
1065 *x_max = (etd->capabilities[1] - i) * 64;
1066 *y_max = (etd->capabilities[2] - i) * 64;
1072 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1075 *x_max = (0x0f & param[0]) << 8 | param[1];
1076 *y_max = (0xf0 & param[0]) << 4 | param[2];
1080 if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1083 *x_max = (0x0f & param[0]) << 8 | param[1];
1084 *y_max = (0xf0 & param[0]) << 4 | param[2];
1085 traces = etd->capabilities[1];
1086 if ((traces < 2) || (traces > *x_max))
1089 *width = *x_max / (traces - 1);
1097 * (value from firmware) * 10 + 790 = dpi
1098 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1100 static unsigned int elantech_convert_res(unsigned int val)
1102 return (val * 10 + 790) * 10 / 254;
1105 static int elantech_get_resolution_v4(struct psmouse *psmouse,
1106 unsigned int *x_res,
1107 unsigned int *y_res)
1109 unsigned char param[3];
1111 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1114 *x_res = elantech_convert_res(param[1] & 0x0f);
1115 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
1121 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1122 * fw_version for this is based on the following fw_version & caps table:
1124 * Laptop-model: fw_version: caps: buttons:
1125 * Acer S3 0x461f00 10, 13, 0e clickpad
1126 * Acer S7-392 0x581f01 50, 17, 0d clickpad
1127 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1128 * Acer V5-551 0x461f00 ? clickpad
1129 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1130 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1131 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
1132 * Asus TP500LN 0x381f17 10, 14, 0e clickpad
1133 * Asus X750JN 0x381f17 10, 14, 0e clickpad
1134 * Asus UX31 0x361f00 20, 15, 0e clickpad
1135 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1136 * Avatar AVIU-145A2 0x361f00 ? clickpad
1137 * Fujitsu CELSIUS H760 0x570f02 40, 14, 0c 3 hw buttons (**)
1138 * Fujitsu CELSIUS H780 0x5d0f02 41, 16, 0d 3 hw buttons (**)
1139 * Fujitsu LIFEBOOK E544 0x470f00 d0, 12, 09 2 hw buttons
1140 * Fujitsu LIFEBOOK E546 0x470f00 50, 12, 09 2 hw buttons
1141 * Fujitsu LIFEBOOK E547 0x470f00 50, 12, 09 2 hw buttons
1142 * Fujitsu LIFEBOOK E554 0x570f01 40, 14, 0c 2 hw buttons
1143 * Fujitsu LIFEBOOK E557 0x570f01 40, 14, 0c 2 hw buttons
1144 * Fujitsu T725 0x470f01 05, 12, 09 2 hw buttons
1145 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
1146 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1147 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
1148 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
1149 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1150 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1151 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1152 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1153 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1154 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1155 * Samsung RF710 0x450f00 ? 2 hw buttons
1156 * System76 Pangolin 0x250f01 ? 2 hw buttons
1157 * (*) + 3 trackpoint buttons
1158 * (**) + 0 trackpoint buttons
1159 * Note: Lenovo L430 and Lenovo L530 have the same fw_version/caps
1161 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1163 struct input_dev *dev = psmouse->dev;
1164 struct elantech_data *etd = psmouse->private;
1166 if (etd->fw_version & 0x001000) {
1167 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1168 __clear_bit(BTN_RIGHT, dev->keybit);
1173 * Some hw_version 4 models do have a middle button
1175 static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1176 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1178 /* Fujitsu H730 has a middle button */
1180 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1181 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1185 /* Fujitsu H760 also has a middle button */
1187 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1188 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1192 /* Fujitsu H780 also has a middle button */
1194 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1195 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H780"),
1202 static const char * const middle_button_pnp_ids[] = {
1203 "LEN2131", /* ThinkPad P52 w/ NFC */
1204 "LEN2132", /* ThinkPad P52 */
1205 "LEN2133", /* ThinkPad P72 w/ NFC */
1206 "LEN2134", /* ThinkPad P72 */
1213 * Set the appropriate event bits for the input subsystem
1215 static int elantech_set_input_params(struct psmouse *psmouse)
1217 struct input_dev *dev = psmouse->dev;
1218 struct elantech_data *etd = psmouse->private;
1219 unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1220 unsigned int x_res = 31, y_res = 31;
1222 if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1225 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1226 __set_bit(EV_KEY, dev->evbit);
1227 __set_bit(EV_ABS, dev->evbit);
1228 __clear_bit(EV_REL, dev->evbit);
1230 __set_bit(BTN_LEFT, dev->keybit);
1231 if (dmi_check_system(elantech_dmi_has_middle_button) ||
1232 psmouse_matches_pnp_id(psmouse, middle_button_pnp_ids))
1233 __set_bit(BTN_MIDDLE, dev->keybit);
1234 __set_bit(BTN_RIGHT, dev->keybit);
1236 __set_bit(BTN_TOUCH, dev->keybit);
1237 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1238 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1239 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1241 switch (etd->hw_version) {
1244 if (etd->fw_version < 0x020000 &&
1245 (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1246 __set_bit(BTN_FORWARD, dev->keybit);
1247 __set_bit(BTN_BACK, dev->keybit);
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);
1254 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1255 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1258 if (etd->hw_version == 3)
1259 elantech_set_buttonpad_prop(psmouse);
1260 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1261 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1262 if (etd->reports_pressure) {
1263 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1265 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1268 input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
1269 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1270 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1274 if (elantech_get_resolution_v4(psmouse, &x_res, &y_res)) {
1276 * if query failed, print a warning and leave the values
1277 * zero to resemble synaptics.c behavior.
1279 psmouse_warn(psmouse, "couldn't query resolution data.\n");
1281 elantech_set_buttonpad_prop(psmouse);
1282 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1283 /* For X to recognize me as touchpad. */
1284 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1285 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1287 * range of pressure and width is the same as v2,
1288 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1290 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1292 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1294 /* Multitouch capable pad, up to 5 fingers. */
1295 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1296 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1297 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1298 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1301 * The firmware reports how many trace lines the finger spans,
1302 * convert to surface unit as Protocol-B requires.
1304 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1305 ETP_WMAX_V2 * width, 0, 0);
1309 input_abs_set_res(dev, ABS_X, x_res);
1310 input_abs_set_res(dev, ABS_Y, y_res);
1311 if (etd->hw_version > 1) {
1312 input_abs_set_res(dev, ABS_MT_POSITION_X, x_res);
1313 input_abs_set_res(dev, ABS_MT_POSITION_Y, y_res);
1322 struct elantech_attr_data {
1323 size_t field_offset;
1328 * Display a register value by reading a sysfs entry
1330 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1333 struct elantech_data *etd = psmouse->private;
1334 struct elantech_attr_data *attr = data;
1335 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1339 rc = elantech_read_reg(psmouse, attr->reg, reg);
1341 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1345 * Write a register value by writing a sysfs entry
1347 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1348 void *data, const char *buf, size_t count)
1350 struct elantech_data *etd = psmouse->private;
1351 struct elantech_attr_data *attr = data;
1352 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1353 unsigned char value;
1356 err = kstrtou8(buf, 16, &value);
1360 /* Do we need to preserve some bits for version 2 hardware too? */
1361 if (etd->hw_version == 1) {
1362 if (attr->reg == 0x10)
1363 /* Force absolute mode always on */
1364 value |= ETP_R10_ABSOLUTE_MODE;
1365 else if (attr->reg == 0x11)
1366 /* Force 4 byte mode always on */
1367 value |= ETP_R11_4_BYTE_MODE;
1370 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1376 #define ELANTECH_INT_ATTR(_name, _register) \
1377 static struct elantech_attr_data elantech_attr_##_name = { \
1378 .field_offset = offsetof(struct elantech_data, _name), \
1381 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1382 &elantech_attr_##_name, \
1383 elantech_show_int_attr, \
1384 elantech_set_int_attr)
1386 ELANTECH_INT_ATTR(reg_07, 0x07);
1387 ELANTECH_INT_ATTR(reg_10, 0x10);
1388 ELANTECH_INT_ATTR(reg_11, 0x11);
1389 ELANTECH_INT_ATTR(reg_20, 0x20);
1390 ELANTECH_INT_ATTR(reg_21, 0x21);
1391 ELANTECH_INT_ATTR(reg_22, 0x22);
1392 ELANTECH_INT_ATTR(reg_23, 0x23);
1393 ELANTECH_INT_ATTR(reg_24, 0x24);
1394 ELANTECH_INT_ATTR(reg_25, 0x25);
1395 ELANTECH_INT_ATTR(reg_26, 0x26);
1396 ELANTECH_INT_ATTR(debug, 0);
1397 ELANTECH_INT_ATTR(paritycheck, 0);
1398 ELANTECH_INT_ATTR(crc_enabled, 0);
1400 static struct attribute *elantech_attrs[] = {
1401 &psmouse_attr_reg_07.dattr.attr,
1402 &psmouse_attr_reg_10.dattr.attr,
1403 &psmouse_attr_reg_11.dattr.attr,
1404 &psmouse_attr_reg_20.dattr.attr,
1405 &psmouse_attr_reg_21.dattr.attr,
1406 &psmouse_attr_reg_22.dattr.attr,
1407 &psmouse_attr_reg_23.dattr.attr,
1408 &psmouse_attr_reg_24.dattr.attr,
1409 &psmouse_attr_reg_25.dattr.attr,
1410 &psmouse_attr_reg_26.dattr.attr,
1411 &psmouse_attr_debug.dattr.attr,
1412 &psmouse_attr_paritycheck.dattr.attr,
1413 &psmouse_attr_crc_enabled.dattr.attr,
1417 static const struct attribute_group elantech_attr_group = {
1418 .attrs = elantech_attrs,
1421 static bool elantech_is_signature_valid(const unsigned char *param)
1423 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1433 * Some hw_version >= 4 models have a revision higher then 20. Meaning
1434 * that param[2] may be 10 or 20, skip the rates check for these.
1436 if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1440 for (i = 0; i < ARRAY_SIZE(rates); i++)
1441 if (param[2] == rates[i])
1448 * Use magic knock to detect Elantech touchpad
1450 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1452 struct ps2dev *ps2dev = &psmouse->ps2dev;
1453 unsigned char param[3];
1455 ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1457 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1458 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1459 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1460 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1461 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1462 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1467 * Report this in case there are Elantech models that use a different
1468 * set of magic numbers
1470 if (param[0] != 0x3c || param[1] != 0x03 ||
1471 (param[2] != 0xc8 && param[2] != 0x00)) {
1472 psmouse_dbg(psmouse,
1473 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1474 param[0], param[1], param[2]);
1479 * Query touchpad's firmware version and see if it reports known
1480 * value to avoid mis-detection. Logitech mice are known to respond
1481 * to Elantech magic knock and there might be more.
1483 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1484 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1488 psmouse_dbg(psmouse,
1489 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1490 param[0], param[1], param[2]);
1492 if (!elantech_is_signature_valid(param)) {
1493 psmouse_dbg(psmouse,
1494 "Probably not a real Elantech touchpad. Aborting.\n");
1498 if (set_properties) {
1499 psmouse->vendor = "Elantech";
1500 psmouse->name = "Touchpad";
1507 * Clean up sysfs entries when disconnecting
1509 static void elantech_disconnect(struct psmouse *psmouse)
1511 struct elantech_data *etd = psmouse->private;
1514 input_unregister_device(etd->tp_dev);
1515 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1516 &elantech_attr_group);
1517 kfree(psmouse->private);
1518 psmouse->private = NULL;
1522 * Put the touchpad back into absolute mode when reconnecting
1524 static int elantech_reconnect(struct psmouse *psmouse)
1526 psmouse_reset(psmouse);
1528 if (elantech_detect(psmouse, 0))
1531 if (elantech_set_absolute_mode(psmouse)) {
1532 psmouse_err(psmouse,
1533 "failed to put touchpad back into absolute mode.\n");
1541 * Some hw_version 4 models do not work with crc_disabled
1543 static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1544 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1546 /* Fujitsu H730 does not work with crc_enabled == 0 */
1548 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1549 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1553 /* Fujitsu H760 does not work with crc_enabled == 0 */
1555 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1556 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1560 /* Fujitsu LIFEBOOK E544 does not work with crc_enabled == 0 */
1562 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1563 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1567 /* Fujitsu LIFEBOOK E546 does not work with crc_enabled == 0 */
1569 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1570 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1574 /* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1576 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1577 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1581 /* Fujitsu LIFEBOOK E554 does not work with crc_enabled == 0 */
1583 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1584 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1588 /* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
1590 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1591 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
1595 /* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1597 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1598 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1602 /* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1604 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1605 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1613 * Some hw_version 3 models go into error state when we try to set
1614 * bit 3 and/or bit 1 of r10.
1616 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1617 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1619 /* Gigabyte U2442 */
1621 DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1622 DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1630 * determine hardware version and set some properties according to it.
1632 static int elantech_set_properties(struct elantech_data *etd)
1634 /* This represents the version of IC body. */
1635 int ver = (etd->fw_version & 0x0f0000) >> 16;
1637 /* Early version of Elan touchpads doesn't obey the rule. */
1638 if (etd->fw_version < 0x020030 || etd->fw_version == 0x020600)
1639 etd->hw_version = 1;
1644 etd->hw_version = 2;
1647 etd->hw_version = 3;
1650 etd->hw_version = 4;
1657 /* decide which send_cmd we're gonna use early */
1658 etd->send_cmd = etd->hw_version >= 3 ? elantech_send_cmd :
1661 /* Turn on packet checking by default */
1662 etd->paritycheck = 1;
1665 * This firmware suffers from misreporting coordinates when
1666 * a touch action starts causing the mouse cursor or scrolled page
1667 * to jump. Enable a workaround.
1670 (etd->fw_version == 0x020022 || etd->fw_version == 0x020600);
1672 if (etd->hw_version > 1) {
1673 /* For now show extra debug information */
1676 if (etd->fw_version >= 0x020800)
1677 etd->reports_pressure = true;
1681 * The signatures of v3 and v4 packets change depending on the
1682 * value of this hardware flag.
1684 etd->crc_enabled = (etd->fw_version & 0x4000) == 0x4000 ||
1685 dmi_check_system(elantech_dmi_force_crc_enabled);
1687 /* Enable real hardware resolution on hw_version 3 ? */
1688 etd->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1694 * Initialize the touchpad and create sysfs entries
1696 int elantech_init(struct psmouse *psmouse)
1698 struct elantech_data *etd;
1700 int error = -EINVAL;
1701 unsigned char param[3];
1702 struct input_dev *tp_dev;
1704 psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
1708 psmouse_reset(psmouse);
1711 for (i = 1; i < 256; i++)
1712 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1715 * Do the version query again so we can store the result
1717 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1718 psmouse_err(psmouse, "failed to query firmware version.\n");
1721 etd->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1723 if (elantech_set_properties(etd)) {
1724 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1727 psmouse_info(psmouse,
1728 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1729 etd->hw_version, param[0], param[1], param[2]);
1731 if (etd->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1732 etd->capabilities)) {
1733 psmouse_err(psmouse, "failed to query capabilities.\n");
1736 psmouse_info(psmouse,
1737 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1738 etd->capabilities[0], etd->capabilities[1],
1739 etd->capabilities[2]);
1741 if (etd->hw_version != 1) {
1742 if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, etd->samples)) {
1743 psmouse_err(psmouse, "failed to query sample data\n");
1746 psmouse_info(psmouse,
1747 "Elan sample query result %02x, %02x, %02x\n",
1748 etd->samples[0], etd->samples[1], etd->samples[2]);
1751 if (etd->samples[1] == 0x74 && etd->hw_version == 0x03) {
1753 * This module has a bug which makes absolute mode
1754 * unusable, so let's abort so we'll be using standard
1757 psmouse_info(psmouse,
1758 "absolute mode broken, forcing standard PS/2 protocol\n");
1762 if (elantech_set_absolute_mode(psmouse)) {
1763 psmouse_err(psmouse,
1764 "failed to put touchpad into absolute mode.\n");
1768 if (etd->fw_version == 0x381f17) {
1769 etd->original_set_rate = psmouse->set_rate;
1770 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1773 if (elantech_set_input_params(psmouse)) {
1774 psmouse_err(psmouse, "failed to query touchpad range.\n");
1778 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1779 &elantech_attr_group);
1781 psmouse_err(psmouse,
1782 "failed to create sysfs attributes, error: %d.\n",
1787 /* The MSB indicates the presence of the trackpoint */
1788 if ((etd->capabilities[0] & 0x80) == 0x80) {
1789 tp_dev = input_allocate_device();
1793 goto init_fail_tp_alloc;
1796 etd->tp_dev = tp_dev;
1797 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1798 psmouse->ps2dev.serio->phys);
1799 tp_dev->phys = etd->tp_phys;
1800 tp_dev->name = "ETPS/2 Elantech TrackPoint";
1801 tp_dev->id.bustype = BUS_I8042;
1802 tp_dev->id.vendor = 0x0002;
1803 tp_dev->id.product = PSMOUSE_ELANTECH;
1804 tp_dev->id.version = 0x0000;
1805 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1806 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1807 tp_dev->relbit[BIT_WORD(REL_X)] =
1808 BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1809 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1810 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1811 BIT_MASK(BTN_RIGHT);
1813 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
1814 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1816 error = input_register_device(etd->tp_dev);
1818 goto init_fail_tp_reg;
1821 psmouse->protocol_handler = elantech_process_byte;
1822 psmouse->disconnect = elantech_disconnect;
1823 psmouse->reconnect = elantech_reconnect;
1824 psmouse->pktsize = etd->hw_version > 1 ? 6 : 4;
1828 input_free_device(tp_dev);
1830 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1831 &elantech_attr_group);
1833 psmouse_reset(psmouse);