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