2 * ALPS touchpad PS/2 mouse driver
4 * Copyright (c) 2003 Peter Osterlund <petero2@telia.com>
5 * Copyright (c) 2005 Vojtech Pavlik <vojtech@suse.cz>
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.
15 #include <linux/input/mt.h>
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 */
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 */
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
44 SS4_PACKET_ID_IDLE
= 0,
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
56 #define SS4_MASK_NORMAL_BUTTONS 0x07
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
63 #define IS_SS4PLUS_DEV(_b) (((_b[0]) == 0x73) && \
64 ((_b[1]) == 0x03) && \
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) && \
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) \
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) \
88 #define SS4_1F_Z_V2(_b) (((_b[5]) & 0x0F) | \
89 ((_b[5] >> 1) & 0x70) | \
93 #define SS4_1F_LFB_V2(_b) (((_b[2] >> 4) & 0x01) == 0x01)
95 #define SS4_MF_LF_V2(_b, _i) ((_b[1 + (_i) * 3] & 0x0004) == 0x0004)
97 #define SS4_BTN_V2(_b) ((_b[0] >> 5) & SS4_MASK_NORMAL_BUTTONS)
99 #define SS4_STD_MF_X_V2(_b, _i) (((_b[0 + (_i) * 3] << 5) & 0x00E0) | \
100 ((_b[1 + _i * 3] << 5) & 0x1F00) \
103 #define SS4_PLUS_STD_MF_X_V2(_b, _i) (((_b[0 + (_i) * 3] << 4) & 0x0070) | \
104 ((_b[1 + (_i) * 3] << 4) & 0x0F80) \
107 #define SS4_STD_MF_Y_V2(_b, _i) (((_b[1 + (_i) * 3] << 3) & 0x0010) | \
108 ((_b[2 + (_i) * 3] << 5) & 0x01E0) | \
109 ((_b[2 + (_i) * 3] << 4) & 0x0E00) \
112 #define SS4_BTL_MF_X_V2(_b, _i) (SS4_STD_MF_X_V2(_b, _i) | \
113 ((_b[0 + (_i) * 3] >> 3) & 0x0010) \
116 #define SS4_PLUS_BTL_MF_X_V2(_b, _i) (SS4_PLUS_STD_MF_X_V2(_b, _i) | \
117 ((_b[0 + (_i) * 3] >> 4) & 0x0008) \
120 #define SS4_BTL_MF_Y_V2(_b, _i) (SS4_STD_MF_Y_V2(_b, _i) | \
121 ((_b[0 + (_i) * 3] >> 3) & 0x0008) \
124 #define SS4_MF_Z_V2(_b, _i) (((_b[1 + (_i) * 3]) & 0x0001) | \
125 ((_b[1 + (_i) * 3] >> 1) & 0x0002) \
128 #define SS4_IS_MF_CONTINUE(_b) ((_b[2] & 0x10) == 0x10)
129 #define SS4_IS_5F_DETECTED(_b) ((_b[2] & 0x10) == 0x10)
131 #define SS4_TS_X_V2(_b) (s8)( \
132 ((_b[0] & 0x01) << 7) | \
136 #define SS4_TS_Y_V2(_b) -(s8)( \
137 ((_b[3] & 0x01) << 7) | \
141 #define SS4_TS_Z_V2(_b) (s8)(_b[4] & 0x7F)
144 #define SS4_MFPACKET_NO_AX 8160 /* X-Coordinate value */
145 #define SS4_MFPACKET_NO_AY 4080 /* Y-Coordinate value */
146 #define SS4_MFPACKET_NO_AX_BL 8176 /* Buttonless X-Coordinate value */
147 #define SS4_MFPACKET_NO_AY_BL 4088 /* Buttonless Y-Coordinate value */
150 * enum V7_PACKET_ID - defines the packet type for V7
151 * V7_PACKET_ID_IDLE: There's no finger and no button activity.
152 * V7_PACKET_ID_TWO: There's one or two non-resting fingers on touchpad
153 * or there's button activities.
154 * V7_PACKET_ID_MULTI: There are at least three non-resting fingers.
155 * V7_PACKET_ID_NEW: The finger position in slot is not continues from
163 V7_PACKET_ID_UNKNOWN
,
167 * struct alps_protocol_info - information about protocol used by a device
168 * @version: Indicates V1/V2/V3/...
169 * @byte0: Helps figure out whether a position report packet matches the
170 * known format for this model. The first byte of the report, ANDed with
171 * mask0, should match byte0.
172 * @mask0: The mask used to check the first byte of the report.
173 * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
175 struct alps_protocol_info
{
182 * struct alps_model_info - touchpad ID table
183 * @signature: E7 response string to match.
184 * @protocol_info: information about protocol used by the device.
186 * Many (but not all) ALPS touchpads can be identified by looking at the
187 * values returned in the "E7 report" and/or the "EC report." This table
188 * lists a number of such touchpads.
190 struct alps_model_info
{
192 struct alps_protocol_info protocol_info
;
196 * struct alps_nibble_commands - encodings for register accesses
197 * @command: PS/2 command used for the nibble
198 * @data: Data supplied as an argument to the PS/2 command, if applicable
200 * The ALPS protocol uses magic sequences to transmit binary data to the
201 * touchpad, as it is generally not OK to send arbitrary bytes out the
202 * PS/2 port. Each of the sequences in this table sends one nibble of the
203 * register address or (write) data. Different versions of the ALPS protocol
204 * use slightly different encodings.
206 struct alps_nibble_commands
{
211 struct alps_bitmap_point
{
217 * struct alps_fields - decoded version of the report packet
218 * @x_map: Bitmap of active X positions for MT.
219 * @y_map: Bitmap of active Y positions for MT.
220 * @fingers: Number of fingers for MT.
221 * @pressure: Pressure.
222 * @st: position for ST.
223 * @mt: position for MT.
224 * @first_mp: Packet is the first of a multi-packet report.
225 * @is_mp: Packet is part of a multi-packet report.
226 * @left: Left touchpad button is active.
227 * @right: Right touchpad button is active.
228 * @middle: Middle touchpad button is active.
229 * @ts_left: Left trackstick button is active.
230 * @ts_right: Right trackstick button is active.
231 * @ts_middle: Middle trackstick button is active.
236 unsigned int fingers
;
239 struct input_mt_pos st
;
240 struct input_mt_pos mt
[MAX_TOUCHES
];
242 unsigned int first_mp
:1;
243 unsigned int is_mp
:1;
246 unsigned int right
:1;
247 unsigned int middle
:1;
249 unsigned int ts_left
:1;
250 unsigned int ts_right
:1;
251 unsigned int ts_middle
:1;
255 * struct alps_data - private data structure for the ALPS driver
256 * @psmouse: Pointer to parent psmouse device
257 * @dev2: Trackstick device (can be NULL).
258 * @dev3: Generic PS/2 mouse (can be NULL, delayed registering).
259 * @phys2: Physical path for the trackstick device.
260 * @phys3: Physical path for the generic PS/2 mouse.
261 * @dev3_register_work: Delayed work for registering PS/2 mouse.
262 * @nibble_commands: Command mapping used for touchpad register accesses.
263 * @addr_command: Command used to tell the touchpad that a register address
265 * @proto_version: Indicates V1/V2/V3/...
266 * @byte0: Helps figure out whether a position report packet matches the
267 * known format for this model. The first byte of the report, ANDed with
268 * mask0, should match byte0.
269 * @mask0: The mask used to check the first byte of the report.
270 * @fw_ver: cached copy of firmware version (EC report)
271 * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
272 * @x_max: Largest possible X position value.
273 * @y_max: Largest possible Y position value.
274 * @x_bits: Number of X bits in the MT bitmap.
275 * @y_bits: Number of Y bits in the MT bitmap.
276 * @hw_init: Protocol-specific hardware init function.
277 * @process_packet: Protocol-specific function to process a report packet.
278 * @decode_fields: Protocol-specific function to read packet bitfields.
279 * @set_abs_params: Protocol-specific function to configure the input_dev.
280 * @prev_fin: Finger bit from previous packet.
281 * @multi_packet: Multi-packet data in progress.
282 * @multi_data: Saved multi-packet data.
283 * @f: Decoded packet data fields.
284 * @quirks: Bitmap of ALPS_QUIRK_*.
285 * @timer: Timer for flushing out the final report packet in the stream.
288 struct psmouse
*psmouse
;
289 struct input_dev
*dev2
;
290 struct input_dev
*dev3
;
293 struct delayed_work dev3_register_work
;
295 /* these are autodetected when the device is identified */
296 const struct alps_nibble_commands
*nibble_commands
;
310 int (*hw_init
)(struct psmouse
*psmouse
);
311 void (*process_packet
)(struct psmouse
*psmouse
);
312 int (*decode_fields
)(struct alps_fields
*f
, unsigned char *p
,
313 struct psmouse
*psmouse
);
314 void (*set_abs_params
)(struct alps_data
*priv
, struct input_dev
*dev1
);
319 unsigned char multi_data
[6];
320 struct alps_fields f
;
322 struct timer_list timer
;
325 #define ALPS_QUIRK_TRACKSTICK_BUTTONS 1 /* trakcstick buttons in trackstick packet */
327 #ifdef CONFIG_MOUSE_PS2_ALPS
328 int alps_detect(struct psmouse
*psmouse
, bool set_properties
);
329 int alps_init(struct psmouse
*psmouse
);
331 inline int alps_detect(struct psmouse
*psmouse
, bool set_properties
)
335 inline int alps_init(struct psmouse
*psmouse
)
339 #endif /* CONFIG_MOUSE_PS2_ALPS */