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