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

/*
 * Synaptics TouchPad PS/2 mouse driver
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#ifndef _SYNAPTICS_H
#define _SYNAPTICS_H

/* synaptics queries */
#define SYN_QUE_IDENTIFY		0x00
#define SYN_QUE_MODES			0x01
#define SYN_QUE_CAPABILITIES		0x02
#define SYN_QUE_MODEL			0x03
#define SYN_QUE_SERIAL_NUMBER_PREFIX	0x06
#define SYN_QUE_SERIAL_NUMBER_SUFFIX	0x07
#define SYN_QUE_RESOLUTION		0x08
#define SYN_QUE_EXT_CAPAB		0x09
#define SYN_QUE_FIRMWARE_ID		0x0a
#define SYN_QUE_EXT_CAPAB_0C		0x0c
#define SYN_QUE_EXT_MAX_COORDS		0x0d
#define SYN_QUE_EXT_MIN_COORDS		0x0f

/* synatics modes */
#define SYN_BIT_ABSOLUTE_MODE		(1 << 7)
#define SYN_BIT_HIGH_RATE		(1 << 6)
#define SYN_BIT_SLEEP_MODE		(1 << 3)
#define SYN_BIT_DISABLE_GESTURE		(1 << 2)
#define SYN_BIT_FOUR_BYTE_CLIENT	(1 << 1)
#define SYN_BIT_W_MODE			(1 << 0)

/* synaptics model ID bits */
#define SYN_MODEL_ROT180(m)		((m) & (1 << 23))
#define SYN_MODEL_PORTRAIT(m)		((m) & (1 << 22))
#define SYN_MODEL_SENSOR(m)		(((m) >> 16) & 0x3f)
#define SYN_MODEL_HARDWARE(m)		(((m) >> 9) & 0x7f)
#define SYN_MODEL_NEWABS(m)		((m) & (1 << 7))
#define SYN_MODEL_PEN(m)		((m) & (1 << 6))
#define SYN_MODEL_SIMPLIC(m)		((m) & (1 << 5))
#define SYN_MODEL_GEOMETRY(m)		((m) & 0x0f)

/* synaptics capability bits */
#define SYN_CAP_EXTENDED(c)		((c) & (1 << 23))
#define SYN_CAP_MIDDLE_BUTTON(c)	((c) & (1 << 18))
#define SYN_CAP_PASS_THROUGH(c)		((c) & (1 << 7))
#define SYN_CAP_SLEEP(c)		((c) & (1 << 4))
#define SYN_CAP_FOUR_BUTTON(c)		((c) & (1 << 3))
#define SYN_CAP_MULTIFINGER(c)		((c) & (1 << 1))
#define SYN_CAP_PALMDETECT(c)		((c) & (1 << 0))
#define SYN_CAP_SUBMODEL_ID(c)		(((c) & 0x00ff00) >> 8)
#define SYN_EXT_CAP_REQUESTS(c)		(((c) & 0x700000) >> 20)
#define SYN_CAP_MULTI_BUTTON_NO(ec)	(((ec) & 0x00f000) >> 12)
#define SYN_CAP_PRODUCT_ID(ec)		(((ec) & 0xff0000) >> 16)

/*
 * The following describes response for the 0x0c query.
 *
 * byte	mask	name			meaning
 * ----	----	-------			------------
 * 1	0x01	adjustable threshold	capacitive button sensitivity
 *					can be adjusted
 * 1	0x02	report max		query 0x0d gives max coord reported
 * 1	0x04	clearpad		sensor is ClearPad product
 * 1	0x08	advanced gesture	not particularly meaningful
 * 1	0x10	clickpad bit 0		1-button ClickPad
 * 1	0x60	multifinger mode	identifies firmware finger counting
 *					(not reporting!) algorithm.
 *					Not particularly meaningful
 * 1	0x80	covered pad		W clipped to 14, 15 == pad mostly covered
 * 2	0x01	clickpad bit 1		2-button ClickPad
 * 2	0x02	deluxe LED controls	touchpad support LED commands
 *					ala multimedia control bar
 * 2	0x04	reduced filtering	firmware does less filtering on
 *					position data, driver should watch
 *					for noise.
 * 2	0x08	image sensor		image sensor tracks 5 fingers, but only
 *					reports 2.
 * 2	0x20	report min		query 0x0f gives min coord reported
 */
#define SYN_CAP_CLICKPAD(ex0c)		((ex0c) & 0x100000) /* 1-button ClickPad */
#define SYN_CAP_CLICKPAD2BTN(ex0c)	((ex0c) & 0x000100) /* 2-button ClickPad */
#define SYN_CAP_MAX_DIMENSIONS(ex0c)	((ex0c) & 0x020000)
#define SYN_CAP_MIN_DIMENSIONS(ex0c)	((ex0c) & 0x002000)
#define SYN_CAP_ADV_GESTURE(ex0c)	((ex0c) & 0x080000)
#define SYN_CAP_REDUCED_FILTERING(ex0c)	((ex0c) & 0x000400)
#define SYN_CAP_IMAGE_SENSOR(ex0c)	((ex0c) & 0x000800)

/* synaptics modes query bits */
#define SYN_MODE_ABSOLUTE(m)		((m) & (1 << 7))
#define SYN_MODE_RATE(m)		((m) & (1 << 6))
#define SYN_MODE_BAUD_SLEEP(m)		((m) & (1 << 3))
#define SYN_MODE_DISABLE_GESTURE(m)	((m) & (1 << 2))
#define SYN_MODE_PACKSIZE(m)		((m) & (1 << 1))
#define SYN_MODE_WMODE(m)		((m) & (1 << 0))

/* synaptics identify query bits */
#define SYN_ID_MODEL(i)			(((i) >> 4) & 0x0f)
#define SYN_ID_MAJOR(i)			((i) & 0x0f)
#define SYN_ID_MINOR(i)			(((i) >> 16) & 0xff)
#define SYN_ID_FULL(i)			((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i))
#define SYN_ID_IS_SYNAPTICS(i)		((((i) >> 8) & 0xff) == 0x47)
#define SYN_ID_DISGEST_SUPPORTED(i)	(SYN_ID_MAJOR(i) >= 4)

/* synaptics special commands */
#define SYN_PS_SET_MODE2		0x14
#define SYN_PS_CLIENT_CMD		0x28

/* synaptics packet types */
#define SYN_NEWABS			0
#define SYN_NEWABS_STRICT		1
#define SYN_NEWABS_RELAXED		2
#define SYN_OLDABS			3

/* amount to fuzz position data when touchpad reports reduced filtering */
#define SYN_REDUCED_FILTER_FUZZ		8

/*
 * A structure to describe which internal touchpad finger slots are being
 * reported in raw packets.
 */
struct synaptics_mt_state {
	int count;			/* num fingers being tracked */
	int sgm;			/* which slot is reported by sgm pkt */
	int agm;			/* which slot is reported by agm pkt*/
};

/*
 * A structure to describe the state of the touchpad hardware (buttons and pad)
 */
struct synaptics_hw_state {
	int x;
	int y;
	int z;
	int w;
	unsigned int left:1;
	unsigned int right:1;
	unsigned int middle:1;
	unsigned int up:1;
	unsigned int down:1;
	unsigned char ext_buttons;
	signed char scroll;

	/* As reported in last AGM-CONTACT packets */
	struct synaptics_mt_state mt_state;
};

struct synaptics_data {
	/* Data read from the touchpad */
	unsigned long int model_id;		/* Model-ID */
	unsigned long int firmware_id;		/* Firmware-ID */
	unsigned long int board_id;		/* Board-ID */
	unsigned long int capabilities;		/* Capabilities */
	unsigned long int ext_cap;		/* Extended Capabilities */
	unsigned long int ext_cap_0c;		/* Ext Caps from 0x0c query */
	unsigned long int identity;		/* Identification */
	unsigned int x_res, y_res;		/* X/Y resolution in units/mm */
	unsigned int x_max, y_max;		/* Max coordinates (from FW) */
	unsigned int x_min, y_min;		/* Min coordinates (from FW) */

	unsigned char pkt_type;			/* packet type - old, new, etc */
	unsigned char mode;			/* current mode byte */
	int scroll;

	bool absolute_mode;			/* run in Absolute mode */
	bool disable_gesture;			/* disable gestures */

	struct serio *pt_port;			/* Pass-through serio port */

	struct synaptics_mt_state mt_state;	/* Current mt finger state */
	bool mt_state_lost;			/* mt_state may be incorrect */

	/*
	 * Last received Advanced Gesture Mode (AGM) packet. An AGM packet
	 * contains position data for a second contact, at half resolution.
	 */
	struct synaptics_hw_state agm;
	bool agm_pending;			/* new AGM packet received */
};

void synaptics_module_init(void);
int synaptics_detect(struct psmouse *psmouse, bool set_properties);
int synaptics_init(struct psmouse *psmouse);
int synaptics_init_relative(struct psmouse *psmouse);
void synaptics_reset(struct psmouse *psmouse);
bool synaptics_supported(void);

#endif /* _SYNAPTICS_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Synaptics TouchPad PS/2 mouse driver
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License version 2 as published by
	6	* the Free Software Foundation.
	7	*/
	8
	9	#ifndef _SYNAPTICS_H
	10	#define _SYNAPTICS_H
	11
1da177e4 LT	12	/* synaptics queries */
	13	#define SYN_QUE_IDENTIFY 0x00
	14	#define SYN_QUE_MODES 0x01
	15	#define SYN_QUE_CAPABILITIES 0x02
	16	#define SYN_QUE_MODEL 0x03
	17	#define SYN_QUE_SERIAL_NUMBER_PREFIX 0x06
	18	#define SYN_QUE_SERIAL_NUMBER_SUFFIX 0x07
	19	#define SYN_QUE_RESOLUTION 0x08
	20	#define SYN_QUE_EXT_CAPAB 0x09
c6bd9d46	21	#define SYN_QUE_FIRMWARE_ID 0x0a
5f57d67d	22	#define SYN_QUE_EXT_CAPAB_0C 0x0c
a66413fb DT	23	#define SYN_QUE_EXT_MAX_COORDS 0x0d
a66413fb DT	24	#define SYN_QUE_EXT_MIN_COORDS 0x0f
1da177e4 LT	25
	26	/* synatics modes */
	27	#define SYN_BIT_ABSOLUTE_MODE (1 << 7)
	28	#define SYN_BIT_HIGH_RATE (1 << 6)
	29	#define SYN_BIT_SLEEP_MODE (1 << 3)
	30	#define SYN_BIT_DISABLE_GESTURE (1 << 2)
	31	#define SYN_BIT_FOUR_BYTE_CLIENT (1 << 1)
	32	#define SYN_BIT_W_MODE (1 << 0)
	33
	34	/* synaptics model ID bits */
	35	#define SYN_MODEL_ROT180(m) ((m) & (1 << 23))
	36	#define SYN_MODEL_PORTRAIT(m) ((m) & (1 << 22))
	37	#define SYN_MODEL_SENSOR(m) (((m) >> 16) & 0x3f)
	38	#define SYN_MODEL_HARDWARE(m) (((m) >> 9) & 0x7f)
	39	#define SYN_MODEL_NEWABS(m) ((m) & (1 << 7))
	40	#define SYN_MODEL_PEN(m) ((m) & (1 << 6))
	41	#define SYN_MODEL_SIMPLIC(m) ((m) & (1 << 5))
	42	#define SYN_MODEL_GEOMETRY(m) ((m) & 0x0f)
	43
	44	/* synaptics capability bits */
	45	#define SYN_CAP_EXTENDED(c) ((c) & (1 << 23))
	46	#define SYN_CAP_MIDDLE_BUTTON(c) ((c) & (1 << 18))
	47	#define SYN_CAP_PASS_THROUGH(c) ((c) & (1 << 7))
	48	#define SYN_CAP_SLEEP(c) ((c) & (1 << 4))
	49	#define SYN_CAP_FOUR_BUTTON(c) ((c) & (1 << 3))
	50	#define SYN_CAP_MULTIFINGER(c) ((c) & (1 << 1))
	51	#define SYN_CAP_PALMDETECT(c) ((c) & (1 << 0))
3619b8fe	52	#define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8)
1da177e4 LT	53	#define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20)
1da177e4 LT	54	#define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12)
5f57d67d	55	#define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16)
9bb794ae DT	56
	57	/*
	58	* The following describes response for the 0x0c query.
	59	*
	60	* byte mask name meaning
	61	* ---- ---- ------- ------------
	62	* 1 0x01 adjustable threshold capacitive button sensitivity
	63	* can be adjusted
	64	* 1 0x02 report max query 0x0d gives max coord reported
	65	* 1 0x04 clearpad sensor is ClearPad product
	66	* 1 0x08 advanced gesture not particularly meaningful
	67	* 1 0x10 clickpad bit 0 1-button ClickPad
	68	* 1 0x60 multifinger mode identifies firmware finger counting
	69	* (not reporting!) algorithm.
	70	* Not particularly meaningful
a9f0b79e DK	71	* 1 0x80 covered pad W clipped to 14, 15 == pad mostly covered
	72	* 2 0x01 clickpad bit 1 2-button ClickPad
	73	* 2 0x02 deluxe LED controls touchpad support LED commands
9bb794ae DT	74	* ala multimedia control bar
	75	* 2 0x04 reduced filtering firmware does less filtering on
	76	* position data, driver should watch
	77	* for noise.
3cdfee9e DK	78	* 2 0x08 image sensor image sensor tracks 5 fingers, but only
3cdfee9e DK	79	* reports 2.
a66413fb	80	* 2 0x20 report min query 0x0f gives min coord reported
9bb794ae	81	*/
3bfa321e YL	82	#define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */
3bfa321e YL	83	#define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */
83ba9ea8	84	#define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000)
3c6b5014	85	#define SYN_CAP_MIN_DIMENSIONS(ex0c) ((ex0c) & 0x002000)
fec6e525	86	#define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000)
a9f0b79e	87	#define SYN_CAP_REDUCED_FILTERING(ex0c) ((ex0c) & 0x000400)
3cdfee9e	88	#define SYN_CAP_IMAGE_SENSOR(ex0c) ((ex0c) & 0x000800)
1da177e4 LT	89
	90	/* synaptics modes query bits */
	91	#define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7))
	92	#define SYN_MODE_RATE(m) ((m) & (1 << 6))
	93	#define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3))
	94	#define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2))
	95	#define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1))
	96	#define SYN_MODE_WMODE(m) ((m) & (1 << 0))
	97
	98	/* synaptics identify query bits */
55e3d922 AS	99	#define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f)
	100	#define SYN_ID_MAJOR(i) ((i) & 0x0f)
	101	#define SYN_ID_MINOR(i) (((i) >> 16) & 0xff)
3619b8fe	102	#define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) \| SYN_ID_MINOR(i))
1da177e4	103	#define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47)
7968a5dd	104	#define SYN_ID_DISGEST_SUPPORTED(i) (SYN_ID_MAJOR(i) >= 4)
1da177e4 LT	105
	106	/* synaptics special commands */
	107	#define SYN_PS_SET_MODE2 0x14
	108	#define SYN_PS_CLIENT_CMD 0x28
	109
	110	/* synaptics packet types */
	111	#define SYN_NEWABS 0
	112	#define SYN_NEWABS_STRICT 1
	113	#define SYN_NEWABS_RELAXED 2
	114	#define SYN_OLDABS 3
	115
a9f0b79e DK	116	/* amount to fuzz position data when touchpad reports reduced filtering */
	117	#define SYN_REDUCED_FILTER_FUZZ 8
	118
1da177e4	119	/*
a6ca40c1 DK	120	* A structure to describe which internal touchpad finger slots are being
a6ca40c1 DK	121	* reported in raw packets.
1da177e4	122	*/
a6ca40c1 DK	123	struct synaptics_mt_state {
	124	int count; /* num fingers being tracked */
	125	int sgm; /* which slot is reported by sgm pkt */
	126	int agm; /* which slot is reported by agm pkt*/
	127	};
1da177e4	128
a6ca40c1 DK	129	/*
	130	* A structure to describe the state of the touchpad hardware (buttons and pad)
	131	*/
1da177e4 LT	132	struct synaptics_hw_state {
	133	int x;
	134	int y;
	135	int z;
	136	int w;
	137	unsigned int left:1;
	138	unsigned int right:1;
	139	unsigned int middle:1;
	140	unsigned int up:1;
	141	unsigned int down:1;
	142	unsigned char ext_buttons;
	143	signed char scroll;
a6ca40c1 DK	144
	145	/* As reported in last AGM-CONTACT packets */
	146	struct synaptics_mt_state mt_state;
1da177e4 LT	147	};
	148
	149	struct synaptics_data {
	150	/* Data read from the touchpad */
	151	unsigned long int model_id; /* Model-ID */
c6bd9d46 DK	152	unsigned long int firmware_id; /* Firmware-ID */
c6bd9d46 DK	153	unsigned long int board_id; /* Board-ID */
55e3d922 AS	154	unsigned long int capabilities; /* Capabilities */
55e3d922 AS	155	unsigned long int ext_cap; /* Extended Capabilities */
5f57d67d	156	unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */
1da177e4	157	unsigned long int identity; /* Identification */
83ba9ea8	158	unsigned int x_res, y_res; /* X/Y resolution in units/mm */
a66413fb DT	159	unsigned int x_max, y_max; /* Max coordinates (from FW) */
a66413fb DT	160	unsigned int x_min, y_min; /* Min coordinates (from FW) */
1da177e4 LT	161
	162	unsigned char pkt_type; /* packet type - old, new, etc */
	163	unsigned char mode; /* current mode byte */
	164	int scroll;
a8b3c0f5	165
7968a5dd DD	166	bool absolute_mode; /* run in Absolute mode */
	167	bool disable_gesture; /* disable gestures */
	168
a8b3c0f5	169	struct serio pt_port; / Pass-through serio port */
fec6e525	170
4dc772d2 DK	171	struct synaptics_mt_state mt_state; /* Current mt finger state */
	172	bool mt_state_lost; /* mt_state may be incorrect */
	173
7afdb842 DK	174	/*
	175	* Last received Advanced Gesture Mode (AGM) packet. An AGM packet
	176	* contains position data for a second contact, at half resolution.
	177	*/
	178	struct synaptics_hw_state agm;
4dc772d2	179	bool agm_pending; /* new AGM packet received */
1da177e4 LT	180	};
1da177e4 LT	181
7705d548	182	void synaptics_module_init(void);
b7802c5c	183	int synaptics_detect(struct psmouse *psmouse, bool set_properties);
55e3d922	184	int synaptics_init(struct psmouse *psmouse);
7968a5dd	185	int synaptics_init_relative(struct psmouse *psmouse);
55e3d922	186	void synaptics_reset(struct psmouse *psmouse);
e4e6efd2	187	bool synaptics_supported(void);
55e3d922	188
1da177e4	189	#endif /* _SYNAPTICS_H */