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", "LEN0039",
142 "LEN2002", "LEN2004", NULL},
143 1024, 5112, 2024, 4832
146 (const char * const []){"LEN2001", NULL},
147 1024, 5022, 2508, 4832
150 (const char * const []){"LEN2006", NULL},
151 1264, 5675, 1171, 4688
156 /* This list has been kindly provided by Synaptics. */
157 static const char * const topbuttonpad_pnp_ids[] = {
167 "LEN0033", /* Helix */
168 "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */
169 "LEN0035", /* X240 */
170 "LEN0036", /* T440 */
173 "LEN0039", /* T440s */
175 "LEN0042", /* Yoga */
182 "LEN2001", /* Edge E431 */
183 "LEN2002", /* Edge E531 */
185 "LEN2004", /* L440 */
196 /*****************************************************************************
197 * Synaptics communications functions
198 ****************************************************************************/
201 * Synaptics touchpads report the y coordinate from bottom to top, which is
202 * opposite from what userspace expects.
203 * This function is used to invert y before reporting.
205 static int synaptics_invert_y(int y)
207 return YMAX_NOMINAL + YMIN_NOMINAL - y;
211 * Send a command to the synpatics touchpad by special commands
213 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
215 if (psmouse_sliced_command(psmouse, c))
217 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
223 * Read the model-id bytes from the touchpad
224 * see also SYN_MODEL_* macros
226 static int synaptics_model_id(struct psmouse *psmouse)
228 struct synaptics_data *priv = psmouse->private;
231 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
233 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
238 * Read the board id from the touchpad
239 * The board id is encoded in the "QUERY MODES" response
241 static int synaptics_board_id(struct psmouse *psmouse)
243 struct synaptics_data *priv = psmouse->private;
244 unsigned char bid[3];
246 if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid))
248 priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1];
253 * Read the firmware id from the touchpad
255 static int synaptics_firmware_id(struct psmouse *psmouse)
257 struct synaptics_data *priv = psmouse->private;
258 unsigned char fwid[3];
260 if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid))
262 priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2];
267 * Read the capability-bits from the touchpad
268 * see also the SYN_CAP_* macros
270 static int synaptics_capability(struct psmouse *psmouse)
272 struct synaptics_data *priv = psmouse->private;
273 unsigned char cap[3];
275 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
277 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
278 priv->ext_cap = priv->ext_cap_0c = 0;
281 * Older firmwares had submodel ID fixed to 0x47
283 if (SYN_ID_FULL(priv->identity) < 0x705 &&
284 SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
289 * Unless capExtended is set the rest of the flags should be ignored
291 if (!SYN_CAP_EXTENDED(priv->capabilities))
292 priv->capabilities = 0;
294 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
295 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
296 psmouse_warn(psmouse,
297 "device claims to have extended capabilities, but I'm not able to read them.\n");
299 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
302 * if nExtBtn is greater than 8 it should be considered
303 * invalid and treated as 0
305 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
306 priv->ext_cap &= 0xff0fff;
310 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
311 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
312 psmouse_warn(psmouse,
313 "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
315 priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
324 * See also the SYN_ID_* macros
326 static int synaptics_identify(struct psmouse *psmouse)
328 struct synaptics_data *priv = psmouse->private;
331 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
333 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
334 if (SYN_ID_IS_SYNAPTICS(priv->identity))
340 * Read touchpad resolution and maximum reported coordinates
341 * Resolution is left zero if touchpad does not support the query
344 static int synaptics_resolution(struct psmouse *psmouse)
346 struct synaptics_data *priv = psmouse->private;
347 unsigned char resp[3];
350 if (SYN_ID_MAJOR(priv->identity) < 4)
353 if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
354 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
355 priv->x_res = resp[0]; /* x resolution in units/mm */
356 priv->y_res = resp[2]; /* y resolution in units/mm */
360 for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) {
361 if (psmouse_matches_pnp_id(psmouse,
362 min_max_pnpid_table[i].pnp_ids)) {
363 priv->x_min = min_max_pnpid_table[i].x_min;
364 priv->x_max = min_max_pnpid_table[i].x_max;
365 priv->y_min = min_max_pnpid_table[i].y_min;
366 priv->y_max = min_max_pnpid_table[i].y_max;
371 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
372 SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
373 if (synaptics_send_cmd(psmouse, 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 priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
378 priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
382 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
383 SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
384 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
385 psmouse_warn(psmouse,
386 "device claims to have min coordinates query, but I'm not able to read it.\n");
388 priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
389 priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
396 static int synaptics_query_hardware(struct psmouse *psmouse)
398 if (synaptics_identify(psmouse))
400 if (synaptics_model_id(psmouse))
402 if (synaptics_firmware_id(psmouse))
404 if (synaptics_board_id(psmouse))
406 if (synaptics_capability(psmouse))
408 if (synaptics_resolution(psmouse))
414 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
416 static unsigned char param = 0xc8;
417 struct synaptics_data *priv = psmouse->private;
419 if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
420 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
423 if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
426 if (ps2_command(&psmouse->ps2dev, ¶m, PSMOUSE_CMD_SETRATE))
429 /* Advanced gesture mode also sends multi finger data */
430 priv->capabilities |= BIT(1);
435 static int synaptics_set_mode(struct psmouse *psmouse)
437 struct synaptics_data *priv = psmouse->private;
440 if (priv->absolute_mode)
441 priv->mode |= SYN_BIT_ABSOLUTE_MODE;
442 if (priv->disable_gesture)
443 priv->mode |= SYN_BIT_DISABLE_GESTURE;
444 if (psmouse->rate >= 80)
445 priv->mode |= SYN_BIT_HIGH_RATE;
446 if (SYN_CAP_EXTENDED(priv->capabilities))
447 priv->mode |= SYN_BIT_W_MODE;
449 if (synaptics_mode_cmd(psmouse, priv->mode))
452 if (priv->absolute_mode &&
453 synaptics_set_advanced_gesture_mode(psmouse)) {
454 psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
461 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
463 struct synaptics_data *priv = psmouse->private;
466 priv->mode |= SYN_BIT_HIGH_RATE;
469 priv->mode &= ~SYN_BIT_HIGH_RATE;
473 synaptics_mode_cmd(psmouse, priv->mode);
476 /*****************************************************************************
477 * Synaptics pass-through PS/2 port support
478 ****************************************************************************/
479 static int synaptics_pt_write(struct serio *serio, unsigned char c)
481 struct psmouse *parent = serio_get_drvdata(serio->parent);
482 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
484 if (psmouse_sliced_command(parent, c))
486 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
491 static int synaptics_pt_start(struct serio *serio)
493 struct psmouse *parent = serio_get_drvdata(serio->parent);
494 struct synaptics_data *priv = parent->private;
496 serio_pause_rx(parent->ps2dev.serio);
497 priv->pt_port = serio;
498 serio_continue_rx(parent->ps2dev.serio);
503 static void synaptics_pt_stop(struct serio *serio)
505 struct psmouse *parent = serio_get_drvdata(serio->parent);
506 struct synaptics_data *priv = parent->private;
508 serio_pause_rx(parent->ps2dev.serio);
509 priv->pt_port = NULL;
510 serio_continue_rx(parent->ps2dev.serio);
513 static int synaptics_is_pt_packet(unsigned char *buf)
515 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
518 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
520 struct psmouse *child = serio_get_drvdata(ptport);
522 if (child && child->state == PSMOUSE_ACTIVATED) {
523 serio_interrupt(ptport, packet[1], 0);
524 serio_interrupt(ptport, packet[4], 0);
525 serio_interrupt(ptport, packet[5], 0);
526 if (child->pktsize == 4)
527 serio_interrupt(ptport, packet[2], 0);
529 serio_interrupt(ptport, packet[1], 0);
532 static void synaptics_pt_activate(struct psmouse *psmouse)
534 struct synaptics_data *priv = psmouse->private;
535 struct psmouse *child = serio_get_drvdata(priv->pt_port);
537 /* adjust the touchpad to child's choice of protocol */
539 if (child->pktsize == 4)
540 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
542 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
544 if (synaptics_mode_cmd(psmouse, priv->mode))
545 psmouse_warn(psmouse,
546 "failed to switch guest protocol\n");
550 static void synaptics_pt_create(struct psmouse *psmouse)
554 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
557 "not enough memory for pass-through port\n");
561 serio->id.type = SERIO_PS_PSTHRU;
562 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
563 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
564 serio->write = synaptics_pt_write;
565 serio->start = synaptics_pt_start;
566 serio->stop = synaptics_pt_stop;
567 serio->parent = psmouse->ps2dev.serio;
569 psmouse->pt_activate = synaptics_pt_activate;
571 psmouse_info(psmouse, "serio: %s port at %s\n",
572 serio->name, psmouse->phys);
573 serio_register_port(serio);
576 /*****************************************************************************
577 * Functions to interpret the absolute mode packets
578 ****************************************************************************/
580 static void synaptics_parse_agm(const unsigned char buf[],
581 struct synaptics_data *priv,
582 struct synaptics_hw_state *hw)
584 struct synaptics_hw_state *agm = &priv->agm;
587 agm_packet_type = (buf[5] & 0x30) >> 4;
588 switch (agm_packet_type) {
590 /* Gesture packet: (x, y, z) half resolution */
592 agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
593 agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
594 agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
598 /* AGM-CONTACT packet: we are only interested in the count */
599 priv->agm_count = buf[1];
607 static bool is_forcepad;
609 static int synaptics_parse_hw_state(const unsigned char buf[],
610 struct synaptics_data *priv,
611 struct synaptics_hw_state *hw)
613 memset(hw, 0, sizeof(struct synaptics_hw_state));
615 if (SYN_MODEL_NEWABS(priv->model_id)) {
616 hw->w = (((buf[0] & 0x30) >> 2) |
617 ((buf[0] & 0x04) >> 1) |
618 ((buf[3] & 0x04) >> 2));
620 if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
621 SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
623 synaptics_parse_agm(buf, priv, hw);
627 hw->x = (((buf[3] & 0x10) << 8) |
628 ((buf[1] & 0x0f) << 8) |
630 hw->y = (((buf[3] & 0x20) << 7) |
631 ((buf[1] & 0xf0) << 4) |
635 hw->left = (buf[0] & 0x01) ? 1 : 0;
636 hw->right = (buf[0] & 0x02) ? 1 : 0;
640 * ForcePads, like Clickpads, use middle button
641 * bits to report primary button clicks.
642 * Unfortunately they report primary button not
643 * only when user presses on the pad above certain
644 * threshold, but also when there are more than one
645 * finger on the touchpad, which interferes with
646 * out multi-finger gestures.
650 priv->press = priv->report_press = false;
651 } else if (hw->w >= 4 && ((buf[0] ^ buf[3]) & 0x01)) {
653 * Single-finger touch with pressure above
654 * the threshold. If pressure stays long
655 * enough, we'll start reporting primary
656 * button. We rely on the device continuing
657 * sending data even if finger does not
661 priv->press_start = jiffies;
663 } else if (time_after(jiffies,
665 msecs_to_jiffies(50))) {
666 priv->report_press = true;
672 hw->left = priv->report_press;
674 } else if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
676 * Clickpad's button is transmitted as middle button,
677 * however, since it is primary button, we will report
680 hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
682 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
683 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
685 hw->scroll = (signed char)(buf[1]);
688 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
689 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
690 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
693 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
694 ((buf[0] ^ buf[3]) & 0x02)) {
695 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
698 * if nExtBtn is greater than 8 it should be
699 * considered invalid and treated as 0
703 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
704 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
706 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
707 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
709 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
710 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
712 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
713 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
717 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
718 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
720 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
721 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
723 hw->left = (buf[0] & 0x01) ? 1 : 0;
724 hw->right = (buf[0] & 0x02) ? 1 : 0;
728 * Convert wrap-around values to negative. (X|Y)_MAX_POSITIVE
729 * is used by some firmware to indicate a finger at the edge of
730 * the touchpad whose precise position cannot be determined, so
731 * convert these values to the maximum axis value.
733 if (hw->x > X_MAX_POSITIVE)
734 hw->x -= 1 << ABS_POS_BITS;
735 else if (hw->x == X_MAX_POSITIVE)
738 if (hw->y > Y_MAX_POSITIVE)
739 hw->y -= 1 << ABS_POS_BITS;
740 else if (hw->y == Y_MAX_POSITIVE)
746 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
747 bool active, int x, int y)
749 input_mt_slot(dev, slot);
750 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
752 input_report_abs(dev, ABS_MT_POSITION_X, x);
753 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
757 static void synaptics_report_semi_mt_data(struct input_dev *dev,
758 const struct synaptics_hw_state *a,
759 const struct synaptics_hw_state *b,
762 if (num_fingers >= 2) {
763 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
765 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
767 } else if (num_fingers == 1) {
768 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
769 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
771 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
772 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
776 static void synaptics_report_buttons(struct psmouse *psmouse,
777 const struct synaptics_hw_state *hw)
779 struct input_dev *dev = psmouse->dev;
780 struct synaptics_data *priv = psmouse->private;
783 input_report_key(dev, BTN_LEFT, hw->left);
784 input_report_key(dev, BTN_RIGHT, hw->right);
786 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
787 input_report_key(dev, BTN_MIDDLE, hw->middle);
789 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
790 input_report_key(dev, BTN_FORWARD, hw->up);
791 input_report_key(dev, BTN_BACK, hw->down);
794 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
795 input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
798 static void synaptics_report_mt_data(struct psmouse *psmouse,
799 const struct synaptics_hw_state *sgm,
802 struct input_dev *dev = psmouse->dev;
803 struct synaptics_data *priv = psmouse->private;
804 const struct synaptics_hw_state *hw[2] = { sgm, &priv->agm };
805 struct input_mt_pos pos[2];
806 int slot[2], nsemi, i;
808 nsemi = clamp_val(num_fingers, 0, 2);
810 for (i = 0; i < nsemi; i++) {
812 pos[i].y = synaptics_invert_y(hw[i]->y);
815 input_mt_assign_slots(dev, slot, pos, nsemi, DMAX * priv->x_res);
817 for (i = 0; i < nsemi; i++) {
818 input_mt_slot(dev, slot[i]);
819 input_mt_report_slot_state(dev, MT_TOOL_FINGER, true);
820 input_report_abs(dev, ABS_MT_POSITION_X, pos[i].x);
821 input_report_abs(dev, ABS_MT_POSITION_Y, pos[i].y);
822 input_report_abs(dev, ABS_MT_PRESSURE, hw[i]->z);
825 input_mt_drop_unused(dev);
827 /* Don't use active slot count to generate BTN_TOOL events. */
828 input_mt_report_pointer_emulation(dev, false);
830 /* Send the number of fingers reported by touchpad itself. */
831 input_mt_report_finger_count(dev, num_fingers);
833 synaptics_report_buttons(psmouse, sgm);
838 static void synaptics_image_sensor_process(struct psmouse *psmouse,
839 struct synaptics_hw_state *sgm)
841 struct synaptics_data *priv = psmouse->private;
845 * Update mt_state using the new finger count and current mt_state.
849 else if (sgm->w >= 4)
851 else if (sgm->w == 0)
853 else if (sgm->w == 1)
854 num_fingers = priv->agm_count ? priv->agm_count : 3;
858 /* Send resulting input events to user space */
859 synaptics_report_mt_data(psmouse, sgm, num_fingers);
863 * called for each full received packet from the touchpad
865 static void synaptics_process_packet(struct psmouse *psmouse)
867 struct input_dev *dev = psmouse->dev;
868 struct synaptics_data *priv = psmouse->private;
869 struct synaptics_hw_state hw;
873 if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
876 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
877 synaptics_image_sensor_process(psmouse, &hw);
882 priv->scroll += hw.scroll;
884 while (priv->scroll >= 4) {
885 input_report_key(dev, BTN_BACK, !hw.down);
887 input_report_key(dev, BTN_BACK, hw.down);
891 while (priv->scroll <= -4) {
892 input_report_key(dev, BTN_FORWARD, !hw.up);
894 input_report_key(dev, BTN_FORWARD, hw.up);
901 if (hw.z > 0 && hw.x > 1) {
904 if (SYN_CAP_EXTENDED(priv->capabilities)) {
907 if (SYN_CAP_MULTIFINGER(priv->capabilities))
908 num_fingers = hw.w + 2;
911 if (SYN_MODEL_PEN(priv->model_id))
912 ; /* Nothing, treat a pen as a single finger */
915 if (SYN_CAP_PALMDETECT(priv->capabilities))
925 if (cr48_profile_sensor) {
926 synaptics_report_mt_data(psmouse, &hw, num_fingers);
930 if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
931 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
935 * BTN_TOUCH has to be first as mousedev relies on it when doing
936 * absolute -> relative conversion
938 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
939 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
941 if (num_fingers > 0) {
942 input_report_abs(dev, ABS_X, hw.x);
943 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
945 input_report_abs(dev, ABS_PRESSURE, hw.z);
947 if (SYN_CAP_PALMDETECT(priv->capabilities))
948 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
950 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
951 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
952 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
953 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
956 synaptics_report_buttons(psmouse, &hw);
961 static int synaptics_validate_byte(struct psmouse *psmouse,
962 int idx, unsigned char pkt_type)
964 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
965 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
966 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
967 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
968 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
969 const char *packet = psmouse->packet;
971 if (idx < 0 || idx > 4)
977 case SYN_NEWABS_RELAXED:
978 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
980 case SYN_NEWABS_STRICT:
981 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
984 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
987 psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
992 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
996 for (i = 0; i < 5; i++)
997 if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
998 psmouse_info(psmouse, "using relaxed packet validation\n");
999 return SYN_NEWABS_RELAXED;
1002 return SYN_NEWABS_STRICT;
1005 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1007 struct synaptics_data *priv = psmouse->private;
1009 if (psmouse->pktcnt >= 6) { /* Full packet received */
1010 if (unlikely(priv->pkt_type == SYN_NEWABS))
1011 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1013 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1014 synaptics_is_pt_packet(psmouse->packet)) {
1016 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1018 synaptics_process_packet(psmouse);
1020 return PSMOUSE_FULL_PACKET;
1023 return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1024 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1027 /*****************************************************************************
1028 * Driver initialization/cleanup functions
1029 ****************************************************************************/
1030 static void set_abs_position_params(struct input_dev *dev,
1031 struct synaptics_data *priv, int x_code,
1034 int x_min = priv->x_min ?: XMIN_NOMINAL;
1035 int x_max = priv->x_max ?: XMAX_NOMINAL;
1036 int y_min = priv->y_min ?: YMIN_NOMINAL;
1037 int y_max = priv->y_max ?: YMAX_NOMINAL;
1038 int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1039 SYN_REDUCED_FILTER_FUZZ : 0;
1041 input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1042 input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1043 input_abs_set_res(dev, x_code, priv->x_res);
1044 input_abs_set_res(dev, y_code, priv->y_res);
1047 static void set_input_params(struct psmouse *psmouse,
1048 struct synaptics_data *priv)
1050 struct input_dev *dev = psmouse->dev;
1053 /* Things that apply to both modes */
1054 __set_bit(INPUT_PROP_POINTER, dev->propbit);
1055 __set_bit(EV_KEY, dev->evbit);
1056 __set_bit(BTN_LEFT, dev->keybit);
1057 __set_bit(BTN_RIGHT, dev->keybit);
1059 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1060 __set_bit(BTN_MIDDLE, dev->keybit);
1062 if (!priv->absolute_mode) {
1064 __set_bit(EV_REL, dev->evbit);
1065 __set_bit(REL_X, dev->relbit);
1066 __set_bit(REL_Y, dev->relbit);
1071 __set_bit(EV_ABS, dev->evbit);
1072 set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1073 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1075 if (cr48_profile_sensor)
1076 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1078 if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1079 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1081 /* Image sensors can report per-contact pressure */
1082 input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1083 input_mt_init_slots(dev, 2, INPUT_MT_POINTER | INPUT_MT_TRACK);
1085 /* Image sensors can signal 4 and 5 finger clicks */
1086 __set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1087 __set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1088 } else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1089 set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1092 * Profile sensor in CR-48 tracks contacts reasonably well,
1093 * other non-image sensors with AGM use semi-mt.
1095 input_mt_init_slots(dev, 2,
1097 (cr48_profile_sensor ?
1098 INPUT_MT_TRACK : INPUT_MT_SEMI_MT));
1101 if (SYN_CAP_PALMDETECT(priv->capabilities))
1102 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1104 __set_bit(BTN_TOUCH, dev->keybit);
1105 __set_bit(BTN_TOOL_FINGER, dev->keybit);
1107 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1108 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1109 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1112 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1113 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1114 __set_bit(BTN_FORWARD, dev->keybit);
1115 __set_bit(BTN_BACK, dev->keybit);
1118 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1119 __set_bit(BTN_0 + i, dev->keybit);
1121 __clear_bit(EV_REL, dev->evbit);
1122 __clear_bit(REL_X, dev->relbit);
1123 __clear_bit(REL_Y, dev->relbit);
1125 if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1126 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1127 if (psmouse_matches_pnp_id(psmouse, topbuttonpad_pnp_ids))
1128 __set_bit(INPUT_PROP_TOPBUTTONPAD, dev->propbit);
1129 /* Clickpads report only left button */
1130 __clear_bit(BTN_RIGHT, dev->keybit);
1131 __clear_bit(BTN_MIDDLE, dev->keybit);
1135 static ssize_t synaptics_show_disable_gesture(struct psmouse *psmouse,
1136 void *data, char *buf)
1138 struct synaptics_data *priv = psmouse->private;
1140 return sprintf(buf, "%c\n", priv->disable_gesture ? '1' : '0');
1143 static ssize_t synaptics_set_disable_gesture(struct psmouse *psmouse,
1144 void *data, const char *buf,
1147 struct synaptics_data *priv = psmouse->private;
1151 err = kstrtouint(buf, 10, &value);
1158 if (value == priv->disable_gesture)
1161 priv->disable_gesture = value;
1163 priv->mode |= SYN_BIT_DISABLE_GESTURE;
1165 priv->mode &= ~SYN_BIT_DISABLE_GESTURE;
1167 if (synaptics_mode_cmd(psmouse, priv->mode))
1173 PSMOUSE_DEFINE_ATTR(disable_gesture, S_IWUSR | S_IRUGO, NULL,
1174 synaptics_show_disable_gesture,
1175 synaptics_set_disable_gesture);
1177 static void synaptics_disconnect(struct psmouse *psmouse)
1179 struct synaptics_data *priv = psmouse->private;
1181 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity))
1182 device_remove_file(&psmouse->ps2dev.serio->dev,
1183 &psmouse_attr_disable_gesture.dattr);
1185 synaptics_reset(psmouse);
1187 psmouse->private = NULL;
1190 static int synaptics_reconnect(struct psmouse *psmouse)
1192 struct synaptics_data *priv = psmouse->private;
1193 struct synaptics_data old_priv = *priv;
1194 unsigned char param[2];
1199 psmouse_reset(psmouse);
1202 * On some boxes, right after resuming, the touchpad
1203 * needs some time to finish initializing (I assume
1204 * it needs time to calibrate) and start responding
1205 * to Synaptics-specific queries, so let's wait a
1210 ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETID);
1211 error = synaptics_detect(psmouse, 0);
1212 } while (error && ++retry < 3);
1218 psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1220 if (synaptics_query_hardware(psmouse)) {
1221 psmouse_err(psmouse, "Unable to query device.\n");
1225 if (synaptics_set_mode(psmouse)) {
1226 psmouse_err(psmouse, "Unable to initialize device.\n");
1230 if (old_priv.identity != priv->identity ||
1231 old_priv.model_id != priv->model_id ||
1232 old_priv.capabilities != priv->capabilities ||
1233 old_priv.ext_cap != priv->ext_cap) {
1234 psmouse_err(psmouse,
1235 "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1236 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);
1246 static bool impaired_toshiba_kbc;
1248 static const struct dmi_system_id toshiba_dmi_table[] __initconst = {
1249 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1251 /* Toshiba Satellite */
1253 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1254 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1258 /* Toshiba Dynabook */
1260 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1261 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1265 /* Toshiba Portege M300 */
1267 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1268 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1273 /* Toshiba Portege M300 */
1275 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1276 DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1277 DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1285 static bool broken_olpc_ec;
1287 static const struct dmi_system_id olpc_dmi_table[] __initconst = {
1288 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1290 /* OLPC XO-1 or XO-1.5 */
1292 DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1293 DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1300 static const struct dmi_system_id __initconst cr48_dmi_table[] = {
1301 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1303 /* Cr-48 Chromebook (Codename Mario) */
1305 DMI_MATCH(DMI_SYS_VENDOR, "IEC"),
1306 DMI_MATCH(DMI_PRODUCT_NAME, "Mario"),
1313 static const struct dmi_system_id forcepad_dmi_table[] __initconst = {
1314 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1317 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1318 DMI_MATCH(DMI_PRODUCT_NAME, "HP EliteBook Folio 1040 G1"),
1325 void __init synaptics_module_init(void)
1327 impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1328 broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1329 cr48_profile_sensor = dmi_check_system(cr48_dmi_table);
1332 * Unfortunately ForcePad capability is not exported over PS/2,
1333 * so we have to resort to checking DMI.
1335 is_forcepad = dmi_check_system(forcepad_dmi_table);
1338 static int __synaptics_init(struct psmouse *psmouse, bool absolute_mode)
1340 struct synaptics_data *priv;
1344 * The OLPC XO has issues with Synaptics' absolute mode; the constant
1345 * packet spew overloads the EC such that key presses on the keyboard
1346 * are missed. Given that, don't even attempt to use Absolute mode.
1347 * Relative mode seems to work just fine.
1349 if (absolute_mode && broken_olpc_ec) {
1350 psmouse_info(psmouse,
1351 "OLPC XO detected, not enabling Synaptics protocol.\n");
1355 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1359 psmouse_reset(psmouse);
1361 if (synaptics_query_hardware(psmouse)) {
1362 psmouse_err(psmouse, "Unable to query device.\n");
1366 priv->absolute_mode = absolute_mode;
1367 if (SYN_ID_DISGEST_SUPPORTED(priv->identity))
1368 priv->disable_gesture = true;
1370 if (synaptics_set_mode(psmouse)) {
1371 psmouse_err(psmouse, "Unable to initialize device.\n");
1375 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1377 psmouse_info(psmouse,
1378 "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx, board id: %lu, fw id: %lu\n",
1379 SYN_ID_MODEL(priv->identity),
1380 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1382 priv->capabilities, priv->ext_cap, priv->ext_cap_0c,
1383 priv->board_id, priv->firmware_id);
1385 set_input_params(psmouse, priv);
1388 * Encode touchpad model so that it can be used to set
1389 * input device->id.version and be visible to userspace.
1390 * Because version is __u16 we have to drop something.
1391 * Hardware info bits seem to be good candidates as they
1392 * are documented to be for Synaptics corp. internal use.
1394 psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1395 (priv->model_id & 0x000000ff);
1397 if (absolute_mode) {
1398 psmouse->protocol_handler = synaptics_process_byte;
1399 psmouse->pktsize = 6;
1401 /* Relative mode follows standard PS/2 mouse protocol */
1402 psmouse->protocol_handler = psmouse_process_byte;
1403 psmouse->pktsize = 3;
1406 psmouse->set_rate = synaptics_set_rate;
1407 psmouse->disconnect = synaptics_disconnect;
1408 psmouse->reconnect = synaptics_reconnect;
1409 psmouse->cleanup = synaptics_reset;
1410 /* Synaptics can usually stay in sync without extra help */
1411 psmouse->resync_time = 0;
1413 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1414 synaptics_pt_create(psmouse);
1417 * Toshiba's KBC seems to have trouble handling data from
1418 * Synaptics at full rate. Switch to a lower rate (roughly
1419 * the same rate as a standard PS/2 mouse).
1421 if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1422 psmouse_info(psmouse,
1423 "Toshiba %s detected, limiting rate to 40pps.\n",
1424 dmi_get_system_info(DMI_PRODUCT_NAME));
1428 if (!priv->absolute_mode && SYN_ID_DISGEST_SUPPORTED(priv->identity)) {
1429 err = device_create_file(&psmouse->ps2dev.serio->dev,
1430 &psmouse_attr_disable_gesture.dattr);
1432 psmouse_err(psmouse,
1433 "Failed to create disable_gesture attribute (%d)",
1446 int synaptics_init(struct psmouse *psmouse)
1448 return __synaptics_init(psmouse, true);
1451 int synaptics_init_relative(struct psmouse *psmouse)
1453 return __synaptics_init(psmouse, false);
1456 bool synaptics_supported(void)
1461 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1463 void __init synaptics_module_init(void)
1467 int synaptics_init(struct psmouse *psmouse)
1472 bool synaptics_supported(void)
1477 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */