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