[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_EXT_CAPAB_0C		0x0c

/* 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_VALID(c)		((((c) & 0x00ff00) >> 8) == 0x47)
#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)
#define SYN_CAP_CLICKPAD(ex0c)		((ex0c) & 0x100100)

/* 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_IS_SYNAPTICS(i)		((((i) >> 8) & 0xff) == 0x47)

/* 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

/*
 * 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;
};

struct synaptics_data {
	/* Data read from the touchpad */
	unsigned long int model_id;		/* Model-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 */
	int x_res;				/* X resolution in units/mm */
	int y_res;				/* Y resolution in units/mm */

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

void synaptics_module_init(void);
int synaptics_detect(struct psmouse *psmouse, bool set_properties);
int synaptics_init(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
5f57d67d	21	#define SYN_QUE_EXT_CAPAB_0C 0x0c
1da177e4 LT	22
	23	/* synatics modes */
	24	#define SYN_BIT_ABSOLUTE_MODE (1 << 7)
	25	#define SYN_BIT_HIGH_RATE (1 << 6)
	26	#define SYN_BIT_SLEEP_MODE (1 << 3)
	27	#define SYN_BIT_DISABLE_GESTURE (1 << 2)
	28	#define SYN_BIT_FOUR_BYTE_CLIENT (1 << 1)
	29	#define SYN_BIT_W_MODE (1 << 0)
	30
	31	/* synaptics model ID bits */
	32	#define SYN_MODEL_ROT180(m) ((m) & (1 << 23))
	33	#define SYN_MODEL_PORTRAIT(m) ((m) & (1 << 22))
	34	#define SYN_MODEL_SENSOR(m) (((m) >> 16) & 0x3f)
	35	#define SYN_MODEL_HARDWARE(m) (((m) >> 9) & 0x7f)
	36	#define SYN_MODEL_NEWABS(m) ((m) & (1 << 7))
	37	#define SYN_MODEL_PEN(m) ((m) & (1 << 6))
	38	#define SYN_MODEL_SIMPLIC(m) ((m) & (1 << 5))
	39	#define SYN_MODEL_GEOMETRY(m) ((m) & 0x0f)
	40
	41	/* synaptics capability bits */
	42	#define SYN_CAP_EXTENDED(c) ((c) & (1 << 23))
	43	#define SYN_CAP_MIDDLE_BUTTON(c) ((c) & (1 << 18))
	44	#define SYN_CAP_PASS_THROUGH(c) ((c) & (1 << 7))
	45	#define SYN_CAP_SLEEP(c) ((c) & (1 << 4))
	46	#define SYN_CAP_FOUR_BUTTON(c) ((c) & (1 << 3))
	47	#define SYN_CAP_MULTIFINGER(c) ((c) & (1 << 1))
	48	#define SYN_CAP_PALMDETECT(c) ((c) & (1 << 0))
	49	#define SYN_CAP_VALID(c) ((((c) & 0x00ff00) >> 8) == 0x47)
	50	#define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20)
	51	#define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12)
5f57d67d TI	52	#define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16)
5f57d67d TI	53	#define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100100)
1da177e4 LT	54
	55	/* synaptics modes query bits */
	56	#define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7))
	57	#define SYN_MODE_RATE(m) ((m) & (1 << 6))
	58	#define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3))
	59	#define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2))
	60	#define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1))
	61	#define SYN_MODE_WMODE(m) ((m) & (1 << 0))
	62
	63	/* synaptics identify query bits */
55e3d922 AS	64	#define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f)
	65	#define SYN_ID_MAJOR(i) ((i) & 0x0f)
	66	#define SYN_ID_MINOR(i) (((i) >> 16) & 0xff)
1da177e4 LT	67	#define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47)
	68
	69	/* synaptics special commands */
	70	#define SYN_PS_SET_MODE2 0x14
	71	#define SYN_PS_CLIENT_CMD 0x28
	72
	73	/* synaptics packet types */
	74	#define SYN_NEWABS 0
	75	#define SYN_NEWABS_STRICT 1
	76	#define SYN_NEWABS_RELAXED 2
	77	#define SYN_OLDABS 3
	78
	79	/*
	80	* A structure to describe the state of the touchpad hardware (buttons and pad)
	81	*/
	82
	83	struct synaptics_hw_state {
	84	int x;
	85	int y;
	86	int z;
	87	int w;
	88	unsigned int left:1;
	89	unsigned int right:1;
	90	unsigned int middle:1;
	91	unsigned int up:1;
	92	unsigned int down:1;
	93	unsigned char ext_buttons;
	94	signed char scroll;
	95	};
	96
	97	struct synaptics_data {
	98	/* Data read from the touchpad */
	99	unsigned long int model_id; /* Model-ID */
55e3d922 AS	100	unsigned long int capabilities; /* Capabilities */
55e3d922 AS	101	unsigned long int ext_cap; /* Extended Capabilities */
5f57d67d	102	unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */
1da177e4	103	unsigned long int identity; /* Identification */
ec20a022 TS	104	int x_res; /* X resolution in units/mm */
ec20a022 TS	105	int y_res; /* Y resolution in units/mm */
1da177e4 LT	106
	107	unsigned char pkt_type; /* packet type - old, new, etc */
	108	unsigned char mode; /* current mode byte */
	109	int scroll;
	110	};
	111
7705d548	112	void synaptics_module_init(void);
b7802c5c	113	int synaptics_detect(struct psmouse *psmouse, bool set_properties);
55e3d922 AS	114	int synaptics_init(struct psmouse *psmouse);
55e3d922 AS	115	void synaptics_reset(struct psmouse *psmouse);
e4e6efd2	116	bool synaptics_supported(void);
55e3d922	117
1da177e4	118	#endif /* _SYNAPTICS_H */