2 * Synaptics TouchPad PS/2 mouse driver
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.
8 * 2003 Peter Osterlund <petero2@telia.com>
9 * Ported to 2.5 input device infrastructure.
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)
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)
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.
23 * Trademarks are the property of their respective owners.
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>
36 #include "synaptics.h"
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
49 #define XMIN_NOMINAL 1472
50 #define XMAX_NOMINAL 5472
51 #define YMIN_NOMINAL 1408
52 #define YMAX_NOMINAL 4448
54 /* Size in bits of absolute position values reported by the hardware */
55 #define ABS_POS_BITS 13
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.
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.
69 #define X_MAX_POSITIVE 8176
70 #define Y_MAX_POSITIVE 8176
72 /* maximum ABS_MT_POSITION displacement (in mm) */
75 /*****************************************************************************
76 * Stuff we need even when we do not want native Synaptics support
77 ****************************************************************************/
80 * Set the synaptics touchpad mode byte by special commands
82 static int synaptics_mode_cmd(struct psmouse *psmouse, u8 mode)
87 error = ps2_sliced_command(&psmouse->ps2dev, mode);
91 param[0] = SYN_PS_SET_MODE2;
92 error = ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE);
99 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
101 struct ps2dev *ps2dev = &psmouse->ps2dev;
104 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
105 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
106 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
107 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
108 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
110 if (param[1] != 0x47)
113 if (set_properties) {
114 psmouse->vendor = "Synaptics";
115 psmouse->name = "TouchPad";
121 void synaptics_reset(struct psmouse *psmouse)
123 /* reset touchpad back to relative mode, gestures enabled */
124 synaptics_mode_cmd(psmouse, 0);
127 #if defined(CONFIG_MOUSE_PS2_SYNAPTICS) || \
128 defined(CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS)
130 /* This list has been kindly provided by Synaptics. */
131 static const char * const topbuttonpad_pnp_ids[] = {
141 "LEN0033", /* Helix */
142 "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
143 "LEN0035", /* X240 */
144 "LEN0036", /* T440 */
145 "LEN0037", /* X1 Carbon 2nd */
147 "LEN0039", /* T440s */
149 "LEN0042", /* Yoga */
153 "LEN2000", /* S540 */
154 "LEN2001", /* Edge E431 */
155 "LEN2002", /* Edge E531 */
157 "LEN2004", /* L440 */
159 "LEN2006", /* Edge E440/E540 */
168 static const char * const smbus_pnp_ids[] = {
169 /* all of the topbuttonpad_pnp_ids are valid, we just add some extras */
170 "LEN0048", /* X1 Carbon 3 */
171 "LEN0046", /* X250 */
172 "LEN004a", /* W541 */
174 "LEN005e", /* T560 */
175 "LEN0071", /* T480 */
176 "LEN0072", /* X1 Carbon Gen 5 (2017) - Elan/ALPS trackpoint */
177 "LEN0073", /* X1 Carbon G5 (Elantech) */
178 "LEN0092", /* X1 Carbon 6 */
179 "LEN0096", /* X280 */
180 "LEN0097", /* X280 -> ALPS trackpoint */
181 "LEN009b", /* T580 */
182 "LEN200f", /* T450s */
183 "SYN3052", /* HP EliteBook 840 G4 */
184 "SYN3221", /* HP 15-ay000 */
188 static const char * const forcepad_pnp_ids[] = {
195 * Send a command to the synpatics touchpad by special commands
197 static int synaptics_send_cmd(struct psmouse *psmouse, u8 cmd, u8 *param)
201 error = ps2_sliced_command(&psmouse->ps2dev, cmd);
205 error = ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO);
212 static int synaptics_query_int(struct psmouse *psmouse, u8 query_cmd, u32 *val)
220 error = synaptics_send_cmd(psmouse, query_cmd, resp.buf + 1);
224 *val = be32_to_cpu(resp.be_val);
230 * See also the SYN_ID_* macros
232 static int synaptics_identify(struct psmouse *psmouse,
233 struct synaptics_device_info *info)
237 error = synaptics_query_int(psmouse, SYN_QUE_IDENTIFY, &info->identity);
241 return SYN_ID_IS_SYNAPTICS(info->identity) ? 0 : -ENXIO;
245 * Read the model-id bytes from the touchpad
246 * see also SYN_MODEL_* macros
248 static int synaptics_model_id(struct psmouse *psmouse,
249 struct synaptics_device_info *info)
251 return synaptics_query_int(psmouse, SYN_QUE_MODEL, &info->model_id);
255 * Read the firmware id from the touchpad
257 static int synaptics_firmware_id(struct psmouse *psmouse,
258 struct synaptics_device_info *info)
260 return synaptics_query_int(psmouse, SYN_QUE_FIRMWARE_ID,
265 * Read the board id and the "More Extended Queries" from the touchpad
266 * The board id is encoded in the "QUERY MODES" response
268 static int synaptics_query_modes(struct psmouse *psmouse,
269 struct synaptics_device_info *info)
274 /* firmwares prior 7.5 have no board_id encoded */
275 if (SYN_ID_FULL(info->identity) < 0x705)
278 error = synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid);
282 info->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
284 if (SYN_MEXT_CAP_BIT(bid[0]))
285 return synaptics_query_int(psmouse, SYN_QUE_MEXT_CAPAB_10,
292 * Read the capability-bits from the touchpad
293 * see also the SYN_CAP_* macros
295 static int synaptics_capability(struct psmouse *psmouse,
296 struct synaptics_device_info *info)
300 error = synaptics_query_int(psmouse, SYN_QUE_CAPABILITIES,
301 &info->capabilities);
305 info->ext_cap = info->ext_cap_0c = 0;
308 * Older firmwares had submodel ID fixed to 0x47
310 if (SYN_ID_FULL(info->identity) < 0x705 &&
311 SYN_CAP_SUBMODEL_ID(info->capabilities) != 0x47) {
316 * Unless capExtended is set the rest of the flags should be ignored
318 if (!SYN_CAP_EXTENDED(info->capabilities))
319 info->capabilities = 0;
321 if (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 1) {
322 error = synaptics_query_int(psmouse, SYN_QUE_EXT_CAPAB,
325 psmouse_warn(psmouse,
326 "device claims to have extended capabilities, but I'm not able to read them.\n");
329 * if nExtBtn is greater than 8 it should be considered
330 * invalid and treated as 0
332 if (SYN_CAP_MULTI_BUTTON_NO(info->ext_cap) > 8)
333 info->ext_cap &= ~SYN_CAP_MB_MASK;
337 if (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 4) {
338 error = synaptics_query_int(psmouse, SYN_QUE_EXT_CAPAB_0C,
341 psmouse_warn(psmouse,
342 "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
349 * Read touchpad resolution and maximum reported coordinates
350 * Resolution is left zero if touchpad does not support the query
352 static int synaptics_resolution(struct psmouse *psmouse,
353 struct synaptics_device_info *info)
358 if (SYN_ID_MAJOR(info->identity) < 4)
361 error = synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp);
363 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
364 info->x_res = resp[0]; /* x resolution in units/mm */
365 info->y_res = resp[2]; /* y resolution in units/mm */
369 if (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 5 &&
370 SYN_CAP_MAX_DIMENSIONS(info->ext_cap_0c)) {
371 error = synaptics_send_cmd(psmouse,
372 SYN_QUE_EXT_MAX_COORDS, resp);
374 psmouse_warn(psmouse,
375 "device claims to have max coordinates query, but I'm not able to read it.\n");
377 info->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
378 info->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
379 psmouse_info(psmouse,
380 "queried max coordinates: x [..%d], y [..%d]\n",
381 info->x_max, info->y_max);
385 if (SYN_CAP_MIN_DIMENSIONS(info->ext_cap_0c) &&
386 (SYN_EXT_CAP_REQUESTS(info->capabilities) >= 7 ||
388 * Firmware v8.1 does not report proper number of extended
389 * capabilities, but has been proven to report correct min
392 SYN_ID_FULL(info->identity) == 0x801)) {
393 error = synaptics_send_cmd(psmouse,
394 SYN_QUE_EXT_MIN_COORDS, resp);
396 psmouse_warn(psmouse,
397 "device claims to have min coordinates query, but I'm not able to read it.\n");
399 info->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
400 info->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
401 psmouse_info(psmouse,
402 "queried min coordinates: x [%d..], y [%d..]\n",
403 info->x_min, info->y_min);
410 static int synaptics_query_hardware(struct psmouse *psmouse,
411 struct synaptics_device_info *info)
415 memset(info, 0, sizeof(*info));
417 error = synaptics_identify(psmouse, info);
421 error = synaptics_model_id(psmouse, info);
425 error = synaptics_firmware_id(psmouse, info);
429 error = synaptics_query_modes(psmouse, info);
433 error = synaptics_capability(psmouse, info);
437 error = synaptics_resolution(psmouse, info);
444 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS || CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
446 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
448 static bool cr48_profile_sensor;
450 #define ANY_BOARD_ID 0
451 struct min_max_quirk {
452 const char * const *pnp_ids;
456 u32 x_min, x_max, y_min, y_max;
459 static const struct min_max_quirk min_max_pnpid_table[] = {
461 (const char * const []){"LEN0033", NULL},
462 {ANY_BOARD_ID, ANY_BOARD_ID},
463 1024, 5052, 2258, 4832
466 (const char * const []){"LEN0042", NULL},
467 {ANY_BOARD_ID, ANY_BOARD_ID},
468 1232, 5710, 1156, 4696
471 (const char * const []){"LEN0034", "LEN0036", "LEN0037",
472 "LEN0039", "LEN2002", "LEN2004",
474 {ANY_BOARD_ID, 2961},
475 1024, 5112, 2024, 4832
478 (const char * const []){"LEN2000", NULL},
479 {ANY_BOARD_ID, ANY_BOARD_ID},
480 1024, 5113, 2021, 4832
483 (const char * const []){"LEN2001", NULL},
484 {ANY_BOARD_ID, ANY_BOARD_ID},
485 1024, 5022, 2508, 4832
488 (const char * const []){"LEN2006", NULL},
490 1024, 5045, 2457, 4832
493 (const char * const []){"LEN2006", NULL},
494 {ANY_BOARD_ID, ANY_BOARD_ID},
495 1264, 5675, 1171, 4688
500 /*****************************************************************************
501 * Synaptics communications functions
502 ****************************************************************************/
505 * Synaptics touchpads report the y coordinate from bottom to top, which is
506 * opposite from what userspace expects.
507 * This function is used to invert y before reporting.
509 static int synaptics_invert_y(int y)
511 return YMAX_NOMINAL + YMIN_NOMINAL - y;
515 * Apply quirk(s) if the hardware matches
517 static void synaptics_apply_quirks(struct psmouse *psmouse,
518 struct synaptics_device_info *info)
522 for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
523 if (!psmouse_matches_pnp_id(psmouse,
524 min_max_pnpid_table[i].pnp_ids))
527 if (min_max_pnpid_table[i].board_id.min != ANY_BOARD_ID &&
528 info->board_id < min_max_pnpid_table[i].board_id.min)
531 if (min_max_pnpid_table[i].board_id.max != ANY_BOARD_ID &&
532 info->board_id > min_max_pnpid_table[i].board_id.max)
535 info->x_min = min_max_pnpid_table[i].x_min;
536 info->x_max = min_max_pnpid_table[i].x_max;
537 info->y_min = min_max_pnpid_table[i].y_min;
538 info->y_max = min_max_pnpid_table[i].y_max;
539 psmouse_info(psmouse,
540 "quirked min/max coordinates: x [%d..%d], y [%d..%d]\n",
541 info->x_min, info->x_max,
542 info->y_min, info->y_max);
547 static bool synaptics_has_agm(struct synaptics_data *priv)
549 return (SYN_CAP_ADV_GESTURE(priv->info.ext_cap_0c) ||
550 SYN_CAP_IMAGE_SENSOR(priv->info.ext_cap_0c));
553 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
555 static u8 param = 0xc8;
558 error = ps2_sliced_command(&psmouse->ps2dev, SYN_QUE_MODEL);
562 error = ps2_command(&psmouse->ps2dev, ¶m, PSMOUSE_CMD_SETRATE);
569 static int synaptics_set_mode(struct psmouse *psmouse)
571 struct synaptics_data *priv = psmouse->private;
575 if (priv->absolute_mode)
576 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
577 if (priv->disable_gesture)
578 priv->mode |= SYN_BIT_DISABLE_GESTURE;
579 if (psmouse->rate >= 80)
580 priv->mode |= SYN_BIT_HIGH_RATE;
581 if (SYN_CAP_EXTENDED(priv->info.capabilities))
582 priv->mode |= SYN_BIT_W_MODE;
584 error = synaptics_mode_cmd(psmouse, priv->mode);
588 if (priv->absolute_mode && synaptics_has_agm(priv)) {
589 error = synaptics_set_advanced_gesture_mode(psmouse);
592 "Advanced gesture mode init failed: %d\n",
601 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
603 struct synaptics_data *priv = psmouse->private;
606 priv->mode |= SYN_BIT_HIGH_RATE;
609 priv->mode &= ~SYN_BIT_HIGH_RATE;
613 synaptics_mode_cmd(psmouse, priv->mode);
616 /*****************************************************************************
617 * Synaptics pass-through PS/2 port support
618 ****************************************************************************/
619 static int synaptics_pt_write(struct serio *serio, u8 c)
621 struct psmouse *parent = serio_get_drvdata(serio->parent);
622 u8 rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
625 error = ps2_sliced_command(&parent->ps2dev, c);
629 error = ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE);
636 static int synaptics_pt_start(struct serio *serio)
638 struct psmouse *parent = serio_get_drvdata(serio->parent);
639 struct synaptics_data *priv = parent->private;
641 serio_pause_rx(parent->ps2dev.serio);
642 priv->pt_port = serio;
643 serio_continue_rx(parent->ps2dev.serio);
648 static void synaptics_pt_stop(struct serio *serio)
650 struct psmouse *parent = serio_get_drvdata(serio->parent);
651 struct synaptics_data *priv = parent->private;
653 serio_pause_rx(parent->ps2dev.serio);
654 priv->pt_port = NULL;
655 serio_continue_rx(parent->ps2dev.serio);
658 static int synaptics_is_pt_packet(u8 *buf)
660 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
663 static void synaptics_pass_pt_packet(struct serio *ptport, u8 *packet)
665 struct psmouse *child = serio_get_drvdata(ptport);
667 if (child && child->state == PSMOUSE_ACTIVATED) {
668 serio_interrupt(ptport, packet[1], 0);
669 serio_interrupt(ptport, packet[4], 0);
670 serio_interrupt(ptport, packet[5], 0);
671 if (child->pktsize == 4)
672 serio_interrupt(ptport, packet[2], 0);
674 serio_interrupt(ptport, packet[1], 0);
678 static void synaptics_pt_activate(struct psmouse *psmouse)
680 struct synaptics_data *priv = psmouse->private;
681 struct psmouse *child = serio_get_drvdata(priv->pt_port);
683 /* adjust the touchpad to child's choice of protocol */
685 if (child->pktsize == 4)
686 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
688 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
690 if (synaptics_mode_cmd(psmouse, priv->mode))
691 psmouse_warn(psmouse,
692 "failed to switch guest protocol\n");
696 static void synaptics_pt_create(struct psmouse *psmouse)
700 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
703 "not enough memory for pass-through port\n");
707 serio->id.type = SERIO_PS_PSTHRU;
708 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
709 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->phys));
710 serio->write = synaptics_pt_write;
711 serio->start = synaptics_pt_start;
712 serio->stop = synaptics_pt_stop;
713 serio->parent = psmouse->ps2dev.serio;
715 psmouse->pt_activate = synaptics_pt_activate;
717 psmouse_info(psmouse, "serio: %s port at %s\n",
718 serio->name, psmouse->phys);
719 serio_register_port(serio);
722 /*****************************************************************************
723 * Functions to interpret the absolute mode packets
724 ****************************************************************************/
726 static void synaptics_parse_agm(const u8 buf[],
727 struct synaptics_data *priv,
728 struct synaptics_hw_state *hw)
730 struct synaptics_hw_state *agm = &priv->agm;
733 agm_packet_type = (buf[5] & 0x30) >> 4;
734 switch (agm_packet_type) {
736 /* Gesture packet: (x, y, z) half resolution */
738 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
739 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
740 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
744 /* AGM-CONTACT packet: we are only interested in the count */
745 priv->agm_count = buf[1];
753 static void synaptics_parse_ext_buttons(const u8 buf[],
754 struct synaptics_data *priv,
755 struct synaptics_hw_state *hw)
757 unsigned int ext_bits =
758 (SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap) + 1) >> 1;
759 unsigned int ext_mask = GENMASK(ext_bits - 1, 0);
761 hw->ext_buttons = buf[4] & ext_mask;
762 hw->ext_buttons |= (buf[5] & ext_mask) << ext_bits;
765 static int synaptics_parse_hw_state(const u8 buf[],
766 struct synaptics_data *priv,
767 struct synaptics_hw_state *hw)
769 memset(hw, 0, sizeof(struct synaptics_hw_state));
771 if (SYN_MODEL_NEWABS(priv->info.model_id)) {
772 hw->w = (((buf[0] & 0x30) >> 2) |
773 ((buf[0] & 0x04) >> 1) |
774 ((buf[3] & 0x04) >> 2));
776 if (synaptics_has_agm(priv) && hw->w == 2) {
777 synaptics_parse_agm(buf, priv, hw);
781 hw->x = (((buf[3] & 0x10) << 8) |
782 ((buf[1] & 0x0f) << 8) |
784 hw->y = (((buf[3] & 0x20) << 7) |
785 ((buf[1] & 0xf0) << 4) |
789 hw->left = (buf[0] & 0x01) ? 1 : 0;
790 hw->right = (buf[0] & 0x02) ? 1 : 0;
792 if (priv->is_forcepad) {
794 * ForcePads, like Clickpads, use middle button
795 * bits to report primary button clicks.
796 * Unfortunately they report primary button not
797 * only when user presses on the pad above certain
798 * threshold, but also when there are more than one
799 * finger on the touchpad, which interferes with
800 * out multi-finger gestures.
804 priv->press = priv->report_press = false;
805 } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
807 * Single-finger touch with pressure above
808 * the threshold. If pressure stays long
809 * enough, we'll start reporting primary
810 * button. We rely on the device continuing
811 * sending data even if finger does not
815 priv->press_start = jiffies;
817 } else if (time_after(jiffies,
819 msecs_to_jiffies(50))) {
820 priv->report_press = true;
826 hw->left = priv->report_press;
828 } else if (SYN_CAP_CLICKPAD(priv->info.ext_cap_0c)) {
830 * Clickpad's button is transmitted as middle button,
831 * however, since it is primary button, we will report
834 hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
836 } else if (SYN_CAP_MIDDLE_BUTTON(priv->info.capabilities)) {
837 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
839 hw->scroll = (s8)buf[1];
842 if (SYN_CAP_FOUR_BUTTON(priv->info.capabilities)) {
843 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
844 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
847 if (SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap) > 0 &&
848 ((buf[0] ^ buf[3]) & 0x02)) {
849 synaptics_parse_ext_buttons(buf, priv, hw);
852 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
853 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
855 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
856 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
858 hw->left = (buf[0] & 0x01) ? 1 : 0;
859 hw->right = (buf[0] & 0x02) ? 1 : 0;
863 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
864 * is used by some firmware to indicate a finger at the edge of
865 * the touchpad whose precise position cannot be determined, so
866 * convert these values to the maximum axis value.
868 if (hw->x > X_MAX_POSITIVE)
869 hw->x -= 1 << ABS_POS_BITS;
870 else if (hw->x == X_MAX_POSITIVE)
873 if (hw->y > Y_MAX_POSITIVE)
874 hw->y -= 1 << ABS_POS_BITS;
875 else if (hw->y == Y_MAX_POSITIVE)
881 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
882 bool active, int x, int y)
884 input_mt_slot(dev, slot);
885 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
887 input_report_abs(dev, ABS_MT_POSITION_X, x);
888 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
892 static void synaptics_report_semi_mt_data(struct input_dev *dev,
893 const struct synaptics_hw_state *a,
894 const struct synaptics_hw_state *b,
897 if (num_fingers >= 2) {
898 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
900 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
902 } else if (num_fingers == 1) {
903 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
904 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
906 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
907 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
911 static void synaptics_report_ext_buttons(struct psmouse *psmouse,
912 const struct synaptics_hw_state *hw)
914 struct input_dev *dev = psmouse->dev;
915 struct synaptics_data *priv = psmouse->private;
916 int ext_bits = (SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap) + 1) >> 1;
919 if (!SYN_CAP_MULTI_BUTTON_NO(priv->info.ext_cap))
922 /* Bug in FW 8.1 & 8.2, buttons are reported only when ExtBit is 1 */
923 if ((SYN_ID_FULL(priv->info.identity) == 0x801 ||
924 SYN_ID_FULL(priv->info.identity) == 0x802) &&
925 !((psmouse->packet[0] ^ psmouse->packet[3]) & 0x02))
928 if (!SYN_CAP_EXT_BUTTONS_STICK(priv->info.ext_cap_10)) {
929 for (i = 0; i < ext_bits; i++) {
930 input_report_key(dev, BTN_0 + 2 * i,
931 hw->ext_buttons & BIT(i));
932 input_report_key(dev, BTN_1 + 2 * i,
933 hw->ext_buttons & BIT(i + ext_bits));
939 * This generation of touchpads has the trackstick buttons
940 * physically wired to the touchpad. Re-route them through
941 * the pass-through interface.
946 /* The trackstick expects at most 3 buttons */
947 pt_buttons = SYN_EXT_BUTTON_STICK_L(hw->ext_buttons) |
948 SYN_EXT_BUTTON_STICK_R(hw->ext_buttons) << 1 |
949 SYN_EXT_BUTTON_STICK_M(hw->ext_buttons) << 2;
951 serio_interrupt(priv->pt_port,
952 PSMOUSE_OOB_EXTRA_BTNS, SERIO_OOB_DATA);
953 serio_interrupt(priv->pt_port, pt_buttons, SERIO_OOB_DATA);
957 static void synaptics_report_buttons(struct psmouse *psmouse,
958 const struct synaptics_hw_state *hw)
960 struct input_dev *dev = psmouse->dev;
961 struct synaptics_data *priv = psmouse->private;
963 input_report_key(dev, BTN_LEFT, hw->left);
964 input_report_key(dev, BTN_RIGHT, hw->right);
966 if (SYN_CAP_MIDDLE_BUTTON(priv->info.capabilities))
967 input_report_key(dev, BTN_MIDDLE, hw->middle);
969 if (SYN_CAP_FOUR_BUTTON(priv->info.capabilities)) {
970 input_report_key(dev, BTN_FORWARD, hw->up);
971 input_report_key(dev, BTN_BACK, hw->down);
974 synaptics_report_ext_buttons(psmouse, hw);
977 static void synaptics_report_mt_data(struct psmouse *psmouse,
978 const struct synaptics_hw_state *sgm,
981 struct input_dev *dev = psmouse->dev;
982 struct synaptics_data *priv = psmouse->private;
983 const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
984 struct input_mt_pos pos[2];
985 int slot[2], nsemi, i;
987 nsemi = clamp_val(num_fingers, 0, 2);
989 for (i = 0; i < nsemi; i++) {
991 pos[i].y = synaptics_invert_y(hw[i]->y);
994 input_mt_assign_slots(dev, slot, pos, nsemi, DMAX * priv->info.x_res);
996 for (i = 0; i < nsemi; i++) {
997 input_mt_slot(dev, slot[i]);
998 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
999 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
1000 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
1001 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
1004 input_mt_drop_unused(dev);
1006 /* Don't use active slot count to generate BTN_TOOL events. */
1007 input_mt_report_pointer_emulation(dev, false);
1009 /* Send the number of fingers reported by touchpad itself. */
1010 input_mt_report_finger_count(dev, num_fingers);
1012 synaptics_report_buttons(psmouse, sgm);
1017 static void synaptics_image_sensor_process(struct psmouse *psmouse,
1018 struct synaptics_hw_state *sgm)
1020 struct synaptics_data *priv = psmouse->private;
1024 * Update mt_state using the new finger count and current mt_state.
1028 else if (sgm->w >= 4)
1030 else if (sgm->w == 0)
1032 else if (sgm->w == 1)
1033 num_fingers = priv->agm_count ? priv->agm_count : 3;
1037 /* Send resulting input events to user space */
1038 synaptics_report_mt_data(psmouse, sgm, num_fingers);
1041 static bool synaptics_has_multifinger(struct synaptics_data *priv)
1043 if (SYN_CAP_MULTIFINGER(priv->info.capabilities))
1046 /* Advanced gesture mode also sends multi finger data */
1047 return synaptics_has_agm(priv);
1051 * called for each full received packet from the touchpad
1053 static void synaptics_process_packet(struct psmouse *psmouse)
1055 struct input_dev *dev = psmouse->dev;
1056 struct synaptics_data *priv = psmouse->private;
1057 struct synaptics_device_info *info = &priv->info;
1058 struct synaptics_hw_state hw;
1062 if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
1065 if (SYN_CAP_IMAGE_SENSOR(info->ext_cap_0c)) {
1066 synaptics_image_sensor_process(psmouse, &hw);
1071 priv->scroll += hw.scroll;
1073 while (priv->scroll >= 4) {
1074 input_report_key(dev, BTN_BACK, !hw.down);
1076 input_report_key(dev, BTN_BACK, hw.down);
1080 while (priv->scroll <= -4) {
1081 input_report_key(dev, BTN_FORWARD, !hw.up);
1083 input_report_key(dev, BTN_FORWARD, hw.up);
1090 if (hw.z > 0 && hw.x > 1) {
1093 if (SYN_CAP_EXTENDED(info->capabilities)) {
1096 if (synaptics_has_multifinger(priv))
1097 num_fingers = hw.w + 2;
1100 if (SYN_MODEL_PEN(info->model_id))
1101 ; /* Nothing, treat a pen as a single finger */
1104 if (SYN_CAP_PALMDETECT(info->capabilities))
1105 finger_width = hw.w;
1114 if (cr48_profile_sensor) {
1115 synaptics_report_mt_data(psmouse, &hw, num_fingers);
1119 if (SYN_CAP_ADV_GESTURE(info->ext_cap_0c))
1120 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
1124 * BTN_TOUCH has to be first as mousedev relies on it when doing
1125 * absolute -> relative conversion
1127 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
1128 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
1130 if (num_fingers > 0) {
1131 input_report_abs(dev, ABS_X, hw.x);
1132 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
1134 input_report_abs(dev, ABS_PRESSURE, hw.z);
1136 if (SYN_CAP_PALMDETECT(info->capabilities))
1137 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
1139 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
1140 if (synaptics_has_multifinger(priv)) {
1141 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
1142 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
1145 synaptics_report_buttons(psmouse, &hw);
1150 static bool synaptics_validate_byte(struct psmouse *psmouse,
1151 int idx, enum synaptics_pkt_type pkt_type)
1153 static const u8 newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
1154 static const u8 newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
1155 static const u8 newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
1156 static const u8 oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
1157 static const u8 oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
1158 const u8 *packet = psmouse->packet;
1160 if (idx < 0 || idx > 4)
1166 case SYN_NEWABS_RELAXED:
1167 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
1169 case SYN_NEWABS_STRICT:
1170 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
1173 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
1176 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
1181 static enum synaptics_pkt_type
1182 synaptics_detect_pkt_type(struct psmouse *psmouse)
1186 for (i = 0; i < 5; i++) {
1187 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
1188 psmouse_info(psmouse, "using relaxed packet validation\n");
1189 return SYN_NEWABS_RELAXED;
1193 return SYN_NEWABS_STRICT;
1196 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1198 struct synaptics_data *priv = psmouse->private;
1200 if (psmouse->pktcnt >= 6) { /* Full packet received */
1201 if (unlikely(priv->pkt_type == SYN_NEWABS))
1202 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1204 if (SYN_CAP_PASS_THROUGH(priv->info.capabilities) &&
1205 synaptics_is_pt_packet(psmouse->packet)) {
1207 synaptics_pass_pt_packet(priv->pt_port,
1210 synaptics_process_packet(psmouse);
1212 return PSMOUSE_FULL_PACKET;
1215 return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1216 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1219 /*****************************************************************************
1220 * Driver initialization/cleanup functions
1221 ****************************************************************************/
1222 static void set_abs_position_params(struct input_dev *dev,
1223 struct synaptics_device_info *info,
1224 int x_code, int y_code)
1226 int x_min = info->x_min ?: XMIN_NOMINAL;
1227 int x_max = info->x_max ?: XMAX_NOMINAL;
1228 int y_min = info->y_min ?: YMIN_NOMINAL;
1229 int y_max = info->y_max ?: YMAX_NOMINAL;
1230 int fuzz = SYN_CAP_REDUCED_FILTERING(info->ext_cap_0c) ?
1231 SYN_REDUCED_FILTER_FUZZ : 0;
1233 input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1234 input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1235 input_abs_set_res(dev, x_code, info->x_res);
1236 input_abs_set_res(dev, y_code, info->y_res);
1239 static int set_input_params(struct psmouse *psmouse,
1240 struct synaptics_data *priv)
1242 struct input_dev *dev = psmouse->dev;
1243 struct synaptics_device_info *info = &priv->info;
1247 /* Reset default psmouse capabilities */
1248 __clear_bit(EV_REL, dev->evbit);
1249 bitmap_zero(dev->relbit, REL_CNT);
1250 bitmap_zero(dev->keybit, KEY_CNT);
1252 /* Things that apply to both modes */
1253 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1255 input_set_capability(dev, EV_KEY, BTN_LEFT);
1257 /* Clickpads report only left button */
1258 if (!SYN_CAP_CLICKPAD(info->ext_cap_0c)) {
1259 input_set_capability(dev, EV_KEY, BTN_RIGHT);
1260 if (SYN_CAP_MIDDLE_BUTTON(info->capabilities))
1261 input_set_capability(dev, EV_KEY, BTN_MIDDLE);
1264 if (!priv->absolute_mode) {
1266 input_set_capability(dev, EV_REL, REL_X);
1267 input_set_capability(dev, EV_REL, REL_Y);
1272 set_abs_position_params(dev, &priv->info, ABS_X, ABS_Y);
1273 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1275 if (cr48_profile_sensor)
1276 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1278 if (SYN_CAP_IMAGE_SENSOR(info->ext_cap_0c)) {
1279 set_abs_position_params(dev, info,
1280 ABS_MT_POSITION_X, ABS_MT_POSITION_Y);
1281 /* Image sensors can report per-contact pressure */
1282 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1284 error = input_mt_init_slots(dev, 2,
1285 INPUT_MT_POINTER | INPUT_MT_TRACK);
1289 /* Image sensors can signal 4 and 5 finger clicks */
1290 input_set_capability(dev, EV_KEY, BTN_TOOL_QUADTAP);
1291 input_set_capability(dev, EV_KEY, BTN_TOOL_QUINTTAP);
1292 } else if (SYN_CAP_ADV_GESTURE(info->ext_cap_0c)) {
1293 set_abs_position_params(dev, info,
1294 ABS_MT_POSITION_X, ABS_MT_POSITION_Y);
1296 * Profile sensor in CR-48 tracks contacts reasonably well,
1297 * other non-image sensors with AGM use semi-mt.
1299 error = input_mt_init_slots(dev, 2,
1301 (cr48_profile_sensor ?
1308 * For semi-mt devices we send ABS_X/Y ourselves instead of
1309 * input_mt_report_pointer_emulation. But
1310 * input_mt_init_slots() resets the fuzz to 0, leading to a
1311 * filtered ABS_MT_POSITION_X but an unfiltered ABS_X
1312 * position. Let's re-initialize ABS_X/Y here.
1314 if (!cr48_profile_sensor)
1315 set_abs_position_params(dev, &priv->info, ABS_X, ABS_Y);
1318 if (SYN_CAP_PALMDETECT(info->capabilities))
1319 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1321 input_set_capability(dev, EV_KEY, BTN_TOUCH);
1322 input_set_capability(dev, EV_KEY, BTN_TOOL_FINGER);
1324 if (synaptics_has_multifinger(priv)) {
1325 input_set_capability(dev, EV_KEY, BTN_TOOL_DOUBLETAP);
1326 input_set_capability(dev, EV_KEY, BTN_TOOL_TRIPLETAP);
1329 if (SYN_CAP_FOUR_BUTTON(info->capabilities) ||
1330 SYN_CAP_MIDDLE_BUTTON(info->capabilities)) {
1331 input_set_capability(dev, EV_KEY, BTN_FORWARD);
1332 input_set_capability(dev, EV_KEY, BTN_BACK);
1335 if (!SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10))
1336 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(info->ext_cap); i++)
1337 input_set_capability(dev, EV_KEY, BTN_0 + i);
1339 if (SYN_CAP_CLICKPAD(info->ext_cap_0c)) {
1340 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1341 if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids) &&
1342 !SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10))
1343 __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1349 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1350 void *data, char *buf)
1352 struct synaptics_data *priv = psmouse->private;
1354 return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1357 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1358 void *data, const char *buf,
1361 struct synaptics_data *priv = psmouse->private;
1365 err = kstrtouint(buf, 10, &value);
1372 if (value == priv->disable_gesture)
1375 priv->disable_gesture = value;
1377 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1379 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1381 if (synaptics_mode_cmd(psmouse, priv->mode))
1387 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1388 synaptics_show_disable_gesture,
1389 synaptics_set_disable_gesture);
1391 static void synaptics_disconnect(struct psmouse *psmouse)
1393 struct synaptics_data *priv = psmouse->private;
1396 * We might have left a breadcrumb when trying to
1397 * set up SMbus companion.
1399 psmouse_smbus_cleanup(psmouse);
1401 if (!priv->absolute_mode &&
1402 SYN_ID_DISGEST_SUPPORTED(priv->info.identity))
1403 device_remove_file(&psmouse->ps2dev.serio->dev,
1404 &psmouse_attr_disable_gesture.dattr);
1406 synaptics_reset(psmouse);
1408 psmouse->private = NULL;
1411 static int synaptics_reconnect(struct psmouse *psmouse)
1413 struct synaptics_data *priv = psmouse->private;
1414 struct synaptics_device_info info;
1420 psmouse_reset(psmouse);
1423 * On some boxes, right after resuming, the touchpad
1424 * needs some time to finish initializing (I assume
1425 * it needs time to calibrate) and start responding
1426 * to Synaptics-specific queries, so let's wait a
1431 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1432 error = synaptics_detect(psmouse, 0);
1433 } while (error && ++retry < 3);
1439 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1441 error = synaptics_query_hardware(psmouse, &info);
1443 psmouse_err(psmouse, "Unable to query device.\n");
1447 error = synaptics_set_mode(psmouse);
1449 psmouse_err(psmouse, "Unable to initialize device.\n");
1453 if (info.identity != priv->info.identity ||
1454 info.model_id != priv->info.model_id ||
1455 info.capabilities != priv->info.capabilities ||
1456 info.ext_cap != priv->info.ext_cap) {
1457 psmouse_err(psmouse,
1458 "hardware appears to be different: id(%u-%u), model(%u-%u), caps(%x-%x), ext(%x-%x).\n",
1459 priv->info.identity, info.identity,
1460 priv->info.model_id, info.model_id,
1461 priv->info.capabilities, info.capabilities,
1462 priv->info.ext_cap, info.ext_cap);
1469 static bool impaired_toshiba_kbc;
1471 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1472 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1474 /* Toshiba Satellite */
1476 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1477 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1481 /* Toshiba Dynabook */
1483 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1484 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1488 /* Toshiba Portege M300 */
1490 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1491 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1496 /* Toshiba Portege M300 */
1498 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1499 DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1500 DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1508 static bool broken_olpc_ec;
1510 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1511 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1513 /* OLPC XO-1 or XO-1.5 */
1515 DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1516 DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1523 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1524 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1526 /* Cr-48 Chromebook (Codename Mario) */
1528 DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1529 DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1536 void __init synaptics_module_init(void)
1538 impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1539 broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1540 cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1543 static int synaptics_init_ps2(struct psmouse *psmouse,
1544 struct synaptics_device_info *info,
1547 struct synaptics_data *priv;
1550 synaptics_apply_quirks(psmouse, info);
1552 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1557 priv->absolute_mode = absolute_mode;
1558 if (SYN_ID_DISGEST_SUPPORTED(info->identity))
1559 priv->disable_gesture = true;
1562 * Unfortunately ForcePad capability is not exported over PS/2,
1563 * so we have to resort to checking PNP IDs.
1565 priv->is_forcepad = psmouse_matches_pnp_id(psmouse, forcepad_pnp_ids);
1567 err = synaptics_set_mode(psmouse);
1569 psmouse_err(psmouse, "Unable to initialize device.\n");
1573 priv->pkt_type = SYN_MODEL_NEWABS(info->model_id) ?
1574 SYN_NEWABS : SYN_OLDABS;
1576 psmouse_info(psmouse,
1577 "Touchpad model: %lu, fw: %lu.%lu, id: %#x, caps: %#x/%#x/%#x/%#x, board id: %u, fw id: %u\n",
1578 SYN_ID_MODEL(info->identity),
1579 SYN_ID_MAJOR(info->identity), SYN_ID_MINOR(info->identity),
1581 info->capabilities, info->ext_cap, info->ext_cap_0c,
1582 info->ext_cap_10, info->board_id, info->firmware_id);
1584 err = set_input_params(psmouse, priv);
1586 psmouse_err(psmouse,
1587 "failed to set up capabilities: %d\n", err);
1592 * Encode touchpad model so that it can be used to set
1593 * input device->id.version and be visible to userspace.
1594 * Because version is __u16 we have to drop something.
1595 * Hardware info bits seem to be good candidates as they
1596 * are documented to be for Synaptics corp. internal use.
1598 psmouse->model = ((info->model_id & 0x00ff0000) >> 8) |
1599 (info->model_id & 0x000000ff);
1601 if (absolute_mode) {
1602 psmouse->protocol_handler = synaptics_process_byte;
1603 psmouse->pktsize = 6;
1605 /* Relative mode follows standard PS/2 mouse protocol */
1606 psmouse->protocol_handler = psmouse_process_byte;
1607 psmouse->pktsize = 3;
1610 psmouse->set_rate = synaptics_set_rate;
1611 psmouse->disconnect = synaptics_disconnect;
1612 psmouse->reconnect = synaptics_reconnect;
1613 psmouse->cleanup = synaptics_reset;
1614 /* Synaptics can usually stay in sync without extra help */
1615 psmouse->resync_time = 0;
1617 if (SYN_CAP_PASS_THROUGH(info->capabilities))
1618 synaptics_pt_create(psmouse);
1621 * Toshiba's KBC seems to have trouble handling data from
1622 * Synaptics at full rate. Switch to a lower rate (roughly
1623 * the same rate as a standard PS/2 mouse).
1625 if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1626 psmouse_info(psmouse,
1627 "Toshiba %s detected, limiting rate to 40pps.\n",
1628 dmi_get_system_info(DMI_PRODUCT_NAME));
1632 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(info->identity)) {
1633 err = device_create_file(&psmouse->ps2dev.serio->dev,
1634 &psmouse_attr_disable_gesture.dattr);
1636 psmouse_err(psmouse,
1637 "Failed to create disable_gesture attribute (%d)",
1650 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1652 struct synaptics_device_info info;
1655 psmouse_reset(psmouse);
1657 error = synaptics_query_hardware(psmouse, &info);
1659 psmouse_err(psmouse, "Unable to query device: %d\n", error);
1663 return synaptics_init_ps2(psmouse, &info, absolute_mode);
1666 int synaptics_init_absolute(struct psmouse *psmouse)
1668 return __synaptics_init(psmouse, true);
1671 int synaptics_init_relative(struct psmouse *psmouse)
1673 return __synaptics_init(psmouse, false);
1676 static int synaptics_setup_ps2(struct psmouse *psmouse,
1677 struct synaptics_device_info *info)
1679 bool absolute_mode = true;
1683 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1684 * packet spew overloads the EC such that key presses on the keyboard
1685 * are missed. Given that, don't even attempt to use Absolute mode.
1686 * Relative mode seems to work just fine.
1688 if (broken_olpc_ec) {
1689 psmouse_info(psmouse,
1690 "OLPC XO detected, forcing relative protocol.\n");
1691 absolute_mode = false;
1694 error = synaptics_init_ps2(psmouse, info, absolute_mode);
1698 return absolute_mode ? PSMOUSE_SYNAPTICS : PSMOUSE_SYNAPTICS_RELATIVE;
1701 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1703 void __init synaptics_module_init(void)
1707 static int __maybe_unused
1708 synaptics_setup_ps2(struct psmouse *psmouse,
1709 struct synaptics_device_info *info)
1714 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */
1716 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS
1719 * The newest Synaptics device can use a secondary bus (called InterTouch) which
1720 * provides a better bandwidth and allow a better control of the touchpads.
1721 * This is used to decide if we need to use this bus or not.
1724 SYNAPTICS_INTERTOUCH_NOT_SET = -1,
1725 SYNAPTICS_INTERTOUCH_OFF,
1726 SYNAPTICS_INTERTOUCH_ON,
1729 static int synaptics_intertouch = IS_ENABLED(CONFIG_RMI4_SMB) ?
1730 SYNAPTICS_INTERTOUCH_NOT_SET : SYNAPTICS_INTERTOUCH_OFF;
1731 module_param_named(synaptics_intertouch, synaptics_intertouch, int, 0644);
1732 MODULE_PARM_DESC(synaptics_intertouch, "Use a secondary bus for the Synaptics device.");
1734 static int synaptics_create_intertouch(struct psmouse *psmouse,
1735 struct synaptics_device_info *info,
1736 bool leave_breadcrumbs)
1739 psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids) &&
1740 !SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10);
1741 const struct rmi_device_platform_data pdata = {
1743 .sensor_type = rmi_sensor_touchpad,
1744 .axis_align.flip_y = true,
1745 .kernel_tracking = false,
1746 .topbuttonpad = topbuttonpad,
1749 .buttonpad = SYN_CAP_CLICKPAD(info->ext_cap_0c),
1750 .trackstick_buttons =
1751 !!SYN_CAP_EXT_BUTTONS_STICK(info->ext_cap_10),
1754 const struct i2c_board_info intertouch_board = {
1755 I2C_BOARD_INFO("rmi4_smbus", 0x2c),
1756 .flags = I2C_CLIENT_HOST_NOTIFY,
1759 return psmouse_smbus_init(psmouse, &intertouch_board,
1760 &pdata, sizeof(pdata), true,
1765 * synaptics_setup_intertouch - called once the PS/2 devices are enumerated
1766 * and decides to instantiate a SMBus InterTouch device.
1768 static int synaptics_setup_intertouch(struct psmouse *psmouse,
1769 struct synaptics_device_info *info,
1770 bool leave_breadcrumbs)
1774 if (synaptics_intertouch == SYNAPTICS_INTERTOUCH_OFF)
1777 if (synaptics_intertouch == SYNAPTICS_INTERTOUCH_NOT_SET) {
1778 if (!psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids) &&
1779 !psmouse_matches_pnp_id(psmouse, smbus_pnp_ids)) {
1781 if (!psmouse_matches_pnp_id(psmouse, forcepad_pnp_ids))
1782 psmouse_info(psmouse,
1783 "Your touchpad (%s) says it can support a different bus. "
1784 "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",
1785 psmouse->ps2dev.serio->firmware_id);
1791 psmouse_info(psmouse, "Trying to set up SMBus access\n");
1793 error = synaptics_create_intertouch(psmouse, info, leave_breadcrumbs);
1795 if (error == -EAGAIN)
1796 psmouse_info(psmouse, "SMbus companion is not ready yet\n");
1798 psmouse_err(psmouse, "unable to create intertouch device\n");
1806 int synaptics_init_smbus(struct psmouse *psmouse)
1808 struct synaptics_device_info info;
1811 psmouse_reset(psmouse);
1813 error = synaptics_query_hardware(psmouse, &info);
1815 psmouse_err(psmouse, "Unable to query device: %d\n", error);
1819 if (!SYN_CAP_INTERTOUCH(info.ext_cap_0c))
1822 return synaptics_create_intertouch(psmouse, &info, false);
1825 #else /* CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1827 static int __maybe_unused
1828 synaptics_setup_intertouch(struct psmouse *psmouse,
1829 struct synaptics_device_info *info,
1830 bool leave_breadcrumbs)
1835 int synaptics_init_smbus(struct psmouse *psmouse)
1840 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1842 #if defined(CONFIG_MOUSE_PS2_SYNAPTICS) || \
1843 defined(CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS)
1845 int synaptics_init(struct psmouse *psmouse)
1847 struct synaptics_device_info info;
1851 psmouse_reset(psmouse);
1853 error = synaptics_query_hardware(psmouse, &info);
1855 psmouse_err(psmouse, "Unable to query device: %d\n", error);
1859 if (SYN_CAP_INTERTOUCH(info.ext_cap_0c)) {
1860 if ((!IS_ENABLED(CONFIG_RMI4_SMB) ||
1861 !IS_ENABLED(CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS)) &&
1862 /* Forcepads need F21, which is not ready */
1863 !psmouse_matches_pnp_id(psmouse, forcepad_pnp_ids)) {
1864 psmouse_warn(psmouse,
1865 "The touchpad can support a better bus than the too old PS/2 protocol. "
1866 "Make sure MOUSE_PS2_SYNAPTICS_SMBUS and RMI4_SMB are enabled to get a better touchpad experience.\n");
1869 error = synaptics_setup_intertouch(psmouse, &info, true);
1871 return PSMOUSE_SYNAPTICS_SMBUS;
1874 retval = synaptics_setup_ps2(psmouse, &info);
1877 * Not using any flavor of Synaptics support, so clean up
1878 * SMbus breadcrumbs, if any.
1880 psmouse_smbus_cleanup(psmouse);
1886 #else /* CONFIG_MOUSE_PS2_SYNAPTICS || CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */
1888 int synaptics_init(struct psmouse *psmouse)
1893 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS || CONFIG_MOUSE_PS2_SYNAPTICS_SMBUS */