2006-07-14 05:01:36 +04:00
/*
2007-05-08 00:16:29 +04:00
* drivers / input / tablet / wacom_wac . h
2006-07-14 05:01:36 +04:00
*
* This program is free software ; you can redistribute it and / or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation ; either version 2 of the License , or
* ( at your option ) any later version .
*/
# ifndef WACOM_WAC_H
# define WACOM_WAC_H
2010-03-20 08:18:15 +03:00
# include <linux/types.h>
2015-01-06 00:32:12 +03:00
# include <linux/hid.h>
2010-03-20 08:18:15 +03:00
2009-12-15 11:35:24 +03:00
/* maximum packet length for USB devices */
2015-01-28 00:30:03 +03:00
# define WACOM_PKGLEN_MAX 192
2009-12-15 11:35:24 +03:00
2013-10-16 10:44:00 +04:00
# define WACOM_NAME_MAX 64
2015-08-21 02:05:17 +03:00
# define WACOM_MAX_REMOTES 5
# define WACOM_STATUS_UNKNOWN 255
2013-10-16 10:44:00 +04:00
2009-12-15 11:35:24 +03:00
/* packet length for individual models */
2010-02-18 09:38:31 +03:00
# define WACOM_PKGLEN_BBFUN 9
2009-12-15 11:35:24 +03:00
# define WACOM_PKGLEN_TPC1FG 5
2014-05-14 22:42:22 +04:00
# define WACOM_PKGLEN_TPC1FG_B 10
2010-02-18 09:38:31 +03:00
# define WACOM_PKGLEN_TPC2FG 14
2010-09-05 23:25:40 +04:00
# define WACOM_PKGLEN_BBTOUCH 20
2011-10-27 09:32:52 +04:00
# define WACOM_PKGLEN_BBTOUCH3 64
2011-10-27 09:34:21 +04:00
# define WACOM_PKGLEN_BBPEN 10
2012-03-26 10:26:11 +04:00
# define WACOM_PKGLEN_WIRELESS 32
2014-05-15 04:14:29 +04:00
# define WACOM_PKGLEN_PENABLED 8
2015-02-26 19:28:50 +03:00
# define WACOM_PKGLEN_BPAD_TOUCH 32
# define WACOM_PKGLEN_BPAD_TOUCH_USB 64
2012-04-30 08:09:18 +04:00
/* wacom data size per MT contact */
# define WACOM_BYTES_PER_MT_PACKET 11
2012-10-21 11:38:04 +04:00
# define WACOM_BYTES_PER_24HDT_PACKET 14
2015-01-28 00:30:03 +03:00
# define WACOM_BYTES_PER_QHDTHID_PACKET 6
2009-12-15 11:35:24 +03:00
2009-12-15 11:35:24 +03:00
/* device IDs */
2006-07-14 05:01:36 +04:00
# define STYLUS_DEVICE_ID 0x02
2008-11-24 19:44:27 +03:00
# define TOUCH_DEVICE_ID 0x03
2006-07-14 05:01:36 +04:00
# define CURSOR_DEVICE_ID 0x06
# define ERASER_DEVICE_ID 0x0A
2007-02-23 23:22:48 +03:00
# define PAD_DEVICE_ID 0x0F
2006-07-14 05:01:36 +04:00
2009-12-15 11:35:25 +03:00
/* wacom data packet report IDs */
# define WACOM_REPORT_PENABLED 2
2014-08-07 00:52:56 +04:00
# define WACOM_REPORT_PENABLED_BT 3
2015-12-01 04:13:52 +03:00
# define WACOM_REPORT_INTUOS_ID1 5
# define WACOM_REPORT_INTUOS_ID2 6
2009-12-15 11:35:25 +03:00
# define WACOM_REPORT_INTUOSPAD 12
2012-04-04 02:48:35 +04:00
# define WACOM_REPORT_INTUOS5PAD 3
2014-01-21 08:18:04 +04:00
# define WACOM_REPORT_DTUSPAD 21
2009-12-15 11:35:25 +03:00
# define WACOM_REPORT_TPC1FG 6
# define WACOM_REPORT_TPC2FG 13
2012-04-30 08:09:18 +04:00
# define WACOM_REPORT_TPCMT 13
2014-05-15 04:14:29 +04:00
# define WACOM_REPORT_TPCMT2 3
2012-01-31 12:07:33 +04:00
# define WACOM_REPORT_TPCHID 15
2015-01-28 00:30:03 +03:00
# define WACOM_REPORT_CINTIQ 16
# define WACOM_REPORT_CINTIQPAD 17
2012-01-31 12:07:33 +04:00
# define WACOM_REPORT_TPCST 16
2014-01-21 08:18:04 +04:00
# define WACOM_REPORT_DTUS 17
2012-06-12 11:15:06 +04:00
# define WACOM_REPORT_TPC1FGE 18
2012-10-21 11:38:04 +04:00
# define WACOM_REPORT_24HDT 1
2013-11-26 06:44:55 +04:00
# define WACOM_REPORT_WL 128
2013-12-06 00:54:53 +04:00
# define WACOM_REPORT_USB 192
2015-02-26 19:28:50 +03:00
# define WACOM_REPORT_BPAD_PEN 3
# define WACOM_REPORT_BPAD_TOUCH 16
2015-08-21 02:05:17 +03:00
# define WACOM_REPORT_DEVICE_LIST 16
2015-09-23 23:51:15 +03:00
# define WACOM_REPORT_INTUOS_PEN 16
2015-08-21 02:05:17 +03:00
# define WACOM_REPORT_REMOTE 17
2016-01-07 00:25:53 +03:00
# define WACOM_REPORT_INTUOSHT2_ID 8
2009-12-15 11:35:25 +03:00
2010-09-05 23:26:16 +04:00
/* device quirks */
2015-03-21 00:57:00 +03:00
# define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
# define WACOM_QUIRK_BATTERY 0x0008
2010-09-05 23:26:16 +04:00
2015-06-16 04:01:42 +03:00
/* device types */
# define WACOM_DEVICETYPE_NONE 0x0000
# define WACOM_DEVICETYPE_PEN 0x0001
# define WACOM_DEVICETYPE_TOUCH 0x0002
2015-06-16 04:01:43 +03:00
# define WACOM_DEVICETYPE_PAD 0x0004
2015-08-03 20:17:04 +03:00
# define WACOM_DEVICETYPE_WL_MONITOR 0x0008
2015-06-16 04:01:42 +03:00
2015-05-01 03:51:54 +03:00
# define WACOM_VENDORDEFINED_PEN 0xff0d0001
2016-04-04 21:26:52 +03:00
# define WACOM_G9_PAGE 0xff090000
# define WACOM_G9_DIGITIZER (WACOM_G9_PAGE | 0x02)
# define WACOM_G9_TOUCHSCREEN (WACOM_G9_PAGE | 0x11)
# define WACOM_G11_PAGE 0xff110000
# define WACOM_G11_DIGITIZER (WACOM_G11_PAGE | 0x02)
# define WACOM_G11_TOUCHSCREEN (WACOM_G11_PAGE | 0x11)
2015-05-01 03:51:54 +03:00
2015-01-06 00:32:12 +03:00
# define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \
( ( f ) - > physical = = HID_DG_STYLUS ) | | \
2015-01-06 00:32:13 +03:00
( ( f ) - > physical = = HID_DG_PEN ) | | \
2015-05-01 03:51:54 +03:00
( ( f ) - > application = = HID_DG_PEN ) | | \
( ( f ) - > application = = HID_DG_DIGITIZER ) | | \
( ( f ) - > application = = WACOM_VENDORDEFINED_PEN ) )
2015-01-06 00:32:12 +03:00
# define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \
( ( f ) - > physical = = HID_DG_FINGER ) | | \
( ( f ) - > application = = HID_DG_TOUCHSCREEN ) )
2006-07-14 05:01:36 +04:00
enum {
PENPARTNER = 0 ,
GRAPHIRE ,
2014-08-07 00:52:56 +04:00
GRAPHIRE_BT ,
2006-07-14 05:01:36 +04:00
WACOM_G4 ,
PTU ,
PL ,
2010-06-28 12:10:51 +04:00
DTU ,
2014-01-21 08:18:04 +04:00
DTUS ,
2014-12-05 05:23:04 +03:00
DTUSX ,
2006-07-14 05:01:36 +04:00
INTUOS ,
2006-09-27 00:34:47 +04:00
INTUOS3S ,
2006-07-14 05:01:36 +04:00
INTUOS3 ,
INTUOS3L ,
2009-05-09 05:30:33 +04:00
INTUOS4S ,
INTUOS4 ,
2014-08-07 00:55:56 +04:00
INTUOS4WL ,
2009-05-09 05:30:33 +04:00
INTUOS4L ,
2012-04-04 02:47:22 +04:00
INTUOS5S ,
INTUOS5 ,
INTUOS5L ,
2013-09-20 20:51:56 +04:00
INTUOSPS ,
INTUOSPM ,
INTUOSPL ,
2010-06-04 09:10:21 +04:00
WACOM_21UX2 ,
2012-07-25 10:54:11 +04:00
WACOM_22HD ,
2013-02-14 08:20:01 +04:00
DTK ,
2012-07-25 10:54:11 +04:00
WACOM_24HD ,
2015-01-28 00:30:03 +03:00
WACOM_27QHD ,
2013-09-20 20:47:35 +04:00
CINTIQ_HYBRID ,
2015-10-13 20:03:49 +03:00
CINTIQ_COMPANION_2 ,
2006-07-14 05:01:36 +04:00
CINTIQ ,
2008-03-13 23:46:46 +03:00
WACOM_BEE ,
2013-05-06 06:56:18 +04:00
WACOM_13HD ,
2007-06-15 07:32:48 +04:00
WACOM_MO ,
2015-09-23 19:59:10 +03:00
BAMBOO_PEN ,
INTUOSHT ,
2015-09-23 23:51:15 +03:00
INTUOSHT2 ,
2015-09-23 19:59:10 +03:00
BAMBOO_TOUCH ,
2012-06-12 11:14:12 +04:00
BAMBOO_PT ,
2012-10-21 11:38:04 +04:00
WACOM_24HDT ,
2015-01-28 00:30:03 +03:00
WACOM_27QHDT ,
2015-02-26 19:28:50 +03:00
BAMBOO_PAD ,
2015-10-27 00:29:12 +03:00
WIRELESS ,
2015-08-21 02:05:17 +03:00
REMOTE ,
2012-06-12 11:14:12 +04:00
TABLETPC , /* add new TPC below */
2012-06-12 11:15:06 +04:00
TABLETPCE ,
2009-12-15 11:35:24 +03:00
TABLETPC2FG ,
2012-04-30 08:09:18 +04:00
MTSCREEN ,
2012-11-03 23:16:15 +04:00
MTTPC ,
2014-05-15 04:14:29 +04:00
MTTPC_B ,
2014-09-23 20:08:08 +04:00
HID_GENERIC ,
2006-07-14 05:01:36 +04:00
MAX_TYPE
} ;
struct wacom_features {
2010-02-18 09:38:31 +03:00
const char * name ;
2006-07-14 05:01:36 +04:00
int x_max ;
int y_max ;
int pressure_max ;
int distance_max ;
int type ;
2011-03-27 08:16:05 +04:00
int x_resolution ;
int y_resolution ;
2015-08-21 02:05:16 +03:00
int numbered_buttons ;
2014-05-29 11:08:41 +04:00
int x_min ;
int y_min ;
2009-12-15 11:35:24 +03:00
int device_type ;
int x_phy ;
int y_phy ;
2014-07-25 00:02:14 +04:00
unsigned unit ;
int unitExpo ;
2010-09-05 23:25:11 +04:00
int x_fuzz ;
int y_fuzz ;
int pressure_fuzz ;
int distance_fuzz ;
2016-04-23 00:30:53 +03:00
int tilt_fuzz ;
2010-09-05 23:26:16 +04:00
unsigned quirks ;
2012-04-30 08:09:17 +04:00
unsigned touch_max ;
2012-10-21 11:38:03 +04:00
int oVid ;
int oPid ;
2014-07-25 00:05:19 +04:00
int pktlen ;
2014-07-24 23:52:23 +04:00
bool check_for_hid_type ;
int hid_type ;
2014-12-11 03:26:04 +03:00
int last_slot_field ;
2006-07-14 05:01:36 +04:00
} ;
2010-03-20 08:18:15 +03:00
struct wacom_shared {
bool stylus_in_proximity ;
2011-03-13 07:34:42 +03:00
bool touch_down ;
2013-12-06 00:54:53 +04:00
/* for wireless device to access USB interfaces */
unsigned touch_max ;
int type ;
struct input_dev * touch_input ;
2015-02-25 19:43:39 +03:00
struct hid_device * pen ;
struct hid_device * touch ;
2010-03-20 08:18:15 +03:00
} ;
2014-09-23 20:08:08 +04:00
struct hid_data {
2014-09-23 20:08:09 +04:00
__s16 inputmode ; /* InputMode HID feature, -1 if non-existent */
__s16 inputmode_index ; /* InputMode HID feature index in the report */
2014-09-23 20:08:08 +04:00
bool inrange_state ;
bool invert_state ;
bool tipswitch ;
2014-09-23 20:08:09 +04:00
int x ;
int y ;
int pressure ;
int width ;
int height ;
int id ;
2015-10-08 02:54:21 +03:00
int cc_report ;
2015-07-21 21:07:24 +03:00
int cc_index ;
int cc_value_index ;
int num_expected ;
int num_received ;
2014-09-23 20:08:08 +04:00
} ;
2006-07-14 05:01:36 +04:00
struct wacom_wac {
2015-06-16 04:01:45 +03:00
char pen_name [ WACOM_NAME_MAX ] ;
char touch_name [ WACOM_NAME_MAX ] ;
Input: wacom - create a separate input device for pads
Currently, the pad events are sent through the stylus input device
for the Intuos/Cintiqs, and through the touch input device for the
Bamboos.
To differentiate the buttons pressed on the pad from the ones pressed
on the stylus, the Intuos/Cintiq uses MISC_SERIAL and ABS_MISC. This
lead to a multiplexing of the events into one device, which are then
splitted out in xf86-input-wacom. Bamboos are not using MISC events
because the pad is attached to the touch interface, and only BTN_TOUCH
is used for the finger (and DOUBLE_TAP, etc...). However, the user space
driver still splits out the pad from the touch interface in the same
way it does for the pro line devices.
The other problem we can see with this fact is that some of the Intuos
and Cintiq have a wheel, and the effective range of the reported values
is [0..71]. Unfortunately, the airbrush stylus also sends wheel events
(there is a small wheel on it), but in the range [0..1023]. From the user
space point of view it is kind of difficult to understand that because
the wheel on the pad are quite common, while the airbrush tool is not.
A solution to fix all of these problems is to split out the pad device
from the stylus/touch. This decision makes more sense because the pad is
not linked to the absolute position of the finger or pen, and usually, the
events from the pad are filtered out by the compositor, which then convert
them into actions or keyboard shortcuts.
For backward compatibility with current xf86-input-wacom, the pad devices
still present the ABS_X, ABS_Y and ABS_MISC events, but they can be
completely ignored in the new implementation.
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Reviewed-by: Ping Cheng <pingc@wacom.com>
Reviewed-by: Jason Gerecke <killertofu@gmail.com>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
2014-07-24 23:48:28 +04:00
char pad_name [ WACOM_NAME_MAX ] ;
2014-07-26 04:31:51 +04:00
char bat_name [ WACOM_NAME_MAX ] ;
2014-07-26 04:32:41 +04:00
char ac_name [ WACOM_NAME_MAX ] ;
2014-07-24 23:52:23 +04:00
unsigned char data [ WACOM_PKGLEN_MAX ] ;
2011-03-13 07:33:33 +03:00
int tool [ 2 ] ;
int id [ 2 ] ;
2015-08-21 02:05:17 +03:00
__u32 serial [ 5 ] ;
2015-01-09 22:05:13 +03:00
bool reporting_data ;
2010-02-18 09:38:31 +03:00
struct wacom_features features ;
2010-03-20 08:18:15 +03:00
struct wacom_shared * shared ;
2015-06-16 04:01:45 +03:00
struct input_dev * pen_input ;
struct input_dev * touch_input ;
Input: wacom - create a separate input device for pads
Currently, the pad events are sent through the stylus input device
for the Intuos/Cintiqs, and through the touch input device for the
Bamboos.
To differentiate the buttons pressed on the pad from the ones pressed
on the stylus, the Intuos/Cintiq uses MISC_SERIAL and ABS_MISC. This
lead to a multiplexing of the events into one device, which are then
splitted out in xf86-input-wacom. Bamboos are not using MISC events
because the pad is attached to the touch interface, and only BTN_TOUCH
is used for the finger (and DOUBLE_TAP, etc...). However, the user space
driver still splits out the pad from the touch interface in the same
way it does for the pro line devices.
The other problem we can see with this fact is that some of the Intuos
and Cintiq have a wheel, and the effective range of the reported values
is [0..71]. Unfortunately, the airbrush stylus also sends wheel events
(there is a small wheel on it), but in the range [0..1023]. From the user
space point of view it is kind of difficult to understand that because
the wheel on the pad are quite common, while the airbrush tool is not.
A solution to fix all of these problems is to split out the pad device
from the stylus/touch. This decision makes more sense because the pad is
not linked to the absolute position of the finger or pen, and usually, the
events from the pad are filtered out by the compositor, which then convert
them into actions or keyboard shortcuts.
For backward compatibility with current xf86-input-wacom, the pad devices
still present the ABS_X, ABS_Y and ABS_MISC events, but they can be
completely ignored in the new implementation.
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Reviewed-by: Ping Cheng <pingc@wacom.com>
Reviewed-by: Jason Gerecke <killertofu@gmail.com>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
2014-07-24 23:48:28 +04:00
struct input_dev * pad_input ;
2015-06-16 04:01:45 +03:00
bool pen_registered ;
bool touch_registered ;
2014-11-21 03:31:12 +03:00
bool pad_registered ;
2012-03-26 10:26:20 +04:00
int pid ;
2012-03-26 10:26:30 +04:00
int battery_capacity ;
2012-04-30 08:09:18 +04:00
int num_contacts_left ;
2014-07-26 04:29:48 +04:00
int bat_charging ;
2015-03-11 20:25:41 +03:00
int bat_connected ;
2014-07-26 04:29:48 +04:00
int ps_connected ;
2014-08-07 00:48:01 +04:00
u8 bt_features ;
u8 bt_high_speed ;
2016-04-04 21:26:52 +03:00
int mode_report ;
int mode_value ;
2014-09-23 20:08:08 +04:00
struct hid_data hid_data ;
2006-07-14 05:01:36 +04:00
} ;
# endif