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/slab.h>
15 #include <linux/module.h>
16 #include <linux/input.h>
17 #include <linux/input/mt.h>
18 #include <linux/serio.h>
19 #include <linux/libps2.h>
23 #define elantech_debug(fmt, ...) \
26 psmouse_printk(KERN_DEBUG, psmouse, \
27 fmt, ##__VA_ARGS__); \
31 * Send a Synaptics style sliced query command
33 static int synaptics_send_cmd(struct psmouse
*psmouse
, unsigned char c
,
36 if (psmouse_sliced_command(psmouse
, c
) ||
37 ps2_command(&psmouse
->ps2dev
, param
, PSMOUSE_CMD_GETINFO
)) {
38 psmouse_err(psmouse
, "%s query 0x%02x failed.\n", __func__
, c
);
46 * A retrying version of ps2_command
48 static int elantech_ps2_command(struct psmouse
*psmouse
,
49 unsigned char *param
, int command
)
51 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
52 struct elantech_data
*etd
= psmouse
->private;
54 int tries
= ETP_PS2_COMMAND_TRIES
;
57 rc
= ps2_command(ps2dev
, param
, command
);
61 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
63 msleep(ETP_PS2_COMMAND_DELAY
);
67 psmouse_err(psmouse
, "ps2 command 0x%02x failed.\n", command
);
73 * Send an Elantech style special command to read a value from a register
75 static int elantech_read_reg(struct psmouse
*psmouse
, unsigned char reg
,
78 struct elantech_data
*etd
= psmouse
->private;
79 unsigned char param
[3];
82 if (reg
< 0x07 || reg
> 0x26)
85 if (reg
> 0x11 && reg
< 0x20)
88 switch (etd
->hw_version
) {
90 if (psmouse_sliced_command(psmouse
, ETP_REGISTER_READ
) ||
91 psmouse_sliced_command(psmouse
, reg
) ||
92 ps2_command(&psmouse
->ps2dev
, param
, PSMOUSE_CMD_GETINFO
)) {
98 if (elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
99 elantech_ps2_command(psmouse
, NULL
, ETP_REGISTER_READ
) ||
100 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
101 elantech_ps2_command(psmouse
, NULL
, reg
) ||
102 elantech_ps2_command(psmouse
, param
, PSMOUSE_CMD_GETINFO
)) {
108 if (elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
109 elantech_ps2_command(psmouse
, NULL
, ETP_REGISTER_READWRITE
) ||
110 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
111 elantech_ps2_command(psmouse
, NULL
, reg
) ||
112 elantech_ps2_command(psmouse
, param
, PSMOUSE_CMD_GETINFO
)) {
119 psmouse_err(psmouse
, "failed to read register 0x%02x.\n", reg
);
120 else if (etd
->hw_version
!= 4)
129 * Send an Elantech style special command to write a register with a value
131 static int elantech_write_reg(struct psmouse
*psmouse
, unsigned char reg
,
134 struct elantech_data
*etd
= psmouse
->private;
137 if (reg
< 0x07 || reg
> 0x26)
140 if (reg
> 0x11 && reg
< 0x20)
143 switch (etd
->hw_version
) {
145 if (psmouse_sliced_command(psmouse
, ETP_REGISTER_WRITE
) ||
146 psmouse_sliced_command(psmouse
, reg
) ||
147 psmouse_sliced_command(psmouse
, val
) ||
148 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
)) {
154 if (elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
155 elantech_ps2_command(psmouse
, NULL
, ETP_REGISTER_WRITE
) ||
156 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
157 elantech_ps2_command(psmouse
, NULL
, reg
) ||
158 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
159 elantech_ps2_command(psmouse
, NULL
, val
) ||
160 elantech_ps2_command(psmouse
, NULL
, PSMOUSE_CMD_SETSCALE11
)) {
166 if (elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
167 elantech_ps2_command(psmouse
, NULL
, ETP_REGISTER_READWRITE
) ||
168 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
169 elantech_ps2_command(psmouse
, NULL
, reg
) ||
170 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
171 elantech_ps2_command(psmouse
, NULL
, val
) ||
172 elantech_ps2_command(psmouse
, NULL
, PSMOUSE_CMD_SETSCALE11
)) {
178 if (elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
179 elantech_ps2_command(psmouse
, NULL
, ETP_REGISTER_READWRITE
) ||
180 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
181 elantech_ps2_command(psmouse
, NULL
, reg
) ||
182 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
183 elantech_ps2_command(psmouse
, NULL
, ETP_REGISTER_READWRITE
) ||
184 elantech_ps2_command(psmouse
, NULL
, ETP_PS2_CUSTOM_COMMAND
) ||
185 elantech_ps2_command(psmouse
, NULL
, val
) ||
186 elantech_ps2_command(psmouse
, NULL
, PSMOUSE_CMD_SETSCALE11
)) {
194 "failed to write register 0x%02x with value 0x%02x.\n",
201 * Dump a complete mouse movement packet to the syslog
203 static void elantech_packet_dump(struct psmouse
*psmouse
)
207 psmouse_printk(KERN_DEBUG
, psmouse
, "PS/2 packet [");
208 for (i
= 0; i
< psmouse
->pktsize
; i
++)
209 printk("%s0x%02x ", i
? ", " : " ", psmouse
->packet
[i
]);
214 * Interpret complete data packets and report absolute mode input events for
215 * hardware version 1. (4 byte packets)
217 static void elantech_report_absolute_v1(struct psmouse
*psmouse
)
219 struct input_dev
*dev
= psmouse
->dev
;
220 struct elantech_data
*etd
= psmouse
->private;
221 unsigned char *packet
= psmouse
->packet
;
224 if (etd
->fw_version
< 0x020000) {
226 * byte 0: D U p1 p2 1 p3 R L
227 * byte 1: f 0 th tw x9 x8 y9 y8
229 fingers
= ((packet
[1] & 0x80) >> 7) +
230 ((packet
[1] & 0x30) >> 4);
233 * byte 0: n1 n0 p2 p1 1 p3 R L
234 * byte 1: 0 0 0 0 x9 x8 y9 y8
236 fingers
= (packet
[0] & 0xc0) >> 6;
239 if (etd
->jumpy_cursor
) {
241 etd
->single_finger_reports
= 0;
242 } else if (etd
->single_finger_reports
< 2) {
243 /* Discard first 2 reports of one finger, bogus */
244 etd
->single_finger_reports
++;
245 elantech_debug("discarding packet\n");
250 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
253 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
254 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
257 input_report_abs(dev
, ABS_X
,
258 ((packet
[1] & 0x0c) << 6) | packet
[2]);
259 input_report_abs(dev
, ABS_Y
,
260 etd
->y_max
- (((packet
[1] & 0x03) << 8) | packet
[3]));
263 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
264 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
265 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
266 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
267 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
269 if (etd
->fw_version
< 0x020000 &&
270 (etd
->capabilities
[0] & ETP_CAP_HAS_ROCKER
)) {
272 input_report_key(dev
, BTN_FORWARD
, packet
[0] & 0x40);
274 input_report_key(dev
, BTN_BACK
, packet
[0] & 0x80);
280 static void elantech_set_slot(struct input_dev
*dev
, int slot
, bool active
,
281 unsigned int x
, unsigned int y
)
283 input_mt_slot(dev
, slot
);
284 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, active
);
286 input_report_abs(dev
, ABS_MT_POSITION_X
, x
);
287 input_report_abs(dev
, ABS_MT_POSITION_Y
, y
);
291 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
292 static void elantech_report_semi_mt_data(struct input_dev
*dev
,
293 unsigned int num_fingers
,
294 unsigned int x1
, unsigned int y1
,
295 unsigned int x2
, unsigned int y2
)
297 elantech_set_slot(dev
, 0, num_fingers
!= 0, x1
, y1
);
298 elantech_set_slot(dev
, 1, num_fingers
== 2, x2
, y2
);
302 * Interpret complete data packets and report absolute mode input events for
303 * hardware version 2. (6 byte packets)
305 static void elantech_report_absolute_v2(struct psmouse
*psmouse
)
307 struct elantech_data
*etd
= psmouse
->private;
308 struct input_dev
*dev
= psmouse
->dev
;
309 unsigned char *packet
= psmouse
->packet
;
310 unsigned int fingers
, x1
= 0, y1
= 0, x2
= 0, y2
= 0;
311 unsigned int width
= 0, pres
= 0;
313 /* byte 0: n1 n0 . . . . R L */
314 fingers
= (packet
[0] & 0xc0) >> 6;
319 * Same as one finger, except report of more than 3 fingers:
320 * byte 3: n4 . w1 w0 . . . .
322 if (packet
[3] & 0x80)
324 /* pass through... */
327 * byte 1: . . . . x11 x10 x9 x8
328 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
330 x1
= ((packet
[1] & 0x0f) << 8) | packet
[2];
332 * byte 4: . . . . y11 y10 y9 y8
333 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
335 y1
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
337 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
338 width
= ((packet
[0] & 0x30) >> 2) | ((packet
[3] & 0x30) >> 4);
343 * The coordinate of each finger is reported separately
344 * with a lower resolution for two finger touches:
345 * byte 0: . . ay8 ax8 . . . .
346 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
348 x1
= (((packet
[0] & 0x10) << 4) | packet
[1]) << 2;
349 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
351 ((((packet
[0] & 0x20) << 3) | packet
[2]) << 2);
353 * byte 3: . . by8 bx8 . . . .
354 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
356 x2
= (((packet
[3] & 0x10) << 4) | packet
[4]) << 2;
357 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
359 ((((packet
[3] & 0x20) << 3) | packet
[5]) << 2);
361 /* Unknown so just report sensible values */
367 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
369 input_report_abs(dev
, ABS_X
, x1
);
370 input_report_abs(dev
, ABS_Y
, y1
);
372 elantech_report_semi_mt_data(dev
, fingers
, x1
, y1
, x2
, y2
);
373 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
374 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
375 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
376 input_report_key(dev
, BTN_TOOL_QUADTAP
, fingers
== 4);
377 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
378 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
379 if (etd
->reports_pressure
) {
380 input_report_abs(dev
, ABS_PRESSURE
, pres
);
381 input_report_abs(dev
, ABS_TOOL_WIDTH
, width
);
388 * Interpret complete data packets and report absolute mode input events for
389 * hardware version 3. (12 byte packets for two fingers)
391 static void elantech_report_absolute_v3(struct psmouse
*psmouse
,
394 struct input_dev
*dev
= psmouse
->dev
;
395 struct elantech_data
*etd
= psmouse
->private;
396 unsigned char *packet
= psmouse
->packet
;
397 unsigned int fingers
= 0, x1
= 0, y1
= 0, x2
= 0, y2
= 0;
398 unsigned int width
= 0, pres
= 0;
400 /* byte 0: n1 n0 . . . . R L */
401 fingers
= (packet
[0] & 0xc0) >> 6;
407 * byte 1: . . . . x11 x10 x9 x8
408 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
410 x1
= ((packet
[1] & 0x0f) << 8) | packet
[2];
412 * byte 4: . . . . y11 y10 y9 y8
413 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
415 y1
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
419 if (packet_type
== PACKET_V3_HEAD
) {
421 * byte 1: . . . . ax11 ax10 ax9 ax8
422 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
424 etd
->mt
[0].x
= ((packet
[1] & 0x0f) << 8) | packet
[2];
426 * byte 4: . . . . ay11 ay10 ay9 ay8
427 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
429 etd
->mt
[0].y
= etd
->y_max
-
430 (((packet
[4] & 0x0f) << 8) | packet
[5]);
432 * wait for next packet
437 /* packet_type == PACKET_V3_TAIL */
440 x2
= ((packet
[1] & 0x0f) << 8) | packet
[2];
441 y2
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
445 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
446 width
= ((packet
[0] & 0x30) >> 2) | ((packet
[3] & 0x30) >> 4);
448 input_report_key(dev
, BTN_TOUCH
, fingers
!= 0);
450 input_report_abs(dev
, ABS_X
, x1
);
451 input_report_abs(dev
, ABS_Y
, y1
);
453 elantech_report_semi_mt_data(dev
, fingers
, x1
, y1
, x2
, y2
);
454 input_report_key(dev
, BTN_TOOL_FINGER
, fingers
== 1);
455 input_report_key(dev
, BTN_TOOL_DOUBLETAP
, fingers
== 2);
456 input_report_key(dev
, BTN_TOOL_TRIPLETAP
, fingers
== 3);
457 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
458 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
459 input_report_abs(dev
, ABS_PRESSURE
, pres
);
460 input_report_abs(dev
, ABS_TOOL_WIDTH
, width
);
465 static void elantech_input_sync_v4(struct psmouse
*psmouse
)
467 struct input_dev
*dev
= psmouse
->dev
;
468 unsigned char *packet
= psmouse
->packet
;
470 input_report_key(dev
, BTN_LEFT
, packet
[0] & 0x01);
471 input_report_key(dev
, BTN_RIGHT
, packet
[0] & 0x02);
472 input_mt_report_pointer_emulation(dev
, true);
476 static void process_packet_status_v4(struct psmouse
*psmouse
)
478 struct input_dev
*dev
= psmouse
->dev
;
479 unsigned char *packet
= psmouse
->packet
;
483 /* notify finger state change */
484 fingers
= packet
[1] & 0x1f;
485 for (i
= 0; i
< ETP_MAX_FINGERS
; i
++) {
486 if ((fingers
& (1 << i
)) == 0) {
487 input_mt_slot(dev
, i
);
488 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, false);
492 elantech_input_sync_v4(psmouse
);
495 static void process_packet_head_v4(struct psmouse
*psmouse
)
497 struct input_dev
*dev
= psmouse
->dev
;
498 struct elantech_data
*etd
= psmouse
->private;
499 unsigned char *packet
= psmouse
->packet
;
500 int id
= ((packet
[3] & 0xe0) >> 5) - 1;
506 etd
->mt
[id
].x
= ((packet
[1] & 0x0f) << 8) | packet
[2];
507 etd
->mt
[id
].y
= etd
->y_max
- (((packet
[4] & 0x0f) << 8) | packet
[5]);
508 pres
= (packet
[1] & 0xf0) | ((packet
[4] & 0xf0) >> 4);
509 traces
= (packet
[0] & 0xf0) >> 4;
511 input_mt_slot(dev
, id
);
512 input_mt_report_slot_state(dev
, MT_TOOL_FINGER
, true);
514 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[id
].x
);
515 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[id
].y
);
516 input_report_abs(dev
, ABS_MT_PRESSURE
, pres
);
517 input_report_abs(dev
, ABS_MT_TOUCH_MAJOR
, traces
* etd
->width
);
518 /* report this for backwards compatibility */
519 input_report_abs(dev
, ABS_TOOL_WIDTH
, traces
);
521 elantech_input_sync_v4(psmouse
);
524 static void process_packet_motion_v4(struct psmouse
*psmouse
)
526 struct input_dev
*dev
= psmouse
->dev
;
527 struct elantech_data
*etd
= psmouse
->private;
528 unsigned char *packet
= psmouse
->packet
;
529 int weight
, delta_x1
= 0, delta_y1
= 0, delta_x2
= 0, delta_y2
= 0;
532 id
= ((packet
[0] & 0xe0) >> 5) - 1;
536 sid
= ((packet
[3] & 0xe0) >> 5) - 1;
537 weight
= (packet
[0] & 0x10) ? ETP_WEIGHT_VALUE
: 1;
539 * Motion packets give us the delta of x, y values of specific fingers,
540 * but in two's complement. Let the compiler do the conversion for us.
541 * Also _enlarge_ the numbers to int, in case of overflow.
543 delta_x1
= (signed char)packet
[1];
544 delta_y1
= (signed char)packet
[2];
545 delta_x2
= (signed char)packet
[4];
546 delta_y2
= (signed char)packet
[5];
548 etd
->mt
[id
].x
+= delta_x1
* weight
;
549 etd
->mt
[id
].y
-= delta_y1
* weight
;
550 input_mt_slot(dev
, id
);
551 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[id
].x
);
552 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[id
].y
);
555 etd
->mt
[sid
].x
+= delta_x2
* weight
;
556 etd
->mt
[sid
].y
-= delta_y2
* weight
;
557 input_mt_slot(dev
, sid
);
558 input_report_abs(dev
, ABS_MT_POSITION_X
, etd
->mt
[sid
].x
);
559 input_report_abs(dev
, ABS_MT_POSITION_Y
, etd
->mt
[sid
].y
);
562 elantech_input_sync_v4(psmouse
);
565 static void elantech_report_absolute_v4(struct psmouse
*psmouse
,
568 switch (packet_type
) {
569 case PACKET_V4_STATUS
:
570 process_packet_status_v4(psmouse
);
574 process_packet_head_v4(psmouse
);
577 case PACKET_V4_MOTION
:
578 process_packet_motion_v4(psmouse
);
583 /* impossible to get here */
588 static int elantech_packet_check_v1(struct psmouse
*psmouse
)
590 struct elantech_data
*etd
= psmouse
->private;
591 unsigned char *packet
= psmouse
->packet
;
592 unsigned char p1
, p2
, p3
;
594 /* Parity bits are placed differently */
595 if (etd
->fw_version
< 0x020000) {
596 /* byte 0: D U p1 p2 1 p3 R L */
597 p1
= (packet
[0] & 0x20) >> 5;
598 p2
= (packet
[0] & 0x10) >> 4;
600 /* byte 0: n1 n0 p2 p1 1 p3 R L */
601 p1
= (packet
[0] & 0x10) >> 4;
602 p2
= (packet
[0] & 0x20) >> 5;
605 p3
= (packet
[0] & 0x04) >> 2;
607 return etd
->parity
[packet
[1]] == p1
&&
608 etd
->parity
[packet
[2]] == p2
&&
609 etd
->parity
[packet
[3]] == p3
;
612 static int elantech_debounce_check_v2(struct psmouse
*psmouse
)
615 * When we encounter packet that matches this exactly, it means the
616 * hardware is in debounce status. Just ignore the whole packet.
618 const u8 debounce_packet
[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
619 unsigned char *packet
= psmouse
->packet
;
621 return !memcmp(packet
, debounce_packet
, sizeof(debounce_packet
));
624 static int elantech_packet_check_v2(struct psmouse
*psmouse
)
626 struct elantech_data
*etd
= psmouse
->private;
627 unsigned char *packet
= psmouse
->packet
;
630 * V2 hardware has two flavors. Older ones that do not report pressure,
631 * and newer ones that reports pressure and width. With newer ones, all
632 * packets (1, 2, 3 finger touch) have the same constant bits. With
633 * older ones, 1/3 finger touch packets and 2 finger touch packets
634 * have different constant bits.
635 * With all three cases, if the constant bits are not exactly what I
636 * expected, I consider them invalid.
638 if (etd
->reports_pressure
)
639 return (packet
[0] & 0x0c) == 0x04 &&
640 (packet
[3] & 0x0f) == 0x02;
642 if ((packet
[0] & 0xc0) == 0x80)
643 return (packet
[0] & 0x0c) == 0x0c &&
644 (packet
[3] & 0x0e) == 0x08;
646 return (packet
[0] & 0x3c) == 0x3c &&
647 (packet
[1] & 0xf0) == 0x00 &&
648 (packet
[3] & 0x3e) == 0x38 &&
649 (packet
[4] & 0xf0) == 0x00;
653 * We check the constant bits to determine what packet type we get,
654 * so packet checking is mandatory for v3 and later hardware.
656 static int elantech_packet_check_v3(struct psmouse
*psmouse
)
658 const u8 debounce_packet
[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
659 unsigned char *packet
= psmouse
->packet
;
662 * check debounce first, it has the same signature in byte 0
663 * and byte 3 as PACKET_V3_HEAD.
665 if (!memcmp(packet
, debounce_packet
, sizeof(debounce_packet
)))
666 return PACKET_DEBOUNCE
;
668 if ((packet
[0] & 0x0c) == 0x04 && (packet
[3] & 0xcf) == 0x02)
669 return PACKET_V3_HEAD
;
671 if ((packet
[0] & 0x0c) == 0x0c && (packet
[3] & 0xce) == 0x0c)
672 return PACKET_V3_TAIL
;
674 return PACKET_UNKNOWN
;
677 static int elantech_packet_check_v4(struct psmouse
*psmouse
)
679 unsigned char *packet
= psmouse
->packet
;
681 if ((packet
[0] & 0x0c) == 0x04 &&
682 (packet
[3] & 0x1f) == 0x11)
683 return PACKET_V4_HEAD
;
685 if ((packet
[0] & 0x0c) == 0x04 &&
686 (packet
[3] & 0x1f) == 0x12)
687 return PACKET_V4_MOTION
;
689 if ((packet
[0] & 0x0c) == 0x04 &&
690 (packet
[3] & 0x1f) == 0x10)
691 return PACKET_V4_STATUS
;
693 return PACKET_UNKNOWN
;
697 * Process byte stream from mouse and handle complete packets
699 static psmouse_ret_t
elantech_process_byte(struct psmouse
*psmouse
)
701 struct elantech_data
*etd
= psmouse
->private;
704 if (psmouse
->pktcnt
< psmouse
->pktsize
)
705 return PSMOUSE_GOOD_DATA
;
708 elantech_packet_dump(psmouse
);
710 switch (etd
->hw_version
) {
712 if (etd
->paritycheck
&& !elantech_packet_check_v1(psmouse
))
713 return PSMOUSE_BAD_DATA
;
715 elantech_report_absolute_v1(psmouse
);
719 /* ignore debounce */
720 if (elantech_debounce_check_v2(psmouse
))
721 return PSMOUSE_FULL_PACKET
;
723 if (etd
->paritycheck
&& !elantech_packet_check_v2(psmouse
))
724 return PSMOUSE_BAD_DATA
;
726 elantech_report_absolute_v2(psmouse
);
730 packet_type
= elantech_packet_check_v3(psmouse
);
731 /* ignore debounce */
732 if (packet_type
== PACKET_DEBOUNCE
)
733 return PSMOUSE_FULL_PACKET
;
735 if (packet_type
== PACKET_UNKNOWN
)
736 return PSMOUSE_BAD_DATA
;
738 elantech_report_absolute_v3(psmouse
, packet_type
);
742 packet_type
= elantech_packet_check_v4(psmouse
);
743 if (packet_type
== PACKET_UNKNOWN
)
744 return PSMOUSE_BAD_DATA
;
746 elantech_report_absolute_v4(psmouse
, packet_type
);
750 return PSMOUSE_FULL_PACKET
;
754 * Put the touchpad into absolute mode
756 static int elantech_set_absolute_mode(struct psmouse
*psmouse
)
758 struct elantech_data
*etd
= psmouse
->private;
760 int tries
= ETP_READ_BACK_TRIES
;
763 switch (etd
->hw_version
) {
767 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
) ||
768 elantech_write_reg(psmouse
, 0x11, etd
->reg_11
)) {
774 /* Windows driver values */
776 etd
->reg_11
= 0x88; /* 0x8a */
777 etd
->reg_21
= 0x60; /* 0x00 */
778 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
) ||
779 elantech_write_reg(psmouse
, 0x11, etd
->reg_11
) ||
780 elantech_write_reg(psmouse
, 0x21, etd
->reg_21
)) {
787 if (elantech_write_reg(psmouse
, 0x10, etd
->reg_10
))
794 if (elantech_write_reg(psmouse
, 0x07, etd
->reg_07
))
797 goto skip_readback_reg_10
; /* v4 has no reg 0x10 to read */
802 * Read back reg 0x10. For hardware version 1 we must make
803 * sure the absolute mode bit is set. For hardware version 2
804 * the touchpad is probably initializing and not ready until
805 * we read back the value we just wrote.
808 rc
= elantech_read_reg(psmouse
, 0x10, &val
);
812 elantech_debug("retrying read (%d).\n", tries
);
813 msleep(ETP_READ_BACK_DELAY
);
818 "failed to read back register 0x10.\n");
819 } else if (etd
->hw_version
== 1 &&
820 !(val
& ETP_R10_ABSOLUTE_MODE
)) {
822 "touchpad refuses to switch to absolute mode.\n");
827 skip_readback_reg_10
:
829 psmouse_err(psmouse
, "failed to initialise registers.\n");
834 static int elantech_set_range(struct psmouse
*psmouse
,
835 unsigned int *x_min
, unsigned int *y_min
,
836 unsigned int *x_max
, unsigned int *y_max
,
839 struct elantech_data
*etd
= psmouse
->private;
840 unsigned char param
[3];
841 unsigned char traces
;
843 switch (etd
->hw_version
) {
845 *x_min
= ETP_XMIN_V1
;
846 *y_min
= ETP_YMIN_V1
;
847 *x_max
= ETP_XMAX_V1
;
848 *y_max
= ETP_YMAX_V1
;
852 if (etd
->fw_version
== 0x020800 ||
853 etd
->fw_version
== 0x020b00 ||
854 etd
->fw_version
== 0x020030) {
855 *x_min
= ETP_XMIN_V2
;
856 *y_min
= ETP_YMIN_V2
;
857 *x_max
= ETP_XMAX_V2
;
858 *y_max
= ETP_YMAX_V2
;
863 i
= (etd
->fw_version
> 0x020800 &&
864 etd
->fw_version
< 0x020900) ? 1 : 2;
866 if (synaptics_send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
869 fixed_dpi
= param
[1] & 0x10;
871 if (((etd
->fw_version
>> 16) == 0x14) && fixed_dpi
) {
872 if (synaptics_send_cmd(psmouse
, ETP_SAMPLE_QUERY
, param
))
875 *x_max
= (etd
->capabilities
[1] - i
) * param
[1] / 2;
876 *y_max
= (etd
->capabilities
[2] - i
) * param
[2] / 2;
877 } else if (etd
->fw_version
== 0x040216) {
880 } else if (etd
->fw_version
== 0x040219 || etd
->fw_version
== 0x040215) {
884 *x_max
= (etd
->capabilities
[1] - i
) * 64;
885 *y_max
= (etd
->capabilities
[2] - i
) * 64;
891 if (synaptics_send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
894 *x_max
= (0x0f & param
[0]) << 8 | param
[1];
895 *y_max
= (0xf0 & param
[0]) << 4 | param
[2];
899 if (synaptics_send_cmd(psmouse
, ETP_FW_ID_QUERY
, param
))
902 *x_max
= (0x0f & param
[0]) << 8 | param
[1];
903 *y_max
= (0xf0 & param
[0]) << 4 | param
[2];
904 traces
= etd
->capabilities
[1];
905 if ((traces
< 2) || (traces
> *x_max
))
908 *width
= *x_max
/ (traces
- 1);
916 * Set the appropriate event bits for the input subsystem
918 static int elantech_set_input_params(struct psmouse
*psmouse
)
920 struct input_dev
*dev
= psmouse
->dev
;
921 struct elantech_data
*etd
= psmouse
->private;
922 unsigned int x_min
= 0, y_min
= 0, x_max
= 0, y_max
= 0, width
= 0;
924 if (elantech_set_range(psmouse
, &x_min
, &y_min
, &x_max
, &y_max
, &width
))
927 __set_bit(EV_KEY
, dev
->evbit
);
928 __set_bit(EV_ABS
, dev
->evbit
);
929 __clear_bit(EV_REL
, dev
->evbit
);
931 __set_bit(BTN_LEFT
, dev
->keybit
);
932 __set_bit(BTN_RIGHT
, dev
->keybit
);
934 __set_bit(BTN_TOUCH
, dev
->keybit
);
935 __set_bit(BTN_TOOL_FINGER
, dev
->keybit
);
936 __set_bit(BTN_TOOL_DOUBLETAP
, dev
->keybit
);
937 __set_bit(BTN_TOOL_TRIPLETAP
, dev
->keybit
);
939 switch (etd
->hw_version
) {
942 if (etd
->fw_version
< 0x020000 &&
943 (etd
->capabilities
[0] & ETP_CAP_HAS_ROCKER
)) {
944 __set_bit(BTN_FORWARD
, dev
->keybit
);
945 __set_bit(BTN_BACK
, dev
->keybit
);
947 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
948 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
952 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
953 __set_bit(INPUT_PROP_SEMI_MT
, dev
->propbit
);
956 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
957 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
958 if (etd
->reports_pressure
) {
959 input_set_abs_params(dev
, ABS_PRESSURE
, ETP_PMIN_V2
,
961 input_set_abs_params(dev
, ABS_TOOL_WIDTH
, ETP_WMIN_V2
,
964 input_mt_init_slots(dev
, 2);
965 input_set_abs_params(dev
, ABS_MT_POSITION_X
, x_min
, x_max
, 0, 0);
966 input_set_abs_params(dev
, ABS_MT_POSITION_Y
, y_min
, y_max
, 0, 0);
970 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
971 /* For X to recognize me as touchpad. */
972 input_set_abs_params(dev
, ABS_X
, x_min
, x_max
, 0, 0);
973 input_set_abs_params(dev
, ABS_Y
, y_min
, y_max
, 0, 0);
975 * range of pressure and width is the same as v2,
976 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
978 input_set_abs_params(dev
, ABS_PRESSURE
, ETP_PMIN_V2
,
980 input_set_abs_params(dev
, ABS_TOOL_WIDTH
, ETP_WMIN_V2
,
982 /* Multitouch capable pad, up to 5 fingers. */
983 input_mt_init_slots(dev
, ETP_MAX_FINGERS
);
984 input_set_abs_params(dev
, ABS_MT_POSITION_X
, x_min
, x_max
, 0, 0);
985 input_set_abs_params(dev
, ABS_MT_POSITION_Y
, y_min
, y_max
, 0, 0);
986 input_set_abs_params(dev
, ABS_MT_PRESSURE
, ETP_PMIN_V2
,
989 * The firmware reports how many trace lines the finger spans,
990 * convert to surface unit as Protocol-B requires.
992 input_set_abs_params(dev
, ABS_MT_TOUCH_MAJOR
, 0,
993 ETP_WMAX_V2
* width
, 0, 0);
1003 struct elantech_attr_data
{
1004 size_t field_offset
;
1009 * Display a register value by reading a sysfs entry
1011 static ssize_t
elantech_show_int_attr(struct psmouse
*psmouse
, void *data
,
1014 struct elantech_data
*etd
= psmouse
->private;
1015 struct elantech_attr_data
*attr
= data
;
1016 unsigned char *reg
= (unsigned char *) etd
+ attr
->field_offset
;
1020 rc
= elantech_read_reg(psmouse
, attr
->reg
, reg
);
1022 return sprintf(buf
, "0x%02x\n", (attr
->reg
&& rc
) ? -1 : *reg
);
1026 * Write a register value by writing a sysfs entry
1028 static ssize_t
elantech_set_int_attr(struct psmouse
*psmouse
,
1029 void *data
, const char *buf
, size_t count
)
1031 struct elantech_data
*etd
= psmouse
->private;
1032 struct elantech_attr_data
*attr
= data
;
1033 unsigned char *reg
= (unsigned char *) etd
+ attr
->field_offset
;
1034 unsigned long value
;
1037 err
= strict_strtoul(buf
, 16, &value
);
1044 /* Do we need to preserve some bits for version 2 hardware too? */
1045 if (etd
->hw_version
== 1) {
1046 if (attr
->reg
== 0x10)
1047 /* Force absolute mode always on */
1048 value
|= ETP_R10_ABSOLUTE_MODE
;
1049 else if (attr
->reg
== 0x11)
1050 /* Force 4 byte mode always on */
1051 value
|= ETP_R11_4_BYTE_MODE
;
1054 if (!attr
->reg
|| elantech_write_reg(psmouse
, attr
->reg
, value
) == 0)
1060 #define ELANTECH_INT_ATTR(_name, _register) \
1061 static struct elantech_attr_data elantech_attr_##_name = { \
1062 .field_offset = offsetof(struct elantech_data, _name), \
1065 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
1066 &elantech_attr_##_name, \
1067 elantech_show_int_attr, \
1068 elantech_set_int_attr)
1070 ELANTECH_INT_ATTR(reg_07
, 0x07);
1071 ELANTECH_INT_ATTR(reg_10
, 0x10);
1072 ELANTECH_INT_ATTR(reg_11
, 0x11);
1073 ELANTECH_INT_ATTR(reg_20
, 0x20);
1074 ELANTECH_INT_ATTR(reg_21
, 0x21);
1075 ELANTECH_INT_ATTR(reg_22
, 0x22);
1076 ELANTECH_INT_ATTR(reg_23
, 0x23);
1077 ELANTECH_INT_ATTR(reg_24
, 0x24);
1078 ELANTECH_INT_ATTR(reg_25
, 0x25);
1079 ELANTECH_INT_ATTR(reg_26
, 0x26);
1080 ELANTECH_INT_ATTR(debug
, 0);
1081 ELANTECH_INT_ATTR(paritycheck
, 0);
1083 static struct attribute
*elantech_attrs
[] = {
1084 &psmouse_attr_reg_07
.dattr
.attr
,
1085 &psmouse_attr_reg_10
.dattr
.attr
,
1086 &psmouse_attr_reg_11
.dattr
.attr
,
1087 &psmouse_attr_reg_20
.dattr
.attr
,
1088 &psmouse_attr_reg_21
.dattr
.attr
,
1089 &psmouse_attr_reg_22
.dattr
.attr
,
1090 &psmouse_attr_reg_23
.dattr
.attr
,
1091 &psmouse_attr_reg_24
.dattr
.attr
,
1092 &psmouse_attr_reg_25
.dattr
.attr
,
1093 &psmouse_attr_reg_26
.dattr
.attr
,
1094 &psmouse_attr_debug
.dattr
.attr
,
1095 &psmouse_attr_paritycheck
.dattr
.attr
,
1099 static struct attribute_group elantech_attr_group
= {
1100 .attrs
= elantech_attrs
,
1103 static bool elantech_is_signature_valid(const unsigned char *param
)
1105 static const unsigned char rates
[] = { 200, 100, 80, 60, 40, 20, 10 };
1114 for (i
= 0; i
< ARRAY_SIZE(rates
); i
++)
1115 if (param
[2] == rates
[i
])
1122 * Use magic knock to detect Elantech touchpad
1124 int elantech_detect(struct psmouse
*psmouse
, bool set_properties
)
1126 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
1127 unsigned char param
[3];
1129 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
);
1131 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
) ||
1132 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1133 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1134 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
) ||
1135 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
)) {
1136 psmouse_dbg(psmouse
, "sending Elantech magic knock failed.\n");
1141 * Report this in case there are Elantech models that use a different
1142 * set of magic numbers
1144 if (param
[0] != 0x3c || param
[1] != 0x03 ||
1145 (param
[2] != 0xc8 && param
[2] != 0x00)) {
1146 psmouse_dbg(psmouse
,
1147 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1148 param
[0], param
[1], param
[2]);
1153 * Query touchpad's firmware version and see if it reports known
1154 * value to avoid mis-detection. Logitech mice are known to respond
1155 * to Elantech magic knock and there might be more.
1157 if (synaptics_send_cmd(psmouse
, ETP_FW_VERSION_QUERY
, param
)) {
1158 psmouse_dbg(psmouse
, "failed to query firmware version.\n");
1162 psmouse_dbg(psmouse
,
1163 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1164 param
[0], param
[1], param
[2]);
1166 if (!elantech_is_signature_valid(param
)) {
1167 psmouse_dbg(psmouse
,
1168 "Probably not a real Elantech touchpad. Aborting.\n");
1172 if (set_properties
) {
1173 psmouse
->vendor
= "Elantech";
1174 psmouse
->name
= "Touchpad";
1181 * Clean up sysfs entries when disconnecting
1183 static void elantech_disconnect(struct psmouse
*psmouse
)
1185 sysfs_remove_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1186 &elantech_attr_group
);
1187 kfree(psmouse
->private);
1188 psmouse
->private = NULL
;
1192 * Put the touchpad back into absolute mode when reconnecting
1194 static int elantech_reconnect(struct psmouse
*psmouse
)
1196 if (elantech_detect(psmouse
, 0))
1199 if (elantech_set_absolute_mode(psmouse
)) {
1200 psmouse_err(psmouse
,
1201 "failed to put touchpad back into absolute mode.\n");
1209 * determine hardware version and set some properties according to it.
1211 static int elantech_set_properties(struct elantech_data
*etd
)
1213 /* This represents the version of IC body. */
1214 int ver
= (etd
->fw_version
& 0x0f0000) >> 16;
1216 /* Early version of Elan touchpads doesn't obey the rule. */
1217 if (etd
->fw_version
< 0x020030 || etd
->fw_version
== 0x020600)
1218 etd
->hw_version
= 1;
1223 etd
->hw_version
= 2;
1226 etd
->hw_version
= 3;
1229 etd
->hw_version
= 4;
1237 * Turn on packet checking by default.
1239 etd
->paritycheck
= 1;
1242 * This firmware suffers from misreporting coordinates when
1243 * a touch action starts causing the mouse cursor or scrolled page
1244 * to jump. Enable a workaround.
1247 (etd
->fw_version
== 0x020022 || etd
->fw_version
== 0x020600);
1249 if (etd
->hw_version
> 1) {
1250 /* For now show extra debug information */
1253 if (etd
->fw_version
>= 0x020800)
1254 etd
->reports_pressure
= true;
1261 * Initialize the touchpad and create sysfs entries
1263 int elantech_init(struct psmouse
*psmouse
)
1265 struct elantech_data
*etd
;
1267 unsigned char param
[3];
1269 psmouse
->private = etd
= kzalloc(sizeof(struct elantech_data
), GFP_KERNEL
);
1274 for (i
= 1; i
< 256; i
++)
1275 etd
->parity
[i
] = etd
->parity
[i
& (i
- 1)] ^ 1;
1278 * Do the version query again so we can store the result
1280 if (synaptics_send_cmd(psmouse
, ETP_FW_VERSION_QUERY
, param
)) {
1281 psmouse_err(psmouse
, "failed to query firmware version.\n");
1284 etd
->fw_version
= (param
[0] << 16) | (param
[1] << 8) | param
[2];
1286 if (elantech_set_properties(etd
)) {
1287 psmouse_err(psmouse
, "unknown hardware version, aborting...\n");
1290 psmouse_info(psmouse
,
1291 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1292 etd
->hw_version
, param
[0], param
[1], param
[2]);
1294 if (synaptics_send_cmd(psmouse
, ETP_CAPABILITIES_QUERY
,
1295 etd
->capabilities
)) {
1296 psmouse_err(psmouse
, "failed to query capabilities.\n");
1299 psmouse_info(psmouse
,
1300 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1301 etd
->capabilities
[0], etd
->capabilities
[1],
1302 etd
->capabilities
[2]);
1304 if (elantech_set_absolute_mode(psmouse
)) {
1305 psmouse_err(psmouse
,
1306 "failed to put touchpad into absolute mode.\n");
1310 if (elantech_set_input_params(psmouse
)) {
1311 psmouse_err(psmouse
, "failed to query touchpad range.\n");
1315 error
= sysfs_create_group(&psmouse
->ps2dev
.serio
->dev
.kobj
,
1316 &elantech_attr_group
);
1318 psmouse_err(psmouse
,
1319 "failed to create sysfs attributes, error: %d.\n",
1324 psmouse
->protocol_handler
= elantech_process_byte
;
1325 psmouse
->disconnect
= elantech_disconnect
;
1326 psmouse
->reconnect
= elantech_reconnect
;
1327 psmouse
->pktsize
= etd
->hw_version
> 1 ? 6 : 4;