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