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_UNPAIR_ALL              0xFF
  83 #define WAC_CMD_WL_INTUOSP2             0x82
  84
  85 /* device quirks */
  86 #define WACOM_QUIRK_BBTOUCH_LOWRES      0x0001
  87 #define WACOM_QUIRK_SENSE               0x0002
  88 #define WACOM_QUIRK_BATTERY             0x0008
  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_HID_UP_WACOMDIGITIZER     0xff0d0000
  99 #define WACOM_HID_SP_PAD                0x00040000
 100 #define WACOM_HID_SP_BUTTON             0x00090000
 101 #define WACOM_HID_SP_DIGITIZER          0x000d0000
 102 #define WACOM_HID_SP_DIGITIZERINFO      0x00100000
 103 #define WACOM_HID_WD_DIGITIZER          (WACOM_HID_UP_WACOMDIGITIZER | 0x01)
 104 #define WACOM_HID_WD_PEN                (WACOM_HID_UP_WACOMDIGITIZER | 0x02)
 105 #define WACOM_HID_WD_SENSE              (WACOM_HID_UP_WACOMDIGITIZER | 0x36)
 106 #define WACOM_HID_WD_DIGITIZERFNKEYS    (WACOM_HID_UP_WACOMDIGITIZER | 0x39)
 107 #define WACOM_HID_WD_SERIALHI           (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
 108 #define WACOM_HID_WD_TOOLTYPE           (WACOM_HID_UP_WACOMDIGITIZER | 0x77)
 109 #define WACOM_HID_WD_DISTANCE           (WACOM_HID_UP_WACOMDIGITIZER | 0x0132)
 110 #define WACOM_HID_WD_TOUCHSTRIP         (WACOM_HID_UP_WACOMDIGITIZER | 0x0136)
 111 #define WACOM_HID_WD_TOUCHSTRIP2        (WACOM_HID_UP_WACOMDIGITIZER | 0x0137)
 112 #define WACOM_HID_WD_TOUCHRING          (WACOM_HID_UP_WACOMDIGITIZER | 0x0138)
 113 #define WACOM_HID_WD_TOUCHRINGSTATUS    (WACOM_HID_UP_WACOMDIGITIZER | 0x0139)
 114 #define WACOM_HID_WD_ACCELEROMETER_X    (WACOM_HID_UP_WACOMDIGITIZER | 0x0401)
 115 #define WACOM_HID_WD_ACCELEROMETER_Y    (WACOM_HID_UP_WACOMDIGITIZER | 0x0402)
 116 #define WACOM_HID_WD_ACCELEROMETER_Z    (WACOM_HID_UP_WACOMDIGITIZER | 0x0403)
 117 #define WACOM_HID_WD_BATTERY_CHARGING   (WACOM_HID_UP_WACOMDIGITIZER | 0x0404)
 118 #define WACOM_HID_WD_BATTERY_LEVEL      (WACOM_HID_UP_WACOMDIGITIZER | 0x043b)
 119 #define WACOM_HID_WD_EXPRESSKEY00       (WACOM_HID_UP_WACOMDIGITIZER | 0x0910)
 120 #define WACOM_HID_WD_EXPRESSKEYCAP00    (WACOM_HID_UP_WACOMDIGITIZER | 0x0950)
 121 #define WACOM_HID_WD_BUTTONHOME         (WACOM_HID_UP_WACOMDIGITIZER | 0x0990)
 122 #define WACOM_HID_WD_BUTTONUP           (WACOM_HID_UP_WACOMDIGITIZER | 0x0991)
 123 #define WACOM_HID_WD_BUTTONDOWN         (WACOM_HID_UP_WACOMDIGITIZER | 0x0992)
 124 #define WACOM_HID_WD_BUTTONLEFT         (WACOM_HID_UP_WACOMDIGITIZER | 0x0993)
 125 #define WACOM_HID_WD_BUTTONRIGHT        (WACOM_HID_UP_WACOMDIGITIZER | 0x0994)
 126 #define WACOM_HID_WD_BUTTONCENTER       (WACOM_HID_UP_WACOMDIGITIZER | 0x0995)
 127 #define WACOM_HID_WD_TOUCHONOFF         (WACOM_HID_UP_WACOMDIGITIZER | 0x0996)
 128 #define WACOM_HID_WD_FINGERWHEEL        (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03)
 129 #define WACOM_HID_WD_OFFSETLEFT         (WACOM_HID_UP_WACOMDIGITIZER | 0x0d30)
 130 #define WACOM_HID_WD_OFFSETTOP          (WACOM_HID_UP_WACOMDIGITIZER | 0x0d31)
 131 #define WACOM_HID_WD_OFFSETRIGHT        (WACOM_HID_UP_WACOMDIGITIZER | 0x0d32)
 132 #define WACOM_HID_WD_OFFSETBOTTOM       (WACOM_HID_UP_WACOMDIGITIZER | 0x0d33)
 133 #define WACOM_HID_WD_DATAMODE           (WACOM_HID_UP_WACOMDIGITIZER | 0x1002)
 134 #define WACOM_HID_WD_DIGITIZERINFO      (WACOM_HID_UP_WACOMDIGITIZER | 0x1013)
 135 #define WACOM_HID_UP_G9                 0xff090000
 136 #define WACOM_HID_G9_PEN                (WACOM_HID_UP_G9 | 0x02)
 137 #define WACOM_HID_G9_TOUCHSCREEN        (WACOM_HID_UP_G9 | 0x11)
 138 #define WACOM_HID_UP_G11                0xff110000
 139 #define WACOM_HID_G11_PEN               (WACOM_HID_UP_G11 | 0x02)
 140 #define WACOM_HID_G11_TOUCHSCREEN       (WACOM_HID_UP_G11 | 0x11)
 141 #define WACOM_HID_UP_WACOMTOUCH         0xff000000
 142 #define WACOM_HID_WT_TOUCHSCREEN        (WACOM_HID_UP_WACOMTOUCH | 0x04)
 143 #define WACOM_HID_WT_TOUCHPAD           (WACOM_HID_UP_WACOMTOUCH | 0x05)
 144 #define WACOM_HID_WT_CONTACTMAX         (WACOM_HID_UP_WACOMTOUCH | 0x55)
 145 #define WACOM_HID_WT_X                  (WACOM_HID_UP_WACOMTOUCH | 0x130)
 146 #define WACOM_HID_WT_Y                  (WACOM_HID_UP_WACOMTOUCH | 0x131)
 147
 148 #define WACOM_PAD_FIELD(f)      (((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \
 149                                  ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \
 150                                  ((f)->physical == WACOM_HID_WD_DIGITIZERINFO))
 151
 152 #define WACOM_PEN_FIELD(f)      (((f)->logical == HID_DG_STYLUS) || \
 153                                  ((f)->physical == HID_DG_STYLUS) || \
 154                                  ((f)->physical == HID_DG_PEN) || \
 155                                  ((f)->application == HID_DG_PEN) || \
 156                                  ((f)->application == HID_DG_DIGITIZER) || \
 157                                  ((f)->application == WACOM_HID_WD_DIGITIZER) || \
 158                                  ((f)->application == WACOM_HID_G9_PEN) || \
 159                                  ((f)->application == WACOM_HID_G11_PEN))
 160 #define WACOM_FINGER_FIELD(f)   (((f)->logical == HID_DG_FINGER) || \
 161                                  ((f)->physical == HID_DG_FINGER) || \
 162                                  ((f)->application == HID_DG_TOUCHSCREEN) || \
 163                                  ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \
 164                                  ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \
 165                                  ((f)->application == WACOM_HID_WT_TOUCHPAD) || \
 166                                  ((f)->application == HID_DG_TOUCHPAD))
 167
 168 #define WACOM_DIRECT_DEVICE(f)  (((f)->application == HID_DG_TOUCHSCREEN) || \
 169                                  ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \
 170                                  ((f)->application == HID_DG_PEN) || \
 171                                  ((f)->application == WACOM_HID_WD_PEN))
 172
 173 enum {
 174         PENPARTNER = 0,
 175         GRAPHIRE,
 176         GRAPHIRE_BT,
 177         WACOM_G4,
 178         PTU,
 179         PL,
 180         DTU,
 181         DTUS,
 182         DTUSX,
 183         INTUOS,
 184         INTUOS3S,
 185         INTUOS3,
 186         INTUOS3L,
 187         INTUOS4S,
 188         INTUOS4,
 189         INTUOS4WL,
 190         INTUOS4L,
 191         INTUOS5S,
 192         INTUOS5,
 193         INTUOS5L,
 194         INTUOSPS,
 195         INTUOSPM,
 196         INTUOSPL,
 197         INTUOSP2_BT,
 198         WACOM_21UX2,
 199         WACOM_22HD,
 200         DTK,
 201         WACOM_24HD,
 202         WACOM_27QHD,
 203         CINTIQ_HYBRID,
 204         CINTIQ_COMPANION_2,
 205         CINTIQ,
 206         WACOM_BEE,
 207         WACOM_13HD,
 208         WACOM_MO,
 209         BAMBOO_PEN,
 210         INTUOSHT,
 211         INTUOSHT2,
 212         BAMBOO_TOUCH,
 213         BAMBOO_PT,
 214         WACOM_24HDT,
 215         WACOM_27QHDT,
 216         BAMBOO_PAD,
 217         WIRELESS,
 218         REMOTE,
 219         TABLETPC,   /* add new TPC below */
 220         TABLETPCE,
 221         TABLETPC2FG,
 222         MTSCREEN,
 223         MTTPC,
 224         MTTPC_B,
 225         HID_GENERIC,
 226         MAX_TYPE
 227 };
 228
 229 struct wacom_features {
 230         const char *name;
 231         int x_max;
 232         int y_max;
 233         int pressure_max;
 234         int distance_max;
 235         int type;
 236         int x_resolution;
 237         int y_resolution;
 238         int numbered_buttons;
 239         int offset_left;
 240         int offset_right;
 241         int offset_top;
 242         int offset_bottom;
 243         int device_type;
 244         int x_phy;
 245         int y_phy;
 246         unsigned unit;
 247         int unitExpo;
 248         int x_fuzz;
 249         int y_fuzz;
 250         int pressure_fuzz;
 251         int distance_fuzz;
 252         int tilt_fuzz;
 253         unsigned quirks;
 254         unsigned touch_max;
 255         int oVid;
 256         int oPid;
 257         int pktlen;
 258         bool check_for_hid_type;
 259         int hid_type;
 260 };
 261
 262 struct wacom_shared {
 263         bool stylus_in_proximity;
 264         bool touch_down;
 265         /* for wireless device to access USB interfaces */
 266         unsigned touch_max;
 267         int type;
 268         struct input_dev *touch_input;
 269         struct hid_device *pen;
 270         struct hid_device *touch;
 271 };
 272
 273 struct hid_data {
 274         __s16 inputmode;        /* InputMode HID feature, -1 if non-existent */
 275         __s16 inputmode_index;  /* InputMode HID feature index in the report */
 276         bool sense_state;
 277         bool inrange_state;
 278         bool invert_state;
 279         bool tipswitch;
 280         int x;
 281         int y;
 282         int pressure;
 283         int width;
 284         int height;
 285         int id;
 286         int cc_report;
 287         int cc_index;
 288         int cc_value_index;
 289         int last_slot_field;
 290         int num_expected;
 291         int num_received;
 292         int battery_capacity;
 293         int bat_charging;
 294         int bat_connected;
 295         int ps_connected;
 296 };
 297
 298 struct wacom_remote_data {
 299         struct {
 300                 u32 serial;
 301                 bool connected;
 302         } remote[WACOM_MAX_REMOTES];
 303 };
 304
 305 struct wacom_wac {
 306         char name[WACOM_NAME_MAX];
 307         char pen_name[WACOM_NAME_MAX];
 308         char touch_name[WACOM_NAME_MAX];
 309         char pad_name[WACOM_NAME_MAX];
 310         unsigned char data[WACOM_PKGLEN_MAX];
 311         int tool[2];
 312         int id[2];
 313         __u64 serial[2];
 314         bool reporting_data;
 315         struct wacom_features features;
 316         struct wacom_shared *shared;
 317         struct input_dev *pen_input;
 318         struct input_dev *touch_input;
 319         struct input_dev *pad_input;
 320         int pid;
 321         int num_contacts_left;
 322         u8 bt_features;
 323         u8 bt_high_speed;
 324         int mode_report;
 325         int mode_value;
 326         struct hid_data hid_data;
 327 };
 328
 329 #endif