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