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