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