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