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