PageRenderTime 33ms CodeModel.GetById 20ms app.highlight 8ms RepoModel.GetById 2ms app.codeStats 0ms

/drivers/input/mouse/synaptics.h

http://github.com/mirrors/linux
C Header | 214 lines | 125 code | 23 blank | 66 comment | 1 complexity | a6d3cb83f1873eb4b2ab96d7ee1abb7d MD5 | raw file
  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/*
  3 * Synaptics TouchPad PS/2 mouse driver
  4 */
  5
  6#ifndef _SYNAPTICS_H
  7#define _SYNAPTICS_H
  8
  9/* synaptics queries */
 10#define SYN_QUE_IDENTIFY		0x00
 11#define SYN_QUE_MODES			0x01
 12#define SYN_QUE_CAPABILITIES		0x02
 13#define SYN_QUE_MODEL			0x03
 14#define SYN_QUE_SERIAL_NUMBER_PREFIX	0x06
 15#define SYN_QUE_SERIAL_NUMBER_SUFFIX	0x07
 16#define SYN_QUE_RESOLUTION		0x08
 17#define SYN_QUE_EXT_CAPAB		0x09
 18#define SYN_QUE_FIRMWARE_ID		0x0a
 19#define SYN_QUE_EXT_CAPAB_0C		0x0c
 20#define SYN_QUE_EXT_MAX_COORDS		0x0d
 21#define SYN_QUE_EXT_MIN_COORDS		0x0f
 22#define SYN_QUE_MEXT_CAPAB_10		0x10
 23
 24/* synatics modes */
 25#define SYN_BIT_ABSOLUTE_MODE		BIT(7)
 26#define SYN_BIT_HIGH_RATE		BIT(6)
 27#define SYN_BIT_SLEEP_MODE		BIT(3)
 28#define SYN_BIT_DISABLE_GESTURE		BIT(2)
 29#define SYN_BIT_FOUR_BYTE_CLIENT	BIT(1)
 30#define SYN_BIT_W_MODE			BIT(0)
 31
 32/* synaptics model ID bits */
 33#define SYN_MODEL_ROT180(m)		((m) & BIT(23))
 34#define SYN_MODEL_PORTRAIT(m)		((m) & BIT(22))
 35#define SYN_MODEL_SENSOR(m)		(((m) & GENMASK(21, 16)) >> 16)
 36#define SYN_MODEL_HARDWARE(m)		(((m) & GENMASK(15, 9)) >> 9)
 37#define SYN_MODEL_NEWABS(m)		((m) & BIT(7))
 38#define SYN_MODEL_PEN(m)		((m) & BIT(6))
 39#define SYN_MODEL_SIMPLIC(m)		((m) & BIT(5))
 40#define SYN_MODEL_GEOMETRY(m)		((m) & GENMASK(3, 0))
 41
 42/* synaptics capability bits */
 43#define SYN_CAP_EXTENDED(c)		((c) & BIT(23))
 44#define SYN_CAP_MIDDLE_BUTTON(c)	((c) & BIT(18))
 45#define SYN_CAP_PASS_THROUGH(c)		((c) & BIT(7))
 46#define SYN_CAP_SLEEP(c)		((c) & BIT(4))
 47#define SYN_CAP_FOUR_BUTTON(c)		((c) & BIT(3))
 48#define SYN_CAP_MULTIFINGER(c)		((c) & BIT(1))
 49#define SYN_CAP_PALMDETECT(c)		((c) & BIT(0))
 50#define SYN_CAP_SUBMODEL_ID(c)		(((c) & GENMASK(15, 8)) >> 8)
 51#define SYN_EXT_CAP_REQUESTS(c)		(((c) & GENMASK(22, 20)) >> 20)
 52#define SYN_CAP_MB_MASK			GENMASK(15, 12)
 53#define SYN_CAP_MULTI_BUTTON_NO(ec)	(((ec) & SYN_CAP_MB_MASK) >> 12)
 54#define SYN_CAP_PRODUCT_ID(ec)		(((ec) & GENMASK(23, 16)) >> 16)
 55#define SYN_MEXT_CAP_BIT(m)		((m) & BIT(1))
 56
 57/*
 58 * The following describes response for the 0x0c query.
 59 *
 60 * byte	mask	name			meaning
 61 * ----	----	-------			------------
 62 * 1	0x01	adjustable threshold	capacitive button sensitivity
 63 *					can be adjusted
 64 * 1	0x02	report max		query 0x0d gives max coord reported
 65 * 1	0x04	clearpad		sensor is ClearPad product
 66 * 1	0x08	advanced gesture	not particularly meaningful
 67 * 1	0x10	clickpad bit 0		1-button ClickPad
 68 * 1	0x60	multifinger mode	identifies firmware finger counting
 69 *					(not reporting!) algorithm.
 70 *					Not particularly meaningful
 71 * 1	0x80	covered pad		W clipped to 14, 15 == pad mostly covered
 72 * 2	0x01	clickpad bit 1		2-button ClickPad
 73 * 2	0x02	deluxe LED controls	touchpad support LED commands
 74 *					ala multimedia control bar
 75 * 2	0x04	reduced filtering	firmware does less filtering on
 76 *					position data, driver should watch
 77 *					for noise.
 78 * 2	0x08	image sensor		image sensor tracks 5 fingers, but only
 79 *					reports 2.
 80 * 2	0x01	uniform clickpad	whole clickpad moves instead of being
 81 *					hinged at the top.
 82 * 2	0x20	report min		query 0x0f gives min coord reported
 83 */
 84#define SYN_CAP_CLICKPAD(ex0c)		((ex0c) & BIT(20)) /* 1-button ClickPad */
 85#define SYN_CAP_CLICKPAD2BTN(ex0c)	((ex0c) & BIT(8))  /* 2-button ClickPad */
 86#define SYN_CAP_MAX_DIMENSIONS(ex0c)	((ex0c) & BIT(17))
 87#define SYN_CAP_MIN_DIMENSIONS(ex0c)	((ex0c) & BIT(13))
 88#define SYN_CAP_ADV_GESTURE(ex0c)	((ex0c) & BIT(19))
 89#define SYN_CAP_REDUCED_FILTERING(ex0c)	((ex0c) & BIT(10))
 90#define SYN_CAP_IMAGE_SENSOR(ex0c)	((ex0c) & BIT(11))
 91#define SYN_CAP_INTERTOUCH(ex0c)	((ex0c) & BIT(14))
 92
 93/*
 94 * The following descibes response for the 0x10 query.
 95 *
 96 * byte	mask	name			meaning
 97 * ----	----	-------			------------
 98 * 1	0x01	ext buttons are stick	buttons exported in the extended
 99 *					capability are actually meant to be used
100 *					by the tracktick (pass-through).
101 * 1	0x02	SecurePad		the touchpad is a SecurePad, so it
102 *					contains a built-in fingerprint reader.
103 * 1	0xe0	more ext count		how many more extented queries are
104 *					available after this one.
105 * 2	0xff	SecurePad width		the width of the SecurePad fingerprint
106 *					reader.
107 * 3	0xff	SecurePad height	the height of the SecurePad fingerprint
108 *					reader.
109 */
110#define SYN_CAP_EXT_BUTTONS_STICK(ex10)	((ex10) & BIT(16))
111#define SYN_CAP_SECUREPAD(ex10)		((ex10) & BIT(17))
112
113#define SYN_EXT_BUTTON_STICK_L(eb)	(((eb) & BIT(0)) >> 0)
114#define SYN_EXT_BUTTON_STICK_M(eb)	(((eb) & BIT(1)) >> 1)
115#define SYN_EXT_BUTTON_STICK_R(eb)	(((eb) & BIT(2)) >> 2)
116
117/* synaptics modes query bits */
118#define SYN_MODE_ABSOLUTE(m)		((m) & BIT(7))
119#define SYN_MODE_RATE(m)		((m) & BIT(6))
120#define SYN_MODE_BAUD_SLEEP(m)		((m) & BIT(3))
121#define SYN_MODE_DISABLE_GESTURE(m)	((m) & BIT(2))
122#define SYN_MODE_PACKSIZE(m)		((m) & BIT(1))
123#define SYN_MODE_WMODE(m)		((m) & BIT(0))
124
125/* synaptics identify query bits */
126#define SYN_ID_MODEL(i)			(((i) & GENMASK(7, 4)) >> 4)
127#define SYN_ID_MAJOR(i)			(((i) & GENMASK(3, 0)) >> 0)
128#define SYN_ID_MINOR(i)			(((i) & GENMASK(23, 16)) >> 16)
129#define SYN_ID_FULL(i)			((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i))
130#define SYN_ID_IS_SYNAPTICS(i)		(((i) & GENMASK(15, 8)) == 0x004700U)
131#define SYN_ID_DISGEST_SUPPORTED(i)	(SYN_ID_MAJOR(i) >= 4)
132
133/* synaptics special commands */
134#define SYN_PS_SET_MODE2		0x14
135#define SYN_PS_CLIENT_CMD		0x28
136
137/* amount to fuzz position data when touchpad reports reduced filtering */
138#define SYN_REDUCED_FILTER_FUZZ		8
139
140/* synaptics packet types */
141enum synaptics_pkt_type {
142	SYN_NEWABS,
143	SYN_NEWABS_STRICT,
144	SYN_NEWABS_RELAXED,
145	SYN_OLDABS,
146};
147
148/*
149 * A structure to describe the state of the touchpad hardware (buttons and pad)
150 */
151struct synaptics_hw_state {
152	int x;
153	int y;
154	int z;
155	int w;
156	unsigned int left:1;
157	unsigned int right:1;
158	unsigned int middle:1;
159	unsigned int up:1;
160	unsigned int down:1;
161	u8 ext_buttons;
162	s8 scroll;
163};
164
165/* Data read from the touchpad */
166struct synaptics_device_info {
167	u32 model_id;		/* Model-ID */
168	u32 firmware_id;	/* Firmware-ID */
169	u32 board_id;		/* Board-ID */
170	u32 capabilities;	/* Capabilities */
171	u32 ext_cap;		/* Extended Capabilities */
172	u32 ext_cap_0c;		/* Ext Caps from 0x0c query */
173	u32 ext_cap_10;		/* Ext Caps from 0x10 query */
174	u32 identity;		/* Identification */
175	u32 x_res, y_res;	/* X/Y resolution in units/mm */
176	u32 x_max, y_max;	/* Max coordinates (from FW) */
177	u32 x_min, y_min;	/* Min coordinates (from FW) */
178};
179
180struct synaptics_data {
181	struct synaptics_device_info info;
182
183	enum synaptics_pkt_type pkt_type;	/* packet type - old, new, etc */
184	u8 mode;				/* current mode byte */
185	int scroll;
186
187	bool absolute_mode;			/* run in Absolute mode */
188	bool disable_gesture;			/* disable gestures */
189
190	struct serio *pt_port;			/* Pass-through serio port */
191
192	/*
193	 * Last received Advanced Gesture Mode (AGM) packet. An AGM packet
194	 * contains position data for a second contact, at half resolution.
195	 */
196	struct synaptics_hw_state agm;
197	unsigned int agm_count;			/* finger count reported by agm */
198
199	/* ForcePad handling */
200	unsigned long				press_start;
201	bool					press;
202	bool					report_press;
203	bool					is_forcepad;
204};
205
206void synaptics_module_init(void);
207int synaptics_detect(struct psmouse *psmouse, bool set_properties);
208int synaptics_init_absolute(struct psmouse *psmouse);
209int synaptics_init_relative(struct psmouse *psmouse);
210int synaptics_init_smbus(struct psmouse *psmouse);
211int synaptics_init(struct psmouse *psmouse);
212void synaptics_reset(struct psmouse *psmouse);
213
214#endif /* _SYNAPTICS_H */