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