Merge tag 'v4.11-rc5' into next
[sfrench/cifs-2.6.git] / drivers / input / mouse / alps.h
1 /*
2  * ALPS touchpad PS/2 mouse driver
3  *
4  * Copyright (c) 2003 Peter Osterlund <petero2@telia.com>
5  * Copyright (c) 2005 Vojtech Pavlik <vojtech@suse.cz>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  */
11
12 #ifndef _ALPS_H
13 #define _ALPS_H
14
15 #include <linux/input/mt.h>
16
17 #define ALPS_PROTO_V1           0x100
18 #define ALPS_PROTO_V2           0x200
19 #define ALPS_PROTO_V3           0x300
20 #define ALPS_PROTO_V3_RUSHMORE  0x310
21 #define ALPS_PROTO_V4           0x400
22 #define ALPS_PROTO_V5           0x500
23 #define ALPS_PROTO_V6           0x600
24 #define ALPS_PROTO_V7           0x700   /* t3btl t4s */
25 #define ALPS_PROTO_V8           0x800   /* SS4btl SS4s */
26 #define ALPS_PROTO_V9           0x900   /* ss3btl */
27
28 #define MAX_TOUCHES     4
29
30 #define DOLPHIN_COUNT_PER_ELECTRODE     64
31 #define DOLPHIN_PROFILE_XOFFSET         8       /* x-electrode offset */
32 #define DOLPHIN_PROFILE_YOFFSET         1       /* y-electrode offset */
33
34 /*
35  * enum SS4_PACKET_ID - defines the packet type for V8
36  * SS4_PACKET_ID_IDLE: There's no finger and no button activity.
37  * SS4_PACKET_ID_ONE: There's one finger on touchpad
38  *  or there's button activities.
39  * SS4_PACKET_ID_TWO: There's two or more fingers on touchpad
40  * SS4_PACKET_ID_MULTI: There's three or more fingers on touchpad
41  * SS4_PACKET_ID_STICK: A stick pointer packet
42 */
43 enum SS4_PACKET_ID {
44         SS4_PACKET_ID_IDLE = 0,
45         SS4_PACKET_ID_ONE,
46         SS4_PACKET_ID_TWO,
47         SS4_PACKET_ID_MULTI,
48         SS4_PACKET_ID_STICK,
49 };
50
51 #define SS4_COUNT_PER_ELECTRODE         256
52 #define SS4_NUMSENSOR_XOFFSET           7
53 #define SS4_NUMSENSOR_YOFFSET           7
54 #define SS4_MIN_PITCH_MM                50
55
56 #define SS4_MASK_NORMAL_BUTTONS         0x07
57
58 #define SS4PLUS_COUNT_PER_ELECTRODE     128
59 #define SS4PLUS_NUMSENSOR_XOFFSET       16
60 #define SS4PLUS_NUMSENSOR_YOFFSET       5
61 #define SS4PLUS_MIN_PITCH_MM            37
62
63 #define IS_SS4PLUS_DEV(_b)      (((_b[0]) == 0x73) &&   \
64                                  ((_b[1]) == 0x03) &&   \
65                                  ((_b[2]) == 0x28)              \
66                                 )
67
68 #define SS4_IS_IDLE_V2(_b)      (((_b[0]) == 0x18) &&           \
69                                  ((_b[1]) == 0x10) &&           \
70                                  ((_b[2]) == 0x00) &&           \
71                                  ((_b[3] & 0x88) == 0x08) &&    \
72                                  ((_b[4]) == 0x10) &&           \
73                                  ((_b[5]) == 0x00)              \
74                                 )
75
76 #define SS4_1F_X_V2(_b)         (((_b[0]) & 0x0007) |           \
77                                  ((_b[1] << 3) & 0x0078) |      \
78                                  ((_b[1] << 2) & 0x0380) |      \
79                                  ((_b[2] << 5) & 0x1C00)        \
80                                 )
81
82 #define SS4_1F_Y_V2(_b)         (((_b[2]) & 0x000F) |           \
83                                  ((_b[3] >> 2) & 0x0030) |      \
84                                  ((_b[4] << 6) & 0x03C0) |      \
85                                  ((_b[4] << 5) & 0x0C00)        \
86                                 )
87
88 #define SS4_1F_Z_V2(_b)         (((_b[5]) & 0x0F) |             \
89                                  ((_b[5] >> 1) & 0x70) |        \
90                                  ((_b[4]) & 0x80)               \
91                                 )
92
93 #define SS4_1F_LFB_V2(_b)       (((_b[2] >> 4) & 0x01) == 0x01)
94
95 #define SS4_MF_LF_V2(_b, _i)    ((_b[1 + (_i) * 3] & 0x0004) == 0x0004)
96
97 #define SS4_BTN_V2(_b)          ((_b[0] >> 5) & SS4_MASK_NORMAL_BUTTONS)
98
99 #define SS4_STD_MF_X_V2(_b, _i) (((_b[0 + (_i) * 3] << 5) & 0x00E0) |   \
100                                  ((_b[1 + _i * 3]  << 5) & 0x1F00)      \
101                                 )
102
103 #define SS4_STD_MF_Y_V2(_b, _i) (((_b[1 + (_i) * 3] << 3) & 0x0010) |   \
104                                  ((_b[2 + (_i) * 3] << 5) & 0x01E0) |   \
105                                  ((_b[2 + (_i) * 3] << 4) & 0x0E00)     \
106                                 )
107
108 #define SS4_BTL_MF_X_V2(_b, _i) (SS4_STD_MF_X_V2(_b, _i) |              \
109                                  ((_b[0 + (_i) * 3] >> 3) & 0x0010)     \
110                                 )
111
112 #define SS4_BTL_MF_Y_V2(_b, _i) (SS4_STD_MF_Y_V2(_b, _i) | \
113                                  ((_b[0 + (_i) * 3] >> 3) & 0x0008)     \
114                                 )
115
116 #define SS4_MF_Z_V2(_b, _i)     (((_b[1 + (_i) * 3]) & 0x0001) |        \
117                                  ((_b[1 + (_i) * 3] >> 1) & 0x0002)     \
118                                 )
119
120 #define SS4_IS_MF_CONTINUE(_b)  ((_b[2] & 0x10) == 0x10)
121 #define SS4_IS_5F_DETECTED(_b)  ((_b[2] & 0x10) == 0x10)
122
123 #define SS4_TS_X_V2(_b)         (s8)(                           \
124                                  ((_b[0] & 0x01) << 7) |        \
125                                  (_b[1] & 0x7F)         \
126                                 )
127
128 #define SS4_TS_Y_V2(_b)         -(s8)(                          \
129                                  ((_b[3] & 0x01) << 7) |        \
130                                  (_b[2] & 0x7F)         \
131                                 )
132
133 #define SS4_TS_Z_V2(_b)         (s8)(_b[4] & 0x7F)
134
135
136 #define SS4_MFPACKET_NO_AX      8160    /* X-Coordinate value */
137 #define SS4_MFPACKET_NO_AY      4080    /* Y-Coordinate value */
138 #define SS4_MFPACKET_NO_AX_BL   8176    /* Buttonless X-Coordinate value */
139 #define SS4_MFPACKET_NO_AY_BL   4088    /* Buttonless Y-Coordinate value */
140
141 /*
142  * enum V7_PACKET_ID - defines the packet type for V7
143  * V7_PACKET_ID_IDLE: There's no finger and no button activity.
144  * V7_PACKET_ID_TWO: There's one or two non-resting fingers on touchpad
145  *  or there's button activities.
146  * V7_PACKET_ID_MULTI: There are at least three non-resting fingers.
147  * V7_PACKET_ID_NEW: The finger position in slot is not continues from
148  *  previous packet.
149 */
150 enum V7_PACKET_ID {
151          V7_PACKET_ID_IDLE,
152          V7_PACKET_ID_TWO,
153          V7_PACKET_ID_MULTI,
154          V7_PACKET_ID_NEW,
155          V7_PACKET_ID_UNKNOWN,
156 };
157
158 /**
159  * struct alps_protocol_info - information about protocol used by a device
160  * @version: Indicates V1/V2/V3/...
161  * @byte0: Helps figure out whether a position report packet matches the
162  *   known format for this model.  The first byte of the report, ANDed with
163  *   mask0, should match byte0.
164  * @mask0: The mask used to check the first byte of the report.
165  * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
166  */
167 struct alps_protocol_info {
168         u16 version;
169         u8 byte0, mask0;
170         unsigned int flags;
171 };
172
173 /**
174  * struct alps_model_info - touchpad ID table
175  * @signature: E7 response string to match.
176  * @protocol_info: information about protocol used by the device.
177  *
178  * Many (but not all) ALPS touchpads can be identified by looking at the
179  * values returned in the "E7 report" and/or the "EC report."  This table
180  * lists a number of such touchpads.
181  */
182 struct alps_model_info {
183         u8 signature[3];
184         struct alps_protocol_info protocol_info;
185 };
186
187 /**
188  * struct alps_nibble_commands - encodings for register accesses
189  * @command: PS/2 command used for the nibble
190  * @data: Data supplied as an argument to the PS/2 command, if applicable
191  *
192  * The ALPS protocol uses magic sequences to transmit binary data to the
193  * touchpad, as it is generally not OK to send arbitrary bytes out the
194  * PS/2 port.  Each of the sequences in this table sends one nibble of the
195  * register address or (write) data.  Different versions of the ALPS protocol
196  * use slightly different encodings.
197  */
198 struct alps_nibble_commands {
199         int command;
200         unsigned char data;
201 };
202
203 struct alps_bitmap_point {
204         int start_bit;
205         int num_bits;
206 };
207
208 /**
209  * struct alps_fields - decoded version of the report packet
210  * @x_map: Bitmap of active X positions for MT.
211  * @y_map: Bitmap of active Y positions for MT.
212  * @fingers: Number of fingers for MT.
213  * @pressure: Pressure.
214  * @st: position for ST.
215  * @mt: position for MT.
216  * @first_mp: Packet is the first of a multi-packet report.
217  * @is_mp: Packet is part of a multi-packet report.
218  * @left: Left touchpad button is active.
219  * @right: Right touchpad button is active.
220  * @middle: Middle touchpad button is active.
221  * @ts_left: Left trackstick button is active.
222  * @ts_right: Right trackstick button is active.
223  * @ts_middle: Middle trackstick button is active.
224  */
225 struct alps_fields {
226         unsigned int x_map;
227         unsigned int y_map;
228         unsigned int fingers;
229
230         int pressure;
231         struct input_mt_pos st;
232         struct input_mt_pos mt[MAX_TOUCHES];
233
234         unsigned int first_mp:1;
235         unsigned int is_mp:1;
236
237         unsigned int left:1;
238         unsigned int right:1;
239         unsigned int middle:1;
240
241         unsigned int ts_left:1;
242         unsigned int ts_right:1;
243         unsigned int ts_middle:1;
244 };
245
246 /**
247  * struct alps_data - private data structure for the ALPS driver
248  * @psmouse: Pointer to parent psmouse device
249  * @dev2: Trackstick device (can be NULL).
250  * @dev3: Generic PS/2 mouse (can be NULL, delayed registering).
251  * @phys2: Physical path for the trackstick device.
252  * @phys3: Physical path for the generic PS/2 mouse.
253  * @dev3_register_work: Delayed work for registering PS/2 mouse.
254  * @nibble_commands: Command mapping used for touchpad register accesses.
255  * @addr_command: Command used to tell the touchpad that a register address
256  *   follows.
257  * @proto_version: Indicates V1/V2/V3/...
258  * @byte0: Helps figure out whether a position report packet matches the
259  *   known format for this model.  The first byte of the report, ANDed with
260  *   mask0, should match byte0.
261  * @mask0: The mask used to check the first byte of the report.
262  * @fw_ver: cached copy of firmware version (EC report)
263  * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
264  * @x_max: Largest possible X position value.
265  * @y_max: Largest possible Y position value.
266  * @x_bits: Number of X bits in the MT bitmap.
267  * @y_bits: Number of Y bits in the MT bitmap.
268  * @hw_init: Protocol-specific hardware init function.
269  * @process_packet: Protocol-specific function to process a report packet.
270  * @decode_fields: Protocol-specific function to read packet bitfields.
271  * @set_abs_params: Protocol-specific function to configure the input_dev.
272  * @prev_fin: Finger bit from previous packet.
273  * @multi_packet: Multi-packet data in progress.
274  * @multi_data: Saved multi-packet data.
275  * @f: Decoded packet data fields.
276  * @quirks: Bitmap of ALPS_QUIRK_*.
277  * @timer: Timer for flushing out the final report packet in the stream.
278  */
279 struct alps_data {
280         struct psmouse *psmouse;
281         struct input_dev *dev2;
282         struct input_dev *dev3;
283         char phys2[32];
284         char phys3[32];
285         struct delayed_work dev3_register_work;
286
287         /* these are autodetected when the device is identified */
288         const struct alps_nibble_commands *nibble_commands;
289         int addr_command;
290         u16 proto_version;
291         u8 byte0, mask0;
292         u8 dev_id[3];
293         u8 fw_ver[3];
294         int flags;
295         int x_max;
296         int y_max;
297         int x_bits;
298         int y_bits;
299         unsigned int x_res;
300         unsigned int y_res;
301
302         int (*hw_init)(struct psmouse *psmouse);
303         void (*process_packet)(struct psmouse *psmouse);
304         int (*decode_fields)(struct alps_fields *f, unsigned char *p,
305                               struct psmouse *psmouse);
306         void (*set_abs_params)(struct alps_data *priv, struct input_dev *dev1);
307
308         int prev_fin;
309         int multi_packet;
310         int second_touch;
311         unsigned char multi_data[6];
312         struct alps_fields f;
313         u8 quirks;
314         struct timer_list timer;
315 };
316
317 #define ALPS_QUIRK_TRACKSTICK_BUTTONS   1 /* trakcstick buttons in trackstick packet */
318
319 #ifdef CONFIG_MOUSE_PS2_ALPS
320 int alps_detect(struct psmouse *psmouse, bool set_properties);
321 int alps_init(struct psmouse *psmouse);
322 #else
323 inline int alps_detect(struct psmouse *psmouse, bool set_properties)
324 {
325         return -ENOSYS;
326 }
327 inline int alps_init(struct psmouse *psmouse)
328 {
329         return -ENOSYS;
330 }
331 #endif /* CONFIG_MOUSE_PS2_ALPS */
332
333 #endif