1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * drivers/input/tablet/wacom_wac.h 4 */ 5 #ifndef WACOM_WAC_H 6 #define WACOM_WAC_H 7 8 #include <linux/types.h> 9 #include <linux/hid.h> 10 #include <linux/kfifo.h> 11 12 /* maximum packet length for USB/BT devices */ 13 #define WACOM_PKGLEN_MAX 361 14 15 #define WACOM_NAME_MAX 64 16 #define WACOM_MAX_REMOTES 5 17 #define WACOM_STATUS_UNKNOWN 255 18 19 /* packet length for individual models */ 20 #define WACOM_PKGLEN_BBFUN 9 21 #define WACOM_PKGLEN_TPC1FG 5 22 #define WACOM_PKGLEN_TPC1FG_B 10 23 #define WACOM_PKGLEN_TPC2FG 14 24 #define WACOM_PKGLEN_BBTOUCH 20 25 #define WACOM_PKGLEN_BBTOUCH3 64 26 #define WACOM_PKGLEN_BBPEN 10 27 #define WACOM_PKGLEN_WIRELESS 32 28 #define WACOM_PKGLEN_PENABLED 8 29 #define WACOM_PKGLEN_BPAD_TOUCH 32 30 #define WACOM_PKGLEN_BPAD_TOUCH_USB 64 31 32 /* wacom data size per MT contact */ 33 #define WACOM_BYTES_PER_MT_PACKET 11 34 #define WACOM_BYTES_PER_24HDT_PACKET 14 35 #define WACOM_BYTES_PER_QHDTHID_PACKET 6 36 37 /* device IDs */ 38 #define STYLUS_DEVICE_ID 0x02 39 #define TOUCH_DEVICE_ID 0x03 40 #define CURSOR_DEVICE_ID 0x06 41 #define ERASER_DEVICE_ID 0x0A 42 #define PAD_DEVICE_ID 0x0F 43 44 /* wacom data packet report IDs */ 45 #define WACOM_REPORT_PENABLED 2 46 #define WACOM_REPORT_PENABLED_BT 3 47 #define WACOM_REPORT_INTUOS_ID1 5 48 #define WACOM_REPORT_INTUOS_ID2 6 49 #define WACOM_REPORT_INTUOSPAD 12 50 #define WACOM_REPORT_INTUOS5PAD 3 51 #define WACOM_REPORT_DTUSPAD 21 52 #define WACOM_REPORT_TPC1FG 6 53 #define WACOM_REPORT_TPC2FG 13 54 #define WACOM_REPORT_TPCMT 13 55 #define WACOM_REPORT_TPCMT2 3 56 #define WACOM_REPORT_TPCHID 15 57 #define WACOM_REPORT_CINTIQ 16 58 #define WACOM_REPORT_CINTIQPAD 17 59 #define WACOM_REPORT_TPCST 16 60 #define WACOM_REPORT_DTUS 17 61 #define WACOM_REPORT_TPC1FGE 18 62 #define WACOM_REPORT_24HDT 1 63 #define WACOM_REPORT_WL 128 64 #define WACOM_REPORT_USB 192 65 #define WACOM_REPORT_BPAD_PEN 3 66 #define WACOM_REPORT_BPAD_TOUCH 16 67 #define WACOM_REPORT_DEVICE_LIST 16 68 #define WACOM_REPORT_INTUOS_PEN 16 69 #define WACOM_REPORT_REMOTE 17 70 #define WACOM_REPORT_INTUOSHT2_ID 8 71 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 79 #define WAC_CMD_LED_CONTROL_GENERIC 0x32 80 #define WAC_CMD_UNPAIR_ALL 0xFF 81 #define WAC_CMD_WL_INTUOSP2 0x82 82 83 /* device quirks */ 84 #define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001 85 #define WACOM_QUIRK_SENSE 0x0002 86 #define WACOM_QUIRK_AESPEN 0x0004 87 #define WACOM_QUIRK_BATTERY 0x0008 88 #define WACOM_QUIRK_TOOLSERIAL 0x0010 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_TOOLTYPE (WACOM_HID_UP_WACOMDIGITIZER | 0x77) 112 #define WACOM_HID_WD_DISTANCE (WACOM_HID_UP_WACOMDIGITIZER | 0x0132) 113 #define WACOM_HID_WD_TOUCHSTRIP (WACOM_HID_UP_WACOMDIGITIZER | 0x0136) 114 #define WACOM_HID_WD_TOUCHSTRIP2 (WACOM_HID_UP_WACOMDIGITIZER | 0x0137) 115 #define WACOM_HID_WD_TOUCHRING (WACOM_HID_UP_WACOMDIGITIZER | 0x0138) 116 #define WACOM_HID_WD_TOUCHRINGSTATUS (WACOM_HID_UP_WACOMDIGITIZER | 0x0139) 117 #define WACOM_HID_WD_REPORT_VALID (WACOM_HID_UP_WACOMDIGITIZER | 0x01d0) 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) 121 #define WACOM_HID_WD_BATTERY_CHARGING (WACOM_HID_UP_WACOMDIGITIZER | 0x0404) 122 #define WACOM_HID_WD_TOUCHONOFF (WACOM_HID_UP_WACOMDIGITIZER | 0x0454) 123 #define WACOM_HID_WD_BATTERY_LEVEL (WACOM_HID_UP_WACOMDIGITIZER | 0x043b) 124 #define WACOM_HID_WD_EXPRESSKEY00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0910) 125 #define WACOM_HID_WD_EXPRESSKEYCAP00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0950) 126 #define WACOM_HID_WD_MODE_CHANGE (WACOM_HID_UP_WACOMDIGITIZER | 0x0980) 127 #define WACOM_HID_WD_MUTE_DEVICE (WACOM_HID_UP_WACOMDIGITIZER | 0x0981) 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) 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) 136 #define WACOM_HID_WD_BUTTONCENTER (WACOM_HID_UP_WACOMDIGITIZER | 0x0995) 137 #define WACOM_HID_WD_FINGERWHEEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03) 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) 142 #define WACOM_HID_WD_DATAMODE (WACOM_HID_UP_WACOMDIGITIZER | 0x1002) 143 #define WACOM_HID_WD_DIGITIZERINFO (WACOM_HID_UP_WACOMDIGITIZER | 0x1013) 144 #define WACOM_HID_UP_G9 0xff090000 145 #define WACOM_HID_G9_PEN (WACOM_HID_UP_G9 | 0x02) 146 #define WACOM_HID_G9_TOUCHSCREEN (WACOM_HID_UP_G9 | 0x11) 147 #define WACOM_HID_UP_G11 0xff110000 148 #define WACOM_HID_G11_PEN (WACOM_HID_UP_G11 | 0x02) 149 #define WACOM_HID_G11_TOUCHSCREEN (WACOM_HID_UP_G11 | 0x11) 150 #define WACOM_HID_UP_WACOMTOUCH 0xff000000 151 #define WACOM_HID_WT_TOUCHSCREEN (WACOM_HID_UP_WACOMTOUCH | 0x04) 152 #define WACOM_HID_WT_TOUCHPAD (WACOM_HID_UP_WACOMTOUCH | 0x05) 153 #define WACOM_HID_WT_CONTACTMAX (WACOM_HID_UP_WACOMTOUCH | 0x55) 154 #define WACOM_HID_WT_SERIALNUMBER (WACOM_HID_UP_WACOMTOUCH | 0x5b) 155 #define WACOM_HID_WT_X (WACOM_HID_UP_WACOMTOUCH | 0x130) 156 #define WACOM_HID_WT_Y (WACOM_HID_UP_WACOMTOUCH | 0x131) 157 158 #define WACOM_BATTERY_USAGE(f) (((f)->hid == HID_DG_BATTERYSTRENGTH) || \ 159 ((f)->hid == WACOM_HID_WD_BATTERY_CHARGING) || \ 160 ((f)->hid == WACOM_HID_WD_BATTERY_LEVEL)) 161 162 #define WACOM_PAD_FIELD(f) (((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \ 163 ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \ 164 ((f)->physical == WACOM_HID_WD_DIGITIZERINFO)) 165 166 #define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \ 167 ((f)->physical == HID_DG_STYLUS) || \ 168 ((f)->physical == HID_DG_PEN) || \ 169 ((f)->application == HID_DG_PEN) || \ 170 ((f)->application == HID_DG_DIGITIZER) || \ 171 ((f)->application == WACOM_HID_WD_PEN) || \ 172 ((f)->application == WACOM_HID_WD_DIGITIZER) || \ 173 ((f)->application == WACOM_HID_G9_PEN) || \ 174 ((f)->application == WACOM_HID_G11_PEN)) 175 #define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \ 176 ((f)->physical == HID_DG_FINGER) || \ 177 ((f)->application == HID_DG_TOUCHSCREEN) || \ 178 ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \ 179 ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \ 180 ((f)->application == WACOM_HID_WT_TOUCHPAD) || \ 181 ((f)->application == HID_DG_TOUCHPAD)) 182 183 #define WACOM_DIRECT_DEVICE(f) (((f)->application == HID_DG_TOUCHSCREEN) || \ 184 ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \ 185 ((f)->application == HID_DG_PEN) || \ 186 ((f)->application == WACOM_HID_WD_PEN)) 187 188 enum { 189 PENPARTNER = 0, 190 GRAPHIRE, 191 GRAPHIRE_BT, 192 WACOM_G4, 193 PTU, 194 PL, 195 DTU, 196 DTUS, 197 DTUSX, 198 INTUOS, 199 INTUOS3S, 200 INTUOS3, 201 INTUOS3L, 202 INTUOS4S, 203 INTUOS4, 204 INTUOS4WL, 205 INTUOS4L, 206 INTUOS5S, 207 INTUOS5, 208 INTUOS5L, 209 INTUOSPS, 210 INTUOSPM, 211 INTUOSPL, 212 INTUOSP2_BT, 213 INTUOSHT3_BT, 214 WACOM_21UX2, 215 WACOM_22HD, 216 DTK, 217 WACOM_24HD, 218 WACOM_27QHD, 219 CINTIQ_HYBRID, 220 CINTIQ_COMPANION_2, 221 CINTIQ, 222 WACOM_BEE, 223 WACOM_13HD, 224 WACOM_MO, 225 BAMBOO_PEN, 226 INTUOSHT, 227 INTUOSHT2, 228 BAMBOO_TOUCH, 229 BAMBOO_PT, 230 WACOM_24HDT, 231 WACOM_27QHDT, 232 BAMBOO_PAD, 233 WIRELESS, 234 REMOTE, 235 TABLETPC, /* add new TPC below */ 236 TABLETPCE, 237 TABLETPC2FG, 238 MTSCREEN, 239 MTTPC, 240 MTTPC_B, 241 HID_GENERIC, 242 MAX_TYPE 243 }; 244 245 struct wacom_features { 246 const char *name; 247 int x_max; 248 int y_max; 249 int pressure_max; 250 int distance_max; 251 int type; 252 int x_resolution; 253 int y_resolution; 254 int numbered_buttons; 255 int offset_left; 256 int offset_right; 257 int offset_top; 258 int offset_bottom; 259 int device_type; 260 int x_phy; 261 int y_phy; 262 unsigned unit; 263 int unitExpo; 264 int x_fuzz; 265 int y_fuzz; 266 int pressure_fuzz; 267 int distance_fuzz; 268 int tilt_fuzz; 269 unsigned quirks; 270 unsigned touch_max; 271 int oVid; 272 int oPid; 273 int pktlen; 274 bool check_for_hid_type; 275 int hid_type; 276 }; 277 278 struct wacom_shared { 279 bool stylus_in_proximity; 280 bool touch_down; 281 /* for wireless device to access USB interfaces */ 282 unsigned touch_max; 283 int type; 284 struct input_dev *touch_input; 285 struct hid_device *pen; 286 struct hid_device *touch; 287 bool has_mute_touch_switch; 288 bool is_touch_on; 289 }; 290 291 struct hid_data { 292 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */ 293 __s16 inputmode_index; /* InputMode HID feature index in the report */ 294 bool sense_state; 295 bool inrange_state; 296 bool invert_state; 297 bool tipswitch; 298 bool barrelswitch; 299 bool barrelswitch2; 300 int x; 301 int y; 302 int pressure; 303 int width; 304 int height; 305 int id; 306 int cc_report; 307 int cc_index; 308 int cc_value_index; 309 int last_slot_field; 310 int num_expected; 311 int num_received; 312 int bat_status; 313 int battery_capacity; 314 int bat_charging; 315 int bat_connected; 316 int ps_connected; 317 bool pad_input_event_flag; 318 }; 319 320 struct wacom_remote_data { 321 struct { 322 u32 serial; 323 bool connected; 324 } remote[WACOM_MAX_REMOTES]; 325 }; 326 327 struct wacom_wac { 328 char name[WACOM_NAME_MAX]; 329 char pen_name[WACOM_NAME_MAX]; 330 char touch_name[WACOM_NAME_MAX]; 331 char pad_name[WACOM_NAME_MAX]; 332 unsigned char data[WACOM_PKGLEN_MAX]; 333 int tool[2]; 334 int id[2]; 335 __u64 serial[2]; 336 bool reporting_data; 337 struct wacom_features features; 338 struct wacom_shared *shared; 339 struct input_dev *pen_input; 340 struct input_dev *touch_input; 341 struct input_dev *pad_input; 342 struct kfifo_rec_ptr_2 pen_fifo; 343 int pid; 344 int num_contacts_left; 345 u8 bt_features; 346 u8 bt_high_speed; 347 int mode_report; 348 int mode_value; 349 struct hid_data hid_data; 350 bool has_mute_touch_switch; 351 bool has_mode_change; 352 bool is_direct_mode; 353 bool is_invalid_bt_frame; 354 }; 355 356 #endif 357