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/slab.h>
34 #include "synaptics.h"
37 * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
38 * section 2.3.2, which says that they should be valid regardless of the
39 * actual size of the sensor.
40 * Note that newer firmware allows querying device for maximum useable
47 #define XMIN_NOMINAL 1472
48 #define XMAX_NOMINAL 5472
49 #define YMIN_NOMINAL 1408
50 #define YMAX_NOMINAL 4448
52 /* Size in bits of absolute position values reported by the hardware */
53 #define ABS_POS_BITS 13
56 * These values should represent the absolute maximum value that will
57 * be reported for a positive position value. Some Synaptics firmware
58 * uses this value to indicate a finger near the edge of the touchpad
59 * whose precise position cannot be determined.
61 * At least one touchpad is known to report positions in excess of this
62 * value which are actually negative values truncated to the 13-bit
63 * reporting range. These values have never been observed to be lower
64 * than 8184 (i.e. -8), so we treat all values greater than 8176 as
65 * negative and any other value as positive.
67 #define X_MAX_POSITIVE 8176
68 #define Y_MAX_POSITIVE 8176
70 /* maximum ABS_MT_POSITION displacement (in mm) */
73 /*****************************************************************************
74 * Stuff we need even when we do not want native Synaptics support
75 ****************************************************************************/
78 * Set the synaptics touchpad mode byte by special commands
80 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
82 unsigned char param[1];
84 if (psmouse_sliced_command(psmouse, mode))
86 param[0] = SYN_PS_SET_MODE2;
87 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
92 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
94 struct ps2dev *ps2dev = &psmouse->ps2dev;
95 unsigned char param[4];
99 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
100 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
101 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
102 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
103 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
105 if (param[1] != 0x47)
108 if (set_properties) {
109 psmouse->vendor = "Synaptics";
110 psmouse->name = "TouchPad";
116 void synaptics_reset(struct psmouse *psmouse)
118 /* reset touchpad back to relative mode, gestures enabled */
119 synaptics_mode_cmd(psmouse, 0);
122 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
124 static bool cr48_profile_sensor;
126 struct min_max_quirk {
127 const char * const *pnp_ids;
128 int x_min, x_max, y_min, y_max;
131 static const struct min_max_quirk min_max_pnpid_table[] = {
133 (const char * const []){"LEN0033", NULL},
134 1024, 5052, 2258, 4832
137 (const char * const []){"LEN0035", "LEN0042", NULL},
138 1232, 5710, 1156, 4696
141 (const char * const []){"LEN0034", "LEN0036", "LEN0037",
142 "LEN0039", "LEN2002", "LEN2004",
144 1024, 5112, 2024, 4832
147 (const char * const []){"LEN2001", NULL},
148 1024, 5022, 2508, 4832
151 (const char * const []){"LEN2006", NULL},
152 1264, 5675, 1171, 4688
157 /* This list has been kindly provided by Synaptics. */
158 static const char * const topbuttonpad_pnp_ids[] = {
168 "LEN0033", /* Helix */
169 "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
170 "LEN0035", /* X240 */
171 "LEN0036", /* T440 */
172 "LEN0037", /* X1 Carbon 2nd */
174 "LEN0039", /* T440s */
176 "LEN0042", /* Yoga */
183 "LEN2001", /* Edge E431 */
184 "LEN2002", /* Edge E531 */
186 "LEN2004", /* L440 */
197 /* This list has been kindly provided by Synaptics. */
198 static const char * const forcepad_pnp_ids[] = {
204 /*****************************************************************************
205 * Synaptics communications functions
206 ****************************************************************************/
209 * Synaptics touchpads report the y coordinate from bottom to top, which is
210 * opposite from what userspace expects.
211 * This function is used to invert y before reporting.
213 static int synaptics_invert_y(int y)
215 return YMAX_NOMINAL + YMIN_NOMINAL - y;
219 * Send a command to the synpatics touchpad by special commands
221 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
223 if (psmouse_sliced_command(psmouse, c))
225 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
231 * Read the model-id bytes from the touchpad
232 * see also SYN_MODEL_* macros
234 static int synaptics_model_id(struct psmouse *psmouse)
236 struct synaptics_data *priv = psmouse->private;
239 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
241 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
246 * Read the board id from the touchpad
247 * The board id is encoded in the "QUERY MODES" response
249 static int synaptics_board_id(struct psmouse *psmouse)
251 struct synaptics_data *priv = psmouse->private;
252 unsigned char bid[3];
254 if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid))
256 priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
261 * Read the firmware id from the touchpad
263 static int synaptics_firmware_id(struct psmouse *psmouse)
265 struct synaptics_data *priv = psmouse->private;
266 unsigned char fwid[3];
268 if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid))
270 priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
275 * Read the capability-bits from the touchpad
276 * see also the SYN_CAP_* macros
278 static int synaptics_capability(struct psmouse *psmouse)
280 struct synaptics_data *priv = psmouse->private;
281 unsigned char cap[3];
283 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
285 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
286 priv->ext_cap = priv->ext_cap_0c = 0;
289 * Older firmwares had submodel ID fixed to 0x47
291 if (SYN_ID_FULL(priv->identity) < 0x705 &&
292 SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
297 * Unless capExtended is set the rest of the flags should be ignored
299 if (!SYN_CAP_EXTENDED(priv->capabilities))
300 priv->capabilities = 0;
302 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
303 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
304 psmouse_warn(psmouse,
305 "device claims to have extended capabilities, but I'm not able to read them.\n");
307 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
310 * if nExtBtn is greater than 8 it should be considered
311 * invalid and treated as 0
313 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
314 priv->ext_cap &= 0xff0fff;
318 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
319 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
320 psmouse_warn(psmouse,
321 "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
323 priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
332 * See also the SYN_ID_* macros
334 static int synaptics_identify(struct psmouse *psmouse)
336 struct synaptics_data *priv = psmouse->private;
339 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
341 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
342 if (SYN_ID_IS_SYNAPTICS(priv->identity))
348 * Read touchpad resolution and maximum reported coordinates
349 * Resolution is left zero if touchpad does not support the query
352 static int synaptics_resolution(struct psmouse *psmouse)
354 struct synaptics_data *priv = psmouse->private;
355 unsigned char resp[3];
358 if (SYN_ID_MAJOR(priv->identity) < 4)
361 if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
362 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
363 priv->x_res = resp[0]; /* x resolution in units/mm */
364 priv->y_res = resp[2]; /* y resolution in units/mm */
368 for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
369 if (psmouse_matches_pnp_id(psmouse,
370 min_max_pnpid_table[i].pnp_ids)) {
371 priv->x_min = min_max_pnpid_table[i].x_min;
372 priv->x_max = min_max_pnpid_table[i].x_max;
373 priv->y_min = min_max_pnpid_table[i].y_min;
374 priv->y_max = min_max_pnpid_table[i].y_max;
379 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
380 SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
381 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
382 psmouse_warn(psmouse,
383 "device claims to have max coordinates query, but I'm not able to read it.\n");
385 priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
386 priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
390 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
391 SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
392 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
393 psmouse_warn(psmouse,
394 "device claims to have min coordinates query, but I'm not able to read it.\n");
396 priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
397 priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
404 static int synaptics_query_hardware(struct psmouse *psmouse)
406 if (synaptics_identify(psmouse))
408 if (synaptics_model_id(psmouse))
410 if (synaptics_firmware_id(psmouse))
412 if (synaptics_board_id(psmouse))
414 if (synaptics_capability(psmouse))
416 if (synaptics_resolution(psmouse))
422 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
424 static unsigned char param = 0xc8;
425 struct synaptics_data *priv = psmouse->private;
427 if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
428 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
431 if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
434 if (ps2_command(&psmouse->ps2dev, ¶m, PSMOUSE_CMD_SETRATE))
437 /* Advanced gesture mode also sends multi finger data */
438 priv->capabilities |= BIT(1);
443 static int synaptics_set_mode(struct psmouse *psmouse)
445 struct synaptics_data *priv = psmouse->private;
448 if (priv->absolute_mode)
449 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
450 if (priv->disable_gesture)
451 priv->mode |= SYN_BIT_DISABLE_GESTURE;
452 if (psmouse->rate >= 80)
453 priv->mode |= SYN_BIT_HIGH_RATE;
454 if (SYN_CAP_EXTENDED(priv->capabilities))
455 priv->mode |= SYN_BIT_W_MODE;
457 if (synaptics_mode_cmd(psmouse, priv->mode))
460 if (priv->absolute_mode &&
461 synaptics_set_advanced_gesture_mode(psmouse)) {
462 psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
469 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
471 struct synaptics_data *priv = psmouse->private;
474 priv->mode |= SYN_BIT_HIGH_RATE;
477 priv->mode &= ~SYN_BIT_HIGH_RATE;
481 synaptics_mode_cmd(psmouse, priv->mode);
484 /*****************************************************************************
485 * Synaptics pass-through PS/2 port support
486 ****************************************************************************/
487 static int synaptics_pt_write(struct serio *serio, unsigned char c)
489 struct psmouse *parent = serio_get_drvdata(serio->parent);
490 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
492 if (psmouse_sliced_command(parent, c))
494 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
499 static int synaptics_pt_start(struct serio *serio)
501 struct psmouse *parent = serio_get_drvdata(serio->parent);
502 struct synaptics_data *priv = parent->private;
504 serio_pause_rx(parent->ps2dev.serio);
505 priv->pt_port = serio;
506 serio_continue_rx(parent->ps2dev.serio);
511 static void synaptics_pt_stop(struct serio *serio)
513 struct psmouse *parent = serio_get_drvdata(serio->parent);
514 struct synaptics_data *priv = parent->private;
516 serio_pause_rx(parent->ps2dev.serio);
517 priv->pt_port = NULL;
518 serio_continue_rx(parent->ps2dev.serio);
521 static int synaptics_is_pt_packet(unsigned char *buf)
523 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
526 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
528 struct psmouse *child = serio_get_drvdata(ptport);
530 if (child && child->state == PSMOUSE_ACTIVATED) {
531 serio_interrupt(ptport, packet[1], 0);
532 serio_interrupt(ptport, packet[4], 0);
533 serio_interrupt(ptport, packet[5], 0);
534 if (child->pktsize == 4)
535 serio_interrupt(ptport, packet[2], 0);
537 serio_interrupt(ptport, packet[1], 0);
540 static void synaptics_pt_activate(struct psmouse *psmouse)
542 struct synaptics_data *priv = psmouse->private;
543 struct psmouse *child = serio_get_drvdata(priv->pt_port);
545 /* adjust the touchpad to child's choice of protocol */
547 if (child->pktsize == 4)
548 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
550 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
552 if (synaptics_mode_cmd(psmouse, priv->mode))
553 psmouse_warn(psmouse,
554 "failed to switch guest protocol\n");
558 static void synaptics_pt_create(struct psmouse *psmouse)
562 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
565 "not enough memory for pass-through port\n");
569 serio->id.type = SERIO_PS_PSTHRU;
570 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
571 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
572 serio->write = synaptics_pt_write;
573 serio->start = synaptics_pt_start;
574 serio->stop = synaptics_pt_stop;
575 serio->parent = psmouse->ps2dev.serio;
577 psmouse->pt_activate = synaptics_pt_activate;
579 psmouse_info(psmouse, "serio: %s port at %s\n",
580 serio->name, psmouse->phys);
581 serio_register_port(serio);
584 /*****************************************************************************
585 * Functions to interpret the absolute mode packets
586 ****************************************************************************/
588 static void synaptics_parse_agm(const unsigned char buf[],
589 struct synaptics_data *priv,
590 struct synaptics_hw_state *hw)
592 struct synaptics_hw_state *agm = &priv->agm;
595 agm_packet_type = (buf[5] & 0x30) >> 4;
596 switch (agm_packet_type) {
598 /* Gesture packet: (x, y, z) half resolution */
600 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
601 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
602 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
606 /* AGM-CONTACT packet: we are only interested in the count */
607 priv->agm_count = buf[1];
615 static int synaptics_parse_hw_state(const unsigned char buf[],
616 struct synaptics_data *priv,
617 struct synaptics_hw_state *hw)
619 memset(hw, 0, sizeof(struct synaptics_hw_state));
621 if (SYN_MODEL_NEWABS(priv->model_id)) {
622 hw->w = (((buf[0] & 0x30) >> 2) |
623 ((buf[0] & 0x04) >> 1) |
624 ((buf[3] & 0x04) >> 2));
626 if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
627 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
629 synaptics_parse_agm(buf, priv, hw);
633 hw->x = (((buf[3] & 0x10) << 8) |
634 ((buf[1] & 0x0f) << 8) |
636 hw->y = (((buf[3] & 0x20) << 7) |
637 ((buf[1] & 0xf0) << 4) |
641 hw->left = (buf[0] & 0x01) ? 1 : 0;
642 hw->right = (buf[0] & 0x02) ? 1 : 0;
644 if (priv->is_forcepad) {
646 * ForcePads, like Clickpads, use middle button
647 * bits to report primary button clicks.
648 * Unfortunately they report primary button not
649 * only when user presses on the pad above certain
650 * threshold, but also when there are more than one
651 * finger on the touchpad, which interferes with
652 * out multi-finger gestures.
656 priv->press = priv->report_press = false;
657 } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
659 * Single-finger touch with pressure above
660 * the threshold. If pressure stays long
661 * enough, we'll start reporting primary
662 * button. We rely on the device continuing
663 * sending data even if finger does not
667 priv->press_start = jiffies;
669 } else if (time_after(jiffies,
671 msecs_to_jiffies(50))) {
672 priv->report_press = true;
678 hw->left = priv->report_press;
680 } else if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
682 * Clickpad's button is transmitted as middle button,
683 * however, since it is primary button, we will report
686 hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
688 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
689 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
691 hw->scroll = (signed char)(buf[1]);
694 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
695 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
696 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
699 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
700 ((buf[0] ^ buf[3]) & 0x02)) {
701 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
704 * if nExtBtn is greater than 8 it should be
705 * considered invalid and treated as 0
709 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
710 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
712 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
713 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
715 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
716 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
718 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
719 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
723 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
724 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
726 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
727 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
729 hw->left = (buf[0] & 0x01) ? 1 : 0;
730 hw->right = (buf[0] & 0x02) ? 1 : 0;
734 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
735 * is used by some firmware to indicate a finger at the edge of
736 * the touchpad whose precise position cannot be determined, so
737 * convert these values to the maximum axis value.
739 if (hw->x > X_MAX_POSITIVE)
740 hw->x -= 1 << ABS_POS_BITS;
741 else if (hw->x == X_MAX_POSITIVE)
744 if (hw->y > Y_MAX_POSITIVE)
745 hw->y -= 1 << ABS_POS_BITS;
746 else if (hw->y == Y_MAX_POSITIVE)
752 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
753 bool active, int x, int y)
755 input_mt_slot(dev, slot);
756 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
758 input_report_abs(dev, ABS_MT_POSITION_X, x);
759 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
763 static void synaptics_report_semi_mt_data(struct input_dev *dev,
764 const struct synaptics_hw_state *a,
765 const struct synaptics_hw_state *b,
768 if (num_fingers >= 2) {
769 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
771 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
773 } else if (num_fingers == 1) {
774 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
775 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
777 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
778 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
782 static void synaptics_report_buttons(struct psmouse *psmouse,
783 const struct synaptics_hw_state *hw)
785 struct input_dev *dev = psmouse->dev;
786 struct synaptics_data *priv = psmouse->private;
789 input_report_key(dev, BTN_LEFT, hw->left);
790 input_report_key(dev, BTN_RIGHT, hw->right);
792 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
793 input_report_key(dev, BTN_MIDDLE, hw->middle);
795 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
796 input_report_key(dev, BTN_FORWARD, hw->up);
797 input_report_key(dev, BTN_BACK, hw->down);
800 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
801 input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
804 static void synaptics_report_mt_data(struct psmouse *psmouse,
805 const struct synaptics_hw_state *sgm,
808 struct input_dev *dev = psmouse->dev;
809 struct synaptics_data *priv = psmouse->private;
810 const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
811 struct input_mt_pos pos[2];
812 int slot[2], nsemi, i;
814 nsemi = clamp_val(num_fingers, 0, 2);
816 for (i = 0; i < nsemi; i++) {
818 pos[i].y = synaptics_invert_y(hw[i]->y);
821 input_mt_assign_slots(dev, slot, pos, nsemi, DMAX * priv->x_res);
823 for (i = 0; i < nsemi; i++) {
824 input_mt_slot(dev, slot[i]);
825 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
826 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
827 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
828 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
831 input_mt_drop_unused(dev);
833 /* Don't use active slot count to generate BTN_TOOL events. */
834 input_mt_report_pointer_emulation(dev, false);
836 /* Send the number of fingers reported by touchpad itself. */
837 input_mt_report_finger_count(dev, num_fingers);
839 synaptics_report_buttons(psmouse, sgm);
844 static void synaptics_image_sensor_process(struct psmouse *psmouse,
845 struct synaptics_hw_state *sgm)
847 struct synaptics_data *priv = psmouse->private;
851 * Update mt_state using the new finger count and current mt_state.
855 else if (sgm->w >= 4)
857 else if (sgm->w == 0)
859 else if (sgm->w == 1)
860 num_fingers = priv->agm_count ? priv->agm_count : 3;
864 /* Send resulting input events to user space */
865 synaptics_report_mt_data(psmouse, sgm, num_fingers);
869 * called for each full received packet from the touchpad
871 static void synaptics_process_packet(struct psmouse *psmouse)
873 struct input_dev *dev = psmouse->dev;
874 struct synaptics_data *priv = psmouse->private;
875 struct synaptics_hw_state hw;
879 if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
882 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
883 synaptics_image_sensor_process(psmouse, &hw);
888 priv->scroll += hw.scroll;
890 while (priv->scroll >= 4) {
891 input_report_key(dev, BTN_BACK, !hw.down);
893 input_report_key(dev, BTN_BACK, hw.down);
897 while (priv->scroll <= -4) {
898 input_report_key(dev, BTN_FORWARD, !hw.up);
900 input_report_key(dev, BTN_FORWARD, hw.up);
907 if (hw.z > 0 && hw.x > 1) {
910 if (SYN_CAP_EXTENDED(priv->capabilities)) {
913 if (SYN_CAP_MULTIFINGER(priv->capabilities))
914 num_fingers = hw.w + 2;
917 if (SYN_MODEL_PEN(priv->model_id))
918 ; /* Nothing, treat a pen as a single finger */
921 if (SYN_CAP_PALMDETECT(priv->capabilities))
931 if (cr48_profile_sensor) {
932 synaptics_report_mt_data(psmouse, &hw, num_fingers);
936 if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
937 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
941 * BTN_TOUCH has to be first as mousedev relies on it when doing
942 * absolute -> relative conversion
944 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
945 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
947 if (num_fingers > 0) {
948 input_report_abs(dev, ABS_X, hw.x);
949 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
951 input_report_abs(dev, ABS_PRESSURE, hw.z);
953 if (SYN_CAP_PALMDETECT(priv->capabilities))
954 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
956 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
957 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
958 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
959 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
962 synaptics_report_buttons(psmouse, &hw);
967 static int synaptics_validate_byte(struct psmouse *psmouse,
968 int idx, unsigned char pkt_type)
970 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
971 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
972 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
973 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
974 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
975 const char *packet = psmouse->packet;
977 if (idx < 0 || idx > 4)
983 case SYN_NEWABS_RELAXED:
984 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
986 case SYN_NEWABS_STRICT:
987 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
990 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
993 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
998 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
1002 for (i = 0; i < 5; i++)
1003 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
1004 psmouse_info(psmouse, "using relaxed packet validation\n");
1005 return SYN_NEWABS_RELAXED;
1008 return SYN_NEWABS_STRICT;
1011 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1013 struct synaptics_data *priv = psmouse->private;
1015 if (psmouse->pktcnt >= 6) { /* Full packet received */
1016 if (unlikely(priv->pkt_type == SYN_NEWABS))
1017 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1019 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1020 synaptics_is_pt_packet(psmouse->packet)) {
1022 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1024 synaptics_process_packet(psmouse);
1026 return PSMOUSE_FULL_PACKET;
1029 return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1030 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1033 /*****************************************************************************
1034 * Driver initialization/cleanup functions
1035 ****************************************************************************/
1036 static void set_abs_position_params(struct input_dev *dev,
1037 struct synaptics_data *priv, int x_code,
1040 int x_min = priv->x_min ?: XMIN_NOMINAL;
1041 int x_max = priv->x_max ?: XMAX_NOMINAL;
1042 int y_min = priv->y_min ?: YMIN_NOMINAL;
1043 int y_max = priv->y_max ?: YMAX_NOMINAL;
1044 int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1045 SYN_REDUCED_FILTER_FUZZ : 0;
1047 input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1048 input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1049 input_abs_set_res(dev, x_code, priv->x_res);
1050 input_abs_set_res(dev, y_code, priv->y_res);
1053 static void set_input_params(struct psmouse *psmouse,
1054 struct synaptics_data *priv)
1056 struct input_dev *dev = psmouse->dev;
1059 /* Things that apply to both modes */
1060 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1061 __set_bit(EV_KEY, dev->evbit);
1062 __set_bit(BTN_LEFT, dev->keybit);
1063 __set_bit(BTN_RIGHT, dev->keybit);
1065 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1066 __set_bit(BTN_MIDDLE, dev->keybit);
1068 if (!priv->absolute_mode) {
1070 __set_bit(EV_REL, dev->evbit);
1071 __set_bit(REL_X, dev->relbit);
1072 __set_bit(REL_Y, dev->relbit);
1077 __set_bit(EV_ABS, dev->evbit);
1078 set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1079 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1081 if (cr48_profile_sensor)
1082 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1084 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1085 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1087 /* Image sensors can report per-contact pressure */
1088 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1089 input_mt_init_slots(dev, 2, INPUT_MT_POINTER | INPUT_MT_TRACK);
1091 /* Image sensors can signal 4 and 5 finger clicks */
1092 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1093 __set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1094 } else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1095 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1098 * Profile sensor in CR-48 tracks contacts reasonably well,
1099 * other non-image sensors with AGM use semi-mt.
1101 input_mt_init_slots(dev, 2,
1103 (cr48_profile_sensor ?
1104 INPUT_MT_TRACK : INPUT_MT_SEMI_MT));
1107 if (SYN_CAP_PALMDETECT(priv->capabilities))
1108 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1110 __set_bit(BTN_TOUCH, dev->keybit);
1111 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1113 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1114 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1115 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1118 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1119 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1120 __set_bit(BTN_FORWARD, dev->keybit);
1121 __set_bit(BTN_BACK, dev->keybit);
1124 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1125 __set_bit(BTN_0 + i, dev->keybit);
1127 __clear_bit(EV_REL, dev->evbit);
1128 __clear_bit(REL_X, dev->relbit);
1129 __clear_bit(REL_Y, dev->relbit);
1131 if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1132 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1133 if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids))
1134 __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1135 /* Clickpads report only left button */
1136 __clear_bit(BTN_RIGHT, dev->keybit);
1137 __clear_bit(BTN_MIDDLE, dev->keybit);
1141 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1142 void *data, char *buf)
1144 struct synaptics_data *priv = psmouse->private;
1146 return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1149 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1150 void *data, const char *buf,
1153 struct synaptics_data *priv = psmouse->private;
1157 err = kstrtouint(buf, 10, &value);
1164 if (value == priv->disable_gesture)
1167 priv->disable_gesture = value;
1169 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1171 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1173 if (synaptics_mode_cmd(psmouse, priv->mode))
1179 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1180 synaptics_show_disable_gesture,
1181 synaptics_set_disable_gesture);
1183 static void synaptics_disconnect(struct psmouse *psmouse)
1185 struct synaptics_data *priv = psmouse->private;
1187 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity))
1188 device_remove_file(&psmouse->ps2dev.serio->dev,
1189 &psmouse_attr_disable_gesture.dattr);
1191 synaptics_reset(psmouse);
1193 psmouse->private = NULL;
1196 static int synaptics_reconnect(struct psmouse *psmouse)
1198 struct synaptics_data *priv = psmouse->private;
1199 struct synaptics_data old_priv = *priv;
1200 unsigned char param[2];
1205 psmouse_reset(psmouse);
1208 * On some boxes, right after resuming, the touchpad
1209 * needs some time to finish initializing (I assume
1210 * it needs time to calibrate) and start responding
1211 * to Synaptics-specific queries, so let's wait a
1216 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1217 error = synaptics_detect(psmouse, 0);
1218 } while (error && ++retry < 3);
1224 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1226 if (synaptics_query_hardware(psmouse)) {
1227 psmouse_err(psmouse, "Unable to query device.\n");
1231 if (synaptics_set_mode(psmouse)) {
1232 psmouse_err(psmouse, "Unable to initialize device.\n");
1236 if (old_priv.identity != priv->identity ||
1237 old_priv.model_id != priv->model_id ||
1238 old_priv.capabilities != priv->capabilities ||
1239 old_priv.ext_cap != priv->ext_cap) {
1240 psmouse_err(psmouse,
1241 "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1242 old_priv.identity, priv->identity,
1243 old_priv.model_id, priv->model_id,
1244 old_priv.capabilities, priv->capabilities,
1245 old_priv.ext_cap, priv->ext_cap);
1252 static bool impaired_toshiba_kbc;
1254 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1255 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1257 /* Toshiba Satellite */
1259 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1260 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1264 /* Toshiba Dynabook */
1266 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1267 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1271 /* Toshiba Portege M300 */
1273 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1274 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1279 /* Toshiba Portege M300 */
1281 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1282 DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1283 DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1291 static bool broken_olpc_ec;
1293 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1294 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1296 /* OLPC XO-1 or XO-1.5 */
1298 DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1299 DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1306 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1307 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1309 /* Cr-48 Chromebook (Codename Mario) */
1311 DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1312 DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1319 void __init synaptics_module_init(void)
1321 impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1322 broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1323 cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1326 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1328 struct synaptics_data *priv;
1332 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1333 * packet spew overloads the EC such that key presses on the keyboard
1334 * are missed. Given that, don't even attempt to use Absolute mode.
1335 * Relative mode seems to work just fine.
1337 if (absolute_mode && broken_olpc_ec) {
1338 psmouse_info(psmouse,
1339 "OLPC XO detected, not enabling Synaptics protocol.\n");
1343 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1347 psmouse_reset(psmouse);
1349 if (synaptics_query_hardware(psmouse)) {
1350 psmouse_err(psmouse, "Unable to query device.\n");
1354 priv->absolute_mode = absolute_mode;
1355 if (SYN_ID_DISGEST_SUPPORTED(priv->identity))
1356 priv->disable_gesture = true;
1359 * Unfortunately ForcePad capability is not exported over PS/2,
1360 * so we have to resort to checking PNP IDs.
1362 priv->is_forcepad = psmouse_matches_pnp_id(psmouse, forcepad_pnp_ids);
1364 if (synaptics_set_mode(psmouse)) {
1365 psmouse_err(psmouse, "Unable to initialize device.\n");
1369 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1371 psmouse_info(psmouse,
1372 "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx, board id: %lu, fw id: %lu\n",
1373 SYN_ID_MODEL(priv->identity),
1374 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1376 priv->capabilities, priv->ext_cap, priv->ext_cap_0c,
1377 priv->board_id, priv->firmware_id);
1379 set_input_params(psmouse, priv);
1382 * Encode touchpad model so that it can be used to set
1383 * input device->id.version and be visible to userspace.
1384 * Because version is __u16 we have to drop something.
1385 * Hardware info bits seem to be good candidates as they
1386 * are documented to be for Synaptics corp. internal use.
1388 psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1389 (priv->model_id & 0x000000ff);
1391 if (absolute_mode) {
1392 psmouse->protocol_handler = synaptics_process_byte;
1393 psmouse->pktsize = 6;
1395 /* Relative mode follows standard PS/2 mouse protocol */
1396 psmouse->protocol_handler = psmouse_process_byte;
1397 psmouse->pktsize = 3;
1400 psmouse->set_rate = synaptics_set_rate;
1401 psmouse->disconnect = synaptics_disconnect;
1402 psmouse->reconnect = synaptics_reconnect;
1403 psmouse->cleanup = synaptics_reset;
1404 /* Synaptics can usually stay in sync without extra help */
1405 psmouse->resync_time = 0;
1407 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1408 synaptics_pt_create(psmouse);
1411 * Toshiba's KBC seems to have trouble handling data from
1412 * Synaptics at full rate. Switch to a lower rate (roughly
1413 * the same rate as a standard PS/2 mouse).
1415 if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1416 psmouse_info(psmouse,
1417 "Toshiba %s detected, limiting rate to 40pps.\n",
1418 dmi_get_system_info(DMI_PRODUCT_NAME));
1422 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity)) {
1423 err = device_create_file(&psmouse->ps2dev.serio->dev,
1424 &psmouse_attr_disable_gesture.dattr);
1426 psmouse_err(psmouse,
1427 "Failed to create disable_gesture attribute (%d)",
1440 int synaptics_init(struct psmouse *psmouse)
1442 return __synaptics_init(psmouse, true);
1445 int synaptics_init_relative(struct psmouse *psmouse)
1447 return __synaptics_init(psmouse, false);
1450 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1452 void __init synaptics_module_init(void)
1456 int synaptics_init(struct psmouse *psmouse)
1461 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */