psmouse.h 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _PSMOUSE_H
  3. #define _PSMOUSE_H
  4. #define PSMOUSE_OOB_NONE 0x00
  5. #define PSMOUSE_OOB_EXTRA_BTNS 0x01
  6. #define PSMOUSE_CMD_SETSCALE11 0x00e6
  7. #define PSMOUSE_CMD_SETSCALE21 0x00e7
  8. #define PSMOUSE_CMD_SETRES 0x10e8
  9. #define PSMOUSE_CMD_GETINFO 0x03e9
  10. #define PSMOUSE_CMD_SETSTREAM 0x00ea
  11. #define PSMOUSE_CMD_SETPOLL 0x00f0
  12. #define PSMOUSE_CMD_POLL 0x00eb /* caller sets number of bytes to receive */
  13. #define PSMOUSE_CMD_RESET_WRAP 0x00ec
  14. #define PSMOUSE_CMD_GETID 0x02f2
  15. #define PSMOUSE_CMD_SETRATE 0x10f3
  16. #define PSMOUSE_CMD_ENABLE 0x00f4
  17. #define PSMOUSE_CMD_DISABLE 0x00f5
  18. #define PSMOUSE_CMD_RESET_DIS 0x00f6
  19. #define PSMOUSE_CMD_RESET_BAT 0x02ff
  20. #define PSMOUSE_RET_BAT 0xaa
  21. #define PSMOUSE_RET_ID 0x00
  22. #define PSMOUSE_RET_ACK 0xfa
  23. #define PSMOUSE_RET_NAK 0xfe
  24. enum psmouse_state {
  25. PSMOUSE_IGNORE,
  26. PSMOUSE_INITIALIZING,
  27. PSMOUSE_RESYNCING,
  28. PSMOUSE_CMD_MODE,
  29. PSMOUSE_ACTIVATED,
  30. };
  31. /* psmouse protocol handler return codes */
  32. typedef enum {
  33. PSMOUSE_BAD_DATA,
  34. PSMOUSE_GOOD_DATA,
  35. PSMOUSE_FULL_PACKET
  36. } psmouse_ret_t;
  37. enum psmouse_scale {
  38. PSMOUSE_SCALE11,
  39. PSMOUSE_SCALE21
  40. };
  41. enum psmouse_type {
  42. PSMOUSE_NONE,
  43. PSMOUSE_PS2,
  44. PSMOUSE_PS2PP,
  45. PSMOUSE_THINKPS,
  46. PSMOUSE_GENPS,
  47. PSMOUSE_IMPS,
  48. PSMOUSE_IMEX,
  49. PSMOUSE_SYNAPTICS,
  50. PSMOUSE_ALPS,
  51. PSMOUSE_LIFEBOOK,
  52. PSMOUSE_TRACKPOINT,
  53. PSMOUSE_TOUCHKIT_PS2,
  54. PSMOUSE_CORTRON,
  55. PSMOUSE_HGPK,
  56. PSMOUSE_ELANTECH,
  57. PSMOUSE_FSP,
  58. PSMOUSE_SYNAPTICS_RELATIVE,
  59. PSMOUSE_CYPRESS,
  60. PSMOUSE_FOCALTECH,
  61. PSMOUSE_VMMOUSE,
  62. PSMOUSE_BYD,
  63. PSMOUSE_SYNAPTICS_SMBUS,
  64. PSMOUSE_ELANTECH_SMBUS,
  65. PSMOUSE_AUTO /* This one should always be last */
  66. };
  67. struct psmouse;
  68. struct psmouse_protocol {
  69. enum psmouse_type type;
  70. bool maxproto;
  71. bool ignore_parity; /* Protocol should ignore parity errors from KBC */
  72. bool try_passthru; /* Try protocol also on passthrough ports */
  73. bool smbus_companion; /* "Protocol" is a stub, device is on SMBus */
  74. const char *name;
  75. const char *alias;
  76. int (*detect)(struct psmouse *, bool);
  77. int (*init)(struct psmouse *);
  78. };
  79. struct psmouse {
  80. void *private;
  81. struct input_dev *dev;
  82. struct ps2dev ps2dev;
  83. struct delayed_work resync_work;
  84. const char *vendor;
  85. const char *name;
  86. const struct psmouse_protocol *protocol;
  87. unsigned char packet[8];
  88. unsigned char badbyte;
  89. unsigned char pktcnt;
  90. unsigned char pktsize;
  91. unsigned char oob_data_type;
  92. unsigned char extra_buttons;
  93. bool acks_disable_command;
  94. unsigned int model;
  95. unsigned long last;
  96. unsigned long out_of_sync_cnt;
  97. unsigned long num_resyncs;
  98. enum psmouse_state state;
  99. char devname[64];
  100. char phys[32];
  101. unsigned int rate;
  102. unsigned int resolution;
  103. unsigned int resetafter;
  104. unsigned int resync_time;
  105. bool smartscroll; /* Logitech only */
  106. psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse);
  107. void (*set_rate)(struct psmouse *psmouse, unsigned int rate);
  108. void (*set_resolution)(struct psmouse *psmouse, unsigned int resolution);
  109. void (*set_scale)(struct psmouse *psmouse, enum psmouse_scale scale);
  110. int (*reconnect)(struct psmouse *psmouse);
  111. int (*fast_reconnect)(struct psmouse *psmouse);
  112. void (*disconnect)(struct psmouse *psmouse);
  113. void (*cleanup)(struct psmouse *psmouse);
  114. int (*poll)(struct psmouse *psmouse);
  115. void (*pt_activate)(struct psmouse *psmouse);
  116. void (*pt_deactivate)(struct psmouse *psmouse);
  117. };
  118. void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
  119. unsigned long delay);
  120. int psmouse_reset(struct psmouse *psmouse);
  121. void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
  122. void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
  123. psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
  124. int psmouse_activate(struct psmouse *psmouse);
  125. int psmouse_deactivate(struct psmouse *psmouse);
  126. bool psmouse_matches_pnp_id(struct psmouse *psmouse, const char * const ids[]);
  127. void psmouse_report_standard_buttons(struct input_dev *, u8 buttons);
  128. void psmouse_report_standard_motion(struct input_dev *, u8 *packet);
  129. void psmouse_report_standard_packet(struct input_dev *, u8 *packet);
  130. struct psmouse_attribute {
  131. struct device_attribute dattr;
  132. void *data;
  133. ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
  134. ssize_t (*set)(struct psmouse *psmouse, void *data,
  135. const char *buf, size_t count);
  136. bool protect;
  137. };
  138. #define to_psmouse_attr(a) container_of((a), struct psmouse_attribute, dattr)
  139. ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
  140. char *buf);
  141. ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
  142. const char *buf, size_t count);
  143. #define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect) \
  144. static struct psmouse_attribute psmouse_attr_##_name = { \
  145. .dattr = { \
  146. .attr = { \
  147. .name = __stringify(_name), \
  148. .mode = _mode, \
  149. }, \
  150. .show = psmouse_attr_show_helper, \
  151. .store = psmouse_attr_set_helper, \
  152. }, \
  153. .data = _data, \
  154. .show = _show, \
  155. .set = _set, \
  156. .protect = _protect, \
  157. }
  158. #define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect) \
  159. static ssize_t _show(struct psmouse *, void *, char *); \
  160. static ssize_t _set(struct psmouse *, void *, const char *, size_t); \
  161. __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
  162. #define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set) \
  163. __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
  164. #define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show) \
  165. static ssize_t _show(struct psmouse *, void *, char *); \
  166. __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
  167. #define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set) \
  168. static ssize_t _set(struct psmouse *, void *, const char *, size_t); \
  169. __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
  170. #ifndef psmouse_fmt
  171. #define psmouse_fmt(fmt) KBUILD_BASENAME ": " fmt
  172. #endif
  173. #define psmouse_dbg(psmouse, format, ...) \
  174. dev_dbg(&(psmouse)->ps2dev.serio->dev, \
  175. psmouse_fmt(format), ##__VA_ARGS__)
  176. #define psmouse_info(psmouse, format, ...) \
  177. dev_info(&(psmouse)->ps2dev.serio->dev, \
  178. psmouse_fmt(format), ##__VA_ARGS__)
  179. #define psmouse_warn(psmouse, format, ...) \
  180. dev_warn(&(psmouse)->ps2dev.serio->dev, \
  181. psmouse_fmt(format), ##__VA_ARGS__)
  182. #define psmouse_err(psmouse, format, ...) \
  183. dev_err(&(psmouse)->ps2dev.serio->dev, \
  184. psmouse_fmt(format), ##__VA_ARGS__)
  185. #define psmouse_notice(psmouse, format, ...) \
  186. dev_notice(&(psmouse)->ps2dev.serio->dev, \
  187. psmouse_fmt(format), ##__VA_ARGS__)
  188. #define psmouse_printk(level, psmouse, format, ...) \
  189. dev_printk(level, \
  190. &(psmouse)->ps2dev.serio->dev, \
  191. psmouse_fmt(format), ##__VA_ARGS__)
  192. #ifdef CONFIG_MOUSE_PS2_SMBUS
  193. int psmouse_smbus_module_init(void);
  194. void psmouse_smbus_module_exit(void);
  195. struct i2c_board_info;
  196. int psmouse_smbus_init(struct psmouse *psmouse,
  197. const struct i2c_board_info *board,
  198. const void *pdata, size_t pdata_size,
  199. bool need_deactivate,
  200. bool leave_breadcrumbs);
  201. void psmouse_smbus_cleanup(struct psmouse *psmouse);
  202. #else /* !CONFIG_MOUSE_PS2_SMBUS */
  203. static inline int psmouse_smbus_module_init(void)
  204. {
  205. return 0;
  206. }
  207. static inline void psmouse_smbus_module_exit(void)
  208. {
  209. }
  210. static inline void psmouse_smbus_cleanup(struct psmouse *psmouse)
  211. {
  212. }
  213. #endif /* CONFIG_MOUSE_PS2_SMBUS */
  214. #endif /* _PSMOUSE_H */