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