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