drivers/hid/wacom_wac.h

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