xref: /openbmc/linux/drivers/input/mouse/synaptics.c (revision e839ffab)
1 /*
2  * Synaptics TouchPad PS/2 mouse driver
3  *
4  *   2003 Dmitry Torokhov <dtor@mail.ru>
5  *     Added support for pass-through port. Special thanks to Peter Berg Larsen
6  *     for explaining various Synaptics quirks.
7  *
8  *   2003 Peter Osterlund <petero2@telia.com>
9  *     Ported to 2.5 input device infrastructure.
10  *
11  *   Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
12  *     start merging tpconfig and gpm code to a xfree-input module
13  *     adding some changes and extensions (ex. 3rd and 4th button)
14  *
15  *   Copyright (c) 1997 C. Scott Ananian <cananian@alumni.priceton.edu>
16  *   Copyright (c) 1998-2000 Bruce Kalk <kall@compass.com>
17  *     code for the special synaptics commands (from the tpconfig-source)
18  *
19  * This program is free software; you can redistribute it and/or modify it
20  * under the terms of the GNU General Public License version 2 as published by
21  * the Free Software Foundation.
22  *
23  * Trademarks are the property of their respective owners.
24  */
25 
26 #include <linux/module.h>
27 #include <linux/delay.h>
28 #include <linux/dmi.h>
29 #include <linux/input/mt.h>
30 #include <linux/serio.h>
31 #include <linux/libps2.h>
32 #include <linux/rmi.h>
33 #include <linux/i2c.h>
34 #include <linux/slab.h>
35 #include "psmouse.h"
36 #include "synaptics.h"
37 
38 /*
39  * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
40  * section 2.3.2, which says that they should be valid regardless of the
41  * actual size of the sensor.
42  * Note that newer firmware allows querying device for maximum useable
43  * coordinates.
44  */
45 #define XMIN 0
46 #define XMAX 6143
47 #define YMIN 0
48 #define YMAX 6143
49 #define XMIN_NOMINAL 1472
50 #define XMAX_NOMINAL 5472
51 #define YMIN_NOMINAL 1408
52 #define YMAX_NOMINAL 4448
53 
54 /* Size in bits of absolute position values reported by the hardware */
55 #define ABS_POS_BITS 13
56 
57 /*
58  * These values should represent the absolute maximum value that will
59  * be reported for a positive position value. Some Synaptics firmware
60  * uses this value to indicate a finger near the edge of the touchpad
61  * whose precise position cannot be determined.
62  *
63  * At least one touchpad is known to report positions in excess of this
64  * value which are actually negative values truncated to the 13-bit
65  * reporting range. These values have never been observed to be lower
66  * than 8184 (i.e. -8), so we treat all values greater than 8176 as
67  * negative and any other value as positive.
68  */
69 #define X_MAX_POSITIVE 8176
70 #define Y_MAX_POSITIVE 8176
71 
72 /* maximum ABS_MT_POSITION displacement (in mm) */
73 #define DMAX 10
74 
75 /*****************************************************************************
76  *	Stuff we need even when we do not want native Synaptics support
77  ****************************************************************************/
78 
79 /*
80  * Set the synaptics touchpad mode byte by special commands
81  */
82 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
83 {
84 	unsigned char param[1];
85 
86 	if (psmouse_sliced_command(psmouse, mode))
87 		return -1;
88 	param[0] = SYN_PS_SET_MODE2;
89 	if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
90 		return -1;
91 	return 0;
92 }
93 
94 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
95 {
96 	struct ps2dev *ps2dev = &psmouse->ps2dev;
97 	unsigned char param[4];
98 
99 	param[0] = 0;
100 
101 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
102 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
103 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
104 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
105 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
106 
107 	if (param[1] != 0x47)
108 		return -ENODEV;
109 
110 	if (set_properties) {
111 		psmouse->vendor = "Synaptics";
112 		psmouse->name = "TouchPad";
113 	}
114 
115 	return 0;
116 }
117 
118 void synaptics_reset(struct psmouse *psmouse)
119 {
120 	/* reset touchpad back to relative mode, gestures enabled */
121 	synaptics_mode_cmd(psmouse, 0);
122 }
123 
124 #if defined(CONFIG_MOUSE_PS2_SYNAPTICS) || \
125     defined(CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS)
126 
127 /* This list has been kindly provided by Synaptics. */
128 static const char * const topbuttonpad_pnp_ids[] = {
129 	"LEN0017",
130 	"LEN0018",
131 	"LEN0019",
132 	"LEN0023",
133 	"LEN002A",
134 	"LEN002B",
135 	"LEN002C",
136 	"LEN002D",
137 	"LEN002E",
138 	"LEN0033", /* Helix */
139 	"LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
140 	"LEN0035", /* X240 */
141 	"LEN0036", /* T440 */
142 	"LEN0037", /* X1 Carbon 2nd */
143 	"LEN0038",
144 	"LEN0039", /* T440s */
145 	"LEN0041",
146 	"LEN0042", /* Yoga */
147 	"LEN0045",
148 	"LEN0047",
149 	"LEN0049",
150 	"LEN2000", /* S540 */
151 	"LEN2001", /* Edge E431 */
152 	"LEN2002", /* Edge E531 */
153 	"LEN2003",
154 	"LEN2004", /* L440 */
155 	"LEN2005",
156 	"LEN2006", /* Edge E440/E540 */
157 	"LEN2007",
158 	"LEN2008",
159 	"LEN2009",
160 	"LEN200A",
161 	"LEN200B",
162 	NULL
163 };
164 
165 static const char * const smbus_pnp_ids[] = {
166 	/* all of the topbuttonpad_pnp_ids are valid, we just add some extras */
167 	"LEN0048", /* X1 Carbon 3 */
168 	"LEN0046", /* X250 */
169 	"LEN004a", /* W541 */
170 	"LEN200f", /* T450s */
171 	NULL
172 };
173 
174 /*
175  * Send a command to the synpatics touchpad by special commands
176  */
177 static int synaptics_send_cmd(struct psmouse *psmouse,
178 			      unsigned char c, unsigned char *param)
179 {
180 	int error;
181 
182 	error = psmouse_sliced_command(psmouse, c);
183 	if (error)
184 		return error;
185 
186 	error = ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO);
187 	if (error)
188 		return error;
189 
190 	return 0;
191 }
192 
193 /*
194  * Identify Touchpad
195  * See also the SYN_ID_* macros
196  */
197 static int synaptics_identify(struct psmouse *psmouse,
198 			      struct synaptics_device_info *info)
199 {
200 	unsigned char id[3];
201 	int error;
202 
203 	error = synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id);
204 	if (error)
205 		return error;
206 
207 	info->identity = (id[0] << 16) | (id[1] << 8) | id[2];
208 	return SYN_ID_IS_SYNAPTICS(info->identity) ? 0 : -ENXIO;
209 }
210 
211 /*
212  * Read the model-id bytes from the touchpad
213  * see also SYN_MODEL_* macros
214  */
215 static int synaptics_model_id(struct psmouse *psmouse,
216 			      struct synaptics_device_info *info)
217 {
218 	unsigned char mi[3];
219 	int error;
220 
221 	error = synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi);
222 	if (error)
223 		return error;
224 
225 	info->model_id = (mi[0] << 16) | (mi[1] << 8) | mi[2];
226 	return 0;
227 }
228 
229 /*
230  * Read the firmware id from the touchpad
231  */
232 static int synaptics_firmware_id(struct psmouse *psmouse,
233 				 struct synaptics_device_info *info)
234 {
235 	unsigned char fwid[3];
236 	int error;
237 
238 	error = synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid);
239 	if (error)
240 		return error;
241 
242 	info->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
243 	return 0;
244 }
245 
246 static int synaptics_more_extended_queries(struct psmouse *psmouse,
247 					   struct synaptics_device_info *info)
248 {
249 	unsigned char buf[3];
250 	int error;
251 
252 	error = synaptics_send_cmd(psmouse, SYN_QUE_MEXT_CAPAB_10, buf);
253 	if (error)
254 		return error;
255 
256 	info->ext_cap_10 = (buf[0] << 16) | (buf[1] << 8) | buf[2];
257 	return 0;
258 }
259 
260 /*
261  * Read the board id and the "More Extended Queries" from the touchpad
262  * The board id is encoded in the "QUERY MODES" response
263  */
264 static int synaptics_query_modes(struct psmouse *psmouse,
265 				 struct synaptics_device_info *info)
266 {
267 	unsigned char bid[3];
268 	int error;
269 
270 	/* firmwares prior 7.5 have no board_id encoded */
271 	if (SYN_ID_FULL(info->identity) < 0x705)
272 		return 0;
273 
274 	error = synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid);
275 	if (error)
276 		return error;
277 
278 	info->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
279 
280 	if (SYN_MEXT_CAP_BIT(bid[0]))
281 		return synaptics_more_extended_queries(psmouse, info);
282 
283 	return 0;
284 }
285 
286 /*
287  * Read the capability-bits from the touchpad
288  * see also the SYN_CAP_* macros
289  */
290 static int synaptics_capability(struct psmouse *psmouse,
291 				struct synaptics_device_info *info)
292 {
293 	unsigned char cap[3];
294 	int error;
295 
296 	error = synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap);
297 	if (error)
298 		return error;
299 
300 	info->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
301 	info->ext_cap = info->ext_cap_0c = 0;
302 
303 	/*
304 	 * Older firmwares had submodel ID fixed to 0x47
305 	 */
306 	if (SYN_ID_FULL(info->identity) < 0x705 &&
307 	    SYN_CAP_SUBMODEL_ID(info->capabilities) != 0x47) {
308 		return -ENXIO;
309 	}
310 
311 	/*
312 	 * Unless capExtended is set the rest of the flags should be ignored
313 	 */
314 	if (!SYN_CAP_EXTENDED(info->capabilities))
315 		info->capabilities = 0;
316 
317 	if (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 1) {
318 		if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
319 			psmouse_warn(psmouse,
320 				     "device claims to have extended capabilities, but I'm not able to read them.\n");
321 		} else {
322 			info->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
323 
324 			/*
325 			 * if nExtBtn is greater than 8 it should be considered
326 			 * invalid and treated as 0
327 			 */
328 			if (SYN_CAP_MULTI_BUTTON_NO(info->ext_cap) > 8)
329 				info->ext_cap &= 0xff0fff;
330 		}
331 	}
332 
333 	if (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 4) {
334 		error = synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap);
335 		if (error)
336 			psmouse_warn(psmouse,
337 				     "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
338 		else
339 			info->ext_cap_0c =
340 				(cap[0] << 16) | (cap[1] << 8) | cap[2];
341 	}
342 
343 	return 0;
344 }
345 
346 /*
347  * Read touchpad resolution and maximum reported coordinates
348  * Resolution is left zero if touchpad does not support the query
349  */
350 static int synaptics_resolution(struct psmouse *psmouse,
351 				struct synaptics_device_info *info)
352 {
353 	unsigned char resp[3];
354 	int error;
355 
356 	if (SYN_ID_MAJOR(info->identity) < 4)
357 		return 0;
358 
359 	error = synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp);
360 	if (!error) {
361 		if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
362 			info->x_res = resp[0]; /* x resolution in units/mm */
363 			info->y_res = resp[2]; /* y resolution in units/mm */
364 		}
365 	}
366 
367 	if (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 5 &&
368 	    SYN_CAP_MAX_DIMENSIONS(info->ext_cap_0c)) {
369 		error = synaptics_send_cmd(psmouse,
370 					   SYN_QUE_EXT_MAX_COORDS, resp);
371 		if (error) {
372 			psmouse_warn(psmouse,
373 				     "device claims to have max coordinates query, but I'm not able to read it.\n");
374 		} else {
375 			info->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
376 			info->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
377 			psmouse_info(psmouse,
378 				     "queried max coordinates: x [..%d], y [..%d]\n",
379 				     info->x_max, info->y_max);
380 		}
381 	}
382 
383 	if (SYN_CAP_MIN_DIMENSIONS(info->ext_cap_0c) &&
384 	    (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 7 ||
385 	     /*
386 	      * Firmware v8.1 does not report proper number of extended
387 	      * capabilities, but has been proven to report correct min
388 	      * coordinates.
389 	      */
390 	     SYN_ID_FULL(info->identity) == 0x801)) {
391 		error = synaptics_send_cmd(psmouse,
392 					   SYN_QUE_EXT_MIN_COORDS, resp);
393 		if (error) {
394 			psmouse_warn(psmouse,
395 				     "device claims to have min coordinates query, but I'm not able to read it.\n");
396 		} else {
397 			info->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
398 			info->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
399 			psmouse_info(psmouse,
400 				     "queried min coordinates: x [%d..], y [%d..]\n",
401 				     info->x_min, info->y_min);
402 		}
403 	}
404 
405 	return 0;
406 }
407 
408 static int synaptics_query_hardware(struct psmouse *psmouse,
409 				    struct synaptics_device_info *info)
410 {
411 	int error;
412 
413 	error = synaptics_identify(psmouse, info);
414 	if (error)
415 		return error;
416 
417 	error = synaptics_model_id(psmouse, info);
418 	if (error)
419 		return error;
420 
421 	error = synaptics_firmware_id(psmouse, info);
422 	if (error)
423 		return error;
424 
425 	error = synaptics_query_modes(psmouse, info);
426 	if (error)
427 		return error;
428 
429 	error = synaptics_capability(psmouse, info);
430 	if (error)
431 		return error;
432 
433 	error = synaptics_resolution(psmouse, info);
434 	if (error)
435 		return error;
436 
437 	return 0;
438 }
439 
440 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS || CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
441 
442 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
443 
444 static bool cr48_profile_sensor;
445 
446 #define ANY_BOARD_ID 0
447 struct min_max_quirk {
448 	const char * const *pnp_ids;
449 	struct {
450 		u32 min, max;
451 	} board_id;
452 	u32 x_min, x_max, y_min, y_max;
453 };
454 
455 static const struct min_max_quirk min_max_pnpid_table[] = {
456 	{
457 		(const char * const []){"LEN0033", NULL},
458 		{ANY_BOARD_ID, ANY_BOARD_ID},
459 		1024, 5052, 2258, 4832
460 	},
461 	{
462 		(const char * const []){"LEN0042", NULL},
463 		{ANY_BOARD_ID, ANY_BOARD_ID},
464 		1232, 5710, 1156, 4696
465 	},
466 	{
467 		(const char * const []){"LEN0034", "LEN0036", "LEN0037",
468 					"LEN0039", "LEN2002", "LEN2004",
469 					NULL},
470 		{ANY_BOARD_ID, 2961},
471 		1024, 5112, 2024, 4832
472 	},
473 	{
474 		(const char * const []){"LEN2000", NULL},
475 		{ANY_BOARD_ID, ANY_BOARD_ID},
476 		1024, 5113, 2021, 4832
477 	},
478 	{
479 		(const char * const []){"LEN2001", NULL},
480 		{ANY_BOARD_ID, ANY_BOARD_ID},
481 		1024, 5022, 2508, 4832
482 	},
483 	{
484 		(const char * const []){"LEN2006", NULL},
485 		{2691, 2691},
486 		1024, 5045, 2457, 4832
487 	},
488 	{
489 		(const char * const []){"LEN2006", NULL},
490 		{ANY_BOARD_ID, ANY_BOARD_ID},
491 		1264, 5675, 1171, 4688
492 	},
493 	{ }
494 };
495 
496 /* This list has been kindly provided by Synaptics. */
497 static const char * const forcepad_pnp_ids[] = {
498 	"SYN300D",
499 	"SYN3014",
500 	NULL
501 };
502 
503 /*****************************************************************************
504  *	Synaptics communications functions
505  ****************************************************************************/
506 
507 /*
508  * Synaptics touchpads report the y coordinate from bottom to top, which is
509  * opposite from what userspace expects.
510  * This function is used to invert y before reporting.
511  */
512 static int synaptics_invert_y(int y)
513 {
514 	return YMAX_NOMINAL + YMIN_NOMINAL - y;
515 }
516 
517 /*
518  * Apply quirk(s) if the hardware matches
519  */
520 static void synaptics_apply_quirks(struct psmouse *psmouse,
521 				   struct synaptics_device_info *info)
522 {
523 	int i;
524 
525 	for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
526 		if (!psmouse_matches_pnp_id(psmouse,
527 					    min_max_pnpid_table[i].pnp_ids))
528 			continue;
529 
530 		if (min_max_pnpid_table[i].board_id.min != ANY_BOARD_ID &&
531 		    info->board_id < min_max_pnpid_table[i].board_id.min)
532 			continue;
533 
534 		if (min_max_pnpid_table[i].board_id.max != ANY_BOARD_ID &&
535 		    info->board_id > min_max_pnpid_table[i].board_id.max)
536 			continue;
537 
538 		info->x_min = min_max_pnpid_table[i].x_min;
539 		info->x_max = min_max_pnpid_table[i].x_max;
540 		info->y_min = min_max_pnpid_table[i].y_min;
541 		info->y_max = min_max_pnpid_table[i].y_max;
542 		psmouse_info(psmouse,
543 			     "quirked min/max coordinates: x [%d..%d], y [%d..%d]\n",
544 			     info->x_min, info->x_max,
545 			     info->y_min, info->y_max);
546 		break;
547 	}
548 }
549 
550 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
551 {
552 	static unsigned char param = 0xc8;
553 	struct synaptics_data *priv = psmouse->private;
554 
555 	if (!(SYN_CAP_ADV_GESTURE(priv->info.ext_cap_0c) ||
556 	      SYN_CAP_IMAGE_SENSOR(priv->info.ext_cap_0c)))
557 		return 0;
558 
559 	if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
560 		return -1;
561 
562 	if (ps2_command(&psmouse->ps2dev, &param, PSMOUSE_CMD_SETRATE))
563 		return -1;
564 
565 	/* Advanced gesture mode also sends multi finger data */
566 	priv->info.capabilities |= BIT(1);
567 
568 	return 0;
569 }
570 
571 static int synaptics_set_mode(struct psmouse *psmouse)
572 {
573 	struct synaptics_data *priv = psmouse->private;
574 
575 	priv->mode = 0;
576 	if (priv->absolute_mode)
577 		priv->mode |= SYN_BIT_ABSOLUTE_MODE;
578 	if (priv->disable_gesture)
579 		priv->mode |= SYN_BIT_DISABLE_GESTURE;
580 	if (psmouse->rate >= 80)
581 		priv->mode |= SYN_BIT_HIGH_RATE;
582 	if (SYN_CAP_EXTENDED(priv->info.capabilities))
583 		priv->mode |= SYN_BIT_W_MODE;
584 
585 	if (synaptics_mode_cmd(psmouse, priv->mode))
586 		return -1;
587 
588 	if (priv->absolute_mode &&
589 	    synaptics_set_advanced_gesture_mode(psmouse)) {
590 		psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
591 		return -1;
592 	}
593 
594 	return 0;
595 }
596 
597 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
598 {
599 	struct synaptics_data *priv = psmouse->private;
600 
601 	if (rate >= 80) {
602 		priv->mode |= SYN_BIT_HIGH_RATE;
603 		psmouse->rate = 80;
604 	} else {
605 		priv->mode &= ~SYN_BIT_HIGH_RATE;
606 		psmouse->rate = 40;
607 	}
608 
609 	synaptics_mode_cmd(psmouse, priv->mode);
610 }
611 
612 /*****************************************************************************
613  *	Synaptics pass-through PS/2 port support
614  ****************************************************************************/
615 static int synaptics_pt_write(struct serio *serio, unsigned char c)
616 {
617 	struct psmouse *parent = serio_get_drvdata(serio->parent);
618 	char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
619 
620 	if (psmouse_sliced_command(parent, c))
621 		return -1;
622 	if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
623 		return -1;
624 	return 0;
625 }
626 
627 static int synaptics_pt_start(struct serio *serio)
628 {
629 	struct psmouse *parent = serio_get_drvdata(serio->parent);
630 	struct synaptics_data *priv = parent->private;
631 
632 	serio_pause_rx(parent->ps2dev.serio);
633 	priv->pt_port = serio;
634 	serio_continue_rx(parent->ps2dev.serio);
635 
636 	return 0;
637 }
638 
639 static void synaptics_pt_stop(struct serio *serio)
640 {
641 	struct psmouse *parent = serio_get_drvdata(serio->parent);
642 	struct synaptics_data *priv = parent->private;
643 
644 	serio_pause_rx(parent->ps2dev.serio);
645 	priv->pt_port = NULL;
646 	serio_continue_rx(parent->ps2dev.serio);
647 }
648 
649 static int synaptics_is_pt_packet(unsigned char *buf)
650 {
651 	return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
652 }
653 
654 static void synaptics_pass_pt_packet(struct serio *ptport,
655 				     unsigned char *packet)
656 {
657 	struct psmouse *child = serio_get_drvdata(ptport);
658 
659 	if (child && child->state == PSMOUSE_ACTIVATED) {
660 		serio_interrupt(ptport, packet[1], 0);
661 		serio_interrupt(ptport, packet[4], 0);
662 		serio_interrupt(ptport, packet[5], 0);
663 		if (child->pktsize == 4)
664 			serio_interrupt(ptport, packet[2], 0);
665 	} else {
666 		serio_interrupt(ptport, packet[1], 0);
667 	}
668 }
669 
670 static void synaptics_pt_activate(struct psmouse *psmouse)
671 {
672 	struct synaptics_data *priv = psmouse->private;
673 	struct psmouse *child = serio_get_drvdata(priv->pt_port);
674 
675 	/* adjust the touchpad to child's choice of protocol */
676 	if (child) {
677 		if (child->pktsize == 4)
678 			priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
679 		else
680 			priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
681 
682 		if (synaptics_mode_cmd(psmouse, priv->mode))
683 			psmouse_warn(psmouse,
684 				     "failed to switch guest protocol\n");
685 	}
686 }
687 
688 static void synaptics_pt_create(struct psmouse *psmouse)
689 {
690 	struct serio *serio;
691 
692 	serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
693 	if (!serio) {
694 		psmouse_err(psmouse,
695 			    "not enough memory for pass-through port\n");
696 		return;
697 	}
698 
699 	serio->id.type = SERIO_PS_PSTHRU;
700 	strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
701 	strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
702 	serio->write = synaptics_pt_write;
703 	serio->start = synaptics_pt_start;
704 	serio->stop = synaptics_pt_stop;
705 	serio->parent = psmouse->ps2dev.serio;
706 
707 	psmouse->pt_activate = synaptics_pt_activate;
708 
709 	psmouse_info(psmouse, "serio: %s port at %s\n",
710 		     serio->name, psmouse->phys);
711 	serio_register_port(serio);
712 }
713 
714 /*****************************************************************************
715  *	Functions to interpret the absolute mode packets
716  ****************************************************************************/
717 
718 static void synaptics_parse_agm(const unsigned char buf[],
719 				struct synaptics_data *priv,
720 				struct synaptics_hw_state *hw)
721 {
722 	struct synaptics_hw_state *agm = &priv->agm;
723 	int agm_packet_type;
724 
725 	agm_packet_type = (buf[5] & 0x30) >> 4;
726 	switch (agm_packet_type) {
727 	case 1:
728 		/* Gesture packet: (x, y, z) half resolution */
729 		agm->w = hw->w;
730 		agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
731 		agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
732 		agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
733 		break;
734 
735 	case 2:
736 		/* AGM-CONTACT packet: we are only interested in the count */
737 		priv->agm_count = buf[1];
738 		break;
739 
740 	default:
741 		break;
742 	}
743 }
744 
745 static void synaptics_parse_ext_buttons(const unsigned char buf[],
746 					struct synaptics_data *priv,
747 					struct synaptics_hw_state *hw)
748 {
749 	unsigned int ext_bits =
750 		(SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap) + 1) >> 1;
751 	unsigned int ext_mask = GENMASK(ext_bits - 1, 0);
752 
753 	hw->ext_buttons = buf[4] & ext_mask;
754 	hw->ext_buttons |= (buf[5] & ext_mask) << ext_bits;
755 }
756 
757 static int synaptics_parse_hw_state(const unsigned char buf[],
758 				    struct synaptics_data *priv,
759 				    struct synaptics_hw_state *hw)
760 {
761 	memset(hw, 0, sizeof(struct synaptics_hw_state));
762 
763 	if (SYN_MODEL_NEWABS(priv->info.model_id)) {
764 		hw->w = (((buf[0] & 0x30) >> 2) |
765 			 ((buf[0] & 0x04) >> 1) |
766 			 ((buf[3] & 0x04) >> 2));
767 
768 		if ((SYN_CAP_ADV_GESTURE(priv->info.ext_cap_0c) ||
769 			SYN_CAP_IMAGE_SENSOR(priv->info.ext_cap_0c)) &&
770 		    hw->w == 2) {
771 			synaptics_parse_agm(buf, priv, hw);
772 			return 1;
773 		}
774 
775 		hw->x = (((buf[3] & 0x10) << 8) |
776 			 ((buf[1] & 0x0f) << 8) |
777 			 buf[4]);
778 		hw->y = (((buf[3] & 0x20) << 7) |
779 			 ((buf[1] & 0xf0) << 4) |
780 			 buf[5]);
781 		hw->z = buf[2];
782 
783 		hw->left  = (buf[0] & 0x01) ? 1 : 0;
784 		hw->right = (buf[0] & 0x02) ? 1 : 0;
785 
786 		if (priv->is_forcepad) {
787 			/*
788 			 * ForcePads, like Clickpads, use middle button
789 			 * bits to report primary button clicks.
790 			 * Unfortunately they report primary button not
791 			 * only when user presses on the pad above certain
792 			 * threshold, but also when there are more than one
793 			 * finger on the touchpad, which interferes with
794 			 * out multi-finger gestures.
795 			 */
796 			if (hw->z == 0) {
797 				/* No contacts */
798 				priv->press = priv->report_press = false;
799 			} else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
800 				/*
801 				 * Single-finger touch with pressure above
802 				 * the threshold. If pressure stays long
803 				 * enough, we'll start reporting primary
804 				 * button. We rely on the device continuing
805 				 * sending data even if finger does not
806 				 * move.
807 				 */
808 				if  (!priv->press) {
809 					priv->press_start = jiffies;
810 					priv->press = true;
811 				} else if (time_after(jiffies,
812 						priv->press_start +
813 							msecs_to_jiffies(50))) {
814 					priv->report_press = true;
815 				}
816 			} else {
817 				priv->press = false;
818 			}
819 
820 			hw->left = priv->report_press;
821 
822 		} else if (SYN_CAP_CLICKPAD(priv->info.ext_cap_0c)) {
823 			/*
824 			 * Clickpad's button is transmitted as middle button,
825 			 * however, since it is primary button, we will report
826 			 * it as BTN_LEFT.
827 			 */
828 			hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
829 
830 		} else if (SYN_CAP_MIDDLE_BUTTON(priv->info.capabilities)) {
831 			hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
832 			if (hw->w == 2)
833 				hw->scroll = (signed char)(buf[1]);
834 		}
835 
836 		if (SYN_CAP_FOUR_BUTTON(priv->info.capabilities)) {
837 			hw->up   = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
838 			hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
839 		}
840 
841 		if (SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap) > 0 &&
842 		    ((buf[0] ^ buf[3]) & 0x02)) {
843 			synaptics_parse_ext_buttons(buf, priv, hw);
844 		}
845 	} else {
846 		hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
847 		hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
848 
849 		hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
850 		hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
851 
852 		hw->left  = (buf[0] & 0x01) ? 1 : 0;
853 		hw->right = (buf[0] & 0x02) ? 1 : 0;
854 	}
855 
856 	/*
857 	 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
858 	 * is used by some firmware to indicate a finger at the edge of
859 	 * the touchpad whose precise position cannot be determined, so
860 	 * convert these values to the maximum axis value.
861 	 */
862 	if (hw->x > X_MAX_POSITIVE)
863 		hw->x -= 1 << ABS_POS_BITS;
864 	else if (hw->x == X_MAX_POSITIVE)
865 		hw->x = XMAX;
866 
867 	if (hw->y > Y_MAX_POSITIVE)
868 		hw->y -= 1 << ABS_POS_BITS;
869 	else if (hw->y == Y_MAX_POSITIVE)
870 		hw->y = YMAX;
871 
872 	return 0;
873 }
874 
875 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
876 					  bool active, int x, int y)
877 {
878 	input_mt_slot(dev, slot);
879 	input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
880 	if (active) {
881 		input_report_abs(dev, ABS_MT_POSITION_X, x);
882 		input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
883 	}
884 }
885 
886 static void synaptics_report_semi_mt_data(struct input_dev *dev,
887 					  const struct synaptics_hw_state *a,
888 					  const struct synaptics_hw_state *b,
889 					  int num_fingers)
890 {
891 	if (num_fingers >= 2) {
892 		synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
893 					      min(a->y, b->y));
894 		synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
895 					      max(a->y, b->y));
896 	} else if (num_fingers == 1) {
897 		synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
898 		synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
899 	} else {
900 		synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
901 		synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
902 	}
903 }
904 
905 static void synaptics_report_ext_buttons(struct psmouse *psmouse,
906 					 const struct synaptics_hw_state *hw)
907 {
908 	struct input_dev *dev = psmouse->dev;
909 	struct synaptics_data *priv = psmouse->private;
910 	int ext_bits = (SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap) + 1) >> 1;
911 	int i;
912 
913 	if (!SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap))
914 		return;
915 
916 	/* Bug in FW 8.1 & 8.2, buttons are reported only when ExtBit is 1 */
917 	if ((SYN_ID_FULL(priv->info.identity) == 0x801 ||
918 	     SYN_ID_FULL(priv->info.identity) == 0x802) &&
919 	    !((psmouse->packet[0] ^ psmouse->packet[3]) & 0x02))
920 		return;
921 
922 	if (!SYN_CAP_EXT_BUTTONS_STICK(priv->info.ext_cap_10)) {
923 		for (i = 0; i < ext_bits; i++) {
924 			input_report_key(dev, BTN_0 + 2 * i,
925 				hw->ext_buttons & (1 << i));
926 			input_report_key(dev, BTN_1 + 2 * i,
927 				hw->ext_buttons & (1 << (i + ext_bits)));
928 		}
929 		return;
930 	}
931 
932 	/*
933 	 * This generation of touchpads has the trackstick buttons
934 	 * physically wired to the touchpad. Re-route them through
935 	 * the pass-through interface.
936 	 */
937 	if (priv->pt_port) {
938 		u8 pt_buttons;
939 
940 		/* The trackstick expects at most 3 buttons */
941 		pt_buttons = SYN_EXT_BUTTON_STICK_L(hw->ext_buttons)      |
942 			     SYN_EXT_BUTTON_STICK_R(hw->ext_buttons) << 1 |
943 			     SYN_EXT_BUTTON_STICK_M(hw->ext_buttons) << 2;
944 
945 		serio_interrupt(priv->pt_port,
946 				PSMOUSE_OOB_EXTRA_BTNS, SERIO_OOB_DATA);
947 		serio_interrupt(priv->pt_port, pt_buttons, SERIO_OOB_DATA);
948 	}
949 }
950 
951 static void synaptics_report_buttons(struct psmouse *psmouse,
952 				     const struct synaptics_hw_state *hw)
953 {
954 	struct input_dev *dev = psmouse->dev;
955 	struct synaptics_data *priv = psmouse->private;
956 
957 	input_report_key(dev, BTN_LEFT, hw->left);
958 	input_report_key(dev, BTN_RIGHT, hw->right);
959 
960 	if (SYN_CAP_MIDDLE_BUTTON(priv->info.capabilities))
961 		input_report_key(dev, BTN_MIDDLE, hw->middle);
962 
963 	if (SYN_CAP_FOUR_BUTTON(priv->info.capabilities)) {
964 		input_report_key(dev, BTN_FORWARD, hw->up);
965 		input_report_key(dev, BTN_BACK, hw->down);
966 	}
967 
968 	synaptics_report_ext_buttons(psmouse, hw);
969 }
970 
971 static void synaptics_report_mt_data(struct psmouse *psmouse,
972 				     const struct synaptics_hw_state *sgm,
973 				     int num_fingers)
974 {
975 	struct input_dev *dev = psmouse->dev;
976 	struct synaptics_data *priv = psmouse->private;
977 	const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
978 	struct input_mt_pos pos[2];
979 	int slot[2], nsemi, i;
980 
981 	nsemi = clamp_val(num_fingers, 0, 2);
982 
983 	for (i = 0; i < nsemi; i++) {
984 		pos[i].x = hw[i]->x;
985 		pos[i].y = synaptics_invert_y(hw[i]->y);
986 	}
987 
988 	input_mt_assign_slots(dev, slot, pos, nsemi, DMAX * priv->info.x_res);
989 
990 	for (i = 0; i < nsemi; i++) {
991 		input_mt_slot(dev, slot[i]);
992 		input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
993 		input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
994 		input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
995 		input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
996 	}
997 
998 	input_mt_drop_unused(dev);
999 
1000 	/* Don't use active slot count to generate BTN_TOOL events. */
1001 	input_mt_report_pointer_emulation(dev, false);
1002 
1003 	/* Send the number of fingers reported by touchpad itself. */
1004 	input_mt_report_finger_count(dev, num_fingers);
1005 
1006 	synaptics_report_buttons(psmouse, sgm);
1007 
1008 	input_sync(dev);
1009 }
1010 
1011 static void synaptics_image_sensor_process(struct psmouse *psmouse,
1012 					   struct synaptics_hw_state *sgm)
1013 {
1014 	struct synaptics_data *priv = psmouse->private;
1015 	int num_fingers;
1016 
1017 	/*
1018 	 * Update mt_state using the new finger count and current mt_state.
1019 	 */
1020 	if (sgm->z == 0)
1021 		num_fingers = 0;
1022 	else if (sgm->w >= 4)
1023 		num_fingers = 1;
1024 	else if (sgm->w == 0)
1025 		num_fingers = 2;
1026 	else if (sgm->w == 1)
1027 		num_fingers = priv->agm_count ? priv->agm_count : 3;
1028 	else
1029 		num_fingers = 4;
1030 
1031 	/* Send resulting input events to user space */
1032 	synaptics_report_mt_data(psmouse, sgm, num_fingers);
1033 }
1034 
1035 /*
1036  *  called for each full received packet from the touchpad
1037  */
1038 static void synaptics_process_packet(struct psmouse *psmouse)
1039 {
1040 	struct input_dev *dev = psmouse->dev;
1041 	struct synaptics_data *priv = psmouse->private;
1042 	struct synaptics_device_info *info = &priv->info;
1043 	struct synaptics_hw_state hw;
1044 	int num_fingers;
1045 	int finger_width;
1046 
1047 	if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
1048 		return;
1049 
1050 	if (SYN_CAP_IMAGE_SENSOR(info->ext_cap_0c)) {
1051 		synaptics_image_sensor_process(psmouse, &hw);
1052 		return;
1053 	}
1054 
1055 	if (hw.scroll) {
1056 		priv->scroll += hw.scroll;
1057 
1058 		while (priv->scroll >= 4) {
1059 			input_report_key(dev, BTN_BACK, !hw.down);
1060 			input_sync(dev);
1061 			input_report_key(dev, BTN_BACK, hw.down);
1062 			input_sync(dev);
1063 			priv->scroll -= 4;
1064 		}
1065 		while (priv->scroll <= -4) {
1066 			input_report_key(dev, BTN_FORWARD, !hw.up);
1067 			input_sync(dev);
1068 			input_report_key(dev, BTN_FORWARD, hw.up);
1069 			input_sync(dev);
1070 			priv->scroll += 4;
1071 		}
1072 		return;
1073 	}
1074 
1075 	if (hw.z > 0 && hw.x > 1) {
1076 		num_fingers = 1;
1077 		finger_width = 5;
1078 		if (SYN_CAP_EXTENDED(info->capabilities)) {
1079 			switch (hw.w) {
1080 			case 0 ... 1:
1081 				if (SYN_CAP_MULTIFINGER(info->capabilities))
1082 					num_fingers = hw.w + 2;
1083 				break;
1084 			case 2:
1085 				if (SYN_MODEL_PEN(info->model_id))
1086 					;   /* Nothing, treat a pen as a single finger */
1087 				break;
1088 			case 4 ... 15:
1089 				if (SYN_CAP_PALMDETECT(info->capabilities))
1090 					finger_width = hw.w;
1091 				break;
1092 			}
1093 		}
1094 	} else {
1095 		num_fingers = 0;
1096 		finger_width = 0;
1097 	}
1098 
1099 	if (cr48_profile_sensor) {
1100 		synaptics_report_mt_data(psmouse, &hw, num_fingers);
1101 		return;
1102 	}
1103 
1104 	if (SYN_CAP_ADV_GESTURE(info->ext_cap_0c))
1105 		synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
1106 					      num_fingers);
1107 
1108 	/* Post events
1109 	 * BTN_TOUCH has to be first as mousedev relies on it when doing
1110 	 * absolute -> relative conversion
1111 	 */
1112 	if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
1113 	if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
1114 
1115 	if (num_fingers > 0) {
1116 		input_report_abs(dev, ABS_X, hw.x);
1117 		input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
1118 	}
1119 	input_report_abs(dev, ABS_PRESSURE, hw.z);
1120 
1121 	if (SYN_CAP_PALMDETECT(info->capabilities))
1122 		input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
1123 
1124 	input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
1125 	if (SYN_CAP_MULTIFINGER(info->capabilities)) {
1126 		input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
1127 		input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
1128 	}
1129 
1130 	synaptics_report_buttons(psmouse, &hw);
1131 
1132 	input_sync(dev);
1133 }
1134 
1135 static int synaptics_validate_byte(struct psmouse *psmouse,
1136 				   int idx, unsigned char pkt_type)
1137 {
1138 	static const unsigned char newabs_mask[]	= { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
1139 	static const unsigned char newabs_rel_mask[]	= { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
1140 	static const unsigned char newabs_rslt[]	= { 0x80, 0x00, 0x00, 0xC0, 0x00 };
1141 	static const unsigned char oldabs_mask[]	= { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
1142 	static const unsigned char oldabs_rslt[]	= { 0xC0, 0x00, 0x00, 0x80, 0x00 };
1143 	const char *packet = psmouse->packet;
1144 
1145 	if (idx < 0 || idx > 4)
1146 		return 0;
1147 
1148 	switch (pkt_type) {
1149 
1150 	case SYN_NEWABS:
1151 	case SYN_NEWABS_RELAXED:
1152 		return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
1153 
1154 	case SYN_NEWABS_STRICT:
1155 		return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
1156 
1157 	case SYN_OLDABS:
1158 		return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
1159 
1160 	default:
1161 		psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
1162 		return 0;
1163 	}
1164 }
1165 
1166 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
1167 {
1168 	int i;
1169 
1170 	for (i = 0; i < 5; i++)
1171 		if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
1172 			psmouse_info(psmouse, "using relaxed packet validation\n");
1173 			return SYN_NEWABS_RELAXED;
1174 		}
1175 
1176 	return SYN_NEWABS_STRICT;
1177 }
1178 
1179 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1180 {
1181 	struct synaptics_data *priv = psmouse->private;
1182 
1183 	if (psmouse->pktcnt >= 6) { /* Full packet received */
1184 		if (unlikely(priv->pkt_type == SYN_NEWABS))
1185 			priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1186 
1187 		if (SYN_CAP_PASS_THROUGH(priv->info.capabilities) &&
1188 		    synaptics_is_pt_packet(psmouse->packet)) {
1189 			if (priv->pt_port)
1190 				synaptics_pass_pt_packet(priv->pt_port,
1191 							 psmouse->packet);
1192 		} else
1193 			synaptics_process_packet(psmouse);
1194 
1195 		return PSMOUSE_FULL_PACKET;
1196 	}
1197 
1198 	return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1199 		PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1200 }
1201 
1202 /*****************************************************************************
1203  *	Driver initialization/cleanup functions
1204  ****************************************************************************/
1205 static void set_abs_position_params(struct input_dev *dev,
1206 				    struct synaptics_device_info *info,
1207 				    int x_code, int y_code)
1208 {
1209 	int x_min = info->x_min ?: XMIN_NOMINAL;
1210 	int x_max = info->x_max ?: XMAX_NOMINAL;
1211 	int y_min = info->y_min ?: YMIN_NOMINAL;
1212 	int y_max = info->y_max ?: YMAX_NOMINAL;
1213 	int fuzz = SYN_CAP_REDUCED_FILTERING(info->ext_cap_0c) ?
1214 			SYN_REDUCED_FILTER_FUZZ : 0;
1215 
1216 	input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1217 	input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1218 	input_abs_set_res(dev, x_code, info->x_res);
1219 	input_abs_set_res(dev, y_code, info->y_res);
1220 }
1221 
1222 static void set_input_params(struct psmouse *psmouse,
1223 			     struct synaptics_data *priv)
1224 {
1225 	struct input_dev *dev = psmouse->dev;
1226 	struct synaptics_device_info *info = &priv->info;
1227 	int i;
1228 
1229 	/* Things that apply to both modes */
1230 	__set_bit(INPUT_PROP_POINTER, dev->propbit);
1231 	__set_bit(EV_KEY, dev->evbit);
1232 	__set_bit(BTN_LEFT, dev->keybit);
1233 	__set_bit(BTN_RIGHT, dev->keybit);
1234 
1235 	if (SYN_CAP_MIDDLE_BUTTON(info->capabilities))
1236 		__set_bit(BTN_MIDDLE, dev->keybit);
1237 
1238 	if (!priv->absolute_mode) {
1239 		/* Relative mode */
1240 		__set_bit(EV_REL, dev->evbit);
1241 		__set_bit(REL_X, dev->relbit);
1242 		__set_bit(REL_Y, dev->relbit);
1243 		return;
1244 	}
1245 
1246 	/* Absolute mode */
1247 	__set_bit(EV_ABS, dev->evbit);
1248 	set_abs_position_params(dev, &priv->info, ABS_X, ABS_Y);
1249 	input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1250 
1251 	if (cr48_profile_sensor)
1252 		input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1253 
1254 	if (SYN_CAP_IMAGE_SENSOR(info->ext_cap_0c)) {
1255 		set_abs_position_params(dev, info,
1256 					ABS_MT_POSITION_X, ABS_MT_POSITION_Y);
1257 		/* Image sensors can report per-contact pressure */
1258 		input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1259 		input_mt_init_slots(dev, 2, INPUT_MT_POINTER | INPUT_MT_TRACK);
1260 
1261 		/* Image sensors can signal 4 and 5 finger clicks */
1262 		__set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1263 		__set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1264 	} else if (SYN_CAP_ADV_GESTURE(info->ext_cap_0c)) {
1265 		set_abs_position_params(dev, info,
1266 					ABS_MT_POSITION_X, ABS_MT_POSITION_Y);
1267 		/*
1268 		 * Profile sensor in CR-48 tracks contacts reasonably well,
1269 		 * other non-image sensors with AGM use semi-mt.
1270 		 */
1271 		input_mt_init_slots(dev, 2,
1272 				    INPUT_MT_POINTER |
1273 				    (cr48_profile_sensor ?
1274 					INPUT_MT_TRACK : INPUT_MT_SEMI_MT));
1275 	}
1276 
1277 	if (SYN_CAP_PALMDETECT(info->capabilities))
1278 		input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1279 
1280 	__set_bit(BTN_TOUCH, dev->keybit);
1281 	__set_bit(BTN_TOOL_FINGER, dev->keybit);
1282 
1283 	if (SYN_CAP_MULTIFINGER(info->capabilities)) {
1284 		__set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1285 		__set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1286 	}
1287 
1288 	if (SYN_CAP_FOUR_BUTTON(info->capabilities) ||
1289 	    SYN_CAP_MIDDLE_BUTTON(info->capabilities)) {
1290 		__set_bit(BTN_FORWARD, dev->keybit);
1291 		__set_bit(BTN_BACK, dev->keybit);
1292 	}
1293 
1294 	if (!SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10))
1295 		for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(info->ext_cap); i++)
1296 			__set_bit(BTN_0 + i, dev->keybit);
1297 
1298 	__clear_bit(EV_REL, dev->evbit);
1299 	__clear_bit(REL_X, dev->relbit);
1300 	__clear_bit(REL_Y, dev->relbit);
1301 
1302 	if (SYN_CAP_CLICKPAD(info->ext_cap_0c)) {
1303 		__set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1304 		if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids) &&
1305 		    !SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10))
1306 			__set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1307 		/* Clickpads report only left button */
1308 		__clear_bit(BTN_RIGHT, dev->keybit);
1309 		__clear_bit(BTN_MIDDLE, dev->keybit);
1310 	}
1311 }
1312 
1313 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1314 					      void *data, char *buf)
1315 {
1316 	struct synaptics_data *priv = psmouse->private;
1317 
1318 	return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1319 }
1320 
1321 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1322 					     void *data, const char *buf,
1323 					     size_t len)
1324 {
1325 	struct synaptics_data *priv = psmouse->private;
1326 	unsigned int value;
1327 	int err;
1328 
1329 	err = kstrtouint(buf, 10, &value);
1330 	if (err)
1331 		return err;
1332 
1333 	if (value > 1)
1334 		return -EINVAL;
1335 
1336 	if (value == priv->disable_gesture)
1337 		return len;
1338 
1339 	priv->disable_gesture = value;
1340 	if (value)
1341 		priv->mode |= SYN_BIT_DISABLE_GESTURE;
1342 	else
1343 		priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1344 
1345 	if (synaptics_mode_cmd(psmouse, priv->mode))
1346 		return -EIO;
1347 
1348 	return len;
1349 }
1350 
1351 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1352 		    synaptics_show_disable_gesture,
1353 		    synaptics_set_disable_gesture);
1354 
1355 static void synaptics_disconnect(struct psmouse *psmouse)
1356 {
1357 	struct synaptics_data *priv = psmouse->private;
1358 
1359 	/*
1360 	 * We might have left a breadcrumb when trying to
1361 	 * set up SMbus companion.
1362 	 */
1363 	psmouse_smbus_cleanup(psmouse);
1364 
1365 	if (!priv->absolute_mode &&
1366 			SYN_ID_DISGEST_SUPPORTED(priv->info.identity))
1367 		device_remove_file(&psmouse->ps2dev.serio->dev,
1368 				   &psmouse_attr_disable_gesture.dattr);
1369 
1370 	synaptics_reset(psmouse);
1371 	kfree(priv);
1372 	psmouse->private = NULL;
1373 }
1374 
1375 static int synaptics_reconnect(struct psmouse *psmouse)
1376 {
1377 	struct synaptics_data *priv = psmouse->private;
1378 	struct synaptics_device_info info;
1379 	unsigned char param[2];
1380 	int retry = 0;
1381 	int error;
1382 
1383 	do {
1384 		psmouse_reset(psmouse);
1385 		if (retry) {
1386 			/*
1387 			 * On some boxes, right after resuming, the touchpad
1388 			 * needs some time to finish initializing (I assume
1389 			 * it needs time to calibrate) and start responding
1390 			 * to Synaptics-specific queries, so let's wait a
1391 			 * bit.
1392 			 */
1393 			ssleep(1);
1394 		}
1395 		ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1396 		error = synaptics_detect(psmouse, 0);
1397 	} while (error && ++retry < 3);
1398 
1399 	if (error)
1400 		return -1;
1401 
1402 	if (retry > 1)
1403 		psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1404 
1405 	if (synaptics_query_hardware(psmouse, &info)) {
1406 		psmouse_err(psmouse, "Unable to query device.\n");
1407 		return -1;
1408 	}
1409 
1410 	if (synaptics_set_mode(psmouse)) {
1411 		psmouse_err(psmouse, "Unable to initialize device.\n");
1412 		return -1;
1413 	}
1414 
1415 	if (info.identity != priv->info.identity ||
1416 	    info.model_id != priv->info.model_id ||
1417 	    info.capabilities != priv->info.capabilities ||
1418 	    info.ext_cap != priv->info.ext_cap) {
1419 		psmouse_err(psmouse,
1420 			    "hardware appears to be different: id(%u-%u), model(%u-%u), caps(%x-%x), ext(%x-%x).\n",
1421 			    priv->info.identity, info.identity,
1422 			    priv->info.model_id, info.model_id,
1423 			    priv->info.capabilities, info.capabilities,
1424 			    priv->info.ext_cap, info.ext_cap);
1425 		return -1;
1426 	}
1427 
1428 	return 0;
1429 }
1430 
1431 static bool impaired_toshiba_kbc;
1432 
1433 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1434 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1435 	{
1436 		/* Toshiba Satellite */
1437 		.matches = {
1438 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1439 			DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1440 		},
1441 	},
1442 	{
1443 		/* Toshiba Dynabook */
1444 		.matches = {
1445 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1446 			DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1447 		},
1448 	},
1449 	{
1450 		/* Toshiba Portege M300 */
1451 		.matches = {
1452 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1453 			DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1454 		},
1455 
1456 	},
1457 	{
1458 		/* Toshiba Portege M300 */
1459 		.matches = {
1460 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1461 			DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1462 			DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1463 		},
1464 
1465 	},
1466 #endif
1467 	{ }
1468 };
1469 
1470 static bool broken_olpc_ec;
1471 
1472 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1473 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1474 	{
1475 		/* OLPC XO-1 or XO-1.5 */
1476 		.matches = {
1477 			DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1478 			DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1479 		},
1480 	},
1481 #endif
1482 	{ }
1483 };
1484 
1485 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1486 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1487 	{
1488 		/* Cr-48 Chromebook (Codename Mario) */
1489 		.matches = {
1490 			DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1491 			DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1492 		},
1493 	},
1494 #endif
1495 	{ }
1496 };
1497 
1498 void __init synaptics_module_init(void)
1499 {
1500 	impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1501 	broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1502 	cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1503 }
1504 
1505 static int synaptics_init_ps2(struct psmouse *psmouse,
1506 			      struct synaptics_device_info *info,
1507 			      bool absolute_mode)
1508 {
1509 	struct synaptics_data *priv;
1510 	int err;
1511 
1512 	synaptics_apply_quirks(psmouse, info);
1513 
1514 	psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1515 	if (!priv)
1516 		return -ENOMEM;
1517 
1518 	priv->info = *info;
1519 	priv->absolute_mode = absolute_mode;
1520 	if (SYN_ID_DISGEST_SUPPORTED(info->identity))
1521 		priv->disable_gesture = true;
1522 
1523 	/*
1524 	 * Unfortunately ForcePad capability is not exported over PS/2,
1525 	 * so we have to resort to checking PNP IDs.
1526 	 */
1527 	priv->is_forcepad = psmouse_matches_pnp_id(psmouse, forcepad_pnp_ids);
1528 
1529 	err = synaptics_set_mode(psmouse);
1530 	if (err) {
1531 		psmouse_err(psmouse, "Unable to initialize device.\n");
1532 		goto init_fail;
1533 	}
1534 
1535 	priv->pkt_type = SYN_MODEL_NEWABS(info->model_id) ?
1536 					SYN_NEWABS : SYN_OLDABS;
1537 
1538 	psmouse_info(psmouse,
1539 		     "Touchpad model: %u, fw: %u.%u, id: %#x, caps: %#x/%#x/%#x/%#x, board id: %u, fw id: %u\n",
1540 		     SYN_ID_MODEL(info->identity),
1541 		     SYN_ID_MAJOR(info->identity), SYN_ID_MINOR(info->identity),
1542 		     info->model_id,
1543 		     info->capabilities, info->ext_cap, info->ext_cap_0c,
1544 		     info->ext_cap_10, info->board_id, info->firmware_id);
1545 
1546 	set_input_params(psmouse, priv);
1547 
1548 	/*
1549 	 * Encode touchpad model so that it can be used to set
1550 	 * input device->id.version and be visible to userspace.
1551 	 * Because version is __u16 we have to drop something.
1552 	 * Hardware info bits seem to be good candidates as they
1553 	 * are documented to be for Synaptics corp. internal use.
1554 	 */
1555 	psmouse->model = ((info->model_id & 0x00ff0000) >> 8) |
1556 			  (info->model_id & 0x000000ff);
1557 
1558 	if (absolute_mode) {
1559 		psmouse->protocol_handler = synaptics_process_byte;
1560 		psmouse->pktsize = 6;
1561 	} else {
1562 		/* Relative mode follows standard PS/2 mouse protocol */
1563 		psmouse->protocol_handler = psmouse_process_byte;
1564 		psmouse->pktsize = 3;
1565 	}
1566 
1567 	psmouse->set_rate = synaptics_set_rate;
1568 	psmouse->disconnect = synaptics_disconnect;
1569 	psmouse->reconnect = synaptics_reconnect;
1570 	psmouse->cleanup = synaptics_reset;
1571 	/* Synaptics can usually stay in sync without extra help */
1572 	psmouse->resync_time = 0;
1573 
1574 	if (SYN_CAP_PASS_THROUGH(info->capabilities))
1575 		synaptics_pt_create(psmouse);
1576 
1577 	/*
1578 	 * Toshiba's KBC seems to have trouble handling data from
1579 	 * Synaptics at full rate.  Switch to a lower rate (roughly
1580 	 * the same rate as a standard PS/2 mouse).
1581 	 */
1582 	if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1583 		psmouse_info(psmouse,
1584 			     "Toshiba %s detected, limiting rate to 40pps.\n",
1585 			     dmi_get_system_info(DMI_PRODUCT_NAME));
1586 		psmouse->rate = 40;
1587 	}
1588 
1589 	if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(info->identity)) {
1590 		err = device_create_file(&psmouse->ps2dev.serio->dev,
1591 					 &psmouse_attr_disable_gesture.dattr);
1592 		if (err) {
1593 			psmouse_err(psmouse,
1594 				    "Failed to create disable_gesture attribute (%d)",
1595 				    err);
1596 			goto init_fail;
1597 		}
1598 	}
1599 
1600 	return 0;
1601 
1602  init_fail:
1603 	kfree(priv);
1604 	return err;
1605 }
1606 
1607 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1608 {
1609 	struct synaptics_device_info info;
1610 	int error;
1611 
1612 	psmouse_reset(psmouse);
1613 
1614 	error = synaptics_query_hardware(psmouse, &info);
1615 	if (error) {
1616 		psmouse_err(psmouse, "Unable to query device: %d\n", error);
1617 		return error;
1618 	}
1619 
1620 	return synaptics_init_ps2(psmouse, &info, absolute_mode);
1621 }
1622 
1623 int synaptics_init_absolute(struct psmouse *psmouse)
1624 {
1625 	return __synaptics_init(psmouse, true);
1626 }
1627 
1628 int synaptics_init_relative(struct psmouse *psmouse)
1629 {
1630 	return __synaptics_init(psmouse, false);
1631 }
1632 
1633 static int synaptics_setup_ps2(struct psmouse *psmouse,
1634 			       struct synaptics_device_info *info)
1635 {
1636 	bool absolute_mode = true;
1637 	int error;
1638 
1639 	/*
1640 	 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1641 	 * packet spew overloads the EC such that key presses on the keyboard
1642 	 * are missed.  Given that, don't even attempt to use Absolute mode.
1643 	 * Relative mode seems to work just fine.
1644 	 */
1645 	if (broken_olpc_ec) {
1646 		psmouse_info(psmouse,
1647 			     "OLPC XO detected, forcing relative protocol.\n");
1648 		absolute_mode = false;
1649 	}
1650 
1651 	error = synaptics_init_ps2(psmouse, info, absolute_mode);
1652 	if (error)
1653 		return error;
1654 
1655 	return absolute_mode ? PSMOUSE_SYNAPTICS : PSMOUSE_SYNAPTICS_RELATIVE;
1656 }
1657 
1658 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1659 
1660 void __init synaptics_module_init(void)
1661 {
1662 }
1663 
1664 static int __maybe_unused
1665 synaptics_setup_ps2(struct psmouse *psmouse,
1666 		    struct synaptics_device_info *info)
1667 {
1668 	return -ENOSYS;
1669 }
1670 
1671 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */
1672 
1673 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS
1674 
1675 /*
1676  * The newest Synaptics device can use a secondary bus (called InterTouch) which
1677  * provides a better bandwidth and allow a better control of the touchpads.
1678  * This is used to decide if we need to use this bus or not.
1679  */
1680 enum {
1681 	SYNAPTICS_INTERTOUCH_NOT_SET = -1,
1682 	SYNAPTICS_INTERTOUCH_OFF,
1683 	SYNAPTICS_INTERTOUCH_ON,
1684 };
1685 
1686 static int synaptics_intertouch = SYNAPTICS_INTERTOUCH_NOT_SET;
1687 module_param_named(synaptics_intertouch, synaptics_intertouch, int, 0644);
1688 MODULE_PARM_DESC(synaptics_intertouch, "Use a secondary bus for the Synaptics device.");
1689 
1690 static int synaptics_create_intertouch(struct psmouse *psmouse,
1691 				       struct synaptics_device_info *info,
1692 				       bool leave_breadcrumbs)
1693 {
1694 	bool topbuttonpad =
1695 		psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids) &&
1696 		!SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10);
1697 	const struct rmi_device_platform_data pdata = {
1698 		.sensor_pdata = {
1699 			.sensor_type = rmi_sensor_touchpad,
1700 			.axis_align.flip_y = true,
1701 			/* to prevent cursors jumps: */
1702 			.kernel_tracking = true,
1703 			.topbuttonpad = topbuttonpad,
1704 		},
1705 		.f30_data = {
1706 			.buttonpad = SYN_CAP_CLICKPAD(info->ext_cap_0c),
1707 			.trackstick_buttons =
1708 				!!SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10),
1709 		},
1710 	};
1711 	const struct i2c_board_info intertouch_board = {
1712 		I2C_BOARD_INFO("rmi4_smbus", 0x2c),
1713 		.flags = I2C_CLIENT_HOST_NOTIFY,
1714 	};
1715 
1716 	return psmouse_smbus_init(psmouse, &intertouch_board,
1717 				  &pdata, sizeof(pdata),
1718 				  leave_breadcrumbs);
1719 }
1720 
1721 /**
1722  * synaptics_setup_intertouch - called once the PS/2 devices are enumerated
1723  * and decides to instantiate a SMBus InterTouch device.
1724  */
1725 static int synaptics_setup_intertouch(struct psmouse *psmouse,
1726 				      struct synaptics_device_info *info,
1727 				      bool leave_breadcrumbs)
1728 {
1729 	int error;
1730 
1731 	if (synaptics_intertouch == SYNAPTICS_INTERTOUCH_OFF)
1732 		return -ENXIO;
1733 
1734 	if (synaptics_intertouch == SYNAPTICS_INTERTOUCH_NOT_SET) {
1735 		if (!psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids) &&
1736 		    !psmouse_matches_pnp_id(psmouse, smbus_pnp_ids))
1737 			return -ENXIO;
1738 	}
1739 
1740 	psmouse_info(psmouse, "Trying to set up SMBus access\n");
1741 
1742 	error = synaptics_create_intertouch(psmouse, info, leave_breadcrumbs);
1743 	if (error) {
1744 		if (error == -EAGAIN)
1745 			psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1746 		else
1747 			psmouse_err(psmouse, "unable to create intertouch device\n");
1748 
1749 		return error;
1750 	}
1751 
1752 	return 0;
1753 }
1754 
1755 int synaptics_init_smbus(struct psmouse *psmouse)
1756 {
1757 	struct synaptics_device_info info;
1758 	int error;
1759 
1760 	psmouse_reset(psmouse);
1761 
1762 	error = synaptics_query_hardware(psmouse, &info);
1763 	if (error) {
1764 		psmouse_err(psmouse, "Unable to query device: %d\n", error);
1765 		return error;
1766 	}
1767 
1768 	if (!SYN_CAP_INTERTOUCH(info.ext_cap_0c))
1769 		return -ENXIO;
1770 
1771 	return synaptics_create_intertouch(psmouse, &info, false);
1772 }
1773 
1774 #else /* CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1775 
1776 static int __maybe_unused
1777 synaptics_setup_intertouch(struct psmouse *psmouse,
1778 			   struct synaptics_device_info *info,
1779 			   bool leave_breadcrumbs)
1780 {
1781 	return -ENOSYS;
1782 }
1783 
1784 int synaptics_init_smbus(struct psmouse *psmouse)
1785 {
1786 	return -ENOSYS;
1787 }
1788 
1789 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1790 
1791 #if defined(CONFIG_MOUSE_PS2_SYNAPTICS) || \
1792     defined(CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS)
1793 
1794 int synaptics_init(struct psmouse *psmouse)
1795 {
1796 	struct synaptics_device_info info;
1797 	int error;
1798 	int retval;
1799 
1800 	psmouse_reset(psmouse);
1801 
1802 	error = synaptics_query_hardware(psmouse, &info);
1803 	if (error) {
1804 		psmouse_err(psmouse, "Unable to query device: %d\n", error);
1805 		return error;
1806 	}
1807 
1808 	if (SYN_CAP_INTERTOUCH(info.ext_cap_0c)) {
1809 		error = synaptics_setup_intertouch(psmouse, &info, true);
1810 		if (!error)
1811 			return PSMOUSE_SYNAPTICS_SMBUS;
1812 	}
1813 
1814 	retval = synaptics_setup_ps2(psmouse, &info);
1815 	if (retval < 0) {
1816 		/*
1817 		 * Not using any flavor of Synaptics support, so clean up
1818 		 * SMbus breadcrumbs, if any.
1819 		 */
1820 		psmouse_smbus_cleanup(psmouse);
1821 	}
1822 
1823 	return retval;
1824 }
1825 
1826 #else /* CONFIG_MOUSE_PS2_SYNAPTICS || CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1827 
1828 int synaptics_init(struct psmouse *psmouse)
1829 {
1830 	return -ENOSYS;
1831 }
1832 
1833 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS || CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1834