1
2
3
4
5
6
7
8
9
10
11
12
13#include <linux/delay.h>
14#include <linux/module.h>
15#include <linux/input.h>
16#include <linux/serio.h>
17#include <linux/libps2.h>
18#include "psmouse.h"
19#include "elantech.h"
20
21#define elantech_debug(format, arg...) \
22 do { \
23 if (etd->debug) \
24 printk(KERN_DEBUG format, ##arg); \
25 } while (0)
26
27
28
29
30static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
31 unsigned char *param)
32{
33 if (psmouse_sliced_command(psmouse, c) ||
34 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
35 pr_err("elantech.c: synaptics_send_cmd query 0x%02x failed.\n", c);
36 return -1;
37 }
38
39 return 0;
40}
41
42
43
44
45static int elantech_ps2_command(struct psmouse *psmouse,
46 unsigned char *param, int command)
47{
48 struct ps2dev *ps2dev = &psmouse->ps2dev;
49 struct elantech_data *etd = psmouse->private;
50 int rc;
51 int tries = ETP_PS2_COMMAND_TRIES;
52
53 do {
54 rc = ps2_command(ps2dev, param, command);
55 if (rc == 0)
56 break;
57 tries--;
58 elantech_debug("elantech.c: retrying ps2 command 0x%02x (%d).\n",
59 command, tries);
60 msleep(ETP_PS2_COMMAND_DELAY);
61 } while (tries > 0);
62
63 if (rc)
64 pr_err("elantech.c: ps2 command 0x%02x failed.\n", command);
65
66 return rc;
67}
68
69
70
71
72static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
73 unsigned char *val)
74{
75 struct elantech_data *etd = psmouse->private;
76 unsigned char param[3];
77 int rc = 0;
78
79 if (reg < 0x10 || reg > 0x26)
80 return -1;
81
82 if (reg > 0x11 && reg < 0x20)
83 return -1;
84
85 switch (etd->hw_version) {
86 case 1:
87 if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
88 psmouse_sliced_command(psmouse, reg) ||
89 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
90 rc = -1;
91 }
92 break;
93
94 case 2:
95 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
96 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
97 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
98 elantech_ps2_command(psmouse, NULL, reg) ||
99 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
100 rc = -1;
101 }
102 break;
103 }
104
105 if (rc)
106 pr_err("elantech.c: failed to read register 0x%02x.\n", reg);
107 else
108 *val = param[0];
109
110 return rc;
111}
112
113
114
115
116static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
117 unsigned char val)
118{
119 struct elantech_data *etd = psmouse->private;
120 int rc = 0;
121
122 if (reg < 0x10 || reg > 0x26)
123 return -1;
124
125 if (reg > 0x11 && reg < 0x20)
126 return -1;
127
128 switch (etd->hw_version) {
129 case 1:
130 if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
131 psmouse_sliced_command(psmouse, reg) ||
132 psmouse_sliced_command(psmouse, val) ||
133 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
134 rc = -1;
135 }
136 break;
137
138 case 2:
139 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
140 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
141 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
142 elantech_ps2_command(psmouse, NULL, reg) ||
143 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
144 elantech_ps2_command(psmouse, NULL, val) ||
145 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
146 rc = -1;
147 }
148 break;
149 }
150
151 if (rc)
152 pr_err("elantech.c: failed to write register 0x%02x with value 0x%02x.\n",
153 reg, val);
154
155 return rc;
156}
157
158
159
160
161static void elantech_packet_dump(unsigned char *packet, int size)
162{
163 int i;
164
165 printk(KERN_DEBUG "elantech.c: PS/2 packet [");
166 for (i = 0; i < size; i++)
167 printk("%s0x%02x ", (i) ? ", " : " ", packet[i]);
168 printk("]\n");
169}
170
171
172
173
174
175static void elantech_report_absolute_v1(struct psmouse *psmouse)
176{
177 struct input_dev *dev = psmouse->dev;
178 struct elantech_data *etd = psmouse->private;
179 unsigned char *packet = psmouse->packet;
180 int fingers;
181 static int old_fingers;
182
183 if (etd->fw_version_maj == 0x01) {
184
185
186 fingers = ((packet[1] & 0x80) >> 7) +
187 ((packet[1] & 0x30) >> 4);
188 } else {
189
190
191 fingers = (packet[0] & 0xc0) >> 6;
192 }
193
194 if (etd->jumpy_cursor) {
195
196 if (fingers > old_fingers) {
197 elantech_debug("elantech.c: discarding packet\n");
198 goto discard_packet_v1;
199 }
200 }
201
202 input_report_key(dev, BTN_TOUCH, fingers != 0);
203
204
205
206 if (fingers) {
207 input_report_abs(dev, ABS_X,
208 ((packet[1] & 0x0c) << 6) | packet[2]);
209 input_report_abs(dev, ABS_Y, ETP_YMAX_V1 -
210 (((packet[1] & 0x03) << 8) | packet[3]));
211 }
212
213 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
214 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
215 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
216 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
217 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
218
219 if ((etd->fw_version_maj == 0x01) &&
220 (etd->capabilities & ETP_CAP_HAS_ROCKER)) {
221
222 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
223
224 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
225 }
226
227 input_sync(dev);
228
229 discard_packet_v1:
230 old_fingers = fingers;
231}
232
233
234
235
236
237static void elantech_report_absolute_v2(struct psmouse *psmouse)
238{
239 struct input_dev *dev = psmouse->dev;
240 unsigned char *packet = psmouse->packet;
241 int fingers, x1, y1, x2, y2;
242
243
244 fingers = (packet[0] & 0xc0) >> 6;
245 input_report_key(dev, BTN_TOUCH, fingers != 0);
246
247 switch (fingers) {
248 case 1:
249
250
251 input_report_abs(dev, ABS_X, (packet[1] << 8) | packet[2]);
252
253
254 input_report_abs(dev, ABS_Y, ETP_YMAX_V2 -
255 ((packet[4] << 8) | packet[5]));
256 break;
257
258 case 2:
259
260
261
262
263 x1 = ((packet[0] & 0x10) << 4) | packet[1];
264
265 y1 = ETP_2FT_YMAX - (((packet[0] & 0x20) << 3) | packet[2]);
266
267
268 x2 = ((packet[3] & 0x10) << 4) | packet[4];
269
270 y2 = ETP_2FT_YMAX - (((packet[3] & 0x20) << 3) | packet[5]);
271
272
273 input_report_abs(dev, ABS_X, x1 << 2);
274 input_report_abs(dev, ABS_Y, y1 << 2);
275
276
277 input_report_abs(dev, ABS_HAT0X, x1);
278 input_report_abs(dev, ABS_HAT0Y, y1);
279 input_report_abs(dev, ABS_HAT1X, x2);
280 input_report_abs(dev, ABS_HAT1Y, y2);
281 break;
282 }
283
284 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
285 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
286 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
287 input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
288 input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
289
290 input_sync(dev);
291}
292
293static int elantech_check_parity_v1(struct psmouse *psmouse)
294{
295 struct elantech_data *etd = psmouse->private;
296 unsigned char *packet = psmouse->packet;
297 unsigned char p1, p2, p3;
298
299
300 if (etd->fw_version_maj == 0x01) {
301
302 p1 = (packet[0] & 0x20) >> 5;
303 p2 = (packet[0] & 0x10) >> 4;
304 } else {
305
306 p1 = (packet[0] & 0x10) >> 4;
307 p2 = (packet[0] & 0x20) >> 5;
308 }
309
310 p3 = (packet[0] & 0x04) >> 2;
311
312 return etd->parity[packet[1]] == p1 &&
313 etd->parity[packet[2]] == p2 &&
314 etd->parity[packet[3]] == p3;
315}
316
317
318
319
320static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
321{
322 struct elantech_data *etd = psmouse->private;
323
324 if (psmouse->pktcnt < psmouse->pktsize)
325 return PSMOUSE_GOOD_DATA;
326
327 if (etd->debug > 1)
328 elantech_packet_dump(psmouse->packet, psmouse->pktsize);
329
330 switch (etd->hw_version) {
331 case 1:
332 if (etd->paritycheck && !elantech_check_parity_v1(psmouse))
333 return PSMOUSE_BAD_DATA;
334
335 elantech_report_absolute_v1(psmouse);
336 break;
337
338 case 2:
339
340 elantech_report_absolute_v2(psmouse);
341 break;
342 }
343
344 return PSMOUSE_FULL_PACKET;
345}
346
347
348
349
350static int elantech_set_absolute_mode(struct psmouse *psmouse)
351{
352 struct elantech_data *etd = psmouse->private;
353 unsigned char val;
354 int tries = ETP_READ_BACK_TRIES;
355 int rc = 0;
356
357 switch (etd->hw_version) {
358 case 1:
359 etd->reg_10 = 0x16;
360 etd->reg_11 = 0x8f;
361 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
362 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
363 rc = -1;
364 }
365 break;
366
367 case 2:
368
369 etd->reg_10 = 0x54;
370 etd->reg_11 = 0x88;
371 etd->reg_21 = 0x60;
372 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
373 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
374 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
375 rc = -1;
376 break;
377 }
378 }
379
380 if (rc == 0) {
381
382
383
384
385
386
387 do {
388 rc = elantech_read_reg(psmouse, 0x10, &val);
389 if (rc == 0)
390 break;
391 tries--;
392 elantech_debug("elantech.c: retrying read (%d).\n",
393 tries);
394 msleep(ETP_READ_BACK_DELAY);
395 } while (tries > 0);
396
397 if (rc) {
398 pr_err("elantech.c: failed to read back register 0x10.\n");
399 } else if (etd->hw_version == 1 &&
400 !(val & ETP_R10_ABSOLUTE_MODE)) {
401 pr_err("elantech.c: touchpad refuses "
402 "to switch to absolute mode.\n");
403 rc = -1;
404 }
405 }
406
407 if (rc)
408 pr_err("elantech.c: failed to initialise registers.\n");
409
410 return rc;
411}
412
413
414
415
416static void elantech_set_input_params(struct psmouse *psmouse)
417{
418 struct input_dev *dev = psmouse->dev;
419 struct elantech_data *etd = psmouse->private;
420
421 __set_bit(EV_KEY, dev->evbit);
422 __set_bit(EV_ABS, dev->evbit);
423
424 __set_bit(BTN_LEFT, dev->keybit);
425 __set_bit(BTN_RIGHT, dev->keybit);
426
427 __set_bit(BTN_TOUCH, dev->keybit);
428 __set_bit(BTN_TOOL_FINGER, dev->keybit);
429 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
430 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
431
432 switch (etd->hw_version) {
433 case 1:
434
435 if ((etd->fw_version_maj == 0x01) &&
436 (etd->capabilities & ETP_CAP_HAS_ROCKER)) {
437 __set_bit(BTN_FORWARD, dev->keybit);
438 __set_bit(BTN_BACK, dev->keybit);
439 }
440 input_set_abs_params(dev, ABS_X, ETP_XMIN_V1, ETP_XMAX_V1, 0, 0);
441 input_set_abs_params(dev, ABS_Y, ETP_YMIN_V1, ETP_YMAX_V1, 0, 0);
442 break;
443
444 case 2:
445 input_set_abs_params(dev, ABS_X, ETP_XMIN_V2, ETP_XMAX_V2, 0, 0);
446 input_set_abs_params(dev, ABS_Y, ETP_YMIN_V2, ETP_YMAX_V2, 0, 0);
447 input_set_abs_params(dev, ABS_HAT0X, ETP_2FT_XMIN, ETP_2FT_XMAX, 0, 0);
448 input_set_abs_params(dev, ABS_HAT0Y, ETP_2FT_YMIN, ETP_2FT_YMAX, 0, 0);
449 input_set_abs_params(dev, ABS_HAT1X, ETP_2FT_XMIN, ETP_2FT_XMAX, 0, 0);
450 input_set_abs_params(dev, ABS_HAT1Y, ETP_2FT_YMIN, ETP_2FT_YMAX, 0, 0);
451 break;
452 }
453}
454
455struct elantech_attr_data {
456 size_t field_offset;
457 unsigned char reg;
458};
459
460
461
462
463static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
464 char *buf)
465{
466 struct elantech_data *etd = psmouse->private;
467 struct elantech_attr_data *attr = data;
468 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
469 int rc = 0;
470
471 if (attr->reg)
472 rc = elantech_read_reg(psmouse, attr->reg, reg);
473
474 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
475}
476
477
478
479
480static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
481 void *data, const char *buf, size_t count)
482{
483 struct elantech_data *etd = psmouse->private;
484 struct elantech_attr_data *attr = data;
485 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
486 unsigned long value;
487 int err;
488
489 err = strict_strtoul(buf, 16, &value);
490 if (err)
491 return err;
492
493 if (value > 0xff)
494 return -EINVAL;
495
496
497 if (etd->hw_version == 1) {
498 if (attr->reg == 0x10)
499
500 value |= ETP_R10_ABSOLUTE_MODE;
501 else if (attr->reg == 0x11)
502
503 value |= ETP_R11_4_BYTE_MODE;
504 }
505
506 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
507 *reg = value;
508
509 return count;
510}
511
512#define ELANTECH_INT_ATTR(_name, _register) \
513 static struct elantech_attr_data elantech_attr_##_name = { \
514 .field_offset = offsetof(struct elantech_data, _name), \
515 .reg = _register, \
516 }; \
517 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
518 &elantech_attr_##_name, \
519 elantech_show_int_attr, \
520 elantech_set_int_attr)
521
522ELANTECH_INT_ATTR(reg_10, 0x10);
523ELANTECH_INT_ATTR(reg_11, 0x11);
524ELANTECH_INT_ATTR(reg_20, 0x20);
525ELANTECH_INT_ATTR(reg_21, 0x21);
526ELANTECH_INT_ATTR(reg_22, 0x22);
527ELANTECH_INT_ATTR(reg_23, 0x23);
528ELANTECH_INT_ATTR(reg_24, 0x24);
529ELANTECH_INT_ATTR(reg_25, 0x25);
530ELANTECH_INT_ATTR(reg_26, 0x26);
531ELANTECH_INT_ATTR(debug, 0);
532ELANTECH_INT_ATTR(paritycheck, 0);
533
534static struct attribute *elantech_attrs[] = {
535 &psmouse_attr_reg_10.dattr.attr,
536 &psmouse_attr_reg_11.dattr.attr,
537 &psmouse_attr_reg_20.dattr.attr,
538 &psmouse_attr_reg_21.dattr.attr,
539 &psmouse_attr_reg_22.dattr.attr,
540 &psmouse_attr_reg_23.dattr.attr,
541 &psmouse_attr_reg_24.dattr.attr,
542 &psmouse_attr_reg_25.dattr.attr,
543 &psmouse_attr_reg_26.dattr.attr,
544 &psmouse_attr_debug.dattr.attr,
545 &psmouse_attr_paritycheck.dattr.attr,
546 NULL
547};
548
549static struct attribute_group elantech_attr_group = {
550 .attrs = elantech_attrs,
551};
552
553
554
555
556int elantech_detect(struct psmouse *psmouse, int set_properties)
557{
558 struct ps2dev *ps2dev = &psmouse->ps2dev;
559 unsigned char param[3];
560
561 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
562
563 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
564 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
565 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
566 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
567 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
568 pr_debug("elantech.c: sending Elantech magic knock failed.\n");
569 return -1;
570 }
571
572
573
574
575
576 if (param[0] != 0x3c || param[1] != 0x03 || param[2] != 0xc8) {
577 pr_debug("elantech.c: "
578 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
579 param[0], param[1], param[2]);
580 return -1;
581 }
582
583
584
585
586
587
588 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
589 pr_debug("elantech.c: failed to query firmware version.\n");
590 return -1;
591 }
592
593 pr_debug("elantech.c: Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
594 param[0], param[1], param[2]);
595
596 if (param[0] == 0 || param[1] != 0) {
597 pr_debug("elantech.c: Probably not a real Elantech touchpad. Aborting.\n");
598 return -1;
599 }
600
601 if (set_properties) {
602 psmouse->vendor = "Elantech";
603 psmouse->name = "Touchpad";
604 }
605
606 return 0;
607}
608
609
610
611
612static void elantech_disconnect(struct psmouse *psmouse)
613{
614 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
615 &elantech_attr_group);
616 kfree(psmouse->private);
617 psmouse->private = NULL;
618}
619
620
621
622
623static int elantech_reconnect(struct psmouse *psmouse)
624{
625 if (elantech_detect(psmouse, 0))
626 return -1;
627
628 if (elantech_set_absolute_mode(psmouse)) {
629 pr_err("elantech.c: failed to put touchpad back into absolute mode.\n");
630 return -1;
631 }
632
633 return 0;
634}
635
636
637
638
639int elantech_init(struct psmouse *psmouse)
640{
641 struct elantech_data *etd;
642 int i, error;
643 unsigned char param[3];
644
645 psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
646 if (!etd)
647 return -1;
648
649 etd->parity[0] = 1;
650 for (i = 1; i < 256; i++)
651 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
652
653
654
655
656 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
657 pr_err("elantech.c: failed to query firmware version.\n");
658 goto init_fail;
659 }
660 etd->fw_version_maj = param[0];
661 etd->fw_version_min = param[2];
662
663
664
665
666
667 if (etd->fw_version_maj >= 0x02 && etd->fw_version_min >= 0x30) {
668 etd->hw_version = 2;
669
670 etd->debug = 1;
671
672 etd->paritycheck = 0;
673 } else {
674 etd->hw_version = 1;
675 etd->paritycheck = 1;
676 }
677 pr_info("elantech.c: assuming hardware version %d, firmware version %d.%d\n",
678 etd->hw_version, etd->fw_version_maj, etd->fw_version_min);
679
680 if (synaptics_send_cmd(psmouse, ETP_CAPABILITIES_QUERY, param)) {
681 pr_err("elantech.c: failed to query capabilities.\n");
682 goto init_fail;
683 }
684 pr_info("elantech.c: Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
685 param[0], param[1], param[2]);
686 etd->capabilities = param[0];
687
688
689
690
691
692
693 if (etd->fw_version_maj == 0x02 && etd->fw_version_min == 0x22) {
694 pr_info("elantech.c: firmware version 2.34 detected, "
695 "enabling jumpy cursor workaround\n");
696 etd->jumpy_cursor = 1;
697 }
698
699 if (elantech_set_absolute_mode(psmouse)) {
700 pr_err("elantech.c: failed to put touchpad into absolute mode.\n");
701 goto init_fail;
702 }
703
704 elantech_set_input_params(psmouse);
705
706 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
707 &elantech_attr_group);
708 if (error) {
709 pr_err("elantech.c: failed to create sysfs attributes, error: %d.\n",
710 error);
711 goto init_fail;
712 }
713
714 psmouse->protocol_handler = elantech_process_byte;
715 psmouse->disconnect = elantech_disconnect;
716 psmouse->reconnect = elantech_reconnect;
717 psmouse->pktsize = etd->hw_version == 2 ? 6 : 4;
718
719 return 0;
720
721 init_fail:
722 kfree(etd);
723 return -1;
724}
725