2 * Synaptics TouchPad PS/2 mouse driver
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
12 /* synaptics queries */
13 #define SYN_QUE_IDENTIFY 0x00
14 #define SYN_QUE_MODES 0x01
15 #define SYN_QUE_CAPABILITIES 0x02
16 #define SYN_QUE_MODEL 0x03
17 #define SYN_QUE_SERIAL_NUMBER_PREFIX 0x06
18 #define SYN_QUE_SERIAL_NUMBER_SUFFIX 0x07
19 #define SYN_QUE_RESOLUTION 0x08
20 #define SYN_QUE_EXT_CAPAB 0x09
21 #define SYN_QUE_FIRMWARE_ID 0x0a
22 #define SYN_QUE_EXT_CAPAB_0C 0x0c
23 #define SYN_QUE_EXT_MAX_COORDS 0x0d
24 #define SYN_QUE_EXT_MIN_COORDS 0x0f
25 #define SYN_QUE_MEXT_CAPAB_10 0x10
28 #define SYN_BIT_ABSOLUTE_MODE (1 << 7)
29 #define SYN_BIT_HIGH_RATE (1 << 6)
30 #define SYN_BIT_SLEEP_MODE (1 << 3)
31 #define SYN_BIT_DISABLE_GESTURE (1 << 2)
32 #define SYN_BIT_FOUR_BYTE_CLIENT (1 << 1)
33 #define SYN_BIT_W_MODE (1 << 0)
35 /* synaptics model ID bits */
36 #define SYN_MODEL_ROT180(m) ((m) & (1 << 23))
37 #define SYN_MODEL_PORTRAIT(m) ((m) & (1 << 22))
38 #define SYN_MODEL_SENSOR(m) (((m) >> 16) & 0x3f)
39 #define SYN_MODEL_HARDWARE(m) (((m) >> 9) & 0x7f)
40 #define SYN_MODEL_NEWABS(m) ((m) & (1 << 7))
41 #define SYN_MODEL_PEN(m) ((m) & (1 << 6))
42 #define SYN_MODEL_SIMPLIC(m) ((m) & (1 << 5))
43 #define SYN_MODEL_GEOMETRY(m) ((m) & 0x0f)
45 /* synaptics capability bits */
46 #define SYN_CAP_EXTENDED(c) ((c) & (1 << 23))
47 #define SYN_CAP_MIDDLE_BUTTON(c) ((c) & (1 << 18))
48 #define SYN_CAP_PASS_THROUGH(c) ((c) & (1 << 7))
49 #define SYN_CAP_SLEEP(c) ((c) & (1 << 4))
50 #define SYN_CAP_FOUR_BUTTON(c) ((c) & (1 << 3))
51 #define SYN_CAP_MULTIFINGER(c) ((c) & (1 << 1))
52 #define SYN_CAP_PALMDETECT(c) ((c) & (1 << 0))
53 #define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8)
54 #define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20)
55 #define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12)
56 #define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16)
57 #define SYN_MEXT_CAP_BIT(m) ((m) & (1 << 1))
60 * The following describes response for the 0x0c query.
62 * byte mask name meaning
63 * ---- ---- ------- ------------
64 * 1 0x01 adjustable threshold capacitive button sensitivity
66 * 1 0x02 report max query 0x0d gives max coord reported
67 * 1 0x04 clearpad sensor is ClearPad product
68 * 1 0x08 advanced gesture not particularly meaningful
69 * 1 0x10 clickpad bit 0 1-button ClickPad
70 * 1 0x60 multifinger mode identifies firmware finger counting
71 * (not reporting!) algorithm.
72 * Not particularly meaningful
73 * 1 0x80 covered pad W clipped to 14, 15 == pad mostly covered
74 * 2 0x01 clickpad bit 1 2-button ClickPad
75 * 2 0x02 deluxe LED controls touchpad support LED commands
76 * ala multimedia control bar
77 * 2 0x04 reduced filtering firmware does less filtering on
78 * position data, driver should watch
80 * 2 0x08 image sensor image sensor tracks 5 fingers, but only
82 * 2 0x01 uniform clickpad whole clickpad moves instead of being
84 * 2 0x20 report min query 0x0f gives min coord reported
86 #define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */
87 #define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */
88 #define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000)
89 #define SYN_CAP_MIN_DIMENSIONS(ex0c) ((ex0c) & 0x002000)
90 #define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000)
91 #define SYN_CAP_REDUCED_FILTERING(ex0c) ((ex0c) & 0x000400)
92 #define SYN_CAP_IMAGE_SENSOR(ex0c) ((ex0c) & 0x000800)
93 #define SYN_CAP_INTERTOUCH(ex0c) ((ex0c) & 0x004000)
96 * The following descibes response for the 0x10 query.
98 * byte mask name meaning
99 * ---- ---- ------- ------------
100 * 1 0x01 ext buttons are stick buttons exported in the extended
101 * capability are actually meant to be used
102 * by the tracktick (pass-through).
103 * 1 0x02 SecurePad the touchpad is a SecurePad, so it
104 * contains a built-in fingerprint reader.
105 * 1 0xe0 more ext count how many more extented queries are
106 * available after this one.
107 * 2 0xff SecurePad width the width of the SecurePad fingerprint
109 * 3 0xff SecurePad height the height of the SecurePad fingerprint
112 #define SYN_CAP_EXT_BUTTONS_STICK(ex10) ((ex10) & 0x010000)
113 #define SYN_CAP_SECUREPAD(ex10) ((ex10) & 0x020000)
115 #define SYN_EXT_BUTTON_STICK_L(eb) (((eb) & BIT(0)) >> 0)
116 #define SYN_EXT_BUTTON_STICK_M(eb) (((eb) & BIT(1)) >> 1)
117 #define SYN_EXT_BUTTON_STICK_R(eb) (((eb) & BIT(2)) >> 2)
119 /* synaptics modes query bits */
120 #define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7))
121 #define SYN_MODE_RATE(m) ((m) & (1 << 6))
122 #define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3))
123 #define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2))
124 #define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1))
125 #define SYN_MODE_WMODE(m) ((m) & (1 << 0))
127 /* synaptics identify query bits */
128 #define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f)
129 #define SYN_ID_MAJOR(i) ((i) & 0x0f)
130 #define SYN_ID_MINOR(i) (((i) >> 16) & 0xff)
131 #define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i))
132 #define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47)
133 #define SYN_ID_DISGEST_SUPPORTED(i) (SYN_ID_MAJOR(i) >= 4)
135 /* synaptics special commands */
136 #define SYN_PS_SET_MODE2 0x14
137 #define SYN_PS_CLIENT_CMD 0x28
139 /* synaptics packet types */
141 #define SYN_NEWABS_STRICT 1
142 #define SYN_NEWABS_RELAXED 2
145 /* amount to fuzz position data when touchpad reports reduced filtering */
146 #define SYN_REDUCED_FILTER_FUZZ 8
149 * A structure to describe the state of the touchpad hardware (buttons and pad)
151 struct synaptics_hw_state {
157 unsigned int right:1;
158 unsigned int middle:1;
161 unsigned char ext_buttons;
165 /* Data read from the touchpad */
166 struct 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) */
180 struct synaptics_data {
181 struct synaptics_device_info info;
183 unsigned char pkt_type; /* packet type - old, new, etc */
184 unsigned char mode; /* current mode byte */
187 bool absolute_mode; /* run in Absolute mode */
188 bool disable_gesture; /* disable gestures */
190 struct serio *pt_port; /* Pass-through serio port */
193 * Last received Advanced Gesture Mode (AGM) packet. An AGM packet
194 * contains position data for a second contact, at half resolution.
196 struct synaptics_hw_state agm;
197 unsigned int agm_count; /* finger count reported by agm */
199 /* ForcePad handling */
200 unsigned long press_start;
206 void synaptics_module_init(void);
207 int synaptics_detect(struct psmouse *psmouse, bool set_properties);
208 int synaptics_init_absolute(struct psmouse *psmouse);
209 int synaptics_init_relative(struct psmouse *psmouse);
210 int synaptics_init_smbus(struct psmouse *psmouse);
211 int synaptics_init(struct psmouse *psmouse);
212 void synaptics_reset(struct psmouse *psmouse);
214 #endif /* _SYNAPTICS_H */