[thirdparty/linux.git] / drivers / input / mouse / psmouse.h

/* SPDX-License-Identifier: GPL-2.0 */
#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
};

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_SYNAPTICS_SMBUS,
	PSMOUSE_AUTO		/* This one should always be last */
};

struct psmouse;

struct psmouse_protocol {
	enum psmouse_type type;
	bool maxproto;
	bool ignore_parity; /* Protocol should ignore parity errors from KBC */
	bool try_passthru; /* Try protocol also on passthrough ports */
	bool smbus_companion; /* "Protocol" is a stub, device is on SMBus */
	const char *name;
	const char *alias;
	int (*detect)(struct psmouse *, bool);
	int (*init)(struct psmouse *);
};

struct psmouse {
	void *private;
	struct input_dev *dev;
	struct ps2dev ps2dev;
	struct delayed_work resync_work;
	const char *vendor;
	const char *name;
	const struct psmouse_protocol *protocol;
	unsigned char packet[8];
	unsigned char badbyte;
	unsigned char pktcnt;
	unsigned char pktsize;
	unsigned char oob_data_type;
	unsigned char extra_buttons;
	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);
	int (*fast_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);
};

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__)

#ifdef CONFIG_MOUSE_PS2_SMBUS

int psmouse_smbus_module_init(void);
void psmouse_smbus_module_exit(void);

struct i2c_board_info;

int psmouse_smbus_init(struct psmouse *psmouse,
		       const struct i2c_board_info *board,
		       const void *pdata, size_t pdata_size,
		       bool leave_breadcrumbs);
void psmouse_smbus_cleanup(struct psmouse *psmouse);

#else /* !CONFIG_MOUSE_PS2_SMBUS */

static inline int psmouse_smbus_module_init(void)
{
	return 0;
}

static inline void psmouse_smbus_module_exit(void)
{
}

static inline void psmouse_smbus_cleanup(struct psmouse *psmouse)
{
}

#endif /* CONFIG_MOUSE_PS2_SMBUS */

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