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 t
= get_unaligned_le32(&packet
[0]);
438 x
= packet
[4] - (int)((packet
[1]^0x80) << 1);
439 y
= (int)((packet
[2]^0x80) << 1) - packet
[5];
441 input_report_key(tp_dev
, BTN_LEFT
, packet
[0] & 0x01);
442 input_report_key(tp_dev
, BTN_RIGHT
, packet
[0] & 0x02);
443 input_report_key(tp_dev
, BTN_MIDDLE
, packet
[0] & 0x04);
445 input_report_rel(tp_dev
, REL_X
, x
);
446 input_report_rel(tp_dev
, REL_Y
, y
);
453 /* Dump unexpected packet sequences if debug=1 (default) */
455 elantech_packet_dump(psmouse
);
462 * Interpret complete data packets and report absolute mode input events for
463 * hardware version 3. (12 byte packets for two fingers)
465 static void elantech_report_absolute_v3(struct psmouse
*psmouse
,
468 struct input_dev
*dev
= psmouse
->dev
;
469 struct elantech_data
*etd
= psmouse
->private;
470 unsigned char *packet
= psmouse
->packet
;
471 unsigned int fingers
= 0, x1
= 0, y1
= 0, x2
= 0, y2
= 0;
472 unsigned int width
= 0, pres
= 0;
474 /* byte 0: n1 n0 . . . . R L */
475 fingers
= (packet
[0] & 0xc0) >> 6;
481 * byte 1: . . . . x11 x10 x9 x8
482 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
484 x1
= ((packet
[1] & 0x0f) << 8) | packet
[2];
486 * byte 4: . . . . y11 y10 y9 y8
487 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
489 y1
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
493 if (packet_type
== PACKET_V3_HEAD
) {
495 * byte 1: . . . . ax11 ax10 ax9 ax8
496 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
498 etd
->mt
[0].x
= ((packet
[1] & 0x0f) << 8) | packet
[2];
500 * byte 4: . . . . ay11 ay10 ay9 ay8
501 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
503 etd
->mt
[0].y
= etd
->y_max
-
504 (((packet
[4] & 0x0f) << 8) | packet
[5]);
506 * wait for next packet
511 /* packet_type == PACKET_V3_TAIL */
514 x2
= ((packet
[1] & 0x0f) << 8) | packet
[2];
515 y2
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
519 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
520 width
= ((packet
[0] & 0x30) >> 2) | ((packet
[3] & 0x30) >> 4);
522 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
524 input_report_abs(dev
, ABS_X
, x1
);
525 input_report_abs(dev
, ABS_Y
, y1
);
527 elantech_report_semi_mt_data(dev
, fingers
, x1
, y1
, x2
, y2
);
528 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
529 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
530 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
532 /* For clickpads map both buttons to BTN_LEFT */
533 if (etd
->fw_version
& 0x001000) {
534 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x03);
536 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
537 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
540 input_report_abs(dev
, ABS_PRESSURE
, pres
);
541 input_report_abs(dev
, ABS_TOOL_WIDTH
, width
);
546 static void elantech_input_sync_v4(struct psmouse
*psmouse
)
548 struct input_dev
*dev
= psmouse
->dev
;
549 struct elantech_data
*etd
= psmouse
->private;
550 unsigned char *packet
= psmouse
->packet
;
552 /* For clickpads map both buttons to BTN_LEFT */
553 if (etd
->fw_version
& 0x001000) {
554 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x03);
556 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
557 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
558 input_report_key(dev
, BTN_MIDDLE
, packet
[0] & 0x04);
561 input_mt_report_pointer_emulation(dev
, true);
565 static void process_packet_status_v4(struct psmouse
*psmouse
)
567 struct input_dev
*dev
= psmouse
->dev
;
568 unsigned char *packet
= psmouse
->packet
;
572 /* notify finger state change */
573 fingers
= packet
[1] & 0x1f;
574 for (i
= 0; i
< ETP_MAX_FINGERS
; i
++) {
575 if ((fingers
& (1 << i
)) == 0) {
576 input_mt_slot(dev
, i
);
577 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, false);
581 elantech_input_sync_v4(psmouse
);
584 static void process_packet_head_v4(struct psmouse
*psmouse
)
586 struct input_dev
*dev
= psmouse
->dev
;
587 struct elantech_data
*etd
= psmouse
->private;
588 unsigned char *packet
= psmouse
->packet
;
589 int id
= ((packet
[3] & 0xe0) >> 5) - 1;
595 etd
->mt
[id
].x
= ((packet
[1] & 0x0f) << 8) | packet
[2];
596 etd
->mt
[id
].y
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
597 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
598 traces
= (packet
[0] & 0xf0) >> 4;
600 input_mt_slot(dev
, id
);
601 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, true);
603 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[id
].x
);
604 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[id
].y
);
605 input_report_abs(dev
, ABS_MT_PRESSURE
, pres
);
606 input_report_abs(dev
, ABS_MT_TOUCH_MAJOR
, traces
* etd
->width
);
607 /* report this for backwards compatibility */
608 input_report_abs(dev
, ABS_TOOL_WIDTH
, traces
);
610 elantech_input_sync_v4(psmouse
);
613 static void process_packet_motion_v4(struct psmouse
*psmouse
)
615 struct input_dev
*dev
= psmouse
->dev
;
616 struct elantech_data
*etd
= psmouse
->private;
617 unsigned char *packet
= psmouse
->packet
;
618 int weight
, delta_x1
= 0, delta_y1
= 0, delta_x2
= 0, delta_y2
= 0;
621 id
= ((packet
[0] & 0xe0) >> 5) - 1;
625 sid
= ((packet
[3] & 0xe0) >> 5) - 1;
626 weight
= (packet
[0] & 0x10) ? ETP_WEIGHT_VALUE
: 1;
628 * Motion packets give us the delta of x, y values of specific fingers,
629 * but in two's complement. Let the compiler do the conversion for us.
630 * Also _enlarge_ the numbers to int, in case of overflow.
632 delta_x1
= (signed char)packet
[1];
633 delta_y1
= (signed char)packet
[2];
634 delta_x2
= (signed char)packet
[4];
635 delta_y2
= (signed char)packet
[5];
637 etd
->mt
[id
].x
+= delta_x1
* weight
;
638 etd
->mt
[id
].y
-= delta_y1
* weight
;
639 input_mt_slot(dev
, id
);
640 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[id
].x
);
641 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[id
].y
);
644 etd
->mt
[sid
].x
+= delta_x2
* weight
;
645 etd
->mt
[sid
].y
-= delta_y2
* weight
;
646 input_mt_slot(dev
, sid
);
647 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[sid
].x
);
648 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[sid
].y
);
651 elantech_input_sync_v4(psmouse
);
654 static void elantech_report_absolute_v4(struct psmouse
*psmouse
,
657 switch (packet_type
) {
658 case PACKET_V4_STATUS
:
659 process_packet_status_v4(psmouse
);
663 process_packet_head_v4(psmouse
);
666 case PACKET_V4_MOTION
:
667 process_packet_motion_v4(psmouse
);
672 /* impossible to get here */
677 static int elantech_packet_check_v1(struct psmouse
*psmouse
)
679 struct elantech_data
*etd
= psmouse
->private;
680 unsigned char *packet
= psmouse
->packet
;
681 unsigned char p1
, p2
, p3
;
683 /* Parity bits are placed differently */
684 if (etd
->fw_version
< 0x020000) {
685 /* byte 0: D U p1 p2 1 p3 R L */
686 p1
= (packet
[0] & 0x20) >> 5;
687 p2
= (packet
[0] & 0x10) >> 4;
689 /* byte 0: n1 n0 p2 p1 1 p3 R L */
690 p1
= (packet
[0] & 0x10) >> 4;
691 p2
= (packet
[0] & 0x20) >> 5;
694 p3
= (packet
[0] & 0x04) >> 2;
696 return etd
->parity
[packet
[1]] == p1
&&
697 etd
->parity
[packet
[2]] == p2
&&
698 etd
->parity
[packet
[3]] == p3
;
701 static int elantech_debounce_check_v2(struct psmouse
*psmouse
)
704 * When we encounter packet that matches this exactly, it means the
705 * hardware is in debounce status. Just ignore the whole packet.
707 const u8 debounce_packet
[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
708 unsigned char *packet
= psmouse
->packet
;
710 return !memcmp(packet
, debounce_packet
, sizeof(debounce_packet
));
713 static int elantech_packet_check_v2(struct psmouse
*psmouse
)
715 struct elantech_data
*etd
= psmouse
->private;
716 unsigned char *packet
= psmouse
->packet
;
719 * V2 hardware has two flavors. Older ones that do not report pressure,
720 * and newer ones that reports pressure and width. With newer ones, all
721 * packets (1, 2, 3 finger touch) have the same constant bits. With
722 * older ones, 1/3 finger touch packets and 2 finger touch packets
723 * have different constant bits.
724 * With all three cases, if the constant bits are not exactly what I
725 * expected, I consider them invalid.
727 if (etd
->reports_pressure
)
728 return (packet
[0] & 0x0c) == 0x04 &&
729 (packet
[3] & 0x0f) == 0x02;
731 if ((packet
[0] & 0xc0) == 0x80)
732 return (packet
[0] & 0x0c) == 0x0c &&
733 (packet
[3] & 0x0e) == 0x08;
735 return (packet
[0] & 0x3c) == 0x3c &&
736 (packet
[1] & 0xf0) == 0x00 &&
737 (packet
[3] & 0x3e) == 0x38 &&
738 (packet
[4] & 0xf0) == 0x00;
742 * We check the constant bits to determine what packet type we get,
743 * so packet checking is mandatory for v3 and later hardware.
745 static int elantech_packet_check_v3(struct psmouse
*psmouse
)
747 struct elantech_data
*etd
= psmouse
->private;
748 const u8 debounce_packet
[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
749 unsigned char *packet
= psmouse
->packet
;
752 * check debounce first, it has the same signature in byte 0
753 * and byte 3 as PACKET_V3_HEAD.
755 if (!memcmp(packet
, debounce_packet
, sizeof(debounce_packet
)))
756 return PACKET_DEBOUNCE
;
759 * If the hardware flag 'crc_enabled' is set the packets have
760 * different signatures.
762 if (etd
->crc_enabled
) {
763 if ((packet
[3] & 0x09) == 0x08)
764 return PACKET_V3_HEAD
;
766 if ((packet
[3] & 0x09) == 0x09)
767 return PACKET_V3_TAIL
;
769 if ((packet
[0] & 0x0c) == 0x04 && (packet
[3] & 0xcf) == 0x02)
770 return PACKET_V3_HEAD
;
772 if ((packet
[0] & 0x0c) == 0x0c && (packet
[3] & 0xce) == 0x0c)
773 return PACKET_V3_TAIL
;
774 if ((packet
[3] & 0x0f) == 0x06)
775 return PACKET_TRACKPOINT
;
778 return PACKET_UNKNOWN
;
781 static int elantech_packet_check_v4(struct psmouse
*psmouse
)
783 struct elantech_data
*etd
= psmouse
->private;
784 unsigned char *packet
= psmouse
->packet
;
785 unsigned char packet_type
= packet
[3] & 0x03;
788 if (etd
->tp_dev
&& (packet
[3] & 0x0f) == 0x06)
789 return PACKET_TRACKPOINT
;
792 * Sanity check based on the constant bits of a packet.
793 * The constant bits change depending on the value of
794 * the hardware flag 'crc_enabled' but are the same for
795 * every packet, regardless of the type.
797 if (etd
->crc_enabled
)
798 sanity_check
= ((packet
[3] & 0x08) == 0x00);
800 sanity_check
= ((packet
[0] & 0x0c) == 0x04 &&
801 (packet
[3] & 0x1c) == 0x10);
804 return PACKET_UNKNOWN
;
806 switch (packet_type
) {
808 return PACKET_V4_STATUS
;
811 return PACKET_V4_HEAD
;
814 return PACKET_V4_MOTION
;
817 return PACKET_UNKNOWN
;
821 * Process byte stream from mouse and handle complete packets
823 static psmouse_ret_t
elantech_process_byte(struct psmouse
*psmouse
)
825 struct elantech_data
*etd
= psmouse
->private;
828 if (psmouse
->pktcnt
< psmouse
->pktsize
)
829 return PSMOUSE_GOOD_DATA
;
832 elantech_packet_dump(psmouse
);
834 switch (etd
->hw_version
) {
836 if (etd
->paritycheck
&& !elantech_packet_check_v1(psmouse
))
837 return PSMOUSE_BAD_DATA
;
839 elantech_report_absolute_v1(psmouse
);
843 /* ignore debounce */
844 if (elantech_debounce_check_v2(psmouse
))
845 return PSMOUSE_FULL_PACKET
;
847 if (etd
->paritycheck
&& !elantech_packet_check_v2(psmouse
))
848 return PSMOUSE_BAD_DATA
;
850 elantech_report_absolute_v2(psmouse
);
854 packet_type
= elantech_packet_check_v3(psmouse
);
855 switch (packet_type
) {
857 return PSMOUSE_BAD_DATA
;
859 case PACKET_DEBOUNCE
:
860 /* ignore debounce */
863 case PACKET_TRACKPOINT
:
864 elantech_report_trackpoint(psmouse
, packet_type
);
868 elantech_report_absolute_v3(psmouse
, packet_type
);
875 packet_type
= elantech_packet_check_v4(psmouse
);
876 switch (packet_type
) {
878 return PSMOUSE_BAD_DATA
;
880 case PACKET_TRACKPOINT
:
881 elantech_report_trackpoint(psmouse
, packet_type
);
885 elantech_report_absolute_v4(psmouse
, packet_type
);
892 return PSMOUSE_FULL_PACKET
;
896 * This writes the reg_07 value again to the hardware at the end of every
897 * set_rate call because the register loses its value. reg_07 allows setting
898 * absolute mode on v4 hardware
900 static void elantech_set_rate_restore_reg_07(struct psmouse
*psmouse
,
903 struct elantech_data
*etd
= psmouse
->private;
905 etd
->original_set_rate(psmouse
, rate
);
906 if (elantech_write_reg(psmouse
, 0x07, etd
->reg_07
))
907 psmouse_err(psmouse
, "restoring reg_07 failed\n");
911 * Put the touchpad into absolute mode
913 static int elantech_set_absolute_mode(struct psmouse
*psmouse
)
915 struct elantech_data
*etd
= psmouse
->private;
917 int tries
= ETP_READ_BACK_TRIES
;
920 switch (etd
->hw_version
) {
924 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
) ||
925 elantech_write_reg(psmouse
, 0x11, etd
->reg_11
)) {
931 /* Windows driver values */
933 etd
->reg_11
= 0x88; /* 0x8a */
934 etd
->reg_21
= 0x60; /* 0x00 */
935 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
) ||
936 elantech_write_reg(psmouse
, 0x11, etd
->reg_11
) ||
937 elantech_write_reg(psmouse
, 0x21, etd
->reg_21
)) {
943 if (etd
->set_hw_resolution
)
948 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
))
955 if (elantech_write_reg(psmouse
, 0x07, etd
->reg_07
))
958 goto skip_readback_reg_10
; /* v4 has no reg 0x10 to read */
963 * Read back reg 0x10. For hardware version 1 we must make
964 * sure the absolute mode bit is set. For hardware version 2
965 * the touchpad is probably initializing and not ready until
966 * we read back the value we just wrote.
969 rc
= elantech_read_reg(psmouse
, 0x10, &val
);
973 elantech_debug("retrying read (%d).\n", tries
);
974 msleep(ETP_READ_BACK_DELAY
);
979 "failed to read back register 0x10.\n");
980 } else if (etd
->hw_version
== 1 &&
981 !(val
& ETP_R10_ABSOLUTE_MODE
)) {
983 "touchpad refuses to switch to absolute mode.\n");
988 skip_readback_reg_10
:
990 psmouse_err(psmouse
, "failed to initialise registers.\n");
995 static int elantech_set_range(struct psmouse
*psmouse
,
996 unsigned int *x_min
, unsigned int *y_min
,
997 unsigned int *x_max
, unsigned int *y_max
,
1000 struct elantech_data
*etd
= psmouse
->private;
1001 unsigned char param
[3];
1002 unsigned char traces
;
1004 switch (etd
->hw_version
) {
1006 *x_min
= ETP_XMIN_V1
;
1007 *y_min
= ETP_YMIN_V1
;
1008 *x_max
= ETP_XMAX_V1
;
1009 *y_max
= ETP_YMAX_V1
;
1013 if (etd
->fw_version
== 0x020800 ||
1014 etd
->fw_version
== 0x020b00 ||
1015 etd
->fw_version
== 0x020030) {
1016 *x_min
= ETP_XMIN_V2
;
1017 *y_min
= ETP_YMIN_V2
;
1018 *x_max
= ETP_XMAX_V2
;
1019 *y_max
= ETP_YMAX_V2
;
1024 i
= (etd
->fw_version
> 0x020800 &&
1025 etd
->fw_version
< 0x020900) ? 1 : 2;
1027 if (etd
->send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
1030 fixed_dpi
= param
[1] & 0x10;
1032 if (((etd
->fw_version
>> 16) == 0x14) && fixed_dpi
) {
1033 if (etd
->send_cmd(psmouse
, ETP_SAMPLE_QUERY
, param
))
1036 *x_max
= (etd
->capabilities
[1] - i
) * param
[1] / 2;
1037 *y_max
= (etd
->capabilities
[2] - i
) * param
[2] / 2;
1038 } else if (etd
->fw_version
== 0x040216) {
1041 } else if (etd
->fw_version
== 0x040219 || etd
->fw_version
== 0x040215) {
1045 *x_max
= (etd
->capabilities
[1] - i
) * 64;
1046 *y_max
= (etd
->capabilities
[2] - i
) * 64;
1052 if (etd
->send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
1055 *x_max
= (0x0f & param
[0]) << 8 | param
[1];
1056 *y_max
= (0xf0 & param
[0]) << 4 | param
[2];
1060 if (etd
->send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
1063 *x_max
= (0x0f & param
[0]) << 8 | param
[1];
1064 *y_max
= (0xf0 & param
[0]) << 4 | param
[2];
1065 traces
= etd
->capabilities
[1];
1066 if ((traces
< 2) || (traces
> *x_max
))
1069 *width
= *x_max
/ (traces
- 1);
1077 * (value from firmware) * 10 + 790 = dpi
1078 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1080 static unsigned int elantech_convert_res(unsigned int val
)
1082 return (val
* 10 + 790) * 10 / 254;
1085 static int elantech_get_resolution_v4(struct psmouse
*psmouse
,
1086 unsigned int *x_res
,
1087 unsigned int *y_res
)
1089 unsigned char param
[3];
1091 if (elantech_send_cmd(psmouse
, ETP_RESOLUTION_QUERY
, param
))
1094 *x_res
= elantech_convert_res(param
[1] & 0x0f);
1095 *y_res
= elantech_convert_res((param
[1] & 0xf0) >> 4);
1101 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1102 * fw_version for this is based on the following fw_version & caps table:
1104 * Laptop-model: fw_version: caps: buttons:
1105 * Acer S3 0x461f00 10, 13, 0e clickpad
1106 * Acer S7-392 0x581f01 50, 17, 0d clickpad
1107 * Acer V5-131 0x461f02 01, 16, 0c clickpad
1108 * Acer V5-551 0x461f00 ? clickpad
1109 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
1110 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
1111 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
1112 * Asus TP500LN 0x381f17 10, 14, 0e clickpad
1113 * Asus X750JN 0x381f17 10, 14, 0e clickpad
1114 * Asus UX31 0x361f00 20, 15, 0e clickpad
1115 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
1116 * Avatar AVIU-145A2 0x361f00 ? clickpad
1117 * Fujitsu LIFEBOOK E544 0x470f00 d0, 12, 09 2 hw buttons
1118 * Fujitsu LIFEBOOK E554 0x570f01 40, 14, 0c 2 hw buttons
1119 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
1120 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
1121 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
1122 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
1123 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
1124 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
1125 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
1126 * Samsung NP900X3E-A02 0x575f03 ? clickpad
1127 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
1128 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
1129 * Samsung RF710 0x450f00 ? 2 hw buttons
1130 * System76 Pangolin 0x250f01 ? 2 hw buttons
1131 * (*) + 3 trackpoint buttons
1132 * (**) + 0 trackpoint buttons
1133 * Note: Lenovo L430 and Lenovo L430 have the same fw_version/caps
1135 static void elantech_set_buttonpad_prop(struct psmouse
*psmouse
)
1137 struct input_dev
*dev
= psmouse
->dev
;
1138 struct elantech_data
*etd
= psmouse
->private;
1140 if (etd
->fw_version
& 0x001000) {
1141 __set_bit(INPUT_PROP_BUTTONPAD
, dev
->propbit
);
1142 __clear_bit(BTN_RIGHT
, dev
->keybit
);
1147 * Some hw_version 4 models do have a middle button
1149 static const struct dmi_system_id elantech_dmi_has_middle_button
[] = {
1150 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1152 /* Fujitsu H730 has a middle button */
1154 DMI_MATCH(DMI_SYS_VENDOR
, "FUJITSU"),
1155 DMI_MATCH(DMI_PRODUCT_NAME
, "CELSIUS H730"),
1163 * Set the appropriate event bits for the input subsystem
1165 static int elantech_set_input_params(struct psmouse
*psmouse
)
1167 struct input_dev
*dev
= psmouse
->dev
;
1168 struct elantech_data
*etd
= psmouse
->private;
1169 unsigned int x_min
= 0, y_min
= 0, x_max
= 0, y_max
= 0, width
= 0;
1170 unsigned int x_res
= 0, y_res
= 0;
1172 if (elantech_set_range(psmouse
, &x_min
, &y_min
, &x_max
, &y_max
, &width
))
1175 __set_bit(INPUT_PROP_POINTER
, dev
->propbit
);
1176 __set_bit(EV_KEY
, dev
->evbit
);
1177 __set_bit(EV_ABS
, dev
->evbit
);
1178 __clear_bit(EV_REL
, dev
->evbit
);
1180 __set_bit(BTN_LEFT
, dev
->keybit
);
1181 if (dmi_check_system(elantech_dmi_has_middle_button
))
1182 __set_bit(BTN_MIDDLE
, dev
->keybit
);
1183 __set_bit(BTN_RIGHT
, dev
->keybit
);
1185 __set_bit(BTN_TOUCH
, dev
->keybit
);
1186 __set_bit(BTN_TOOL_FINGER
, dev
->keybit
);
1187 __set_bit(BTN_TOOL_DOUBLETAP
, dev
->keybit
);
1188 __set_bit(BTN_TOOL_TRIPLETAP
, dev
->keybit
);
1190 switch (etd
->hw_version
) {
1193 if (etd
->fw_version
< 0x020000 &&
1194 (etd
->capabilities
[0] & ETP_CAP_HAS_ROCKER
)) {
1195 __set_bit(BTN_FORWARD
, dev
->keybit
);
1196 __set_bit(BTN_BACK
, dev
->keybit
);
1198 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
1199 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
1203 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
1204 __set_bit(INPUT_PROP_SEMI_MT
, dev
->propbit
);
1207 if (etd
->hw_version
== 3)
1208 elantech_set_buttonpad_prop(psmouse
);
1209 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
1210 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
1211 if (etd
->reports_pressure
) {
1212 input_set_abs_params(dev
, ABS_PRESSURE
, ETP_PMIN_V2
,
1214 input_set_abs_params(dev
, ABS_TOOL_WIDTH
, ETP_WMIN_V2
,
1217 input_mt_init_slots(dev
, 2, 0);
1218 input_set_abs_params(dev
, ABS_MT_POSITION_X
, x_min
, x_max
, 0, 0);
1219 input_set_abs_params(dev
, ABS_MT_POSITION_Y
, y_min
, y_max
, 0, 0);
1223 if (elantech_get_resolution_v4(psmouse
, &x_res
, &y_res
)) {
1225 * if query failed, print a warning and leave the values
1226 * zero to resemble synaptics.c behavior.
1228 psmouse_warn(psmouse
, "couldn't query resolution data.\n");
1230 elantech_set_buttonpad_prop(psmouse
);
1231 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
1232 /* For X to recognize me as touchpad. */
1233 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
1234 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
1235 input_abs_set_res(dev
, ABS_X
, x_res
);
1236 input_abs_set_res(dev
, ABS_Y
, y_res
);
1238 * range of pressure and width is the same as v2,
1239 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1241 input_set_abs_params(dev
, ABS_PRESSURE
, ETP_PMIN_V2
,
1243 input_set_abs_params(dev
, ABS_TOOL_WIDTH
, ETP_WMIN_V2
,
1245 /* Multitouch capable pad, up to 5 fingers. */
1246 input_mt_init_slots(dev
, ETP_MAX_FINGERS
, 0);
1247 input_set_abs_params(dev
, ABS_MT_POSITION_X
, x_min
, x_max
, 0, 0);
1248 input_set_abs_params(dev
, ABS_MT_POSITION_Y
, y_min
, y_max
, 0, 0);
1249 input_abs_set_res(dev
, ABS_MT_POSITION_X
, x_res
);
1250 input_abs_set_res(dev
, ABS_MT_POSITION_Y
, y_res
);
1251 input_set_abs_params(dev
, ABS_MT_PRESSURE
, ETP_PMIN_V2
,
1254 * The firmware reports how many trace lines the finger spans,
1255 * convert to surface unit as Protocol-B requires.
1257 input_set_abs_params(dev
, ABS_MT_TOUCH_MAJOR
, 0,
1258 ETP_WMAX_V2
* width
, 0, 0);
1268 struct elantech_attr_data
{
1269 size_t field_offset
;
1274 * Display a register value by reading a sysfs entry
1276 static ssize_t
elantech_show_int_attr(struct psmouse
*psmouse
, void *data
,
1279 struct elantech_data
*etd
= psmouse
->private;
1280 struct elantech_attr_data
*attr
= data
;
1281 unsigned char *reg
= (unsigned char *) etd
+ attr
->field_offset
;
1285 rc
= elantech_read_reg(psmouse
, attr
->reg
, reg
);
1287 return sprintf(buf
, "0x%02x\n", (attr
->reg
&& rc
) ? -1 : *reg
);
1291 * Write a register value by writing a sysfs entry
1293 static ssize_t
elantech_set_int_attr(struct psmouse
*psmouse
,
1294 void *data
, const char *buf
, size_t count
)
1296 struct elantech_data
*etd
= psmouse
->private;
1297 struct elantech_attr_data
*attr
= data
;
1298 unsigned char *reg
= (unsigned char *) etd
+ attr
->field_offset
;
1299 unsigned char value
;
1302 err
= kstrtou8(buf
, 16, &value
);
1306 /* Do we need to preserve some bits for version 2 hardware too? */
1307 if (etd
->hw_version
== 1) {
1308 if (attr
->reg
== 0x10)
1309 /* Force absolute mode always on */
1310 value
|= ETP_R10_ABSOLUTE_MODE
;
1311 else if (attr
->reg
== 0x11)
1312 /* Force 4 byte mode always on */
1313 value
|= ETP_R11_4_BYTE_MODE
;
1316 if (!attr
->reg
|| elantech_write_reg(psmouse
, attr
->reg
, value
) == 0)
1322 #define ELANTECH_INT_ATTR(_name, _register) \
1323 static struct elantech_attr_data elantech_attr_##_name = { \
1324 .field_offset = offsetof(struct elantech_data, _name), \
1327 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1328 &elantech_attr_##_name, \
1329 elantech_show_int_attr, \
1330 elantech_set_int_attr)
1332 ELANTECH_INT_ATTR(reg_07
, 0x07);
1333 ELANTECH_INT_ATTR(reg_10
, 0x10);
1334 ELANTECH_INT_ATTR(reg_11
, 0x11);
1335 ELANTECH_INT_ATTR(reg_20
, 0x20);
1336 ELANTECH_INT_ATTR(reg_21
, 0x21);
1337 ELANTECH_INT_ATTR(reg_22
, 0x22);
1338 ELANTECH_INT_ATTR(reg_23
, 0x23);
1339 ELANTECH_INT_ATTR(reg_24
, 0x24);
1340 ELANTECH_INT_ATTR(reg_25
, 0x25);
1341 ELANTECH_INT_ATTR(reg_26
, 0x26);
1342 ELANTECH_INT_ATTR(debug
, 0);
1343 ELANTECH_INT_ATTR(paritycheck
, 0);
1344 ELANTECH_INT_ATTR(crc_enabled
, 0);
1346 static struct attribute
*elantech_attrs
[] = {
1347 &psmouse_attr_reg_07
.dattr
.attr
,
1348 &psmouse_attr_reg_10
.dattr
.attr
,
1349 &psmouse_attr_reg_11
.dattr
.attr
,
1350 &psmouse_attr_reg_20
.dattr
.attr
,
1351 &psmouse_attr_reg_21
.dattr
.attr
,
1352 &psmouse_attr_reg_22
.dattr
.attr
,
1353 &psmouse_attr_reg_23
.dattr
.attr
,
1354 &psmouse_attr_reg_24
.dattr
.attr
,
1355 &psmouse_attr_reg_25
.dattr
.attr
,
1356 &psmouse_attr_reg_26
.dattr
.attr
,
1357 &psmouse_attr_debug
.dattr
.attr
,
1358 &psmouse_attr_paritycheck
.dattr
.attr
,
1359 &psmouse_attr_crc_enabled
.dattr
.attr
,
1363 static struct attribute_group elantech_attr_group
= {
1364 .attrs
= elantech_attrs
,
1367 static bool elantech_is_signature_valid(const unsigned char *param
)
1369 static const unsigned char rates
[] = { 200, 100, 80, 60, 40, 20, 10 };
1379 * Some hw_version >= 4 models have a revision higher then 20. Meaning
1380 * that param[2] may be 10 or 20, skip the rates check for these.
1382 if ((param
[0] & 0x0f) >= 0x06 && (param
[1] & 0xaf) == 0x0f &&
1386 for (i
= 0; i
< ARRAY_SIZE(rates
); i
++)
1387 if (param
[2] == rates
[i
])
1394 * Use magic knock to detect Elantech touchpad
1396 int elantech_detect(struct psmouse
*psmouse
, bool set_properties
)
1398 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
1399 unsigned char param
[3];
1401 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
);
1403 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
1404 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1405 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1406 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1407 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
)) {
1408 psmouse_dbg(psmouse
, "sending Elantech magic knock failed.\n");
1413 * Report this in case there are Elantech models that use a different
1414 * set of magic numbers
1416 if (param
[0] != 0x3c || param
[1] != 0x03 ||
1417 (param
[2] != 0xc8 && param
[2] != 0x00)) {
1418 psmouse_dbg(psmouse
,
1419 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1420 param
[0], param
[1], param
[2]);
1425 * Query touchpad's firmware version and see if it reports known
1426 * value to avoid mis-detection. Logitech mice are known to respond
1427 * to Elantech magic knock and there might be more.
1429 if (synaptics_send_cmd(psmouse
, ETP_FW_VERSION_QUERY
, param
)) {
1430 psmouse_dbg(psmouse
, "failed to query firmware version.\n");
1434 psmouse_dbg(psmouse
,
1435 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1436 param
[0], param
[1], param
[2]);
1438 if (!elantech_is_signature_valid(param
)) {
1439 psmouse_dbg(psmouse
,
1440 "Probably not a real Elantech touchpad. Aborting.\n");
1444 if (set_properties
) {
1445 psmouse
->vendor
= "Elantech";
1446 psmouse
->name
= "Touchpad";
1453 * Clean up sysfs entries when disconnecting
1455 static void elantech_disconnect(struct psmouse
*psmouse
)
1457 struct elantech_data
*etd
= psmouse
->private;
1460 input_unregister_device(etd
->tp_dev
);
1461 sysfs_remove_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1462 &elantech_attr_group
);
1463 kfree(psmouse
->private);
1464 psmouse
->private = NULL
;
1468 * Put the touchpad back into absolute mode when reconnecting
1470 static int elantech_reconnect(struct psmouse
*psmouse
)
1472 psmouse_reset(psmouse
);
1474 if (elantech_detect(psmouse
, 0))
1477 if (elantech_set_absolute_mode(psmouse
)) {
1478 psmouse_err(psmouse
,
1479 "failed to put touchpad back into absolute mode.\n");
1487 * Some hw_version 4 models do not work with crc_disabled
1489 static const struct dmi_system_id elantech_dmi_force_crc_enabled
[] = {
1490 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1492 /* Fujitsu H730 does not work with crc_enabled == 0 */
1494 DMI_MATCH(DMI_SYS_VENDOR
, "FUJITSU"),
1495 DMI_MATCH(DMI_PRODUCT_NAME
, "CELSIUS H730"),
1499 /* Fujitsu LIFEBOOK E554 does not work with crc_enabled == 0 */
1501 DMI_MATCH(DMI_SYS_VENDOR
, "FUJITSU"),
1502 DMI_MATCH(DMI_PRODUCT_NAME
, "LIFEBOOK E554"),
1506 /* Fujitsu LIFEBOOK E544 does not work with crc_enabled == 0 */
1508 DMI_MATCH(DMI_SYS_VENDOR
, "FUJITSU"),
1509 DMI_MATCH(DMI_PRODUCT_NAME
, "LIFEBOOK E544"),
1517 * Some hw_version 3 models go into error state when we try to set
1518 * bit 3 and/or bit 1 of r10.
1520 static const struct dmi_system_id no_hw_res_dmi_table
[] = {
1521 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1523 /* Gigabyte U2442 */
1525 DMI_MATCH(DMI_SYS_VENDOR
, "GIGABYTE"),
1526 DMI_MATCH(DMI_PRODUCT_NAME
, "U2442"),
1534 * determine hardware version and set some properties according to it.
1536 static int elantech_set_properties(struct elantech_data
*etd
)
1538 /* This represents the version of IC body. */
1539 int ver
= (etd
->fw_version
& 0x0f0000) >> 16;
1541 /* Early version of Elan touchpads doesn't obey the rule. */
1542 if (etd
->fw_version
< 0x020030 || etd
->fw_version
== 0x020600)
1543 etd
->hw_version
= 1;
1548 etd
->hw_version
= 2;
1551 etd
->hw_version
= 3;
1560 etd
->hw_version
= 4;
1567 /* decide which send_cmd we're gonna use early */
1568 etd
->send_cmd
= etd
->hw_version
>= 3 ? elantech_send_cmd
:
1571 /* Turn on packet checking by default */
1572 etd
->paritycheck
= 1;
1575 * This firmware suffers from misreporting coordinates when
1576 * a touch action starts causing the mouse cursor or scrolled page
1577 * to jump. Enable a workaround.
1580 (etd
->fw_version
== 0x020022 || etd
->fw_version
== 0x020600);
1582 if (etd
->hw_version
> 1) {
1583 /* For now show extra debug information */
1586 if (etd
->fw_version
>= 0x020800)
1587 etd
->reports_pressure
= true;
1591 * The signatures of v3 and v4 packets change depending on the
1592 * value of this hardware flag.
1594 etd
->crc_enabled
= (etd
->fw_version
& 0x4000) == 0x4000 ||
1595 dmi_check_system(elantech_dmi_force_crc_enabled
);
1597 /* Enable real hardware resolution on hw_version 3 ? */
1598 etd
->set_hw_resolution
= !dmi_check_system(no_hw_res_dmi_table
);
1604 * Initialize the touchpad and create sysfs entries
1606 int elantech_init(struct psmouse
*psmouse
)
1608 struct elantech_data
*etd
;
1610 int error
= -EINVAL
;
1611 unsigned char param
[3];
1612 struct input_dev
*tp_dev
;
1614 psmouse
->private = etd
= kzalloc(sizeof(struct elantech_data
), GFP_KERNEL
);
1618 psmouse_reset(psmouse
);
1621 for (i
= 1; i
< 256; i
++)
1622 etd
->parity
[i
] = etd
->parity
[i
& (i
- 1)] ^ 1;
1625 * Do the version query again so we can store the result
1627 if (synaptics_send_cmd(psmouse
, ETP_FW_VERSION_QUERY
, param
)) {
1628 psmouse_err(psmouse
, "failed to query firmware version.\n");
1631 etd
->fw_version
= (param
[0] << 16) | (param
[1] << 8) | param
[2];
1633 if (elantech_set_properties(etd
)) {
1634 psmouse_err(psmouse
, "unknown hardware version, aborting...\n");
1637 psmouse_info(psmouse
,
1638 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1639 etd
->hw_version
, param
[0], param
[1], param
[2]);
1641 if (etd
->send_cmd(psmouse
, ETP_CAPABILITIES_QUERY
,
1642 etd
->capabilities
)) {
1643 psmouse_err(psmouse
, "failed to query capabilities.\n");
1646 psmouse_info(psmouse
,
1647 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1648 etd
->capabilities
[0], etd
->capabilities
[1],
1649 etd
->capabilities
[2]);
1651 if (elantech_set_absolute_mode(psmouse
)) {
1652 psmouse_err(psmouse
,
1653 "failed to put touchpad into absolute mode.\n");
1657 if (etd
->fw_version
== 0x381f17) {
1658 etd
->original_set_rate
= psmouse
->set_rate
;
1659 psmouse
->set_rate
= elantech_set_rate_restore_reg_07
;
1662 if (elantech_set_input_params(psmouse
)) {
1663 psmouse_err(psmouse
, "failed to query touchpad range.\n");
1667 error
= sysfs_create_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1668 &elantech_attr_group
);
1670 psmouse_err(psmouse
,
1671 "failed to create sysfs attributes, error: %d.\n",
1676 /* The MSB indicates the presence of the trackpoint */
1677 if ((etd
->capabilities
[0] & 0x80) == 0x80) {
1678 tp_dev
= input_allocate_device();
1682 goto init_fail_tp_alloc
;
1685 etd
->tp_dev
= tp_dev
;
1686 snprintf(etd
->tp_phys
, sizeof(etd
->tp_phys
), "%s/input1",
1687 psmouse
->ps2dev
.serio
->phys
);
1688 tp_dev
->phys
= etd
->tp_phys
;
1689 tp_dev
->name
= "Elantech PS/2 TrackPoint";
1690 tp_dev
->id
.bustype
= BUS_I8042
;
1691 tp_dev
->id
.vendor
= 0x0002;
1692 tp_dev
->id
.product
= PSMOUSE_ELANTECH
;
1693 tp_dev
->id
.version
= 0x0000;
1694 tp_dev
->dev
.parent
= &psmouse
->ps2dev
.serio
->dev
;
1695 tp_dev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REL
);
1696 tp_dev
->relbit
[BIT_WORD(REL_X
)] =
1697 BIT_MASK(REL_X
) | BIT_MASK(REL_Y
);
1698 tp_dev
->keybit
[BIT_WORD(BTN_LEFT
)] =
1699 BIT_MASK(BTN_LEFT
) | BIT_MASK(BTN_MIDDLE
) |
1700 BIT_MASK(BTN_RIGHT
);
1702 __set_bit(INPUT_PROP_POINTER
, tp_dev
->propbit
);
1703 __set_bit(INPUT_PROP_POINTING_STICK
, tp_dev
->propbit
);
1705 error
= input_register_device(etd
->tp_dev
);
1707 goto init_fail_tp_reg
;
1710 psmouse
->protocol_handler
= elantech_process_byte
;
1711 psmouse
->disconnect
= elantech_disconnect
;
1712 psmouse
->reconnect
= elantech_reconnect
;
1713 psmouse
->pktsize
= etd
->hw_version
> 1 ? 6 : 4;
1717 input_free_device(tp_dev
);
1719 sysfs_remove_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1720 &elantech_attr_group
);
1722 psmouse_reset(psmouse
);