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