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