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