• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Elantech Touchpad driver (v6)
3  *
4  * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
5  *
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>
14 #include <linux/dmi.h>
15 #include <linux/slab.h>
16 #include <linux/module.h>
17 #include <linux/input.h>
18 #include <linux/input/mt.h>
19 #include <linux/serio.h>
20 #include <linux/libps2.h>
21 #include <asm/unaligned.h>
22 #include "psmouse.h"
23 #include "elantech.h"
24 
25 #define elantech_debug(fmt, ...)					\
26 	do {								\
27 		if (etd->debug)						\
28 			psmouse_printk(KERN_DEBUG, psmouse,		\
29 					fmt, ##__VA_ARGS__);		\
30 	} while (0)
31 
32 /*
33  * Send a Synaptics style sliced query command
34  */
synaptics_send_cmd(struct psmouse * psmouse,unsigned char c,unsigned char * param)35 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c,
36 				unsigned char *param)
37 {
38 	if (psmouse_sliced_command(psmouse, c) ||
39 	    ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
40 		psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
41 		return -1;
42 	}
43 
44 	return 0;
45 }
46 
47 /*
48  * V3 and later support this fast command
49  */
elantech_send_cmd(struct psmouse * psmouse,unsigned char c,unsigned char * param)50 static int elantech_send_cmd(struct psmouse *psmouse, unsigned char c,
51 				unsigned char *param)
52 {
53 	struct ps2dev *ps2dev = &psmouse->ps2dev;
54 
55 	if (ps2_command(ps2dev, NULL, ETP_PS2_CUSTOM_COMMAND) ||
56 	    ps2_command(ps2dev, NULL, c) ||
57 	    ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
58 		psmouse_err(psmouse, "%s query 0x%02x failed.\n", __func__, c);
59 		return -1;
60 	}
61 
62 	return 0;
63 }
64 
65 /*
66  * A retrying version of ps2_command
67  */
elantech_ps2_command(struct psmouse * psmouse,unsigned char * param,int command)68 static int elantech_ps2_command(struct psmouse *psmouse,
69 				unsigned char *param, int command)
70 {
71 	struct ps2dev *ps2dev = &psmouse->ps2dev;
72 	struct elantech_data *etd = psmouse->private;
73 	int rc;
74 	int tries = ETP_PS2_COMMAND_TRIES;
75 
76 	do {
77 		rc = ps2_command(ps2dev, param, command);
78 		if (rc == 0)
79 			break;
80 		tries--;
81 		elantech_debug("retrying ps2 command 0x%02x (%d).\n",
82 				command, tries);
83 		msleep(ETP_PS2_COMMAND_DELAY);
84 	} while (tries > 0);
85 
86 	if (rc)
87 		psmouse_err(psmouse, "ps2 command 0x%02x failed.\n", command);
88 
89 	return rc;
90 }
91 
92 /*
93  * Send an Elantech style special command to read a value from a register
94  */
elantech_read_reg(struct psmouse * psmouse,unsigned char reg,unsigned char * val)95 static int elantech_read_reg(struct psmouse *psmouse, unsigned char reg,
96 				unsigned char *val)
97 {
98 	struct elantech_data *etd = psmouse->private;
99 	unsigned char param[3];
100 	int rc = 0;
101 
102 	if (reg < 0x07 || reg > 0x26)
103 		return -1;
104 
105 	if (reg > 0x11 && reg < 0x20)
106 		return -1;
107 
108 	switch (etd->hw_version) {
109 	case 1:
110 		if (psmouse_sliced_command(psmouse, ETP_REGISTER_READ) ||
111 		    psmouse_sliced_command(psmouse, reg) ||
112 		    ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) {
113 			rc = -1;
114 		}
115 		break;
116 
117 	case 2:
118 		if (elantech_ps2_command(psmouse,  NULL, ETP_PS2_CUSTOM_COMMAND) ||
119 		    elantech_ps2_command(psmouse,  NULL, ETP_REGISTER_READ) ||
120 		    elantech_ps2_command(psmouse,  NULL, ETP_PS2_CUSTOM_COMMAND) ||
121 		    elantech_ps2_command(psmouse,  NULL, reg) ||
122 		    elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
123 			rc = -1;
124 		}
125 		break;
126 
127 	case 3 ... 4:
128 		if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
129 		    elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
130 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
131 		    elantech_ps2_command(psmouse, NULL, reg) ||
132 		    elantech_ps2_command(psmouse, param, PSMOUSE_CMD_GETINFO)) {
133 			rc = -1;
134 		}
135 		break;
136 	}
137 
138 	if (rc)
139 		psmouse_err(psmouse, "failed to read register 0x%02x.\n", reg);
140 	else if (etd->hw_version != 4)
141 		*val = param[0];
142 	else
143 		*val = param[1];
144 
145 	return rc;
146 }
147 
148 /*
149  * Send an Elantech style special command to write a register with a value
150  */
elantech_write_reg(struct psmouse * psmouse,unsigned char reg,unsigned char val)151 static int elantech_write_reg(struct psmouse *psmouse, unsigned char reg,
152 				unsigned char val)
153 {
154 	struct elantech_data *etd = psmouse->private;
155 	int rc = 0;
156 
157 	if (reg < 0x07 || reg > 0x26)
158 		return -1;
159 
160 	if (reg > 0x11 && reg < 0x20)
161 		return -1;
162 
163 	switch (etd->hw_version) {
164 	case 1:
165 		if (psmouse_sliced_command(psmouse, ETP_REGISTER_WRITE) ||
166 		    psmouse_sliced_command(psmouse, reg) ||
167 		    psmouse_sliced_command(psmouse, val) ||
168 		    ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) {
169 			rc = -1;
170 		}
171 		break;
172 
173 	case 2:
174 		if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
175 		    elantech_ps2_command(psmouse, NULL, ETP_REGISTER_WRITE) ||
176 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
177 		    elantech_ps2_command(psmouse, NULL, reg) ||
178 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
179 		    elantech_ps2_command(psmouse, NULL, val) ||
180 		    elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
181 			rc = -1;
182 		}
183 		break;
184 
185 	case 3:
186 		if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
187 		    elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
188 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
189 		    elantech_ps2_command(psmouse, NULL, reg) ||
190 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
191 		    elantech_ps2_command(psmouse, NULL, val) ||
192 		    elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
193 			rc = -1;
194 		}
195 		break;
196 
197 	case 4:
198 		if (elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
199 		    elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
200 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
201 		    elantech_ps2_command(psmouse, NULL, reg) ||
202 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
203 		    elantech_ps2_command(psmouse, NULL, ETP_REGISTER_READWRITE) ||
204 		    elantech_ps2_command(psmouse, NULL, ETP_PS2_CUSTOM_COMMAND) ||
205 		    elantech_ps2_command(psmouse, NULL, val) ||
206 		    elantech_ps2_command(psmouse, NULL, PSMOUSE_CMD_SETSCALE11)) {
207 			rc = -1;
208 		}
209 		break;
210 	}
211 
212 	if (rc)
213 		psmouse_err(psmouse,
214 			    "failed to write register 0x%02x with value 0x%02x.\n",
215 			    reg, val);
216 
217 	return rc;
218 }
219 
220 /*
221  * Dump a complete mouse movement packet to the syslog
222  */
elantech_packet_dump(struct psmouse * psmouse)223 static void elantech_packet_dump(struct psmouse *psmouse)
224 {
225 	int	i;
226 
227 	psmouse_printk(KERN_DEBUG, psmouse, "PS/2 packet [");
228 	for (i = 0; i < psmouse->pktsize; i++)
229 		printk("%s0x%02x ", i ? ", " : " ", psmouse->packet[i]);
230 	printk("]\n");
231 }
232 
233 /*
234  * Interpret complete data packets and report absolute mode input events for
235  * hardware version 1. (4 byte packets)
236  */
elantech_report_absolute_v1(struct psmouse * psmouse)237 static void elantech_report_absolute_v1(struct psmouse *psmouse)
238 {
239 	struct input_dev *dev = psmouse->dev;
240 	struct elantech_data *etd = psmouse->private;
241 	unsigned char *packet = psmouse->packet;
242 	int fingers;
243 
244 	if (etd->fw_version < 0x020000) {
245 		/*
246 		 * byte 0:  D   U  p1  p2   1  p3   R   L
247 		 * byte 1:  f   0  th  tw  x9  x8  y9  y8
248 		 */
249 		fingers = ((packet[1] & 0x80) >> 7) +
250 				((packet[1] & 0x30) >> 4);
251 	} else {
252 		/*
253 		 * byte 0: n1  n0  p2  p1   1  p3   R   L
254 		 * byte 1:  0   0   0   0  x9  x8  y9  y8
255 		 */
256 		fingers = (packet[0] & 0xc0) >> 6;
257 	}
258 
259 	if (etd->jumpy_cursor) {
260 		if (fingers != 1) {
261 			etd->single_finger_reports = 0;
262 		} else if (etd->single_finger_reports < 2) {
263 			/* Discard first 2 reports of one finger, bogus */
264 			etd->single_finger_reports++;
265 			elantech_debug("discarding packet\n");
266 			return;
267 		}
268 	}
269 
270 	input_report_key(dev, BTN_TOUCH, fingers != 0);
271 
272 	/*
273 	 * byte 2: x7  x6  x5  x4  x3  x2  x1  x0
274 	 * byte 3: y7  y6  y5  y4  y3  y2  y1  y0
275 	 */
276 	if (fingers) {
277 		input_report_abs(dev, ABS_X,
278 			((packet[1] & 0x0c) << 6) | packet[2]);
279 		input_report_abs(dev, ABS_Y,
280 			etd->y_max - (((packet[1] & 0x03) << 8) | packet[3]));
281 	}
282 
283 	input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
284 	input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
285 	input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
286 	input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
287 	input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
288 
289 	if (etd->fw_version < 0x020000 &&
290 	    (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
291 		/* rocker up */
292 		input_report_key(dev, BTN_FORWARD, packet[0] & 0x40);
293 		/* rocker down */
294 		input_report_key(dev, BTN_BACK, packet[0] & 0x80);
295 	}
296 
297 	input_sync(dev);
298 }
299 
elantech_set_slot(struct input_dev * dev,int slot,bool active,unsigned int x,unsigned int y)300 static void elantech_set_slot(struct input_dev *dev, int slot, bool active,
301 			      unsigned int x, unsigned int y)
302 {
303 	input_mt_slot(dev, slot);
304 	input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
305 	if (active) {
306 		input_report_abs(dev, ABS_MT_POSITION_X, x);
307 		input_report_abs(dev, ABS_MT_POSITION_Y, y);
308 	}
309 }
310 
311 /* x1 < x2 and y1 < y2 when two fingers, x = y = 0 when not pressed */
elantech_report_semi_mt_data(struct input_dev * dev,unsigned int num_fingers,unsigned int x1,unsigned int y1,unsigned int x2,unsigned int y2)312 static void elantech_report_semi_mt_data(struct input_dev *dev,
313 					 unsigned int num_fingers,
314 					 unsigned int x1, unsigned int y1,
315 					 unsigned int x2, unsigned int y2)
316 {
317 	elantech_set_slot(dev, 0, num_fingers != 0, x1, y1);
318 	elantech_set_slot(dev, 1, num_fingers >= 2, x2, y2);
319 }
320 
321 /*
322  * Interpret complete data packets and report absolute mode input events for
323  * hardware version 2. (6 byte packets)
324  */
elantech_report_absolute_v2(struct psmouse * psmouse)325 static void elantech_report_absolute_v2(struct psmouse *psmouse)
326 {
327 	struct elantech_data *etd = psmouse->private;
328 	struct input_dev *dev = psmouse->dev;
329 	unsigned char *packet = psmouse->packet;
330 	unsigned int fingers, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
331 	unsigned int width = 0, pres = 0;
332 
333 	/* byte 0: n1  n0   .   .   .   .   R   L */
334 	fingers = (packet[0] & 0xc0) >> 6;
335 
336 	switch (fingers) {
337 	case 3:
338 		/*
339 		 * Same as one finger, except report of more than 3 fingers:
340 		 * byte 3:  n4  .   w1  w0   .   .   .   .
341 		 */
342 		if (packet[3] & 0x80)
343 			fingers = 4;
344 		/* pass through... */
345 	case 1:
346 		/*
347 		 * byte 1:  .   .   .   .  x11 x10 x9  x8
348 		 * byte 2: x7  x6  x5  x4  x4  x2  x1  x0
349 		 */
350 		x1 = ((packet[1] & 0x0f) << 8) | packet[2];
351 		/*
352 		 * byte 4:  .   .   .   .  y11 y10 y9  y8
353 		 * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
354 		 */
355 		y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
356 
357 		pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
358 		width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
359 		break;
360 
361 	case 2:
362 		/*
363 		 * The coordinate of each finger is reported separately
364 		 * with a lower resolution for two finger touches:
365 		 * byte 0:  .   .  ay8 ax8  .   .   .   .
366 		 * byte 1: ax7 ax6 ax5 ax4 ax3 ax2 ax1 ax0
367 		 */
368 		x1 = (((packet[0] & 0x10) << 4) | packet[1]) << 2;
369 		/* byte 2: ay7 ay6 ay5 ay4 ay3 ay2 ay1 ay0 */
370 		y1 = etd->y_max -
371 			((((packet[0] & 0x20) << 3) | packet[2]) << 2);
372 		/*
373 		 * byte 3:  .   .  by8 bx8  .   .   .   .
374 		 * byte 4: bx7 bx6 bx5 bx4 bx3 bx2 bx1 bx0
375 		 */
376 		x2 = (((packet[3] & 0x10) << 4) | packet[4]) << 2;
377 		/* byte 5: by7 by8 by5 by4 by3 by2 by1 by0 */
378 		y2 = etd->y_max -
379 			((((packet[3] & 0x20) << 3) | packet[5]) << 2);
380 
381 		/* Unknown so just report sensible values */
382 		pres = 127;
383 		width = 7;
384 		break;
385 	}
386 
387 	input_report_key(dev, BTN_TOUCH, fingers != 0);
388 	if (fingers != 0) {
389 		input_report_abs(dev, ABS_X, x1);
390 		input_report_abs(dev, ABS_Y, y1);
391 	}
392 	elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
393 	input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
394 	input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
395 	input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
396 	input_report_key(dev, BTN_TOOL_QUADTAP, fingers == 4);
397 	input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
398 	input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
399 	if (etd->reports_pressure) {
400 		input_report_abs(dev, ABS_PRESSURE, pres);
401 		input_report_abs(dev, ABS_TOOL_WIDTH, width);
402 	}
403 
404 	input_sync(dev);
405 }
406 
elantech_report_trackpoint(struct psmouse * psmouse,int packet_type)407 static void elantech_report_trackpoint(struct psmouse *psmouse,
408 				       int packet_type)
409 {
410 	/*
411 	 * byte 0:  0   0  sx  sy   0   M   R   L
412 	 * byte 1:~sx   0   0   0   0   0   0   0
413 	 * byte 2:~sy   0   0   0   0   0   0   0
414 	 * byte 3:  0   0 ~sy ~sx   0   1   1   0
415 	 * byte 4: x7  x6  x5  x4  x3  x2  x1  x0
416 	 * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
417 	 *
418 	 * x and y are written in two's complement spread
419 	 * over 9 bits with sx/sy the relative top bit and
420 	 * x7..x0 and y7..y0 the lower bits.
421 	 * The sign of y is opposite to what the input driver
422 	 * expects for a relative movement
423 	 */
424 
425 	struct elantech_data *etd = psmouse->private;
426 	struct input_dev *tp_dev = etd->tp_dev;
427 	unsigned char *packet = psmouse->packet;
428 	int x, y;
429 	u32 t;
430 
431 	t = get_unaligned_le32(&packet[0]);
432 
433 	switch (t & ~7U) {
434 	case 0x06000030U:
435 	case 0x16008020U:
436 	case 0x26800010U:
437 	case 0x36808000U:
438 
439 		/*
440 		 * This firmware misreport coordinates for trackpoint
441 		 * occasionally. Discard packets outside of [-127, 127] range
442 		 * to prevent cursor jumps.
443 		 */
444 		if (packet[4] == 0x80 || packet[5] == 0x80 ||
445 		    packet[1] >> 7 == packet[4] >> 7 ||
446 		    packet[2] >> 7 == packet[5] >> 7) {
447 			elantech_debug("discarding packet [%6ph]\n", packet);
448 			break;
449 
450 		}
451 		x = packet[4] - (int)((packet[1]^0x80) << 1);
452 		y = (int)((packet[2]^0x80) << 1) - packet[5];
453 
454 		input_report_key(tp_dev, BTN_LEFT, packet[0] & 0x01);
455 		input_report_key(tp_dev, BTN_RIGHT, packet[0] & 0x02);
456 		input_report_key(tp_dev, BTN_MIDDLE, packet[0] & 0x04);
457 
458 		input_report_rel(tp_dev, REL_X, x);
459 		input_report_rel(tp_dev, REL_Y, y);
460 
461 		input_sync(tp_dev);
462 
463 		break;
464 
465 	default:
466 		/* Dump unexpected packet sequences if debug=1 (default) */
467 		if (etd->debug == 1)
468 			elantech_packet_dump(psmouse);
469 
470 		break;
471 	}
472 }
473 
474 /*
475  * Interpret complete data packets and report absolute mode input events for
476  * hardware version 3. (12 byte packets for two fingers)
477  */
elantech_report_absolute_v3(struct psmouse * psmouse,int packet_type)478 static void elantech_report_absolute_v3(struct psmouse *psmouse,
479 					int packet_type)
480 {
481 	struct input_dev *dev = psmouse->dev;
482 	struct elantech_data *etd = psmouse->private;
483 	unsigned char *packet = psmouse->packet;
484 	unsigned int fingers = 0, x1 = 0, y1 = 0, x2 = 0, y2 = 0;
485 	unsigned int width = 0, pres = 0;
486 
487 	/* byte 0: n1  n0   .   .   .   .   R   L */
488 	fingers = (packet[0] & 0xc0) >> 6;
489 
490 	switch (fingers) {
491 	case 3:
492 	case 1:
493 		/*
494 		 * byte 1:  .   .   .   .  x11 x10 x9  x8
495 		 * byte 2: x7  x6  x5  x4  x4  x2  x1  x0
496 		 */
497 		x1 = ((packet[1] & 0x0f) << 8) | packet[2];
498 		/*
499 		 * byte 4:  .   .   .   .  y11 y10 y9  y8
500 		 * byte 5: y7  y6  y5  y4  y3  y2  y1  y0
501 		 */
502 		y1 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
503 		break;
504 
505 	case 2:
506 		if (packet_type == PACKET_V3_HEAD) {
507 			/*
508 			 * byte 1:   .    .    .    .  ax11 ax10 ax9  ax8
509 			 * byte 2: ax7  ax6  ax5  ax4  ax3  ax2  ax1  ax0
510 			 */
511 			etd->mt[0].x = ((packet[1] & 0x0f) << 8) | packet[2];
512 			/*
513 			 * byte 4:   .    .    .    .  ay11 ay10 ay9  ay8
514 			 * byte 5: ay7  ay6  ay5  ay4  ay3  ay2  ay1  ay0
515 			 */
516 			etd->mt[0].y = etd->y_max -
517 				(((packet[4] & 0x0f) << 8) | packet[5]);
518 			/*
519 			 * wait for next packet
520 			 */
521 			return;
522 		}
523 
524 		/* packet_type == PACKET_V3_TAIL */
525 		x1 = etd->mt[0].x;
526 		y1 = etd->mt[0].y;
527 		x2 = ((packet[1] & 0x0f) << 8) | packet[2];
528 		y2 = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
529 		break;
530 	}
531 
532 	pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
533 	width = ((packet[0] & 0x30) >> 2) | ((packet[3] & 0x30) >> 4);
534 
535 	input_report_key(dev, BTN_TOUCH, fingers != 0);
536 	if (fingers != 0) {
537 		input_report_abs(dev, ABS_X, x1);
538 		input_report_abs(dev, ABS_Y, y1);
539 	}
540 	elantech_report_semi_mt_data(dev, fingers, x1, y1, x2, y2);
541 	input_report_key(dev, BTN_TOOL_FINGER, fingers == 1);
542 	input_report_key(dev, BTN_TOOL_DOUBLETAP, fingers == 2);
543 	input_report_key(dev, BTN_TOOL_TRIPLETAP, fingers == 3);
544 
545 	/* For clickpads map both buttons to BTN_LEFT */
546 	if (etd->fw_version & 0x001000) {
547 		input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
548 	} else {
549 		input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
550 		input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
551 	}
552 
553 	input_report_abs(dev, ABS_PRESSURE, pres);
554 	input_report_abs(dev, ABS_TOOL_WIDTH, width);
555 
556 	input_sync(dev);
557 }
558 
elantech_input_sync_v4(struct psmouse * psmouse)559 static void elantech_input_sync_v4(struct psmouse *psmouse)
560 {
561 	struct input_dev *dev = psmouse->dev;
562 	struct elantech_data *etd = psmouse->private;
563 	unsigned char *packet = psmouse->packet;
564 
565 	/* For clickpads map both buttons to BTN_LEFT */
566 	if (etd->fw_version & 0x001000) {
567 		input_report_key(dev, BTN_LEFT, packet[0] & 0x03);
568 	} else {
569 		input_report_key(dev, BTN_LEFT, packet[0] & 0x01);
570 		input_report_key(dev, BTN_RIGHT, packet[0] & 0x02);
571 		input_report_key(dev, BTN_MIDDLE, packet[0] & 0x04);
572 	}
573 
574 	input_mt_report_pointer_emulation(dev, true);
575 	input_sync(dev);
576 }
577 
process_packet_status_v4(struct psmouse * psmouse)578 static void process_packet_status_v4(struct psmouse *psmouse)
579 {
580 	struct input_dev *dev = psmouse->dev;
581 	unsigned char *packet = psmouse->packet;
582 	unsigned fingers;
583 	int i;
584 
585 	/* notify finger state change */
586 	fingers = packet[1] & 0x1f;
587 	for (i = 0; i < ETP_MAX_FINGERS; i++) {
588 		if ((fingers & (1 << i)) == 0) {
589 			input_mt_slot(dev, i);
590 			input_mt_report_slot_state(dev, MT_TOOL_FINGER, false);
591 		}
592 	}
593 
594 	elantech_input_sync_v4(psmouse);
595 }
596 
process_packet_head_v4(struct psmouse * psmouse)597 static void process_packet_head_v4(struct psmouse *psmouse)
598 {
599 	struct input_dev *dev = psmouse->dev;
600 	struct elantech_data *etd = psmouse->private;
601 	unsigned char *packet = psmouse->packet;
602 	int id = ((packet[3] & 0xe0) >> 5) - 1;
603 	int pres, traces;
604 
605 	if (id < 0)
606 		return;
607 
608 	etd->mt[id].x = ((packet[1] & 0x0f) << 8) | packet[2];
609 	etd->mt[id].y = etd->y_max - (((packet[4] & 0x0f) << 8) | packet[5]);
610 	pres = (packet[1] & 0xf0) | ((packet[4] & 0xf0) >> 4);
611 	traces = (packet[0] & 0xf0) >> 4;
612 
613 	input_mt_slot(dev, id);
614 	input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
615 
616 	input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
617 	input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
618 	input_report_abs(dev, ABS_MT_PRESSURE, pres);
619 	input_report_abs(dev, ABS_MT_TOUCH_MAJOR, traces * etd->width);
620 	/* report this for backwards compatibility */
621 	input_report_abs(dev, ABS_TOOL_WIDTH, traces);
622 
623 	elantech_input_sync_v4(psmouse);
624 }
625 
process_packet_motion_v4(struct psmouse * psmouse)626 static void process_packet_motion_v4(struct psmouse *psmouse)
627 {
628 	struct input_dev *dev = psmouse->dev;
629 	struct elantech_data *etd = psmouse->private;
630 	unsigned char *packet = psmouse->packet;
631 	int weight, delta_x1 = 0, delta_y1 = 0, delta_x2 = 0, delta_y2 = 0;
632 	int id, sid;
633 
634 	id = ((packet[0] & 0xe0) >> 5) - 1;
635 	if (id < 0)
636 		return;
637 
638 	sid = ((packet[3] & 0xe0) >> 5) - 1;
639 	weight = (packet[0] & 0x10) ? ETP_WEIGHT_VALUE : 1;
640 	/*
641 	 * Motion packets give us the delta of x, y values of specific fingers,
642 	 * but in two's complement. Let the compiler do the conversion for us.
643 	 * Also _enlarge_ the numbers to int, in case of overflow.
644 	 */
645 	delta_x1 = (signed char)packet[1];
646 	delta_y1 = (signed char)packet[2];
647 	delta_x2 = (signed char)packet[4];
648 	delta_y2 = (signed char)packet[5];
649 
650 	etd->mt[id].x += delta_x1 * weight;
651 	etd->mt[id].y -= delta_y1 * weight;
652 	input_mt_slot(dev, id);
653 	input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[id].x);
654 	input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[id].y);
655 
656 	if (sid >= 0) {
657 		etd->mt[sid].x += delta_x2 * weight;
658 		etd->mt[sid].y -= delta_y2 * weight;
659 		input_mt_slot(dev, sid);
660 		input_report_abs(dev, ABS_MT_POSITION_X, etd->mt[sid].x);
661 		input_report_abs(dev, ABS_MT_POSITION_Y, etd->mt[sid].y);
662 	}
663 
664 	elantech_input_sync_v4(psmouse);
665 }
666 
elantech_report_absolute_v4(struct psmouse * psmouse,int packet_type)667 static void elantech_report_absolute_v4(struct psmouse *psmouse,
668 					int packet_type)
669 {
670 	switch (packet_type) {
671 	case PACKET_V4_STATUS:
672 		process_packet_status_v4(psmouse);
673 		break;
674 
675 	case PACKET_V4_HEAD:
676 		process_packet_head_v4(psmouse);
677 		break;
678 
679 	case PACKET_V4_MOTION:
680 		process_packet_motion_v4(psmouse);
681 		break;
682 
683 	case PACKET_UNKNOWN:
684 	default:
685 		/* impossible to get here */
686 		break;
687 	}
688 }
689 
elantech_packet_check_v1(struct psmouse * psmouse)690 static int elantech_packet_check_v1(struct psmouse *psmouse)
691 {
692 	struct elantech_data *etd = psmouse->private;
693 	unsigned char *packet = psmouse->packet;
694 	unsigned char p1, p2, p3;
695 
696 	/* Parity bits are placed differently */
697 	if (etd->fw_version < 0x020000) {
698 		/* byte 0:  D   U  p1  p2   1  p3   R   L */
699 		p1 = (packet[0] & 0x20) >> 5;
700 		p2 = (packet[0] & 0x10) >> 4;
701 	} else {
702 		/* byte 0: n1  n0  p2  p1   1  p3   R   L */
703 		p1 = (packet[0] & 0x10) >> 4;
704 		p2 = (packet[0] & 0x20) >> 5;
705 	}
706 
707 	p3 = (packet[0] & 0x04) >> 2;
708 
709 	return etd->parity[packet[1]] == p1 &&
710 	       etd->parity[packet[2]] == p2 &&
711 	       etd->parity[packet[3]] == p3;
712 }
713 
elantech_debounce_check_v2(struct psmouse * psmouse)714 static int elantech_debounce_check_v2(struct psmouse *psmouse)
715 {
716         /*
717          * When we encounter packet that matches this exactly, it means the
718          * hardware is in debounce status. Just ignore the whole packet.
719          */
720         const u8 debounce_packet[] = { 0x84, 0xff, 0xff, 0x02, 0xff, 0xff };
721         unsigned char *packet = psmouse->packet;
722 
723         return !memcmp(packet, debounce_packet, sizeof(debounce_packet));
724 }
725 
elantech_packet_check_v2(struct psmouse * psmouse)726 static int elantech_packet_check_v2(struct psmouse *psmouse)
727 {
728 	struct elantech_data *etd = psmouse->private;
729 	unsigned char *packet = psmouse->packet;
730 
731 	/*
732 	 * V2 hardware has two flavors. Older ones that do not report pressure,
733 	 * and newer ones that reports pressure and width. With newer ones, all
734 	 * packets (1, 2, 3 finger touch) have the same constant bits. With
735 	 * older ones, 1/3 finger touch packets and 2 finger touch packets
736 	 * have different constant bits.
737 	 * With all three cases, if the constant bits are not exactly what I
738 	 * expected, I consider them invalid.
739 	 */
740 	if (etd->reports_pressure)
741 		return (packet[0] & 0x0c) == 0x04 &&
742 		       (packet[3] & 0x0f) == 0x02;
743 
744 	if ((packet[0] & 0xc0) == 0x80)
745 		return (packet[0] & 0x0c) == 0x0c &&
746 		       (packet[3] & 0x0e) == 0x08;
747 
748 	return (packet[0] & 0x3c) == 0x3c &&
749 	       (packet[1] & 0xf0) == 0x00 &&
750 	       (packet[3] & 0x3e) == 0x38 &&
751 	       (packet[4] & 0xf0) == 0x00;
752 }
753 
754 /*
755  * We check the constant bits to determine what packet type we get,
756  * so packet checking is mandatory for v3 and later hardware.
757  */
elantech_packet_check_v3(struct psmouse * psmouse)758 static int elantech_packet_check_v3(struct psmouse *psmouse)
759 {
760 	struct elantech_data *etd = psmouse->private;
761 	const u8 debounce_packet[] = { 0xc4, 0xff, 0xff, 0x02, 0xff, 0xff };
762 	unsigned char *packet = psmouse->packet;
763 
764 	/*
765 	 * check debounce first, it has the same signature in byte 0
766 	 * and byte 3 as PACKET_V3_HEAD.
767 	 */
768 	if (!memcmp(packet, debounce_packet, sizeof(debounce_packet)))
769 		return PACKET_DEBOUNCE;
770 
771 	/*
772 	 * If the hardware flag 'crc_enabled' is set the packets have
773 	 * different signatures.
774 	 */
775 	if (etd->crc_enabled) {
776 		if ((packet[3] & 0x09) == 0x08)
777 			return PACKET_V3_HEAD;
778 
779 		if ((packet[3] & 0x09) == 0x09)
780 			return PACKET_V3_TAIL;
781 	} else {
782 		if ((packet[0] & 0x0c) == 0x04 && (packet[3] & 0xcf) == 0x02)
783 			return PACKET_V3_HEAD;
784 
785 		if ((packet[0] & 0x0c) == 0x0c && (packet[3] & 0xce) == 0x0c)
786 			return PACKET_V3_TAIL;
787 		if ((packet[3] & 0x0f) == 0x06)
788 			return PACKET_TRACKPOINT;
789 	}
790 
791 	return PACKET_UNKNOWN;
792 }
793 
elantech_packet_check_v4(struct psmouse * psmouse)794 static int elantech_packet_check_v4(struct psmouse *psmouse)
795 {
796 	struct elantech_data *etd = psmouse->private;
797 	unsigned char *packet = psmouse->packet;
798 	unsigned char packet_type = packet[3] & 0x03;
799 	unsigned int ic_version;
800 	bool sanity_check;
801 
802 	if (etd->tp_dev && (packet[3] & 0x0f) == 0x06)
803 		return PACKET_TRACKPOINT;
804 
805 	/* This represents the version of IC body. */
806 	ic_version = (etd->fw_version & 0x0f0000) >> 16;
807 
808 	/*
809 	 * Sanity check based on the constant bits of a packet.
810 	 * The constant bits change depending on the value of
811 	 * the hardware flag 'crc_enabled' and the version of
812 	 * the IC body, but are the same for every packet,
813 	 * regardless of the type.
814 	 */
815 	if (etd->crc_enabled)
816 		sanity_check = ((packet[3] & 0x08) == 0x00);
817 	else if (ic_version == 7 && etd->samples[1] == 0x2A)
818 		sanity_check = ((packet[3] & 0x1c) == 0x10);
819 	else
820 		sanity_check = ((packet[0] & 0x08) == 0x00 &&
821 				(packet[3] & 0x1c) == 0x10);
822 
823 	if (!sanity_check)
824 		return PACKET_UNKNOWN;
825 
826 	switch (packet_type) {
827 	case 0:
828 		return PACKET_V4_STATUS;
829 
830 	case 1:
831 		return PACKET_V4_HEAD;
832 
833 	case 2:
834 		return PACKET_V4_MOTION;
835 	}
836 
837 	return PACKET_UNKNOWN;
838 }
839 
840 /*
841  * Process byte stream from mouse and handle complete packets
842  */
elantech_process_byte(struct psmouse * psmouse)843 static psmouse_ret_t elantech_process_byte(struct psmouse *psmouse)
844 {
845 	struct elantech_data *etd = psmouse->private;
846 	int packet_type;
847 
848 	if (psmouse->pktcnt < psmouse->pktsize)
849 		return PSMOUSE_GOOD_DATA;
850 
851 	if (etd->debug > 1)
852 		elantech_packet_dump(psmouse);
853 
854 	switch (etd->hw_version) {
855 	case 1:
856 		if (etd->paritycheck && !elantech_packet_check_v1(psmouse))
857 			return PSMOUSE_BAD_DATA;
858 
859 		elantech_report_absolute_v1(psmouse);
860 		break;
861 
862 	case 2:
863 		/* ignore debounce */
864 		if (elantech_debounce_check_v2(psmouse))
865 			return PSMOUSE_FULL_PACKET;
866 
867 		if (etd->paritycheck && !elantech_packet_check_v2(psmouse))
868 			return PSMOUSE_BAD_DATA;
869 
870 		elantech_report_absolute_v2(psmouse);
871 		break;
872 
873 	case 3:
874 		packet_type = elantech_packet_check_v3(psmouse);
875 		switch (packet_type) {
876 		case PACKET_UNKNOWN:
877 			return PSMOUSE_BAD_DATA;
878 
879 		case PACKET_DEBOUNCE:
880 			/* ignore debounce */
881 			break;
882 
883 		case PACKET_TRACKPOINT:
884 			elantech_report_trackpoint(psmouse, packet_type);
885 			break;
886 
887 		default:
888 			elantech_report_absolute_v3(psmouse, packet_type);
889 			break;
890 		}
891 
892 		break;
893 
894 	case 4:
895 		packet_type = elantech_packet_check_v4(psmouse);
896 		switch (packet_type) {
897 		case PACKET_UNKNOWN:
898 			return PSMOUSE_BAD_DATA;
899 
900 		case PACKET_TRACKPOINT:
901 			elantech_report_trackpoint(psmouse, packet_type);
902 			break;
903 
904 		default:
905 			elantech_report_absolute_v4(psmouse, packet_type);
906 			break;
907 		}
908 
909 		break;
910 	}
911 
912 	return PSMOUSE_FULL_PACKET;
913 }
914 
915 /*
916  * This writes the reg_07 value again to the hardware at the end of every
917  * set_rate call because the register loses its value. reg_07 allows setting
918  * absolute mode on v4 hardware
919  */
elantech_set_rate_restore_reg_07(struct psmouse * psmouse,unsigned int rate)920 static void elantech_set_rate_restore_reg_07(struct psmouse *psmouse,
921 		unsigned int rate)
922 {
923 	struct elantech_data *etd = psmouse->private;
924 
925 	etd->original_set_rate(psmouse, rate);
926 	if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
927 		psmouse_err(psmouse, "restoring reg_07 failed\n");
928 }
929 
930 /*
931  * Put the touchpad into absolute mode
932  */
elantech_set_absolute_mode(struct psmouse * psmouse)933 static int elantech_set_absolute_mode(struct psmouse *psmouse)
934 {
935 	struct elantech_data *etd = psmouse->private;
936 	unsigned char val;
937 	int tries = ETP_READ_BACK_TRIES;
938 	int rc = 0;
939 
940 	switch (etd->hw_version) {
941 	case 1:
942 		etd->reg_10 = 0x16;
943 		etd->reg_11 = 0x8f;
944 		if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
945 		    elantech_write_reg(psmouse, 0x11, etd->reg_11)) {
946 			rc = -1;
947 		}
948 		break;
949 
950 	case 2:
951 					/* Windows driver values */
952 		etd->reg_10 = 0x54;
953 		etd->reg_11 = 0x88;	/* 0x8a */
954 		etd->reg_21 = 0x60;	/* 0x00 */
955 		if (elantech_write_reg(psmouse, 0x10, etd->reg_10) ||
956 		    elantech_write_reg(psmouse, 0x11, etd->reg_11) ||
957 		    elantech_write_reg(psmouse, 0x21, etd->reg_21)) {
958 			rc = -1;
959 		}
960 		break;
961 
962 	case 3:
963 		if (etd->set_hw_resolution)
964 			etd->reg_10 = 0x0b;
965 		else
966 			etd->reg_10 = 0x01;
967 
968 		if (elantech_write_reg(psmouse, 0x10, etd->reg_10))
969 			rc = -1;
970 
971 		break;
972 
973 	case 4:
974 		etd->reg_07 = 0x01;
975 		if (elantech_write_reg(psmouse, 0x07, etd->reg_07))
976 			rc = -1;
977 
978 		goto skip_readback_reg_10; /* v4 has no reg 0x10 to read */
979 	}
980 
981 	if (rc == 0) {
982 		/*
983 		 * Read back reg 0x10. For hardware version 1 we must make
984 		 * sure the absolute mode bit is set. For hardware version 2
985 		 * the touchpad is probably initializing and not ready until
986 		 * we read back the value we just wrote.
987 		 */
988 		do {
989 			rc = elantech_read_reg(psmouse, 0x10, &val);
990 			if (rc == 0)
991 				break;
992 			tries--;
993 			elantech_debug("retrying read (%d).\n", tries);
994 			msleep(ETP_READ_BACK_DELAY);
995 		} while (tries > 0);
996 
997 		if (rc) {
998 			psmouse_err(psmouse,
999 				    "failed to read back register 0x10.\n");
1000 		} else if (etd->hw_version == 1 &&
1001 			   !(val & ETP_R10_ABSOLUTE_MODE)) {
1002 			psmouse_err(psmouse,
1003 				    "touchpad refuses to switch to absolute mode.\n");
1004 			rc = -1;
1005 		}
1006 	}
1007 
1008  skip_readback_reg_10:
1009 	if (rc)
1010 		psmouse_err(psmouse, "failed to initialise registers.\n");
1011 
1012 	return rc;
1013 }
1014 
elantech_set_range(struct psmouse * psmouse,unsigned int * x_min,unsigned int * y_min,unsigned int * x_max,unsigned int * y_max,unsigned int * width)1015 static int elantech_set_range(struct psmouse *psmouse,
1016 			      unsigned int *x_min, unsigned int *y_min,
1017 			      unsigned int *x_max, unsigned int *y_max,
1018 			      unsigned int *width)
1019 {
1020 	struct elantech_data *etd = psmouse->private;
1021 	unsigned char param[3];
1022 	unsigned char traces;
1023 
1024 	switch (etd->hw_version) {
1025 	case 1:
1026 		*x_min = ETP_XMIN_V1;
1027 		*y_min = ETP_YMIN_V1;
1028 		*x_max = ETP_XMAX_V1;
1029 		*y_max = ETP_YMAX_V1;
1030 		break;
1031 
1032 	case 2:
1033 		if (etd->fw_version == 0x020800 ||
1034 		    etd->fw_version == 0x020b00 ||
1035 		    etd->fw_version == 0x020030) {
1036 			*x_min = ETP_XMIN_V2;
1037 			*y_min = ETP_YMIN_V2;
1038 			*x_max = ETP_XMAX_V2;
1039 			*y_max = ETP_YMAX_V2;
1040 		} else {
1041 			int i;
1042 			int fixed_dpi;
1043 
1044 			i = (etd->fw_version > 0x020800 &&
1045 			     etd->fw_version < 0x020900) ? 1 : 2;
1046 
1047 			if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1048 				return -1;
1049 
1050 			fixed_dpi = param[1] & 0x10;
1051 
1052 			if (((etd->fw_version >> 16) == 0x14) && fixed_dpi) {
1053 				if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, param))
1054 					return -1;
1055 
1056 				*x_max = (etd->capabilities[1] - i) * param[1] / 2;
1057 				*y_max = (etd->capabilities[2] - i) * param[2] / 2;
1058 			} else if (etd->fw_version == 0x040216) {
1059 				*x_max = 819;
1060 				*y_max = 405;
1061 			} else if (etd->fw_version == 0x040219 || etd->fw_version == 0x040215) {
1062 				*x_max = 900;
1063 				*y_max = 500;
1064 			} else {
1065 				*x_max = (etd->capabilities[1] - i) * 64;
1066 				*y_max = (etd->capabilities[2] - i) * 64;
1067 			}
1068 		}
1069 		break;
1070 
1071 	case 3:
1072 		if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1073 			return -1;
1074 
1075 		*x_max = (0x0f & param[0]) << 8 | param[1];
1076 		*y_max = (0xf0 & param[0]) << 4 | param[2];
1077 		break;
1078 
1079 	case 4:
1080 		if (etd->send_cmd(psmouse, ETP_FW_ID_QUERY, param))
1081 			return -1;
1082 
1083 		*x_max = (0x0f & param[0]) << 8 | param[1];
1084 		*y_max = (0xf0 & param[0]) << 4 | param[2];
1085 		traces = etd->capabilities[1];
1086 		if ((traces < 2) || (traces > *x_max))
1087 			return -1;
1088 
1089 		*width = *x_max / (traces - 1);
1090 		break;
1091 	}
1092 
1093 	return 0;
1094 }
1095 
1096 /*
1097  * (value from firmware) * 10 + 790 = dpi
1098  * we also have to convert dpi to dots/mm (*10/254 to avoid floating point)
1099  */
elantech_convert_res(unsigned int val)1100 static unsigned int elantech_convert_res(unsigned int val)
1101 {
1102 	return (val * 10 + 790) * 10 / 254;
1103 }
1104 
elantech_get_resolution_v4(struct psmouse * psmouse,unsigned int * x_res,unsigned int * y_res)1105 static int elantech_get_resolution_v4(struct psmouse *psmouse,
1106 				      unsigned int *x_res,
1107 				      unsigned int *y_res)
1108 {
1109 	unsigned char param[3];
1110 
1111 	if (elantech_send_cmd(psmouse, ETP_RESOLUTION_QUERY, param))
1112 		return -1;
1113 
1114 	*x_res = elantech_convert_res(param[1] & 0x0f);
1115 	*y_res = elantech_convert_res((param[1] & 0xf0) >> 4);
1116 
1117 	return 0;
1118 }
1119 
1120 /*
1121  * Advertise INPUT_PROP_BUTTONPAD for clickpads. The testing of bit 12 in
1122  * fw_version for this is based on the following fw_version & caps table:
1123  *
1124  * Laptop-model:           fw_version:     caps:           buttons:
1125  * Acer S3                 0x461f00        10, 13, 0e      clickpad
1126  * Acer S7-392             0x581f01        50, 17, 0d      clickpad
1127  * Acer V5-131             0x461f02        01, 16, 0c      clickpad
1128  * Acer V5-551             0x461f00        ?               clickpad
1129  * Asus K53SV              0x450f01        78, 15, 0c      2 hw buttons
1130  * Asus G46VW              0x460f02        00, 18, 0c      2 hw buttons
1131  * Asus G750JX             0x360f00        00, 16, 0c      2 hw buttons
1132  * Asus TP500LN            0x381f17        10, 14, 0e      clickpad
1133  * Asus X750JN             0x381f17        10, 14, 0e      clickpad
1134  * Asus UX31               0x361f00        20, 15, 0e      clickpad
1135  * Asus UX32VD             0x361f02        00, 15, 0e      clickpad
1136  * Avatar AVIU-145A2       0x361f00        ?               clickpad
1137  * Fujitsu CELSIUS H760    0x570f02        40, 14, 0c      3 hw buttons (**)
1138  * Fujitsu CELSIUS H780    0x5d0f02        41, 16, 0d      3 hw buttons (**)
1139  * Fujitsu LIFEBOOK E544   0x470f00        d0, 12, 09      2 hw buttons
1140  * Fujitsu LIFEBOOK E546   0x470f00        50, 12, 09      2 hw buttons
1141  * Fujitsu LIFEBOOK E547   0x470f00        50, 12, 09      2 hw buttons
1142  * Fujitsu LIFEBOOK E554   0x570f01        40, 14, 0c      2 hw buttons
1143  * Fujitsu LIFEBOOK E557   0x570f01        40, 14, 0c      2 hw buttons
1144  * Fujitsu T725            0x470f01        05, 12, 09      2 hw buttons
1145  * Fujitsu H730            0x570f00        c0, 14, 0c      3 hw buttons (**)
1146  * Gigabyte U2442          0x450f01        58, 17, 0c      2 hw buttons
1147  * Lenovo L430             0x350f02        b9, 15, 0c      2 hw buttons (*)
1148  * Lenovo L530             0x350f02        b9, 15, 0c      2 hw buttons (*)
1149  * Samsung NF210           0x150b00        78, 14, 0a      2 hw buttons
1150  * Samsung NP770Z5E        0x575f01        10, 15, 0f      clickpad
1151  * Samsung NP700Z5B        0x361f06        21, 15, 0f      clickpad
1152  * Samsung NP900X3E-A02    0x575f03        ?               clickpad
1153  * Samsung NP-QX410        0x851b00        19, 14, 0c      clickpad
1154  * Samsung RC512           0x450f00        08, 15, 0c      2 hw buttons
1155  * Samsung RF710           0x450f00        ?               2 hw buttons
1156  * System76 Pangolin       0x250f01        ?               2 hw buttons
1157  * (*) + 3 trackpoint buttons
1158  * (**) + 0 trackpoint buttons
1159  * Note: Lenovo L430 and Lenovo L430 have the same fw_version/caps
1160  */
elantech_set_buttonpad_prop(struct psmouse * psmouse)1161 static void elantech_set_buttonpad_prop(struct psmouse *psmouse)
1162 {
1163 	struct input_dev *dev = psmouse->dev;
1164 	struct elantech_data *etd = psmouse->private;
1165 
1166 	if (etd->fw_version & 0x001000) {
1167 		__set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1168 		__clear_bit(BTN_RIGHT, dev->keybit);
1169 	}
1170 }
1171 
1172 /*
1173  * Some hw_version 4 models do have a middle button
1174  */
1175 static const struct dmi_system_id elantech_dmi_has_middle_button[] = {
1176 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1177 	{
1178 		/* Fujitsu H730 has a middle button */
1179 		.matches = {
1180 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1181 			DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1182 		},
1183 	},
1184 	{
1185 		/* Fujitsu H760 also has a middle button */
1186 		.matches = {
1187 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1188 			DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1189 		},
1190 	},
1191 	{
1192 		/* Fujitsu H780 also has a middle button */
1193 		.matches = {
1194 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1195 			DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H780"),
1196 		},
1197 	},
1198 #endif
1199 	{ }
1200 };
1201 
1202 static const char * const middle_button_pnp_ids[] = {
1203 	"LEN2131", /* ThinkPad P52 w/ NFC */
1204 	"LEN2132", /* ThinkPad P52 */
1205 	"LEN2133", /* ThinkPad P72 w/ NFC */
1206 	"LEN2134", /* ThinkPad P72 */
1207 	"LEN0407",
1208 	"LEN0408",
1209 	NULL
1210 };
1211 
1212 /*
1213  * Set the appropriate event bits for the input subsystem
1214  */
elantech_set_input_params(struct psmouse * psmouse)1215 static int elantech_set_input_params(struct psmouse *psmouse)
1216 {
1217 	struct input_dev *dev = psmouse->dev;
1218 	struct elantech_data *etd = psmouse->private;
1219 	unsigned int x_min = 0, y_min = 0, x_max = 0, y_max = 0, width = 0;
1220 	unsigned int x_res = 31, y_res = 31;
1221 
1222 	if (elantech_set_range(psmouse, &x_min, &y_min, &x_max, &y_max, &width))
1223 		return -1;
1224 
1225 	__set_bit(INPUT_PROP_POINTER, dev->propbit);
1226 	__set_bit(EV_KEY, dev->evbit);
1227 	__set_bit(EV_ABS, dev->evbit);
1228 	__clear_bit(EV_REL, dev->evbit);
1229 
1230 	__set_bit(BTN_LEFT, dev->keybit);
1231 	if (dmi_check_system(elantech_dmi_has_middle_button) ||
1232 			psmouse_matches_pnp_id(psmouse, middle_button_pnp_ids))
1233 		__set_bit(BTN_MIDDLE, dev->keybit);
1234 	__set_bit(BTN_RIGHT, dev->keybit);
1235 
1236 	__set_bit(BTN_TOUCH, dev->keybit);
1237 	__set_bit(BTN_TOOL_FINGER, dev->keybit);
1238 	__set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1239 	__set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1240 
1241 	switch (etd->hw_version) {
1242 	case 1:
1243 		/* Rocker button */
1244 		if (etd->fw_version < 0x020000 &&
1245 		    (etd->capabilities[0] & ETP_CAP_HAS_ROCKER)) {
1246 			__set_bit(BTN_FORWARD, dev->keybit);
1247 			__set_bit(BTN_BACK, dev->keybit);
1248 		}
1249 		input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1250 		input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1251 		break;
1252 
1253 	case 2:
1254 		__set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1255 		__set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1256 		/* fall through */
1257 	case 3:
1258 		if (etd->hw_version == 3)
1259 			elantech_set_buttonpad_prop(psmouse);
1260 		input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1261 		input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1262 		if (etd->reports_pressure) {
1263 			input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1264 					     ETP_PMAX_V2, 0, 0);
1265 			input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1266 					     ETP_WMAX_V2, 0, 0);
1267 		}
1268 		input_mt_init_slots(dev, 2, INPUT_MT_SEMI_MT);
1269 		input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1270 		input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1271 		break;
1272 
1273 	case 4:
1274 		if (elantech_get_resolution_v4(psmouse, &x_res, &y_res)) {
1275 			/*
1276 			 * if query failed, print a warning and leave the values
1277 			 * zero to resemble synaptics.c behavior.
1278 			 */
1279 			psmouse_warn(psmouse, "couldn't query resolution data.\n");
1280 		}
1281 		elantech_set_buttonpad_prop(psmouse);
1282 		__set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1283 		/* For X to recognize me as touchpad. */
1284 		input_set_abs_params(dev, ABS_X, x_min, x_max, 0, 0);
1285 		input_set_abs_params(dev, ABS_Y, y_min, y_max, 0, 0);
1286 		/*
1287 		 * range of pressure and width is the same as v2,
1288 		 * report ABS_PRESSURE, ABS_TOOL_WIDTH for compatibility.
1289 		 */
1290 		input_set_abs_params(dev, ABS_PRESSURE, ETP_PMIN_V2,
1291 				     ETP_PMAX_V2, 0, 0);
1292 		input_set_abs_params(dev, ABS_TOOL_WIDTH, ETP_WMIN_V2,
1293 				     ETP_WMAX_V2, 0, 0);
1294 		/* Multitouch capable pad, up to 5 fingers. */
1295 		input_mt_init_slots(dev, ETP_MAX_FINGERS, 0);
1296 		input_set_abs_params(dev, ABS_MT_POSITION_X, x_min, x_max, 0, 0);
1297 		input_set_abs_params(dev, ABS_MT_POSITION_Y, y_min, y_max, 0, 0);
1298 		input_set_abs_params(dev, ABS_MT_PRESSURE, ETP_PMIN_V2,
1299 				     ETP_PMAX_V2, 0, 0);
1300 		/*
1301 		 * The firmware reports how many trace lines the finger spans,
1302 		 * convert to surface unit as Protocol-B requires.
1303 		 */
1304 		input_set_abs_params(dev, ABS_MT_TOUCH_MAJOR, 0,
1305 				     ETP_WMAX_V2 * width, 0, 0);
1306 		break;
1307 	}
1308 
1309 	input_abs_set_res(dev, ABS_X, x_res);
1310 	input_abs_set_res(dev, ABS_Y, y_res);
1311 	if (etd->hw_version > 1) {
1312 		input_abs_set_res(dev, ABS_MT_POSITION_X, x_res);
1313 		input_abs_set_res(dev, ABS_MT_POSITION_Y, y_res);
1314 	}
1315 
1316 	etd->y_max = y_max;
1317 	etd->width = width;
1318 
1319 	return 0;
1320 }
1321 
1322 struct elantech_attr_data {
1323 	size_t		field_offset;
1324 	unsigned char	reg;
1325 };
1326 
1327 /*
1328  * Display a register value by reading a sysfs entry
1329  */
elantech_show_int_attr(struct psmouse * psmouse,void * data,char * buf)1330 static ssize_t elantech_show_int_attr(struct psmouse *psmouse, void *data,
1331 					char *buf)
1332 {
1333 	struct elantech_data *etd = psmouse->private;
1334 	struct elantech_attr_data *attr = data;
1335 	unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1336 	int rc = 0;
1337 
1338 	if (attr->reg)
1339 		rc = elantech_read_reg(psmouse, attr->reg, reg);
1340 
1341 	return sprintf(buf, "0x%02x\n", (attr->reg && rc) ? -1 : *reg);
1342 }
1343 
1344 /*
1345  * Write a register value by writing a sysfs entry
1346  */
elantech_set_int_attr(struct psmouse * psmouse,void * data,const char * buf,size_t count)1347 static ssize_t elantech_set_int_attr(struct psmouse *psmouse,
1348 				     void *data, const char *buf, size_t count)
1349 {
1350 	struct elantech_data *etd = psmouse->private;
1351 	struct elantech_attr_data *attr = data;
1352 	unsigned char *reg = (unsigned char *) etd + attr->field_offset;
1353 	unsigned char value;
1354 	int err;
1355 
1356 	err = kstrtou8(buf, 16, &value);
1357 	if (err)
1358 		return err;
1359 
1360 	/* Do we need to preserve some bits for version 2 hardware too? */
1361 	if (etd->hw_version == 1) {
1362 		if (attr->reg == 0x10)
1363 			/* Force absolute mode always on */
1364 			value |= ETP_R10_ABSOLUTE_MODE;
1365 		else if (attr->reg == 0x11)
1366 			/* Force 4 byte mode always on */
1367 			value |= ETP_R11_4_BYTE_MODE;
1368 	}
1369 
1370 	if (!attr->reg || elantech_write_reg(psmouse, attr->reg, value) == 0)
1371 		*reg = value;
1372 
1373 	return count;
1374 }
1375 
1376 #define ELANTECH_INT_ATTR(_name, _register)				\
1377 	static struct elantech_attr_data elantech_attr_##_name = {	\
1378 		.field_offset = offsetof(struct elantech_data, _name),	\
1379 		.reg = _register,					\
1380 	};								\
1381 	PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,			\
1382 			    &elantech_attr_##_name,			\
1383 			    elantech_show_int_attr,			\
1384 			    elantech_set_int_attr)
1385 
1386 ELANTECH_INT_ATTR(reg_07, 0x07);
1387 ELANTECH_INT_ATTR(reg_10, 0x10);
1388 ELANTECH_INT_ATTR(reg_11, 0x11);
1389 ELANTECH_INT_ATTR(reg_20, 0x20);
1390 ELANTECH_INT_ATTR(reg_21, 0x21);
1391 ELANTECH_INT_ATTR(reg_22, 0x22);
1392 ELANTECH_INT_ATTR(reg_23, 0x23);
1393 ELANTECH_INT_ATTR(reg_24, 0x24);
1394 ELANTECH_INT_ATTR(reg_25, 0x25);
1395 ELANTECH_INT_ATTR(reg_26, 0x26);
1396 ELANTECH_INT_ATTR(debug, 0);
1397 ELANTECH_INT_ATTR(paritycheck, 0);
1398 ELANTECH_INT_ATTR(crc_enabled, 0);
1399 
1400 static struct attribute *elantech_attrs[] = {
1401 	&psmouse_attr_reg_07.dattr.attr,
1402 	&psmouse_attr_reg_10.dattr.attr,
1403 	&psmouse_attr_reg_11.dattr.attr,
1404 	&psmouse_attr_reg_20.dattr.attr,
1405 	&psmouse_attr_reg_21.dattr.attr,
1406 	&psmouse_attr_reg_22.dattr.attr,
1407 	&psmouse_attr_reg_23.dattr.attr,
1408 	&psmouse_attr_reg_24.dattr.attr,
1409 	&psmouse_attr_reg_25.dattr.attr,
1410 	&psmouse_attr_reg_26.dattr.attr,
1411 	&psmouse_attr_debug.dattr.attr,
1412 	&psmouse_attr_paritycheck.dattr.attr,
1413 	&psmouse_attr_crc_enabled.dattr.attr,
1414 	NULL
1415 };
1416 
1417 static struct attribute_group elantech_attr_group = {
1418 	.attrs = elantech_attrs,
1419 };
1420 
elantech_is_signature_valid(const unsigned char * param)1421 static bool elantech_is_signature_valid(const unsigned char *param)
1422 {
1423 	static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10 };
1424 	int i;
1425 
1426 	if (param[0] == 0)
1427 		return false;
1428 
1429 	if (param[1] == 0)
1430 		return true;
1431 
1432 	/*
1433 	 * Some hw_version >= 4 models have a revision higher then 20. Meaning
1434 	 * that param[2] may be 10 or 20, skip the rates check for these.
1435 	 */
1436 	if ((param[0] & 0x0f) >= 0x06 && (param[1] & 0xaf) == 0x0f &&
1437 	    param[2] < 40)
1438 		return true;
1439 
1440 	for (i = 0; i < ARRAY_SIZE(rates); i++)
1441 		if (param[2] == rates[i])
1442 			return false;
1443 
1444 	return true;
1445 }
1446 
1447 /*
1448  * Use magic knock to detect Elantech touchpad
1449  */
elantech_detect(struct psmouse * psmouse,bool set_properties)1450 int elantech_detect(struct psmouse *psmouse, bool set_properties)
1451 {
1452 	struct ps2dev *ps2dev = &psmouse->ps2dev;
1453 	unsigned char param[3];
1454 
1455 	ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1456 
1457 	if (ps2_command(ps2dev,  NULL, PSMOUSE_CMD_DISABLE) ||
1458 	    ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1459 	    ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1460 	    ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
1461 	    ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) {
1462 		psmouse_dbg(psmouse, "sending Elantech magic knock failed.\n");
1463 		return -1;
1464 	}
1465 
1466 	/*
1467 	 * Report this in case there are Elantech models that use a different
1468 	 * set of magic numbers
1469 	 */
1470 	if (param[0] != 0x3c || param[1] != 0x03 ||
1471 	    (param[2] != 0xc8 && param[2] != 0x00)) {
1472 		psmouse_dbg(psmouse,
1473 			    "unexpected magic knock result 0x%02x, 0x%02x, 0x%02x.\n",
1474 			    param[0], param[1], param[2]);
1475 		return -1;
1476 	}
1477 
1478 	/*
1479 	 * Query touchpad's firmware version and see if it reports known
1480 	 * value to avoid mis-detection. Logitech mice are known to respond
1481 	 * to Elantech magic knock and there might be more.
1482 	 */
1483 	if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1484 		psmouse_dbg(psmouse, "failed to query firmware version.\n");
1485 		return -1;
1486 	}
1487 
1488 	psmouse_dbg(psmouse,
1489 		    "Elantech version query result 0x%02x, 0x%02x, 0x%02x.\n",
1490 		    param[0], param[1], param[2]);
1491 
1492 	if (!elantech_is_signature_valid(param)) {
1493 		psmouse_dbg(psmouse,
1494 			    "Probably not a real Elantech touchpad. Aborting.\n");
1495 		return -1;
1496 	}
1497 
1498 	if (set_properties) {
1499 		psmouse->vendor = "Elantech";
1500 		psmouse->name = "Touchpad";
1501 	}
1502 
1503 	return 0;
1504 }
1505 
1506 /*
1507  * Clean up sysfs entries when disconnecting
1508  */
elantech_disconnect(struct psmouse * psmouse)1509 static void elantech_disconnect(struct psmouse *psmouse)
1510 {
1511 	struct elantech_data *etd = psmouse->private;
1512 
1513 	if (etd->tp_dev)
1514 		input_unregister_device(etd->tp_dev);
1515 	sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1516 			   &elantech_attr_group);
1517 	kfree(psmouse->private);
1518 	psmouse->private = NULL;
1519 }
1520 
1521 /*
1522  * Put the touchpad back into absolute mode when reconnecting
1523  */
elantech_reconnect(struct psmouse * psmouse)1524 static int elantech_reconnect(struct psmouse *psmouse)
1525 {
1526 	psmouse_reset(psmouse);
1527 
1528 	if (elantech_detect(psmouse, 0))
1529 		return -1;
1530 
1531 	if (elantech_set_absolute_mode(psmouse)) {
1532 		psmouse_err(psmouse,
1533 			    "failed to put touchpad back into absolute mode.\n");
1534 		return -1;
1535 	}
1536 
1537 	return 0;
1538 }
1539 
1540 /*
1541  * Some hw_version 4 models do not work with crc_disabled
1542  */
1543 static const struct dmi_system_id elantech_dmi_force_crc_enabled[] = {
1544 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1545 	{
1546 		/* Fujitsu H730 does not work with crc_enabled == 0 */
1547 		.matches = {
1548 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1549 			DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H730"),
1550 		},
1551 	},
1552 	{
1553 		/* Fujitsu H760 does not work with crc_enabled == 0 */
1554 		.matches = {
1555 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1556 			DMI_MATCH(DMI_PRODUCT_NAME, "CELSIUS H760"),
1557 		},
1558 	},
1559 	{
1560 		/* Fujitsu LIFEBOOK E544  does not work with crc_enabled == 0 */
1561 		.matches = {
1562 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1563 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E544"),
1564 		},
1565 	},
1566 	{
1567 		/* Fujitsu LIFEBOOK E546  does not work with crc_enabled == 0 */
1568 		.matches = {
1569 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1570 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E546"),
1571 		},
1572 	},
1573 	{
1574 		/* Fujitsu LIFEBOOK E547 does not work with crc_enabled == 0 */
1575 		.matches = {
1576 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1577 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E547"),
1578 		},
1579 	},
1580 	{
1581 		/* Fujitsu LIFEBOOK E554  does not work with crc_enabled == 0 */
1582 		.matches = {
1583 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1584 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E554"),
1585 		},
1586 	},
1587 	{
1588 		/* Fujitsu LIFEBOOK E556 does not work with crc_enabled == 0 */
1589 		.matches = {
1590 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1591 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E556"),
1592 		},
1593 	},
1594 	{
1595 		/* Fujitsu LIFEBOOK E557 does not work with crc_enabled == 0 */
1596 		.matches = {
1597 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1598 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK E557"),
1599 		},
1600 	},
1601 	{
1602 		/* Fujitsu LIFEBOOK U745 does not work with crc_enabled == 0 */
1603 		.matches = {
1604 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"),
1605 			DMI_MATCH(DMI_PRODUCT_NAME, "LIFEBOOK U745"),
1606 		},
1607 	},
1608 #endif
1609 	{ }
1610 };
1611 
1612 /*
1613  * Some hw_version 3 models go into error state when we try to set
1614  * bit 3 and/or bit 1 of r10.
1615  */
1616 static const struct dmi_system_id no_hw_res_dmi_table[] = {
1617 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1618 	{
1619 		/* Gigabyte U2442 */
1620 		.matches = {
1621 			DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
1622 			DMI_MATCH(DMI_PRODUCT_NAME, "U2442"),
1623 		},
1624 	},
1625 #endif
1626 	{ }
1627 };
1628 
1629 /*
1630  * determine hardware version and set some properties according to it.
1631  */
elantech_set_properties(struct elantech_data * etd)1632 static int elantech_set_properties(struct elantech_data *etd)
1633 {
1634 	/* This represents the version of IC body. */
1635 	int ver = (etd->fw_version & 0x0f0000) >> 16;
1636 
1637 	/* Early version of Elan touchpads doesn't obey the rule. */
1638 	if (etd->fw_version < 0x020030 || etd->fw_version == 0x020600)
1639 		etd->hw_version = 1;
1640 	else {
1641 		switch (ver) {
1642 		case 2:
1643 		case 4:
1644 			etd->hw_version = 2;
1645 			break;
1646 		case 5:
1647 			etd->hw_version = 3;
1648 			break;
1649 		case 6 ... 15:
1650 			etd->hw_version = 4;
1651 			break;
1652 		default:
1653 			return -1;
1654 		}
1655 	}
1656 
1657 	/* decide which send_cmd we're gonna use early */
1658 	etd->send_cmd = etd->hw_version >= 3 ? elantech_send_cmd :
1659 					       synaptics_send_cmd;
1660 
1661 	/* Turn on packet checking by default */
1662 	etd->paritycheck = 1;
1663 
1664 	/*
1665 	 * This firmware suffers from misreporting coordinates when
1666 	 * a touch action starts causing the mouse cursor or scrolled page
1667 	 * to jump. Enable a workaround.
1668 	 */
1669 	etd->jumpy_cursor =
1670 		(etd->fw_version == 0x020022 || etd->fw_version == 0x020600);
1671 
1672 	if (etd->hw_version > 1) {
1673 		/* For now show extra debug information */
1674 		etd->debug = 1;
1675 
1676 		if (etd->fw_version >= 0x020800)
1677 			etd->reports_pressure = true;
1678 	}
1679 
1680 	/*
1681 	 * The signatures of v3 and v4 packets change depending on the
1682 	 * value of this hardware flag.
1683 	 */
1684 	etd->crc_enabled = (etd->fw_version & 0x4000) == 0x4000 ||
1685 			   dmi_check_system(elantech_dmi_force_crc_enabled);
1686 
1687 	/* Enable real hardware resolution on hw_version 3 ? */
1688 	etd->set_hw_resolution = !dmi_check_system(no_hw_res_dmi_table);
1689 
1690 	return 0;
1691 }
1692 
1693 /*
1694  * Initialize the touchpad and create sysfs entries
1695  */
elantech_init(struct psmouse * psmouse)1696 int elantech_init(struct psmouse *psmouse)
1697 {
1698 	struct elantech_data *etd;
1699 	int i;
1700 	int error = -EINVAL;
1701 	unsigned char param[3];
1702 	struct input_dev *tp_dev;
1703 
1704 	psmouse->private = etd = kzalloc(sizeof(struct elantech_data), GFP_KERNEL);
1705 	if (!etd)
1706 		return -ENOMEM;
1707 
1708 	psmouse_reset(psmouse);
1709 
1710 	etd->parity[0] = 1;
1711 	for (i = 1; i < 256; i++)
1712 		etd->parity[i] = etd->parity[i & (i - 1)] ^ 1;
1713 
1714 	/*
1715 	 * Do the version query again so we can store the result
1716 	 */
1717 	if (synaptics_send_cmd(psmouse, ETP_FW_VERSION_QUERY, param)) {
1718 		psmouse_err(psmouse, "failed to query firmware version.\n");
1719 		goto init_fail;
1720 	}
1721 	etd->fw_version = (param[0] << 16) | (param[1] << 8) | param[2];
1722 
1723 	if (elantech_set_properties(etd)) {
1724 		psmouse_err(psmouse, "unknown hardware version, aborting...\n");
1725 		goto init_fail;
1726 	}
1727 	psmouse_info(psmouse,
1728 		     "assuming hardware version %d (with firmware version 0x%02x%02x%02x)\n",
1729 		     etd->hw_version, param[0], param[1], param[2]);
1730 
1731 	if (etd->send_cmd(psmouse, ETP_CAPABILITIES_QUERY,
1732 	    etd->capabilities)) {
1733 		psmouse_err(psmouse, "failed to query capabilities.\n");
1734 		goto init_fail;
1735 	}
1736 	psmouse_info(psmouse,
1737 		     "Synaptics capabilities query result 0x%02x, 0x%02x, 0x%02x.\n",
1738 		     etd->capabilities[0], etd->capabilities[1],
1739 		     etd->capabilities[2]);
1740 
1741 	if (etd->hw_version != 1) {
1742 		if (etd->send_cmd(psmouse, ETP_SAMPLE_QUERY, etd->samples)) {
1743 			psmouse_err(psmouse, "failed to query sample data\n");
1744 			goto init_fail;
1745 		}
1746 		psmouse_info(psmouse,
1747 			     "Elan sample query result %02x, %02x, %02x\n",
1748 			     etd->samples[0], etd->samples[1], etd->samples[2]);
1749 	}
1750 
1751 	if (etd->samples[1] == 0x74 && etd->hw_version == 0x03) {
1752 		/*
1753 		 * This module has a bug which makes absolute mode
1754 		 * unusable, so let's abort so we'll be using standard
1755 		 * PS/2 protocol.
1756 		 */
1757 		psmouse_info(psmouse,
1758 			     "absolute mode broken, forcing standard PS/2 protocol\n");
1759 		goto init_fail;
1760 	}
1761 
1762 	if (elantech_set_absolute_mode(psmouse)) {
1763 		psmouse_err(psmouse,
1764 			    "failed to put touchpad into absolute mode.\n");
1765 		goto init_fail;
1766 	}
1767 
1768 	if (etd->fw_version == 0x381f17) {
1769 		etd->original_set_rate = psmouse->set_rate;
1770 		psmouse->set_rate = elantech_set_rate_restore_reg_07;
1771 	}
1772 
1773 	if (elantech_set_input_params(psmouse)) {
1774 		psmouse_err(psmouse, "failed to query touchpad range.\n");
1775 		goto init_fail;
1776 	}
1777 
1778 	error = sysfs_create_group(&psmouse->ps2dev.serio->dev.kobj,
1779 				   &elantech_attr_group);
1780 	if (error) {
1781 		psmouse_err(psmouse,
1782 			    "failed to create sysfs attributes, error: %d.\n",
1783 			    error);
1784 		goto init_fail;
1785 	}
1786 
1787 	/* The MSB indicates the presence of the trackpoint */
1788 	if ((etd->capabilities[0] & 0x80) == 0x80) {
1789 		tp_dev = input_allocate_device();
1790 
1791 		if (!tp_dev) {
1792 			error = -ENOMEM;
1793 			goto init_fail_tp_alloc;
1794 		}
1795 
1796 		etd->tp_dev = tp_dev;
1797 		snprintf(etd->tp_phys, sizeof(etd->tp_phys), "%s/input1",
1798 			psmouse->ps2dev.serio->phys);
1799 		tp_dev->phys = etd->tp_phys;
1800 		tp_dev->name = "Elantech PS/2 TrackPoint";
1801 		tp_dev->id.bustype = BUS_I8042;
1802 		tp_dev->id.vendor  = 0x0002;
1803 		tp_dev->id.product = PSMOUSE_ELANTECH;
1804 		tp_dev->id.version = 0x0000;
1805 		tp_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1806 		tp_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1807 		tp_dev->relbit[BIT_WORD(REL_X)] =
1808 			BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1809 		tp_dev->keybit[BIT_WORD(BTN_LEFT)] =
1810 			BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_MIDDLE) |
1811 			BIT_MASK(BTN_RIGHT);
1812 
1813 		__set_bit(INPUT_PROP_POINTER, tp_dev->propbit);
1814 		__set_bit(INPUT_PROP_POINTING_STICK, tp_dev->propbit);
1815 
1816 		error = input_register_device(etd->tp_dev);
1817 		if (error < 0)
1818 			goto init_fail_tp_reg;
1819 	}
1820 
1821 	psmouse->protocol_handler = elantech_process_byte;
1822 	psmouse->disconnect = elantech_disconnect;
1823 	psmouse->reconnect = elantech_reconnect;
1824 	psmouse->pktsize = etd->hw_version > 1 ? 6 : 4;
1825 
1826 	return 0;
1827  init_fail_tp_reg:
1828 	input_free_device(tp_dev);
1829  init_fail_tp_alloc:
1830 	sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj,
1831 			   &elantech_attr_group);
1832  init_fail:
1833 	psmouse_reset(psmouse);
1834 	kfree(etd);
1835 	return error;
1836 }
1837