alps.h 9.9 KB

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