Back to home page

OSCL-LXR
 
 

     

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef _PSMOUSE_H
0003 #define _PSMOUSE_H
0004 
0005 #define PSMOUSE_OOB_NONE    0x00
0006 #define PSMOUSE_OOB_EXTRA_BTNS  0x01
0007 
0008 #define PSMOUSE_CMD_SETSCALE11  0x00e6
0009 #define PSMOUSE_CMD_SETSCALE21  0x00e7
0010 #define PSMOUSE_CMD_SETRES  0x10e8
0011 #define PSMOUSE_CMD_GETINFO 0x03e9
0012 #define PSMOUSE_CMD_SETSTREAM   0x00ea
0013 #define PSMOUSE_CMD_SETPOLL 0x00f0
0014 #define PSMOUSE_CMD_POLL    0x00eb  /* caller sets number of bytes to receive */
0015 #define PSMOUSE_CMD_RESET_WRAP  0x00ec
0016 #define PSMOUSE_CMD_GETID   0x02f2
0017 #define PSMOUSE_CMD_SETRATE 0x10f3
0018 #define PSMOUSE_CMD_ENABLE  0x00f4
0019 #define PSMOUSE_CMD_DISABLE 0x00f5
0020 #define PSMOUSE_CMD_RESET_DIS   0x00f6
0021 #define PSMOUSE_CMD_RESET_BAT   0x02ff
0022 
0023 #define PSMOUSE_RET_BAT     0xaa
0024 #define PSMOUSE_RET_ID      0x00
0025 #define PSMOUSE_RET_ACK     0xfa
0026 #define PSMOUSE_RET_NAK     0xfe
0027 
0028 enum psmouse_state {
0029     PSMOUSE_IGNORE,
0030     PSMOUSE_INITIALIZING,
0031     PSMOUSE_RESYNCING,
0032     PSMOUSE_CMD_MODE,
0033     PSMOUSE_ACTIVATED,
0034 };
0035 
0036 /* psmouse protocol handler return codes */
0037 typedef enum {
0038     PSMOUSE_BAD_DATA,
0039     PSMOUSE_GOOD_DATA,
0040     PSMOUSE_FULL_PACKET
0041 } psmouse_ret_t;
0042 
0043 enum psmouse_scale {
0044     PSMOUSE_SCALE11,
0045     PSMOUSE_SCALE21
0046 };
0047 
0048 enum psmouse_type {
0049     PSMOUSE_NONE,
0050     PSMOUSE_PS2,
0051     PSMOUSE_PS2PP,
0052     PSMOUSE_THINKPS,
0053     PSMOUSE_GENPS,
0054     PSMOUSE_IMPS,
0055     PSMOUSE_IMEX,
0056     PSMOUSE_SYNAPTICS,
0057     PSMOUSE_ALPS,
0058     PSMOUSE_LIFEBOOK,
0059     PSMOUSE_TRACKPOINT,
0060     PSMOUSE_TOUCHKIT_PS2,
0061     PSMOUSE_CORTRON,
0062     PSMOUSE_HGPK,
0063     PSMOUSE_ELANTECH,
0064     PSMOUSE_FSP,
0065     PSMOUSE_SYNAPTICS_RELATIVE,
0066     PSMOUSE_CYPRESS,
0067     PSMOUSE_FOCALTECH,
0068     PSMOUSE_VMMOUSE,
0069     PSMOUSE_BYD,
0070     PSMOUSE_SYNAPTICS_SMBUS,
0071     PSMOUSE_ELANTECH_SMBUS,
0072     PSMOUSE_AUTO        /* This one should always be last */
0073 };
0074 
0075 struct psmouse;
0076 
0077 struct psmouse_protocol {
0078     enum psmouse_type type;
0079     bool maxproto;
0080     bool ignore_parity; /* Protocol should ignore parity errors from KBC */
0081     bool try_passthru; /* Try protocol also on passthrough ports */
0082     bool smbus_companion; /* "Protocol" is a stub, device is on SMBus */
0083     const char *name;
0084     const char *alias;
0085     int (*detect)(struct psmouse *, bool);
0086     int (*init)(struct psmouse *);
0087 };
0088 
0089 struct psmouse {
0090     void *private;
0091     struct input_dev *dev;
0092     struct ps2dev ps2dev;
0093     struct delayed_work resync_work;
0094     const char *vendor;
0095     const char *name;
0096     const struct psmouse_protocol *protocol;
0097     unsigned char packet[8];
0098     unsigned char badbyte;
0099     unsigned char pktcnt;
0100     unsigned char pktsize;
0101     unsigned char oob_data_type;
0102     unsigned char extra_buttons;
0103     bool acks_disable_command;
0104     unsigned int model;
0105     unsigned long last;
0106     unsigned long out_of_sync_cnt;
0107     unsigned long num_resyncs;
0108     enum psmouse_state state;
0109     char devname[64];
0110     char phys[32];
0111 
0112     unsigned int rate;
0113     unsigned int resolution;
0114     unsigned int resetafter;
0115     unsigned int resync_time;
0116     bool smartscroll;   /* Logitech only */
0117 
0118     psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse);
0119     void (*set_rate)(struct psmouse *psmouse, unsigned int rate);
0120     void (*set_resolution)(struct psmouse *psmouse, unsigned int resolution);
0121     void (*set_scale)(struct psmouse *psmouse, enum psmouse_scale scale);
0122 
0123     int (*reconnect)(struct psmouse *psmouse);
0124     int (*fast_reconnect)(struct psmouse *psmouse);
0125     void (*disconnect)(struct psmouse *psmouse);
0126     void (*cleanup)(struct psmouse *psmouse);
0127     int (*poll)(struct psmouse *psmouse);
0128 
0129     void (*pt_activate)(struct psmouse *psmouse);
0130     void (*pt_deactivate)(struct psmouse *psmouse);
0131 };
0132 
0133 void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
0134         unsigned long delay);
0135 int psmouse_reset(struct psmouse *psmouse);
0136 void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
0137 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
0138 psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
0139 int psmouse_activate(struct psmouse *psmouse);
0140 int psmouse_deactivate(struct psmouse *psmouse);
0141 bool psmouse_matches_pnp_id(struct psmouse *psmouse, const char * const ids[]);
0142 
0143 void psmouse_report_standard_buttons(struct input_dev *, u8 buttons);
0144 void psmouse_report_standard_motion(struct input_dev *, u8 *packet);
0145 void psmouse_report_standard_packet(struct input_dev *, u8 *packet);
0146 
0147 struct psmouse_attribute {
0148     struct device_attribute dattr;
0149     void *data;
0150     ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
0151     ssize_t (*set)(struct psmouse *psmouse, void *data,
0152             const char *buf, size_t count);
0153     bool protect;
0154 };
0155 #define to_psmouse_attr(a)  container_of((a), struct psmouse_attribute, dattr)
0156 
0157 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
0158                  char *buf);
0159 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
0160                 const char *buf, size_t count);
0161 
0162 #define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)   \
0163 static struct psmouse_attribute psmouse_attr_##_name = {            \
0164     .dattr  = {                             \
0165         .attr   = {                         \
0166             .name   = __stringify(_name),               \
0167             .mode   = _mode,                    \
0168         },                              \
0169         .show   = psmouse_attr_show_helper,             \
0170         .store  = psmouse_attr_set_helper,              \
0171     },                                  \
0172     .data   = _data,                            \
0173     .show   = _show,                            \
0174     .set    = _set,                             \
0175     .protect = _protect,                            \
0176 }
0177 
0178 #define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect)   \
0179     static ssize_t _show(struct psmouse *, void *, char *);         \
0180     static ssize_t _set(struct psmouse *, void *, const char *, size_t);    \
0181     __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
0182 
0183 #define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set)           \
0184     __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
0185 
0186 #define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show)          \
0187     static ssize_t _show(struct psmouse *, void *, char *);         \
0188     __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
0189 
0190 #define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set)           \
0191     static ssize_t _set(struct psmouse *, void *, const char *, size_t);    \
0192     __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
0193 
0194 #ifndef psmouse_fmt
0195 #define psmouse_fmt(fmt)    KBUILD_BASENAME ": " fmt
0196 #endif
0197 
0198 #define psmouse_dbg(psmouse, format, ...)       \
0199     dev_dbg(&(psmouse)->ps2dev.serio->dev,      \
0200         psmouse_fmt(format), ##__VA_ARGS__)
0201 #define psmouse_info(psmouse, format, ...)      \
0202     dev_info(&(psmouse)->ps2dev.serio->dev,     \
0203          psmouse_fmt(format), ##__VA_ARGS__)
0204 #define psmouse_warn(psmouse, format, ...)      \
0205     dev_warn(&(psmouse)->ps2dev.serio->dev,     \
0206          psmouse_fmt(format), ##__VA_ARGS__)
0207 #define psmouse_err(psmouse, format, ...)       \
0208     dev_err(&(psmouse)->ps2dev.serio->dev,      \
0209         psmouse_fmt(format), ##__VA_ARGS__)
0210 #define psmouse_notice(psmouse, format, ...)        \
0211     dev_notice(&(psmouse)->ps2dev.serio->dev,   \
0212            psmouse_fmt(format), ##__VA_ARGS__)
0213 #define psmouse_printk(level, psmouse, format, ...) \
0214     dev_printk(level,               \
0215            &(psmouse)->ps2dev.serio->dev,   \
0216            psmouse_fmt(format), ##__VA_ARGS__)
0217 
0218 #ifdef CONFIG_MOUSE_PS2_SMBUS
0219 
0220 int psmouse_smbus_module_init(void);
0221 void psmouse_smbus_module_exit(void);
0222 
0223 struct i2c_board_info;
0224 
0225 int psmouse_smbus_init(struct psmouse *psmouse,
0226                const struct i2c_board_info *board,
0227                const void *pdata, size_t pdata_size,
0228                bool need_deactivate,
0229                bool leave_breadcrumbs);
0230 void psmouse_smbus_cleanup(struct psmouse *psmouse);
0231 
0232 #else /* !CONFIG_MOUSE_PS2_SMBUS */
0233 
0234 static inline int psmouse_smbus_module_init(void)
0235 {
0236     return 0;
0237 }
0238 
0239 static inline void psmouse_smbus_module_exit(void)
0240 {
0241 }
0242 
0243 static inline void psmouse_smbus_cleanup(struct psmouse *psmouse)
0244 {
0245 }
0246 
0247 #endif /* CONFIG_MOUSE_PS2_SMBUS */
0248 
0249 #endif /* _PSMOUSE_H */
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!