blob: fe1df231ba4c8dfc07488fd6d4fe1031344e0f76 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
Dmitry Torokhovf0d5c6f42006-01-14 00:27:37 -050010#define PSMOUSE_CMD_POLL 0x00eb /* caller sets number of bytes to receive */
Seth Forshee25bded72011-11-07 19:53:36 -080011#define PSMOUSE_CMD_RESET_WRAP 0x00ec
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#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
24enum psmouse_state {
25 PSMOUSE_IGNORE,
26 PSMOUSE_INITIALIZING,
Dmitry Torokhovf0d5c6f42006-01-14 00:27:37 -050027 PSMOUSE_RESYNCING,
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 PSMOUSE_CMD_MODE,
29 PSMOUSE_ACTIVATED,
30};
31
32/* psmouse protocol handler return codes */
33typedef enum {
34 PSMOUSE_BAD_DATA,
35 PSMOUSE_GOOD_DATA,
36 PSMOUSE_FULL_PACKET
37} psmouse_ret_t;
38
39struct psmouse {
40 void *private;
Dmitry Torokhov2e5b6362005-09-15 02:01:44 -050041 struct input_dev *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 struct ps2dev ps2dev;
Andres Salomon8bf020e2008-09-16 12:30:33 -040043 struct delayed_work resync_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 char *vendor;
45 char *name;
46 unsigned char packet[8];
Dmitry Torokhovf0d5c6f42006-01-14 00:27:37 -050047 unsigned char badbyte;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 unsigned char pktcnt;
49 unsigned char pktsize;
50 unsigned char type;
Dmitry Torokhov6b9d363c2010-04-19 00:42:16 -070051 bool ignore_parity;
Dmitry Torokhovb7802c52009-09-09 19:13:20 -070052 bool acks_disable_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 unsigned int model;
54 unsigned long last;
Dmitry Torokhovb7802c52009-09-09 19:13:20 -070055 unsigned long out_of_sync_cnt;
Dmitry Torokhovf0d5c6f42006-01-14 00:27:37 -050056 unsigned long num_resyncs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 enum psmouse_state state;
58 char devname[64];
59 char phys[32];
60
61 unsigned int rate;
62 unsigned int resolution;
63 unsigned int resetafter;
Dmitry Torokhovf0d5c6f42006-01-14 00:27:37 -050064 unsigned int resync_time;
Dmitry Torokhovb7802c52009-09-09 19:13:20 -070065 bool smartscroll; /* Logitech only */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
David Howells7d12e782006-10-05 14:55:46 +010067 psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 void (*set_rate)(struct psmouse *psmouse, unsigned int rate);
69 void (*set_resolution)(struct psmouse *psmouse, unsigned int resolution);
70
71 int (*reconnect)(struct psmouse *psmouse);
72 void (*disconnect)(struct psmouse *psmouse);
Dmitry Torokhova1cec062007-02-18 01:40:24 -050073 void (*cleanup)(struct psmouse *psmouse);
Dmitry Torokhovf0d5c6f42006-01-14 00:27:37 -050074 int (*poll)(struct psmouse *psmouse);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76 void (*pt_activate)(struct psmouse *psmouse);
77 void (*pt_deactivate)(struct psmouse *psmouse);
78};
79
80enum psmouse_type {
81 PSMOUSE_NONE,
82 PSMOUSE_PS2,
83 PSMOUSE_PS2PP,
84 PSMOUSE_THINKPS,
85 PSMOUSE_GENPS,
86 PSMOUSE_IMPS,
87 PSMOUSE_IMEX,
88 PSMOUSE_SYNAPTICS,
89 PSMOUSE_ALPS,
Kenan Esau02d7f582005-05-29 02:30:22 -050090 PSMOUSE_LIFEBOOK,
Stephen Evanchik541e3162005-08-08 01:26:18 -050091 PSMOUSE_TRACKPOINT,
Stefan Lucke24bf10a2007-02-18 01:49:10 -050092 PSMOUSE_TOUCHKIT_PS2,
Aristeu Rozanskiaea6a462007-05-10 01:47:18 -040093 PSMOUSE_CORTRON,
Andres Salomondf08ef22008-09-16 12:30:34 -040094 PSMOUSE_HGPK,
Arjan Opmeer2a0bd752008-10-16 22:10:19 -040095 PSMOUSE_ELANTECH,
Tai-hwa Liangfc69f4a2009-05-10 18:15:39 -070096 PSMOUSE_FSP,
Daniel Drake7968a5d2011-11-08 00:00:35 -080097 PSMOUSE_SYNAPTICS_RELATIVE,
Dmitry Torokhovdbf4ccd2005-06-01 02:40:01 -050098 PSMOUSE_AUTO /* This one should always be last */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099};
100
Andres Salomon8bf020e2008-09-16 12:30:33 -0400101void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
102 unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
104int psmouse_reset(struct psmouse *psmouse);
Andres Salomona48cf5f2008-09-16 12:30:33 -0400105void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
Daniel Drake7968a5d2011-11-08 00:00:35 -0800107psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
Andres Salomonbd26f3d2012-02-24 00:51:37 -0800108int psmouse_activate(struct psmouse *psmouse);
109int psmouse_deactivate(struct psmouse *psmouse);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Dmitry Torokhovcfe9e882005-09-04 01:40:20 -0500111struct psmouse_attribute {
112 struct device_attribute dattr;
113 void *data;
114 ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
115 ssize_t (*set)(struct psmouse *psmouse, void *data,
116 const char *buf, size_t count);
Dmitry Torokhovb7802c52009-09-09 19:13:20 -0700117 bool protect;
Dmitry Torokhovcfe9e882005-09-04 01:40:20 -0500118};
119#define to_psmouse_attr(a) container_of((a), struct psmouse_attribute, dattr)
120
121ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
122 char *buf);
123ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
124 const char *buf, size_t count);
125
Dmitry Torokhov3b720942009-08-18 11:45:02 -0700126#define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect) \
Dmitry Torokhovcfe9e882005-09-04 01:40:20 -0500127static struct psmouse_attribute psmouse_attr_##_name = { \
128 .dattr = { \
129 .attr = { \
130 .name = __stringify(_name), \
131 .mode = _mode, \
Dmitry Torokhovcfe9e882005-09-04 01:40:20 -0500132 }, \
133 .show = psmouse_attr_show_helper, \
134 .store = psmouse_attr_set_helper, \
135 }, \
136 .data = _data, \
137 .show = _show, \
138 .set = _set, \
Andres Salomon68d48222008-09-16 12:30:34 -0400139 .protect = _protect, \
Dmitry Torokhovcfe9e882005-09-04 01:40:20 -0500140}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Dmitry Torokhov3b720942009-08-18 11:45:02 -0700142#define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect) \
143 static ssize_t _show(struct psmouse *, void *, char *); \
144 static ssize_t _set(struct psmouse *, void *, const char *, size_t); \
145 __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
146
147#define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set) \
Dmitry Torokhovb7802c52009-09-09 19:13:20 -0700148 __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
Dmitry Torokhov3b720942009-08-18 11:45:02 -0700149
150#define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show) \
151 static ssize_t _show(struct psmouse *, void *, char *); \
Dmitry Torokhovb7802c52009-09-09 19:13:20 -0700152 __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
Dmitry Torokhov3b720942009-08-18 11:45:02 -0700153
154#define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set) \
155 static ssize_t _set(struct psmouse *, void *, const char *, size_t); \
Dmitry Torokhovb7802c52009-09-09 19:13:20 -0700156 __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
Andres Salomon68d48222008-09-16 12:30:34 -0400157
Dmitry Torokhovb5d21702011-10-10 18:27:03 -0700158#ifndef psmouse_fmt
159#define psmouse_fmt(fmt) KBUILD_BASENAME ": " fmt
160#endif
161
162#define psmouse_dbg(psmouse, format, ...) \
163 dev_dbg(&(psmouse)->ps2dev.serio->dev, \
164 psmouse_fmt(format), ##__VA_ARGS__)
165#define psmouse_info(psmouse, format, ...) \
166 dev_info(&(psmouse)->ps2dev.serio->dev, \
167 psmouse_fmt(format), ##__VA_ARGS__)
168#define psmouse_warn(psmouse, format, ...) \
169 dev_warn(&(psmouse)->ps2dev.serio->dev, \
170 psmouse_fmt(format), ##__VA_ARGS__)
171#define psmouse_err(psmouse, format, ...) \
172 dev_err(&(psmouse)->ps2dev.serio->dev, \
173 psmouse_fmt(format), ##__VA_ARGS__)
174#define psmouse_notice(psmouse, format, ...) \
175 dev_notice(&(psmouse)->ps2dev.serio->dev, \
176 psmouse_fmt(format), ##__VA_ARGS__)
177#define psmouse_printk(level, psmouse, format, ...) \
178 dev_printk(level, \
179 &(psmouse)->ps2dev.serio->dev, \
180 psmouse_fmt(format), ##__VA_ARGS__)
181
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183#endif /* _PSMOUSE_H */