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 */
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 */
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
42 SS4_PACKET_ID_IDLE
= 0,
48 #define SS4_COUNT_PER_ELECTRODE 256
49 #define SS4_NUMSENSOR_XOFFSET 7
50 #define SS4_NUMSENSOR_YOFFSET 7
51 #define SS4_MIN_PITCH_MM 50
53 #define SS4_MASK_NORMAL_BUTTONS 0x07
55 #define SS4_1F_X_V2(_b) ((_b[0] & 0x0007) | \
56 ((_b[1] << 3) & 0x0078) | \
57 ((_b[1] << 2) & 0x0380) | \
58 ((_b[2] << 5) & 0x1C00) \
61 #define SS4_1F_Y_V2(_b) (((_b[2]) & 0x000F) | \
62 ((_b[3] >> 2) & 0x0030) | \
63 ((_b[4] << 6) & 0x03C0) | \
64 ((_b[4] << 5) & 0x0C00) \
67 #define SS4_1F_Z_V2(_b) (((_b[5]) & 0x0F) | \
68 ((_b[5] >> 1) & 0x70) | \
72 #define SS4_1F_LFB_V2(_b) (((_b[2] >> 4) & 0x01) == 0x01)
74 #define SS4_MF_LF_V2(_b, _i) ((_b[1 + (_i) * 3] & 0x0004) == 0x0004)
76 #define SS4_BTN_V2(_b) ((_b[0] >> 5) & SS4_MASK_NORMAL_BUTTONS)
78 #define SS4_STD_MF_X_V2(_b, _i) (((_b[0 + (_i) * 3] << 5) & 0x00E0) | \
79 ((_b[1 + _i * 3] << 5) & 0x1F00) \
82 #define SS4_STD_MF_Y_V2(_b, _i) (((_b[1 + (_i) * 3] << 3) & 0x0010) | \
83 ((_b[2 + (_i) * 3] << 5) & 0x01E0) | \
84 ((_b[2 + (_i) * 3] << 4) & 0x0E00) \
87 #define SS4_BTL_MF_X_V2(_b, _i) (SS4_STD_MF_X_V2(_b, _i) | \
88 ((_b[0 + (_i) * 3] >> 3) & 0x0010) \
91 #define SS4_BTL_MF_Y_V2(_b, _i) (SS4_STD_MF_Y_V2(_b, _i) | \
92 ((_b[0 + (_i) * 3] >> 3) & 0x0008) \
95 #define SS4_MF_Z_V2(_b, _i) (((_b[1 + (_i) * 3]) & 0x0001) | \
96 ((_b[1 + (_i) * 3] >> 1) & 0x0002) \
99 #define SS4_IS_MF_CONTINUE(_b) ((_b[2] & 0x10) == 0x10)
100 #define SS4_IS_5F_DETECTED(_b) ((_b[2] & 0x10) == 0x10)
103 #define SS4_MFPACKET_NO_AX 8160 /* X-Coordinate value */
104 #define SS4_MFPACKET_NO_AY 4080 /* Y-Coordinate value */
105 #define SS4_MFPACKET_NO_AX_BL 8176 /* Buttonless X-Coordinate value */
106 #define SS4_MFPACKET_NO_AY_BL 4088 /* Buttonless Y-Coordinate value */
109 * enum V7_PACKET_ID - defines the packet type for V7
110 * V7_PACKET_ID_IDLE: There's no finger and no button activity.
111 * V7_PACKET_ID_TWO: There's one or two non-resting fingers on touchpad
112 * or there's button activities.
113 * V7_PACKET_ID_MULTI: There are at least three non-resting fingers.
114 * V7_PACKET_ID_NEW: The finger position in slot is not continues from
122 V7_PACKET_ID_UNKNOWN
,
126 * struct alps_protocol_info - information about protocol used by a device
127 * @version: Indicates V1/V2/V3/...
128 * @byte0: Helps figure out whether a position report packet matches the
129 * known format for this model. The first byte of the report, ANDed with
130 * mask0, should match byte0.
131 * @mask0: The mask used to check the first byte of the report.
132 * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
134 struct alps_protocol_info
{
141 * struct alps_model_info - touchpad ID table
142 * @signature: E7 response string to match.
143 * @command_mode_resp: For V3/V4 touchpads, the final byte of the EC response
144 * (aka command mode response) identifies the firmware minor version. This
145 * can be used to distinguish different hardware models which are not
146 * uniquely identifiable through their E7 responses.
147 * @protocol_info: information about protcol used by the device.
149 * Many (but not all) ALPS touchpads can be identified by looking at the
150 * values returned in the "E7 report" and/or the "EC report." This table
151 * lists a number of such touchpads.
153 struct alps_model_info
{
155 u8 command_mode_resp
;
156 struct alps_protocol_info protocol_info
;
160 * struct alps_nibble_commands - encodings for register accesses
161 * @command: PS/2 command used for the nibble
162 * @data: Data supplied as an argument to the PS/2 command, if applicable
164 * The ALPS protocol uses magic sequences to transmit binary data to the
165 * touchpad, as it is generally not OK to send arbitrary bytes out the
166 * PS/2 port. Each of the sequences in this table sends one nibble of the
167 * register address or (write) data. Different versions of the ALPS protocol
168 * use slightly different encodings.
170 struct alps_nibble_commands
{
175 struct alps_bitmap_point
{
181 * struct alps_fields - decoded version of the report packet
182 * @x_map: Bitmap of active X positions for MT.
183 * @y_map: Bitmap of active Y positions for MT.
184 * @fingers: Number of fingers for MT.
185 * @pressure: Pressure.
186 * @st: position for ST.
187 * @mt: position for MT.
188 * @first_mp: Packet is the first of a multi-packet report.
189 * @is_mp: Packet is part of a multi-packet report.
190 * @left: Left touchpad button is active.
191 * @right: Right touchpad button is active.
192 * @middle: Middle touchpad button is active.
193 * @ts_left: Left trackstick button is active.
194 * @ts_right: Right trackstick button is active.
195 * @ts_middle: Middle trackstick button is active.
200 unsigned int fingers
;
203 struct input_mt_pos st
;
204 struct input_mt_pos mt
[MAX_TOUCHES
];
206 unsigned int first_mp
:1;
207 unsigned int is_mp
:1;
210 unsigned int right
:1;
211 unsigned int middle
:1;
213 unsigned int ts_left
:1;
214 unsigned int ts_right
:1;
215 unsigned int ts_middle
:1;
219 * struct alps_data - private data structure for the ALPS driver
220 * @psmouse: Pointer to parent psmouse device
221 * @dev2: Trackstick device (can be NULL).
222 * @dev3: Generic PS/2 mouse (can be NULL, delayed registering).
223 * @phys2: Physical path for the trackstick device.
224 * @phys3: Physical path for the generic PS/2 mouse.
225 * @dev3_register_work: Delayed work for registering PS/2 mouse.
226 * @nibble_commands: Command mapping used for touchpad register accesses.
227 * @addr_command: Command used to tell the touchpad that a register address
229 * @proto_version: Indicates V1/V2/V3/...
230 * @byte0: Helps figure out whether a position report packet matches the
231 * known format for this model. The first byte of the report, ANDed with
232 * mask0, should match byte0.
233 * @mask0: The mask used to check the first byte of the report.
234 * @fw_ver: cached copy of firmware version (EC report)
235 * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
236 * @x_max: Largest possible X position value.
237 * @y_max: Largest possible Y position value.
238 * @x_bits: Number of X bits in the MT bitmap.
239 * @y_bits: Number of Y bits in the MT bitmap.
240 * @hw_init: Protocol-specific hardware init function.
241 * @process_packet: Protocol-specific function to process a report packet.
242 * @decode_fields: Protocol-specific function to read packet bitfields.
243 * @set_abs_params: Protocol-specific function to configure the input_dev.
244 * @prev_fin: Finger bit from previous packet.
245 * @multi_packet: Multi-packet data in progress.
246 * @multi_data: Saved multi-packet data.
247 * @f: Decoded packet data fields.
248 * @quirks: Bitmap of ALPS_QUIRK_*.
249 * @timer: Timer for flushing out the final report packet in the stream.
252 struct psmouse
*psmouse
;
253 struct input_dev
*dev2
;
254 struct input_dev
*dev3
;
257 struct delayed_work dev3_register_work
;
259 /* these are autodetected when the device is identified */
260 const struct alps_nibble_commands
*nibble_commands
;
273 int (*hw_init
)(struct psmouse
*psmouse
);
274 void (*process_packet
)(struct psmouse
*psmouse
);
275 int (*decode_fields
)(struct alps_fields
*f
, unsigned char *p
,
276 struct psmouse
*psmouse
);
277 void (*set_abs_params
)(struct alps_data
*priv
, struct input_dev
*dev1
);
282 unsigned char multi_data
[6];
283 struct alps_fields f
;
285 struct timer_list timer
;
288 #define ALPS_QUIRK_TRACKSTICK_BUTTONS 1 /* trakcstick buttons in trackstick packet */
290 #ifdef CONFIG_MOUSE_PS2_ALPS
291 int alps_detect(struct psmouse
*psmouse
, bool set_properties
);
292 int alps_init(struct psmouse
*psmouse
);
294 inline int alps_detect(struct psmouse
*psmouse
, bool set_properties
)
298 inline int alps_init(struct psmouse
*psmouse
)
302 #endif /* CONFIG_MOUSE_PS2_ALPS */