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 #define WACOM_REMOTE_BATTERY_TIMEOUT    21000000000ll
  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_BATTERY             0x0008
  91
  92 /* device types */
  93 #define WACOM_DEVICETYPE_NONE           0x0000
  94 #define WACOM_DEVICETYPE_PEN            0x0001
  95 #define WACOM_DEVICETYPE_TOUCH          0x0002
  96 #define WACOM_DEVICETYPE_PAD            0x0004
  97 #define WACOM_DEVICETYPE_WL_MONITOR     0x0008
  98 #define WACOM_DEVICETYPE_DIRECT         0x0010
  99
 100 #define WACOM_POWER_SUPPLY_STATUS_AUTO  -1
 101
 102 #define WACOM_HID_UP_WACOMDIGITIZER     0xff0d0000
 103 #define WACOM_HID_SP_PAD                0x00040000
 104 #define WACOM_HID_SP_BUTTON             0x00090000
 105 #define WACOM_HID_SP_DIGITIZER          0x000d0000
 106 #define WACOM_HID_SP_DIGITIZERINFO      0x00100000
 107 #define WACOM_HID_WD_DIGITIZER          (WACOM_HID_UP_WACOMDIGITIZER | 0x01)
 108 #define WACOM_HID_WD_PEN                (WACOM_HID_UP_WACOMDIGITIZER | 0x02)
 109 #define WACOM_HID_WD_SENSE              (WACOM_HID_UP_WACOMDIGITIZER | 0x36)
 110 #define WACOM_HID_WD_DIGITIZERFNKEYS    (WACOM_HID_UP_WACOMDIGITIZER | 0x39)
 111 #define WACOM_HID_WD_SERIALHI           (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
 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_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 | 0x0940)
 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_WD_TOUCH_RING_SETTING (WACOM_HID_UP_WACOMDIGITIZER | 0x1032)
 145 #define WACOM_HID_UP_G9                 0xff090000
 146 #define WACOM_HID_G9_PEN                (WACOM_HID_UP_G9 | 0x02)
 147 #define WACOM_HID_G9_TOUCHSCREEN        (WACOM_HID_UP_G9 | 0x11)
 148 #define WACOM_HID_UP_G11                0xff110000
 149 #define WACOM_HID_G11_PEN               (WACOM_HID_UP_G11 | 0x02)
 150 #define WACOM_HID_G11_TOUCHSCREEN       (WACOM_HID_UP_G11 | 0x11)
 151 #define WACOM_HID_UP_WACOMTOUCH         0xff000000
 152 #define WACOM_HID_WT_TOUCHSCREEN        (WACOM_HID_UP_WACOMTOUCH | 0x04)
 153 #define WACOM_HID_WT_TOUCHPAD           (WACOM_HID_UP_WACOMTOUCH | 0x05)
 154 #define WACOM_HID_WT_CONTACTMAX         (WACOM_HID_UP_WACOMTOUCH | 0x55)
 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         WACOM_21UX2,
 214         WACOM_22HD,
 215         DTK,
 216         WACOM_24HD,
 217         WACOM_27QHD,
 218         CINTIQ_HYBRID,
 219         CINTIQ_COMPANION_2,
 220         CINTIQ,
 221         WACOM_BEE,
 222         WACOM_13HD,
 223         WACOM_MO,
 224         BAMBOO_PEN,
 225         INTUOSHT,
 226         INTUOSHT2,
 227         BAMBOO_TOUCH,
 228         BAMBOO_PT,
 229         WACOM_24HDT,
 230         WACOM_27QHDT,
 231         BAMBOO_PAD,
 232         WIRELESS,
 233         REMOTE,
 234         TABLETPC,   /* add new TPC below */
 235         TABLETPCE,
 236         TABLETPC2FG,
 237         MTSCREEN,
 238         MTTPC,
 239         MTTPC_B,
 240         HID_GENERIC,
 241         BOOTLOADER,
 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 confidence;
 299         int x;
 300         int y;
 301         int pressure;
 302         int width;
 303         int height;
 304         int id;
 305         int cc_report;
 306         int cc_index;
 307         int cc_value_index;
 308         int last_slot_field;
 309         int num_expected;
 310         int num_received;
 311         int bat_status;
 312         int battery_capacity;
 313         int bat_charging;
 314         int bat_connected;
 315         int ps_connected;
 316         bool pad_input_event_flag;
 317 };
 318
 319 struct wacom_remote_data {
 320         struct {
 321                 u32 serial;
 322                 bool connected;
 323         } remote[WACOM_MAX_REMOTES];
 324 };
 325
 326 struct wacom_wac {
 327         char name[WACOM_NAME_MAX];
 328         char pen_name[WACOM_NAME_MAX];
 329         char touch_name[WACOM_NAME_MAX];
 330         char pad_name[WACOM_NAME_MAX];
 331         unsigned char data[WACOM_PKGLEN_MAX];
 332         int tool[2];
 333         int id[2];
 334         __u64 serial[2];
 335         bool reporting_data;
 336         struct wacom_features features;
 337         struct wacom_shared *shared;
 338         struct input_dev *pen_input;
 339         struct input_dev *touch_input;
 340         struct input_dev *pad_input;
 341         int pid;
 342         int num_contacts_left;
 343         u8 bt_features;
 344         u8 bt_high_speed;
 345         int mode_report;
 346         int mode_value;
 347         struct hid_data hid_data;
 348         bool has_mute_touch_switch;
 349         bool has_mode_change;
 350         bool is_direct_mode;
 351
 352 };
 353
 354 #endif