1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * drivers/input/tablet/wacom_wac.h
8 #include <linux/types.h>
10 #include <linux/kfifo.h>
12 /* maximum packet length for USB/BT devices */
13 #define WACOM_PKGLEN_MAX 361
15 #define WACOM_NAME_MAX 64
16 #define WACOM_MAX_REMOTES 5
17 #define WACOM_STATUS_UNKNOWN 255
18 #define WACOM_REMOTE_BATTERY_TIMEOUT 21000000000ll
20 /* packet length for individual models */
21 #define WACOM_PKGLEN_BBFUN 9
22 #define WACOM_PKGLEN_TPC1FG 5
23 #define WACOM_PKGLEN_TPC1FG_B 10
24 #define WACOM_PKGLEN_TPC2FG 14
25 #define WACOM_PKGLEN_BBTOUCH 20
26 #define WACOM_PKGLEN_BBTOUCH3 64
27 #define WACOM_PKGLEN_BBPEN 10
28 #define WACOM_PKGLEN_WIRELESS 32
29 #define WACOM_PKGLEN_PENABLED 8
30 #define WACOM_PKGLEN_BPAD_TOUCH 32
31 #define WACOM_PKGLEN_BPAD_TOUCH_USB 64
33 /* wacom data size per MT contact */
34 #define WACOM_BYTES_PER_MT_PACKET 11
35 #define WACOM_BYTES_PER_24HDT_PACKET 14
36 #define WACOM_BYTES_PER_QHDTHID_PACKET 6
39 #define STYLUS_DEVICE_ID 0x02
40 #define TOUCH_DEVICE_ID 0x03
41 #define CURSOR_DEVICE_ID 0x06
42 #define ERASER_DEVICE_ID 0x0A
43 #define PAD_DEVICE_ID 0x0F
45 /* wacom data packet report IDs */
46 #define WACOM_REPORT_PENABLED 2
47 #define WACOM_REPORT_PENABLED_BT 3
48 #define WACOM_REPORT_INTUOS_ID1 5
49 #define WACOM_REPORT_INTUOS_ID2 6
50 #define WACOM_REPORT_INTUOSPAD 12
51 #define WACOM_REPORT_INTUOS5PAD 3
52 #define WACOM_REPORT_DTUSPAD 21
53 #define WACOM_REPORT_TPC1FG 6
54 #define WACOM_REPORT_TPC2FG 13
55 #define WACOM_REPORT_TPCMT 13
56 #define WACOM_REPORT_TPCMT2 3
57 #define WACOM_REPORT_TPCHID 15
58 #define WACOM_REPORT_CINTIQ 16
59 #define WACOM_REPORT_CINTIQPAD 17
60 #define WACOM_REPORT_TPCST 16
61 #define WACOM_REPORT_DTUS 17
62 #define WACOM_REPORT_TPC1FGE 18
63 #define WACOM_REPORT_24HDT 1
64 #define WACOM_REPORT_WL 128
65 #define WACOM_REPORT_USB 192
66 #define WACOM_REPORT_BPAD_PEN 3
67 #define WACOM_REPORT_BPAD_TOUCH 16
68 #define WACOM_REPORT_DEVICE_LIST 16
69 #define WACOM_REPORT_INTUOS_PEN 16
70 #define WACOM_REPORT_REMOTE 17
71 #define WACOM_REPORT_INTUOSHT2_ID 8
73 /* wacom command report ids */
74 #define WAC_CMD_WL_LED_CONTROL 0x03
75 #define WAC_CMD_LED_CONTROL 0x20
76 #define WAC_CMD_ICON_START 0x21
77 #define WAC_CMD_ICON_XFER 0x23
78 #define WAC_CMD_ICON_BT_XFER 0x26
79 #define WAC_CMD_DELETE_PAIRING 0x20
80 #define WAC_CMD_LED_CONTROL_GENERIC 0x32
81 #define WAC_CMD_UNPAIR_ALL 0xFF
82 #define WAC_CMD_WL_INTUOSP2 0x82
85 #define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
86 #define WACOM_QUIRK_SENSE 0x0002
87 #define WACOM_QUIRK_AESPEN 0x0004
88 #define WACOM_QUIRK_BATTERY 0x0008
89 #define WACOM_QUIRK_TOOLSERIAL 0x0010
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_SERIALNUMBER (WACOM_HID_UP_WACOMDIGITIZER | 0x5b)
111 #define WACOM_HID_WD_SERIALHI (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
112 #define WACOM_HID_WD_TOOLTYPE (WACOM_HID_UP_WACOMDIGITIZER | 0x77)
113 #define WACOM_HID_WD_DISTANCE (WACOM_HID_UP_WACOMDIGITIZER | 0x0132)
114 #define WACOM_HID_WD_TOUCHSTRIP (WACOM_HID_UP_WACOMDIGITIZER | 0x0136)
115 #define WACOM_HID_WD_TOUCHSTRIP2 (WACOM_HID_UP_WACOMDIGITIZER | 0x0137)
116 #define WACOM_HID_WD_TOUCHRING (WACOM_HID_UP_WACOMDIGITIZER | 0x0138)
117 #define WACOM_HID_WD_TOUCHRINGSTATUS (WACOM_HID_UP_WACOMDIGITIZER | 0x0139)
118 #define WACOM_HID_WD_REPORT_VALID (WACOM_HID_UP_WACOMDIGITIZER | 0x01d0)
119 #define WACOM_HID_WD_ACCELEROMETER_X (WACOM_HID_UP_WACOMDIGITIZER | 0x0401)
120 #define WACOM_HID_WD_ACCELEROMETER_Y (WACOM_HID_UP_WACOMDIGITIZER | 0x0402)
121 #define WACOM_HID_WD_ACCELEROMETER_Z (WACOM_HID_UP_WACOMDIGITIZER | 0x0403)
122 #define WACOM_HID_WD_BATTERY_CHARGING (WACOM_HID_UP_WACOMDIGITIZER | 0x0404)
123 #define WACOM_HID_WD_TOUCHONOFF (WACOM_HID_UP_WACOMDIGITIZER | 0x0454)
124 #define WACOM_HID_WD_BATTERY_LEVEL (WACOM_HID_UP_WACOMDIGITIZER | 0x043b)
125 #define WACOM_HID_WD_EXPRESSKEY00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0910)
126 #define WACOM_HID_WD_EXPRESSKEYCAP00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0940)
127 #define WACOM_HID_WD_MODE_CHANGE (WACOM_HID_UP_WACOMDIGITIZER | 0x0980)
128 #define WACOM_HID_WD_MUTE_DEVICE (WACOM_HID_UP_WACOMDIGITIZER | 0x0981)
129 #define WACOM_HID_WD_CONTROLPANEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0982)
130 #define WACOM_HID_WD_ONSCREEN_KEYBOARD (WACOM_HID_UP_WACOMDIGITIZER | 0x0983)
131 #define WACOM_HID_WD_BUTTONCONFIG (WACOM_HID_UP_WACOMDIGITIZER | 0x0986)
132 #define WACOM_HID_WD_BUTTONHOME (WACOM_HID_UP_WACOMDIGITIZER | 0x0990)
133 #define WACOM_HID_WD_BUTTONUP (WACOM_HID_UP_WACOMDIGITIZER | 0x0991)
134 #define WACOM_HID_WD_BUTTONDOWN (WACOM_HID_UP_WACOMDIGITIZER | 0x0992)
135 #define WACOM_HID_WD_BUTTONLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0993)
136 #define WACOM_HID_WD_BUTTONRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0994)
137 #define WACOM_HID_WD_BUTTONCENTER (WACOM_HID_UP_WACOMDIGITIZER | 0x0995)
138 #define WACOM_HID_WD_FINGERWHEEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03)
139 #define WACOM_HID_WD_OFFSETLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d30)
140 #define WACOM_HID_WD_OFFSETTOP (WACOM_HID_UP_WACOMDIGITIZER | 0x0d31)
141 #define WACOM_HID_WD_OFFSETRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d32)
142 #define WACOM_HID_WD_OFFSETBOTTOM (WACOM_HID_UP_WACOMDIGITIZER | 0x0d33)
143 #define WACOM_HID_WD_DATAMODE (WACOM_HID_UP_WACOMDIGITIZER | 0x1002)
144 #define WACOM_HID_WD_DIGITIZERINFO (WACOM_HID_UP_WACOMDIGITIZER | 0x1013)
145 #define WACOM_HID_WD_TOUCH_RING_SETTING (WACOM_HID_UP_WACOMDIGITIZER | 0x1032)
146 #define WACOM_HID_UP_G9 0xff090000
147 #define WACOM_HID_G9_PEN (WACOM_HID_UP_G9 | 0x02)
148 #define WACOM_HID_G9_TOUCHSCREEN (WACOM_HID_UP_G9 | 0x11)
149 #define WACOM_HID_UP_G11 0xff110000
150 #define WACOM_HID_G11_PEN (WACOM_HID_UP_G11 | 0x02)
151 #define WACOM_HID_G11_TOUCHSCREEN (WACOM_HID_UP_G11 | 0x11)
152 #define WACOM_HID_UP_WACOMTOUCH 0xff000000
153 #define WACOM_HID_WT_TOUCHSCREEN (WACOM_HID_UP_WACOMTOUCH | 0x04)
154 #define WACOM_HID_WT_TOUCHPAD (WACOM_HID_UP_WACOMTOUCH | 0x05)
155 #define WACOM_HID_WT_CONTACTMAX (WACOM_HID_UP_WACOMTOUCH | 0x55)
156 #define WACOM_HID_WT_SERIALNUMBER (WACOM_HID_UP_WACOMTOUCH | 0x5b)
157 #define WACOM_HID_WT_X (WACOM_HID_UP_WACOMTOUCH | 0x130)
158 #define WACOM_HID_WT_Y (WACOM_HID_UP_WACOMTOUCH | 0x131)
159 #define WACOM_HID_WT_REPORT_VALID (WACOM_HID_UP_WACOMTOUCH | 0x1d0)
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))
239 TABLETPC, /* add new TPC below */
250 struct wacom_features {
259 int numbered_buttons;
279 bool check_for_hid_type;
283 struct wacom_shared {
284 bool stylus_in_proximity;
286 /* for wireless device to access USB interfaces */
289 struct input_dev *touch_input;
290 struct hid_device *pen;
291 struct hid_device *touch;
292 bool has_mute_touch_switch;
297 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
298 __s16 inputmode_index; /* InputMode HID feature index in the report */
319 int battery_capacity;
323 bool pad_input_event_flag;
324 ktime_t time_delayed;
327 struct wacom_remote_data {
331 } remote[WACOM_MAX_REMOTES];
335 char name[WACOM_NAME_MAX];
336 char pen_name[WACOM_NAME_MAX];
337 char touch_name[WACOM_NAME_MAX];
338 char pad_name[WACOM_NAME_MAX];
339 unsigned char data[WACOM_PKGLEN_MAX];
344 struct wacom_features features;
345 struct wacom_shared *shared;
346 struct input_dev *pen_input;
347 struct input_dev *touch_input;
348 struct input_dev *pad_input;
349 struct kfifo_rec_ptr_2 *pen_fifo;
351 int num_contacts_left;
356 struct hid_data hid_data;
357 bool has_mute_touch_switch;
358 bool has_mode_change;
360 bool is_invalid_bt_frame;