x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / drivers / hid / wacom_wac.h
blobfeb62fd4dfc3ecff1ba43ee46fc7f70ec9b3c6d2
1 /*
2 * drivers/input/tablet/wacom_wac.h
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 */
9 #ifndef WACOM_WAC_H
10 #define WACOM_WAC_H
12 #include <linux/types.h>
13 #include <linux/hid.h>
15 /* maximum packet length for USB/BT devices */
16 #define WACOM_PKGLEN_MAX 361
18 #define WACOM_NAME_MAX 64
19 #define WACOM_MAX_REMOTES 5
20 #define WACOM_STATUS_UNKNOWN 255
22 /* packet length for individual models */
23 #define WACOM_PKGLEN_BBFUN 9
24 #define WACOM_PKGLEN_TPC1FG 5
25 #define WACOM_PKGLEN_TPC1FG_B 10
26 #define WACOM_PKGLEN_TPC2FG 14
27 #define WACOM_PKGLEN_BBTOUCH 20
28 #define WACOM_PKGLEN_BBTOUCH3 64
29 #define WACOM_PKGLEN_BBPEN 10
30 #define WACOM_PKGLEN_WIRELESS 32
31 #define WACOM_PKGLEN_PENABLED 8
32 #define WACOM_PKGLEN_BPAD_TOUCH 32
33 #define WACOM_PKGLEN_BPAD_TOUCH_USB 64
35 /* wacom data size per MT contact */
36 #define WACOM_BYTES_PER_MT_PACKET 11
37 #define WACOM_BYTES_PER_24HDT_PACKET 14
38 #define WACOM_BYTES_PER_QHDTHID_PACKET 6
40 /* device IDs */
41 #define STYLUS_DEVICE_ID 0x02
42 #define TOUCH_DEVICE_ID 0x03
43 #define CURSOR_DEVICE_ID 0x06
44 #define ERASER_DEVICE_ID 0x0A
45 #define PAD_DEVICE_ID 0x0F
47 /* wacom data packet report IDs */
48 #define WACOM_REPORT_PENABLED 2
49 #define WACOM_REPORT_PENABLED_BT 3
50 #define WACOM_REPORT_INTUOS_ID1 5
51 #define WACOM_REPORT_INTUOS_ID2 6
52 #define WACOM_REPORT_INTUOSPAD 12
53 #define WACOM_REPORT_INTUOS5PAD 3
54 #define WACOM_REPORT_DTUSPAD 21
55 #define WACOM_REPORT_TPC1FG 6
56 #define WACOM_REPORT_TPC2FG 13
57 #define WACOM_REPORT_TPCMT 13
58 #define WACOM_REPORT_TPCMT2 3
59 #define WACOM_REPORT_TPCHID 15
60 #define WACOM_REPORT_CINTIQ 16
61 #define WACOM_REPORT_CINTIQPAD 17
62 #define WACOM_REPORT_TPCST 16
63 #define WACOM_REPORT_DTUS 17
64 #define WACOM_REPORT_TPC1FGE 18
65 #define WACOM_REPORT_24HDT 1
66 #define WACOM_REPORT_WL 128
67 #define WACOM_REPORT_USB 192
68 #define WACOM_REPORT_BPAD_PEN 3
69 #define WACOM_REPORT_BPAD_TOUCH 16
70 #define WACOM_REPORT_DEVICE_LIST 16
71 #define WACOM_REPORT_INTUOS_PEN 16
72 #define WACOM_REPORT_REMOTE 17
73 #define WACOM_REPORT_INTUOSHT2_ID 8
75 /* wacom command report ids */
76 #define WAC_CMD_WL_LED_CONTROL 0x03
77 #define WAC_CMD_LED_CONTROL 0x20
78 #define WAC_CMD_ICON_START 0x21
79 #define WAC_CMD_ICON_XFER 0x23
80 #define WAC_CMD_ICON_BT_XFER 0x26
81 #define WAC_CMD_DELETE_PAIRING 0x20
82 #define WAC_CMD_LED_CONTROL_GENERIC 0x32
83 #define WAC_CMD_UNPAIR_ALL 0xFF
84 #define WAC_CMD_WL_INTUOSP2 0x82
86 /* device quirks */
87 #define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
88 #define WACOM_QUIRK_SENSE 0x0002
89 #define WACOM_QUIRK_BATTERY 0x0008
91 /* device types */
92 #define WACOM_DEVICETYPE_NONE 0x0000
93 #define WACOM_DEVICETYPE_PEN 0x0001
94 #define WACOM_DEVICETYPE_TOUCH 0x0002
95 #define WACOM_DEVICETYPE_PAD 0x0004
96 #define WACOM_DEVICETYPE_WL_MONITOR 0x0008
97 #define WACOM_DEVICETYPE_DIRECT 0x0010
99 #define WACOM_POWER_SUPPLY_STATUS_AUTO -1
101 #define WACOM_HID_UP_WACOMDIGITIZER 0xff0d0000
102 #define WACOM_HID_SP_PAD 0x00040000
103 #define WACOM_HID_SP_BUTTON 0x00090000
104 #define WACOM_HID_SP_DIGITIZER 0x000d0000
105 #define WACOM_HID_SP_DIGITIZERINFO 0x00100000
106 #define WACOM_HID_WD_DIGITIZER (WACOM_HID_UP_WACOMDIGITIZER | 0x01)
107 #define WACOM_HID_WD_PEN (WACOM_HID_UP_WACOMDIGITIZER | 0x02)
108 #define WACOM_HID_WD_SENSE (WACOM_HID_UP_WACOMDIGITIZER | 0x36)
109 #define WACOM_HID_WD_DIGITIZERFNKEYS (WACOM_HID_UP_WACOMDIGITIZER | 0x39)
110 #define WACOM_HID_WD_SERIALHI (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
111 #define WACOM_HID_WD_TOOLTYPE (WACOM_HID_UP_WACOMDIGITIZER | 0x77)
112 #define WACOM_HID_WD_DISTANCE (WACOM_HID_UP_WACOMDIGITIZER | 0x0132)
113 #define WACOM_HID_WD_TOUCHSTRIP (WACOM_HID_UP_WACOMDIGITIZER | 0x0136)
114 #define WACOM_HID_WD_TOUCHSTRIP2 (WACOM_HID_UP_WACOMDIGITIZER | 0x0137)
115 #define WACOM_HID_WD_TOUCHRING (WACOM_HID_UP_WACOMDIGITIZER | 0x0138)
116 #define WACOM_HID_WD_TOUCHRINGSTATUS (WACOM_HID_UP_WACOMDIGITIZER | 0x0139)
117 #define WACOM_HID_WD_ACCELEROMETER_X (WACOM_HID_UP_WACOMDIGITIZER | 0x0401)
118 #define WACOM_HID_WD_ACCELEROMETER_Y (WACOM_HID_UP_WACOMDIGITIZER | 0x0402)
119 #define WACOM_HID_WD_ACCELEROMETER_Z (WACOM_HID_UP_WACOMDIGITIZER | 0x0403)
120 #define WACOM_HID_WD_BATTERY_CHARGING (WACOM_HID_UP_WACOMDIGITIZER | 0x0404)
121 #define WACOM_HID_WD_TOUCHONOFF (WACOM_HID_UP_WACOMDIGITIZER | 0x0454)
122 #define WACOM_HID_WD_BATTERY_LEVEL (WACOM_HID_UP_WACOMDIGITIZER | 0x043b)
123 #define WACOM_HID_WD_EXPRESSKEY00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0910)
124 #define WACOM_HID_WD_EXPRESSKEYCAP00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0950)
125 #define WACOM_HID_WD_MODE_CHANGE (WACOM_HID_UP_WACOMDIGITIZER | 0x0980)
126 #define WACOM_HID_WD_MUTE_DEVICE (WACOM_HID_UP_WACOMDIGITIZER | 0x0981)
127 #define WACOM_HID_WD_CONTROLPANEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0982)
128 #define WACOM_HID_WD_ONSCREEN_KEYBOARD (WACOM_HID_UP_WACOMDIGITIZER | 0x0983)
129 #define WACOM_HID_WD_BUTTONCONFIG (WACOM_HID_UP_WACOMDIGITIZER | 0x0986)
130 #define WACOM_HID_WD_BUTTONHOME (WACOM_HID_UP_WACOMDIGITIZER | 0x0990)
131 #define WACOM_HID_WD_BUTTONUP (WACOM_HID_UP_WACOMDIGITIZER | 0x0991)
132 #define WACOM_HID_WD_BUTTONDOWN (WACOM_HID_UP_WACOMDIGITIZER | 0x0992)
133 #define WACOM_HID_WD_BUTTONLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0993)
134 #define WACOM_HID_WD_BUTTONRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0994)
135 #define WACOM_HID_WD_BUTTONCENTER (WACOM_HID_UP_WACOMDIGITIZER | 0x0995)
136 #define WACOM_HID_WD_FINGERWHEEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03)
137 #define WACOM_HID_WD_OFFSETLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d30)
138 #define WACOM_HID_WD_OFFSETTOP (WACOM_HID_UP_WACOMDIGITIZER | 0x0d31)
139 #define WACOM_HID_WD_OFFSETRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d32)
140 #define WACOM_HID_WD_OFFSETBOTTOM (WACOM_HID_UP_WACOMDIGITIZER | 0x0d33)
141 #define WACOM_HID_WD_DATAMODE (WACOM_HID_UP_WACOMDIGITIZER | 0x1002)
142 #define WACOM_HID_WD_DIGITIZERINFO (WACOM_HID_UP_WACOMDIGITIZER | 0x1013)
143 #define WACOM_HID_UP_G9 0xff090000
144 #define WACOM_HID_G9_PEN (WACOM_HID_UP_G9 | 0x02)
145 #define WACOM_HID_G9_TOUCHSCREEN (WACOM_HID_UP_G9 | 0x11)
146 #define WACOM_HID_UP_G11 0xff110000
147 #define WACOM_HID_G11_PEN (WACOM_HID_UP_G11 | 0x02)
148 #define WACOM_HID_G11_TOUCHSCREEN (WACOM_HID_UP_G11 | 0x11)
149 #define WACOM_HID_UP_WACOMTOUCH 0xff000000
150 #define WACOM_HID_WT_TOUCHSCREEN (WACOM_HID_UP_WACOMTOUCH | 0x04)
151 #define WACOM_HID_WT_TOUCHPAD (WACOM_HID_UP_WACOMTOUCH | 0x05)
152 #define WACOM_HID_WT_CONTACTMAX (WACOM_HID_UP_WACOMTOUCH | 0x55)
153 #define WACOM_HID_WT_X (WACOM_HID_UP_WACOMTOUCH | 0x130)
154 #define WACOM_HID_WT_Y (WACOM_HID_UP_WACOMTOUCH | 0x131)
156 #define WACOM_BATTERY_USAGE(f) (((f)->hid == HID_DG_BATTERYSTRENGTH) || \
157 ((f)->hid == WACOM_HID_WD_BATTERY_CHARGING) || \
158 ((f)->hid == WACOM_HID_WD_BATTERY_LEVEL))
160 #define WACOM_PAD_FIELD(f) (((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \
161 ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \
162 ((f)->physical == WACOM_HID_WD_DIGITIZERINFO))
164 #define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \
165 ((f)->physical == HID_DG_STYLUS) || \
166 ((f)->physical == HID_DG_PEN) || \
167 ((f)->application == HID_DG_PEN) || \
168 ((f)->application == HID_DG_DIGITIZER) || \
169 ((f)->application == WACOM_HID_WD_PEN) || \
170 ((f)->application == WACOM_HID_WD_DIGITIZER) || \
171 ((f)->application == WACOM_HID_G9_PEN) || \
172 ((f)->application == WACOM_HID_G11_PEN))
173 #define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \
174 ((f)->physical == HID_DG_FINGER) || \
175 ((f)->application == HID_DG_TOUCHSCREEN) || \
176 ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \
177 ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \
178 ((f)->application == WACOM_HID_WT_TOUCHPAD) || \
179 ((f)->application == HID_DG_TOUCHPAD))
181 #define WACOM_DIRECT_DEVICE(f) (((f)->application == HID_DG_TOUCHSCREEN) || \
182 ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \
183 ((f)->application == HID_DG_PEN) || \
184 ((f)->application == WACOM_HID_WD_PEN))
186 enum {
187 PENPARTNER = 0,
188 GRAPHIRE,
189 GRAPHIRE_BT,
190 WACOM_G4,
191 PTU,
193 DTU,
194 DTUS,
195 DTUSX,
196 INTUOS,
197 INTUOS3S,
198 INTUOS3,
199 INTUOS3L,
200 INTUOS4S,
201 INTUOS4,
202 INTUOS4WL,
203 INTUOS4L,
204 INTUOS5S,
205 INTUOS5,
206 INTUOS5L,
207 INTUOSPS,
208 INTUOSPM,
209 INTUOSPL,
210 INTUOSP2_BT,
211 WACOM_21UX2,
212 WACOM_22HD,
213 DTK,
214 WACOM_24HD,
215 WACOM_27QHD,
216 CINTIQ_HYBRID,
217 CINTIQ_COMPANION_2,
218 CINTIQ,
219 WACOM_BEE,
220 WACOM_13HD,
221 WACOM_MO,
222 BAMBOO_PEN,
223 INTUOSHT,
224 INTUOSHT2,
225 BAMBOO_TOUCH,
226 BAMBOO_PT,
227 WACOM_24HDT,
228 WACOM_27QHDT,
229 BAMBOO_PAD,
230 WIRELESS,
231 REMOTE,
232 TABLETPC, /* add new TPC below */
233 TABLETPCE,
234 TABLETPC2FG,
235 MTSCREEN,
236 MTTPC,
237 MTTPC_B,
238 HID_GENERIC,
239 MAX_TYPE
242 struct wacom_features {
243 const char *name;
244 int x_max;
245 int y_max;
246 int pressure_max;
247 int distance_max;
248 int type;
249 int x_resolution;
250 int y_resolution;
251 int numbered_buttons;
252 int offset_left;
253 int offset_right;
254 int offset_top;
255 int offset_bottom;
256 int device_type;
257 int x_phy;
258 int y_phy;
259 unsigned unit;
260 int unitExpo;
261 int x_fuzz;
262 int y_fuzz;
263 int pressure_fuzz;
264 int distance_fuzz;
265 int tilt_fuzz;
266 unsigned quirks;
267 unsigned touch_max;
268 int oVid;
269 int oPid;
270 int pktlen;
271 bool check_for_hid_type;
272 int hid_type;
275 struct wacom_shared {
276 bool stylus_in_proximity;
277 bool touch_down;
278 /* for wireless device to access USB interfaces */
279 unsigned touch_max;
280 int type;
281 struct input_dev *touch_input;
282 struct hid_device *pen;
283 struct hid_device *touch;
284 bool has_mute_touch_switch;
285 bool is_touch_on;
288 struct hid_data {
289 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
290 __s16 inputmode_index; /* InputMode HID feature index in the report */
291 bool sense_state;
292 bool inrange_state;
293 bool invert_state;
294 bool tipswitch;
295 int x;
296 int y;
297 int pressure;
298 int width;
299 int height;
300 int id;
301 int cc_report;
302 int cc_index;
303 int cc_value_index;
304 int last_slot_field;
305 int num_expected;
306 int num_received;
307 int bat_status;
308 int battery_capacity;
309 int bat_charging;
310 int bat_connected;
311 int ps_connected;
312 bool pad_input_event_flag;
315 struct wacom_remote_data {
316 struct {
317 u32 serial;
318 bool connected;
319 } remote[WACOM_MAX_REMOTES];
322 struct wacom_wac {
323 char name[WACOM_NAME_MAX];
324 char pen_name[WACOM_NAME_MAX];
325 char touch_name[WACOM_NAME_MAX];
326 char pad_name[WACOM_NAME_MAX];
327 unsigned char data[WACOM_PKGLEN_MAX];
328 int tool[2];
329 int id[2];
330 __u64 serial[2];
331 bool reporting_data;
332 struct wacom_features features;
333 struct wacom_shared *shared;
334 struct input_dev *pen_input;
335 struct input_dev *touch_input;
336 struct input_dev *pad_input;
337 int pid;
338 int num_contacts_left;
339 u8 bt_features;
340 u8 bt_high_speed;
341 int mode_report;
342 int mode_value;
343 struct hid_data hid_data;
344 bool has_mute_touch_switch;
345 bool has_mode_change;
346 bool is_direct_mode;
350 #endif