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