xref: /openbmc/linux/drivers/hid/wacom_wac.h (revision d236d361)
1 /*
2  * drivers/input/tablet/wacom_wac.h
3  *
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
11 
12 #include <linux/types.h>
13 #include <linux/hid.h>
14 
15 /* maximum packet length for USB/BT devices */
16 #define WACOM_PKGLEN_MAX	361
17 
18 #define WACOM_NAME_MAX		64
19 #define WACOM_MAX_REMOTES	5
20 #define WACOM_STATUS_UNKNOWN	255
21 
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
34 
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
39 
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
46 
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
74 
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
85 
86 /* device quirks */
87 #define WACOM_QUIRK_BBTOUCH_LOWRES	0x0001
88 #define WACOM_QUIRK_SENSE		0x0002
89 #define WACOM_QUIRK_BATTERY		0x0008
90 
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
98 
99 #define WACOM_HID_UP_WACOMDIGITIZER     0xff0d0000
100 #define WACOM_HID_SP_PAD                0x00040000
101 #define WACOM_HID_SP_BUTTON             0x00090000
102 #define WACOM_HID_SP_DIGITIZER          0x000d0000
103 #define WACOM_HID_SP_DIGITIZERINFO      0x00100000
104 #define WACOM_HID_WD_DIGITIZER          (WACOM_HID_UP_WACOMDIGITIZER | 0x01)
105 #define WACOM_HID_WD_PEN                (WACOM_HID_UP_WACOMDIGITIZER | 0x02)
106 #define WACOM_HID_WD_SENSE              (WACOM_HID_UP_WACOMDIGITIZER | 0x36)
107 #define WACOM_HID_WD_DIGITIZERFNKEYS    (WACOM_HID_UP_WACOMDIGITIZER | 0x39)
108 #define WACOM_HID_WD_SERIALHI           (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
109 #define WACOM_HID_WD_TOOLTYPE           (WACOM_HID_UP_WACOMDIGITIZER | 0x77)
110 #define WACOM_HID_WD_DISTANCE           (WACOM_HID_UP_WACOMDIGITIZER | 0x0132)
111 #define WACOM_HID_WD_TOUCHSTRIP         (WACOM_HID_UP_WACOMDIGITIZER | 0x0136)
112 #define WACOM_HID_WD_TOUCHSTRIP2        (WACOM_HID_UP_WACOMDIGITIZER | 0x0137)
113 #define WACOM_HID_WD_TOUCHRING          (WACOM_HID_UP_WACOMDIGITIZER | 0x0138)
114 #define WACOM_HID_WD_TOUCHRINGSTATUS    (WACOM_HID_UP_WACOMDIGITIZER | 0x0139)
115 #define WACOM_HID_WD_ACCELEROMETER_X    (WACOM_HID_UP_WACOMDIGITIZER | 0x0401)
116 #define WACOM_HID_WD_ACCELEROMETER_Y    (WACOM_HID_UP_WACOMDIGITIZER | 0x0402)
117 #define WACOM_HID_WD_ACCELEROMETER_Z    (WACOM_HID_UP_WACOMDIGITIZER | 0x0403)
118 #define WACOM_HID_WD_BATTERY_CHARGING   (WACOM_HID_UP_WACOMDIGITIZER | 0x0404)
119 #define WACOM_HID_WD_TOUCHONOFF         (WACOM_HID_UP_WACOMDIGITIZER | 0x0454)
120 #define WACOM_HID_WD_BATTERY_LEVEL      (WACOM_HID_UP_WACOMDIGITIZER | 0x043b)
121 #define WACOM_HID_WD_EXPRESSKEY00       (WACOM_HID_UP_WACOMDIGITIZER | 0x0910)
122 #define WACOM_HID_WD_EXPRESSKEYCAP00    (WACOM_HID_UP_WACOMDIGITIZER | 0x0950)
123 #define WACOM_HID_WD_MODE_CHANGE        (WACOM_HID_UP_WACOMDIGITIZER | 0x0980)
124 #define WACOM_HID_WD_MUTE_DEVICE        (WACOM_HID_UP_WACOMDIGITIZER | 0x0981)
125 #define WACOM_HID_WD_CONTROLPANEL       (WACOM_HID_UP_WACOMDIGITIZER | 0x0982)
126 #define WACOM_HID_WD_ONSCREEN_KEYBOARD  (WACOM_HID_UP_WACOMDIGITIZER | 0x0983)
127 #define WACOM_HID_WD_BUTTONCONFIG       (WACOM_HID_UP_WACOMDIGITIZER | 0x0986)
128 #define WACOM_HID_WD_BUTTONHOME         (WACOM_HID_UP_WACOMDIGITIZER | 0x0990)
129 #define WACOM_HID_WD_BUTTONUP           (WACOM_HID_UP_WACOMDIGITIZER | 0x0991)
130 #define WACOM_HID_WD_BUTTONDOWN         (WACOM_HID_UP_WACOMDIGITIZER | 0x0992)
131 #define WACOM_HID_WD_BUTTONLEFT         (WACOM_HID_UP_WACOMDIGITIZER | 0x0993)
132 #define WACOM_HID_WD_BUTTONRIGHT        (WACOM_HID_UP_WACOMDIGITIZER | 0x0994)
133 #define WACOM_HID_WD_BUTTONCENTER       (WACOM_HID_UP_WACOMDIGITIZER | 0x0995)
134 #define WACOM_HID_WD_FINGERWHEEL        (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03)
135 #define WACOM_HID_WD_OFFSETLEFT         (WACOM_HID_UP_WACOMDIGITIZER | 0x0d30)
136 #define WACOM_HID_WD_OFFSETTOP          (WACOM_HID_UP_WACOMDIGITIZER | 0x0d31)
137 #define WACOM_HID_WD_OFFSETRIGHT        (WACOM_HID_UP_WACOMDIGITIZER | 0x0d32)
138 #define WACOM_HID_WD_OFFSETBOTTOM       (WACOM_HID_UP_WACOMDIGITIZER | 0x0d33)
139 #define WACOM_HID_WD_DATAMODE           (WACOM_HID_UP_WACOMDIGITIZER | 0x1002)
140 #define WACOM_HID_WD_DIGITIZERINFO      (WACOM_HID_UP_WACOMDIGITIZER | 0x1013)
141 #define WACOM_HID_UP_G9                 0xff090000
142 #define WACOM_HID_G9_PEN                (WACOM_HID_UP_G9 | 0x02)
143 #define WACOM_HID_G9_TOUCHSCREEN        (WACOM_HID_UP_G9 | 0x11)
144 #define WACOM_HID_UP_G11                0xff110000
145 #define WACOM_HID_G11_PEN               (WACOM_HID_UP_G11 | 0x02)
146 #define WACOM_HID_G11_TOUCHSCREEN       (WACOM_HID_UP_G11 | 0x11)
147 #define WACOM_HID_UP_WACOMTOUCH         0xff000000
148 #define WACOM_HID_WT_TOUCHSCREEN        (WACOM_HID_UP_WACOMTOUCH | 0x04)
149 #define WACOM_HID_WT_TOUCHPAD           (WACOM_HID_UP_WACOMTOUCH | 0x05)
150 #define WACOM_HID_WT_CONTACTMAX         (WACOM_HID_UP_WACOMTOUCH | 0x55)
151 #define WACOM_HID_WT_X                  (WACOM_HID_UP_WACOMTOUCH | 0x130)
152 #define WACOM_HID_WT_Y                  (WACOM_HID_UP_WACOMTOUCH | 0x131)
153 
154 #define WACOM_PAD_FIELD(f)	(((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \
155 				 ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \
156 				 ((f)->physical == WACOM_HID_WD_DIGITIZERINFO))
157 
158 #define WACOM_PEN_FIELD(f)	(((f)->logical == HID_DG_STYLUS) || \
159 				 ((f)->physical == HID_DG_STYLUS) || \
160 				 ((f)->physical == HID_DG_PEN) || \
161 				 ((f)->application == HID_DG_PEN) || \
162 				 ((f)->application == HID_DG_DIGITIZER) || \
163 				 ((f)->application == WACOM_HID_WD_DIGITIZER) || \
164 				 ((f)->application == WACOM_HID_G9_PEN) || \
165 				 ((f)->application == WACOM_HID_G11_PEN))
166 #define WACOM_FINGER_FIELD(f)	(((f)->logical == HID_DG_FINGER) || \
167 				 ((f)->physical == HID_DG_FINGER) || \
168 				 ((f)->application == HID_DG_TOUCHSCREEN) || \
169 				 ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \
170 				 ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \
171 				 ((f)->application == WACOM_HID_WT_TOUCHPAD) || \
172 				 ((f)->application == HID_DG_TOUCHPAD))
173 
174 #define WACOM_DIRECT_DEVICE(f)	(((f)->application == HID_DG_TOUCHSCREEN) || \
175 				 ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \
176 				 ((f)->application == HID_DG_PEN) || \
177 				 ((f)->application == WACOM_HID_WD_PEN))
178 
179 enum {
180 	PENPARTNER = 0,
181 	GRAPHIRE,
182 	GRAPHIRE_BT,
183 	WACOM_G4,
184 	PTU,
185 	PL,
186 	DTU,
187 	DTUS,
188 	DTUSX,
189 	INTUOS,
190 	INTUOS3S,
191 	INTUOS3,
192 	INTUOS3L,
193 	INTUOS4S,
194 	INTUOS4,
195 	INTUOS4WL,
196 	INTUOS4L,
197 	INTUOS5S,
198 	INTUOS5,
199 	INTUOS5L,
200 	INTUOSPS,
201 	INTUOSPM,
202 	INTUOSPL,
203 	INTUOSP2_BT,
204 	WACOM_21UX2,
205 	WACOM_22HD,
206 	DTK,
207 	WACOM_24HD,
208 	WACOM_27QHD,
209 	CINTIQ_HYBRID,
210 	CINTIQ_COMPANION_2,
211 	CINTIQ,
212 	WACOM_BEE,
213 	WACOM_13HD,
214 	WACOM_MO,
215 	BAMBOO_PEN,
216 	INTUOSHT,
217 	INTUOSHT2,
218 	BAMBOO_TOUCH,
219 	BAMBOO_PT,
220 	WACOM_24HDT,
221 	WACOM_27QHDT,
222 	BAMBOO_PAD,
223 	WIRELESS,
224 	REMOTE,
225 	TABLETPC,   /* add new TPC below */
226 	TABLETPCE,
227 	TABLETPC2FG,
228 	MTSCREEN,
229 	MTTPC,
230 	MTTPC_B,
231 	HID_GENERIC,
232 	MAX_TYPE
233 };
234 
235 struct wacom_features {
236 	const char *name;
237 	int x_max;
238 	int y_max;
239 	int pressure_max;
240 	int distance_max;
241 	int type;
242 	int x_resolution;
243 	int y_resolution;
244 	int numbered_buttons;
245 	int offset_left;
246 	int offset_right;
247 	int offset_top;
248 	int offset_bottom;
249 	int device_type;
250 	int x_phy;
251 	int y_phy;
252 	unsigned unit;
253 	int unitExpo;
254 	int x_fuzz;
255 	int y_fuzz;
256 	int pressure_fuzz;
257 	int distance_fuzz;
258 	int tilt_fuzz;
259 	unsigned quirks;
260 	unsigned touch_max;
261 	int oVid;
262 	int oPid;
263 	int pktlen;
264 	bool check_for_hid_type;
265 	int hid_type;
266 };
267 
268 struct wacom_shared {
269 	bool stylus_in_proximity;
270 	bool touch_down;
271 	/* for wireless device to access USB interfaces */
272 	unsigned touch_max;
273 	int type;
274 	struct input_dev *touch_input;
275 	struct hid_device *pen;
276 	struct hid_device *touch;
277 	bool has_mute_touch_switch;
278 	bool is_touch_on;
279 };
280 
281 struct hid_data {
282 	__s16 inputmode;	/* InputMode HID feature, -1 if non-existent */
283 	__s16 inputmode_index;	/* InputMode HID feature index in the report */
284 	bool sense_state;
285 	bool inrange_state;
286 	bool invert_state;
287 	bool tipswitch;
288 	int x;
289 	int y;
290 	int pressure;
291 	int width;
292 	int height;
293 	int id;
294 	int cc_report;
295 	int cc_index;
296 	int cc_value_index;
297 	int last_slot_field;
298 	int num_expected;
299 	int num_received;
300 	int battery_capacity;
301 	int bat_charging;
302 	int bat_connected;
303 	int ps_connected;
304 	bool pad_input_event_flag;
305 };
306 
307 struct wacom_remote_data {
308 	struct {
309 		u32 serial;
310 		bool connected;
311 	} remote[WACOM_MAX_REMOTES];
312 };
313 
314 struct wacom_wac {
315 	char name[WACOM_NAME_MAX];
316 	char pen_name[WACOM_NAME_MAX];
317 	char touch_name[WACOM_NAME_MAX];
318 	char pad_name[WACOM_NAME_MAX];
319 	unsigned char data[WACOM_PKGLEN_MAX];
320 	int tool[2];
321 	int id[2];
322 	__u64 serial[2];
323 	bool reporting_data;
324 	struct wacom_features features;
325 	struct wacom_shared *shared;
326 	struct input_dev *pen_input;
327 	struct input_dev *touch_input;
328 	struct input_dev *pad_input;
329 	int pid;
330 	int num_contacts_left;
331 	u8 bt_features;
332 	u8 bt_high_speed;
333 	int mode_report;
334 	int mode_value;
335 	struct hid_data hid_data;
336 	bool has_mute_touch_switch;
337 	bool has_mode_change;
338 	bool is_direct_mode;
339 
340 };
341 
342 #endif
343