blob: 9a5ee623cb44b01aa887c4ad1de21128b713192e [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
19
Ping Chengee545002009-12-15 00:35:24 -080020/* packet length for individual models */
Jason Childse33da8a2010-02-17 22:38:31 -080021#define WACOM_PKGLEN_BBFUN 9
Ping Chengee545002009-12-15 00:35:24 -080022#define WACOM_PKGLEN_TPC1FG 5
Jason Gerecke61616ed2014-05-14 11:42:22 -070023#define WACOM_PKGLEN_TPC1FG_B 10
Jason Childse33da8a2010-02-17 22:38:31 -080024#define WACOM_PKGLEN_TPC2FG 14
Ping Cheng4a880812010-09-05 12:25:40 -070025#define WACOM_PKGLEN_BBTOUCH 20
Chris Bagwell41343612011-10-26 22:32:52 -070026#define WACOM_PKGLEN_BBTOUCH3 64
Chris Bagwell73149ab2011-10-26 22:34:21 -070027#define WACOM_PKGLEN_BBPEN 10
Chris Bagwelld3825d52012-03-25 23:26:11 -070028#define WACOM_PKGLEN_WIRELESS 32
Jason Gerecked51ddb22014-05-14 17:14:29 -070029#define WACOM_PKGLEN_PENABLED 8
Benjamin Tissoires8c97a762015-02-26 11:28:50 -050030#define WACOM_PKGLEN_BPAD_TOUCH 32
31#define WACOM_PKGLEN_BPAD_TOUCH_USB 64
Ping Cheng19635182012-04-29 21:09:18 -070032
33/* wacom data size per MT contact */
34#define WACOM_BYTES_PER_MT_PACKET 11
Jason Gereckeb1e42792012-10-21 00:38:04 -070035#define WACOM_BYTES_PER_24HDT_PACKET 14
Ping Cheng500d4162015-01-27 13:30:03 -080036#define WACOM_BYTES_PER_QHDTHID_PACKET 6
Ping Chengee545002009-12-15 00:35:24 -080037
Ping Chengec67bbe2009-12-15 00:35:24 -080038/* device IDs */
Ping Cheng3bea7332006-07-13 18:01:36 -070039#define STYLUS_DEVICE_ID 0x02
Ping Cheng545f4e92008-11-24 11:44:27 -050040#define TOUCH_DEVICE_ID 0x03
Ping Cheng3bea7332006-07-13 18:01:36 -070041#define CURSOR_DEVICE_ID 0x06
42#define ERASER_DEVICE_ID 0x0A
Ping Cheng80d4e8e2007-02-23 12:22:48 -080043#define PAD_DEVICE_ID 0x0F
Ping Cheng3bea7332006-07-13 18:01:36 -070044
Ping Chengcad74702009-12-15 00:35:25 -080045/* wacom data packet report IDs */
46#define WACOM_REPORT_PENABLED 2
Benjamin Tissoires387142b2014-08-06 13:52:56 -070047#define WACOM_REPORT_PENABLED_BT 3
Ping Chengcad74702009-12-15 00:35:25 -080048#define WACOM_REPORT_INTUOSREAD 5
49#define WACOM_REPORT_INTUOSWRITE 6
50#define WACOM_REPORT_INTUOSPAD 12
Jason Gereckef860e582012-04-03 15:48:35 -070051#define WACOM_REPORT_INTUOS5PAD 3
Ping Cheng497ab1f2014-01-20 20:18:04 -080052#define WACOM_REPORT_DTUSPAD 21
Ping Chengcad74702009-12-15 00:35:25 -080053#define WACOM_REPORT_TPC1FG 6
54#define WACOM_REPORT_TPC2FG 13
Ping Cheng19635182012-04-29 21:09:18 -070055#define WACOM_REPORT_TPCMT 13
Jason Gerecked51ddb22014-05-14 17:14:29 -070056#define WACOM_REPORT_TPCMT2 3
Ping Cheng31175a82012-01-31 00:07:33 -080057#define WACOM_REPORT_TPCHID 15
Ping Cheng500d4162015-01-27 13:30:03 -080058#define WACOM_REPORT_CINTIQ 16
59#define WACOM_REPORT_CINTIQPAD 17
Ping Cheng31175a82012-01-31 00:07:33 -080060#define WACOM_REPORT_TPCST 16
Ping Cheng497ab1f2014-01-20 20:18:04 -080061#define WACOM_REPORT_DTUS 17
Ping Chengac173832012-06-12 00:15:06 -070062#define WACOM_REPORT_TPC1FGE 18
Jason Gereckeb1e42792012-10-21 00:38:04 -070063#define WACOM_REPORT_24HDT 1
Ping Chengb5fd2a32013-11-25 18:44:55 -080064#define WACOM_REPORT_WL 128
Ping Cheng961794a2013-12-05 12:54:53 -080065#define WACOM_REPORT_USB 192
Benjamin Tissoires8c97a762015-02-26 11:28:50 -050066#define WACOM_REPORT_BPAD_PEN 3
67#define WACOM_REPORT_BPAD_TOUCH 16
Ping Chengcad74702009-12-15 00:35:25 -080068
Henrik Rydbergbc73dd32010-09-05 12:26:16 -070069/* device quirks */
Ping Chengf3586d22015-03-20 14:57:00 -070070#define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
71#define WACOM_QUIRK_NO_INPUT 0x0002
72#define WACOM_QUIRK_MONITOR 0x0004
73#define WACOM_QUIRK_BATTERY 0x0008
Henrik Rydbergbc73dd32010-09-05 12:26:16 -070074
Jason Gerecke042628a2015-04-30 17:51:54 -070075#define WACOM_VENDORDEFINED_PEN 0xff0d0001
76
Benjamin Tissoiresd97a5522015-01-05 16:32:12 -050077#define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \
78 ((f)->physical == HID_DG_STYLUS) || \
Benjamin Tissoires61e9e7e2015-01-05 16:32:13 -050079 ((f)->physical == HID_DG_PEN) || \
Jason Gerecke042628a2015-04-30 17:51:54 -070080 ((f)->application == HID_DG_PEN) || \
81 ((f)->application == HID_DG_DIGITIZER) || \
82 ((f)->application == WACOM_VENDORDEFINED_PEN))
Benjamin Tissoiresd97a5522015-01-05 16:32:12 -050083#define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \
84 ((f)->physical == HID_DG_FINGER) || \
85 ((f)->application == HID_DG_TOUCHSCREEN))
86
Ping Cheng3bea7332006-07-13 18:01:36 -070087enum {
88 PENPARTNER = 0,
89 GRAPHIRE,
Benjamin Tissoires387142b2014-08-06 13:52:56 -070090 GRAPHIRE_BT,
Ping Cheng3bea7332006-07-13 18:01:36 -070091 WACOM_G4,
92 PTU,
93 PL,
Ping Chengc8f2edc2010-06-28 01:10:51 -070094 DTU,
Ping Cheng497ab1f2014-01-20 20:18:04 -080095 DTUS,
Ping Chengfff00bf2014-12-04 18:23:04 -080096 DTUSX,
Ping Cheng3bea7332006-07-13 18:01:36 -070097 INTUOS,
Ping Cheng8d32e3a2006-09-26 13:34:47 -070098 INTUOS3S,
Ping Cheng3bea7332006-07-13 18:01:36 -070099 INTUOS3,
100 INTUOS3L,
Ping Cheng6f660f12009-05-08 18:30:33 -0700101 INTUOS4S,
102 INTUOS4,
Benjamin Tissoires81af7e62014-08-06 13:55:56 -0700103 INTUOS4WL,
Ping Cheng6f660f12009-05-08 18:30:33 -0700104 INTUOS4L,
Jason Gerecke9fee6192012-04-03 15:47:22 -0700105 INTUOS5S,
106 INTUOS5,
107 INTUOS5L,
Ping Cheng9a35c412013-09-20 09:51:56 -0700108 INTUOSPS,
109 INTUOSPM,
110 INTUOSPL,
Ping Chengb5fd2a32013-11-25 18:44:55 -0800111 INTUOSHT,
Ping Cheng3a4b4aa2010-06-03 22:10:21 -0700112 WACOM_21UX2,
Ping Chengd838c642012-07-24 23:54:11 -0700113 WACOM_22HD,
Ping Chenga112e9f2013-02-13 20:20:01 -0800114 DTK,
Ping Chengd838c642012-07-24 23:54:11 -0700115 WACOM_24HD,
Ping Cheng500d4162015-01-27 13:30:03 -0800116 WACOM_27QHD,
Jason Gerecke36d3c512013-09-20 09:47:35 -0700117 CINTIQ_HYBRID,
Ping Cheng3bea7332006-07-13 18:01:36 -0700118 CINTIQ,
Ping Cheng0e1763f2008-03-13 16:46:46 -0400119 WACOM_BEE,
Ping Cheng56218562013-05-05 19:56:18 -0700120 WACOM_13HD,
Ping Cheng7ecfbfd2007-06-14 23:32:48 -0400121 WACOM_MO,
Ping Chengea2e6022012-06-12 00:14:12 -0700122 WIRELESS,
123 BAMBOO_PT,
Jason Gereckeb1e42792012-10-21 00:38:04 -0700124 WACOM_24HDT,
Ping Cheng500d4162015-01-27 13:30:03 -0800125 WACOM_27QHDT,
Benjamin Tissoires8c97a762015-02-26 11:28:50 -0500126 BAMBOO_PAD,
Ping Chengea2e6022012-06-12 00:14:12 -0700127 TABLETPC, /* add new TPC below */
Ping Chengac173832012-06-12 00:15:06 -0700128 TABLETPCE,
Ping Chengec67bbe2009-12-15 00:35:24 -0800129 TABLETPC2FG,
Ping Cheng19635182012-04-29 21:09:18 -0700130 MTSCREEN,
Ping Cheng6afdc282012-11-03 12:16:15 -0700131 MTTPC,
Jason Gerecked51ddb22014-05-14 17:14:29 -0700132 MTTPC_B,
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400133 HID_GENERIC,
Ping Cheng3bea7332006-07-13 18:01:36 -0700134 MAX_TYPE
135};
136
137struct wacom_features {
Jason Childse33da8a2010-02-17 22:38:31 -0800138 const char *name;
Ping Cheng3bea7332006-07-13 18:01:36 -0700139 int x_max;
140 int y_max;
141 int pressure_max;
142 int distance_max;
143 int type;
Ping Chenge35fb8c2011-03-26 21:16:05 -0700144 int x_resolution;
145 int y_resolution;
Ping Chengac414da2014-05-29 00:08:41 -0700146 int x_min;
147 int y_min;
Ping Chengec67bbe2009-12-15 00:35:24 -0800148 int device_type;
149 int x_phy;
150 int y_phy;
Benjamin Tissoiresc669fb22014-07-24 13:02:14 -0700151 unsigned unit;
152 int unitExpo;
Henrik Rydbergfed87e62010-09-05 12:25:11 -0700153 int x_fuzz;
154 int y_fuzz;
155 int pressure_fuzz;
156 int distance_fuzz;
Henrik Rydbergbc73dd32010-09-05 12:26:16 -0700157 unsigned quirks;
Ping Chengf393ee22012-04-29 21:09:17 -0700158 unsigned touch_max;
Jason Gereckeaea2bf62012-10-21 00:38:03 -0700159 int oVid;
160 int oPid;
Benjamin Tissoires80befa92014-07-24 13:05:19 -0700161 int pktlen;
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700162 bool check_for_hid_type;
163 int hid_type;
Jason Gerecke601a22f2014-12-10 16:26:04 -0800164 int last_slot_field;
Ping Cheng3bea7332006-07-13 18:01:36 -0700165};
166
Ping Cheng4492eff2010-03-19 22:18:15 -0700167struct wacom_shared {
168 bool stylus_in_proximity;
Ping Chenga43c7c52011-03-12 20:34:42 -0800169 bool touch_down;
Ping Cheng961794a2013-12-05 12:54:53 -0800170 /* for wireless device to access USB interfaces */
171 unsigned touch_max;
172 int type;
173 struct input_dev *touch_input;
Benjamin Tissoiresa97ac102015-02-25 11:43:39 -0500174 struct hid_device *pen;
175 struct hid_device *touch;
Ping Cheng4492eff2010-03-19 22:18:15 -0700176};
177
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400178struct hid_data {
Benjamin Tissoires5ae6e892014-09-23 12:08:09 -0400179 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
180 __s16 inputmode_index; /* InputMode HID feature index in the report */
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400181 bool inrange_state;
182 bool invert_state;
183 bool tipswitch;
Benjamin Tissoires5ae6e892014-09-23 12:08:09 -0400184 int x;
185 int y;
186 int pressure;
187 int width;
188 int height;
189 int id;
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400190};
191
Ping Cheng3bea7332006-07-13 18:01:36 -0700192struct wacom_wac {
Ping Cheng57bcfce2013-10-15 23:44:00 -0700193 char name[WACOM_NAME_MAX];
Benjamin Tissoiresd2d13f12014-07-24 12:48:28 -0700194 char pad_name[WACOM_NAME_MAX];
Benjamin Tissoiresd70420b2014-07-25 17:31:51 -0700195 char bat_name[WACOM_NAME_MAX];
Benjamin Tissoires7dbd2292014-07-25 17:32:41 -0700196 char ac_name[WACOM_NAME_MAX];
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700197 unsigned char data[WACOM_PKGLEN_MAX];
Ping Cheng4fc19382011-03-12 20:33:33 -0800198 int tool[2];
199 int id[2];
Ping Cheng49b764a2010-02-20 00:53:49 -0800200 __u32 serial[2];
Ping Chengb3bd7ef2015-01-09 11:05:13 -0800201 bool reporting_data;
Jason Childse33da8a2010-02-17 22:38:31 -0800202 struct wacom_features features;
Ping Cheng4492eff2010-03-19 22:18:15 -0700203 struct wacom_shared *shared;
Dmitry Torokhov8da23fc2010-03-19 22:18:15 -0700204 struct input_dev *input;
Benjamin Tissoiresd2d13f12014-07-24 12:48:28 -0700205 struct input_dev *pad_input;
Benjamin Tissoires2546dac2014-09-23 12:08:06 -0400206 bool input_registered;
Ping Cheng954df6a2014-11-20 16:31:12 -0800207 bool pad_registered;
Chris Bagwell16bf2882012-03-25 23:26:20 -0700208 int pid;
Chris Bagwella1d552c2012-03-25 23:26:30 -0700209 int battery_capacity;
Ping Cheng19635182012-04-29 21:09:18 -0700210 int num_contacts_left;
Benjamin Tissoiresac8d1012014-07-25 17:29:48 -0700211 int bat_charging;
Jason Gerecke71fa6412015-03-11 10:25:41 -0700212 int bat_connected;
Benjamin Tissoiresac8d1012014-07-25 17:29:48 -0700213 int ps_connected;
Benjamin Tissoiresf81a1292014-08-06 13:48:01 -0700214 u8 bt_features;
215 u8 bt_high_speed;
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400216 struct hid_data hid_data;
Ping Cheng3bea7332006-07-13 18:01:36 -0700217};
218
219#endif