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