blob: ca10fd97d9d5fd1f7870f6f4b07ebf6a09d2a55e [file] [log] [blame]
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001/*
Arjan Opmeer3f8c0df2009-04-18 19:05:40 -07002 * Elantech Touchpad driver (v6)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04003 *
Arjan Opmeer3f8c0df2009-04-18 19:05:40 -07004 * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04005 *
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.
9 *
10 * Trademarks are the property of their respective owners.
11 */
12
13#include <linux/delay.h>
Hans de Goede36189cc2014-05-05 09:36:43 -070014#include <linux/dmi.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090015#include <linux/slab.h>
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040016#include <linux/module.h>
Benjamin Tissoires21c48db2018-05-22 17:28:23 -070017#include <linux/i2c.h>
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040018#include <linux/input.h>
Éric Piel89eec4d2011-05-16 22:45:54 -070019#include <linux/input/mt.h>
Benjamin Tissoires21c48db2018-05-22 17:28:23 -070020#include <linux/platform_device.h>
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040021#include <linux/serio.h>
22#include <linux/libps2.h>
Ulrik De Biea2418fc2014-08-22 17:06:00 -070023#include <asm/unaligned.h>
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040024#include "psmouse.h"
25#include "elantech.h"
Benjamin Tissoires21c48db2018-05-22 17:28:23 -070026#include "elan_i2c.h"
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040027
Dmitry Torokhovd4ae84a82010-05-13 00:41:15 -070028#define elantech_debug(fmt, ...) \
29 do { \
Benjamin Tissoiresf0787592018-05-22 17:26:24 -070030 if (etd->info.debug) \
Dmitry Torokhovb5d21702011-10-10 18:27:03 -070031 psmouse_printk(KERN_DEBUG, psmouse, \
32 fmt, ##__VA_ARGS__); \
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040033 } while (0)
34
35/*
36 * Send a Synaptics style sliced query command
37 */
38static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
39 unsigned char *param)
40{
Dmitry Torokhov08be9542018-01-02 12:03:02 -080041 if (ps2_sliced_command(&psmouse->ps2dev, c) ||
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040042 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -070043 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040044 return -1;
45 }
46
47 return 0;
48}
49
50/*
JJ Dingb56b92a2011-11-20 22:21:45 -080051 * V3 and later support this fast command
52 */
53static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
54 unsigned char *param)
55{
56 struct ps2dev *ps2dev = &psmouse->ps2dev;
57
58 if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
59 ps2_command(ps2dev, NULL, c) ||
60 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
61 psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
62 return -1;
63 }
64
65 return 0;
66}
67
68/*
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040069 * A retrying version of ps2_command
70 */
71static int elantech_ps2_command(struct psmouse *psmouse,
72 unsigned char *param, int command)
73{
74 struct ps2dev *ps2dev = &psmouse->ps2dev;
75 struct elantech_data *etd = psmouse->private;
76 int rc;
77 int tries = ETP_PS2_COMMAND_TRIES;
78
79 do {
80 rc = ps2_command(ps2dev, param, command);
81 if (rc == 0)
82 break;
83 tries--;
Dmitry Torokhovd4ae84a82010-05-13 00:41:15 -070084 elantech_debug("retrying ps2 command 0x%02x (%d).\n",
85 command, tries);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040086 msleep(ETP_PS2_COMMAND_DELAY);
87 } while (tries > 0);
88
89 if (rc)
Dmitry Torokhovb5d21702011-10-10 18:27:03 -070090 psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040091
92 return rc;
93}
94
95/*
96 * Send an Elantech style special command to read a value from a register
97 */
98static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
99 unsigned char *val)
100{
101 struct elantech_data *etd = psmouse->private;
102 unsigned char param[3];
103 int rc = 0;
104
JJ Ding1dc6ede2011-09-09 10:31:58 -0700105 if (reg < 0x07 || reg > 0x26)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400106 return -1;
107
108 if (reg > 0x11 && reg < 0x20)
109 return -1;
110
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700111 switch (etd->info.hw_version) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400112 case 1:
Dmitry Torokhov08be9542018-01-02 12:03:02 -0800113 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_READ) ||
114 ps2_sliced_command(&psmouse->ps2dev, reg) ||
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400115 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
116 rc = -1;
117 }
118 break;
119
120 case 2:
121 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
122 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READ) ||
123 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
124 elantech_ps2_command(psmouse, NULL, reg) ||
125 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
126 rc = -1;
127 }
128 break;
JJ Ding28f49612011-09-09 10:30:31 -0700129
JJ Ding1dc6ede2011-09-09 10:31:58 -0700130 case 3 ... 4:
JJ Ding28f49612011-09-09 10:30:31 -0700131 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
132 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
133 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
134 elantech_ps2_command(psmouse, NULL, reg) ||
135 elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
136 rc = -1;
137 }
138 break;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400139 }
140
141 if (rc)
Dmitry Torokhovb5d21702011-10-10 18:27:03 -0700142 psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700143 else if (etd->info.hw_version != 4)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400144 *val = param[0];
JJ Ding1dc6ede2011-09-09 10:31:58 -0700145 else
146 *val = param[1];
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400147
148 return rc;
149}
150
151/*
152 * Send an Elantech style special command to write a register with a value
153 */
154static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
155 unsigned char val)
156{
157 struct elantech_data *etd = psmouse->private;
158 int rc = 0;
159
JJ Ding1dc6ede2011-09-09 10:31:58 -0700160 if (reg < 0x07 || reg > 0x26)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400161 return -1;
162
163 if (reg > 0x11 && reg < 0x20)
164 return -1;
165
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700166 switch (etd->info.hw_version) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400167 case 1:
Dmitry Torokhov08be9542018-01-02 12:03:02 -0800168 if (ps2_sliced_command(&psmouse->ps2dev, ETP_REGISTER_WRITE) ||
169 ps2_sliced_command(&psmouse->ps2dev, reg) ||
170 ps2_sliced_command(&psmouse->ps2dev, val) ||
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400171 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
172 rc = -1;
173 }
174 break;
175
176 case 2:
177 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
178 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
179 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
180 elantech_ps2_command(psmouse, NULL, reg) ||
181 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
182 elantech_ps2_command(psmouse, NULL, val) ||
183 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
184 rc = -1;
185 }
186 break;
JJ Ding28f49612011-09-09 10:30:31 -0700187
188 case 3:
189 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
190 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
191 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
192 elantech_ps2_command(psmouse, NULL, reg) ||
193 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
194 elantech_ps2_command(psmouse, NULL, val) ||
195 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
196 rc = -1;
197 }
198 break;
JJ Ding1dc6ede2011-09-09 10:31:58 -0700199
200 case 4:
201 if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
202 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
203 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
204 elantech_ps2_command(psmouse, NULL, reg) ||
205 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
206 elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
207 elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
208 elantech_ps2_command(psmouse, NULL, val) ||
209 elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
210 rc = -1;
211 }
212 break;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400213 }
214
215 if (rc)
Dmitry Torokhovb5d21702011-10-10 18:27:03 -0700216 psmouse_err(psmouse,
217 "failed to write register 0x%02x with value 0x%02x.\n",
218 reg, val);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400219
220 return rc;
221}
222
223/*
224 * Dump a complete mouse movement packet to the syslog
225 */
Dmitry Torokhovb5d21702011-10-10 18:27:03 -0700226static void elantech_packet_dump(struct psmouse *psmouse)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400227{
Benjamin Tissoires014420f2016-07-28 11:22:13 -0700228 psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [%*ph]\n",
229 psmouse->pktsize, psmouse->packet);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400230}
231
232/*
Benjamin Tissoires88463492019-05-27 18:24:47 -0700233 * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
234 * fw_version for this is based on the following fw_version & caps table:
235 *
236 * Laptop-model: fw_version: caps: buttons:
237 * Acer S3 0x461f00 10, 13, 0e clickpad
238 * Acer S7-392 0x581f01 50, 17, 0d clickpad
239 * Acer V5-131 0x461f02 01, 16, 0c clickpad
240 * Acer V5-551 0x461f00 ? clickpad
241 * Asus K53SV 0x450f01 78, 15, 0c 2 hw buttons
242 * Asus G46VW 0x460f02 00, 18, 0c 2 hw buttons
243 * Asus G750JX 0x360f00 00, 16, 0c 2 hw buttons
244 * Asus TP500LN 0x381f17 10, 14, 0e clickpad
245 * Asus X750JN 0x381f17 10, 14, 0e clickpad
246 * Asus UX31 0x361f00 20, 15, 0e clickpad
247 * Asus UX32VD 0x361f02 00, 15, 0e clickpad
248 * Avatar AVIU-145A2 0x361f00 ? clickpad
249 * Fujitsu CELSIUS H760 0x570f02 40, 14, 0c 3 hw buttons (**)
250 * Fujitsu CELSIUS H780 0x5d0f02 41, 16, 0d 3 hw buttons (**)
251 * Fujitsu LIFEBOOK E544 0x470f00 d0, 12, 09 2 hw buttons
252 * Fujitsu LIFEBOOK E546 0x470f00 50, 12, 09 2 hw buttons
253 * Fujitsu LIFEBOOK E547 0x470f00 50, 12, 09 2 hw buttons
254 * Fujitsu LIFEBOOK E554 0x570f01 40, 14, 0c 2 hw buttons
255 * Fujitsu LIFEBOOK E557 0x570f01 40, 14, 0c 2 hw buttons
256 * Fujitsu T725 0x470f01 05, 12, 09 2 hw buttons
257 * Fujitsu H730 0x570f00 c0, 14, 0c 3 hw buttons (**)
258 * Gigabyte U2442 0x450f01 58, 17, 0c 2 hw buttons
259 * Lenovo L430 0x350f02 b9, 15, 0c 2 hw buttons (*)
260 * Lenovo L530 0x350f02 b9, 15, 0c 2 hw buttons (*)
261 * Samsung NF210 0x150b00 78, 14, 0a 2 hw buttons
262 * Samsung NP770Z5E 0x575f01 10, 15, 0f clickpad
263 * Samsung NP700Z5B 0x361f06 21, 15, 0f clickpad
264 * Samsung NP900X3E-A02 0x575f03 ? clickpad
265 * Samsung NP-QX410 0x851b00 19, 14, 0c clickpad
266 * Samsung RC512 0x450f00 08, 15, 0c 2 hw buttons
267 * Samsung RF710 0x450f00 ? 2 hw buttons
268 * System76 Pangolin 0x250f01 ? 2 hw buttons
269 * (*) + 3 trackpoint buttons
270 * (**) + 0 trackpoint buttons
271 * Note: Lenovo L430 and Lenovo L530 have the same fw_version/caps
272 */
273static inline int elantech_is_buttonpad(struct elantech_device_info *info)
274{
275 return info->fw_version & 0x001000;
276}
277
278/*
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400279 * Interpret complete data packets and report absolute mode input events for
280 * hardware version 1. (4 byte packets)
281 */
282static void elantech_report_absolute_v1(struct psmouse *psmouse)
283{
284 struct input_dev *dev = psmouse->dev;
285 struct elantech_data *etd = psmouse->private;
286 unsigned char *packet = psmouse->packet;
287 int fingers;
288
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700289 if (etd->info.fw_version < 0x020000) {
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700290 /*
291 * byte 0: D U p1 p2 1 p3 R L
292 * byte 1: f 0 th tw x9 x8 y9 y8
293 */
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400294 fingers = ((packet[1] & 0x80) >> 7) +
295 ((packet[1] & 0x30) >> 4);
296 } else {
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700297 /*
298 * byte 0: n1 n0 p2 p1 1 p3 R L
299 * byte 1: 0 0 0 0 x9 x8 y9 y8
300 */
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400301 fingers = (packet[0] & 0xc0) >> 6;
302 }
303
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700304 if (etd->info.jumpy_cursor) {
Éric Piel7f29f172010-08-05 23:51:49 -0700305 if (fingers != 1) {
306 etd->single_finger_reports = 0;
307 } else if (etd->single_finger_reports < 2) {
308 /* Discard first 2 reports of one finger, bogus */
309 etd->single_finger_reports++;
Dmitry Torokhovd4ae84a82010-05-13 00:41:15 -0700310 elantech_debug("discarding packet\n");
Éric Piel7f29f172010-08-05 23:51:49 -0700311 return;
Arjan Opmeer3f8c0df2009-04-18 19:05:40 -0700312 }
313 }
314
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400315 input_report_key(dev, BTN_TOUCH, fingers != 0);
316
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700317 /*
318 * byte 2: x7 x6 x5 x4 x3 x2 x1 x0
319 * byte 3: y7 y6 y5 y4 y3 y2 y1 y0
320 */
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400321 if (fingers) {
322 input_report_abs(dev, ABS_X,
323 ((packet[1] & 0x0c) << 6) | packet[2]);
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700324 input_report_abs(dev, ABS_Y,
JJ Ding230282a2011-09-09 10:26:16 -0700325 etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400326 }
327
328 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
329 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
330 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
Dmitry Torokhov1ef85802017-02-07 17:07:44 -0800331
332 psmouse_report_standard_buttons(dev, packet[0]);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400333
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700334 if (etd->info.fw_version < 0x020000 &&
335 (etd->info.capabilities[0] & ETP_CAP_HAS_ROCKER)) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400336 /* rocker up */
337 input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
338 /* rocker down */
339 input_report_key(dev, BTN_BACK, packet[0] & 0x80);
340 }
341
342 input_sync(dev);
343}
344
Éric Piel89eec4d2011-05-16 22:45:54 -0700345static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
346 unsigned int x, unsigned int y)
347{
348 input_mt_slot(dev, slot);
349 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
350 if (active) {
351 input_report_abs(dev, ABS_MT_POSITION_X, x);
352 input_report_abs(dev, ABS_MT_POSITION_Y, y);
353 }
354}
355
356/* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
357static void elantech_report_semi_mt_data(struct input_dev *dev,
358 unsigned int num_fingers,
359 unsigned int x1, unsigned int y1,
360 unsigned int x2, unsigned int y2)
361{
362 elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
Benjamin Tissoires3c0213d2015-04-23 09:08:43 -0700363 elantech_set_slot(dev, 1, num_fingers >= 2, x2, y2);
Éric Piel89eec4d2011-05-16 22:45:54 -0700364}
365
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400366/*
367 * Interpret complete data packets and report absolute mode input events for
368 * hardware version 2. (6 byte packets)
369 */
370static void elantech_report_absolute_v2(struct psmouse *psmouse)
371{
Éric Pielf941c702011-05-16 22:45:54 -0700372 struct elantech_data *etd = psmouse->private;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400373 struct input_dev *dev = psmouse->dev;
374 unsigned char *packet = psmouse->packet;
JJ Ding461a7912011-09-09 10:22:58 -0700375 unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
376 unsigned int width = 0, pres = 0;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400377
378 /* byte 0: n1 n0 . . . . R L */
379 fingers = (packet[0] & 0xc0) >> 6;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400380
381 switch (fingers) {
Éric Piel22462d9f2010-08-05 23:51:49 -0700382 case 3:
383 /*
384 * Same as one finger, except report of more than 3 fingers:
385 * byte 3: n4 . w1 w0 . . . .
386 */
387 if (packet[3] & 0x80)
388 fingers = 4;
Gustavo A. R. Silva17a4ed52018-08-06 15:31:02 -0700389 /* fall through */
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400390 case 1:
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700391 /*
JJ Ding11559612011-09-09 10:22:19 -0700392 * byte 1: . . . . x11 x10 x9 x8
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700393 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
394 */
JJ Ding11559612011-09-09 10:22:19 -0700395 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700396 /*
JJ Ding11559612011-09-09 10:22:19 -0700397 * byte 4: . . . . y11 y10 y9 y8
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700398 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
399 */
JJ Ding230282a2011-09-09 10:26:16 -0700400 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
Éric Piel89eec4d2011-05-16 22:45:54 -0700401
Éric Pielf941c702011-05-16 22:45:54 -0700402 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
403 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400404 break;
405
406 case 2:
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700407 /*
408 * The coordinate of each finger is reported separately
409 * with a lower resolution for two finger touches:
410 * byte 0: . . ay8 ax8 . . . .
411 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
412 */
JJ Ding461a7912011-09-09 10:22:58 -0700413 x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400414 /* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
JJ Ding230282a2011-09-09 10:26:16 -0700415 y1 = etd->y_max -
JJ Ding461a7912011-09-09 10:22:58 -0700416 ((((packet[0] & 0x20) << 3) | packet[2]) << 2);
Florian Ragwitze938fbf2010-05-03 23:29:37 -0700417 /*
418 * byte 3: . . by8 bx8 . . . .
419 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
420 */
JJ Ding461a7912011-09-09 10:22:58 -0700421 x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400422 /* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
JJ Ding230282a2011-09-09 10:26:16 -0700423 y2 = etd->y_max -
JJ Ding461a7912011-09-09 10:22:58 -0700424 ((((packet[3] & 0x20) << 3) | packet[5]) << 2);
Éric Pielf941c702011-05-16 22:45:54 -0700425
426 /* Unknown so just report sensible values */
427 pres = 127;
428 width = 7;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400429 break;
430 }
431
JJ Ding461a7912011-09-09 10:22:58 -0700432 input_report_key(dev, BTN_TOUCH, fingers != 0);
433 if (fingers != 0) {
434 input_report_abs(dev, ABS_X, x1);
435 input_report_abs(dev, ABS_Y, y1);
436 }
Éric Piel89eec4d2011-05-16 22:45:54 -0700437 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400438 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
439 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
440 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
Éric Piel22462d9f2010-08-05 23:51:49 -0700441 input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
Dmitry Torokhov1ef85802017-02-07 17:07:44 -0800442 psmouse_report_standard_buttons(dev, packet[0]);
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700443 if (etd->info.reports_pressure) {
Éric Pielf941c702011-05-16 22:45:54 -0700444 input_report_abs(dev, ABS_PRESSURE, pres);
445 input_report_abs(dev, ABS_TOOL_WIDTH, width);
446 }
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400447
448 input_sync(dev);
449}
450
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700451static void elantech_report_trackpoint(struct psmouse *psmouse,
452 int packet_type)
453{
454 /*
455 * byte 0: 0 0 sx sy 0 M R L
456 * byte 1:~sx 0 0 0 0 0 0 0
457 * byte 2:~sy 0 0 0 0 0 0 0
458 * byte 3: 0 0 ~sy ~sx 0 1 1 0
459 * byte 4: x7 x6 x5 x4 x3 x2 x1 x0
460 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
461 *
462 * x and y are written in two's complement spread
463 * over 9 bits with sx/sy the relative top bit and
464 * x7..x0 and y7..y0 the lower bits.
465 * The sign of y is opposite to what the input driver
466 * expects for a relative movement
467 */
468
469 struct elantech_data *etd = psmouse->private;
470 struct input_dev *tp_dev = etd->tp_dev;
471 unsigned char *packet = psmouse->packet;
472 int x, y;
473 u32 t;
474
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700475 t = get_unaligned_le32(&packet[0]);
476
477 switch (t & ~7U) {
478 case 0x06000030U:
479 case 0x16008020U:
480 case 0x26800010U:
481 case 0x36808000U:
482 x = packet[4] - (int)((packet[1]^0x80) << 1);
483 y = (int)((packet[2]^0x80) << 1) - packet[5];
484
Dmitry Torokhov1ef85802017-02-07 17:07:44 -0800485 psmouse_report_standard_buttons(tp_dev, packet[0]);
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700486
487 input_report_rel(tp_dev, REL_X, x);
488 input_report_rel(tp_dev, REL_Y, y);
489
490 input_sync(tp_dev);
491
492 break;
493
494 default:
495 /* Dump unexpected packet sequences if debug=1 (default) */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700496 if (etd->info.debug == 1)
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700497 elantech_packet_dump(psmouse);
498
499 break;
500 }
501}
502
JJ Ding28f49612011-09-09 10:30:31 -0700503/*
504 * Interpret complete data packets and report absolute mode input events for
505 * hardware version 3. (12 byte packets for two fingers)
506 */
507static void elantech_report_absolute_v3(struct psmouse *psmouse,
508 int packet_type)
509{
510 struct input_dev *dev = psmouse->dev;
511 struct elantech_data *etd = psmouse->private;
512 unsigned char *packet = psmouse->packet;
513 unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
514 unsigned int width = 0, pres = 0;
515
516 /* byte 0: n1 n0 . . . . R L */
517 fingers = (packet[0] & 0xc0) >> 6;
518
519 switch (fingers) {
520 case 3:
521 case 1:
522 /*
523 * byte 1: . . . . x11 x10 x9 x8
524 * byte 2: x7 x6 x5 x4 x4 x2 x1 x0
525 */
526 x1 = ((packet[1] & 0x0f) << 8) | packet[2];
527 /*
528 * byte 4: . . . . y11 y10 y9 y8
529 * byte 5: y7 y6 y5 y4 y3 y2 y1 y0
530 */
531 y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
532 break;
533
534 case 2:
535 if (packet_type == PACKET_V3_HEAD) {
536 /*
537 * byte 1: . . . . ax11 ax10 ax9 ax8
538 * byte 2: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
539 */
JJ Ding1dc6ede2011-09-09 10:31:58 -0700540 etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
JJ Ding28f49612011-09-09 10:30:31 -0700541 /*
542 * byte 4: . . . . ay11 ay10 ay9 ay8
543 * byte 5: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0
544 */
JJ Ding1dc6ede2011-09-09 10:31:58 -0700545 etd->mt[0].y = etd->y_max -
JJ Ding28f49612011-09-09 10:30:31 -0700546 (((packet[4] & 0x0f) << 8) | packet[5]);
547 /*
548 * wait for next packet
549 */
550 return;
551 }
552
553 /* packet_type == PACKET_V3_TAIL */
JJ Ding1dc6ede2011-09-09 10:31:58 -0700554 x1 = etd->mt[0].x;
555 y1 = etd->mt[0].y;
JJ Ding28f49612011-09-09 10:30:31 -0700556 x2 = ((packet[1] & 0x0f) << 8) | packet[2];
557 y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
558 break;
559 }
560
561 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
562 width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
563
564 input_report_key(dev, BTN_TOUCH, fingers != 0);
565 if (fingers != 0) {
566 input_report_abs(dev, ABS_X, x1);
567 input_report_abs(dev, ABS_Y, y1);
568 }
569 elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
570 input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
571 input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
572 input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700573
574 /* For clickpads map both buttons to BTN_LEFT */
Benjamin Tissoires88463492019-05-27 18:24:47 -0700575 if (elantech_is_buttonpad(&etd->info))
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700576 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
Dmitry Torokhov1ef85802017-02-07 17:07:44 -0800577 else
578 psmouse_report_standard_buttons(dev, packet[0]);
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700579
JJ Ding28f49612011-09-09 10:30:31 -0700580 input_report_abs(dev, ABS_PRESSURE, pres);
581 input_report_abs(dev, ABS_TOOL_WIDTH, width);
582
583 input_sync(dev);
584}
585
JJ Ding1dc6ede2011-09-09 10:31:58 -0700586static void elantech_input_sync_v4(struct psmouse *psmouse)
587{
588 struct input_dev *dev = psmouse->dev;
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700589 struct elantech_data *etd = psmouse->private;
JJ Ding1dc6ede2011-09-09 10:31:58 -0700590 unsigned char *packet = psmouse->packet;
591
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700592 /* For clickpads map both buttons to BTN_LEFT */
Benjamin Tissoires88463492019-05-27 18:24:47 -0700593 if (elantech_is_buttonpad(&etd->info))
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700594 input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
Dmitry Torokhov1ef85802017-02-07 17:07:44 -0800595 else
596 psmouse_report_standard_buttons(dev, packet[0]);
Hans de Goedecd9e83e2014-06-07 22:35:07 -0700597
JJ Ding1dc6ede2011-09-09 10:31:58 -0700598 input_mt_report_pointer_emulation(dev, true);
599 input_sync(dev);
600}
601
602static void process_packet_status_v4(struct psmouse *psmouse)
603{
604 struct input_dev *dev = psmouse->dev;
605 unsigned char *packet = psmouse->packet;
606 unsigned fingers;
607 int i;
608
609 /* notify finger state change */
610 fingers = packet[1] & 0x1f;
611 for (i = 0; i < ETP_MAX_FINGERS; i++) {
612 if ((fingers & (1 << i)) == 0) {
613 input_mt_slot(dev, i);
614 input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
615 }
616 }
617
618 elantech_input_sync_v4(psmouse);
619}
620
621static void process_packet_head_v4(struct psmouse *psmouse)
622{
623 struct input_dev *dev = psmouse->dev;
624 struct elantech_data *etd = psmouse->private;
625 unsigned char *packet = psmouse->packet;
626 int id = ((packet[3] & 0xe0) >> 5) - 1;
627 int pres, traces;
628
629 if (id < 0)
630 return;
631
632 etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
633 etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
634 pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
635 traces = (packet[0] & 0xf0) >> 4;
636
637 input_mt_slot(dev, id);
638 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
639
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);
642 input_report_abs(dev, ABS_MT_PRESSURE, pres);
643 input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
644 /* report this for backwards compatibility */
645 input_report_abs(dev, ABS_TOOL_WIDTH, traces);
646
647 elantech_input_sync_v4(psmouse);
648}
649
650static void process_packet_motion_v4(struct psmouse *psmouse)
651{
652 struct input_dev *dev = psmouse->dev;
653 struct elantech_data *etd = psmouse->private;
654 unsigned char *packet = psmouse->packet;
655 int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
656 int id, sid;
657
658 id = ((packet[0] & 0xe0) >> 5) - 1;
659 if (id < 0)
660 return;
661
662 sid = ((packet[3] & 0xe0) >> 5) - 1;
663 weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
664 /*
665 * Motion packets give us the delta of x, y values of specific fingers,
666 * but in two's complement. Let the compiler do the conversion for us.
667 * Also _enlarge_ the numbers to int, in case of overflow.
668 */
669 delta_x1 = (signed char)packet[1];
670 delta_y1 = (signed char)packet[2];
671 delta_x2 = (signed char)packet[4];
672 delta_y2 = (signed char)packet[5];
673
674 etd->mt[id].x += delta_x1 * weight;
675 etd->mt[id].y -= delta_y1 * weight;
676 input_mt_slot(dev, id);
677 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
678 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
679
680 if (sid >= 0) {
681 etd->mt[sid].x += delta_x2 * weight;
682 etd->mt[sid].y -= delta_y2 * weight;
683 input_mt_slot(dev, sid);
684 input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
685 input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
686 }
687
688 elantech_input_sync_v4(psmouse);
689}
690
691static void elantech_report_absolute_v4(struct psmouse *psmouse,
692 int packet_type)
693{
694 switch (packet_type) {
695 case PACKET_V4_STATUS:
696 process_packet_status_v4(psmouse);
697 break;
698
699 case PACKET_V4_HEAD:
700 process_packet_head_v4(psmouse);
701 break;
702
703 case PACKET_V4_MOTION:
704 process_packet_motion_v4(psmouse);
705 break;
706
707 case PACKET_UNKNOWN:
708 default:
709 /* impossible to get here */
710 break;
711 }
712}
713
JJ Ding7894f212011-09-09 10:28:04 -0700714static int elantech_packet_check_v1(struct psmouse *psmouse)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400715{
716 struct elantech_data *etd = psmouse->private;
717 unsigned char *packet = psmouse->packet;
718 unsigned char p1, p2, p3;
719
720 /* Parity bits are placed differently */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700721 if (etd->info.fw_version < 0x020000) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400722 /* byte 0: D U p1 p2 1 p3 R L */
723 p1 = (packet[0] & 0x20) >> 5;
724 p2 = (packet[0] & 0x10) >> 4;
725 } else {
726 /* byte 0: n1 n0 p2 p1 1 p3 R L */
727 p1 = (packet[0] & 0x10) >> 4;
728 p2 = (packet[0] & 0x20) >> 5;
729 }
730
731 p3 = (packet[0] & 0x04) >> 2;
732
733 return etd->parity[packet[1]] == p1 &&
734 etd->parity[packet[2]] == p2 &&
735 etd->parity[packet[3]] == p3;
736}
737
JJ Ding84a90b62011-09-20 22:42:51 -0700738static int elantech_debounce_check_v2(struct psmouse *psmouse)
739{
740 /*
741 * When we encounter packet that matches this exactly, it means the
742 * hardware is in debounce status. Just ignore the whole packet.
743 */
Colin Ian King4f1b4612017-09-07 14:27:26 -0700744 static const u8 debounce_packet[] = {
745 0x84, 0xff, 0xff, 0x02, 0xff, 0xff
746 };
JJ Ding84a90b62011-09-20 22:42:51 -0700747 unsigned char *packet = psmouse->packet;
748
749 return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
750}
751
JJ Ding7894f212011-09-09 10:28:04 -0700752static int elantech_packet_check_v2(struct psmouse *psmouse)
753{
754 struct elantech_data *etd = psmouse->private;
755 unsigned char *packet = psmouse->packet;
756
757 /*
758 * V2 hardware has two flavors. Older ones that do not report pressure,
759 * and newer ones that reports pressure and width. With newer ones, all
760 * packets (1, 2, 3 finger touch) have the same constant bits. With
761 * older ones, 1/3 finger touch packets and 2 finger touch packets
762 * have different constant bits.
763 * With all three cases, if the constant bits are not exactly what I
764 * expected, I consider them invalid.
765 */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700766 if (etd->info.reports_pressure)
JJ Ding7894f212011-09-09 10:28:04 -0700767 return (packet[0] & 0x0c) == 0x04 &&
768 (packet[3] & 0x0f) == 0x02;
769
770 if ((packet[0] & 0xc0) == 0x80)
771 return (packet[0] & 0x0c) == 0x0c &&
772 (packet[3] & 0x0e) == 0x08;
773
774 return (packet[0] & 0x3c) == 0x3c &&
775 (packet[1] & 0xf0) == 0x00 &&
776 (packet[3] & 0x3e) == 0x38 &&
777 (packet[4] & 0xf0) == 0x00;
778}
779
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400780/*
JJ Ding28f49612011-09-09 10:30:31 -0700781 * We check the constant bits to determine what packet type we get,
JJ Ding1dc6ede2011-09-09 10:31:58 -0700782 * so packet checking is mandatory for v3 and later hardware.
JJ Ding28f49612011-09-09 10:30:31 -0700783 */
784static int elantech_packet_check_v3(struct psmouse *psmouse)
785{
Matteo Delfinoacc04442013-08-15 00:09:41 -0700786 struct elantech_data *etd = psmouse->private;
Colin Ian King4f1b4612017-09-07 14:27:26 -0700787 static const u8 debounce_packet[] = {
788 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff
789 };
JJ Ding28f49612011-09-09 10:30:31 -0700790 unsigned char *packet = psmouse->packet;
791
792 /*
793 * check debounce first, it has the same signature in byte 0
794 * and byte 3 as PACKET_V3_HEAD.
795 */
796 if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
797 return PACKET_DEBOUNCE;
798
Matteo Delfinoacc04442013-08-15 00:09:41 -0700799 /*
800 * If the hardware flag 'crc_enabled' is set the packets have
801 * different signatures.
802 */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700803 if (etd->info.crc_enabled) {
Matteo Delfinoacc04442013-08-15 00:09:41 -0700804 if ((packet[3] & 0x09) == 0x08)
805 return PACKET_V3_HEAD;
JJ Ding28f49612011-09-09 10:30:31 -0700806
Matteo Delfinoacc04442013-08-15 00:09:41 -0700807 if ((packet[3] & 0x09) == 0x09)
808 return PACKET_V3_TAIL;
809 } else {
810 if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
811 return PACKET_V3_HEAD;
812
813 if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
814 return PACKET_V3_TAIL;
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700815 if ((packet[3] & 0x0f) == 0x06)
816 return PACKET_TRACKPOINT;
Matteo Delfinoacc04442013-08-15 00:09:41 -0700817 }
JJ Ding28f49612011-09-09 10:30:31 -0700818
819 return PACKET_UNKNOWN;
820}
821
JJ Ding1dc6ede2011-09-09 10:31:58 -0700822static int elantech_packet_check_v4(struct psmouse *psmouse)
823{
Matteo Delfinoacc04442013-08-15 00:09:41 -0700824 struct elantech_data *etd = psmouse->private;
JJ Ding1dc6ede2011-09-09 10:31:58 -0700825 unsigned char *packet = psmouse->packet;
Matteo Delfino9eebed72013-07-06 21:52:26 -0700826 unsigned char packet_type = packet[3] & 0x03;
Duson Lin6b30c732015-08-07 14:37:24 -0700827 unsigned int ic_version;
Matteo Delfinoacc04442013-08-15 00:09:41 -0700828 bool sanity_check;
829
Dmitry Torokhovd0ab5472014-11-19 23:33:07 -0800830 if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
Ulrik De Biecaeb0d32014-11-07 23:51:34 -0800831 return PACKET_TRACKPOINT;
832
Duson Lin6b30c732015-08-07 14:37:24 -0700833 /* This represents the version of IC body. */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700834 ic_version = (etd->info.fw_version & 0x0f0000) >> 16;
Duson Lin6b30c732015-08-07 14:37:24 -0700835
Matteo Delfinoacc04442013-08-15 00:09:41 -0700836 /*
837 * Sanity check based on the constant bits of a packet.
838 * The constant bits change depending on the value of
Duson Lin6b30c732015-08-07 14:37:24 -0700839 * the hardware flag 'crc_enabled' and the version of
840 * the IC body, but are the same for every packet,
841 * regardless of the type.
Matteo Delfinoacc04442013-08-15 00:09:41 -0700842 */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700843 if (etd->info.crc_enabled)
Matteo Delfinoacc04442013-08-15 00:09:41 -0700844 sanity_check = ((packet[3] & 0x08) == 0x00);
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700845 else if (ic_version == 7 && etd->info.samples[1] == 0x2A)
Duson Lin6b30c732015-08-07 14:37:24 -0700846 sanity_check = ((packet[3] & 0x1c) == 0x10);
Matteo Delfinoacc04442013-08-15 00:09:41 -0700847 else
???e0ae2512018-06-21 17:15:32 -0700848 sanity_check = ((packet[0] & 0x08) == 0x00 &&
Matteo Delfinoacc04442013-08-15 00:09:41 -0700849 (packet[3] & 0x1c) == 0x10);
850
851 if (!sanity_check)
852 return PACKET_UNKNOWN;
JJ Ding1dc6ede2011-09-09 10:31:58 -0700853
Matteo Delfino9eebed72013-07-06 21:52:26 -0700854 switch (packet_type) {
855 case 0:
856 return PACKET_V4_STATUS;
857
858 case 1:
JJ Ding1dc6ede2011-09-09 10:31:58 -0700859 return PACKET_V4_HEAD;
860
Matteo Delfino9eebed72013-07-06 21:52:26 -0700861 case 2:
JJ Ding1dc6ede2011-09-09 10:31:58 -0700862 return PACKET_V4_MOTION;
Matteo Delfino9eebed72013-07-06 21:52:26 -0700863 }
JJ Ding1dc6ede2011-09-09 10:31:58 -0700864
865 return PACKET_UNKNOWN;
866}
867
JJ Ding28f49612011-09-09 10:30:31 -0700868/*
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400869 * Process byte stream from mouse and handle complete packets
870 */
871static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
872{
873 struct elantech_data *etd = psmouse->private;
JJ Ding28f49612011-09-09 10:30:31 -0700874 int packet_type;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400875
876 if (psmouse->pktcnt < psmouse->pktsize)
877 return PSMOUSE_GOOD_DATA;
878
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700879 if (etd->info.debug > 1)
Dmitry Torokhovb5d21702011-10-10 18:27:03 -0700880 elantech_packet_dump(psmouse);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400881
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700882 switch (etd->info.hw_version) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400883 case 1:
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700884 if (etd->info.paritycheck && !elantech_packet_check_v1(psmouse))
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400885 return PSMOUSE_BAD_DATA;
886
887 elantech_report_absolute_v1(psmouse);
888 break;
889
890 case 2:
JJ Ding84a90b62011-09-20 22:42:51 -0700891 /* ignore debounce */
892 if (elantech_debounce_check_v2(psmouse))
893 return PSMOUSE_FULL_PACKET;
894
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700895 if (etd->info.paritycheck && !elantech_packet_check_v2(psmouse))
JJ Ding7894f212011-09-09 10:28:04 -0700896 return PSMOUSE_BAD_DATA;
897
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400898 elantech_report_absolute_v2(psmouse);
899 break;
JJ Ding28f49612011-09-09 10:30:31 -0700900
901 case 3:
902 packet_type = elantech_packet_check_v3(psmouse);
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700903 switch (packet_type) {
904 case PACKET_UNKNOWN:
JJ Ding28f49612011-09-09 10:30:31 -0700905 return PSMOUSE_BAD_DATA;
906
Ulrik De Biea2418fc2014-08-22 17:06:00 -0700907 case PACKET_DEBOUNCE:
908 /* ignore debounce */
909 break;
910
911 case PACKET_TRACKPOINT:
912 elantech_report_trackpoint(psmouse, packet_type);
913 break;
914
915 default:
916 elantech_report_absolute_v3(psmouse, packet_type);
917 break;
918 }
919
JJ Ding28f49612011-09-09 10:30:31 -0700920 break;
JJ Ding1dc6ede2011-09-09 10:31:58 -0700921
922 case 4:
923 packet_type = elantech_packet_check_v4(psmouse);
Ulrik De Biecaeb0d32014-11-07 23:51:34 -0800924 switch (packet_type) {
925 case PACKET_UNKNOWN:
JJ Ding1dc6ede2011-09-09 10:31:58 -0700926 return PSMOUSE_BAD_DATA;
927
Ulrik De Biecaeb0d32014-11-07 23:51:34 -0800928 case PACKET_TRACKPOINT:
929 elantech_report_trackpoint(psmouse, packet_type);
930 break;
931
932 default:
933 elantech_report_absolute_v4(psmouse, packet_type);
934 break;
935 }
936
JJ Ding1dc6ede2011-09-09 10:31:58 -0700937 break;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400938 }
939
940 return PSMOUSE_FULL_PACKET;
941}
942
943/*
Ulrik De Biebd884142015-04-06 15:35:38 -0700944 * This writes the reg_07 value again to the hardware at the end of every
945 * set_rate call because the register loses its value. reg_07 allows setting
946 * absolute mode on v4 hardware
947 */
948static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
949 unsigned int rate)
950{
951 struct elantech_data *etd = psmouse->private;
952
953 etd->original_set_rate(psmouse, rate);
954 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
955 psmouse_err(psmouse, "restoring reg_07 failed\n");
956}
957
958/*
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400959 * Put the touchpad into absolute mode
960 */
961static int elantech_set_absolute_mode(struct psmouse *psmouse)
962{
963 struct elantech_data *etd = psmouse->private;
964 unsigned char val;
965 int tries = ETP_READ_BACK_TRIES;
966 int rc = 0;
967
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700968 switch (etd->info.hw_version) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400969 case 1:
970 etd->reg_10 = 0x16;
971 etd->reg_11 = 0x8f;
972 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
973 elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
974 rc = -1;
975 }
976 break;
977
978 case 2:
979 /* Windows driver values */
980 etd->reg_10 = 0x54;
981 etd->reg_11 = 0x88; /* 0x8a */
982 etd->reg_21 = 0x60; /* 0x00 */
983 if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
984 elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
985 elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
986 rc = -1;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -0400987 }
JJ Ding28f49612011-09-09 10:30:31 -0700988 break;
989
990 case 3:
Benjamin Tissoiresf0787592018-05-22 17:26:24 -0700991 if (etd->info.set_hw_resolution)
Hans de Goede36189cc2014-05-05 09:36:43 -0700992 etd->reg_10 = 0x0b;
993 else
Hans de Goedefb4f8f52014-06-07 23:07:13 -0700994 etd->reg_10 = 0x01;
Hans de Goede36189cc2014-05-05 09:36:43 -0700995
JJ Ding28f49612011-09-09 10:30:31 -0700996 if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
997 rc = -1;
998
999 break;
JJ Ding1dc6ede2011-09-09 10:31:58 -07001000
1001 case 4:
1002 etd->reg_07 = 0x01;
1003 if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
1004 rc = -1;
1005
1006 goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
Arjan Opmeerb2546df2009-04-18 19:10:17 -07001007 }
1008
1009 if (rc == 0) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001010 /*
Arjan Opmeerb2546df2009-04-18 19:10:17 -07001011 * Read back reg 0x10. For hardware version 1 we must make
1012 * sure the absolute mode bit is set. For hardware version 2
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001013 * the touchpad is probably initializing and not ready until
Arjan Opmeerb2546df2009-04-18 19:10:17 -07001014 * we read back the value we just wrote.
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001015 */
1016 do {
1017 rc = elantech_read_reg(psmouse, 0x10, &val);
1018 if (rc == 0)
1019 break;
1020 tries--;
Dmitry Torokhovd4ae84a82010-05-13 00:41:15 -07001021 elantech_debug("retrying read (%d).\n", tries);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001022 msleep(ETP_READ_BACK_DELAY);
1023 } while (tries > 0);
Arjan Opmeerb2546df2009-04-18 19:10:17 -07001024
1025 if (rc) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001026 psmouse_err(psmouse,
1027 "failed to read back register 0x10.\n");
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001028 } else if (etd->info.hw_version == 1 &&
Arjan Opmeerb2546df2009-04-18 19:10:17 -07001029 !(val & ETP_R10_ABSOLUTE_MODE)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001030 psmouse_err(psmouse,
1031 "touchpad refuses to switch to absolute mode.\n");
Arjan Opmeerb2546df2009-04-18 19:10:17 -07001032 rc = -1;
1033 }
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001034 }
1035
JJ Ding1dc6ede2011-09-09 10:31:58 -07001036 skip_readback_reg_10:
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001037 if (rc)
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001038 psmouse_err(psmouse, "failed to initialise registers.\n");
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001039
1040 return rc;
1041}
1042
1043/*
JJ Ding3d95fd62011-11-20 22:26:56 -08001044 * (value from firmware) * 10 + 790 = dpi
1045 * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1046 */
1047static unsigned int elantech_convert_res(unsigned int val)
1048{
1049 return (val * 10 + 790) * 10 / 254;
1050}
1051
1052static int elantech_get_resolution_v4(struct psmouse *psmouse,
1053 unsigned int *x_res,
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001054 unsigned int *y_res,
1055 unsigned int *bus)
JJ Ding3d95fd62011-11-20 22:26:56 -08001056{
1057 unsigned char param[3];
1058
1059 if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1060 return -1;
1061
1062 *x_res = elantech_convert_res(param[1] & 0x0f);
1063 *y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001064 *bus = param[2];
JJ Ding3d95fd62011-11-20 22:26:56 -08001065
1066 return 0;
1067}
1068
Hans de Goedec15bdfd2013-12-16 07:09:25 -08001069static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1070{
1071 struct input_dev *dev = psmouse->dev;
1072 struct elantech_data *etd = psmouse->private;
1073
Benjamin Tissoires88463492019-05-27 18:24:47 -07001074 if (elantech_is_buttonpad(&etd->info)) {
Hans de Goedec15bdfd2013-12-16 07:09:25 -08001075 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1076 __clear_bit(BTN_RIGHT, dev->keybit);
1077 }
1078}
1079
1080/*
Ulrik De Bief3864742014-11-13 17:45:12 -08001081 * Some hw_version 4 models do have a middle button
1082 */
1083static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1084#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1085 {
1086 /* Fujitsu H730 has a middle button */
1087 .matches = {
1088 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1089 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1090 },
1091 },
Matti Kurkelaf9a703a2016-10-03 16:48:17 -07001092 {
1093 /* Fujitsu H760 also has a middle button */
1094 .matches = {
1095 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1096 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1097 },
1098 },
Matti Kurkelae8b22d0a2019-02-07 23:49:23 -08001099 {
1100 /* Fujitsu H780 also has a middle button */
1101 .matches = {
1102 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1103 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H780"),
1104 },
1105 },
Ulrik De Bief3864742014-11-13 17:45:12 -08001106#endif
1107 { }
1108};
1109
1110/*
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001111 * Set the appropriate event bits for the input subsystem
1112 */
JJ Ding28f49612011-09-09 10:30:31 -07001113static int elantech_set_input_params(struct psmouse *psmouse)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001114{
1115 struct input_dev *dev = psmouse->dev;
1116 struct elantech_data *etd = psmouse->private;
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001117 struct elantech_device_info *info = &etd->info;
Benjamin Tissoires37548652019-05-27 18:24:28 -07001118 unsigned int x_min = info->x_min, y_min = info->y_min,
1119 x_max = info->x_max, y_max = info->y_max,
1120 width = info->width;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001121
JJ Dinge3dde4f2012-04-10 00:30:12 -07001122 __set_bit(INPUT_PROP_POINTER, dev->propbit);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001123 __set_bit(EV_KEY, dev->evbit);
1124 __set_bit(EV_ABS, dev->evbit);
Dmitry Torokhovc7a1f3c2009-11-16 22:12:21 -08001125 __clear_bit(EV_REL, dev->evbit);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001126
1127 __set_bit(BTN_LEFT, dev->keybit);
Benjamin Tissoiresfd1cf112019-05-27 18:33:33 -07001128 if (info->has_middle_button)
Ulrik De Bief3864742014-11-13 17:45:12 -08001129 __set_bit(BTN_MIDDLE, dev->keybit);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001130 __set_bit(BTN_RIGHT, dev->keybit);
1131
1132 __set_bit(BTN_TOUCH, dev->keybit);
1133 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1134 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1135 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1136
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001137 switch (info->hw_version) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001138 case 1:
1139 /* Rocker button */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001140 if (info->fw_version < 0x020000 &&
1141 (info->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001142 __set_bit(BTN_FORWARD, dev->keybit);
1143 __set_bit(BTN_BACK, dev->keybit);
1144 }
JJ Ding230282a2011-09-09 10:26:16 -07001145 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1146 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001147 break;
1148
1149 case 2:
Éric Piel22462d9f2010-08-05 23:51:49 -07001150 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
JJ Ding28f49612011-09-09 10:30:31 -07001151 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1152 /* fall through */
1153 case 3:
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001154 if (info->hw_version == 3)
Hans de Goedec15bdfd2013-12-16 07:09:25 -08001155 elantech_set_buttonpad_prop(psmouse);
JJ Ding230282a2011-09-09 10:26:16 -07001156 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1157 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001158 if (info->reports_pressure) {
Éric Pielf941c702011-05-16 22:45:54 -07001159 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1160 ETP_PMAX_V2, 0, 0);
1161 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1162 ETP_WMAX_V2, 0, 0);
1163 }
Benjamin Tissoires6544a1d2016-01-11 17:35:38 -08001164 input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
JJ Ding230282a2011-09-09 10:26:16 -07001165 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1166 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001167 break;
JJ Ding1dc6ede2011-09-09 10:31:58 -07001168
1169 case 4:
Hans de Goedec15bdfd2013-12-16 07:09:25 -08001170 elantech_set_buttonpad_prop(psmouse);
JJ Ding1dc6ede2011-09-09 10:31:58 -07001171 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1172 /* For X to recognize me as touchpad. */
1173 input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1174 input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1175 /*
1176 * range of pressure and width is the same as v2,
1177 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1178 */
1179 input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1180 ETP_PMAX_V2, 0, 0);
1181 input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1182 ETP_WMAX_V2, 0, 0);
1183 /* Multitouch capable pad, up to 5 fingers. */
Henrik Rydbergb4adbbe2012-08-11 22:07:55 +02001184 input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
JJ Ding1dc6ede2011-09-09 10:31:58 -07001185 input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1186 input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1187 input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1188 ETP_PMAX_V2, 0, 0);
1189 /*
1190 * The firmware reports how many trace lines the finger spans,
1191 * convert to surface unit as Protocol-B requires.
1192 */
1193 input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1194 ETP_WMAX_V2 * width, 0, 0);
1195 break;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001196 }
JJ Ding230282a2011-09-09 10:26:16 -07001197
Benjamin Tissoires80212ed2018-05-22 17:27:43 -07001198 input_abs_set_res(dev, ABS_X, info->x_res);
1199 input_abs_set_res(dev, ABS_Y, info->y_res);
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001200 if (info->hw_version > 1) {
Benjamin Tissoires80212ed2018-05-22 17:27:43 -07001201 input_abs_set_res(dev, ABS_MT_POSITION_X, info->x_res);
1202 input_abs_set_res(dev, ABS_MT_POSITION_Y, info->y_res);
Peter Huttererd98399e2015-07-16 10:38:15 -07001203 }
1204
JJ Ding230282a2011-09-09 10:26:16 -07001205 etd->y_max = y_max;
JJ Ding1dc6ede2011-09-09 10:31:58 -07001206 etd->width = width;
JJ Ding28f49612011-09-09 10:30:31 -07001207
1208 return 0;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001209}
1210
1211struct elantech_attr_data {
1212 size_t field_offset;
1213 unsigned char reg;
1214};
1215
1216/*
1217 * Display a register value by reading a sysfs entry
1218 */
1219static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1220 char *buf)
1221{
1222 struct elantech_data *etd = psmouse->private;
1223 struct elantech_attr_data *attr = data;
1224 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1225 int rc = 0;
1226
1227 if (attr->reg)
1228 rc = elantech_read_reg(psmouse, attr->reg, reg);
1229
1230 return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1231}
1232
1233/*
1234 * Write a register value by writing a sysfs entry
1235 */
1236static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1237 void *data, const char *buf, size_t count)
1238{
1239 struct elantech_data *etd = psmouse->private;
1240 struct elantech_attr_data *attr = data;
1241 unsigned char *reg = (unsigned char *) etd + attr->field_offset;
JJ Ding76496e72011-11-09 10:20:14 -08001242 unsigned char value;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001243 int err;
1244
JJ Ding76496e72011-11-09 10:20:14 -08001245 err = kstrtou8(buf, 16, &value);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001246 if (err)
1247 return err;
1248
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001249 /* Do we need to preserve some bits for version 2 hardware too? */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001250 if (etd->info.hw_version == 1) {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001251 if (attr->reg == 0x10)
1252 /* Force absolute mode always on */
1253 value |= ETP_R10_ABSOLUTE_MODE;
1254 else if (attr->reg == 0x11)
1255 /* Force 4 byte mode always on */
1256 value |= ETP_R11_4_BYTE_MODE;
1257 }
1258
1259 if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1260 *reg = value;
1261
1262 return count;
1263}
1264
1265#define ELANTECH_INT_ATTR(_name, _register) \
1266 static struct elantech_attr_data elantech_attr_##_name = { \
1267 .field_offset = offsetof(struct elantech_data, _name), \
1268 .reg = _register, \
1269 }; \
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001270 PSMOUSE_DEFINE_ATTR(_name, 0644, \
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001271 &elantech_attr_##_name, \
1272 elantech_show_int_attr, \
1273 elantech_set_int_attr)
1274
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001275#define ELANTECH_INFO_ATTR(_name) \
1276 static struct elantech_attr_data elantech_attr_##_name = { \
1277 .field_offset = offsetof(struct elantech_data, info) + \
1278 offsetof(struct elantech_device_info, _name), \
1279 .reg = 0, \
1280 }; \
1281 PSMOUSE_DEFINE_ATTR(_name, 0644, \
1282 &elantech_attr_##_name, \
1283 elantech_show_int_attr, \
1284 elantech_set_int_attr)
1285
JJ Ding1dc6ede2011-09-09 10:31:58 -07001286ELANTECH_INT_ATTR(reg_07, 0x07);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001287ELANTECH_INT_ATTR(reg_10, 0x10);
1288ELANTECH_INT_ATTR(reg_11, 0x11);
1289ELANTECH_INT_ATTR(reg_20, 0x20);
1290ELANTECH_INT_ATTR(reg_21, 0x21);
1291ELANTECH_INT_ATTR(reg_22, 0x22);
1292ELANTECH_INT_ATTR(reg_23, 0x23);
1293ELANTECH_INT_ATTR(reg_24, 0x24);
1294ELANTECH_INT_ATTR(reg_25, 0x25);
1295ELANTECH_INT_ATTR(reg_26, 0x26);
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001296ELANTECH_INFO_ATTR(debug);
1297ELANTECH_INFO_ATTR(paritycheck);
1298ELANTECH_INFO_ATTR(crc_enabled);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001299
1300static struct attribute *elantech_attrs[] = {
JJ Ding1dc6ede2011-09-09 10:31:58 -07001301 &psmouse_attr_reg_07.dattr.attr,
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001302 &psmouse_attr_reg_10.dattr.attr,
1303 &psmouse_attr_reg_11.dattr.attr,
1304 &psmouse_attr_reg_20.dattr.attr,
1305 &psmouse_attr_reg_21.dattr.attr,
1306 &psmouse_attr_reg_22.dattr.attr,
1307 &psmouse_attr_reg_23.dattr.attr,
1308 &psmouse_attr_reg_24.dattr.attr,
1309 &psmouse_attr_reg_25.dattr.attr,
1310 &psmouse_attr_reg_26.dattr.attr,
1311 &psmouse_attr_debug.dattr.attr,
1312 &psmouse_attr_paritycheck.dattr.attr,
Ulrik De Bie2d9eb812014-11-13 17:47:04 -08001313 &psmouse_attr_crc_enabled.dattr.attr,
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001314 NULL
1315};
1316
Arvind Yadav57999432017-07-10 20:22:40 -07001317static const struct attribute_group elantech_attr_group = {
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001318 .attrs = elantech_attrs,
1319};
1320
Dmitry Torokhova0836322010-05-19 10:11:13 -07001321static bool elantech_is_signature_valid(const unsigned char *param)
1322{
1323 static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1324 int i;
1325
1326 if (param[0] == 0)
1327 return false;
1328
1329 if (param[1] == 0)
1330 return true;
1331
Hans de Goede271329b2014-09-08 14:39:52 -07001332 /*
Hans de Goede5f0ee9d2015-06-02 10:40:50 -07001333 * Some hw_version >= 4 models have a revision higher then 20. Meaning
1334 * that param[2] may be 10 or 20, skip the rates check for these.
Hans de Goede271329b2014-09-08 14:39:52 -07001335 */
Hans de Goede5f0ee9d2015-06-02 10:40:50 -07001336 if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1337 param[2] < 40)
Hans de Goede271329b2014-09-08 14:39:52 -07001338 return true;
1339
Dmitry Torokhova0836322010-05-19 10:11:13 -07001340 for (i = 0; i < ARRAY_SIZE(rates); i++)
1341 if (param[2] == rates[i])
1342 return false;
1343
1344 return true;
1345}
1346
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001347/*
1348 * Use magic knock to detect Elantech touchpad
1349 */
Dmitry Torokhovb7802c52009-09-09 19:13:20 -07001350int elantech_detect(struct psmouse *psmouse, bool set_properties)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001351{
1352 struct ps2dev *ps2dev = &psmouse->ps2dev;
1353 unsigned char param[3];
1354
Guenter Roeckad568142017-01-21 23:44:46 -08001355 ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001356
1357 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
1358 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1359 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1360 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) ||
1361 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001362 psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001363 return -1;
1364 }
1365
1366 /*
1367 * Report this in case there are Elantech models that use a different
1368 * set of magic numbers
1369 */
JJ Ding28f49612011-09-09 10:30:31 -07001370 if (param[0] != 0x3c || param[1] != 0x03 ||
1371 (param[2] != 0xc8 && param[2] != 0x00)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001372 psmouse_dbg(psmouse,
1373 "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1374 param[0], param[1], param[2]);
Arjan Opmeer9ab7b252009-02-28 13:52:40 -08001375 return -1;
1376 }
1377
1378 /*
1379 * Query touchpad's firmware version and see if it reports known
1380 * value to avoid mis-detection. Logitech mice are known to respond
1381 * to Elantech magic knock and there might be more.
1382 */
1383 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001384 psmouse_dbg(psmouse, "failed to query firmware version.\n");
Arjan Opmeer9ab7b252009-02-28 13:52:40 -08001385 return -1;
1386 }
1387
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001388 psmouse_dbg(psmouse,
1389 "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1390 param[0], param[1], param[2]);
Arjan Opmeer9ab7b252009-02-28 13:52:40 -08001391
Dmitry Torokhova0836322010-05-19 10:11:13 -07001392 if (!elantech_is_signature_valid(param)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001393 psmouse_dbg(psmouse,
1394 "Probably not a real Elantech touchpad. Aborting.\n");
JJ Ding4af61e92011-09-20 22:42:51 -07001395 return -1;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001396 }
1397
1398 if (set_properties) {
1399 psmouse->vendor = "Elantech";
1400 psmouse->name = "Touchpad";
1401 }
1402
1403 return 0;
1404}
1405
1406/*
1407 * Clean up sysfs entries when disconnecting
1408 */
1409static void elantech_disconnect(struct psmouse *psmouse)
1410{
Ulrik De Biea2418fc2014-08-22 17:06:00 -07001411 struct elantech_data *etd = psmouse->private;
1412
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001413 /*
1414 * We might have left a breadcrumb when trying to
1415 * set up SMbus companion.
1416 */
1417 psmouse_smbus_cleanup(psmouse);
1418
Ulrik De Biea2418fc2014-08-22 17:06:00 -07001419 if (etd->tp_dev)
1420 input_unregister_device(etd->tp_dev);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001421 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1422 &elantech_attr_group);
1423 kfree(psmouse->private);
1424 psmouse->private = NULL;
1425}
1426
1427/*
1428 * Put the touchpad back into absolute mode when reconnecting
1429 */
1430static int elantech_reconnect(struct psmouse *psmouse)
1431{
JJ Dinga67ada72012-04-10 00:29:12 -07001432 psmouse_reset(psmouse);
1433
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001434 if (elantech_detect(psmouse, 0))
1435 return -1;
1436
1437 if (elantech_set_absolute_mode(psmouse)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001438 psmouse_err(psmouse,
1439 "failed to put touchpad back into absolute mode.\n");
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001440 return -1;
1441 }
1442
1443 return 0;
1444}
1445
1446/*
Ulrik De Bie0dc15872014-11-07 23:57:34 -08001447 * Some hw_version 4 models do not work with crc_disabled
1448 */
1449static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1450#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1451 {
1452 /* Fujitsu H730 does not work with crc_enabled == 0 */
1453 .matches = {
1454 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1455 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1456 },
1457 },
Rainer Koenig47c1ffb2015-01-27 15:15:11 -08001458 {
Matti Kurkelaf9a703a2016-10-03 16:48:17 -07001459 /* Fujitsu H760 does not work with crc_enabled == 0 */
1460 .matches = {
1461 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1462 DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1463 },
1464 },
1465 {
Dmitry Torokhov62837b32016-10-05 22:49:30 -07001466 /* Fujitsu LIFEBOOK E544 does not work with crc_enabled == 0 */
1467 .matches = {
1468 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1469 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1470 },
1471 },
1472 {
Ulrik De Bie47eb0c82017-06-07 10:30:57 -07001473 /* Fujitsu LIFEBOOK E546 does not work with crc_enabled == 0 */
1474 .matches = {
1475 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1476 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1477 },
1478 },
1479 {
Thorsten Leemhuis704de482017-04-18 11:14:28 -07001480 /* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1481 .matches = {
1482 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1483 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1484 },
1485 },
1486 {
Rainer Koenig47c1ffb2015-01-27 15:15:11 -08001487 /* Fujitsu LIFEBOOK E554 does not work with crc_enabled == 0 */
1488 .matches = {
1489 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1490 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1491 },
1492 },
1493 {
Dmitry Torokhov62837b32016-10-05 22:49:30 -07001494 /* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
Rainer Koenig47c1ffb2015-01-27 15:15:11 -08001495 .matches = {
1496 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
Dmitry Torokhov62837b32016-10-05 22:49:30 -07001497 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
Rainer Koenig47c1ffb2015-01-27 15:15:11 -08001498 },
1499 },
Takashi Iwai60603952015-11-06 11:26:01 -08001500 {
Ulrik De Bie47eb0c82017-06-07 10:30:57 -07001501 /* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1502 .matches = {
1503 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1504 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1505 },
1506 },
1507 {
Takashi Iwai60603952015-11-06 11:26:01 -08001508 /* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1509 .matches = {
1510 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1511 DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1512 },
1513 },
Ulrik De Bie0dc15872014-11-07 23:57:34 -08001514#endif
1515 { }
1516};
1517
1518/*
Hans de Goedefb4f8f52014-06-07 23:07:13 -07001519 * Some hw_version 3 models go into error state when we try to set
1520 * bit 3 and/or bit 1 of r10.
Hans de Goede36189cc2014-05-05 09:36:43 -07001521 */
1522static const struct dmi_system_id no_hw_res_dmi_table[] = {
1523#if defined(CONFIG_DMI) && defined(CONFIG_X86)
1524 {
1525 /* Gigabyte U2442 */
1526 .matches = {
1527 DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1528 DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1529 },
1530 },
1531#endif
1532 { }
1533};
1534
1535/*
JJ Ding3c8bbb92011-09-09 10:28:19 -07001536 * determine hardware version and set some properties according to it.
1537 */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001538static int elantech_set_properties(struct elantech_device_info *info)
JJ Ding3c8bbb92011-09-09 10:28:19 -07001539{
JJ Ding3940d612011-11-08 22:13:14 -08001540 /* This represents the version of IC body. */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001541 int ver = (info->fw_version & 0x0f0000) >> 16;
JJ Ding1dc6ede2011-09-09 10:31:58 -07001542
JJ Ding3940d612011-11-08 22:13:14 -08001543 /* Early version of Elan touchpads doesn't obey the rule. */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001544 if (info->fw_version < 0x020030 || info->fw_version == 0x020600)
1545 info->hw_version = 1;
JJ Ding3940d612011-11-08 22:13:14 -08001546 else {
1547 switch (ver) {
1548 case 2:
1549 case 4:
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001550 info->hw_version = 2;
JJ Ding3940d612011-11-08 22:13:14 -08001551 break;
1552 case 5:
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001553 info->hw_version = 3;
JJ Ding3940d612011-11-08 22:13:14 -08001554 break;
Aaron Ma10d90032017-11-25 16:48:41 -08001555 case 6 ... 15:
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001556 info->hw_version = 4;
JJ Ding3940d612011-11-08 22:13:14 -08001557 break;
1558 default:
1559 return -1;
1560 }
1561 }
JJ Ding3c8bbb92011-09-09 10:28:19 -07001562
JJ Dingb56b92a2011-11-20 22:21:45 -08001563 /* decide which send_cmd we're gonna use early */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001564 info->send_cmd = info->hw_version >= 3 ? elantech_send_cmd :
1565 synaptics_send_cmd;
JJ Dingb56b92a2011-11-20 22:21:45 -08001566
1567 /* Turn on packet checking by default */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001568 info->paritycheck = 1;
JJ Ding3c8bbb92011-09-09 10:28:19 -07001569
1570 /*
1571 * This firmware suffers from misreporting coordinates when
1572 * a touch action starts causing the mouse cursor or scrolled page
1573 * to jump. Enable a workaround.
1574 */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001575 info->jumpy_cursor =
1576 (info->fw_version == 0x020022 || info->fw_version == 0x020600);
JJ Ding3c8bbb92011-09-09 10:28:19 -07001577
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001578 if (info->hw_version > 1) {
JJ Ding3c8bbb92011-09-09 10:28:19 -07001579 /* For now show extra debug information */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001580 info->debug = 1;
JJ Ding3c8bbb92011-09-09 10:28:19 -07001581
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001582 if (info->fw_version >= 0x020800)
1583 info->reports_pressure = true;
JJ Ding3c8bbb92011-09-09 10:28:19 -07001584 }
JJ Ding28f49612011-09-09 10:30:31 -07001585
Matteo Delfinoacc04442013-08-15 00:09:41 -07001586 /*
1587 * The signatures of v3 and v4 packets change depending on the
1588 * value of this hardware flag.
1589 */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001590 info->crc_enabled = (info->fw_version & 0x4000) == 0x4000 ||
1591 dmi_check_system(elantech_dmi_force_crc_enabled);
Matteo Delfinoacc04442013-08-15 00:09:41 -07001592
Hans de Goede36189cc2014-05-05 09:36:43 -07001593 /* Enable real hardware resolution on hw_version 3 ? */
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001594 info->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
Hans de Goede36189cc2014-05-05 09:36:43 -07001595
JJ Ding28f49612011-09-09 10:30:31 -07001596 return 0;
JJ Ding3c8bbb92011-09-09 10:28:19 -07001597}
1598
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001599static int elantech_query_info(struct psmouse *psmouse,
1600 struct elantech_device_info *info)
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001601{
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001602 unsigned char param[3];
Benjamin Tissoires37548652019-05-27 18:24:28 -07001603 unsigned char traces;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001604
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001605 memset(info, 0, sizeof(*info));
1606
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001607 /*
Arjan Opmeer9ab7b252009-02-28 13:52:40 -08001608 * Do the version query again so we can store the result
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001609 */
1610 if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001611 psmouse_err(psmouse, "failed to query firmware version.\n");
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001612 return -EINVAL;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001613 }
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001614 info->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
JJ Ding28f49612011-09-09 10:30:31 -07001615
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001616 if (elantech_set_properties(info)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001617 psmouse_err(psmouse, "unknown hardware version, aborting...\n");
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001618 return -EINVAL;
JJ Ding28f49612011-09-09 10:30:31 -07001619 }
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001620 psmouse_info(psmouse,
1621 "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001622 info->hw_version, param[0], param[1], param[2]);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001623
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001624 if (info->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1625 info->capabilities)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001626 psmouse_err(psmouse, "failed to query capabilities.\n");
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001627 return -EINVAL;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001628 }
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001629 psmouse_info(psmouse,
1630 "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001631 info->capabilities[0], info->capabilities[1],
1632 info->capabilities[2]);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001633
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001634 if (info->hw_version != 1) {
1635 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, info->samples)) {
Duson Lin6b30c732015-08-07 14:37:24 -07001636 psmouse_err(psmouse, "failed to query sample data\n");
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001637 return -EINVAL;
Duson Lin6b30c732015-08-07 14:37:24 -07001638 }
1639 psmouse_info(psmouse,
1640 "Elan sample query result %02x, %02x, %02x\n",
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001641 info->samples[0],
1642 info->samples[1],
1643 info->samples[2]);
Duson Lin6b30c732015-08-07 14:37:24 -07001644 }
1645
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001646 if (info->samples[1] == 0x74 && info->hw_version == 0x03) {
KT Liaod8995202016-12-12 11:03:42 -08001647 /*
1648 * This module has a bug which makes absolute mode
1649 * unusable, so let's abort so we'll be using standard
1650 * PS/2 protocol.
1651 */
1652 psmouse_info(psmouse,
1653 "absolute mode broken, forcing standard PS/2 protocol\n");
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001654 return -ENODEV;
KT Liaod8995202016-12-12 11:03:42 -08001655 }
1656
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001657 /* The MSB indicates the presence of the trackpoint */
1658 info->has_trackpoint = (info->capabilities[0] & 0x80) == 0x80;
1659
Benjamin Tissoires80212ed2018-05-22 17:27:43 -07001660 info->x_res = 31;
1661 info->y_res = 31;
1662 if (info->hw_version == 4) {
1663 if (elantech_get_resolution_v4(psmouse,
1664 &info->x_res,
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001665 &info->y_res,
1666 &info->bus)) {
Benjamin Tissoires80212ed2018-05-22 17:27:43 -07001667 psmouse_warn(psmouse,
1668 "failed to query resolution data.\n");
1669 }
1670 }
1671
Benjamin Tissoires37548652019-05-27 18:24:28 -07001672 /* query range information */
1673 switch (info->hw_version) {
1674 case 1:
1675 info->x_min = ETP_XMIN_V1;
1676 info->y_min = ETP_YMIN_V1;
1677 info->x_max = ETP_XMAX_V1;
1678 info->y_max = ETP_YMAX_V1;
1679 break;
1680
1681 case 2:
1682 if (info->fw_version == 0x020800 ||
1683 info->fw_version == 0x020b00 ||
1684 info->fw_version == 0x020030) {
1685 info->x_min = ETP_XMIN_V2;
1686 info->y_min = ETP_YMIN_V2;
1687 info->x_max = ETP_XMAX_V2;
1688 info->y_max = ETP_YMAX_V2;
1689 } else {
1690 int i;
1691 int fixed_dpi;
1692
1693 i = (info->fw_version > 0x020800 &&
1694 info->fw_version < 0x020900) ? 1 : 2;
1695
1696 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1697 return -EINVAL;
1698
1699 fixed_dpi = param[1] & 0x10;
1700
1701 if (((info->fw_version >> 16) == 0x14) && fixed_dpi) {
1702 if (info->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
1703 return -EINVAL;
1704
1705 info->x_max = (info->capabilities[1] - i) * param[1] / 2;
1706 info->y_max = (info->capabilities[2] - i) * param[2] / 2;
1707 } else if (info->fw_version == 0x040216) {
1708 info->x_max = 819;
1709 info->y_max = 405;
1710 } else if (info->fw_version == 0x040219 || info->fw_version == 0x040215) {
1711 info->x_max = 900;
1712 info->y_max = 500;
1713 } else {
1714 info->x_max = (info->capabilities[1] - i) * 64;
1715 info->y_max = (info->capabilities[2] - i) * 64;
1716 }
1717 }
1718 break;
1719
1720 case 3:
1721 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1722 return -EINVAL;
1723
1724 info->x_max = (0x0f & param[0]) << 8 | param[1];
1725 info->y_max = (0xf0 & param[0]) << 4 | param[2];
1726 break;
1727
1728 case 4:
1729 if (info->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1730 return -EINVAL;
1731
1732 info->x_max = (0x0f & param[0]) << 8 | param[1];
1733 info->y_max = (0xf0 & param[0]) << 4 | param[2];
1734 traces = info->capabilities[1];
1735 if ((traces < 2) || (traces > info->x_max))
1736 return -EINVAL;
1737
1738 info->width = info->x_max / (traces - 1);
Benjamin Tissoires3abcc532019-05-27 18:43:49 -07001739
1740 /* column number of traces */
1741 info->x_traces = traces;
1742
1743 /* row number of traces */
1744 traces = info->capabilities[2];
1745 if ((traces >= 2) && (traces <= info->y_max))
1746 info->y_traces = traces;
1747
Benjamin Tissoires37548652019-05-27 18:24:28 -07001748 break;
1749 }
1750
Benjamin Tissoiresfd1cf112019-05-27 18:33:33 -07001751 /* check for the middle button: DMI matching or new v4 firmwares */
1752 info->has_middle_button = dmi_check_system(elantech_dmi_has_middle_button) ||
1753 (ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version) &&
1754 !elantech_is_buttonpad(info));
1755
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001756 return 0;
1757}
1758
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001759#if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
1760
1761/*
1762 * The newest Elantech device can use a secondary bus (over SMBus) which
1763 * provides a better bandwidth and allow a better control of the touchpads.
1764 * This is used to decide if we need to use this bus or not.
1765 */
1766enum {
1767 ELANTECH_SMBUS_NOT_SET = -1,
1768 ELANTECH_SMBUS_OFF,
1769 ELANTECH_SMBUS_ON,
1770};
1771
1772static int elantech_smbus = IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ?
1773 ELANTECH_SMBUS_NOT_SET : ELANTECH_SMBUS_OFF;
1774module_param_named(elantech_smbus, elantech_smbus, int, 0644);
1775MODULE_PARM_DESC(elantech_smbus, "Use a secondary bus for the Elantech device.");
1776
Benjamin Tissoiresd21ff5d2018-12-21 00:42:38 -08001777static const char * const i2c_blacklist_pnp_ids[] = {
1778 /*
1779 * These are known to not be working properly as bits are missing
1780 * in elan_i2c.
1781 */
1782 "LEN2131", /* ThinkPad P52 w/ NFC */
1783 "LEN2132", /* ThinkPad P52 */
1784 "LEN2133", /* ThinkPad P72 w/ NFC */
1785 "LEN2134", /* ThinkPad P72 */
1786 NULL
1787};
1788
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001789static int elantech_create_smbus(struct psmouse *psmouse,
1790 struct elantech_device_info *info,
1791 bool leave_breadcrumbs)
1792{
Benjamin Tissoires3abcc532019-05-27 18:43:49 -07001793 struct property_entry i2c_props[11] = {};
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001794 struct i2c_board_info smbus_board = {
1795 I2C_BOARD_INFO("elan_i2c", 0x15),
1796 .flags = I2C_CLIENT_HOST_NOTIFY,
1797 };
Benjamin Tissoires3abcc532019-05-27 18:43:49 -07001798 unsigned int idx = 0;
1799
1800 smbus_board.properties = i2c_props;
1801
1802 i2c_props[idx++] = PROPERTY_ENTRY_U32("touchscreen-size-x",
1803 info->x_max + 1);
1804 i2c_props[idx++] = PROPERTY_ENTRY_U32("touchscreen-size-y",
1805 info->y_max + 1);
1806 i2c_props[idx++] = PROPERTY_ENTRY_U32("touchscreen-min-x",
1807 info->x_min);
1808 i2c_props[idx++] = PROPERTY_ENTRY_U32("touchscreen-min-y",
1809 info->y_min);
1810 if (info->x_res)
1811 i2c_props[idx++] = PROPERTY_ENTRY_U32("touchscreen-x-mm",
1812 (info->x_max + 1) / info->x_res);
1813 if (info->y_res)
1814 i2c_props[idx++] = PROPERTY_ENTRY_U32("touchscreen-y-mm",
1815 (info->y_max + 1) / info->y_res);
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001816
1817 if (info->has_trackpoint)
Benjamin Tissoires3abcc532019-05-27 18:43:49 -07001818 i2c_props[idx++] = PROPERTY_ENTRY_BOOL("elan,trackpoint");
1819
1820 if (info->has_middle_button)
1821 i2c_props[idx++] = PROPERTY_ENTRY_BOOL("elan,middle-button");
1822
1823 if (info->x_traces)
1824 i2c_props[idx++] = PROPERTY_ENTRY_U32("elan,x_traces",
1825 info->x_traces);
1826 if (info->y_traces)
1827 i2c_props[idx++] = PROPERTY_ENTRY_U32("elan,y_traces",
1828 info->y_traces);
1829
1830 if (elantech_is_buttonpad(info))
1831 i2c_props[idx++] = PROPERTY_ENTRY_BOOL("elan,clickpad");
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001832
Benjamin Tissoiresbf232e42018-05-22 17:30:31 -07001833 return psmouse_smbus_init(psmouse, &smbus_board, NULL, 0, false,
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001834 leave_breadcrumbs);
1835}
1836
1837/**
1838 * elantech_setup_smbus - called once the PS/2 devices are enumerated
1839 * and decides to instantiate a SMBus InterTouch device.
1840 */
1841static int elantech_setup_smbus(struct psmouse *psmouse,
1842 struct elantech_device_info *info,
1843 bool leave_breadcrumbs)
1844{
1845 int error;
1846
1847 if (elantech_smbus == ELANTECH_SMBUS_OFF)
1848 return -ENXIO;
1849
1850 if (elantech_smbus == ELANTECH_SMBUS_NOT_SET) {
1851 /*
Benjamin Tissoiresd21ff5d2018-12-21 00:42:38 -08001852 * New ICs are enabled by default, unless mentioned in
1853 * i2c_blacklist_pnp_ids.
Benjamin Tissoiresdf077232018-05-22 17:30:07 -07001854 * Old ICs are up to the user to decide.
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001855 */
Benjamin Tissoiresd21ff5d2018-12-21 00:42:38 -08001856 if (!ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version) ||
1857 psmouse_matches_pnp_id(psmouse, i2c_blacklist_pnp_ids))
Benjamin Tissoiresdf077232018-05-22 17:30:07 -07001858 return -ENXIO;
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001859 }
1860
1861 psmouse_info(psmouse, "Trying to set up SMBus access\n");
1862
1863 error = elantech_create_smbus(psmouse, info, leave_breadcrumbs);
1864 if (error) {
1865 if (error == -EAGAIN)
1866 psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1867 else
1868 psmouse_err(psmouse, "unable to create intertouch device\n");
1869
1870 return error;
1871 }
1872
1873 return 0;
1874}
1875
1876static bool elantech_use_host_notify(struct psmouse *psmouse,
1877 struct elantech_device_info *info)
1878{
Benjamin Tissoiresdf077232018-05-22 17:30:07 -07001879 if (ETP_NEW_IC_SMBUS_HOST_NOTIFY(info->fw_version))
1880 return true;
1881
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001882 switch (info->bus) {
1883 case ETP_BUS_PS2_ONLY:
1884 /* expected case */
1885 break;
1886 case ETP_BUS_SMB_ALERT_ONLY:
1887 /* fall-through */
1888 case ETP_BUS_PS2_SMB_ALERT:
1889 psmouse_dbg(psmouse, "Ignoring SMBus provider through alert protocol.\n");
1890 break;
1891 case ETP_BUS_SMB_HST_NTFY_ONLY:
1892 /* fall-through */
1893 case ETP_BUS_PS2_SMB_HST_NTFY:
1894 return true;
1895 default:
1896 psmouse_dbg(psmouse,
1897 "Ignoring SMBus bus provider %d.\n",
1898 info->bus);
1899 }
1900
1901 return false;
1902}
1903
1904int elantech_init_smbus(struct psmouse *psmouse)
1905{
1906 struct elantech_device_info info;
1907 int error = -EINVAL;
1908
1909 psmouse_reset(psmouse);
1910
1911 error = elantech_query_info(psmouse, &info);
1912 if (error)
1913 goto init_fail;
1914
1915 if (info.hw_version < 4) {
1916 error = -ENXIO;
1917 goto init_fail;
1918 }
1919
1920 return elantech_create_smbus(psmouse, &info, false);
1921 init_fail:
1922 psmouse_reset(psmouse);
1923 return error;
1924}
1925#endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
1926
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001927/*
1928 * Initialize the touchpad and create sysfs entries
1929 */
1930static int elantech_setup_ps2(struct psmouse *psmouse,
1931 struct elantech_device_info *info)
1932{
1933 struct elantech_data *etd;
1934 int i;
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07001935 int error = -EINVAL;
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001936 struct input_dev *tp_dev;
1937
1938 psmouse->private = etd = kzalloc(sizeof(*etd), GFP_KERNEL);
1939 if (!etd)
1940 return -ENOMEM;
1941
1942 etd->info = *info;
1943
1944 etd->parity[0] = 1;
1945 for (i = 1; i < 256; i++)
1946 etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1947
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001948 if (elantech_set_absolute_mode(psmouse)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001949 psmouse_err(psmouse,
1950 "failed to put touchpad into absolute mode.\n");
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001951 goto init_fail;
1952 }
1953
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001954 if (info->fw_version == 0x381f17) {
Ulrik De Biebd884142015-04-06 15:35:38 -07001955 etd->original_set_rate = psmouse->set_rate;
1956 psmouse->set_rate = elantech_set_rate_restore_reg_07;
1957 }
1958
JJ Ding28f49612011-09-09 10:30:31 -07001959 if (elantech_set_input_params(psmouse)) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001960 psmouse_err(psmouse, "failed to query touchpad range.\n");
JJ Ding28f49612011-09-09 10:30:31 -07001961 goto init_fail;
1962 }
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001963
1964 error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1965 &elantech_attr_group);
1966 if (error) {
Dmitry Torokhovb5d21702011-10-10 18:27:03 -07001967 psmouse_err(psmouse,
1968 "failed to create sysfs attributes, error: %d.\n",
1969 error);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04001970 goto init_fail;
1971 }
1972
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07001973 if (info->has_trackpoint) {
Ulrik De Biea2418fc2014-08-22 17:06:00 -07001974 tp_dev = input_allocate_device();
1975
1976 if (!tp_dev) {
1977 error = -ENOMEM;
1978 goto init_fail_tp_alloc;
1979 }
1980
1981 etd->tp_dev = tp_dev;
1982 snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1983 psmouse->ps2dev.serio->phys);
1984 tp_dev->phys = etd->tp_phys;
Pali Rohár9096a452016-06-18 10:09:43 -07001985 tp_dev->name = "ETPS/2 Elantech TrackPoint";
Ulrik De Biea2418fc2014-08-22 17:06:00 -07001986 tp_dev->id.bustype = BUS_I8042;
1987 tp_dev->id.vendor = 0x0002;
1988 tp_dev->id.product = PSMOUSE_ELANTECH;
1989 tp_dev->id.version = 0x0000;
1990 tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1991 tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1992 tp_dev->relbit[BIT_WORD(REL_X)] =
1993 BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1994 tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1995 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1996 BIT_MASK(BTN_RIGHT);
Hans de Goede76113922014-09-08 14:42:12 -07001997
Hans de Goede01d4cd52014-09-08 14:44:05 -07001998 __set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
Hans de Goede76113922014-09-08 14:42:12 -07001999 __set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
2000
Ulrik De Biea2418fc2014-08-22 17:06:00 -07002001 error = input_register_device(etd->tp_dev);
2002 if (error < 0)
2003 goto init_fail_tp_reg;
2004 }
2005
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04002006 psmouse->protocol_handler = elantech_process_byte;
2007 psmouse->disconnect = elantech_disconnect;
2008 psmouse->reconnect = elantech_reconnect;
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07002009 psmouse->pktsize = info->hw_version > 1 ? 6 : 4;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04002010
2011 return 0;
Ulrik De Biea2418fc2014-08-22 17:06:00 -07002012 init_fail_tp_reg:
2013 input_free_device(tp_dev);
2014 init_fail_tp_alloc:
2015 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
2016 &elantech_attr_group);
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04002017 init_fail:
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04002018 kfree(etd);
Ulrik De Biea2418fc2014-08-22 17:06:00 -07002019 return error;
Arjan Opmeer2a0bd752008-10-16 22:10:19 -04002020}
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07002021
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07002022int elantech_init_ps2(struct psmouse *psmouse)
Benjamin Tissoiresf0787592018-05-22 17:26:24 -07002023{
2024 struct elantech_device_info info;
2025 int error = -EINVAL;
2026
2027 psmouse_reset(psmouse);
2028
2029 error = elantech_query_info(psmouse, &info);
2030 if (error)
2031 goto init_fail;
2032
2033 error = elantech_setup_ps2(psmouse, &info);
2034 if (error)
2035 goto init_fail;
2036
2037 return 0;
2038 init_fail:
2039 psmouse_reset(psmouse);
2040 return error;
2041}
Benjamin Tissoires21c48db2018-05-22 17:28:23 -07002042
2043int elantech_init(struct psmouse *psmouse)
2044{
2045 struct elantech_device_info info;
2046 int error = -EINVAL;
2047
2048 psmouse_reset(psmouse);
2049
2050 error = elantech_query_info(psmouse, &info);
2051 if (error)
2052 goto init_fail;
2053
2054#if defined(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)
2055
2056 if (elantech_use_host_notify(psmouse, &info)) {
2057 if (!IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) ||
2058 !IS_ENABLED(CONFIG_MOUSE_PS2_ELANTECH_SMBUS)) {
2059 psmouse_warn(psmouse,
2060 "The touchpad can support a better bus than the too old PS/2 protocol. "
2061 "Make sure MOUSE_PS2_ELANTECH_SMBUS and MOUSE_ELAN_I2C_SMBUS are enabled to get a better touchpad experience.\n");
2062 }
2063 error = elantech_setup_smbus(psmouse, &info, true);
2064 if (!error)
2065 return PSMOUSE_ELANTECH_SMBUS;
2066 }
2067
2068#endif /* CONFIG_MOUSE_PS2_ELANTECH_SMBUS */
2069
2070 error = elantech_setup_ps2(psmouse, &info);
2071 if (error < 0) {
2072 /*
2073 * Not using any flavor of Elantech support, so clean up
2074 * SMbus breadcrumbs, if any.
2075 */
2076 psmouse_smbus_cleanup(psmouse);
2077 goto init_fail;
2078 }
2079
2080 return PSMOUSE_ELANTECH;
2081 init_fail:
2082 psmouse_reset(psmouse);
2083 return error;
2084}