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