psmouse.h

   1 #ifndef _PSMOUSE_H
   2 #define _PSMOUSE_H
   3
   4 #define PSMOUSE_CMD_SETSCALE11  0x00e6
   5 #define PSMOUSE_CMD_SETSCALE21  0x00e7
   6 #define PSMOUSE_CMD_SETRES      0x10e8
   7 #define PSMOUSE_CMD_GETINFO     0x03e9
   8 #define PSMOUSE_CMD_SETSTREAM   0x00ea
   9 #define PSMOUSE_CMD_SETPOLL     0x00f0
  10 #define PSMOUSE_CMD_POLL        0x00eb  /* caller sets number of bytes to receive */
  11 #define PSMOUSE_CMD_RESET_WRAP  0x00ec
  12 #define PSMOUSE_CMD_GETID       0x02f2
  13 #define PSMOUSE_CMD_SETRATE     0x10f3
  14 #define PSMOUSE_CMD_ENABLE      0x00f4
  15 #define PSMOUSE_CMD_DISABLE     0x00f5
  16 #define PSMOUSE_CMD_RESET_DIS   0x00f6
  17 #define PSMOUSE_CMD_RESET_BAT   0x02ff
  18
  19 #define PSMOUSE_RET_BAT         0xaa
  20 #define PSMOUSE_RET_ID          0x00
  21 #define PSMOUSE_RET_ACK         0xfa
  22 #define PSMOUSE_RET_NAK         0xfe
  23
  24 enum psmouse_state {
  25         PSMOUSE_IGNORE,
  26         PSMOUSE_INITIALIZING,
  27         PSMOUSE_RESYNCING,
  28         PSMOUSE_CMD_MODE,
  29         PSMOUSE_ACTIVATED,
  30 };
  31
  32 /* psmouse protocol handler return codes */
  33 typedef enum {
  34         PSMOUSE_BAD_DATA,
  35         PSMOUSE_GOOD_DATA,
  36         PSMOUSE_FULL_PACKET
  37 } psmouse_ret_t;
  38
  39 enum psmouse_scale {
  40         PSMOUSE_SCALE11,
  41         PSMOUSE_SCALE21
  42 };
  43
  44 struct psmouse {
  45         void *private;
  46         struct input_dev *dev;
  47         struct ps2dev ps2dev;
  48         struct delayed_work resync_work;
  49         char *vendor;
  50         char *name;
  51         unsigned char packet[8];
  52         unsigned char badbyte;
  53         unsigned char pktcnt;
  54         unsigned char pktsize;
  55         unsigned char type;
  56         bool ignore_parity;
  57         bool acks_disable_command;
  58         unsigned int model;
  59         unsigned long last;
  60         unsigned long out_of_sync_cnt;
  61         unsigned long num_resyncs;
  62         enum psmouse_state state;
  63         char devname[64];
  64         char phys[32];
  65
  66         unsigned int rate;
  67         unsigned int resolution;
  68         unsigned int resetafter;
  69         unsigned int resync_time;
  70         bool smartscroll;       /* Logitech only */
  71
  72         psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse);
  73         void (*set_rate)(struct psmouse *psmouse, unsigned int rate);
  74         void (*set_resolution)(struct psmouse *psmouse, unsigned int resolution);
  75         void (*set_scale)(struct psmouse *psmouse, enum psmouse_scale scale);
  76
  77         int (*reconnect)(struct psmouse *psmouse);
  78         void (*disconnect)(struct psmouse *psmouse);
  79         void (*cleanup)(struct psmouse *psmouse);
  80         int (*poll)(struct psmouse *psmouse);
  81
  82         void (*pt_activate)(struct psmouse *psmouse);
  83         void (*pt_deactivate)(struct psmouse *psmouse);
  84 };
  85
  86 enum psmouse_type {
  87         PSMOUSE_NONE,
  88         PSMOUSE_PS2,
  89         PSMOUSE_PS2PP,
  90         PSMOUSE_THINKPS,
  91         PSMOUSE_GENPS,
  92         PSMOUSE_IMPS,
  93         PSMOUSE_IMEX,
  94         PSMOUSE_SYNAPTICS,
  95         PSMOUSE_ALPS,
  96         PSMOUSE_LIFEBOOK,
  97         PSMOUSE_TRACKPOINT,
  98         PSMOUSE_TOUCHKIT_PS2,
  99         PSMOUSE_CORTRON,
 100         PSMOUSE_HGPK,
 101         PSMOUSE_ELANTECH,
 102         PSMOUSE_FSP,
 103         PSMOUSE_SYNAPTICS_RELATIVE,
 104         PSMOUSE_CYPRESS,
 105         PSMOUSE_FOCALTECH,
 106         PSMOUSE_VMMOUSE,
 107         PSMOUSE_BYD,
 108         PSMOUSE_AUTO            /* This one should always be last */
 109 };
 110
 111 void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
 112                 unsigned long delay);
 113 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
 114 int psmouse_reset(struct psmouse *psmouse);
 115 void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
 116 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
 117 psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
 118 int psmouse_activate(struct psmouse *psmouse);
 119 int psmouse_deactivate(struct psmouse *psmouse);
 120 bool psmouse_matches_pnp_id(struct psmouse *psmouse, const char * const ids[]);
 121
 122 struct psmouse_attribute {
 123         struct device_attribute dattr;
 124         void *data;
 125         ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
 126         ssize_t (*set)(struct psmouse *psmouse, void *data,
 127                         const char *buf, size_t count);
 128         bool protect;
 129 };
 130 #define to_psmouse_attr(a)      container_of((a), struct psmouse_attribute, dattr)
 131
 132 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
 133                                  char *buf);
 134 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
 135                                 const char *buf, size_t count);
 136
 137 #define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)   \
 138 static struct psmouse_attribute psmouse_attr_##_name = {                        \
 139         .dattr  = {                                                             \
 140                 .attr   = {                                                     \
 141                         .name   = __stringify(_name),                           \
 142                         .mode   = _mode,                                        \
 143                 },                                                              \
 144                 .show   = psmouse_attr_show_helper,                             \
 145                 .store  = psmouse_attr_set_helper,                              \
 146         },                                                                      \
 147         .data   = _data,                                                        \
 148         .show   = _show,                                                        \
 149         .set    = _set,                                                         \
 150         .protect = _protect,                                                    \
 151 }
 152
 153 #define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect)       \
 154         static ssize_t _show(struct psmouse *, void *, char *);                 \
 155         static ssize_t _set(struct psmouse *, void *, const char *, size_t);    \
 156         __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
 157
 158 #define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set)                   \
 159         __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
 160
 161 #define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show)                      \
 162         static ssize_t _show(struct psmouse *, void *, char *);                 \
 163         __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
 164
 165 #define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set)                       \
 166         static ssize_t _set(struct psmouse *, void *, const char *, size_t);    \
 167         __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
 168
 169 #ifndef psmouse_fmt
 170 #define psmouse_fmt(fmt)        KBUILD_BASENAME ": " fmt
 171 #endif
 172
 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
 193
 194 #endif /* _PSMOUSE_H */