net: dsa: microchip: ksz8795: Don't use phy_port_cnt in VLAN table lookup
[linux-2.6-block.git] / drivers / hid / wacom_wac.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
3bea733a 2/*
4104d13f 3 * drivers/input/tablet/wacom_wac.h
3bea733a
PC
4 */
5#ifndef WACOM_WAC_H
6#define WACOM_WAC_H
7
51269fe8 8#include <linux/types.h>
d97a5522 9#include <linux/hid.h>
83417206 10#include <linux/kfifo.h>
51269fe8 11
4922cd26
JG
12/* maximum packet length for USB/BT devices */
13#define WACOM_PKGLEN_MAX 361
ee54500d 14
57bcfce3 15#define WACOM_NAME_MAX 64
72b236d6
AS
16#define WACOM_MAX_REMOTES 5
17#define WACOM_STATUS_UNKNOWN 255
57bcfce3 18
ee54500d 19/* packet length for individual models */
e33da8a5 20#define WACOM_PKGLEN_BBFUN 9
ee54500d 21#define WACOM_PKGLEN_TPC1FG 5
61616ed0 22#define WACOM_PKGLEN_TPC1FG_B 10
e33da8a5 23#define WACOM_PKGLEN_TPC2FG 14
4a88081e 24#define WACOM_PKGLEN_BBTOUCH 20
4134361a 25#define WACOM_PKGLEN_BBTOUCH3 64
73149ab8 26#define WACOM_PKGLEN_BBPEN 10
d3825d51 27#define WACOM_PKGLEN_WIRELESS 32
d51ddb2b 28#define WACOM_PKGLEN_PENABLED 8
8c97a765
BT
29#define WACOM_PKGLEN_BPAD_TOUCH 32
30#define WACOM_PKGLEN_BPAD_TOUCH_USB 64
1963518b
PC
31
32/* wacom data size per MT contact */
33#define WACOM_BYTES_PER_MT_PACKET 11
b1e4279e 34#define WACOM_BYTES_PER_24HDT_PACKET 14
500d4160 35#define WACOM_BYTES_PER_QHDTHID_PACKET 6
ee54500d 36
ec67bbed 37/* device IDs */
3bea733a 38#define STYLUS_DEVICE_ID 0x02
545f4e99 39#define TOUCH_DEVICE_ID 0x03
3bea733a
PC
40#define CURSOR_DEVICE_ID 0x06
41#define ERASER_DEVICE_ID 0x0A
80d4e8e9 42#define PAD_DEVICE_ID 0x0F
3bea733a 43
cad74700
PC
44/* wacom data packet report IDs */
45#define WACOM_REPORT_PENABLED 2
387142bb 46#define WACOM_REPORT_PENABLED_BT 3
06109993
JG
47#define WACOM_REPORT_INTUOS_ID1 5
48#define WACOM_REPORT_INTUOS_ID2 6
cad74700 49#define WACOM_REPORT_INTUOSPAD 12
f860e581 50#define WACOM_REPORT_INTUOS5PAD 3
497ab1f2 51#define WACOM_REPORT_DTUSPAD 21
cad74700
PC
52#define WACOM_REPORT_TPC1FG 6
53#define WACOM_REPORT_TPC2FG 13
1963518b 54#define WACOM_REPORT_TPCMT 13
d51ddb2b 55#define WACOM_REPORT_TPCMT2 3
31175a83 56#define WACOM_REPORT_TPCHID 15
500d4160
PC
57#define WACOM_REPORT_CINTIQ 16
58#define WACOM_REPORT_CINTIQPAD 17
31175a83 59#define WACOM_REPORT_TPCST 16
497ab1f2 60#define WACOM_REPORT_DTUS 17
ac173837 61#define WACOM_REPORT_TPC1FGE 18
b1e4279e 62#define WACOM_REPORT_24HDT 1
b5fd2a3e 63#define WACOM_REPORT_WL 128
961794a0 64#define WACOM_REPORT_USB 192
8c97a765
BT
65#define WACOM_REPORT_BPAD_PEN 3
66#define WACOM_REPORT_BPAD_TOUCH 16
72b236d6 67#define WACOM_REPORT_DEVICE_LIST 16
eda01dab 68#define WACOM_REPORT_INTUOS_PEN 16
72b236d6 69#define WACOM_REPORT_REMOTE 17
0bbfe28a 70#define WACOM_REPORT_INTUOSHT2_ID 8
cad74700 71
5ba13c64
JG
72/* wacom command report ids */
73#define WAC_CMD_WL_LED_CONTROL 0x03
74#define WAC_CMD_LED_CONTROL 0x20
75#define WAC_CMD_ICON_START 0x21
76#define WAC_CMD_ICON_XFER 0x23
77#define WAC_CMD_ICON_BT_XFER 0x26
78#define WAC_CMD_DELETE_PAIRING 0x20
10c55cac 79#define WAC_CMD_LED_CONTROL_GENERIC 0x32
5ba13c64 80#define WAC_CMD_UNPAIR_ALL 0xFF
4922cd26 81#define WAC_CMD_WL_INTUOSP2 0x82
5ba13c64 82
bc73dd39 83/* device quirks */
f3586d2f 84#define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
61ce346a 85#define WACOM_QUIRK_SENSE 0x0002
99acedad 86#define WACOM_QUIRK_AESPEN 0x0004
f3586d2f 87#define WACOM_QUIRK_BATTERY 0x0008
83417206 88#define WACOM_QUIRK_TOOLSERIAL 0x0010
bc73dd39 89
aa86b18c
JG
90/* device types */
91#define WACOM_DEVICETYPE_NONE 0x0000
92#define WACOM_DEVICETYPE_PEN 0x0001
93#define WACOM_DEVICETYPE_TOUCH 0x0002
862cf553 94#define WACOM_DEVICETYPE_PAD 0x0004
ccad85cc 95#define WACOM_DEVICETYPE_WL_MONITOR 0x0008
e5bc8eb1 96#define WACOM_DEVICETYPE_DIRECT 0x0010
aa86b18c 97
16e45989
JG
98#define WACOM_POWER_SUPPLY_STATUS_AUTO -1
99
8de82280 100#define WACOM_HID_UP_WACOMDIGITIZER 0xff0d0000
5922e613
JG
101#define WACOM_HID_SP_PAD 0x00040000
102#define WACOM_HID_SP_BUTTON 0x00090000
c9c09587
JG
103#define WACOM_HID_SP_DIGITIZER 0x000d0000
104#define WACOM_HID_SP_DIGITIZERINFO 0x00100000
8de82280 105#define WACOM_HID_WD_DIGITIZER (WACOM_HID_UP_WACOMDIGITIZER | 0x01)
ac2423c9 106#define WACOM_HID_WD_PEN (WACOM_HID_UP_WACOMDIGITIZER | 0x02)
61ce346a 107#define WACOM_HID_WD_SENSE (WACOM_HID_UP_WACOMDIGITIZER | 0x36)
5922e613 108#define WACOM_HID_WD_DIGITIZERFNKEYS (WACOM_HID_UP_WACOMDIGITIZER | 0x39)
99acedad 109#define WACOM_HID_WD_SERIALNUMBER (WACOM_HID_UP_WACOMDIGITIZER | 0x5b)
f85c9dc6
JG
110#define WACOM_HID_WD_SERIALHI (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
111#define WACOM_HID_WD_TOOLTYPE (WACOM_HID_UP_WACOMDIGITIZER | 0x77)
b5c921e6 112#define WACOM_HID_WD_DISTANCE (WACOM_HID_UP_WACOMDIGITIZER | 0x0132)
bf78adcb
JG
113#define WACOM_HID_WD_TOUCHSTRIP (WACOM_HID_UP_WACOMDIGITIZER | 0x0136)
114#define WACOM_HID_WD_TOUCHSTRIP2 (WACOM_HID_UP_WACOMDIGITIZER | 0x0137)
5922e613
JG
115#define WACOM_HID_WD_TOUCHRING (WACOM_HID_UP_WACOMDIGITIZER | 0x0138)
116#define WACOM_HID_WD_TOUCHRINGSTATUS (WACOM_HID_UP_WACOMDIGITIZER | 0x0139)
b1f466a9 117#define WACOM_HID_WD_REPORT_VALID (WACOM_HID_UP_WACOMDIGITIZER | 0x01d0)
5922e613
JG
118#define WACOM_HID_WD_ACCELEROMETER_X (WACOM_HID_UP_WACOMDIGITIZER | 0x0401)
119#define WACOM_HID_WD_ACCELEROMETER_Y (WACOM_HID_UP_WACOMDIGITIZER | 0x0402)
120#define WACOM_HID_WD_ACCELEROMETER_Z (WACOM_HID_UP_WACOMDIGITIZER | 0x0403)
93aab7fa 121#define WACOM_HID_WD_BATTERY_CHARGING (WACOM_HID_UP_WACOMDIGITIZER | 0x0404)
d2ec58ae 122#define WACOM_HID_WD_TOUCHONOFF (WACOM_HID_UP_WACOMDIGITIZER | 0x0454)
93aab7fa 123#define WACOM_HID_WD_BATTERY_LEVEL (WACOM_HID_UP_WACOMDIGITIZER | 0x043b)
5922e613 124#define WACOM_HID_WD_EXPRESSKEY00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0910)
424d8237 125#define WACOM_HID_WD_EXPRESSKEYCAP00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0940)
4082da80 126#define WACOM_HID_WD_MODE_CHANGE (WACOM_HID_UP_WACOMDIGITIZER | 0x0980)
d793ff81 127#define WACOM_HID_WD_MUTE_DEVICE (WACOM_HID_UP_WACOMDIGITIZER | 0x0981)
4eb220cb
PC
128#define WACOM_HID_WD_CONTROLPANEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0982)
129#define WACOM_HID_WD_ONSCREEN_KEYBOARD (WACOM_HID_UP_WACOMDIGITIZER | 0x0983)
130#define WACOM_HID_WD_BUTTONCONFIG (WACOM_HID_UP_WACOMDIGITIZER | 0x0986)
5922e613
JG
131#define WACOM_HID_WD_BUTTONHOME (WACOM_HID_UP_WACOMDIGITIZER | 0x0990)
132#define WACOM_HID_WD_BUTTONUP (WACOM_HID_UP_WACOMDIGITIZER | 0x0991)
133#define WACOM_HID_WD_BUTTONDOWN (WACOM_HID_UP_WACOMDIGITIZER | 0x0992)
134#define WACOM_HID_WD_BUTTONLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0993)
135#define WACOM_HID_WD_BUTTONRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0994)
bf78adcb 136#define WACOM_HID_WD_BUTTONCENTER (WACOM_HID_UP_WACOMDIGITIZER | 0x0995)
929d6d5d 137#define WACOM_HID_WD_FINGERWHEEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03)
345857bb
JG
138#define WACOM_HID_WD_OFFSETLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d30)
139#define WACOM_HID_WD_OFFSETTOP (WACOM_HID_UP_WACOMDIGITIZER | 0x0d31)
140#define WACOM_HID_WD_OFFSETRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d32)
141#define WACOM_HID_WD_OFFSETBOTTOM (WACOM_HID_UP_WACOMDIGITIZER | 0x0d33)
c9c09587 142#define WACOM_HID_WD_DATAMODE (WACOM_HID_UP_WACOMDIGITIZER | 0x1002)
5922e613 143#define WACOM_HID_WD_DIGITIZERINFO (WACOM_HID_UP_WACOMDIGITIZER | 0x1013)
d8e98060 144#define WACOM_HID_WD_TOUCH_RING_SETTING (WACOM_HID_UP_WACOMDIGITIZER | 0x1032)
8de82280
JG
145#define WACOM_HID_UP_G9 0xff090000
146#define WACOM_HID_G9_PEN (WACOM_HID_UP_G9 | 0x02)
147#define WACOM_HID_G9_TOUCHSCREEN (WACOM_HID_UP_G9 | 0x11)
148#define WACOM_HID_UP_G11 0xff110000
149#define WACOM_HID_G11_PEN (WACOM_HID_UP_G11 | 0x02)
150#define WACOM_HID_G11_TOUCHSCREEN (WACOM_HID_UP_G11 | 0x11)
ac2423c9
AAS
151#define WACOM_HID_UP_WACOMTOUCH 0xff000000
152#define WACOM_HID_WT_TOUCHSCREEN (WACOM_HID_UP_WACOMTOUCH | 0x04)
153#define WACOM_HID_WT_TOUCHPAD (WACOM_HID_UP_WACOMTOUCH | 0x05)
154#define WACOM_HID_WT_CONTACTMAX (WACOM_HID_UP_WACOMTOUCH | 0x55)
99acedad 155#define WACOM_HID_WT_SERIALNUMBER (WACOM_HID_UP_WACOMTOUCH | 0x5b)
ac2423c9
AAS
156#define WACOM_HID_WT_X (WACOM_HID_UP_WACOMTOUCH | 0x130)
157#define WACOM_HID_WT_Y (WACOM_HID_UP_WACOMTOUCH | 0x131)
f4e11d59 158#define WACOM_HID_WT_REPORT_VALID (WACOM_HID_UP_WACOMTOUCH | 0x1d0)
042628ab 159
5ac3d4ae
JG
160#define WACOM_BATTERY_USAGE(f) (((f)->hid == HID_DG_BATTERYSTRENGTH) || \
161 ((f)->hid == WACOM_HID_WD_BATTERY_CHARGING) || \
162 ((f)->hid == WACOM_HID_WD_BATTERY_LEVEL))
163
5922e613
JG
164#define WACOM_PAD_FIELD(f) (((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \
165 ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \
166 ((f)->physical == WACOM_HID_WD_DIGITIZERINFO))
167
d97a5522
BT
168#define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \
169 ((f)->physical == HID_DG_STYLUS) || \
61e9e7e4 170 ((f)->physical == HID_DG_PEN) || \
042628ab
JG
171 ((f)->application == HID_DG_PEN) || \
172 ((f)->application == HID_DG_DIGITIZER) || \
885e89f6 173 ((f)->application == WACOM_HID_WD_PEN) || \
1b18b75c
JG
174 ((f)->application == WACOM_HID_WD_DIGITIZER) || \
175 ((f)->application == WACOM_HID_G9_PEN) || \
176 ((f)->application == WACOM_HID_G11_PEN))
d97a5522
BT
177#define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \
178 ((f)->physical == HID_DG_FINGER) || \
1b18b75c
JG
179 ((f)->application == HID_DG_TOUCHSCREEN) || \
180 ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \
ac2423c9
AAS
181 ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \
182 ((f)->application == WACOM_HID_WT_TOUCHPAD) || \
183 ((f)->application == HID_DG_TOUCHPAD))
184
185#define WACOM_DIRECT_DEVICE(f) (((f)->application == HID_DG_TOUCHSCREEN) || \
186 ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \
187 ((f)->application == HID_DG_PEN) || \
188 ((f)->application == WACOM_HID_WD_PEN))
d97a5522 189
3bea733a
PC
190enum {
191 PENPARTNER = 0,
192 GRAPHIRE,
387142bb 193 GRAPHIRE_BT,
3bea733a
PC
194 WACOM_G4,
195 PTU,
196 PL,
c8f2edc5 197 DTU,
497ab1f2 198 DTUS,
fff00bf8 199 DTUSX,
3bea733a 200 INTUOS,
8d32e3ae 201 INTUOS3S,
3bea733a
PC
202 INTUOS3,
203 INTUOS3L,
6f660f12
PC
204 INTUOS4S,
205 INTUOS4,
81af7e61 206 INTUOS4WL,
6f660f12 207 INTUOS4L,
9fee6195
JG
208 INTUOS5S,
209 INTUOS5,
210 INTUOS5L,
9a35c411
PC
211 INTUOSPS,
212 INTUOSPM,
213 INTUOSPL,
4922cd26 214 INTUOSP2_BT,
912c6aa6 215 INTUOSP2S_BT,
87046b6c 216 INTUOSHT3_BT,
3a4b4aaa 217 WACOM_21UX2,
d838c644 218 WACOM_22HD,
a112e9fd 219 DTK,
d838c644 220 WACOM_24HD,
500d4160 221 WACOM_27QHD,
36d3c510 222 CINTIQ_HYBRID,
f7acb55c 223 CINTIQ_COMPANION_2,
3bea733a 224 CINTIQ,
0e1763f5 225 WACOM_BEE,
56218563 226 WACOM_13HD,
7ecfbfd3 227 WACOM_MO,
3b164a00
PC
228 BAMBOO_PEN,
229 INTUOSHT,
eda01dab 230 INTUOSHT2,
3b164a00 231 BAMBOO_TOUCH,
ea2e6024 232 BAMBOO_PT,
b1e4279e 233 WACOM_24HDT,
500d4160 234 WACOM_27QHDT,
8c97a765 235 BAMBOO_PAD,
7adb91bd 236 WIRELESS,
72b236d6 237 REMOTE,
ea2e6024 238 TABLETPC, /* add new TPC below */
ac173837 239 TABLETPCE,
ec67bbed 240 TABLETPC2FG,
1963518b 241 MTSCREEN,
6afdc289 242 MTTPC,
d51ddb2b 243 MTTPC_B,
7704ac93 244 HID_GENERIC,
3bea733a
PC
245 MAX_TYPE
246};
247
248struct wacom_features {
e33da8a5 249 const char *name;
3bea733a
PC
250 int x_max;
251 int y_max;
252 int pressure_max;
253 int distance_max;
254 int type;
e35fb8c1
PC
255 int x_resolution;
256 int y_resolution;
70ee06c5 257 int numbered_buttons;
e779ef23
JG
258 int offset_left;
259 int offset_right;
260 int offset_top;
261 int offset_bottom;
ec67bbed
PC
262 int device_type;
263 int x_phy;
264 int y_phy;
c669fb2b
BT
265 unsigned unit;
266 int unitExpo;
fed87e65
HR
267 int x_fuzz;
268 int y_fuzz;
269 int pressure_fuzz;
270 int distance_fuzz;
bef7e200 271 int tilt_fuzz;
bc73dd39 272 unsigned quirks;
f393ee2b 273 unsigned touch_max;
aea2bf6a
JG
274 int oVid;
275 int oPid;
80befa93 276 int pktlen;
29b47391
BT
277 bool check_for_hid_type;
278 int hid_type;
3bea733a
PC
279};
280
4492efff
PC
281struct wacom_shared {
282 bool stylus_in_proximity;
a43c7c53 283 bool touch_down;
961794a0
PC
284 /* for wireless device to access USB interfaces */
285 unsigned touch_max;
286 int type;
287 struct input_dev *touch_input;
a97ac104
BT
288 struct hid_device *pen;
289 struct hid_device *touch;
d2ec58ae 290 bool has_mute_touch_switch;
d793ff81 291 bool is_touch_on;
4492efff
PC
292};
293
7704ac93 294struct hid_data {
5ae6e89f
BT
295 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
296 __s16 inputmode_index; /* InputMode HID feature index in the report */
61ce346a 297 bool sense_state;
7704ac93
BT
298 bool inrange_state;
299 bool invert_state;
300 bool tipswitch;
9e429d56
JG
301 bool barrelswitch;
302 bool barrelswitch2;
46fc466e 303 bool serialhi;
5ae6e89f
BT
304 int x;
305 int y;
306 int pressure;
307 int width;
308 int height;
309 int id;
499522c8 310 int cc_report;
1b5d514a
JG
311 int cc_index;
312 int cc_value_index;
003f50ab 313 int last_slot_field;
1b5d514a
JG
314 int num_expected;
315 int num_received;
16e45989 316 int bat_status;
93aab7fa
JG
317 int battery_capacity;
318 int bat_charging;
319 int bat_connected;
320 int ps_connected;
ed1fa736 321 bool pad_input_event_flag;
7704ac93
BT
322};
323
e6f2813a
BT
324struct wacom_remote_data {
325 struct {
326 u32 serial;
327 bool connected;
328 } remote[WACOM_MAX_REMOTES];
329};
330
3bea733a 331struct wacom_wac {
9956953e 332 char name[WACOM_NAME_MAX];
2a6cdbdd
JG
333 char pen_name[WACOM_NAME_MAX];
334 char touch_name[WACOM_NAME_MAX];
d2d13f18 335 char pad_name[WACOM_NAME_MAX];
29b47391 336 unsigned char data[WACOM_PKGLEN_MAX];
4fc19381
PC
337 int tool[2];
338 int id[2];
f85c9dc6 339 __u64 serial[2];
b3bd7ef3 340 bool reporting_data;
e33da8a5 341 struct wacom_features features;
4492efff 342 struct wacom_shared *shared;
2a6cdbdd
JG
343 struct input_dev *pen_input;
344 struct input_dev *touch_input;
d2d13f18 345 struct input_dev *pad_input;
179e8e47 346 struct kfifo_rec_ptr_2 *pen_fifo;
16bf288c 347 int pid;
1963518b 348 int num_contacts_left;
f81a1295
BT
349 u8 bt_features;
350 u8 bt_high_speed;
326ea2a9
JG
351 int mode_report;
352 int mode_value;
7704ac93 353 struct hid_data hid_data;
d2ec58ae 354 bool has_mute_touch_switch;
4082da80
BT
355 bool has_mode_change;
356 bool is_direct_mode;
b1f466a9 357 bool is_invalid_bt_frame;
3bea733a
PC
358};
359
360#endif