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