elantech.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Elantech Touchpad driver (v6)
  4. *
  5. * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
  6. *
  7. * Trademarks are the property of their respective owners.
  8. */
  9. #ifndef _ELANTECH_H
  10. #define _ELANTECH_H
  11. /*
  12. * Command values for Synaptics style queries
  13. */
  14. #define ETP_FW_ID_QUERY 0x00
  15. #define ETP_FW_VERSION_QUERY 0x01
  16. #define ETP_CAPABILITIES_QUERY 0x02
  17. #define ETP_SAMPLE_QUERY 0x03
  18. #define ETP_RESOLUTION_QUERY 0x04
  19. #define ETP_ICBODY_QUERY 0x05
  20. /*
  21. * Command values for register reading or writing
  22. */
  23. #define ETP_REGISTER_READ 0x10
  24. #define ETP_REGISTER_WRITE 0x11
  25. #define ETP_REGISTER_READWRITE 0x00
  26. /*
  27. * Hardware version 2 custom PS/2 command value
  28. */
  29. #define ETP_PS2_CUSTOM_COMMAND 0xf8
  30. /*
  31. * Times to retry a ps2_command and millisecond delay between tries
  32. */
  33. #define ETP_PS2_COMMAND_TRIES 3
  34. #define ETP_PS2_COMMAND_DELAY 500
  35. /*
  36. * Times to try to read back a register and millisecond delay between tries
  37. */
  38. #define ETP_READ_BACK_TRIES 5
  39. #define ETP_READ_BACK_DELAY 2000
  40. /*
  41. * Register bitmasks for hardware version 1
  42. */
  43. #define ETP_R10_ABSOLUTE_MODE 0x04
  44. #define ETP_R11_4_BYTE_MODE 0x02
  45. /*
  46. * Capability bitmasks
  47. */
  48. #define ETP_CAP_HAS_ROCKER 0x04
  49. /*
  50. * One hard to find application note states that X axis range is 0 to 576
  51. * and Y axis range is 0 to 384 for harware version 1.
  52. * Edge fuzz might be necessary because of bezel around the touchpad
  53. */
  54. #define ETP_EDGE_FUZZ_V1 32
  55. #define ETP_XMIN_V1 ( 0 + ETP_EDGE_FUZZ_V1)
  56. #define ETP_XMAX_V1 (576 - ETP_EDGE_FUZZ_V1)
  57. #define ETP_YMIN_V1 ( 0 + ETP_EDGE_FUZZ_V1)
  58. #define ETP_YMAX_V1 (384 - ETP_EDGE_FUZZ_V1)
  59. /*
  60. * The resolution for older v2 hardware doubled.
  61. * (newer v2's firmware provides command so we can query)
  62. */
  63. #define ETP_XMIN_V2 0
  64. #define ETP_XMAX_V2 1152
  65. #define ETP_YMIN_V2 0
  66. #define ETP_YMAX_V2 768
  67. #define ETP_PMIN_V2 0
  68. #define ETP_PMAX_V2 255
  69. #define ETP_WMIN_V2 0
  70. #define ETP_WMAX_V2 15
  71. /*
  72. * v3 hardware has 2 kinds of packet types,
  73. * v4 hardware has 3.
  74. */
  75. #define PACKET_UNKNOWN 0x01
  76. #define PACKET_DEBOUNCE 0x02
  77. #define PACKET_V3_HEAD 0x03
  78. #define PACKET_V3_TAIL 0x04
  79. #define PACKET_V4_HEAD 0x05
  80. #define PACKET_V4_MOTION 0x06
  81. #define PACKET_V4_STATUS 0x07
  82. #define PACKET_TRACKPOINT 0x08
  83. /*
  84. * track up to 5 fingers for v4 hardware
  85. */
  86. #define ETP_MAX_FINGERS 5
  87. /*
  88. * weight value for v4 hardware
  89. */
  90. #define ETP_WEIGHT_VALUE 5
  91. /*
  92. * Bus information on 3rd byte of query ETP_RESOLUTION_QUERY(0x04)
  93. */
  94. #define ETP_BUS_PS2_ONLY 0
  95. #define ETP_BUS_SMB_ALERT_ONLY 1
  96. #define ETP_BUS_SMB_HST_NTFY_ONLY 2
  97. #define ETP_BUS_PS2_SMB_ALERT 3
  98. #define ETP_BUS_PS2_SMB_HST_NTFY 4
  99. /*
  100. * New ICs are either using SMBus Host Notify or just plain PS2.
  101. *
  102. * ETP_FW_VERSION_QUERY is:
  103. * Byte 1:
  104. * - bit 0..3: IC BODY
  105. * Byte 2:
  106. * - bit 4: HiddenButton
  107. * - bit 5: PS2_SMBUS_NOTIFY
  108. * - bit 6: PS2CRCCheck
  109. */
  110. #define ETP_NEW_IC_SMBUS_HOST_NOTIFY(fw_version) \
  111. ((((fw_version) & 0x0f2000) == 0x0f2000) && \
  112. ((fw_version) & 0x0000ff) > 0)
  113. /*
  114. * The base position for one finger, v4 hardware
  115. */
  116. struct finger_pos {
  117. unsigned int x;
  118. unsigned int y;
  119. };
  120. struct elantech_device_info {
  121. unsigned char capabilities[3];
  122. unsigned char samples[3];
  123. unsigned char debug;
  124. unsigned char hw_version;
  125. unsigned char pattern;
  126. unsigned int fw_version;
  127. unsigned int ic_version;
  128. unsigned int product_id;
  129. unsigned int x_min;
  130. unsigned int y_min;
  131. unsigned int x_max;
  132. unsigned int y_max;
  133. unsigned int x_res;
  134. unsigned int y_res;
  135. unsigned int x_traces;
  136. unsigned int y_traces;
  137. unsigned int width;
  138. unsigned int bus;
  139. bool paritycheck;
  140. bool jumpy_cursor;
  141. bool reports_pressure;
  142. bool crc_enabled;
  143. bool set_hw_resolution;
  144. bool has_trackpoint;
  145. bool has_middle_button;
  146. int (*send_cmd)(struct psmouse *psmouse, unsigned char c,
  147. unsigned char *param);
  148. };
  149. struct elantech_data {
  150. struct input_dev *tp_dev; /* Relative device for trackpoint */
  151. char tp_phys[32];
  152. unsigned char reg_07;
  153. unsigned char reg_10;
  154. unsigned char reg_11;
  155. unsigned char reg_20;
  156. unsigned char reg_21;
  157. unsigned char reg_22;
  158. unsigned char reg_23;
  159. unsigned char reg_24;
  160. unsigned char reg_25;
  161. unsigned char reg_26;
  162. unsigned int single_finger_reports;
  163. unsigned int y_max;
  164. unsigned int width;
  165. struct finger_pos mt[ETP_MAX_FINGERS];
  166. unsigned char parity[256];
  167. struct elantech_device_info info;
  168. void (*original_set_rate)(struct psmouse *psmouse, unsigned int rate);
  169. };
  170. int elantech_detect(struct psmouse *psmouse, bool set_properties);
  171. int elantech_init_ps2(struct psmouse *psmouse);
  172. #ifdef CONFIG_MOUSE_PS2_ELANTECH
  173. int elantech_init(struct psmouse *psmouse);
  174. #else
  175. static inline int elantech_init(struct psmouse *psmouse)
  176. {
  177. return -ENOSYS;
  178. }
  179. #endif /* CONFIG_MOUSE_PS2_ELANTECH */
  180. int elantech_init_smbus(struct psmouse *psmouse);
  181. #endif