blob: 877c24a5df94ad5056983ca95c71bbe79588903f [file] [log] [blame]
Ping Cheng3bea7332006-07-13 18:01:36 -07001/*
Dmitry Torokhov4104d132007-05-07 16:16:29 -04002 * drivers/input/tablet/wacom_wac.h
Ping Cheng3bea7332006-07-13 18:01:36 -07003 *
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
Dmitry Torokhov51269fe2010-03-19 22:18:15 -070012#include <linux/types.h>
Benjamin Tissoiresd97a5522015-01-05 16:32:12 -050013#include <linux/hid.h>
Dmitry Torokhov51269fe2010-03-19 22:18:15 -070014
Ping Chengee545002009-12-15 00:35:24 -080015/* maximum packet length for USB devices */
Ping Cheng500d4162015-01-27 13:30:03 -080016#define WACOM_PKGLEN_MAX 192
Ping Chengee545002009-12-15 00:35:24 -080017
Ping Cheng57bcfce2013-10-15 23:44:00 -070018#define WACOM_NAME_MAX 64
Aaron Skomra72b236d2015-08-20 16:05:17 -070019#define WACOM_MAX_REMOTES 5
20#define WACOM_STATUS_UNKNOWN 255
Ping Cheng57bcfce2013-10-15 23:44:00 -070021
Ping Chengee545002009-12-15 00:35:24 -080022/* packet length for individual models */
Jason Childse33da8a2010-02-17 22:38:31 -080023#define WACOM_PKGLEN_BBFUN 9
Ping Chengee545002009-12-15 00:35:24 -080024#define WACOM_PKGLEN_TPC1FG 5
Jason Gerecke61616ed2014-05-14 11:42:22 -070025#define WACOM_PKGLEN_TPC1FG_B 10
Jason Childse33da8a2010-02-17 22:38:31 -080026#define WACOM_PKGLEN_TPC2FG 14
Ping Cheng4a880812010-09-05 12:25:40 -070027#define WACOM_PKGLEN_BBTOUCH 20
Chris Bagwell41343612011-10-26 22:32:52 -070028#define WACOM_PKGLEN_BBTOUCH3 64
Chris Bagwell73149ab2011-10-26 22:34:21 -070029#define WACOM_PKGLEN_BBPEN 10
Chris Bagwelld3825d52012-03-25 23:26:11 -070030#define WACOM_PKGLEN_WIRELESS 32
Jason Gerecked51ddb22014-05-14 17:14:29 -070031#define WACOM_PKGLEN_PENABLED 8
Benjamin Tissoires8c97a762015-02-26 11:28:50 -050032#define WACOM_PKGLEN_BPAD_TOUCH 32
33#define WACOM_PKGLEN_BPAD_TOUCH_USB 64
Ping Cheng19635182012-04-29 21:09:18 -070034
35/* wacom data size per MT contact */
36#define WACOM_BYTES_PER_MT_PACKET 11
Jason Gereckeb1e42792012-10-21 00:38:04 -070037#define WACOM_BYTES_PER_24HDT_PACKET 14
Ping Cheng500d4162015-01-27 13:30:03 -080038#define WACOM_BYTES_PER_QHDTHID_PACKET 6
Ping Chengee545002009-12-15 00:35:24 -080039
Ping Chengec67bbe2009-12-15 00:35:24 -080040/* device IDs */
Ping Cheng3bea7332006-07-13 18:01:36 -070041#define STYLUS_DEVICE_ID 0x02
Ping Cheng545f4e92008-11-24 11:44:27 -050042#define TOUCH_DEVICE_ID 0x03
Ping Cheng3bea7332006-07-13 18:01:36 -070043#define CURSOR_DEVICE_ID 0x06
44#define ERASER_DEVICE_ID 0x0A
Ping Cheng80d4e8e2007-02-23 12:22:48 -080045#define PAD_DEVICE_ID 0x0F
Ping Cheng3bea7332006-07-13 18:01:36 -070046
Ping Chengcad74702009-12-15 00:35:25 -080047/* wacom data packet report IDs */
48#define WACOM_REPORT_PENABLED 2
Benjamin Tissoires387142b2014-08-06 13:52:56 -070049#define WACOM_REPORT_PENABLED_BT 3
Ping Chengcad74702009-12-15 00:35:25 -080050#define WACOM_REPORT_INTUOSREAD 5
51#define WACOM_REPORT_INTUOSWRITE 6
52#define WACOM_REPORT_INTUOSPAD 12
Jason Gereckef860e582012-04-03 15:48:35 -070053#define WACOM_REPORT_INTUOS5PAD 3
Ping Cheng497ab1f2014-01-20 20:18:04 -080054#define WACOM_REPORT_DTUSPAD 21
Ping Chengcad74702009-12-15 00:35:25 -080055#define WACOM_REPORT_TPC1FG 6
56#define WACOM_REPORT_TPC2FG 13
Ping Cheng19635182012-04-29 21:09:18 -070057#define WACOM_REPORT_TPCMT 13
Jason Gerecked51ddb22014-05-14 17:14:29 -070058#define WACOM_REPORT_TPCMT2 3
Ping Cheng31175a82012-01-31 00:07:33 -080059#define WACOM_REPORT_TPCHID 15
Ping Cheng500d4162015-01-27 13:30:03 -080060#define WACOM_REPORT_CINTIQ 16
61#define WACOM_REPORT_CINTIQPAD 17
Ping Cheng31175a82012-01-31 00:07:33 -080062#define WACOM_REPORT_TPCST 16
Ping Cheng497ab1f2014-01-20 20:18:04 -080063#define WACOM_REPORT_DTUS 17
Ping Chengac173832012-06-12 00:15:06 -070064#define WACOM_REPORT_TPC1FGE 18
Jason Gereckeb1e42792012-10-21 00:38:04 -070065#define WACOM_REPORT_24HDT 1
Ping Chengb5fd2a32013-11-25 18:44:55 -080066#define WACOM_REPORT_WL 128
Ping Cheng961794a2013-12-05 12:54:53 -080067#define WACOM_REPORT_USB 192
Benjamin Tissoires8c97a762015-02-26 11:28:50 -050068#define WACOM_REPORT_BPAD_PEN 3
69#define WACOM_REPORT_BPAD_TOUCH 16
Aaron Skomra72b236d2015-08-20 16:05:17 -070070#define WACOM_REPORT_DEVICE_LIST 16
Ping Chengeda01da2015-09-23 13:51:15 -070071#define WACOM_REPORT_INTUOS_PEN 16
Aaron Skomra72b236d2015-08-20 16:05:17 -070072#define WACOM_REPORT_REMOTE 17
Ping Chengcad74702009-12-15 00:35:25 -080073
Henrik Rydbergbc73dd32010-09-05 12:26:16 -070074/* device quirks */
Ping Chengf3586d22015-03-20 14:57:00 -070075#define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
Ping Chengf3586d22015-03-20 14:57:00 -070076#define WACOM_QUIRK_BATTERY 0x0008
Henrik Rydbergbc73dd32010-09-05 12:26:16 -070077
Jason Gereckeaa86b182015-06-15 18:01:42 -070078/* device types */
79#define WACOM_DEVICETYPE_NONE 0x0000
80#define WACOM_DEVICETYPE_PEN 0x0001
81#define WACOM_DEVICETYPE_TOUCH 0x0002
Jason Gerecke862cf552015-06-15 18:01:43 -070082#define WACOM_DEVICETYPE_PAD 0x0004
Jason Gereckeccad85c2015-08-03 10:17:04 -070083#define WACOM_DEVICETYPE_WL_MONITOR 0x0008
Jason Gereckeaa86b182015-06-15 18:01:42 -070084
Jason Gerecke042628a2015-04-30 17:51:54 -070085#define WACOM_VENDORDEFINED_PEN 0xff0d0001
86
Benjamin Tissoiresd97a5522015-01-05 16:32:12 -050087#define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \
88 ((f)->physical == HID_DG_STYLUS) || \
Benjamin Tissoires61e9e7e2015-01-05 16:32:13 -050089 ((f)->physical == HID_DG_PEN) || \
Jason Gerecke042628a2015-04-30 17:51:54 -070090 ((f)->application == HID_DG_PEN) || \
91 ((f)->application == HID_DG_DIGITIZER) || \
92 ((f)->application == WACOM_VENDORDEFINED_PEN))
Benjamin Tissoiresd97a5522015-01-05 16:32:12 -050093#define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \
94 ((f)->physical == HID_DG_FINGER) || \
95 ((f)->application == HID_DG_TOUCHSCREEN))
96
Ping Cheng3bea7332006-07-13 18:01:36 -070097enum {
98 PENPARTNER = 0,
99 GRAPHIRE,
Benjamin Tissoires387142b2014-08-06 13:52:56 -0700100 GRAPHIRE_BT,
Ping Cheng3bea7332006-07-13 18:01:36 -0700101 WACOM_G4,
102 PTU,
103 PL,
Ping Chengc8f2edc2010-06-28 01:10:51 -0700104 DTU,
Ping Cheng497ab1f2014-01-20 20:18:04 -0800105 DTUS,
Ping Chengfff00bf2014-12-04 18:23:04 -0800106 DTUSX,
Ping Cheng3bea7332006-07-13 18:01:36 -0700107 INTUOS,
Ping Cheng8d32e3a2006-09-26 13:34:47 -0700108 INTUOS3S,
Ping Cheng3bea7332006-07-13 18:01:36 -0700109 INTUOS3,
110 INTUOS3L,
Ping Cheng6f660f12009-05-08 18:30:33 -0700111 INTUOS4S,
112 INTUOS4,
Benjamin Tissoires81af7e62014-08-06 13:55:56 -0700113 INTUOS4WL,
Ping Cheng6f660f12009-05-08 18:30:33 -0700114 INTUOS4L,
Jason Gerecke9fee6192012-04-03 15:47:22 -0700115 INTUOS5S,
116 INTUOS5,
117 INTUOS5L,
Ping Cheng9a35c412013-09-20 09:51:56 -0700118 INTUOSPS,
119 INTUOSPM,
120 INTUOSPL,
Ping Cheng3a4b4aa2010-06-03 22:10:21 -0700121 WACOM_21UX2,
Ping Chengd838c642012-07-24 23:54:11 -0700122 WACOM_22HD,
Ping Chenga112e9f2013-02-13 20:20:01 -0800123 DTK,
Ping Chengd838c642012-07-24 23:54:11 -0700124 WACOM_24HD,
Ping Cheng500d4162015-01-27 13:30:03 -0800125 WACOM_27QHD,
Jason Gerecke36d3c512013-09-20 09:47:35 -0700126 CINTIQ_HYBRID,
Jason Gereckef7acb552015-10-13 10:03:49 -0700127 CINTIQ_COMPANION_2,
Ping Cheng3bea7332006-07-13 18:01:36 -0700128 CINTIQ,
Ping Cheng0e1763f2008-03-13 16:46:46 -0400129 WACOM_BEE,
Ping Cheng56218562013-05-05 19:56:18 -0700130 WACOM_13HD,
Ping Cheng7ecfbfd2007-06-14 23:32:48 -0400131 WACOM_MO,
Ping Cheng3b164a02015-09-23 09:59:10 -0700132 BAMBOO_PEN,
133 INTUOSHT,
Ping Chengeda01da2015-09-23 13:51:15 -0700134 INTUOSHT2,
Ping Cheng3b164a02015-09-23 09:59:10 -0700135 BAMBOO_TOUCH,
Ping Chengea2e6022012-06-12 00:14:12 -0700136 BAMBOO_PT,
Jason Gereckeb1e42792012-10-21 00:38:04 -0700137 WACOM_24HDT,
Ping Cheng500d4162015-01-27 13:30:03 -0800138 WACOM_27QHDT,
Benjamin Tissoires8c97a762015-02-26 11:28:50 -0500139 BAMBOO_PAD,
Ping Cheng7adb91b2015-10-26 14:29:12 -0700140 WIRELESS,
Aaron Skomra72b236d2015-08-20 16:05:17 -0700141 REMOTE,
Ping Chengea2e6022012-06-12 00:14:12 -0700142 TABLETPC, /* add new TPC below */
Ping Chengac173832012-06-12 00:15:06 -0700143 TABLETPCE,
Ping Chengec67bbe2009-12-15 00:35:24 -0800144 TABLETPC2FG,
Ping Cheng19635182012-04-29 21:09:18 -0700145 MTSCREEN,
Ping Cheng6afdc282012-11-03 12:16:15 -0700146 MTTPC,
Jason Gerecked51ddb22014-05-14 17:14:29 -0700147 MTTPC_B,
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400148 HID_GENERIC,
Ping Cheng3bea7332006-07-13 18:01:36 -0700149 MAX_TYPE
150};
151
152struct wacom_features {
Jason Childse33da8a2010-02-17 22:38:31 -0800153 const char *name;
Ping Cheng3bea7332006-07-13 18:01:36 -0700154 int x_max;
155 int y_max;
156 int pressure_max;
157 int distance_max;
158 int type;
Ping Chenge35fb8c2011-03-26 21:16:05 -0700159 int x_resolution;
160 int y_resolution;
Aaron Skomra70ee06c2015-08-20 16:05:16 -0700161 int numbered_buttons;
Ping Chengac414da2014-05-29 00:08:41 -0700162 int x_min;
163 int y_min;
Ping Chengec67bbe2009-12-15 00:35:24 -0800164 int device_type;
165 int x_phy;
166 int y_phy;
Benjamin Tissoiresc669fb22014-07-24 13:02:14 -0700167 unsigned unit;
168 int unitExpo;
Henrik Rydbergfed87e62010-09-05 12:25:11 -0700169 int x_fuzz;
170 int y_fuzz;
171 int pressure_fuzz;
172 int distance_fuzz;
Henrik Rydbergbc73dd32010-09-05 12:26:16 -0700173 unsigned quirks;
Ping Chengf393ee22012-04-29 21:09:17 -0700174 unsigned touch_max;
Jason Gereckeaea2bf62012-10-21 00:38:03 -0700175 int oVid;
176 int oPid;
Benjamin Tissoires80befa92014-07-24 13:05:19 -0700177 int pktlen;
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700178 bool check_for_hid_type;
179 int hid_type;
Jason Gerecke601a22f2014-12-10 16:26:04 -0800180 int last_slot_field;
Ping Cheng3bea7332006-07-13 18:01:36 -0700181};
182
Ping Cheng4492eff2010-03-19 22:18:15 -0700183struct wacom_shared {
184 bool stylus_in_proximity;
Ping Chenga43c7c52011-03-12 20:34:42 -0800185 bool touch_down;
Ping Cheng961794a2013-12-05 12:54:53 -0800186 /* for wireless device to access USB interfaces */
187 unsigned touch_max;
188 int type;
189 struct input_dev *touch_input;
Benjamin Tissoiresa97ac102015-02-25 11:43:39 -0500190 struct hid_device *pen;
191 struct hid_device *touch;
Ping Cheng4492eff2010-03-19 22:18:15 -0700192};
193
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400194struct hid_data {
Benjamin Tissoires5ae6e892014-09-23 12:08:09 -0400195 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
196 __s16 inputmode_index; /* InputMode HID feature index in the report */
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400197 bool inrange_state;
198 bool invert_state;
199 bool tipswitch;
Benjamin Tissoires5ae6e892014-09-23 12:08:09 -0400200 int x;
201 int y;
202 int pressure;
203 int width;
204 int height;
205 int id;
Jason Gerecke499522c2015-10-07 16:54:21 -0700206 int cc_report;
Jason Gerecke1b5d514a2015-07-21 11:07:24 -0700207 int cc_index;
208 int cc_value_index;
209 int num_expected;
210 int num_received;
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400211};
212
Ping Cheng3bea7332006-07-13 18:01:36 -0700213struct wacom_wac {
Jason Gerecke2a6cdbd2015-06-15 18:01:45 -0700214 char pen_name[WACOM_NAME_MAX];
215 char touch_name[WACOM_NAME_MAX];
Benjamin Tissoiresd2d13f12014-07-24 12:48:28 -0700216 char pad_name[WACOM_NAME_MAX];
Benjamin Tissoiresd70420b92014-07-25 17:31:51 -0700217 char bat_name[WACOM_NAME_MAX];
Benjamin Tissoires7dbd2292014-07-25 17:32:41 -0700218 char ac_name[WACOM_NAME_MAX];
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700219 unsigned char data[WACOM_PKGLEN_MAX];
Ping Cheng4fc19382011-03-12 20:33:33 -0800220 int tool[2];
221 int id[2];
Aaron Skomra72b236d2015-08-20 16:05:17 -0700222 __u32 serial[5];
Ping Chengb3bd7ef2015-01-09 11:05:13 -0800223 bool reporting_data;
Jason Childse33da8a2010-02-17 22:38:31 -0800224 struct wacom_features features;
Ping Cheng4492eff2010-03-19 22:18:15 -0700225 struct wacom_shared *shared;
Jason Gerecke2a6cdbd2015-06-15 18:01:45 -0700226 struct input_dev *pen_input;
227 struct input_dev *touch_input;
Benjamin Tissoiresd2d13f12014-07-24 12:48:28 -0700228 struct input_dev *pad_input;
Jason Gerecke2a6cdbd2015-06-15 18:01:45 -0700229 bool pen_registered;
230 bool touch_registered;
Ping Cheng954df6a2014-11-20 16:31:12 -0800231 bool pad_registered;
Chris Bagwell16bf2882012-03-25 23:26:20 -0700232 int pid;
Chris Bagwella1d552c2012-03-25 23:26:30 -0700233 int battery_capacity;
Ping Cheng19635182012-04-29 21:09:18 -0700234 int num_contacts_left;
Benjamin Tissoiresac8d1012014-07-25 17:29:48 -0700235 int bat_charging;
Jason Gerecke71fa6412015-03-11 10:25:41 -0700236 int bat_connected;
Benjamin Tissoiresac8d1012014-07-25 17:29:48 -0700237 int ps_connected;
Benjamin Tissoiresf81a1292014-08-06 13:48:01 -0700238 u8 bt_features;
239 u8 bt_high_speed;
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400240 struct hid_data hid_data;
Ping Cheng3bea7332006-07-13 18:01:36 -0700241};
242
243#endif