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/i2c.h>
18 #include <linux/input.h>
19 #include <linux/input/mt.h>
20 #include <linux/platform_device.h>
21 #include <linux/serio.h>
22 #include <linux/libps2.h>
23 #include <asm/unaligned.h>
28 #define elantech_debug(fmt, ...) \
30 if (etd->info.debug) \
31 psmouse_printk(KERN_DEBUG, psmouse, \
32 fmt, ##__VA_ARGS__); \
36 * Send a Synaptics style sliced query command
38 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
41 if (ps2_sliced_command(&psmouse->ps2dev, c) ||
42 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
43 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
51 * V3 and later support this fast command
53 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
56 struct ps2dev *ps2dev = &psmouse->ps2dev;
58 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
59 ps2_command(ps2dev, NULL, c) ||
60 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
61 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
69 * A retrying version of ps2_command
71 static int elantech_ps2_command(struct psmouse *psmouse,
72 unsigned char *param, int command)
74 struct ps2dev *ps2dev = &psmouse->ps2dev;
75 struct elantech_data *etd = psmouse->private;
77 int tries = ETP_PS2_COMMAND_TRIES;
80 rc = ps2_command(ps2dev, param, command);
84 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
86 msleep(ETP_PS2_COMMAND_DELAY);
90 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
96 * Send an Elantech style special command to read a value from a register
98 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
101 struct elantech_data *etd = psmouse->private;
102 unsigned char param[3];
105 if (reg < 0x07 || reg > 0x26)
108 if (reg > 0x11 && reg < 0x20)
111 switch (etd->info.hw_version) {
113 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_READ) ||
114 ps2_sliced_command(&psmouse->ps2dev, reg) ||
115 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
121 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
122 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
123 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
124 elantech_ps2_command(psmouse, NULL, reg) ||
125 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
131 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
132 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
133 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
134 elantech_ps2_command(psmouse, NULL, reg) ||
135 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
142 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
143 else if (etd->info.hw_version != 4)
152 * Send an Elantech style special command to write a register with a value
154 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
157 struct elantech_data *etd = psmouse->private;
160 if (reg < 0x07 || reg > 0x26)
163 if (reg > 0x11 && reg < 0x20)
166 switch (etd->info.hw_version) {
168 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_WRITE) ||
169 ps2_sliced_command(&psmouse->ps2dev, reg) ||
170 ps2_sliced_command(&psmouse->ps2dev, val) ||
171 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
177 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
178 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
179 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
180 elantech_ps2_command(psmouse, NULL, reg) ||
181 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
182 elantech_ps2_command(psmouse, NULL, val) ||
183 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
189 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
190 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
191 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
192 elantech_ps2_command(psmouse, NULL, reg) ||
193 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
194 elantech_ps2_command(psmouse, NULL, val) ||
195 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
201 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
202 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
203 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
204 elantech_ps2_command(psmouse, NULL, reg) ||
205 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
206 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
207 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
208 elantech_ps2_command(psmouse, NULL, val) ||
209 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
217 "failed to write register 0x%02x with value 0x%02x.\n",
224 * Dump a complete mouse movement packet to the syslog
226 static void elantech_packet_dump(struct psmouse *psmouse)
228 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [%*ph]\n",
229 psmouse->pktsize, psmouse->packet);
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->info.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->info.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);
286 psmouse_report_standard_buttons(dev, packet[0]);
288 if (etd->info.fw_version < 0x020000 &&
289 (etd->info.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 psmouse_report_standard_buttons(dev, packet[0]);
397 if (etd->info.reports_pressure) {
398 input_report_abs(dev, ABS_PRESSURE, pres);
399 input_report_abs(dev, ABS_TOOL_WIDTH, width);
405 static void elantech_report_trackpoint(struct psmouse *psmouse,
409 * byte 0: 0 0 sx sy 0 M R L
410 * byte 1:~sx 0 0 0 0 0 0 0
411 * byte 2:~sy 0 0 0 0 0 0 0
412 * byte 3: 0 0 ~sy ~sx 0 1 1 0
413 * byte 4: x7 x6 x5 x4 x3 x2 x1 x0
414 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
416 * x and y are written in two's complement spread
417 * over 9 bits with sx/sy the relative top bit and
418 * x7..x0 and y7..y0 the lower bits.
419 * The sign of y is opposite to what the input driver
420 * expects for a relative movement
423 struct elantech_data *etd = psmouse->private;
424 struct input_dev *tp_dev = etd->tp_dev;
425 unsigned char *packet = psmouse->packet;
429 t = get_unaligned_le32(&packet[0]);
436 x = packet[4] - (int)((packet[1]^0x80) << 1);
437 y = (int)((packet[2]^0x80) << 1) - packet[5];
439 psmouse_report_standard_buttons(tp_dev, packet[0]);
441 input_report_rel(tp_dev, REL_X, x);
442 input_report_rel(tp_dev, REL_Y, y);
449 /* Dump unexpected packet sequences if debug=1 (default) */
450 if (etd->info.debug == 1)
451 elantech_packet_dump(psmouse);
458 * Interpret complete data packets and report absolute mode input events for
459 * hardware version 3. (12 byte packets for two fingers)
461 static void elantech_report_absolute_v3(struct psmouse *psmouse,
464 struct input_dev *dev = psmouse->dev;
465 struct elantech_data *etd = psmouse->private;
466 unsigned char *packet = psmouse->packet;
467 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
468 unsigned int width = 0, pres = 0;
470 /* byte 0: n1 n0 . . . . R L */
471 fingers = (packet[0] & 0xc0) >> 6;
477 * byte 1: . . . . x11 x10 x9 x8
478 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
480 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
482 * byte 4: . . . . y11 y10 y9 y8
483 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
485 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
489 if (packet_type == PACKET_V3_HEAD) {
491 * byte 1: . . . . ax11 ax10 ax9 ax8
492 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
494 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
496 * byte 4: . . . . ay11 ay10 ay9 ay8
497 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
499 etd->mt[0].y = etd->y_max -
500 (((packet[4] & 0x0f) << 8) | packet[5]);
502 * wait for next packet
507 /* packet_type == PACKET_V3_TAIL */
510 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
511 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
515 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
516 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
518 input_report_key(dev, BTN_TOUCH, fingers != 0);
520 input_report_abs(dev, ABS_X, x1);
521 input_report_abs(dev, ABS_Y, y1);
523 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
524 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
525 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
526 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
528 /* For clickpads map both buttons to BTN_LEFT */
529 if (etd->info.fw_version & 0x001000)
530 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
532 psmouse_report_standard_buttons(dev, packet[0]);
534 input_report_abs(dev, ABS_PRESSURE, pres);
535 input_report_abs(dev, ABS_TOOL_WIDTH, width);
540 static void elantech_input_sync_v4(struct psmouse *psmouse)
542 struct input_dev *dev = psmouse->dev;
543 struct elantech_data *etd = psmouse->private;
544 unsigned char *packet = psmouse->packet;
546 /* For clickpads map both buttons to BTN_LEFT */
547 if (etd->info.fw_version & 0x001000)
548 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
550 psmouse_report_standard_buttons(dev, packet[0]);
552 input_mt_report_pointer_emulation(dev, true);
556 static void process_packet_status_v4(struct psmouse *psmouse)
558 struct input_dev *dev = psmouse->dev;
559 unsigned char *packet = psmouse->packet;
563 /* notify finger state change */
564 fingers = packet[1] & 0x1f;
565 for (i = 0; i < ETP_MAX_FINGERS; i++) {
566 if ((fingers & (1 << i)) == 0) {
567 input_mt_slot(dev, i);
568 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
572 elantech_input_sync_v4(psmouse);
575 static void process_packet_head_v4(struct psmouse *psmouse)
577 struct input_dev *dev = psmouse->dev;
578 struct elantech_data *etd = psmouse->private;
579 unsigned char *packet = psmouse->packet;
580 int id = ((packet[3] & 0xe0) >> 5) - 1;
586 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
587 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
588 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
589 traces = (packet[0] & 0xf0) >> 4;
591 input_mt_slot(dev, id);
592 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
594 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
595 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
596 input_report_abs(dev, ABS_MT_PRESSURE, pres);
597 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
598 /* report this for backwards compatibility */
599 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
601 elantech_input_sync_v4(psmouse);
604 static void process_packet_motion_v4(struct psmouse *psmouse)
606 struct input_dev *dev = psmouse->dev;
607 struct elantech_data *etd = psmouse->private;
608 unsigned char *packet = psmouse->packet;
609 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
612 id = ((packet[0] & 0xe0) >> 5) - 1;
616 sid = ((packet[3] & 0xe0) >> 5) - 1;
617 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
619 * Motion packets give us the delta of x, y values of specific fingers,
620 * but in two's complement. Let the compiler do the conversion for us.
621 * Also _enlarge_ the numbers to int, in case of overflow.
623 delta_x1 = (signed char)packet[1];
624 delta_y1 = (signed char)packet[2];
625 delta_x2 = (signed char)packet[4];
626 delta_y2 = (signed char)packet[5];
628 etd->mt[id].x += delta_x1 * weight;
629 etd->mt[id].y -= delta_y1 * weight;
630 input_mt_slot(dev, id);
631 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
632 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
635 etd->mt[sid].x += delta_x2 * weight;
636 etd->mt[sid].y -= delta_y2 * weight;
637 input_mt_slot(dev, sid);
638 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
639 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
642 elantech_input_sync_v4(psmouse);
645 static void elantech_report_absolute_v4(struct psmouse *psmouse,
648 switch (packet_type) {
649 case PACKET_V4_STATUS:
650 process_packet_status_v4(psmouse);
654 process_packet_head_v4(psmouse);
657 case PACKET_V4_MOTION:
658 process_packet_motion_v4(psmouse);
663 /* impossible to get here */
668 static int elantech_packet_check_v1(struct psmouse *psmouse)
670 struct elantech_data *etd = psmouse->private;
671 unsigned char *packet = psmouse->packet;
672 unsigned char p1, p2, p3;
674 /* Parity bits are placed differently */
675 if (etd->info.fw_version < 0x020000) {
676 /* byte 0: D U p1 p2 1 p3 R L */
677 p1 = (packet[0] & 0x20) >> 5;
678 p2 = (packet[0] & 0x10) >> 4;
680 /* byte 0: n1 n0 p2 p1 1 p3 R L */
681 p1 = (packet[0] & 0x10) >> 4;
682 p2 = (packet[0] & 0x20) >> 5;
685 p3 = (packet[0] & 0x04) >> 2;
687 return etd->parity[packet[1]] == p1 &&
688 etd->parity[packet[2]] == p2 &&
689 etd->parity[packet[3]] == p3;
692 static int elantech_debounce_check_v2(struct psmouse *psmouse)
695 * When we encounter packet that matches this exactly, it means the
696 * hardware is in debounce status. Just ignore the whole packet.
698 static const u8 debounce_packet[] = {
699 0x84, 0xff, 0xff, 0x02, 0xff, 0xff
701 unsigned char *packet = psmouse->packet;
703 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
706 static int elantech_packet_check_v2(struct psmouse *psmouse)
708 struct elantech_data *etd = psmouse->private;
709 unsigned char *packet = psmouse->packet;
712 * V2 hardware has two flavors. Older ones that do not report pressure,
713 * and newer ones that reports pressure and width. With newer ones, all
714 * packets (1, 2, 3 finger touch) have the same constant bits. With
715 * older ones, 1/3 finger touch packets and 2 finger touch packets
716 * have different constant bits.
717 * With all three cases, if the constant bits are not exactly what I
718 * expected, I consider them invalid.
720 if (etd->info.reports_pressure)
721 return (packet[0] & 0x0c) == 0x04 &&
722 (packet[3] & 0x0f) == 0x02;
724 if ((packet[0] & 0xc0) == 0x80)
725 return (packet[0] & 0x0c) == 0x0c &&
726 (packet[3] & 0x0e) == 0x08;
728 return (packet[0] & 0x3c) == 0x3c &&
729 (packet[1] & 0xf0) == 0x00 &&
730 (packet[3] & 0x3e) == 0x38 &&
731 (packet[4] & 0xf0) == 0x00;
735 * We check the constant bits to determine what packet type we get,
736 * so packet checking is mandatory for v3 and later hardware.
738 static int elantech_packet_check_v3(struct psmouse *psmouse)
740 struct elantech_data *etd = psmouse->private;
741 static const u8 debounce_packet[] = {
742 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff
744 unsigned char *packet = psmouse->packet;
747 * check debounce first, it has the same signature in byte 0
748 * and byte 3 as PACKET_V3_HEAD.
750 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
751 return PACKET_DEBOUNCE;
754 * If the hardware flag 'crc_enabled' is set the packets have
755 * different signatures.
757 if (etd->info.crc_enabled) {
758 if ((packet[3] & 0x09) == 0x08)
759 return PACKET_V3_HEAD;
761 if ((packet[3] & 0x09) == 0x09)
762 return PACKET_V3_TAIL;
764 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
765 return PACKET_V3_HEAD;
767 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
768 return PACKET_V3_TAIL;
769 if ((packet[3] & 0x0f) == 0x06)
770 return PACKET_TRACKPOINT;
773 return PACKET_UNKNOWN;
776 static int elantech_packet_check_v4(struct psmouse *psmouse)
778 struct elantech_data *etd = psmouse->private;
779 unsigned char *packet = psmouse->packet;
780 unsigned char packet_type = packet[3] & 0x03;
781 unsigned int ic_version;
784 if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
785 return PACKET_TRACKPOINT;
787 /* This represents the version of IC body. */
788 ic_version = (etd->info.fw_version & 0x0f0000) >> 16;
791 * Sanity check based on the constant bits of a packet.
792 * The constant bits change depending on the value of
793 * the hardware flag 'crc_enabled' and the version of
794 * the IC body, but are the same for every packet,
795 * regardless of the type.
797 if (etd->info.crc_enabled)
798 sanity_check = ((packet[3] & 0x08) == 0x00);
799 else if (ic_version == 7 && etd->info.samples[1] == 0x2A)
800 sanity_check = ((packet[3] & 0x1c) == 0x10);
802 sanity_check = ((packet[0] & 0x0c) == 0x04 &&
803 (packet[3] & 0x1c) == 0x10);
806 return PACKET_UNKNOWN;
808 switch (packet_type) {
810 return PACKET_V4_STATUS;
813 return PACKET_V4_HEAD;
816 return PACKET_V4_MOTION;
819 return PACKET_UNKNOWN;
823 * Process byte stream from mouse and handle complete packets
825 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
827 struct elantech_data *etd = psmouse->private;
830 if (psmouse->pktcnt < psmouse->pktsize)
831 return PSMOUSE_GOOD_DATA;
833 if (etd->info.debug > 1)
834 elantech_packet_dump(psmouse);
836 switch (etd->info.hw_version) {
838 if (etd->info.paritycheck && !elantech_packet_check_v1(psmouse))
839 return PSMOUSE_BAD_DATA;
841 elantech_report_absolute_v1(psmouse);
845 /* ignore debounce */
846 if (elantech_debounce_check_v2(psmouse))
847 return PSMOUSE_FULL_PACKET;
849 if (etd->info.paritycheck && !elantech_packet_check_v2(psmouse))
850 return PSMOUSE_BAD_DATA;
852 elantech_report_absolute_v2(psmouse);
856 packet_type = elantech_packet_check_v3(psmouse);
857 switch (packet_type) {
859 return PSMOUSE_BAD_DATA;
861 case PACKET_DEBOUNCE:
862 /* ignore debounce */
865 case PACKET_TRACKPOINT:
866 elantech_report_trackpoint(psmouse, packet_type);
870 elantech_report_absolute_v3(psmouse, packet_type);
877 packet_type = elantech_packet_check_v4(psmouse);
878 switch (packet_type) {
880 return PSMOUSE_BAD_DATA;
882 case PACKET_TRACKPOINT:
883 elantech_report_trackpoint(psmouse, packet_type);
887 elantech_report_absolute_v4(psmouse, packet_type);
894 return PSMOUSE_FULL_PACKET;
898 * This writes the reg_07 value again to the hardware at the end of every
899 * set_rate call because the register loses its value. reg_07 allows setting
900 * absolute mode on v4 hardware
902 static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
905 struct elantech_data *etd = psmouse->private;
907 etd->original_set_rate(psmouse, rate);
908 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
909 psmouse_err(psmouse, "restoring reg_07 failed\n");
913 * Put the touchpad into absolute mode
915 static int elantech_set_absolute_mode(struct psmouse *psmouse)
917 struct elantech_data *etd = psmouse->private;
919 int tries = ETP_READ_BACK_TRIES;
922 switch (etd->info.hw_version) {
926 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
927 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
933 /* Windows driver values */
935 etd->reg_11 = 0x88; /* 0x8a */
936 etd->reg_21 = 0x60; /* 0x00 */
937 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
938 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
939 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
945 if (etd->info.set_hw_resolution)
950 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
957 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
960 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
965 * Read back reg 0x10. For hardware version 1 we must make
966 * sure the absolute mode bit is set. For hardware version 2
967 * the touchpad is probably initializing and not ready until
968 * we read back the value we just wrote.
971 rc = elantech_read_reg(psmouse, 0x10, &val);
975 elantech_debug("retrying read (%d).\n", tries);
976 msleep(ETP_READ_BACK_DELAY);
981 "failed to read back register 0x10.\n");
982 } else if (etd->info.hw_version == 1 &&
983 !(val & ETP_R10_ABSOLUTE_MODE)) {
985 "touchpad refuses to switch to absolute mode.\n");
990 skip_readback_reg_10:
992 psmouse_err(psmouse, "failed to initialise registers.\n");
997 static int elantech_set_range(struct psmouse *psmouse,
998 unsigned int *x_min, unsigned int *y_min,
999 unsigned int *x_max, unsigned int *y_max,
1000 unsigned int *width)
1002 struct elantech_data *etd = psmouse->private;
1003 struct elantech_device_info *info = &etd->info;
1004 unsigned char param[3];
1005 unsigned char traces;
1007 switch (info->hw_version) {
1009 *x_min = ETP_XMIN_V1;
1010 *y_min = ETP_YMIN_V1;
1011 *x_max = ETP_XMAX_V1;
1012 *y_max = ETP_YMAX_V1;
1016 if (info->fw_version == 0x020800 ||
1017 info->fw_version == 0x020b00 ||
1018 info->fw_version == 0x020030) {
1019 *x_min = ETP_XMIN_V2;
1020 *y_min = ETP_YMIN_V2;
1021 *x_max = ETP_XMAX_V2;
1022 *y_max = ETP_YMAX_V2;
1027 i = (info->fw_version > 0x020800 &&
1028 info->fw_version < 0x020900) ? 1 : 2;
1030 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1033 fixed_dpi = param[1] & 0x10;
1035 if (((info->fw_version >> 16) == 0x14) && fixed_dpi) {
1036 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
1039 *x_max = (info->capabilities[1] - i) * param[1] / 2;
1040 *y_max = (info->capabilities[2] - i) * param[2] / 2;
1041 } else if (info->fw_version == 0x040216) {
1044 } else if (info->fw_version == 0x040219 || info->fw_version == 0x040215) {
1048 *x_max = (info->capabilities[1] - i) * 64;
1049 *y_max = (info->capabilities[2] - i) * 64;
1055 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1058 *x_max = (0x0f & param[0]) << 8 | param[1];
1059 *y_max = (0xf0 & param[0]) << 4 | param[2];
1063 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1066 *x_max = (0x0f & param[0]) << 8 | param[1];
1067 *y_max = (0xf0 & param[0]) << 4 | param[2];
1068 traces = info->capabilities[1];
1069 if ((traces < 2) || (traces > *x_max))
1072 *width = *x_max / (traces - 1);
1080 * (value from firmware) * 10 + 790 = dpi
1081 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1083 static unsigned int elantech_convert_res(unsigned int val)
1085 return (val * 10 + 790) * 10 / 254;
1088 static int elantech_get_resolution_v4(struct psmouse *psmouse,
1089 unsigned int *x_res,
1090 unsigned int *y_res,
1093 unsigned char param[3];
1095 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1098 *x_res = elantech_convert_res(param[1] & 0x0f);
1099 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
1106 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1107 * fw_version for this is based on the following fw_version & caps table:
1109 * Laptop-model: fw_version: caps: buttons:
1110 * Acer S3 0x461f00 10, 13, 0e clickpad
1111 * Acer S7-392 0x581f01 50, 17, 0d clickpad
1112 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1113 * Acer V5-551 0x461f00 ? clickpad
1114 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1115 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1116 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
1117 * Asus TP500LN 0x381f17 10, 14, 0e clickpad
1118 * Asus X750JN 0x381f17 10, 14, 0e clickpad
1119 * Asus UX31 0x361f00 20, 15, 0e clickpad
1120 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1121 * Avatar AVIU-145A2 0x361f00 ? clickpad
1122 * Fujitsu LIFEBOOK E544 0x470f00 d0, 12, 09 2 hw buttons
1123 * Fujitsu LIFEBOOK E546 0x470f00 50, 12, 09 2 hw buttons
1124 * Fujitsu LIFEBOOK E547 0x470f00 50, 12, 09 2 hw buttons
1125 * Fujitsu LIFEBOOK E554 0x570f01 40, 14, 0c 2 hw buttons
1126 * Fujitsu LIFEBOOK E557 0x570f01 40, 14, 0c 2 hw buttons
1127 * Fujitsu T725 0x470f01 05, 12, 09 2 hw buttons
1128 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
1129 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1130 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
1131 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
1132 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1133 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1134 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1135 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1136 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1137 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1138 * Samsung RF710 0x450f00 ? 2 hw buttons
1139 * System76 Pangolin 0x250f01 ? 2 hw buttons
1140 * (*) + 3 trackpoint buttons
1141 * (**) + 0 trackpoint buttons
1142 * Note: Lenovo L430 and Lenovo L530 have the same fw_version/caps
1144 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1146 struct input_dev *dev = psmouse->dev;
1147 struct elantech_data *etd = psmouse->private;
1149 if (etd->info.fw_version & 0x001000) {
1150 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1151 __clear_bit(BTN_RIGHT, dev->keybit);
1156 * Some hw_version 4 models do have a middle button
1158 static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1159 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1161 /* Fujitsu H730 has a middle button */
1163 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1164 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1168 /* Fujitsu H760 also has a middle button */
1170 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1171 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1179 * Set the appropriate event bits for the input subsystem
1181 static int elantech_set_input_params(struct psmouse *psmouse)
1183 struct input_dev *dev = psmouse->dev;
1184 struct elantech_data *etd = psmouse->private;
1185 struct elantech_device_info *info = &etd->info;
1186 unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1188 if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1191 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1192 __set_bit(EV_KEY, dev->evbit);
1193 __set_bit(EV_ABS, dev->evbit);
1194 __clear_bit(EV_REL, dev->evbit);
1196 __set_bit(BTN_LEFT, dev->keybit);
1197 if (dmi_check_system(elantech_dmi_has_middle_button))
1198 __set_bit(BTN_MIDDLE, dev->keybit);
1199 __set_bit(BTN_RIGHT, dev->keybit);
1201 __set_bit(BTN_TOUCH, dev->keybit);
1202 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1203 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1204 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1206 switch (info->hw_version) {
1209 if (info->fw_version < 0x020000 &&
1210 (info->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1211 __set_bit(BTN_FORWARD, dev->keybit);
1212 __set_bit(BTN_BACK, dev->keybit);
1214 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1215 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1219 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1220 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1223 if (info->hw_version == 3)
1224 elantech_set_buttonpad_prop(psmouse);
1225 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1226 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1227 if (info->reports_pressure) {
1228 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1230 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1233 input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
1234 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1235 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1239 elantech_set_buttonpad_prop(psmouse);
1240 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1241 /* For X to recognize me as touchpad. */
1242 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1243 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1245 * range of pressure and width is the same as v2,
1246 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1248 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1250 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1252 /* Multitouch capable pad, up to 5 fingers. */
1253 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1254 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1255 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1256 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1259 * The firmware reports how many trace lines the finger spans,
1260 * convert to surface unit as Protocol-B requires.
1262 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1263 ETP_WMAX_V2 * width, 0, 0);
1267 input_abs_set_res(dev, ABS_X, info->x_res);
1268 input_abs_set_res(dev, ABS_Y, info->y_res);
1269 if (info->hw_version > 1) {
1270 input_abs_set_res(dev, ABS_MT_POSITION_X, info->x_res);
1271 input_abs_set_res(dev, ABS_MT_POSITION_Y, info->y_res);
1280 struct elantech_attr_data {
1281 size_t field_offset;
1286 * Display a register value by reading a sysfs entry
1288 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1291 struct elantech_data *etd = psmouse->private;
1292 struct elantech_attr_data *attr = data;
1293 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1297 rc = elantech_read_reg(psmouse, attr->reg, reg);
1299 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1303 * Write a register value by writing a sysfs entry
1305 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1306 void *data, const char *buf, size_t count)
1308 struct elantech_data *etd = psmouse->private;
1309 struct elantech_attr_data *attr = data;
1310 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1311 unsigned char value;
1314 err = kstrtou8(buf, 16, &value);
1318 /* Do we need to preserve some bits for version 2 hardware too? */
1319 if (etd->info.hw_version == 1) {
1320 if (attr->reg == 0x10)
1321 /* Force absolute mode always on */
1322 value |= ETP_R10_ABSOLUTE_MODE;
1323 else if (attr->reg == 0x11)
1324 /* Force 4 byte mode always on */
1325 value |= ETP_R11_4_BYTE_MODE;
1328 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1334 #define ELANTECH_INT_ATTR(_name, _register) \
1335 static struct elantech_attr_data elantech_attr_##_name = { \
1336 .field_offset = offsetof(struct elantech_data, _name), \
1339 PSMOUSE_DEFINE_ATTR(_name, 0644, \
1340 &elantech_attr_##_name, \
1341 elantech_show_int_attr, \
1342 elantech_set_int_attr)
1344 #define ELANTECH_INFO_ATTR(_name) \
1345 static struct elantech_attr_data elantech_attr_##_name = { \
1346 .field_offset = offsetof(struct elantech_data, info) + \
1347 offsetof(struct elantech_device_info, _name), \
1350 PSMOUSE_DEFINE_ATTR(_name, 0644, \
1351 &elantech_attr_##_name, \
1352 elantech_show_int_attr, \
1353 elantech_set_int_attr)
1355 ELANTECH_INT_ATTR(reg_07, 0x07);
1356 ELANTECH_INT_ATTR(reg_10, 0x10);
1357 ELANTECH_INT_ATTR(reg_11, 0x11);
1358 ELANTECH_INT_ATTR(reg_20, 0x20);
1359 ELANTECH_INT_ATTR(reg_21, 0x21);
1360 ELANTECH_INT_ATTR(reg_22, 0x22);
1361 ELANTECH_INT_ATTR(reg_23, 0x23);
1362 ELANTECH_INT_ATTR(reg_24, 0x24);
1363 ELANTECH_INT_ATTR(reg_25, 0x25);
1364 ELANTECH_INT_ATTR(reg_26, 0x26);
1365 ELANTECH_INFO_ATTR(debug);
1366 ELANTECH_INFO_ATTR(paritycheck);
1367 ELANTECH_INFO_ATTR(crc_enabled);
1369 static struct attribute *elantech_attrs[] = {
1370 &psmouse_attr_reg_07.dattr.attr,
1371 &psmouse_attr_reg_10.dattr.attr,
1372 &psmouse_attr_reg_11.dattr.attr,
1373 &psmouse_attr_reg_20.dattr.attr,
1374 &psmouse_attr_reg_21.dattr.attr,
1375 &psmouse_attr_reg_22.dattr.attr,
1376 &psmouse_attr_reg_23.dattr.attr,
1377 &psmouse_attr_reg_24.dattr.attr,
1378 &psmouse_attr_reg_25.dattr.attr,
1379 &psmouse_attr_reg_26.dattr.attr,
1380 &psmouse_attr_debug.dattr.attr,
1381 &psmouse_attr_paritycheck.dattr.attr,
1382 &psmouse_attr_crc_enabled.dattr.attr,
1386 static const struct attribute_group elantech_attr_group = {
1387 .attrs = elantech_attrs,
1390 static bool elantech_is_signature_valid(const unsigned char *param)
1392 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1402 * Some hw_version >= 4 models have a revision higher then 20. Meaning
1403 * that param[2] may be 10 or 20, skip the rates check for these.
1405 if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1409 for (i = 0; i < ARRAY_SIZE(rates); i++)
1410 if (param[2] == rates[i])
1417 * Use magic knock to detect Elantech touchpad
1419 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1421 struct ps2dev *ps2dev = &psmouse->ps2dev;
1422 unsigned char param[3];
1424 ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1426 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1427 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1428 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1429 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1430 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1431 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1436 * Report this in case there are Elantech models that use a different
1437 * set of magic numbers
1439 if (param[0] != 0x3c || param[1] != 0x03 ||
1440 (param[2] != 0xc8 && param[2] != 0x00)) {
1441 psmouse_dbg(psmouse,
1442 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1443 param[0], param[1], param[2]);
1448 * Query touchpad's firmware version and see if it reports known
1449 * value to avoid mis-detection. Logitech mice are known to respond
1450 * to Elantech magic knock and there might be more.
1452 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1453 psmouse_dbg(psmouse, "failed to query firmware version.\n");
1457 psmouse_dbg(psmouse,
1458 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1459 param[0], param[1], param[2]);
1461 if (!elantech_is_signature_valid(param)) {
1462 psmouse_dbg(psmouse,
1463 "Probably not a real Elantech touchpad. Aborting.\n");
1467 if (set_properties) {
1468 psmouse->vendor = "Elantech";
1469 psmouse->name = "Touchpad";
1476 * Clean up sysfs entries when disconnecting
1478 static void elantech_disconnect(struct psmouse *psmouse)
1480 struct elantech_data *etd = psmouse->private;
1483 * We might have left a breadcrumb when trying to
1484 * set up SMbus companion.
1486 psmouse_smbus_cleanup(psmouse);
1489 input_unregister_device(etd->tp_dev);
1490 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1491 &elantech_attr_group);
1492 kfree(psmouse->private);
1493 psmouse->private = NULL;
1497 * Put the touchpad back into absolute mode when reconnecting
1499 static int elantech_reconnect(struct psmouse *psmouse)
1501 psmouse_reset(psmouse);
1503 if (elantech_detect(psmouse, 0))
1506 if (elantech_set_absolute_mode(psmouse)) {
1507 psmouse_err(psmouse,
1508 "failed to put touchpad back into absolute mode.\n");
1516 * Some hw_version 4 models do not work with crc_disabled
1518 static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1519 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1521 /* Fujitsu H730 does not work with crc_enabled == 0 */
1523 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1524 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1528 /* Fujitsu H760 does not work with crc_enabled == 0 */
1530 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1531 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1535 /* Fujitsu LIFEBOOK E544 does not work with crc_enabled == 0 */
1537 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1538 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1542 /* Fujitsu LIFEBOOK E546 does not work with crc_enabled == 0 */
1544 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1545 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1549 /* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1551 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1552 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1556 /* Fujitsu LIFEBOOK E554 does not work with crc_enabled == 0 */
1558 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1559 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1563 /* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
1565 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1566 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
1570 /* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1572 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1573 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1577 /* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1579 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1580 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1588 * Some hw_version 3 models go into error state when we try to set
1589 * bit 3 and/or bit 1 of r10.
1591 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1592 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1594 /* Gigabyte U2442 */
1596 DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1597 DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1605 * determine hardware version and set some properties according to it.
1607 static int elantech_set_properties(struct elantech_device_info *info)
1609 /* This represents the version of IC body. */
1610 int ver = (info->fw_version & 0x0f0000) >> 16;
1612 /* Early version of Elan touchpads doesn't obey the rule. */
1613 if (info->fw_version < 0x020030 || info->fw_version == 0x020600)
1614 info->hw_version = 1;
1619 info->hw_version = 2;
1622 info->hw_version = 3;
1625 info->hw_version = 4;
1632 /* decide which send_cmd we're gonna use early */
1633 info->send_cmd = info->hw_version >= 3 ? elantech_send_cmd :
1636 /* Turn on packet checking by default */
1637 info->paritycheck = 1;
1640 * This firmware suffers from misreporting coordinates when
1641 * a touch action starts causing the mouse cursor or scrolled page
1642 * to jump. Enable a workaround.
1644 info->jumpy_cursor =
1645 (info->fw_version == 0x020022 || info->fw_version == 0x020600);
1647 if (info->hw_version > 1) {
1648 /* For now show extra debug information */
1651 if (info->fw_version >= 0x020800)
1652 info->reports_pressure = true;
1656 * The signatures of v3 and v4 packets change depending on the
1657 * value of this hardware flag.
1659 info->crc_enabled = (info->fw_version & 0x4000) == 0x4000 ||
1660 dmi_check_system(elantech_dmi_force_crc_enabled);
1662 /* Enable real hardware resolution on hw_version 3 ? */
1663 info->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1668 static int elantech_query_info(struct psmouse *psmouse,
1669 struct elantech_device_info *info)
1671 unsigned char param[3];
1673 memset(info, 0, sizeof(*info));
1676 * Do the version query again so we can store the result
1678 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1679 psmouse_err(psmouse, "failed to query firmware version.\n");
1682 info->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1684 if (elantech_set_properties(info)) {
1685 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1688 psmouse_info(psmouse,
1689 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1690 info->hw_version, param[0], param[1], param[2]);
1692 if (info->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1693 info->capabilities)) {
1694 psmouse_err(psmouse, "failed to query capabilities.\n");
1697 psmouse_info(psmouse,
1698 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1699 info->capabilities[0], info->capabilities[1],
1700 info->capabilities[2]);
1702 if (info->hw_version != 1) {
1703 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, info->samples)) {
1704 psmouse_err(psmouse, "failed to query sample data\n");
1707 psmouse_info(psmouse,
1708 "Elan sample query result %02x, %02x, %02x\n",
1714 if (info->samples[1] == 0x74 && info->hw_version == 0x03) {
1716 * This module has a bug which makes absolute mode
1717 * unusable, so let's abort so we'll be using standard
1720 psmouse_info(psmouse,
1721 "absolute mode broken, forcing standard PS/2 protocol\n");
1725 /* The MSB indicates the presence of the trackpoint */
1726 info->has_trackpoint = (info->capabilities[0] & 0x80) == 0x80;
1730 if (info->hw_version == 4) {
1731 if (elantech_get_resolution_v4(psmouse,
1735 psmouse_warn(psmouse,
1736 "failed to query resolution data.\n");
1743 #if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
1746 * The newest Elantech device can use a secondary bus (over SMBus) which
1747 * provides a better bandwidth and allow a better control of the touchpads.
1748 * This is used to decide if we need to use this bus or not.
1751 ELANTECH_SMBUS_NOT_SET = -1,
1756 static int elantech_smbus = IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ?
1757 ELANTECH_SMBUS_NOT_SET : ELANTECH_SMBUS_OFF;
1758 module_param_named(elantech_smbus, elantech_smbus, int, 0644);
1759 MODULE_PARM_DESC(elantech_smbus, "Use a secondary bus for the Elantech device.");
1761 static int elantech_create_smbus(struct psmouse *psmouse,
1762 struct elantech_device_info *info,
1763 bool leave_breadcrumbs)
1765 const struct property_entry i2c_properties[] = {
1766 PROPERTY_ENTRY_BOOL("elan,trackpoint"),
1769 struct i2c_board_info smbus_board = {
1770 I2C_BOARD_INFO("elan_i2c", 0x15),
1771 .flags = I2C_CLIENT_HOST_NOTIFY,
1774 if (info->has_trackpoint)
1775 smbus_board.properties = i2c_properties;
1777 return psmouse_smbus_init(psmouse, &smbus_board, NULL, 0, false,
1782 * elantech_setup_smbus - called once the PS/2 devices are enumerated
1783 * and decides to instantiate a SMBus InterTouch device.
1785 static int elantech_setup_smbus(struct psmouse *psmouse,
1786 struct elantech_device_info *info,
1787 bool leave_breadcrumbs)
1791 if (elantech_smbus == ELANTECH_SMBUS_OFF)
1794 if (elantech_smbus == ELANTECH_SMBUS_NOT_SET) {
1796 * New ICs are enabled by default.
1797 * Old ICs are up to the user to decide.
1799 if (!ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1803 psmouse_info(psmouse, "Trying to set up SMBus access\n");
1805 error = elantech_create_smbus(psmouse, info, leave_breadcrumbs);
1807 if (error == -EAGAIN)
1808 psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1810 psmouse_err(psmouse, "unable to create intertouch device\n");
1818 static bool elantech_use_host_notify(struct psmouse *psmouse,
1819 struct elantech_device_info *info)
1821 if (ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1824 switch (info->bus) {
1825 case ETP_BUS_PS2_ONLY:
1828 case ETP_BUS_SMB_ALERT_ONLY:
1830 case ETP_BUS_PS2_SMB_ALERT:
1831 psmouse_dbg(psmouse, "Ignoring SMBus provider through alert protocol.\n");
1833 case ETP_BUS_SMB_HST_NTFY_ONLY:
1835 case ETP_BUS_PS2_SMB_HST_NTFY:
1838 psmouse_dbg(psmouse,
1839 "Ignoring SMBus bus provider %d.\n",
1846 int elantech_init_smbus(struct psmouse *psmouse)
1848 struct elantech_device_info info;
1849 int error = -EINVAL;
1851 psmouse_reset(psmouse);
1853 error = elantech_query_info(psmouse, &info);
1857 if (info.hw_version < 4) {
1862 return elantech_create_smbus(psmouse, &info, false);
1864 psmouse_reset(psmouse);
1867 #endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
1870 * Initialize the touchpad and create sysfs entries
1872 static int elantech_setup_ps2(struct psmouse *psmouse,
1873 struct elantech_device_info *info)
1875 struct elantech_data *etd;
1877 int error = -EINVAL;
1878 struct input_dev *tp_dev;
1880 psmouse->private = etd = kzalloc(sizeof(*etd), GFP_KERNEL);
1887 for (i = 1; i < 256; i++)
1888 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1890 if (elantech_set_absolute_mode(psmouse)) {
1891 psmouse_err(psmouse,
1892 "failed to put touchpad into absolute mode.\n");
1896 if (info->fw_version == 0x381f17) {
1897 etd->original_set_rate = psmouse->set_rate;
1898 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1901 if (elantech_set_input_params(psmouse)) {
1902 psmouse_err(psmouse, "failed to query touchpad range.\n");
1906 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1907 &elantech_attr_group);
1909 psmouse_err(psmouse,
1910 "failed to create sysfs attributes, error: %d.\n",
1915 if (info->has_trackpoint) {
1916 tp_dev = input_allocate_device();
1920 goto init_fail_tp_alloc;
1923 etd->tp_dev = tp_dev;
1924 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1925 psmouse->ps2dev.serio->phys);
1926 tp_dev->phys = etd->tp_phys;
1927 tp_dev->name = "ETPS/2 Elantech TrackPoint";
1928 tp_dev->id.bustype = BUS_I8042;
1929 tp_dev->id.vendor = 0x0002;
1930 tp_dev->id.product = PSMOUSE_ELANTECH;
1931 tp_dev->id.version = 0x0000;
1932 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1933 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1934 tp_dev->relbit[BIT_WORD(REL_X)] =
1935 BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1936 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1937 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1938 BIT_MASK(BTN_RIGHT);
1940 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
1941 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1943 error = input_register_device(etd->tp_dev);
1945 goto init_fail_tp_reg;
1948 psmouse->protocol_handler = elantech_process_byte;
1949 psmouse->disconnect = elantech_disconnect;
1950 psmouse->reconnect = elantech_reconnect;
1951 psmouse->pktsize = info->hw_version > 1 ? 6 : 4;
1955 input_free_device(tp_dev);
1957 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1958 &elantech_attr_group);
1964 int elantech_init_ps2(struct psmouse *psmouse)
1966 struct elantech_device_info info;
1967 int error = -EINVAL;
1969 psmouse_reset(psmouse);
1971 error = elantech_query_info(psmouse, &info);
1975 error = elantech_setup_ps2(psmouse, &info);
1981 psmouse_reset(psmouse);
1985 int elantech_init(struct psmouse *psmouse)
1987 struct elantech_device_info info;
1988 int error = -EINVAL;
1990 psmouse_reset(psmouse);
1992 error = elantech_query_info(psmouse, &info);
1996 #if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
1998 if (elantech_use_host_notify(psmouse, &info)) {
1999 if (!IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ||
2000 !IS_ENABLED(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)) {
2001 psmouse_warn(psmouse,
2002 "The touchpad can support a better bus than the too old PS/2 protocol. "
2003 "Make sure MOUSE_PS2_ELANTECH_SMBUS and MOUSE_ELAN_I2C_SMBUS are enabled to get a better touchpad experience.\n");
2005 error = elantech_setup_smbus(psmouse, &info, true);
2007 return PSMOUSE_ELANTECH_SMBUS;
2010 #endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
2012 error = elantech_setup_ps2(psmouse, &info);
2015 * Not using any flavor of Elantech support, so clean up
2016 * SMbus breadcrumbs, if any.
2018 psmouse_smbus_cleanup(psmouse);
2022 return PSMOUSE_ELANTECH;
2024 psmouse_reset(psmouse);