xref: /openbmc/linux/drivers/input/mouse/psmouse.h (revision 275876e2)
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 struct psmouse {
40 	void *private;
41 	struct input_dev *dev;
42 	struct ps2dev ps2dev;
43 	struct delayed_work resync_work;
44 	char *vendor;
45 	char *name;
46 	unsigned char packet[8];
47 	unsigned char badbyte;
48 	unsigned char pktcnt;
49 	unsigned char pktsize;
50 	unsigned char type;
51 	bool ignore_parity;
52 	bool acks_disable_command;
53 	unsigned int model;
54 	unsigned long last;
55 	unsigned long out_of_sync_cnt;
56 	unsigned long num_resyncs;
57 	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;
64 	unsigned int resync_time;
65 	bool smartscroll;	/* Logitech only */
66 
67 	psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse);
68 	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);
73 	void (*cleanup)(struct psmouse *psmouse);
74 	int (*poll)(struct psmouse *psmouse);
75 
76 	void (*pt_activate)(struct psmouse *psmouse);
77 	void (*pt_deactivate)(struct psmouse *psmouse);
78 };
79 
80 enum 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,
90 	PSMOUSE_LIFEBOOK,
91 	PSMOUSE_TRACKPOINT,
92 	PSMOUSE_TOUCHKIT_PS2,
93 	PSMOUSE_CORTRON,
94 	PSMOUSE_HGPK,
95 	PSMOUSE_ELANTECH,
96 	PSMOUSE_FSP,
97 	PSMOUSE_SYNAPTICS_RELATIVE,
98 	PSMOUSE_CYPRESS,
99 	PSMOUSE_AUTO		/* This one should always be last */
100 };
101 
102 void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
103 		unsigned long delay);
104 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
105 int psmouse_reset(struct psmouse *psmouse);
106 void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
107 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
108 psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
109 int psmouse_activate(struct psmouse *psmouse);
110 int psmouse_deactivate(struct psmouse *psmouse);
111 
112 struct psmouse_attribute {
113 	struct device_attribute dattr;
114 	void *data;
115 	ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
116 	ssize_t (*set)(struct psmouse *psmouse, void *data,
117 			const char *buf, size_t count);
118 	bool protect;
119 };
120 #define to_psmouse_attr(a)	container_of((a), struct psmouse_attribute, dattr)
121 
122 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
123 				 char *buf);
124 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
125 				const char *buf, size_t count);
126 
127 #define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)	\
128 static struct psmouse_attribute psmouse_attr_##_name = {			\
129 	.dattr	= {								\
130 		.attr	= {							\
131 			.name	= __stringify(_name),				\
132 			.mode	= _mode,					\
133 		},								\
134 		.show	= psmouse_attr_show_helper,				\
135 		.store	= psmouse_attr_set_helper,				\
136 	},									\
137 	.data	= _data,							\
138 	.show	= _show,							\
139 	.set	= _set,								\
140 	.protect = _protect,							\
141 }
142 
143 #define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect)	\
144 	static ssize_t _show(struct psmouse *, void *, char *);			\
145 	static ssize_t _set(struct psmouse *, void *, const char *, size_t);	\
146 	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
147 
148 #define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set)			\
149 	__PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
150 
151 #define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show)			\
152 	static ssize_t _show(struct psmouse *, void *, char *);			\
153 	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
154 
155 #define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set)			\
156 	static ssize_t _set(struct psmouse *, void *, const char *, size_t);	\
157 	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
158 
159 #ifndef psmouse_fmt
160 #define psmouse_fmt(fmt)	KBUILD_BASENAME ": " fmt
161 #endif
162 
163 #define psmouse_dbg(psmouse, format, ...)		\
164 	dev_dbg(&(psmouse)->ps2dev.serio->dev,		\
165 		psmouse_fmt(format), ##__VA_ARGS__)
166 #define psmouse_info(psmouse, format, ...)		\
167 	dev_info(&(psmouse)->ps2dev.serio->dev,		\
168 		 psmouse_fmt(format), ##__VA_ARGS__)
169 #define psmouse_warn(psmouse, format, ...)		\
170 	dev_warn(&(psmouse)->ps2dev.serio->dev,		\
171 		 psmouse_fmt(format), ##__VA_ARGS__)
172 #define psmouse_err(psmouse, format, ...)		\
173 	dev_err(&(psmouse)->ps2dev.serio->dev,		\
174 		psmouse_fmt(format), ##__VA_ARGS__)
175 #define psmouse_notice(psmouse, format, ...)		\
176 	dev_notice(&(psmouse)->ps2dev.serio->dev,	\
177 		   psmouse_fmt(format), ##__VA_ARGS__)
178 #define psmouse_printk(level, psmouse, format, ...)	\
179 	dev_printk(level,				\
180 		   &(psmouse)->ps2dev.serio->dev,	\
181 		   psmouse_fmt(format), ##__VA_ARGS__)
182 
183 
184 #endif /* _PSMOUSE_H */
185