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
)
227 psmouse_printk(KERN_DEBUG
, psmouse
, "PS/2 packet [");
228 for (i
= 0; i
< psmouse
->pktsize
; i
++)
229 printk("%s0x%02x ", i
? ", " : " ", psmouse
->packet
[i
]);
234 * Interpret complete data packets and report absolute mode input events for
235 * hardware version 1. (4 byte packets)
237 static void elantech_report_absolute_v1(struct psmouse
*psmouse
)
239 struct input_dev
*dev
= psmouse
->dev
;
240 struct elantech_data
*etd
= psmouse
->private;
241 unsigned char *packet
= psmouse
->packet
;
244 if (etd
->fw_version
< 0x020000) {
246 * byte 0: D U p1 p2 1 p3 R L
247 * byte 1: f 0 th tw x9 x8 y9 y8
249 fingers
= ((packet
[1] & 0x80) >> 7) +
250 ((packet
[1] & 0x30) >> 4);
253 * byte 0: n1 n0 p2 p1 1 p3 R L
254 * byte 1: 0 0 0 0 x9 x8 y9 y8
256 fingers
= (packet
[0] & 0xc0) >> 6;
259 if (etd
->jumpy_cursor
) {
261 etd
->single_finger_reports
= 0;
262 } else if (etd
->single_finger_reports
< 2) {
263 /* Discard first 2 reports of one finger, bogus */
264 etd
->single_finger_reports
++;
265 elantech_debug("discarding packet\n");
270 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
273 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
274 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
277 input_report_abs(dev
, ABS_X
,
278 ((packet
[1] & 0x0c) << 6) | packet
[2]);
279 input_report_abs(dev
, ABS_Y
,
280 etd
->y_max
- (((packet
[1] & 0x03) << 8) | packet
[3]));
283 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
284 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
285 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
286 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
287 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
289 if (etd
->fw_version
< 0x020000 &&
290 (etd
->capabilities
[0] & ETP_CAP_HAS_ROCKER
)) {
292 input_report_key(dev
, BTN_FORWARD
, packet
[0] & 0x40);
294 input_report_key(dev
, BTN_BACK
, packet
[0] & 0x80);
300 static void elantech_set_slot(struct input_dev
*dev
, int slot
, bool active
,
301 unsigned int x
, unsigned int y
)
303 input_mt_slot(dev
, slot
);
304 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, active
);
306 input_report_abs(dev
, ABS_MT_POSITION_X
, x
);
307 input_report_abs(dev
, ABS_MT_POSITION_Y
, y
);
311 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
312 static void elantech_report_semi_mt_data(struct input_dev
*dev
,
313 unsigned int num_fingers
,
314 unsigned int x1
, unsigned int y1
,
315 unsigned int x2
, unsigned int y2
)
317 elantech_set_slot(dev
, 0, num_fingers
!= 0, x1
, y1
);
318 elantech_set_slot(dev
, 1, num_fingers
== 2, x2
, y2
);
322 * Interpret complete data packets and report absolute mode input events for
323 * hardware version 2. (6 byte packets)
325 static void elantech_report_absolute_v2(struct psmouse
*psmouse
)
327 struct elantech_data
*etd
= psmouse
->private;
328 struct input_dev
*dev
= psmouse
->dev
;
329 unsigned char *packet
= psmouse
->packet
;
330 unsigned int fingers
, x1
= 0, y1
= 0, x2
= 0, y2
= 0;
331 unsigned int width
= 0, pres
= 0;
333 /* byte 0: n1 n0 . . . . R L */
334 fingers
= (packet
[0] & 0xc0) >> 6;
339 * Same as one finger, except report of more than 3 fingers:
340 * byte 3: n4 . w1 w0 . . . .
342 if (packet
[3] & 0x80)
344 /* pass through... */
347 * byte 1: . . . . x11 x10 x9 x8
348 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
350 x1
= ((packet
[1] & 0x0f) << 8) | packet
[2];
352 * byte 4: . . . . y11 y10 y9 y8
353 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
355 y1
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
357 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
358 width
= ((packet
[0] & 0x30) >> 2) | ((packet
[3] & 0x30) >> 4);
363 * The coordinate of each finger is reported separately
364 * with a lower resolution for two finger touches:
365 * byte 0: . . ay8 ax8 . . . .
366 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
368 x1
= (((packet
[0] & 0x10) << 4) | packet
[1]) << 2;
369 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
371 ((((packet
[0] & 0x20) << 3) | packet
[2]) << 2);
373 * byte 3: . . by8 bx8 . . . .
374 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
376 x2
= (((packet
[3] & 0x10) << 4) | packet
[4]) << 2;
377 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
379 ((((packet
[3] & 0x20) << 3) | packet
[5]) << 2);
381 /* Unknown so just report sensible values */
387 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
389 input_report_abs(dev
, ABS_X
, x1
);
390 input_report_abs(dev
, ABS_Y
, y1
);
392 elantech_report_semi_mt_data(dev
, fingers
, x1
, y1
, x2
, y2
);
393 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
394 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
395 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
396 input_report_key(dev
, BTN_TOOL_QUADTAP
, fingers
== 4);
397 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
398 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
399 if (etd
->reports_pressure
) {
400 input_report_abs(dev
, ABS_PRESSURE
, pres
);
401 input_report_abs(dev
, ABS_TOOL_WIDTH
, width
);
407 static void elantech_report_trackpoint(struct psmouse
*psmouse
,
411 * byte 0: 0 0 sx sy 0 M R L
412 * byte 1:~sx 0 0 0 0 0 0 0
413 * byte 2:~sy 0 0 0 0 0 0 0
414 * byte 3: 0 0 ~sy ~sx 0 1 1 0
415 * byte 4: x7 x6 x5 x4 x3 x2 x1 x0
416 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
418 * x and y are written in two's complement spread
419 * over 9 bits with sx/sy the relative top bit and
420 * x7..x0 and y7..y0 the lower bits.
421 * The sign of y is opposite to what the input driver
422 * expects for a relative movement
425 struct elantech_data
*etd
= psmouse
->private;
426 struct input_dev
*tp_dev
= etd
->tp_dev
;
427 unsigned char *packet
= psmouse
->packet
;
431 if (dev_WARN_ONCE(&psmouse
->ps2dev
.serio
->dev
,
433 psmouse_fmt("Unexpected trackpoint message\n"))) {
435 elantech_packet_dump(psmouse
);
439 t
= get_unaligned_le32(&packet
[0]);
446 x
= packet
[4] - (int)((packet
[1]^0x80) << 1);
447 y
= (int)((packet
[2]^0x80) << 1) - packet
[5];
449 input_report_key(tp_dev
, BTN_LEFT
, packet
[0] & 0x01);
450 input_report_key(tp_dev
, BTN_RIGHT
, packet
[0] & 0x02);
451 input_report_key(tp_dev
, BTN_MIDDLE
, packet
[0] & 0x04);
453 input_report_rel(tp_dev
, REL_X
, x
);
454 input_report_rel(tp_dev
, REL_Y
, y
);
461 /* Dump unexpected packet sequences if debug=1 (default) */
463 elantech_packet_dump(psmouse
);
470 * Interpret complete data packets and report absolute mode input events for
471 * hardware version 3. (12 byte packets for two fingers)
473 static void elantech_report_absolute_v3(struct psmouse
*psmouse
,
476 struct input_dev
*dev
= psmouse
->dev
;
477 struct elantech_data
*etd
= psmouse
->private;
478 unsigned char *packet
= psmouse
->packet
;
479 unsigned int fingers
= 0, x1
= 0, y1
= 0, x2
= 0, y2
= 0;
480 unsigned int width
= 0, pres
= 0;
482 /* byte 0: n1 n0 . . . . R L */
483 fingers
= (packet
[0] & 0xc0) >> 6;
489 * byte 1: . . . . x11 x10 x9 x8
490 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
492 x1
= ((packet
[1] & 0x0f) << 8) | packet
[2];
494 * byte 4: . . . . y11 y10 y9 y8
495 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
497 y1
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
501 if (packet_type
== PACKET_V3_HEAD
) {
503 * byte 1: . . . . ax11 ax10 ax9 ax8
504 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
506 etd
->mt
[0].x
= ((packet
[1] & 0x0f) << 8) | packet
[2];
508 * byte 4: . . . . ay11 ay10 ay9 ay8
509 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
511 etd
->mt
[0].y
= etd
->y_max
-
512 (((packet
[4] & 0x0f) << 8) | packet
[5]);
514 * wait for next packet
519 /* packet_type == PACKET_V3_TAIL */
522 x2
= ((packet
[1] & 0x0f) << 8) | packet
[2];
523 y2
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
527 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
528 width
= ((packet
[0] & 0x30) >> 2) | ((packet
[3] & 0x30) >> 4);
530 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
532 input_report_abs(dev
, ABS_X
, x1
);
533 input_report_abs(dev
, ABS_Y
, y1
);
535 elantech_report_semi_mt_data(dev
, fingers
, x1
, y1
, x2
, y2
);
536 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
537 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
538 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
540 /* For clickpads map both buttons to BTN_LEFT */
541 if (etd
->fw_version
& 0x001000) {
542 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x03);
544 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
545 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
548 input_report_abs(dev
, ABS_PRESSURE
, pres
);
549 input_report_abs(dev
, ABS_TOOL_WIDTH
, width
);
554 static void elantech_input_sync_v4(struct psmouse
*psmouse
)
556 struct input_dev
*dev
= psmouse
->dev
;
557 struct elantech_data
*etd
= psmouse
->private;
558 unsigned char *packet
= psmouse
->packet
;
560 /* For clickpads map both buttons to BTN_LEFT */
561 if (etd
->fw_version
& 0x001000) {
562 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x03);
564 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
565 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
568 input_mt_report_pointer_emulation(dev
, true);
572 static void process_packet_status_v4(struct psmouse
*psmouse
)
574 struct input_dev
*dev
= psmouse
->dev
;
575 unsigned char *packet
= psmouse
->packet
;
579 /* notify finger state change */
580 fingers
= packet
[1] & 0x1f;
581 for (i
= 0; i
< ETP_MAX_FINGERS
; i
++) {
582 if ((fingers
& (1 << i
)) == 0) {
583 input_mt_slot(dev
, i
);
584 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, false);
588 elantech_input_sync_v4(psmouse
);
591 static void process_packet_head_v4(struct psmouse
*psmouse
)
593 struct input_dev
*dev
= psmouse
->dev
;
594 struct elantech_data
*etd
= psmouse
->private;
595 unsigned char *packet
= psmouse
->packet
;
596 int id
= ((packet
[3] & 0xe0) >> 5) - 1;
602 etd
->mt
[id
].x
= ((packet
[1] & 0x0f) << 8) | packet
[2];
603 etd
->mt
[id
].y
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
604 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
605 traces
= (packet
[0] & 0xf0) >> 4;
607 input_mt_slot(dev
, id
);
608 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, true);
610 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[id
].x
);
611 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[id
].y
);
612 input_report_abs(dev
, ABS_MT_PRESSURE
, pres
);
613 input_report_abs(dev
, ABS_MT_TOUCH_MAJOR
, traces
* etd
->width
);
614 /* report this for backwards compatibility */
615 input_report_abs(dev
, ABS_TOOL_WIDTH
, traces
);
617 elantech_input_sync_v4(psmouse
);
620 static void process_packet_motion_v4(struct psmouse
*psmouse
)
622 struct input_dev
*dev
= psmouse
->dev
;
623 struct elantech_data
*etd
= psmouse
->private;
624 unsigned char *packet
= psmouse
->packet
;
625 int weight
, delta_x1
= 0, delta_y1
= 0, delta_x2
= 0, delta_y2
= 0;
628 id
= ((packet
[0] & 0xe0) >> 5) - 1;
632 sid
= ((packet
[3] & 0xe0) >> 5) - 1;
633 weight
= (packet
[0] & 0x10) ? ETP_WEIGHT_VALUE
: 1;
635 * Motion packets give us the delta of x, y values of specific fingers,
636 * but in two's complement. Let the compiler do the conversion for us.
637 * Also _enlarge_ the numbers to int, in case of overflow.
639 delta_x1
= (signed char)packet
[1];
640 delta_y1
= (signed char)packet
[2];
641 delta_x2
= (signed char)packet
[4];
642 delta_y2
= (signed char)packet
[5];
644 etd
->mt
[id
].x
+= delta_x1
* weight
;
645 etd
->mt
[id
].y
-= delta_y1
* weight
;
646 input_mt_slot(dev
, id
);
647 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[id
].x
);
648 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[id
].y
);
651 etd
->mt
[sid
].x
+= delta_x2
* weight
;
652 etd
->mt
[sid
].y
-= delta_y2
* weight
;
653 input_mt_slot(dev
, sid
);
654 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[sid
].x
);
655 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[sid
].y
);
658 elantech_input_sync_v4(psmouse
);
661 static void elantech_report_absolute_v4(struct psmouse
*psmouse
,
664 switch (packet_type
) {
665 case PACKET_V4_STATUS
:
666 process_packet_status_v4(psmouse
);
670 process_packet_head_v4(psmouse
);
673 case PACKET_V4_MOTION
:
674 process_packet_motion_v4(psmouse
);
679 /* impossible to get here */
684 static int elantech_packet_check_v1(struct psmouse
*psmouse
)
686 struct elantech_data
*etd
= psmouse
->private;
687 unsigned char *packet
= psmouse
->packet
;
688 unsigned char p1
, p2
, p3
;
690 /* Parity bits are placed differently */
691 if (etd
->fw_version
< 0x020000) {
692 /* byte 0: D U p1 p2 1 p3 R L */
693 p1
= (packet
[0] & 0x20) >> 5;
694 p2
= (packet
[0] & 0x10) >> 4;
696 /* byte 0: n1 n0 p2 p1 1 p3 R L */
697 p1
= (packet
[0] & 0x10) >> 4;
698 p2
= (packet
[0] & 0x20) >> 5;
701 p3
= (packet
[0] & 0x04) >> 2;
703 return etd
->parity
[packet
[1]] == p1
&&
704 etd
->parity
[packet
[2]] == p2
&&
705 etd
->parity
[packet
[3]] == p3
;
708 static int elantech_debounce_check_v2(struct psmouse
*psmouse
)
711 * When we encounter packet that matches this exactly, it means the
712 * hardware is in debounce status. Just ignore the whole packet.
714 const u8 debounce_packet
[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
715 unsigned char *packet
= psmouse
->packet
;
717 return !memcmp(packet
, debounce_packet
, sizeof(debounce_packet
));
720 static int elantech_packet_check_v2(struct psmouse
*psmouse
)
722 struct elantech_data
*etd
= psmouse
->private;
723 unsigned char *packet
= psmouse
->packet
;
726 * V2 hardware has two flavors. Older ones that do not report pressure,
727 * and newer ones that reports pressure and width. With newer ones, all
728 * packets (1, 2, 3 finger touch) have the same constant bits. With
729 * older ones, 1/3 finger touch packets and 2 finger touch packets
730 * have different constant bits.
731 * With all three cases, if the constant bits are not exactly what I
732 * expected, I consider them invalid.
734 if (etd
->reports_pressure
)
735 return (packet
[0] & 0x0c) == 0x04 &&
736 (packet
[3] & 0x0f) == 0x02;
738 if ((packet
[0] & 0xc0) == 0x80)
739 return (packet
[0] & 0x0c) == 0x0c &&
740 (packet
[3] & 0x0e) == 0x08;
742 return (packet
[0] & 0x3c) == 0x3c &&
743 (packet
[1] & 0xf0) == 0x00 &&
744 (packet
[3] & 0x3e) == 0x38 &&
745 (packet
[4] & 0xf0) == 0x00;
749 * We check the constant bits to determine what packet type we get,
750 * so packet checking is mandatory for v3 and later hardware.
752 static int elantech_packet_check_v3(struct psmouse
*psmouse
)
754 struct elantech_data
*etd
= psmouse
->private;
755 const u8 debounce_packet
[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
756 unsigned char *packet
= psmouse
->packet
;
759 * check debounce first, it has the same signature in byte 0
760 * and byte 3 as PACKET_V3_HEAD.
762 if (!memcmp(packet
, debounce_packet
, sizeof(debounce_packet
)))
763 return PACKET_DEBOUNCE
;
766 * If the hardware flag 'crc_enabled' is set the packets have
767 * different signatures.
769 if (etd
->crc_enabled
) {
770 if ((packet
[3] & 0x09) == 0x08)
771 return PACKET_V3_HEAD
;
773 if ((packet
[3] & 0x09) == 0x09)
774 return PACKET_V3_TAIL
;
776 if ((packet
[0] & 0x0c) == 0x04 && (packet
[3] & 0xcf) == 0x02)
777 return PACKET_V3_HEAD
;
779 if ((packet
[0] & 0x0c) == 0x0c && (packet
[3] & 0xce) == 0x0c)
780 return PACKET_V3_TAIL
;
781 if ((packet
[3] & 0x0f) == 0x06)
782 return PACKET_TRACKPOINT
;
785 return PACKET_UNKNOWN
;
788 static int elantech_packet_check_v4(struct psmouse
*psmouse
)
790 struct elantech_data
*etd
= psmouse
->private;
791 unsigned char *packet
= psmouse
->packet
;
792 unsigned char packet_type
= packet
[3] & 0x03;
796 * Sanity check based on the constant bits of a packet.
797 * The constant bits change depending on the value of
798 * the hardware flag 'crc_enabled' but are the same for
799 * every packet, regardless of the type.
801 if (etd
->crc_enabled
)
802 sanity_check
= ((packet
[3] & 0x08) == 0x00);
804 sanity_check
= ((packet
[0] & 0x0c) == 0x04 &&
805 (packet
[3] & 0x1c) == 0x10);
808 return PACKET_UNKNOWN
;
810 switch (packet_type
) {
812 return PACKET_V4_STATUS
;
815 return PACKET_V4_HEAD
;
818 return PACKET_V4_MOTION
;
821 return PACKET_UNKNOWN
;
825 * Process byte stream from mouse and handle complete packets
827 static psmouse_ret_t
elantech_process_byte(struct psmouse
*psmouse
)
829 struct elantech_data
*etd
= psmouse
->private;
832 if (psmouse
->pktcnt
< psmouse
->pktsize
)
833 return PSMOUSE_GOOD_DATA
;
836 elantech_packet_dump(psmouse
);
838 switch (etd
->hw_version
) {
840 if (etd
->paritycheck
&& !elantech_packet_check_v1(psmouse
))
841 return PSMOUSE_BAD_DATA
;
843 elantech_report_absolute_v1(psmouse
);
847 /* ignore debounce */
848 if (elantech_debounce_check_v2(psmouse
))
849 return PSMOUSE_FULL_PACKET
;
851 if (etd
->paritycheck
&& !elantech_packet_check_v2(psmouse
))
852 return PSMOUSE_BAD_DATA
;
854 elantech_report_absolute_v2(psmouse
);
858 packet_type
= elantech_packet_check_v3(psmouse
);
859 switch (packet_type
) {
861 return PSMOUSE_BAD_DATA
;
863 case PACKET_DEBOUNCE
:
864 /* ignore debounce */
867 case PACKET_TRACKPOINT
:
868 elantech_report_trackpoint(psmouse
, packet_type
);
872 elantech_report_absolute_v3(psmouse
, packet_type
);
879 packet_type
= elantech_packet_check_v4(psmouse
);
880 if (packet_type
== PACKET_UNKNOWN
)
881 return PSMOUSE_BAD_DATA
;
883 elantech_report_absolute_v4(psmouse
, packet_type
);
887 return PSMOUSE_FULL_PACKET
;
891 * Put the touchpad into absolute mode
893 static int elantech_set_absolute_mode(struct psmouse
*psmouse
)
895 struct elantech_data
*etd
= psmouse
->private;
897 int tries
= ETP_READ_BACK_TRIES
;
900 switch (etd
->hw_version
) {
904 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
) ||
905 elantech_write_reg(psmouse
, 0x11, etd
->reg_11
)) {
911 /* Windows driver values */
913 etd
->reg_11
= 0x88; /* 0x8a */
914 etd
->reg_21
= 0x60; /* 0x00 */
915 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
) ||
916 elantech_write_reg(psmouse
, 0x11, etd
->reg_11
) ||
917 elantech_write_reg(psmouse
, 0x21, etd
->reg_21
)) {
923 if (etd
->set_hw_resolution
)
928 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
))
935 if (elantech_write_reg(psmouse
, 0x07, etd
->reg_07
))
938 goto skip_readback_reg_10
; /* v4 has no reg 0x10 to read */
943 * Read back reg 0x10. For hardware version 1 we must make
944 * sure the absolute mode bit is set. For hardware version 2
945 * the touchpad is probably initializing and not ready until
946 * we read back the value we just wrote.
949 rc
= elantech_read_reg(psmouse
, 0x10, &val
);
953 elantech_debug("retrying read (%d).\n", tries
);
954 msleep(ETP_READ_BACK_DELAY
);
959 "failed to read back register 0x10.\n");
960 } else if (etd
->hw_version
== 1 &&
961 !(val
& ETP_R10_ABSOLUTE_MODE
)) {
963 "touchpad refuses to switch to absolute mode.\n");
968 skip_readback_reg_10
:
970 psmouse_err(psmouse
, "failed to initialise registers.\n");
975 static int elantech_set_range(struct psmouse
*psmouse
,
976 unsigned int *x_min
, unsigned int *y_min
,
977 unsigned int *x_max
, unsigned int *y_max
,
980 struct elantech_data
*etd
= psmouse
->private;
981 unsigned char param
[3];
982 unsigned char traces
;
984 switch (etd
->hw_version
) {
986 *x_min
= ETP_XMIN_V1
;
987 *y_min
= ETP_YMIN_V1
;
988 *x_max
= ETP_XMAX_V1
;
989 *y_max
= ETP_YMAX_V1
;
993 if (etd
->fw_version
== 0x020800 ||
994 etd
->fw_version
== 0x020b00 ||
995 etd
->fw_version
== 0x020030) {
996 *x_min
= ETP_XMIN_V2
;
997 *y_min
= ETP_YMIN_V2
;
998 *x_max
= ETP_XMAX_V2
;
999 *y_max
= ETP_YMAX_V2
;
1004 i
= (etd
->fw_version
> 0x020800 &&
1005 etd
->fw_version
< 0x020900) ? 1 : 2;
1007 if (etd
->send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
1010 fixed_dpi
= param
[1] & 0x10;
1012 if (((etd
->fw_version
>> 16) == 0x14) && fixed_dpi
) {
1013 if (etd
->send_cmd(psmouse
, ETP_SAMPLE_QUERY
, param
))
1016 *x_max
= (etd
->capabilities
[1] - i
) * param
[1] / 2;
1017 *y_max
= (etd
->capabilities
[2] - i
) * param
[2] / 2;
1018 } else if (etd
->fw_version
== 0x040216) {
1021 } else if (etd
->fw_version
== 0x040219 || etd
->fw_version
== 0x040215) {
1025 *x_max
= (etd
->capabilities
[1] - i
) * 64;
1026 *y_max
= (etd
->capabilities
[2] - i
) * 64;
1032 if (etd
->send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
1035 *x_max
= (0x0f & param
[0]) << 8 | param
[1];
1036 *y_max
= (0xf0 & param
[0]) << 4 | param
[2];
1040 if (etd
->send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
1043 *x_max
= (0x0f & param
[0]) << 8 | param
[1];
1044 *y_max
= (0xf0 & param
[0]) << 4 | param
[2];
1045 traces
= etd
->capabilities
[1];
1046 if ((traces
< 2) || (traces
> *x_max
))
1049 *width
= *x_max
/ (traces
- 1);
1057 * (value from firmware) * 10 + 790 = dpi
1058 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1060 static unsigned int elantech_convert_res(unsigned int val
)
1062 return (val
* 10 + 790) * 10 / 254;
1065 static int elantech_get_resolution_v4(struct psmouse
*psmouse
,
1066 unsigned int *x_res
,
1067 unsigned int *y_res
)
1069 unsigned char param
[3];
1071 if (elantech_send_cmd(psmouse
, ETP_RESOLUTION_QUERY
, param
))
1074 *x_res
= elantech_convert_res(param
[1] & 0x0f);
1075 *y_res
= elantech_convert_res((param
[1] & 0xf0) >> 4);
1081 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1082 * fw_version for this is based on the following fw_version & caps table:
1084 * Laptop-model: fw_version: caps: buttons:
1085 * Acer S3 0x461f00 10, 13, 0e clickpad
1086 * Acer S7-392 0x581f01 50, 17, 0d clickpad
1087 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1088 * Acer V5-551 0x461f00 ? clickpad
1089 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1090 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1091 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
1092 * Asus UX31 0x361f00 20, 15, 0e clickpad
1093 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1094 * Avatar AVIU-145A2 0x361f00 ? clickpad
1095 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
1096 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1097 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
1098 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
1099 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1100 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1101 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1102 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1103 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1104 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1105 * Samsung RF710 0x450f00 ? 2 hw buttons
1106 * System76 Pangolin 0x250f01 ? 2 hw buttons
1107 * (*) + 3 trackpoint buttons
1108 * (**) + 0 trackpoint buttons
1109 * Note: Lenovo L430 and Lenovo L430 have the same fw_version/caps
1111 static void elantech_set_buttonpad_prop(struct psmouse
*psmouse
)
1113 struct input_dev
*dev
= psmouse
->dev
;
1114 struct elantech_data
*etd
= psmouse
->private;
1116 if (etd
->fw_version
& 0x001000) {
1117 __set_bit(INPUT_PROP_BUTTONPAD
, dev
->propbit
);
1118 __clear_bit(BTN_RIGHT
, dev
->keybit
);
1123 * Set the appropriate event bits for the input subsystem
1125 static int elantech_set_input_params(struct psmouse
*psmouse
)
1127 struct input_dev
*dev
= psmouse
->dev
;
1128 struct elantech_data
*etd
= psmouse
->private;
1129 unsigned int x_min
= 0, y_min
= 0, x_max
= 0, y_max
= 0, width
= 0;
1130 unsigned int x_res
= 0, y_res
= 0;
1132 if (elantech_set_range(psmouse
, &x_min
, &y_min
, &x_max
, &y_max
, &width
))
1135 __set_bit(INPUT_PROP_POINTER
, dev
->propbit
);
1136 __set_bit(EV_KEY
, dev
->evbit
);
1137 __set_bit(EV_ABS
, dev
->evbit
);
1138 __clear_bit(EV_REL
, dev
->evbit
);
1140 __set_bit(BTN_LEFT
, dev
->keybit
);
1141 __set_bit(BTN_RIGHT
, dev
->keybit
);
1143 __set_bit(BTN_TOUCH
, dev
->keybit
);
1144 __set_bit(BTN_TOOL_FINGER
, dev
->keybit
);
1145 __set_bit(BTN_TOOL_DOUBLETAP
, dev
->keybit
);
1146 __set_bit(BTN_TOOL_TRIPLETAP
, dev
->keybit
);
1148 switch (etd
->hw_version
) {
1151 if (etd
->fw_version
< 0x020000 &&
1152 (etd
->capabilities
[0] & ETP_CAP_HAS_ROCKER
)) {
1153 __set_bit(BTN_FORWARD
, dev
->keybit
);
1154 __set_bit(BTN_BACK
, dev
->keybit
);
1156 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
1157 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
1161 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
1162 __set_bit(INPUT_PROP_SEMI_MT
, dev
->propbit
);
1165 if (etd
->hw_version
== 3)
1166 elantech_set_buttonpad_prop(psmouse
);
1167 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
1168 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
1169 if (etd
->reports_pressure
) {
1170 input_set_abs_params(dev
, ABS_PRESSURE
, ETP_PMIN_V2
,
1172 input_set_abs_params(dev
, ABS_TOOL_WIDTH
, ETP_WMIN_V2
,
1175 input_mt_init_slots(dev
, 2, 0);
1176 input_set_abs_params(dev
, ABS_MT_POSITION_X
, x_min
, x_max
, 0, 0);
1177 input_set_abs_params(dev
, ABS_MT_POSITION_Y
, y_min
, y_max
, 0, 0);
1181 if (elantech_get_resolution_v4(psmouse
, &x_res
, &y_res
)) {
1183 * if query failed, print a warning and leave the values
1184 * zero to resemble synaptics.c behavior.
1186 psmouse_warn(psmouse
, "couldn't query resolution data.\n");
1188 elantech_set_buttonpad_prop(psmouse
);
1189 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
1190 /* For X to recognize me as touchpad. */
1191 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
1192 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
1193 input_abs_set_res(dev
, ABS_X
, x_res
);
1194 input_abs_set_res(dev
, ABS_Y
, y_res
);
1196 * range of pressure and width is the same as v2,
1197 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1199 input_set_abs_params(dev
, ABS_PRESSURE
, ETP_PMIN_V2
,
1201 input_set_abs_params(dev
, ABS_TOOL_WIDTH
, ETP_WMIN_V2
,
1203 /* Multitouch capable pad, up to 5 fingers. */
1204 input_mt_init_slots(dev
, ETP_MAX_FINGERS
, 0);
1205 input_set_abs_params(dev
, ABS_MT_POSITION_X
, x_min
, x_max
, 0, 0);
1206 input_set_abs_params(dev
, ABS_MT_POSITION_Y
, y_min
, y_max
, 0, 0);
1207 input_abs_set_res(dev
, ABS_MT_POSITION_X
, x_res
);
1208 input_abs_set_res(dev
, ABS_MT_POSITION_Y
, y_res
);
1209 input_set_abs_params(dev
, ABS_MT_PRESSURE
, ETP_PMIN_V2
,
1212 * The firmware reports how many trace lines the finger spans,
1213 * convert to surface unit as Protocol-B requires.
1215 input_set_abs_params(dev
, ABS_MT_TOUCH_MAJOR
, 0,
1216 ETP_WMAX_V2
* width
, 0, 0);
1226 struct elantech_attr_data
{
1227 size_t field_offset
;
1232 * Display a register value by reading a sysfs entry
1234 static ssize_t
elantech_show_int_attr(struct psmouse
*psmouse
, void *data
,
1237 struct elantech_data
*etd
= psmouse
->private;
1238 struct elantech_attr_data
*attr
= data
;
1239 unsigned char *reg
= (unsigned char *) etd
+ attr
->field_offset
;
1243 rc
= elantech_read_reg(psmouse
, attr
->reg
, reg
);
1245 return sprintf(buf
, "0x%02x\n", (attr
->reg
&& rc
) ? -1 : *reg
);
1249 * Write a register value by writing a sysfs entry
1251 static ssize_t
elantech_set_int_attr(struct psmouse
*psmouse
,
1252 void *data
, const char *buf
, size_t count
)
1254 struct elantech_data
*etd
= psmouse
->private;
1255 struct elantech_attr_data
*attr
= data
;
1256 unsigned char *reg
= (unsigned char *) etd
+ attr
->field_offset
;
1257 unsigned char value
;
1260 err
= kstrtou8(buf
, 16, &value
);
1264 /* Do we need to preserve some bits for version 2 hardware too? */
1265 if (etd
->hw_version
== 1) {
1266 if (attr
->reg
== 0x10)
1267 /* Force absolute mode always on */
1268 value
|= ETP_R10_ABSOLUTE_MODE
;
1269 else if (attr
->reg
== 0x11)
1270 /* Force 4 byte mode always on */
1271 value
|= ETP_R11_4_BYTE_MODE
;
1274 if (!attr
->reg
|| elantech_write_reg(psmouse
, attr
->reg
, value
) == 0)
1280 #define ELANTECH_INT_ATTR(_name, _register) \
1281 static struct elantech_attr_data elantech_attr_##_name = { \
1282 .field_offset = offsetof(struct elantech_data, _name), \
1285 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1286 &elantech_attr_##_name, \
1287 elantech_show_int_attr, \
1288 elantech_set_int_attr)
1290 ELANTECH_INT_ATTR(reg_07
, 0x07);
1291 ELANTECH_INT_ATTR(reg_10
, 0x10);
1292 ELANTECH_INT_ATTR(reg_11
, 0x11);
1293 ELANTECH_INT_ATTR(reg_20
, 0x20);
1294 ELANTECH_INT_ATTR(reg_21
, 0x21);
1295 ELANTECH_INT_ATTR(reg_22
, 0x22);
1296 ELANTECH_INT_ATTR(reg_23
, 0x23);
1297 ELANTECH_INT_ATTR(reg_24
, 0x24);
1298 ELANTECH_INT_ATTR(reg_25
, 0x25);
1299 ELANTECH_INT_ATTR(reg_26
, 0x26);
1300 ELANTECH_INT_ATTR(debug
, 0);
1301 ELANTECH_INT_ATTR(paritycheck
, 0);
1303 static struct attribute
*elantech_attrs
[] = {
1304 &psmouse_attr_reg_07
.dattr
.attr
,
1305 &psmouse_attr_reg_10
.dattr
.attr
,
1306 &psmouse_attr_reg_11
.dattr
.attr
,
1307 &psmouse_attr_reg_20
.dattr
.attr
,
1308 &psmouse_attr_reg_21
.dattr
.attr
,
1309 &psmouse_attr_reg_22
.dattr
.attr
,
1310 &psmouse_attr_reg_23
.dattr
.attr
,
1311 &psmouse_attr_reg_24
.dattr
.attr
,
1312 &psmouse_attr_reg_25
.dattr
.attr
,
1313 &psmouse_attr_reg_26
.dattr
.attr
,
1314 &psmouse_attr_debug
.dattr
.attr
,
1315 &psmouse_attr_paritycheck
.dattr
.attr
,
1319 static struct attribute_group elantech_attr_group
= {
1320 .attrs
= elantech_attrs
,
1323 static bool elantech_is_signature_valid(const unsigned char *param
)
1325 static const unsigned char rates
[] = { 200, 100, 80, 60, 40, 20, 10 };
1335 * Some models have a revision higher then 20. Meaning param[2] may
1336 * be 10 or 20, skip the rates check for these.
1338 if (param
[0] == 0x46 && (param
[1] & 0xef) == 0x0f && param
[2] < 40)
1341 for (i
= 0; i
< ARRAY_SIZE(rates
); i
++)
1342 if (param
[2] == rates
[i
])
1349 * Use magic knock to detect Elantech touchpad
1351 int elantech_detect(struct psmouse
*psmouse
, bool set_properties
)
1353 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
1354 unsigned char param
[3];
1356 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
);
1358 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
1359 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1360 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1361 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1362 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
)) {
1363 psmouse_dbg(psmouse
, "sending Elantech magic knock failed.\n");
1368 * Report this in case there are Elantech models that use a different
1369 * set of magic numbers
1371 if (param
[0] != 0x3c || param
[1] != 0x03 ||
1372 (param
[2] != 0xc8 && param
[2] != 0x00)) {
1373 psmouse_dbg(psmouse
,
1374 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1375 param
[0], param
[1], param
[2]);
1380 * Query touchpad's firmware version and see if it reports known
1381 * value to avoid mis-detection. Logitech mice are known to respond
1382 * to Elantech magic knock and there might be more.
1384 if (synaptics_send_cmd(psmouse
, ETP_FW_VERSION_QUERY
, param
)) {
1385 psmouse_dbg(psmouse
, "failed to query firmware version.\n");
1389 psmouse_dbg(psmouse
,
1390 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1391 param
[0], param
[1], param
[2]);
1393 if (!elantech_is_signature_valid(param
)) {
1394 psmouse_dbg(psmouse
,
1395 "Probably not a real Elantech touchpad. Aborting.\n");
1399 if (set_properties
) {
1400 psmouse
->vendor
= "Elantech";
1401 psmouse
->name
= "Touchpad";
1408 * Clean up sysfs entries when disconnecting
1410 static void elantech_disconnect(struct psmouse
*psmouse
)
1412 struct elantech_data
*etd
= psmouse
->private;
1415 input_unregister_device(etd
->tp_dev
);
1416 sysfs_remove_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1417 &elantech_attr_group
);
1418 kfree(psmouse
->private);
1419 psmouse
->private = NULL
;
1423 * Put the touchpad back into absolute mode when reconnecting
1425 static int elantech_reconnect(struct psmouse
*psmouse
)
1427 psmouse_reset(psmouse
);
1429 if (elantech_detect(psmouse
, 0))
1432 if (elantech_set_absolute_mode(psmouse
)) {
1433 psmouse_err(psmouse
,
1434 "failed to put touchpad back into absolute mode.\n");
1442 * Some hw_version 3 models go into error state when we try to set
1443 * bit 3 and/or bit 1 of r10.
1445 static const struct dmi_system_id no_hw_res_dmi_table
[] = {
1446 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1448 /* Gigabyte U2442 */
1450 DMI_MATCH(DMI_SYS_VENDOR
, "GIGABYTE"),
1451 DMI_MATCH(DMI_PRODUCT_NAME
, "U2442"),
1459 * determine hardware version and set some properties according to it.
1461 static int elantech_set_properties(struct elantech_data
*etd
)
1463 /* This represents the version of IC body. */
1464 int ver
= (etd
->fw_version
& 0x0f0000) >> 16;
1466 /* Early version of Elan touchpads doesn't obey the rule. */
1467 if (etd
->fw_version
< 0x020030 || etd
->fw_version
== 0x020600)
1468 etd
->hw_version
= 1;
1473 etd
->hw_version
= 2;
1476 etd
->hw_version
= 3;
1482 etd
->hw_version
= 4;
1489 /* decide which send_cmd we're gonna use early */
1490 etd
->send_cmd
= etd
->hw_version
>= 3 ? elantech_send_cmd
:
1493 /* Turn on packet checking by default */
1494 etd
->paritycheck
= 1;
1497 * This firmware suffers from misreporting coordinates when
1498 * a touch action starts causing the mouse cursor or scrolled page
1499 * to jump. Enable a workaround.
1502 (etd
->fw_version
== 0x020022 || etd
->fw_version
== 0x020600);
1504 if (etd
->hw_version
> 1) {
1505 /* For now show extra debug information */
1508 if (etd
->fw_version
>= 0x020800)
1509 etd
->reports_pressure
= true;
1513 * The signatures of v3 and v4 packets change depending on the
1514 * value of this hardware flag.
1516 etd
->crc_enabled
= ((etd
->fw_version
& 0x4000) == 0x4000);
1518 /* Enable real hardware resolution on hw_version 3 ? */
1519 etd
->set_hw_resolution
= !dmi_check_system(no_hw_res_dmi_table
);
1525 * Initialize the touchpad and create sysfs entries
1527 int elantech_init(struct psmouse
*psmouse
)
1529 struct elantech_data
*etd
;
1531 int error
= -EINVAL
;
1532 unsigned char param
[3];
1533 struct input_dev
*tp_dev
;
1535 psmouse
->private = etd
= kzalloc(sizeof(struct elantech_data
), GFP_KERNEL
);
1539 psmouse_reset(psmouse
);
1542 for (i
= 1; i
< 256; i
++)
1543 etd
->parity
[i
] = etd
->parity
[i
& (i
- 1)] ^ 1;
1546 * Do the version query again so we can store the result
1548 if (synaptics_send_cmd(psmouse
, ETP_FW_VERSION_QUERY
, param
)) {
1549 psmouse_err(psmouse
, "failed to query firmware version.\n");
1552 etd
->fw_version
= (param
[0] << 16) | (param
[1] << 8) | param
[2];
1554 if (elantech_set_properties(etd
)) {
1555 psmouse_err(psmouse
, "unknown hardware version, aborting...\n");
1558 psmouse_info(psmouse
,
1559 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1560 etd
->hw_version
, param
[0], param
[1], param
[2]);
1562 if (etd
->send_cmd(psmouse
, ETP_CAPABILITIES_QUERY
,
1563 etd
->capabilities
)) {
1564 psmouse_err(psmouse
, "failed to query capabilities.\n");
1567 psmouse_info(psmouse
,
1568 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1569 etd
->capabilities
[0], etd
->capabilities
[1],
1570 etd
->capabilities
[2]);
1572 if (elantech_set_absolute_mode(psmouse
)) {
1573 psmouse_err(psmouse
,
1574 "failed to put touchpad into absolute mode.\n");
1578 if (elantech_set_input_params(psmouse
)) {
1579 psmouse_err(psmouse
, "failed to query touchpad range.\n");
1583 error
= sysfs_create_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1584 &elantech_attr_group
);
1586 psmouse_err(psmouse
,
1587 "failed to create sysfs attributes, error: %d.\n",
1592 /* The MSB indicates the presence of the trackpoint */
1593 if ((etd
->capabilities
[0] & 0x80) == 0x80) {
1594 tp_dev
= input_allocate_device();
1598 goto init_fail_tp_alloc
;
1601 etd
->tp_dev
= tp_dev
;
1602 snprintf(etd
->tp_phys
, sizeof(etd
->tp_phys
), "%s/input1",
1603 psmouse
->ps2dev
.serio
->phys
);
1604 tp_dev
->phys
= etd
->tp_phys
;
1605 tp_dev
->name
= "Elantech PS/2 TrackPoint";
1606 tp_dev
->id
.bustype
= BUS_I8042
;
1607 tp_dev
->id
.vendor
= 0x0002;
1608 tp_dev
->id
.product
= PSMOUSE_ELANTECH
;
1609 tp_dev
->id
.version
= 0x0000;
1610 tp_dev
->dev
.parent
= &psmouse
->ps2dev
.serio
->dev
;
1611 tp_dev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REL
);
1612 tp_dev
->relbit
[BIT_WORD(REL_X
)] =
1613 BIT_MASK(REL_X
) | BIT_MASK(REL_Y
);
1614 tp_dev
->keybit
[BIT_WORD(BTN_LEFT
)] =
1615 BIT_MASK(BTN_LEFT
) | BIT_MASK(BTN_MIDDLE
) |
1616 BIT_MASK(BTN_RIGHT
);
1618 __set_bit(INPUT_PROP_POINTER
, tp_dev
->propbit
);
1619 __set_bit(INPUT_PROP_POINTING_STICK
, tp_dev
->propbit
);
1621 error
= input_register_device(etd
->tp_dev
);
1623 goto init_fail_tp_reg
;
1626 psmouse
->protocol_handler
= elantech_process_byte
;
1627 psmouse
->disconnect
= elantech_disconnect
;
1628 psmouse
->reconnect
= elantech_reconnect
;
1629 psmouse
->pktsize
= etd
->hw_version
> 1 ? 6 : 4;
1633 input_free_device(tp_dev
);
1635 sysfs_remove_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1636 &elantech_attr_group
);
1638 psmouse_reset(psmouse
);