cregit-Linux how code gets into the kernel

Release 4.11 drivers/input/mouse/synaptics.c

/*
 * Synaptics TouchPad PS/2 mouse driver
 *
 *   2003 Dmitry Torokhov <dtor@mail.ru>
 *     Added support for pass-through port. Special thanks to Peter Berg Larsen
 *     for explaining various Synaptics quirks.
 *
 *   2003 Peter Osterlund <petero2@telia.com>
 *     Ported to 2.5 input device infrastructure.
 *
 *   Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
 *     start merging tpconfig and gpm code to a xfree-input module
 *     adding some changes and extensions (ex. 3rd and 4th button)
 *
 *   Copyright (c) 1997 C. Scott Ananian <cananian@alumni.priceton.edu>
 *   Copyright (c) 1998-2000 Bruce Kalk <kall@compass.com>
 *     code for the special synaptics commands (from the tpconfig-source)
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 *
 * Trademarks are the property of their respective owners.
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/dmi.h>
#include <linux/input/mt.h>
#include <linux/serio.h>
#include <linux/libps2.h>
#include <linux/slab.h>
#include "psmouse.h"
#include "synaptics.h"

/*
 * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
 * section 2.3.2, which says that they should be valid regardless of the
 * actual size of the sensor.
 * Note that newer firmware allows querying device for maximum useable
 * coordinates.
 */

#define XMIN 0

#define XMAX 6143

#define YMIN 0

#define YMAX 6143

#define XMIN_NOMINAL 1472

#define XMAX_NOMINAL 5472

#define YMIN_NOMINAL 1408

#define YMAX_NOMINAL 4448

/* Size in bits of absolute position values reported by the hardware */

#define ABS_POS_BITS 13

/*
 * These values should represent the absolute maximum value that will
 * be reported for a positive position value. Some Synaptics firmware
 * uses this value to indicate a finger near the edge of the touchpad
 * whose precise position cannot be determined.
 *
 * At least one touchpad is known to report positions in excess of this
 * value which are actually negative values truncated to the 13-bit
 * reporting range. These values have never been observed to be lower
 * than 8184 (i.e. -8), so we treat all values greater than 8176 as
 * negative and any other value as positive.
 */

#define X_MAX_POSITIVE 8176

#define Y_MAX_POSITIVE 8176

/* maximum ABS_MT_POSITION displacement (in mm) */

#define DMAX 10

/*****************************************************************************
 *      Stuff we need even when we do not want native Synaptics support
 ****************************************************************************/

/*
 * Set the synaptics touchpad mode byte by special commands
 */

static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode) { unsigned char param[1]; if (psmouse_sliced_command(psmouse, mode)) return -1; param[0] = SYN_PS_SET_MODE2; if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE)) return -1; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund4165.08%125.00%
Andres Salomon1726.98%125.00%
Dmitry Torokhov57.94%250.00%
Total63100.00%4100.00%


int synaptics_detect(struct psmouse *psmouse, bool set_properties) { struct ps2dev *ps2dev = &psmouse->ps2dev; unsigned char param[4]; param[0] = 0; ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES); ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES); ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES); ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES); ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO); if (param[1] != 0x47) return -ENODEV; if (set_properties) { psmouse->vendor = "Synaptics"; psmouse->name = "TouchPad"; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Andres Salomon10086.21%133.33%
Peter Osterlund1512.93%133.33%
Dmitry Torokhov10.86%133.33%
Total116100.00%3100.00%


void synaptics_reset(struct psmouse *psmouse) { /* reset touchpad back to relative mode, gestures enabled */ synaptics_mode_cmd(psmouse, 0); }

Contributors

PersonTokensPropCommitsCommitProp
Andres Salomon18100.00%1100.00%
Total18100.00%1100.00%

#ifdef CONFIG_MOUSE_PS2_SYNAPTICS static bool cr48_profile_sensor; #define ANY_BOARD_ID 0 struct min_max_quirk { const char * const *pnp_ids; struct { unsigned long int min, max; } board_id; int x_min, x_max, y_min, y_max; }; static const struct min_max_quirk min_max_pnpid_table[] = { { (const char * const []){"LEN0033", NULL}, {ANY_BOARD_ID, ANY_BOARD_ID}, 1024, 5052, 2258, 4832 }, { (const char * const []){"LEN0042", NULL}, {ANY_BOARD_ID, ANY_BOARD_ID}, 1232, 5710, 1156, 4696 }, { (const char * const []){"LEN0034", "LEN0036", "LEN0037", "LEN0039", "LEN2002", "LEN2004", NULL}, {ANY_BOARD_ID, 2961}, 1024, 5112, 2024, 4832 }, { (const char * const []){"LEN2000", NULL}, {ANY_BOARD_ID, ANY_BOARD_ID}, 1024, 5113, 2021, 4832 }, { (const char * const []){"LEN2001", NULL}, {ANY_BOARD_ID, ANY_BOARD_ID}, 1024, 5022, 2508, 4832 }, { (const char * const []){"LEN2006", NULL}, {2691, 2691}, 1024, 5045, 2457, 4832 }, { (const char * const []){"LEN2006", NULL}, {ANY_BOARD_ID, ANY_BOARD_ID}, 1264, 5675, 1171, 4688 }, { } }; /* This list has been kindly provided by Synaptics. */ static const char * const topbuttonpad_pnp_ids[] = { "LEN0017", "LEN0018", "LEN0019", "LEN0023", "LEN002A", "LEN002B", "LEN002C", "LEN002D", "LEN002E", "LEN0033", /* Helix */ "LEN0034", /* T431s, L440, L540, T540, W540, X1 Carbon 2nd */ "LEN0035", /* X240 */ "LEN0036", /* T440 */ "LEN0037", /* X1 Carbon 2nd */ "LEN0038", "LEN0039", /* T440s */ "LEN0041", "LEN0042", /* Yoga */ "LEN0045", "LEN0047", "LEN0049", "LEN2000", /* S540 */ "LEN2001", /* Edge E431 */ "LEN2002", /* Edge E531 */ "LEN2003", "LEN2004", /* L440 */ "LEN2005", "LEN2006", /* Edge E440/E540 */ "LEN2007", "LEN2008", "LEN2009", "LEN200A", "LEN200B", NULL }; /* This list has been kindly provided by Synaptics. */ static const char * const forcepad_pnp_ids[] = { "SYN300D", "SYN3014", NULL }; /***************************************************************************** * Synaptics communications functions ****************************************************************************/ /* * Synaptics touchpads report the y coordinate from bottom to top, which is * opposite from what userspace expects. * This function is used to invert y before reporting. */
static int synaptics_invert_y(int y) { return YMAX_NOMINAL + YMIN_NOMINAL - y; }

Contributors

PersonTokensPropCommitsCommitProp
JJ Ding16100.00%1100.00%
Total16100.00%1100.00%

/* * Send a command to the synpatics touchpad by special commands */
static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param) { if (psmouse_sliced_command(psmouse, c)) return -1; if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO)) return -1; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund2851.85%125.00%
Andres Salomon2138.89%125.00%
Dmitry Torokhov59.26%250.00%
Total54100.00%4100.00%

/* * Read the model-id bytes from the touchpad * see also SYN_MODEL_* macros */
static int synaptics_model_id(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char mi[3]; if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi)) return -1; priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2]; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund6184.72%150.00%
Dmitry Torokhov1115.28%150.00%
Total72100.00%2100.00%


static int synaptics_more_extended_queries(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char buf[3]; if (synaptics_send_cmd(psmouse, SYN_QUE_MEXT_CAPAB_10, buf)) return -1; priv->ext_cap_10 = (buf[0]<<16) | (buf[1]<<8) | buf[2]; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Benjamin Tissoires72100.00%1100.00%
Total72100.00%1100.00%

/* * Read the board id and the "More Extended Queries" from the touchpad * The board id is encoded in the "QUERY MODES" response */
static int synaptics_query_modes(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char bid[3]; /* firmwares prior 7.5 have no board_id encoded */ if (SYN_ID_FULL(priv->identity) < 0x705) return 0; if (synaptics_send_cmd(psmouse, SYN_QUE_MODES, bid)) return -1; priv->board_id = ((bid[0] & 0xfc) << 6) | bid[1]; if (SYN_MEXT_CAP_BIT(bid[0])) return synaptics_more_extended_queries(psmouse); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Daniel Kurtz6667.35%133.33%
Benjamin Tissoires3232.65%266.67%
Total98100.00%3100.00%

/* * Read the firmware id from the touchpad */
static int synaptics_firmware_id(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char fwid[3]; if (synaptics_send_cmd(psmouse, SYN_QUE_FIRMWARE_ID, fwid)) return -1; priv->firmware_id = (fwid[0] << 16) | (fwid[1] << 8) | fwid[2]; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Daniel Kurtz72100.00%1100.00%
Total72100.00%1100.00%

/* * Read the capability-bits from the touchpad * see also the SYN_CAP_* macros */
static int synaptics_capability(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char cap[3]; if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap)) return -1; priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2]; priv->ext_cap = priv->ext_cap_0c = 0; /* * Older firmwares had submodel ID fixed to 0x47 */ if (SYN_ID_FULL(priv->identity) < 0x705 && SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) { return -1; } /* * Unless capExtended is set the rest of the flags should be ignored */ if (!SYN_CAP_EXTENDED(priv->capabilities)) priv->capabilities = 0; if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) { if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) { psmouse_warn(psmouse, "device claims to have extended capabilities, but I'm not able to read them.\n"); } else { priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2]; /* * if nExtBtn is greater than 8 it should be considered * invalid and treated as 0 */ if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8) priv->ext_cap &= 0xff0fff; } } if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) { if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) { psmouse_warn(psmouse, "device claims to have extended capability 0x0c, but I'm not able to read it.\n"); } else { priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2]; } } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund12345.56%228.57%
Dmitry Torokhov8431.11%457.14%
Takashi Iwai6323.33%114.29%
Total270100.00%7100.00%

/* * Identify Touchpad * See also the SYN_ID_* macros */
static int synaptics_identify(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char id[3]; if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id)) return -1; priv->identity = (id[0]<<16) | (id[1]<<8) | id[2]; if (SYN_ID_IS_SYNAPTICS(priv->identity)) return 0; return -1; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund7082.35%150.00%
Dmitry Torokhov1517.65%150.00%
Total85100.00%2100.00%

/* * Read touchpad resolution and maximum reported coordinates * Resolution is left zero if touchpad does not support the query */
static int synaptics_resolution(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; unsigned char resp[3]; if (SYN_ID_MAJOR(priv->identity) < 4) return 0; if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) { if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) { priv->x_res = resp[0]; /* x resolution in units/mm */ priv->y_res = resp[2]; /* y resolution in units/mm */ } } if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 && SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) { if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) { psmouse_warn(psmouse, "device claims to have max coordinates query, but I'm not able to read it.\n"); } else { priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1); priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3); psmouse_info(psmouse, "queried max coordinates: x [..%d], y [..%d]\n", priv->x_max, priv->y_max); } } if (SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c) && (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 || /* * Firmware v8.1 does not report proper number of extended * capabilities, but has been proven to report correct min * coordinates. */ SYN_ID_FULL(priv->identity) == 0x801)) { if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) { psmouse_warn(psmouse, "device claims to have min coordinates query, but I'm not able to read it.\n"); } else { priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1); priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3); psmouse_info(psmouse, "queried min coordinates: x [%d..], y [%d..]\n", priv->x_min, priv->y_min); } } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov19256.80%342.86%
Benjamin Tissoires7622.49%114.29%
Daniel Martin4513.31%228.57%
Tero Saarni257.40%114.29%
Total338100.00%7100.00%

/* * Apply quirk(s) if the hardware matches */
static void synaptics_apply_quirks(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; int i; for (i = 0; min_max_pnpid_table[i].pnp_ids; i++) { if (!psmouse_matches_pnp_id(psmouse, min_max_pnpid_table[i].pnp_ids)) continue; if (min_max_pnpid_table[i].board_id.min != ANY_BOARD_ID && priv->board_id < min_max_pnpid_table[i].board_id.min) continue; if (min_max_pnpid_table[i].board_id.max != ANY_BOARD_ID && priv->board_id > min_max_pnpid_table[i].board_id.max) continue; priv->x_min = min_max_pnpid_table[i].x_min; priv->x_max = min_max_pnpid_table[i].x_max; priv->y_min = min_max_pnpid_table[i].y_min; priv->y_max = min_max_pnpid_table[i].y_max; psmouse_info(psmouse, "quirked min/max coordinates: x [%d..%d], y [%d..%d]\n", priv->x_min, priv->x_max, priv->y_min, priv->y_max); break; } }

Contributors

PersonTokensPropCommitsCommitProp
Daniel Martin179100.00%3100.00%
Total179100.00%3100.00%


static int synaptics_query_hardware(struct psmouse *psmouse) { if (synaptics_identify(psmouse)) return -1; if (synaptics_model_id(psmouse)) return -1; if (synaptics_firmware_id(psmouse)) return -1; if (synaptics_query_modes(psmouse)) return -1; if (synaptics_capability(psmouse)) return -1; if (synaptics_resolution(psmouse)) return -1; synaptics_apply_quirks(psmouse); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund4249.41%114.29%
Daniel Kurtz2124.71%114.29%
Tero Saarni1112.94%114.29%
Dmitry Torokhov55.88%228.57%
Daniel Martin55.88%114.29%
Benjamin Tissoires11.18%114.29%
Total85100.00%7100.00%


static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse) { static unsigned char param = 0xc8; struct synaptics_data *priv = psmouse->private; if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) || SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c))) return 0; if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL)) return -1; if (ps2_command(&psmouse->ps2dev, &param, PSMOUSE_CMD_SETRATE)) return -1; /* Advanced gesture mode also sends multi finger data */ priv->capabilities |= BIT(1); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Daniel Drake8590.43%150.00%
Benjamin Herrenschmidt99.57%150.00%
Total94100.00%2100.00%


static int synaptics_set_mode(struct psmouse *psmouse) { struct synaptics_data *priv = psmouse->private; priv->mode = 0; if (priv->absolute_mode) priv->mode |= SYN_BIT_ABSOLUTE_MODE; if (priv->disable_gesture) priv->mode |= SYN_BIT_DISABLE_GESTURE; if (psmouse->rate >= 80) priv->mode |= SYN_BIT_HIGH_RATE; if (SYN_CAP_EXTENDED(priv->capabilities)) priv->mode |= SYN_BIT_W_MODE; if (synaptics_mode_cmd(psmouse, priv->mode)) return -1; if (priv->absolute_mode && synaptics_set_advanced_gesture_mode(psmouse)) { psmouse_err(psmouse, "Advanced gesture mode init failed.\n"); return -1; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov4638.02%666.67%
Daniel Drake4537.19%111.11%
Peter Osterlund3024.79%222.22%
Total121100.00%9100.00%


static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate) { struct synaptics_data *priv = psmouse->private; if (rate >= 80) { priv->mode |= SYN_BIT_HIGH_RATE; psmouse->rate = 80; } else { priv->mode &= ~SYN_BIT_HIGH_RATE; psmouse->rate = 40; } synaptics_mode_cmd(psmouse, priv->mode); }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov69100.00%1100.00%
Total69100.00%1100.00%

/***************************************************************************** * Synaptics pass-through PS/2 port support ****************************************************************************/
static int synaptics_pt_write(struct serio *serio, unsigned char c) { struct psmouse *parent = serio_get_drvdata(serio->parent); char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */ if (psmouse_sliced_command(parent, c)) return -1; if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE)) return -1; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund5580.88%233.33%
Dmitry Torokhov1319.12%466.67%
Total68100.00%6100.00%


static int synaptics_pt_start(struct serio *serio) { struct psmouse *parent = serio_get_drvdata(serio->parent); struct synaptics_data *priv = parent->private; serio_pause_rx(parent->ps2dev.serio); priv->pt_port = serio; serio_continue_rx(parent->ps2dev.serio); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov59100.00%1100.00%
Total59100.00%1100.00%


static void synaptics_pt_stop(struct serio *serio) { struct psmouse *parent = serio_get_drvdata(serio->parent); struct synaptics_data *priv = parent->private; serio_pause_rx(parent->ps2dev.serio); priv->pt_port = NULL; serio_continue_rx(parent->ps2dev.serio); }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov56100.00%1100.00%
Total56100.00%1100.00%


static int synaptics_is_pt_packet(unsigned char *buf) { return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4; }

Contributors

PersonTokensPropCommitsCommitProp
Peter Osterlund34100.00%1100.00%
Total34100.00%1100.00%


static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet) { struct psmouse *child = serio_get_drvdata(ptport); if (child && child->state == PSMOUSE_ACTIVATED) { serio_interrupt(ptport, packet[1], 0); serio_interrupt(ptport, packet[4], 0); serio_interrupt(ptport, packet[5], 0); if (child->pktsize == 4) serio_interrupt(ptport, packet[2], 0); } else { serio_interrupt(