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

#ifndef _PSMOUSE_H
#define _PSMOUSE_H

#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;

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

	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_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
	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
f0d5c6f4	10	#define PSMOUSE_CMD_POLL 0x00eb /* caller sets number of bytes to receive */
25bded7c	11	#define PSMOUSE_CMD_RESET_WRAP 0x00ec
1da177e4 LT	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,
f0d5c6f4	27	PSMOUSE_RESYNCING,
1da177e4 LT	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;
2e5b636b	41	struct input_dev *dev;
1da177e4	42	struct ps2dev ps2dev;
8bf020ee	43	struct delayed_work resync_work;
1da177e4 LT	44	char *vendor;
	45	char *name;
	46	unsigned char packet[8];
f0d5c6f4	47	unsigned char badbyte;
1da177e4 LT	48	unsigned char pktcnt;
	49	unsigned char pktsize;
	50	unsigned char type;
6b9d363c	51	bool ignore_parity;
b7802c5c	52	bool acks_disable_command;
1da177e4 LT	53	unsigned int model;
1da177e4 LT	54	unsigned long last;
b7802c5c	55	unsigned long out_of_sync_cnt;
f0d5c6f4	56	unsigned long num_resyncs;
1da177e4 LT	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;
f0d5c6f4	64	unsigned int resync_time;
b7802c5c	65	bool smartscroll; /* Logitech only */
1da177e4	66
7d12e780	67	psmouse_ret_t (protocol_handler)(struct psmouse psmouse);
1da177e4 LT	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);
a1cec061	73	void (cleanup)(struct psmouse psmouse);
f0d5c6f4	74	int (poll)(struct psmouse psmouse);
1da177e4 LT	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,
02d7f589	90	PSMOUSE_LIFEBOOK,
541e316a	91	PSMOUSE_TRACKPOINT,
24bf10ab	92	PSMOUSE_TOUCHKIT_PS2,
aea6a461	93	PSMOUSE_CORTRON,
df08ef27	94	PSMOUSE_HGPK,
2a0bd75e	95	PSMOUSE_ELANTECH,
fc69f4a6	96	PSMOUSE_FSP,
7968a5dd	97	PSMOUSE_SYNAPTICS_RELATIVE,
0799a924	98	PSMOUSE_CYPRESS,
dbf4ccd6	99	PSMOUSE_AUTO /* This one should always be last */
1da177e4 LT	100	};
1da177e4 LT	101
8bf020ee AS	102	void psmouse_queue_work(struct psmouse psmouse, struct delayed_work work,
8bf020ee AS	103	unsigned long delay);
1da177e4 LT	104	int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
1da177e4 LT	105	int psmouse_reset(struct psmouse *psmouse);
a48cf5f3	106	void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
1da177e4	107	void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
7968a5dd	108	psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse);
bd26f3d6 AS	109	int psmouse_activate(struct psmouse *psmouse);
bd26f3d6 AS	110	int psmouse_deactivate(struct psmouse *psmouse);
2c75ada6	111	bool psmouse_matches_pnp_id(struct psmouse psmouse, const char const ids[]);
1da177e4	112
cfe9e888 DT	113	struct psmouse_attribute {
	114	struct device_attribute dattr;
	115	void *data;
	116	ssize_t (show)(struct psmouse psmouse, void data, char buf);
	117	ssize_t (set)(struct psmouse psmouse, void *data,
	118	const char *buf, size_t count);
b7802c5c	119	bool protect;
cfe9e888 DT	120	};
	121	#define to_psmouse_attr(a) container_of((a), struct psmouse_attribute, dattr)
	122
	123	ssize_t psmouse_attr_show_helper(struct device dev, struct device_attribute attr,
	124	char *buf);
	125	ssize_t psmouse_attr_set_helper(struct device dev, struct device_attribute attr,
	126	const char *buf, size_t count);
	127
3b720944	128	#define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect) \
cfe9e888 DT	129	static struct psmouse_attribute psmouse_attr_##_name = { \
	130	.dattr = { \
	131	.attr = { \
	132	.name = __stringify(_name), \
	133	.mode = _mode, \
cfe9e888 DT	134	}, \
	135	.show = psmouse_attr_show_helper, \
	136	.store = psmouse_attr_set_helper, \
	137	}, \
	138	.data = _data, \
	139	.show = _show, \
	140	.set = _set, \
68d48221	141	.protect = _protect, \
cfe9e888	142	}
1da177e4	143
3b720944 DT	144	#define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect) \
	145	static ssize_t _show(struct psmouse , void , char *); \
	146	static ssize_t _set(struct psmouse , void , const char *, size_t); \
	147	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
	148
	149	#define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set) \
b7802c5c	150	__PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
3b720944 DT	151
	152	#define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show) \
	153	static ssize_t _show(struct psmouse , void , char *); \
b7802c5c	154	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
3b720944 DT	155
	156	#define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set) \
	157	static ssize_t _set(struct psmouse , void , const char *, size_t); \
b7802c5c	158	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
68d48221	159
b5d21704 DT	160	#ifndef psmouse_fmt
	161	#define psmouse_fmt(fmt) KBUILD_BASENAME ": " fmt
	162	#endif
	163
	164	#define psmouse_dbg(psmouse, format, ...) \
	165	dev_dbg(&(psmouse)->ps2dev.serio->dev, \
	166	psmouse_fmt(format), ##__VA_ARGS__)
	167	#define psmouse_info(psmouse, format, ...) \
	168	dev_info(&(psmouse)->ps2dev.serio->dev, \
	169	psmouse_fmt(format), ##__VA_ARGS__)
	170	#define psmouse_warn(psmouse, format, ...) \
	171	dev_warn(&(psmouse)->ps2dev.serio->dev, \
	172	psmouse_fmt(format), ##__VA_ARGS__)
	173	#define psmouse_err(psmouse, format, ...) \
	174	dev_err(&(psmouse)->ps2dev.serio->dev, \
	175	psmouse_fmt(format), ##__VA_ARGS__)
	176	#define psmouse_notice(psmouse, format, ...) \
	177	dev_notice(&(psmouse)->ps2dev.serio->dev, \
	178	psmouse_fmt(format), ##__VA_ARGS__)
	179	#define psmouse_printk(level, psmouse, format, ...) \
	180	dev_printk(level, \
	181	&(psmouse)->ps2dev.serio->dev, \
	182	psmouse_fmt(format), ##__VA_ARGS__)
	183
	184
1da177e4	185	#endif /* _PSMOUSE_H */