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