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 | 0x0940)
 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_WD_TOUCH_RING_SETTING (WACOM_HID_UP_WACOMDIGITIZER | 0x1032)
 144 #define WACOM_HID_UP_G9                 0xff090000
 145 #define WACOM_HID_G9_PEN                (WACOM_HID_UP_G9 | 0x02)
 146 #define WACOM_HID_G9_TOUCHSCREEN        (WACOM_HID_UP_G9 | 0x11)
 147 #define WACOM_HID_UP_G11                0xff110000
 148 #define WACOM_HID_G11_PEN               (WACOM_HID_UP_G11 | 0x02)
 149 #define WACOM_HID_G11_TOUCHSCREEN       (WACOM_HID_UP_G11 | 0x11)
 150 #define WACOM_HID_UP_WACOMTOUCH         0xff000000
 151 #define WACOM_HID_WT_TOUCHSCREEN        (WACOM_HID_UP_WACOMTOUCH | 0x04)
 152 #define WACOM_HID_WT_TOUCHPAD           (WACOM_HID_UP_WACOMTOUCH | 0x05)
 153 #define WACOM_HID_WT_CONTACTMAX         (WACOM_HID_UP_WACOMTOUCH | 0x55)
 154 #define WACOM_HID_WT_X                  (WACOM_HID_UP_WACOMTOUCH | 0x130)
 155 #define WACOM_HID_WT_Y                  (WACOM_HID_UP_WACOMTOUCH | 0x131)
 156
 157 #define WACOM_BATTERY_USAGE(f)  (((f)->hid == HID_DG_BATTERYSTRENGTH) || \
 158                                  ((f)->hid == WACOM_HID_WD_BATTERY_CHARGING) || \
 159                                  ((f)->hid == WACOM_HID_WD_BATTERY_LEVEL))
 160
 161 #define WACOM_PAD_FIELD(f)      (((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \
 162                                  ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \
 163                                  ((f)->physical == WACOM_HID_WD_DIGITIZERINFO))
 164
 165 #define WACOM_PEN_FIELD(f)      (((f)->logical == HID_DG_STYLUS) || \
 166                                  ((f)->physical == HID_DG_STYLUS) || \
 167                                  ((f)->physical == HID_DG_PEN) || \
 168                                  ((f)->application == HID_DG_PEN) || \
 169                                  ((f)->application == HID_DG_DIGITIZER) || \
 170                                  ((f)->application == WACOM_HID_WD_PEN) || \
 171                                  ((f)->application == WACOM_HID_WD_DIGITIZER) || \
 172                                  ((f)->application == WACOM_HID_G9_PEN) || \
 173                                  ((f)->application == WACOM_HID_G11_PEN))
 174 #define WACOM_FINGER_FIELD(f)   (((f)->logical == HID_DG_FINGER) || \
 175                                  ((f)->physical == HID_DG_FINGER) || \
 176                                  ((f)->application == HID_DG_TOUCHSCREEN) || \
 177                                  ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \
 178                                  ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \
 179                                  ((f)->application == WACOM_HID_WT_TOUCHPAD) || \
 180                                  ((f)->application == HID_DG_TOUCHPAD))
 181
 182 #define WACOM_DIRECT_DEVICE(f)  (((f)->application == HID_DG_TOUCHSCREEN) || \
 183                                  ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \
 184                                  ((f)->application == HID_DG_PEN) || \
 185                                  ((f)->application == WACOM_HID_WD_PEN))
 186
 187 enum {
 188         PENPARTNER = 0,
 189         GRAPHIRE,
 190         GRAPHIRE_BT,
 191         WACOM_G4,
 192         PTU,
 193         PL,
 194         DTU,
 195         DTUS,
 196         DTUSX,
 197         INTUOS,
 198         INTUOS3S,
 199         INTUOS3,
 200         INTUOS3L,
 201         INTUOS4S,
 202         INTUOS4,
 203         INTUOS4WL,
 204         INTUOS4L,
 205         INTUOS5S,
 206         INTUOS5,
 207         INTUOS5L,
 208         INTUOSPS,
 209         INTUOSPM,
 210         INTUOSPL,
 211         INTUOSP2_BT,
 212         WACOM_21UX2,
 213         WACOM_22HD,
 214         DTK,
 215         WACOM_24HD,
 216         WACOM_27QHD,
 217         CINTIQ_HYBRID,
 218         CINTIQ_COMPANION_2,
 219         CINTIQ,
 220         WACOM_BEE,
 221         WACOM_13HD,
 222         WACOM_MO,
 223         BAMBOO_PEN,
 224         INTUOSHT,
 225         INTUOSHT2,
 226         BAMBOO_TOUCH,
 227         BAMBOO_PT,
 228         WACOM_24HDT,
 229         WACOM_27QHDT,
 230         BAMBOO_PAD,
 231         WIRELESS,
 232         REMOTE,
 233         TABLETPC,   /* add new TPC below */
 234         TABLETPCE,
 235         TABLETPC2FG,
 236         MTSCREEN,
 237         MTTPC,
 238         MTTPC_B,
 239         HID_GENERIC,
 240         BOOTLOADER,
 241         MAX_TYPE
 242 };
 243
 244 struct wacom_features {
 245         const char *name;
 246         int x_max;
 247         int y_max;
 248         int pressure_max;
 249         int distance_max;
 250         int type;
 251         int x_resolution;
 252         int y_resolution;
 253         int numbered_buttons;
 254         int offset_left;
 255         int offset_right;
 256         int offset_top;
 257         int offset_bottom;
 258         int device_type;
 259         int x_phy;
 260         int y_phy;
 261         unsigned unit;
 262         int unitExpo;
 263         int x_fuzz;
 264         int y_fuzz;
 265         int pressure_fuzz;
 266         int distance_fuzz;
 267         int tilt_fuzz;
 268         unsigned quirks;
 269         unsigned touch_max;
 270         int oVid;
 271         int oPid;
 272         int pktlen;
 273         bool check_for_hid_type;
 274         int hid_type;
 275 };
 276
 277 struct wacom_shared {
 278         bool stylus_in_proximity;
 279         bool touch_down;
 280         /* for wireless device to access USB interfaces */
 281         unsigned touch_max;
 282         int type;
 283         struct input_dev *touch_input;
 284         struct hid_device *pen;
 285         struct hid_device *touch;
 286         bool has_mute_touch_switch;
 287         bool is_touch_on;
 288 };
 289
 290 struct hid_data {
 291         __s16 inputmode;        /* InputMode HID feature, -1 if non-existent */
 292         __s16 inputmode_index;  /* InputMode HID feature index in the report */
 293         bool sense_state;
 294         bool inrange_state;
 295         bool invert_state;
 296         bool tipswitch;
 297         bool confidence;
 298         int x;
 299         int y;
 300         int pressure;
 301         int width;
 302         int height;
 303         int id;
 304         int cc_report;
 305         int cc_index;
 306         int cc_value_index;
 307         int last_slot_field;
 308         int num_expected;
 309         int num_received;
 310         int bat_status;
 311         int battery_capacity;
 312         int bat_charging;
 313         int bat_connected;
 314         int ps_connected;
 315         bool pad_input_event_flag;
 316 };
 317
 318 struct wacom_remote_data {
 319         struct {
 320                 u32 serial;
 321                 bool connected;
 322         } remote[WACOM_MAX_REMOTES];
 323 };
 324
 325 struct wacom_wac {
 326         char name[WACOM_NAME_MAX];
 327         char pen_name[WACOM_NAME_MAX];
 328         char touch_name[WACOM_NAME_MAX];
 329         char pad_name[WACOM_NAME_MAX];
 330         unsigned char data[WACOM_PKGLEN_MAX];
 331         int tool[2];
 332         int id[2];
 333         __u64 serial[2];
 334         bool reporting_data;
 335         struct wacom_features features;
 336         struct wacom_shared *shared;
 337         struct input_dev *pen_input;
 338         struct input_dev *touch_input;
 339         struct input_dev *pad_input;
 340         int pid;
 341         int num_contacts_left;
 342         u8 bt_features;
 343         u8 bt_high_speed;
 344         int mode_report;
 345         int mode_value;
 346         struct hid_data hid_data;
 347         bool has_mute_touch_switch;
 348         bool has_mode_change;
 349         bool is_direct_mode;
 350
 351 };
 352
 353 #endif