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 /*****************************************************************************
198 * Synaptics communications functions
199 ****************************************************************************/
202 * Synaptics touchpads report the y coordinate from bottom to top, which is
203 * opposite from what userspace expects.
204 * This function is used to invert y before reporting.
206 static int synaptics_invert_y(int y)
208 return YMAX_NOMINAL + YMIN_NOMINAL - y;
212 * Send a command to the synpatics touchpad by special commands
214 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
216 if (psmouse_sliced_command(psmouse, c))
218 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
224 * Read the model-id bytes from the touchpad
225 * see also SYN_MODEL_* macros
227 static int synaptics_model_id(struct psmouse *psmouse)
229 struct synaptics_data *priv = psmouse->private;
232 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
234 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
239 * Read the board id from the touchpad
240 * The board id is encoded in the "QUERY MODES" response
242 static int synaptics_board_id(struct psmouse *psmouse)
244 struct synaptics_data *priv = psmouse->private;
245 unsigned char bid[3];
247 if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid))
249 priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
254 * Read the firmware id from the touchpad
256 static int synaptics_firmware_id(struct psmouse *psmouse)
258 struct synaptics_data *priv = psmouse->private;
259 unsigned char fwid[3];
261 if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid))
263 priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
268 * Read the capability-bits from the touchpad
269 * see also the SYN_CAP_* macros
271 static int synaptics_capability(struct psmouse *psmouse)
273 struct synaptics_data *priv = psmouse->private;
274 unsigned char cap[3];
276 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
278 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
279 priv->ext_cap = priv->ext_cap_0c = 0;
282 * Older firmwares had submodel ID fixed to 0x47
284 if (SYN_ID_FULL(priv->identity) < 0x705 &&
285 SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
290 * Unless capExtended is set the rest of the flags should be ignored
292 if (!SYN_CAP_EXTENDED(priv->capabilities))
293 priv->capabilities = 0;
295 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
296 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
297 psmouse_warn(psmouse,
298 "device claims to have extended capabilities, but I'm not able to read them.\n");
300 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
303 * if nExtBtn is greater than 8 it should be considered
304 * invalid and treated as 0
306 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
307 priv->ext_cap &= 0xff0fff;
311 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
312 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
313 psmouse_warn(psmouse,
314 "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
316 priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
325 * See also the SYN_ID_* macros
327 static int synaptics_identify(struct psmouse *psmouse)
329 struct synaptics_data *priv = psmouse->private;
332 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
334 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
335 if (SYN_ID_IS_SYNAPTICS(priv->identity))
341 * Read touchpad resolution and maximum reported coordinates
342 * Resolution is left zero if touchpad does not support the query
345 static int synaptics_resolution(struct psmouse *psmouse)
347 struct synaptics_data *priv = psmouse->private;
348 unsigned char resp[3];
351 if (SYN_ID_MAJOR(priv->identity) < 4)
354 if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
355 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
356 priv->x_res = resp[0]; /* x resolution in units/mm */
357 priv->y_res = resp[2]; /* y resolution in units/mm */
361 for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
362 if (psmouse_matches_pnp_id(psmouse,
363 min_max_pnpid_table[i].pnp_ids)) {
364 priv->x_min = min_max_pnpid_table[i].x_min;
365 priv->x_max = min_max_pnpid_table[i].x_max;
366 priv->y_min = min_max_pnpid_table[i].y_min;
367 priv->y_max = min_max_pnpid_table[i].y_max;
372 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
373 SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
374 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
375 psmouse_warn(psmouse,
376 "device claims to have max coordinates query, but I'm not able to read it.\n");
378 priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
379 priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
383 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
384 SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
385 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
386 psmouse_warn(psmouse,
387 "device claims to have min coordinates query, but I'm not able to read it.\n");
389 priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
390 priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
397 static int synaptics_query_hardware(struct psmouse *psmouse)
399 if (synaptics_identify(psmouse))
401 if (synaptics_model_id(psmouse))
403 if (synaptics_firmware_id(psmouse))
405 if (synaptics_board_id(psmouse))
407 if (synaptics_capability(psmouse))
409 if (synaptics_resolution(psmouse))
415 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
417 static unsigned char param = 0xc8;
418 struct synaptics_data *priv = psmouse->private;
420 if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
421 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
424 if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
427 if (ps2_command(&psmouse->ps2dev, ¶m, PSMOUSE_CMD_SETRATE))
430 /* Advanced gesture mode also sends multi finger data */
431 priv->capabilities |= BIT(1);
436 static int synaptics_set_mode(struct psmouse *psmouse)
438 struct synaptics_data *priv = psmouse->private;
441 if (priv->absolute_mode)
442 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
443 if (priv->disable_gesture)
444 priv->mode |= SYN_BIT_DISABLE_GESTURE;
445 if (psmouse->rate >= 80)
446 priv->mode |= SYN_BIT_HIGH_RATE;
447 if (SYN_CAP_EXTENDED(priv->capabilities))
448 priv->mode |= SYN_BIT_W_MODE;
450 if (synaptics_mode_cmd(psmouse, priv->mode))
453 if (priv->absolute_mode &&
454 synaptics_set_advanced_gesture_mode(psmouse)) {
455 psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
462 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
464 struct synaptics_data *priv = psmouse->private;
467 priv->mode |= SYN_BIT_HIGH_RATE;
470 priv->mode &= ~SYN_BIT_HIGH_RATE;
474 synaptics_mode_cmd(psmouse, priv->mode);
477 /*****************************************************************************
478 * Synaptics pass-through PS/2 port support
479 ****************************************************************************/
480 static int synaptics_pt_write(struct serio *serio, unsigned char c)
482 struct psmouse *parent = serio_get_drvdata(serio->parent);
483 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
485 if (psmouse_sliced_command(parent, c))
487 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
492 static int synaptics_pt_start(struct serio *serio)
494 struct psmouse *parent = serio_get_drvdata(serio->parent);
495 struct synaptics_data *priv = parent->private;
497 serio_pause_rx(parent->ps2dev.serio);
498 priv->pt_port = serio;
499 serio_continue_rx(parent->ps2dev.serio);
504 static void synaptics_pt_stop(struct serio *serio)
506 struct psmouse *parent = serio_get_drvdata(serio->parent);
507 struct synaptics_data *priv = parent->private;
509 serio_pause_rx(parent->ps2dev.serio);
510 priv->pt_port = NULL;
511 serio_continue_rx(parent->ps2dev.serio);
514 static int synaptics_is_pt_packet(unsigned char *buf)
516 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
519 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
521 struct psmouse *child = serio_get_drvdata(ptport);
523 if (child && child->state == PSMOUSE_ACTIVATED) {
524 serio_interrupt(ptport, packet[1], 0);
525 serio_interrupt(ptport, packet[4], 0);
526 serio_interrupt(ptport, packet[5], 0);
527 if (child->pktsize == 4)
528 serio_interrupt(ptport, packet[2], 0);
530 serio_interrupt(ptport, packet[1], 0);
533 static void synaptics_pt_activate(struct psmouse *psmouse)
535 struct synaptics_data *priv = psmouse->private;
536 struct psmouse *child = serio_get_drvdata(priv->pt_port);
538 /* adjust the touchpad to child's choice of protocol */
540 if (child->pktsize == 4)
541 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
543 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
545 if (synaptics_mode_cmd(psmouse, priv->mode))
546 psmouse_warn(psmouse,
547 "failed to switch guest protocol\n");
551 static void synaptics_pt_create(struct psmouse *psmouse)
555 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
558 "not enough memory for pass-through port\n");
562 serio->id.type = SERIO_PS_PSTHRU;
563 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
564 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
565 serio->write = synaptics_pt_write;
566 serio->start = synaptics_pt_start;
567 serio->stop = synaptics_pt_stop;
568 serio->parent = psmouse->ps2dev.serio;
570 psmouse->pt_activate = synaptics_pt_activate;
572 psmouse_info(psmouse, "serio: %s port at %s\n",
573 serio->name, psmouse->phys);
574 serio_register_port(serio);
577 /*****************************************************************************
578 * Functions to interpret the absolute mode packets
579 ****************************************************************************/
581 static void synaptics_parse_agm(const unsigned char buf[],
582 struct synaptics_data *priv,
583 struct synaptics_hw_state *hw)
585 struct synaptics_hw_state *agm = &priv->agm;
588 agm_packet_type = (buf[5] & 0x30) >> 4;
589 switch (agm_packet_type) {
591 /* Gesture packet: (x, y, z) half resolution */
593 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
594 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
595 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
599 /* AGM-CONTACT packet: we are only interested in the count */
600 priv->agm_count = buf[1];
608 static bool is_forcepad;
610 static int synaptics_parse_hw_state(const unsigned char buf[],
611 struct synaptics_data *priv,
612 struct synaptics_hw_state *hw)
614 memset(hw, 0, sizeof(struct synaptics_hw_state));
616 if (SYN_MODEL_NEWABS(priv->model_id)) {
617 hw->w = (((buf[0] & 0x30) >> 2) |
618 ((buf[0] & 0x04) >> 1) |
619 ((buf[3] & 0x04) >> 2));
621 if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
622 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
624 synaptics_parse_agm(buf, priv, hw);
628 hw->x = (((buf[3] & 0x10) << 8) |
629 ((buf[1] & 0x0f) << 8) |
631 hw->y = (((buf[3] & 0x20) << 7) |
632 ((buf[1] & 0xf0) << 4) |
636 hw->left = (buf[0] & 0x01) ? 1 : 0;
637 hw->right = (buf[0] & 0x02) ? 1 : 0;
641 * ForcePads, like Clickpads, use middle button
642 * bits to report primary button clicks.
643 * Unfortunately they report primary button not
644 * only when user presses on the pad above certain
645 * threshold, but also when there are more than one
646 * finger on the touchpad, which interferes with
647 * out multi-finger gestures.
651 priv->press = priv->report_press = false;
652 } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
654 * Single-finger touch with pressure above
655 * the threshold. If pressure stays long
656 * enough, we'll start reporting primary
657 * button. We rely on the device continuing
658 * sending data even if finger does not
662 priv->press_start = jiffies;
664 } else if (time_after(jiffies,
666 msecs_to_jiffies(50))) {
667 priv->report_press = true;
673 hw->left = priv->report_press;
675 } else if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
677 * Clickpad's button is transmitted as middle button,
678 * however, since it is primary button, we will report
681 hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
683 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
684 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
686 hw->scroll = (signed char)(buf[1]);
689 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
690 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
691 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
694 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
695 ((buf[0] ^ buf[3]) & 0x02)) {
696 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
699 * if nExtBtn is greater than 8 it should be
700 * considered invalid and treated as 0
704 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
705 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
707 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
708 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
710 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
711 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
713 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
714 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
718 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
719 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
721 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
722 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
724 hw->left = (buf[0] & 0x01) ? 1 : 0;
725 hw->right = (buf[0] & 0x02) ? 1 : 0;
729 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
730 * is used by some firmware to indicate a finger at the edge of
731 * the touchpad whose precise position cannot be determined, so
732 * convert these values to the maximum axis value.
734 if (hw->x > X_MAX_POSITIVE)
735 hw->x -= 1 << ABS_POS_BITS;
736 else if (hw->x == X_MAX_POSITIVE)
739 if (hw->y > Y_MAX_POSITIVE)
740 hw->y -= 1 << ABS_POS_BITS;
741 else if (hw->y == Y_MAX_POSITIVE)
747 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
748 bool active, int x, int y)
750 input_mt_slot(dev, slot);
751 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
753 input_report_abs(dev, ABS_MT_POSITION_X, x);
754 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
758 static void synaptics_report_semi_mt_data(struct input_dev *dev,
759 const struct synaptics_hw_state *a,
760 const struct synaptics_hw_state *b,
763 if (num_fingers >= 2) {
764 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
766 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
768 } else if (num_fingers == 1) {
769 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
770 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
772 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
773 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
777 static void synaptics_report_buttons(struct psmouse *psmouse,
778 const struct synaptics_hw_state *hw)
780 struct input_dev *dev = psmouse->dev;
781 struct synaptics_data *priv = psmouse->private;
784 input_report_key(dev, BTN_LEFT, hw->left);
785 input_report_key(dev, BTN_RIGHT, hw->right);
787 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
788 input_report_key(dev, BTN_MIDDLE, hw->middle);
790 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
791 input_report_key(dev, BTN_FORWARD, hw->up);
792 input_report_key(dev, BTN_BACK, hw->down);
795 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
796 input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
799 static void synaptics_report_mt_data(struct psmouse *psmouse,
800 const struct synaptics_hw_state *sgm,
803 struct input_dev *dev = psmouse->dev;
804 struct synaptics_data *priv = psmouse->private;
805 const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
806 struct input_mt_pos pos[2];
807 int slot[2], nsemi, i;
809 nsemi = clamp_val(num_fingers, 0, 2);
811 for (i = 0; i < nsemi; i++) {
813 pos[i].y = synaptics_invert_y(hw[i]->y);
816 input_mt_assign_slots(dev, slot, pos, nsemi, DMAX * priv->x_res);
818 for (i = 0; i < nsemi; i++) {
819 input_mt_slot(dev, slot[i]);
820 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
821 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
822 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
823 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
826 input_mt_drop_unused(dev);
828 /* Don't use active slot count to generate BTN_TOOL events. */
829 input_mt_report_pointer_emulation(dev, false);
831 /* Send the number of fingers reported by touchpad itself. */
832 input_mt_report_finger_count(dev, num_fingers);
834 synaptics_report_buttons(psmouse, sgm);
839 static void synaptics_image_sensor_process(struct psmouse *psmouse,
840 struct synaptics_hw_state *sgm)
842 struct synaptics_data *priv = psmouse->private;
846 * Update mt_state using the new finger count and current mt_state.
850 else if (sgm->w >= 4)
852 else if (sgm->w == 0)
854 else if (sgm->w == 1)
855 num_fingers = priv->agm_count ? priv->agm_count : 3;
859 /* Send resulting input events to user space */
860 synaptics_report_mt_data(psmouse, sgm, num_fingers);
864 * called for each full received packet from the touchpad
866 static void synaptics_process_packet(struct psmouse *psmouse)
868 struct input_dev *dev = psmouse->dev;
869 struct synaptics_data *priv = psmouse->private;
870 struct synaptics_hw_state hw;
874 if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
877 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
878 synaptics_image_sensor_process(psmouse, &hw);
883 priv->scroll += hw.scroll;
885 while (priv->scroll >= 4) {
886 input_report_key(dev, BTN_BACK, !hw.down);
888 input_report_key(dev, BTN_BACK, hw.down);
892 while (priv->scroll <= -4) {
893 input_report_key(dev, BTN_FORWARD, !hw.up);
895 input_report_key(dev, BTN_FORWARD, hw.up);
902 if (hw.z > 0 && hw.x > 1) {
905 if (SYN_CAP_EXTENDED(priv->capabilities)) {
908 if (SYN_CAP_MULTIFINGER(priv->capabilities))
909 num_fingers = hw.w + 2;
912 if (SYN_MODEL_PEN(priv->model_id))
913 ; /* Nothing, treat a pen as a single finger */
916 if (SYN_CAP_PALMDETECT(priv->capabilities))
926 if (cr48_profile_sensor) {
927 synaptics_report_mt_data(psmouse, &hw, num_fingers);
931 if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
932 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
936 * BTN_TOUCH has to be first as mousedev relies on it when doing
937 * absolute -> relative conversion
939 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
940 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
942 if (num_fingers > 0) {
943 input_report_abs(dev, ABS_X, hw.x);
944 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
946 input_report_abs(dev, ABS_PRESSURE, hw.z);
948 if (SYN_CAP_PALMDETECT(priv->capabilities))
949 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
951 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
952 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
953 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
954 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
957 synaptics_report_buttons(psmouse, &hw);
962 static int synaptics_validate_byte(struct psmouse *psmouse,
963 int idx, unsigned char pkt_type)
965 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
966 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
967 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
968 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
969 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
970 const char *packet = psmouse->packet;
972 if (idx < 0 || idx > 4)
978 case SYN_NEWABS_RELAXED:
979 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
981 case SYN_NEWABS_STRICT:
982 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
985 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
988 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
993 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
997 for (i = 0; i < 5; i++)
998 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
999 psmouse_info(psmouse, "using relaxed packet validation\n");
1000 return SYN_NEWABS_RELAXED;
1003 return SYN_NEWABS_STRICT;
1006 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1008 struct synaptics_data *priv = psmouse->private;
1010 if (psmouse->pktcnt >= 6) { /* Full packet received */
1011 if (unlikely(priv->pkt_type == SYN_NEWABS))
1012 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1014 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1015 synaptics_is_pt_packet(psmouse->packet)) {
1017 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1019 synaptics_process_packet(psmouse);
1021 return PSMOUSE_FULL_PACKET;
1024 return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1025 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1028 /*****************************************************************************
1029 * Driver initialization/cleanup functions
1030 ****************************************************************************/
1031 static void set_abs_position_params(struct input_dev *dev,
1032 struct synaptics_data *priv, int x_code,
1035 int x_min = priv->x_min ?: XMIN_NOMINAL;
1036 int x_max = priv->x_max ?: XMAX_NOMINAL;
1037 int y_min = priv->y_min ?: YMIN_NOMINAL;
1038 int y_max = priv->y_max ?: YMAX_NOMINAL;
1039 int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1040 SYN_REDUCED_FILTER_FUZZ : 0;
1042 input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1043 input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1044 input_abs_set_res(dev, x_code, priv->x_res);
1045 input_abs_set_res(dev, y_code, priv->y_res);
1048 static void set_input_params(struct psmouse *psmouse,
1049 struct synaptics_data *priv)
1051 struct input_dev *dev = psmouse->dev;
1054 /* Things that apply to both modes */
1055 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1056 __set_bit(EV_KEY, dev->evbit);
1057 __set_bit(BTN_LEFT, dev->keybit);
1058 __set_bit(BTN_RIGHT, dev->keybit);
1060 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1061 __set_bit(BTN_MIDDLE, dev->keybit);
1063 if (!priv->absolute_mode) {
1065 __set_bit(EV_REL, dev->evbit);
1066 __set_bit(REL_X, dev->relbit);
1067 __set_bit(REL_Y, dev->relbit);
1072 __set_bit(EV_ABS, dev->evbit);
1073 set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1074 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1076 if (cr48_profile_sensor)
1077 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1079 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1080 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1082 /* Image sensors can report per-contact pressure */
1083 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1084 input_mt_init_slots(dev, 2, INPUT_MT_POINTER | INPUT_MT_TRACK);
1086 /* Image sensors can signal 4 and 5 finger clicks */
1087 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1088 __set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1089 } else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1090 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1093 * Profile sensor in CR-48 tracks contacts reasonably well,
1094 * other non-image sensors with AGM use semi-mt.
1096 input_mt_init_slots(dev, 2,
1098 (cr48_profile_sensor ?
1099 INPUT_MT_TRACK : INPUT_MT_SEMI_MT));
1102 if (SYN_CAP_PALMDETECT(priv->capabilities))
1103 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1105 __set_bit(BTN_TOUCH, dev->keybit);
1106 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1108 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1109 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1110 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1113 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1114 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1115 __set_bit(BTN_FORWARD, dev->keybit);
1116 __set_bit(BTN_BACK, dev->keybit);
1119 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1120 __set_bit(BTN_0 + i, dev->keybit);
1122 __clear_bit(EV_REL, dev->evbit);
1123 __clear_bit(REL_X, dev->relbit);
1124 __clear_bit(REL_Y, dev->relbit);
1126 if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1127 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1128 if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids))
1129 __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1130 /* Clickpads report only left button */
1131 __clear_bit(BTN_RIGHT, dev->keybit);
1132 __clear_bit(BTN_MIDDLE, dev->keybit);
1136 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1137 void *data, char *buf)
1139 struct synaptics_data *priv = psmouse->private;
1141 return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1144 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1145 void *data, const char *buf,
1148 struct synaptics_data *priv = psmouse->private;
1152 err = kstrtouint(buf, 10, &value);
1159 if (value == priv->disable_gesture)
1162 priv->disable_gesture = value;
1164 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1166 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1168 if (synaptics_mode_cmd(psmouse, priv->mode))
1174 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1175 synaptics_show_disable_gesture,
1176 synaptics_set_disable_gesture);
1178 static void synaptics_disconnect(struct psmouse *psmouse)
1180 struct synaptics_data *priv = psmouse->private;
1182 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity))
1183 device_remove_file(&psmouse->ps2dev.serio->dev,
1184 &psmouse_attr_disable_gesture.dattr);
1186 synaptics_reset(psmouse);
1188 psmouse->private = NULL;
1191 static int synaptics_reconnect(struct psmouse *psmouse)
1193 struct synaptics_data *priv = psmouse->private;
1194 struct synaptics_data old_priv = *priv;
1195 unsigned char param[2];
1200 psmouse_reset(psmouse);
1203 * On some boxes, right after resuming, the touchpad
1204 * needs some time to finish initializing (I assume
1205 * it needs time to calibrate) and start responding
1206 * to Synaptics-specific queries, so let's wait a
1211 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1212 error = synaptics_detect(psmouse, 0);
1213 } while (error && ++retry < 3);
1219 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1221 if (synaptics_query_hardware(psmouse)) {
1222 psmouse_err(psmouse, "Unable to query device.\n");
1226 if (synaptics_set_mode(psmouse)) {
1227 psmouse_err(psmouse, "Unable to initialize device.\n");
1231 if (old_priv.identity != priv->identity ||
1232 old_priv.model_id != priv->model_id ||
1233 old_priv.capabilities != priv->capabilities ||
1234 old_priv.ext_cap != priv->ext_cap) {
1235 psmouse_err(psmouse,
1236 "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1237 old_priv.identity, priv->identity,
1238 old_priv.model_id, priv->model_id,
1239 old_priv.capabilities, priv->capabilities,
1240 old_priv.ext_cap, priv->ext_cap);
1247 static bool impaired_toshiba_kbc;
1249 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1250 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1252 /* Toshiba Satellite */
1254 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1255 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1259 /* Toshiba Dynabook */
1261 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1262 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1266 /* Toshiba Portege M300 */
1268 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1269 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1274 /* Toshiba Portege M300 */
1276 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1277 DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1278 DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1286 static bool broken_olpc_ec;
1288 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1289 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1291 /* OLPC XO-1 or XO-1.5 */
1293 DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1294 DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1301 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1302 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1304 /* Cr-48 Chromebook (Codename Mario) */
1306 DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1307 DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1314 static const struct dmi_system_id forcepad_dmi_table[] __initconst = {
1315 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1318 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1319 DMI_MATCH(DMI_PRODUCT_NAME, "HP EliteBook Folio 1040 G1"),
1326 void __init synaptics_module_init(void)
1328 impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1329 broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1330 cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1333 * Unfortunately ForcePad capability is not exported over PS/2,
1334 * so we have to resort to checking DMI.
1336 is_forcepad = dmi_check_system(forcepad_dmi_table);
1339 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1341 struct synaptics_data *priv;
1345 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1346 * packet spew overloads the EC such that key presses on the keyboard
1347 * are missed. Given that, don't even attempt to use Absolute mode.
1348 * Relative mode seems to work just fine.
1350 if (absolute_mode && broken_olpc_ec) {
1351 psmouse_info(psmouse,
1352 "OLPC XO detected, not enabling Synaptics protocol.\n");
1356 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1360 psmouse_reset(psmouse);
1362 if (synaptics_query_hardware(psmouse)) {
1363 psmouse_err(psmouse, "Unable to query device.\n");
1367 priv->absolute_mode = absolute_mode;
1368 if (SYN_ID_DISGEST_SUPPORTED(priv->identity))
1369 priv->disable_gesture = true;
1371 if (synaptics_set_mode(psmouse)) {
1372 psmouse_err(psmouse, "Unable to initialize device.\n");
1376 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1378 psmouse_info(psmouse,
1379 "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx, board id: %lu, fw id: %lu\n",
1380 SYN_ID_MODEL(priv->identity),
1381 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1383 priv->capabilities, priv->ext_cap, priv->ext_cap_0c,
1384 priv->board_id, priv->firmware_id);
1386 set_input_params(psmouse, priv);
1389 * Encode touchpad model so that it can be used to set
1390 * input device->id.version and be visible to userspace.
1391 * Because version is __u16 we have to drop something.
1392 * Hardware info bits seem to be good candidates as they
1393 * are documented to be for Synaptics corp. internal use.
1395 psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1396 (priv->model_id & 0x000000ff);
1398 if (absolute_mode) {
1399 psmouse->protocol_handler = synaptics_process_byte;
1400 psmouse->pktsize = 6;
1402 /* Relative mode follows standard PS/2 mouse protocol */
1403 psmouse->protocol_handler = psmouse_process_byte;
1404 psmouse->pktsize = 3;
1407 psmouse->set_rate = synaptics_set_rate;
1408 psmouse->disconnect = synaptics_disconnect;
1409 psmouse->reconnect = synaptics_reconnect;
1410 psmouse->cleanup = synaptics_reset;
1411 /* Synaptics can usually stay in sync without extra help */
1412 psmouse->resync_time = 0;
1414 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1415 synaptics_pt_create(psmouse);
1418 * Toshiba's KBC seems to have trouble handling data from
1419 * Synaptics at full rate. Switch to a lower rate (roughly
1420 * the same rate as a standard PS/2 mouse).
1422 if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1423 psmouse_info(psmouse,
1424 "Toshiba %s detected, limiting rate to 40pps.\n",
1425 dmi_get_system_info(DMI_PRODUCT_NAME));
1429 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity)) {
1430 err = device_create_file(&psmouse->ps2dev.serio->dev,
1431 &psmouse_attr_disable_gesture.dattr);
1433 psmouse_err(psmouse,
1434 "Failed to create disable_gesture attribute (%d)",
1447 int synaptics_init(struct psmouse *psmouse)
1449 return __synaptics_init(psmouse, true);
1452 int synaptics_init_relative(struct psmouse *psmouse)
1454 return __synaptics_init(psmouse, false);
1457 bool synaptics_supported(void)
1462 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1464 void __init synaptics_module_init(void)
1468 int synaptics_init(struct psmouse *psmouse)
1473 bool synaptics_supported(void)
1478 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */