Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
synaptics.h
Go to the documentation of this file.
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_FIRMWARE_ID 0x0a
22 #define SYN_QUE_EXT_CAPAB_0C 0x0c
23 #define SYN_QUE_EXT_MAX_COORDS 0x0d
24 #define SYN_QUE_EXT_MIN_COORDS 0x0f
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))
52 #define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8)
53 #define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20)
54 #define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12)
55 #define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16)
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
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
74  * ala multimedia control bar
75  * 2 0x04 reduced filtering firmware does less filtering on
76  * position data, driver should watch
77  * for noise.
78  * 2 0x08 image sensor image sensor tracks 5 fingers, but only
79  * reports 2.
80  * 2 0x20 report min query 0x0f gives min coord reported
81  */
82 #define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */
83 #define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */
84 #define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000)
85 #define SYN_CAP_MIN_DIMENSIONS(ex0c) ((ex0c) & 0x002000)
86 #define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000)
87 #define SYN_CAP_REDUCED_FILTERING(ex0c) ((ex0c) & 0x000400)
88 #define SYN_CAP_IMAGE_SENSOR(ex0c) ((ex0c) & 0x000800)
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 */
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)
102 #define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i))
103 #define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47)
104 #define SYN_ID_DISGEST_SUPPORTED(i) (SYN_ID_MAJOR(i) >= 4)
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 
116 /* amount to fuzz position data when touchpad reports reduced filtering */
117 #define SYN_REDUCED_FILTER_FUZZ 8
118 
119 /*
120  * A structure to describe which internal touchpad finger slots are being
121  * reported in raw packets.
122  */
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 };
128 
129 /*
130  * A structure to describe the state of the touchpad hardware (buttons and pad)
131  */
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;
144 
145  /* As reported in last AGM-CONTACT packets */
146  struct synaptics_mt_state mt_state;
147 };
148 
149 struct synaptics_data {
150  /* Data read from the touchpad */
151  unsigned long int model_id; /* Model-ID */
152  unsigned long int firmware_id; /* Firmware-ID */
153  unsigned long int board_id; /* Board-ID */
154  unsigned long int capabilities; /* Capabilities */
155  unsigned long int ext_cap; /* Extended Capabilities */
156  unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */
157  unsigned long int identity; /* Identification */
158  unsigned int x_res, y_res; /* X/Y resolution in units/mm */
159  unsigned int x_max, y_max; /* Max coordinates (from FW) */
160  unsigned int x_min, y_min; /* Min coordinates (from FW) */
161 
162  unsigned char pkt_type; /* packet type - old, new, etc */
163  unsigned char mode; /* current mode byte */
164  int scroll;
165 
166  bool absolute_mode; /* run in Absolute mode */
167  bool disable_gesture; /* disable gestures */
168 
169  struct serio *pt_port; /* Pass-through serio port */
170 
171  struct synaptics_mt_state mt_state; /* Current mt finger state */
172  bool mt_state_lost; /* mt_state may be incorrect */
173 
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;
179  bool agm_pending; /* new AGM packet received */
180 };
181 
182 void synaptics_module_init(void);
183 int synaptics_detect(struct psmouse *psmouse, bool set_properties);
184 int synaptics_init(struct psmouse *psmouse);
185 int synaptics_init_relative(struct psmouse *psmouse);
186 void synaptics_reset(struct psmouse *psmouse);
187 bool synaptics_supported(void);
188 
189 #endif /* _SYNAPTICS_H */
Generated on Thu Jan 10 2013 13:39:47 for Linux Kernel by   doxygen 1.8.2