Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Synaptics TouchPad PS/2 mouse driver | |
3 | * | |
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. | |
7 | */ | |
8 | ||
9 | #ifndef _SYNAPTICS_H | |
10 | #define _SYNAPTICS_H | |
11 | ||
1da177e4 LT |
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 | |
c6bd9d46 | 21 | #define SYN_QUE_FIRMWARE_ID 0x0a |
5f57d67d | 22 | #define SYN_QUE_EXT_CAPAB_0C 0x0c |
a66413fb DT |
23 | #define SYN_QUE_EXT_MAX_COORDS 0x0d |
24 | #define SYN_QUE_EXT_MIN_COORDS 0x0f | |
06aa374b | 25 | #define SYN_QUE_MEXT_CAPAB_10 0x10 |
1da177e4 LT |
26 | |
27 | /* synatics modes */ | |
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) | |
34 | ||
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) | |
44 | ||
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)) | |
3619b8fe | 53 | #define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8) |
1da177e4 LT |
54 | #define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20) |
55 | #define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12) | |
5f57d67d | 56 | #define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16) |
06aa374b | 57 | #define SYN_MEXT_CAP_BIT(m) ((m) & (1 << 1)) |
9bb794ae DT |
58 | |
59 | /* | |
60 | * The following describes response for the 0x0c query. | |
61 | * | |
62 | * byte mask name meaning | |
63 | * ---- ---- ------- ------------ | |
64 | * 1 0x01 adjustable threshold capacitive button sensitivity | |
65 | * can be adjusted | |
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 | |
a9f0b79e DK |
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 | |
9bb794ae DT |
76 | * ala multimedia control bar |
77 | * 2 0x04 reduced filtering firmware does less filtering on | |
78 | * position data, driver should watch | |
79 | * for noise. | |
3cdfee9e DK |
80 | * 2 0x08 image sensor image sensor tracks 5 fingers, but only |
81 | * reports 2. | |
aa972409 DT |
82 | * 2 0x01 uniform clickpad whole clickpad moves instead of being |
83 | * hinged at the top. | |
a66413fb | 84 | * 2 0x20 report min query 0x0f gives min coord reported |
9bb794ae | 85 | */ |
3bfa321e YL |
86 | #define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */ |
87 | #define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */ | |
83ba9ea8 | 88 | #define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000) |
3c6b5014 | 89 | #define SYN_CAP_MIN_DIMENSIONS(ex0c) ((ex0c) & 0x002000) |
fec6e525 | 90 | #define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000) |
a9f0b79e | 91 | #define SYN_CAP_REDUCED_FILTERING(ex0c) ((ex0c) & 0x000400) |
3cdfee9e | 92 | #define SYN_CAP_IMAGE_SENSOR(ex0c) ((ex0c) & 0x000800) |
1da177e4 | 93 | |
06aa374b BT |
94 | /* |
95 | * The following descibes response for the 0x10 query. | |
96 | * | |
97 | * byte mask name meaning | |
98 | * ---- ---- ------- ------------ | |
99 | * 1 0x01 ext buttons are stick buttons exported in the extended | |
100 | * capability are actually meant to be used | |
101 | * by the tracktick (pass-through). | |
102 | * 1 0x02 SecurePad the touchpad is a SecurePad, so it | |
103 | * contains a built-in fingerprint reader. | |
104 | * 1 0xe0 more ext count how many more extented queries are | |
105 | * available after this one. | |
106 | * 2 0xff SecurePad width the width of the SecurePad fingerprint | |
107 | * reader. | |
108 | * 3 0xff SecurePad height the height of the SecurePad fingerprint | |
109 | * reader. | |
110 | */ | |
111 | #define SYN_CAP_EXT_BUTTONS_STICK(ex10) ((ex10) & 0x010000) | |
112 | #define SYN_CAP_SECUREPAD(ex10) ((ex10) & 0x020000) | |
113 | ||
1da177e4 LT |
114 | /* synaptics modes query bits */ |
115 | #define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7)) | |
116 | #define SYN_MODE_RATE(m) ((m) & (1 << 6)) | |
117 | #define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3)) | |
118 | #define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2)) | |
119 | #define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1)) | |
120 | #define SYN_MODE_WMODE(m) ((m) & (1 << 0)) | |
121 | ||
122 | /* synaptics identify query bits */ | |
55e3d922 AS |
123 | #define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f) |
124 | #define SYN_ID_MAJOR(i) ((i) & 0x0f) | |
125 | #define SYN_ID_MINOR(i) (((i) >> 16) & 0xff) | |
3619b8fe | 126 | #define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i)) |
1da177e4 | 127 | #define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47) |
7968a5dd | 128 | #define SYN_ID_DISGEST_SUPPORTED(i) (SYN_ID_MAJOR(i) >= 4) |
1da177e4 LT |
129 | |
130 | /* synaptics special commands */ | |
131 | #define SYN_PS_SET_MODE2 0x14 | |
132 | #define SYN_PS_CLIENT_CMD 0x28 | |
133 | ||
134 | /* synaptics packet types */ | |
135 | #define SYN_NEWABS 0 | |
136 | #define SYN_NEWABS_STRICT 1 | |
137 | #define SYN_NEWABS_RELAXED 2 | |
138 | #define SYN_OLDABS 3 | |
139 | ||
a9f0b79e DK |
140 | /* amount to fuzz position data when touchpad reports reduced filtering */ |
141 | #define SYN_REDUCED_FILTER_FUZZ 8 | |
142 | ||
1da177e4 | 143 | /* |
a6ca40c1 DK |
144 | * A structure to describe which internal touchpad finger slots are being |
145 | * reported in raw packets. | |
1da177e4 | 146 | */ |
a6ca40c1 DK |
147 | struct synaptics_mt_state { |
148 | int count; /* num fingers being tracked */ | |
149 | int sgm; /* which slot is reported by sgm pkt */ | |
150 | int agm; /* which slot is reported by agm pkt*/ | |
151 | }; | |
1da177e4 | 152 | |
a6ca40c1 DK |
153 | /* |
154 | * A structure to describe the state of the touchpad hardware (buttons and pad) | |
155 | */ | |
1da177e4 LT |
156 | struct synaptics_hw_state { |
157 | int x; | |
158 | int y; | |
159 | int z; | |
160 | int w; | |
161 | unsigned int left:1; | |
162 | unsigned int right:1; | |
163 | unsigned int middle:1; | |
164 | unsigned int up:1; | |
165 | unsigned int down:1; | |
166 | unsigned char ext_buttons; | |
167 | signed char scroll; | |
a6ca40c1 DK |
168 | |
169 | /* As reported in last AGM-CONTACT packets */ | |
170 | struct synaptics_mt_state mt_state; | |
1da177e4 LT |
171 | }; |
172 | ||
173 | struct synaptics_data { | |
174 | /* Data read from the touchpad */ | |
175 | unsigned long int model_id; /* Model-ID */ | |
c6bd9d46 DK |
176 | unsigned long int firmware_id; /* Firmware-ID */ |
177 | unsigned long int board_id; /* Board-ID */ | |
55e3d922 AS |
178 | unsigned long int capabilities; /* Capabilities */ |
179 | unsigned long int ext_cap; /* Extended Capabilities */ | |
5f57d67d | 180 | unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */ |
06aa374b | 181 | unsigned long int ext_cap_10; /* Ext Caps from 0x10 query */ |
1da177e4 | 182 | unsigned long int identity; /* Identification */ |
83ba9ea8 | 183 | unsigned int x_res, y_res; /* X/Y resolution in units/mm */ |
a66413fb DT |
184 | unsigned int x_max, y_max; /* Max coordinates (from FW) */ |
185 | unsigned int x_min, y_min; /* Min coordinates (from FW) */ | |
1da177e4 LT |
186 | |
187 | unsigned char pkt_type; /* packet type - old, new, etc */ | |
188 | unsigned char mode; /* current mode byte */ | |
189 | int scroll; | |
a8b3c0f5 | 190 | |
7968a5dd DD |
191 | bool absolute_mode; /* run in Absolute mode */ |
192 | bool disable_gesture; /* disable gestures */ | |
193 | ||
a8b3c0f5 | 194 | struct serio *pt_port; /* Pass-through serio port */ |
fec6e525 | 195 | |
4dc772d2 DK |
196 | struct synaptics_mt_state mt_state; /* Current mt finger state */ |
197 | bool mt_state_lost; /* mt_state may be incorrect */ | |
198 | ||
7afdb842 DK |
199 | /* |
200 | * Last received Advanced Gesture Mode (AGM) packet. An AGM packet | |
201 | * contains position data for a second contact, at half resolution. | |
202 | */ | |
203 | struct synaptics_hw_state agm; | |
4dc772d2 | 204 | bool agm_pending; /* new AGM packet received */ |
5715fc76 DT |
205 | |
206 | /* ForcePad handling */ | |
207 | unsigned long press_start; | |
208 | bool press; | |
209 | bool report_press; | |
1da177e4 LT |
210 | }; |
211 | ||
7705d548 | 212 | void synaptics_module_init(void); |
b7802c5c | 213 | int synaptics_detect(struct psmouse *psmouse, bool set_properties); |
55e3d922 | 214 | int synaptics_init(struct psmouse *psmouse); |
7968a5dd | 215 | int synaptics_init_relative(struct psmouse *psmouse); |
55e3d922 | 216 | void synaptics_reset(struct psmouse *psmouse); |
e4e6efd2 | 217 | bool synaptics_supported(void); |
55e3d922 | 218 | |
1da177e4 | 219 | #endif /* _SYNAPTICS_H */ |