[mirror_ubuntu-artful-kernel.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_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 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_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);

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)

#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 */
1da177e4 LT	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,
f0d5c6f4	26	PSMOUSE_RESYNCING,
1da177e4 LT	27	PSMOUSE_CMD_MODE,
	28	PSMOUSE_ACTIVATED,
	29	};
	30
	31	/* psmouse protocol handler return codes */
	32	typedef enum {
	33	PSMOUSE_BAD_DATA,
	34	PSMOUSE_GOOD_DATA,
	35	PSMOUSE_FULL_PACKET
	36	} psmouse_ret_t;
	37
	38	struct psmouse {
	39	void *private;
2e5b636b	40	struct input_dev *dev;
1da177e4	41	struct ps2dev ps2dev;
8bf020ee	42	struct delayed_work resync_work;
1da177e4 LT	43	char *vendor;
	44	char *name;
	45	unsigned char packet[8];
f0d5c6f4	46	unsigned char badbyte;
1da177e4 LT	47	unsigned char pktcnt;
	48	unsigned char pktsize;
	49	unsigned char type;
b7802c5c	50	bool acks_disable_command;
1da177e4 LT	51	unsigned int model;
1da177e4 LT	52	unsigned long last;
b7802c5c	53	unsigned long out_of_sync_cnt;
f0d5c6f4	54	unsigned long num_resyncs;
1da177e4 LT	55	enum psmouse_state state;
	56	char devname[64];
	57	char phys[32];
	58
	59	unsigned int rate;
	60	unsigned int resolution;
	61	unsigned int resetafter;
f0d5c6f4	62	unsigned int resync_time;
b7802c5c	63	bool smartscroll; /* Logitech only */
1da177e4	64
7d12e780	65	psmouse_ret_t (protocol_handler)(struct psmouse psmouse);
1da177e4 LT	66	void (set_rate)(struct psmouse psmouse, unsigned int rate);
	67	void (set_resolution)(struct psmouse psmouse, unsigned int resolution);
	68
	69	int (reconnect)(struct psmouse psmouse);
	70	void (disconnect)(struct psmouse psmouse);
a1cec061	71	void (cleanup)(struct psmouse psmouse);
f0d5c6f4	72	int (poll)(struct psmouse psmouse);
1da177e4 LT	73
	74	void (pt_activate)(struct psmouse psmouse);
	75	void (pt_deactivate)(struct psmouse psmouse);
	76	};
	77
	78	enum psmouse_type {
	79	PSMOUSE_NONE,
	80	PSMOUSE_PS2,
	81	PSMOUSE_PS2PP,
	82	PSMOUSE_THINKPS,
	83	PSMOUSE_GENPS,
	84	PSMOUSE_IMPS,
	85	PSMOUSE_IMEX,
	86	PSMOUSE_SYNAPTICS,
	87	PSMOUSE_ALPS,
02d7f589	88	PSMOUSE_LIFEBOOK,
541e316a	89	PSMOUSE_TRACKPOINT,
24bf10ab	90	PSMOUSE_TOUCHKIT_PS2,
aea6a461	91	PSMOUSE_CORTRON,
df08ef27	92	PSMOUSE_HGPK,
2a0bd75e	93	PSMOUSE_ELANTECH,
fc69f4a6	94	PSMOUSE_FSP,
dbf4ccd6	95	PSMOUSE_AUTO /* This one should always be last */
1da177e4 LT	96	};
1da177e4 LT	97
8bf020ee AS	98	void psmouse_queue_work(struct psmouse psmouse, struct delayed_work work,
8bf020ee AS	99	unsigned long delay);
1da177e4 LT	100	int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command);
1da177e4 LT	101	int psmouse_reset(struct psmouse *psmouse);
a48cf5f3	102	void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state);
1da177e4 LT	103	void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution);
1da177e4 LT	104
cfe9e888 DT	105	struct psmouse_attribute {
	106	struct device_attribute dattr;
	107	void *data;
	108	ssize_t (show)(struct psmouse psmouse, void data, char buf);
	109	ssize_t (set)(struct psmouse psmouse, void *data,
	110	const char *buf, size_t count);
b7802c5c	111	bool protect;
cfe9e888 DT	112	};
	113	#define to_psmouse_attr(a) container_of((a), struct psmouse_attribute, dattr)
	114
	115	ssize_t psmouse_attr_show_helper(struct device dev, struct device_attribute attr,
	116	char *buf);
	117	ssize_t psmouse_attr_set_helper(struct device dev, struct device_attribute attr,
	118	const char *buf, size_t count);
	119
3b720944	120	#define __PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect) \
cfe9e888 DT	121	static struct psmouse_attribute psmouse_attr_##_name = { \
	122	.dattr = { \
	123	.attr = { \
	124	.name = __stringify(_name), \
	125	.mode = _mode, \
cfe9e888 DT	126	}, \
	127	.show = psmouse_attr_show_helper, \
	128	.store = psmouse_attr_set_helper, \
	129	}, \
	130	.data = _data, \
	131	.show = _show, \
	132	.set = _set, \
68d48221	133	.protect = _protect, \
cfe9e888	134	}
1da177e4	135
3b720944 DT	136	#define __PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, _protect) \
	137	static ssize_t _show(struct psmouse , void , char *); \
	138	static ssize_t _set(struct psmouse , void , const char *, size_t); \
	139	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, _set, _protect)
	140
	141	#define PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set) \
b7802c5c	142	__PSMOUSE_DEFINE_ATTR(_name, _mode, _data, _show, _set, true)
3b720944 DT	143
	144	#define PSMOUSE_DEFINE_RO_ATTR(_name, _mode, _data, _show) \
	145	static ssize_t _show(struct psmouse , void , char *); \
b7802c5c	146	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, _show, NULL, true)
3b720944 DT	147
	148	#define PSMOUSE_DEFINE_WO_ATTR(_name, _mode, _data, _set) \
	149	static ssize_t _set(struct psmouse , void , const char *, size_t); \
b7802c5c	150	__PSMOUSE_DEFINE_ATTR_VAR(_name, _mode, _data, NULL, _set, true)
68d48221	151
1da177e4	152	#endif /* _PSMOUSE_H */