[mirror_ubuntu-bionic-kernel.git] / drivers / input / mouse / psmouse.h

#ifndef _PSMOUSE_H
#define _PSMOUSE_H

#define PSMOUSE_OOB_NONE	0x00
#define PSMOUSE_OOB_EXTRA_BTNS	0x01

#define PSMOUSE_CMD_SETSCALE11	0x00e6
#define PSMOUSE_CMD_SETSCALE21	0x00e7
#define PSMOUSE_CMD_SETRES	0x10e8
#define PSMOUSE_CMD_GETINFO	0x03e9
#define PSMOUSE_CMD_SETSTREAM	0x00ea
#define PSMOUSE_CMD_SETPOLL	0x00f0
#define PSMOUSE_CMD_POLL	0x00eb	/* caller sets number of bytes to receive */
#define PSMOUSE_CMD_RESET_WRAP	0x00ec
#define PSMOUSE_CMD_GETID	0x02f2
#define PSMOUSE_CMD_SETRATE	0x10f3
#define PSMOUSE_CMD_ENABLE	0x00f4
#define PSMOUSE_CMD_DISABLE	0x00f5
#define PSMOUSE_CMD_RESET_DIS	0x00f6
#define PSMOUSE_CMD_RESET_BAT	0x02ff

#define PSMOUSE_RET_BAT		0xaa
#define PSMOUSE_RET_ID		0x00
#define PSMOUSE_RET_ACK		0xfa
#define PSMOUSE_RET_NAK		0xfe

enum psmouse_state {
	PSMOUSE_IGNORE,
	PSMOUSE_INITIALIZING,
	PSMOUSE_RESYNCING,
	PSMOUSE_CMD_MODE,
	PSMOUSE_ACTIVATED,
};

/* psmouse protocol handler return codes */
typedef enum {
	PSMOUSE_BAD_DATA,
	PSMOUSE_GOOD_DATA,
	PSMOUSE_FULL_PACKET
} psmouse_ret_t;

enum psmouse_scale {
	PSMOUSE_SCALE11,
	PSMOUSE_SCALE21
};

struct psmouse {
	void *private;
	struct input_dev *dev;
	struct ps2dev ps2dev;
	struct delayed_work resync_work;
	char *vendor;
	char *name;
	unsigned char packet[8];
	unsigned char badbyte;
	unsigned char pktcnt;
	unsigned char pktsize;
	unsigned char type;
	unsigned char oob_data_type;
	unsigned char extra_buttons;
	bool ignore_parity;
	bool acks_disable_command;
	unsigned int model;
	unsigned long last;
	unsigned long out_of_sync_cnt;
	unsigned long num_resyncs;
	enum psmouse_state state;
	char devname[64];
	char phys[32];

	unsigned int rate;
	unsigned int resolution;
	unsigned int resetafter;
	unsigned int resync_time;
	bool smartscroll;	/* Logitech only */

	psmouse_ret_t (*protocol_handler)(struct psmouse *psmouse);
	void (*set_rate)(struct psmouse *psmouse, unsigned int rate);
	void (*set_resolution)(struct psmouse *psmouse, unsigned int resolution);
	void (*set_scale)(struct psmouse *psmouse, enum psmouse_scale scale);

	int (*reconnect)(struct psmouse *psmouse);
	void (*disconnect)(struct psmouse *psmouse);
	void (*cleanup)(struct psmouse *psmouse);
	int (*poll)(struct psmouse *psmouse);

	void (*pt_activate)(struct psmouse *psmouse);
	void (*pt_deactivate)(struct psmouse *psmouse);
};

enum psmouse_type {
	PSMOUSE_NONE,
	PSMOUSE_PS2,
	PSMOUSE_PS2PP,
	PSMOUSE_THINKPS,
	PSMOUSE_GENPS,
	PSMOUSE_IMPS,
	PSMOUSE_IMEX,
	PSMOUSE_SYNAPTICS,
	PSMOUSE_ALPS,
	PSMOUSE_LIFEBOOK,
	PSMOUSE_TRACKPOINT,
	PSMOUSE_TOUCHKIT_PS2,
	PSMOUSE_CORTRON,
	PSMOUSE_HGPK,
	PSMOUSE_ELANTECH,
	PSMOUSE_FSP,
	PSMOUSE_SYNAPTICS_RELATIVE,
	PSMOUSE_CYPRESS,
	PSMOUSE_FOCALTECH,
	PSMOUSE_VMMOUSE,
	PSMOUSE_BYD,
	PSMOUSE_AUTO		/* This one should always be last */
};

void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
		unsigned long delay);
int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
int psmouse_reset(struct psmouse *psmouse);
void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
int psmouse_activate(struct psmouse *psmouse);
int psmouse_deactivate(struct psmouse *psmouse);
bool psmouse_matches_pnp_id(struct psmouse *psmouse, const char * const ids[]);

struct psmouse_attribute {
	struct device_attribute dattr;
	void *data;
	ssize_t (*show)(struct psmouse *psmouse, void *data, char *buf);
	ssize_t (*set)(struct psmouse *psmouse, void *data,
			const char *buf, size_t count);
	bool protect;
};
#define to_psmouse_attr(a)	container_of((a), struct psmouse_attribute, dattr)

ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *attr,
				 char *buf);
ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *attr,
				const char *buf, size_t count);

#define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)	\
static struct psmouse_attribute psmouse_attr_##_name = {			\
	.dattr	= {								\
		.attr	= {							\
			.name	= __stringify(_name),				\
			.mode	= _mode,					\
		},								\
		.show	= psmouse_attr_show_helper,				\
		.store	= psmouse_attr_set_helper,				\
	},									\
	.data	= _data,							\
	.show	= _show,							\
	.set	= _set,								\
	.protect = _protect,							\
}

#define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect)	\
	static ssize_t _show(struct psmouse *, void *, char *);			\
	static ssize_t _set(struct psmouse *, void *, const char *, size_t);	\
	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)

#define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set)			\
	__PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)

#define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show)			\
	static ssize_t _show(struct psmouse *, void *, char *);			\
	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)

#define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set)			\
	static ssize_t _set(struct psmouse *, void *, const char *, size_t);	\
	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)

#ifndef psmouse_fmt
#define psmouse_fmt(fmt)	KBUILD_BASENAME ": " fmt
#endif

#define psmouse_dbg(psmouse, format, ...)		\
	dev_dbg(&(psmouse)->ps2dev.serio->dev,		\
		psmouse_fmt(format), ##__VA_ARGS__)
#define psmouse_info(psmouse, format, ...)		\
	dev_info(&(psmouse)->ps2dev.serio->dev,		\
		 psmouse_fmt(format), ##__VA_ARGS__)
#define psmouse_warn(psmouse, format, ...)		\
	dev_warn(&(psmouse)->ps2dev.serio->dev,		\
		 psmouse_fmt(format), ##__VA_ARGS__)
#define psmouse_err(psmouse, format, ...)		\
	dev_err(&(psmouse)->ps2dev.serio->dev,		\
		psmouse_fmt(format), ##__VA_ARGS__)
#define psmouse_notice(psmouse, format, ...)		\
	dev_notice(&(psmouse)->ps2dev.serio->dev,	\
		   psmouse_fmt(format), ##__VA_ARGS__)
#define psmouse_printk(level, psmouse, format, ...)	\
	dev_printk(level,				\
		   &(psmouse)->ps2dev.serio->dev,	\
		   psmouse_fmt(format), ##__VA_ARGS__)


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