xref: /openbmc/linux/drivers/input/mouse/psmouse.h (revision 87c2ce3b)
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	0x03eb
11 #define PSMOUSE_CMD_GETID	0x02f2
12 #define PSMOUSE_CMD_SETRATE	0x10f3
13 #define PSMOUSE_CMD_ENABLE	0x00f4
14 #define PSMOUSE_CMD_DISABLE	0x00f5
15 #define PSMOUSE_CMD_RESET_DIS	0x00f6
16 #define PSMOUSE_CMD_RESET_BAT	0x02ff
17 
18 #define PSMOUSE_RET_BAT		0xaa
19 #define PSMOUSE_RET_ID		0x00
20 #define PSMOUSE_RET_ACK		0xfa
21 #define PSMOUSE_RET_NAK		0xfe
22 
23 enum psmouse_state {
24 	PSMOUSE_IGNORE,
25 	PSMOUSE_INITIALIZING,
26 	PSMOUSE_CMD_MODE,
27 	PSMOUSE_ACTIVATED,
28 };
29 
30 /* psmouse protocol handler return codes */
31 typedef enum {
32 	PSMOUSE_BAD_DATA,
33 	PSMOUSE_GOOD_DATA,
34 	PSMOUSE_FULL_PACKET
35 } psmouse_ret_t;
36 
37 struct psmouse {
38 	void *private;
39 	struct input_dev *dev;
40 	struct ps2dev ps2dev;
41 	char *vendor;
42 	char *name;
43 	unsigned char packet[8];
44 	unsigned char pktcnt;
45 	unsigned char pktsize;
46 	unsigned char type;
47 	unsigned int model;
48 	unsigned long last;
49 	unsigned long out_of_sync;
50 	enum psmouse_state state;
51 	char devname[64];
52 	char phys[32];
53 
54 	unsigned int rate;
55 	unsigned int resolution;
56 	unsigned int resetafter;
57 	unsigned int smartscroll;	/* Logitech only */
58 
59 	psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse, struct pt_regs *regs);
60 	void (*set_rate)(struct psmouse *psmouse, unsigned int rate);
61 	void (*set_resolution)(struct psmouse *psmouse, unsigned int resolution);
62 
63 	int (*reconnect)(struct psmouse *psmouse);
64 	void (*disconnect)(struct psmouse *psmouse);
65 
66 	void (*pt_activate)(struct psmouse *psmouse);
67 	void (*pt_deactivate)(struct psmouse *psmouse);
68 };
69 
70 enum psmouse_type {
71 	PSMOUSE_NONE,
72 	PSMOUSE_PS2,
73 	PSMOUSE_PS2PP,
74 	PSMOUSE_THINKPS,
75 	PSMOUSE_GENPS,
76 	PSMOUSE_IMPS,
77 	PSMOUSE_IMEX,
78 	PSMOUSE_SYNAPTICS,
79 	PSMOUSE_ALPS,
80 	PSMOUSE_LIFEBOOK,
81 	PSMOUSE_TRACKPOINT,
82 	PSMOUSE_AUTO		/* This one should always be last */
83 };
84 
85 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
86 int psmouse_reset(struct psmouse *psmouse);
87 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
88 
89 
90 struct psmouse_attribute {
91 	struct device_attribute dattr;
92 	void *data;
93 	ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
94 	ssize_t (*set)(struct psmouse *psmouse, void *data,
95 			const char *buf, size_t count);
96 };
97 #define to_psmouse_attr(a)	container_of((a), struct psmouse_attribute, dattr)
98 
99 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
100 				 char *buf);
101 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
102 				const char *buf, size_t count);
103 
104 #define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set)			\
105 static ssize_t _show(struct psmouse *, void *data, char *);			\
106 static ssize_t _set(struct psmouse *, void *data, const char *, size_t);	\
107 static struct psmouse_attribute psmouse_attr_##_name = {			\
108 	.dattr	= {								\
109 		.attr	= {							\
110 			.name	= __stringify(_name),				\
111 			.mode	= _mode,					\
112 			.owner	= THIS_MODULE,					\
113 		},								\
114 		.show	= psmouse_attr_show_helper,				\
115 		.store	= psmouse_attr_set_helper,				\
116 	},									\
117 	.data	= _data,							\
118 	.show	= _show,							\
119 	.set	= _set,								\
120 }
121 
122 #endif /* _PSMOUSE_H */
123