[linux-2.6-block.git] / drivers / hid / wacom.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * drivers/input/tablet/wacom.h
 *
 *  USB Wacom tablet support
 *
 *  Copyright (c) 2000-2004 Vojtech Pavlik	<vojtech@ucw.cz>
 *  Copyright (c) 2000 Andreas Bach Aaen	<abach@stofanet.dk>
 *  Copyright (c) 2000 Clifford Wolf		<clifford@clifford.at>
 *  Copyright (c) 2000 Sam Mosel		<sam.mosel@computer.org>
 *  Copyright (c) 2000 James E. Blair		<corvus@gnu.org>
 *  Copyright (c) 2000 Daniel Egger		<egger@suse.de>
 *  Copyright (c) 2001 Frederic Lepied		<flepied@mandrakesoft.com>
 *  Copyright (c) 2004 Panagiotis Issaris	<panagiotis.issaris@mech.kuleuven.ac.be>
 *  Copyright (c) 2002-2011 Ping Cheng		<pingc@wacom.com>
 *  Copyright (c) 2014 Benjamin Tissoires	<benjamin.tissoires@redhat.com>
 *
 *  ChangeLog:
 *      v0.1 (vp)  - Initial release
 *      v0.2 (aba) - Support for all buttons / combinations
 *      v0.3 (vp)  - Support for Intuos added
 *	v0.4 (sm)  - Support for more Intuos models, menustrip
 *			relative mode, proximity.
 *	v0.5 (vp)  - Big cleanup, nifty features removed,
 *			they belong in userspace
 *	v1.8 (vp)  - Submit URB only when operating, moved to CVS,
 *			use input_report_key instead of report_btn and
 *			other cleanups
 *	v1.11 (vp) - Add URB ->dev setting for new kernels
 *	v1.11 (jb) - Add support for the 4D Mouse & Lens
 *	v1.12 (de) - Add support for two more inking pen IDs
 *	v1.14 (vp) - Use new USB device id probing scheme.
 *		     Fix Wacom Graphire mouse wheel
 *	v1.18 (vp) - Fix mouse wheel direction
 *		     Make mouse relative
 *      v1.20 (fl) - Report tool id for Intuos devices
 *                 - Multi tools support
 *                 - Corrected Intuos protocol decoding (airbrush, 4D mouse, lens cursor...)
 *                 - Add PL models support
 *		   - Fix Wacom Graphire mouse wheel again
 *	v1.21 (vp) - Removed protocol descriptions
 *		   - Added MISC_SERIAL for tool serial numbers
 *	      (gb) - Identify version on module load.
 *    v1.21.1 (fl) - added Graphire2 support
 *    v1.21.2 (fl) - added Intuos2 support
 *                 - added all the PL ids
 *    v1.21.3 (fl) - added another eraser id from Neil Okamoto
 *                 - added smooth filter for Graphire from Peri Hankey
 *                 - added PenPartner support from Olaf van Es
 *                 - new tool ids from Ole Martin Bjoerndalen
 *	v1.29 (pc) - Add support for more tablets
 *		   - Fix pressure reporting
 *	v1.30 (vp) - Merge 2.4 and 2.5 drivers
 *		   - Since 2.5 now has input_sync(), remove MSC_SERIAL abuse
 *		   - Cleanups here and there
 *    v1.30.1 (pi) - Added Graphire3 support
 *	v1.40 (pc) - Add support for several new devices, fix eraser reporting, ...
 *	v1.43 (pc) - Added support for Cintiq 21UX
 *		   - Fixed a Graphire bug
 *		   - Merged wacom_intuos3_irq into wacom_intuos_irq
 *	v1.44 (pc) - Added support for Graphire4, Cintiq 710, Intuos3 6x11, etc.
 *		   - Report Device IDs
 *      v1.45 (pc) - Added support for DTF 521, Intuos3 12x12 and 12x19
 *                 - Minor data report fix
 *      v1.46 (pc) - Split wacom.c into wacom_sys.c and wacom_wac.c,
 *		   - where wacom_sys.c deals with system specific code,
 *		   - and wacom_wac.c deals with Wacom specific code
 *		   - Support Intuos3 4x6
 *      v1.47 (pc) - Added support for Bamboo
 *      v1.48 (pc) - Added support for Bamboo1, BambooFun, and Cintiq 12WX
 *      v1.49 (pc) - Added support for USB Tablet PC (0x90, 0x93, and 0x9A)
 *      v1.50 (pc) - Fixed a TabletPC touch bug in 2.6.28
 *      v1.51 (pc) - Added support for Intuos4
 *      v1.52 (pc) - Query Wacom data upon system resume
 *                 - add defines for features->type
 *                 - add new devices (0x9F, 0xE2, and 0XE3)
 *      v2.00 (bt) - conversion to a HID driver
 *                 - integration of the Bluetooth devices
 */

/*
 */
#ifndef WACOM_H
#define WACOM_H
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/mod_devicetable.h>
#include <linux/hid.h>
#include <linux/kfifo.h>
#include <linux/leds.h>
#include <linux/usb/input.h>
#include <linux/power_supply.h>
#include <asm/unaligned.h>

/*
 * Version Information
 */
#define DRIVER_VERSION "v2.00"
#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
#define DRIVER_DESC "USB Wacom tablet driver"

#define USB_VENDOR_ID_WACOM	0x056a
#define USB_VENDOR_ID_LENOVO	0x17ef

enum wacom_worker {
	WACOM_WORKER_WIRELESS,
	WACOM_WORKER_BATTERY,
	WACOM_WORKER_REMOTE,
	WACOM_WORKER_MODE_CHANGE,
};

struct wacom;

struct wacom_led {
	struct led_classdev cdev;
	struct led_trigger trigger;
	struct wacom *wacom;
	unsigned int group;
	unsigned int id;
	u8 llv;
	u8 hlv;
	bool held;
};

struct wacom_group_leds {
	u8 select; /* status led selector (0..3) */
	struct wacom_led *leds;
	unsigned int count;
	struct device *dev;
};

struct wacom_battery {
	struct wacom *wacom;
	struct power_supply_desc bat_desc;
	struct power_supply *battery;
	char bat_name[WACOM_NAME_MAX];
	int bat_status;
	int battery_capacity;
	int bat_charging;
	int bat_connected;
	int ps_connected;
};

struct wacom_remote {
	spinlock_t remote_lock;
	struct kfifo remote_fifo;
	struct kobject *remote_dir;
	struct {
		struct attribute_group group;
		u32 serial;
		struct input_dev *input;
		bool registered;
		struct wacom_battery battery;
	} remotes[WACOM_MAX_REMOTES];
};

struct wacom {
	struct usb_device *usbdev;
	struct usb_interface *intf;
	struct wacom_wac wacom_wac;
	struct hid_device *hdev;
	struct mutex lock;
	struct work_struct wireless_work;
	struct work_struct battery_work;
	struct work_struct remote_work;
	struct delayed_work init_work;
	struct wacom_remote *remote;
	struct work_struct mode_change_work;
	bool generic_has_leds;
	struct wacom_leds {
		struct wacom_group_leds *groups;
		unsigned int count;
		u8 llv;       /* status led brightness no button (1..127) */
		u8 hlv;       /* status led brightness button pressed (1..127) */
		u8 img_lum;   /* OLED matrix display brightness */
		u8 max_llv;   /* maximum brightness of LED (llv) */
		u8 max_hlv;   /* maximum brightness of LED (hlv) */
	} led;
	struct wacom_battery battery;
	bool resources;
};

static inline void wacom_schedule_work(struct wacom_wac *wacom_wac,
				       enum wacom_worker which)
{
	struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac);

	switch (which) {
	case WACOM_WORKER_WIRELESS:
		schedule_work(&wacom->wireless_work);
		break;
	case WACOM_WORKER_BATTERY:
		schedule_work(&wacom->battery_work);
		break;
	case WACOM_WORKER_REMOTE:
		schedule_work(&wacom->remote_work);
		break;
	case WACOM_WORKER_MODE_CHANGE:
		schedule_work(&wacom->mode_change_work);
		break;
	}
}

extern const struct hid_device_id wacom_ids[];

void wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len);
void wacom_setup_device_quirks(struct wacom *wacom);
int wacom_setup_pen_input_capabilities(struct input_dev *input_dev,
				   struct wacom_wac *wacom_wac);
int wacom_setup_touch_input_capabilities(struct input_dev *input_dev,
				   struct wacom_wac *wacom_wac);
int wacom_setup_pad_input_capabilities(struct input_dev *input_dev,
				       struct wacom_wac *wacom_wac);
void wacom_wac_usage_mapping(struct hid_device *hdev,
		struct hid_field *field, struct hid_usage *usage);
void wacom_wac_event(struct hid_device *hdev, struct hid_field *field,
		struct hid_usage *usage, __s32 value);
void wacom_wac_report(struct hid_device *hdev, struct hid_report *report);
void wacom_battery_work(struct work_struct *work);
enum led_brightness wacom_leds_brightness_get(struct wacom_led *led);
struct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group,
				 unsigned int id);
struct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur);
int wacom_equivalent_usage(int usage);
int wacom_initialize_leds(struct wacom *wacom);
#endif
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
3bea733a	2	/*
4104d13f	3	* drivers/input/tablet/wacom.h
3bea733a	4	*
232f5693	5	* USB Wacom tablet support
3bea733a PC	6	*
	7	* Copyright (c) 2000-2004 Vojtech Pavlik <vojtech@ucw.cz>
	8	* Copyright (c) 2000 Andreas Bach Aaen <abach@stofanet.dk>
	9	* Copyright (c) 2000 Clifford Wolf <clifford@clifford.at>
	10	* Copyright (c) 2000 Sam Mosel <sam.mosel@computer.org>
	11	* Copyright (c) 2000 James E. Blair <corvus@gnu.org>
	12	* Copyright (c) 2000 Daniel Egger <egger@suse.de>
	13	* Copyright (c) 2001 Frederic Lepied <flepied@mandrakesoft.com>
	14	* Copyright (c) 2004 Panagiotis Issaris <panagiotis.issaris@mech.kuleuven.ac.be>
09e7d941	15	* Copyright (c) 2002-2011 Ping Cheng <pingc@wacom.com>
1c3c5235	16	* Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@redhat.com>
3bea733a PC	17	*
	18	* ChangeLog:
	19	* v0.1 (vp) - Initial release
	20	* v0.2 (aba) - Support for all buttons / combinations
	21	* v0.3 (vp) - Support for Intuos added
	22	* v0.4 (sm) - Support for more Intuos models, menustrip
	23	* relative mode, proximity.
	24	* v0.5 (vp) - Big cleanup, nifty features removed,
	25	* they belong in userspace
	26	* v1.8 (vp) - Submit URB only when operating, moved to CVS,
	27	* use input_report_key instead of report_btn and
	28	* other cleanups
	29	* v1.11 (vp) - Add URB ->dev setting for new kernels
	30	* v1.11 (jb) - Add support for the 4D Mouse & Lens
	31	* v1.12 (de) - Add support for two more inking pen IDs
	32	* v1.14 (vp) - Use new USB device id probing scheme.
	33	* Fix Wacom Graphire mouse wheel
	34	* v1.18 (vp) - Fix mouse wheel direction
	35	* Make mouse relative
	36	* v1.20 (fl) - Report tool id for Intuos devices
	37	* - Multi tools support
	38	* - Corrected Intuos protocol decoding (airbrush, 4D mouse, lens cursor...)
	39	* - Add PL models support
	40	* - Fix Wacom Graphire mouse wheel again
	41	* v1.21 (vp) - Removed protocol descriptions
	42	* - Added MISC_SERIAL for tool serial numbers
	43	* (gb) - Identify version on module load.
	44	* v1.21.1 (fl) - added Graphire2 support
	45	* v1.21.2 (fl) - added Intuos2 support
	46	* - added all the PL ids
	47	* v1.21.3 (fl) - added another eraser id from Neil Okamoto
	48	* - added smooth filter for Graphire from Peri Hankey
	49	* - added PenPartner support from Olaf van Es
	50	* - new tool ids from Ole Martin Bjoerndalen
	51	* v1.29 (pc) - Add support for more tablets
	52	* - Fix pressure reporting
	53	* v1.30 (vp) - Merge 2.4 and 2.5 drivers
	54	* - Since 2.5 now has input_sync(), remove MSC_SERIAL abuse
	55	* - Cleanups here and there
	56	* v1.30.1 (pi) - Added Graphire3 support
	57	* v1.40 (pc) - Add support for several new devices, fix eraser reporting, ...
	58	* v1.43 (pc) - Added support for Cintiq 21UX
	59	* - Fixed a Graphire bug
	60	* - Merged wacom_intuos3_irq into wacom_intuos_irq
	61	* v1.44 (pc) - Added support for Graphire4, Cintiq 710, Intuos3 6x11, etc.
	62	* - Report Device IDs
	63	* v1.45 (pc) - Added support for DTF 521, Intuos3 12x12 and 12x19
	64	* - Minor data report fix
	65	* v1.46 (pc) - Split wacom.c into wacom_sys.c and wacom_wac.c,
	66	* - where wacom_sys.c deals with system specific code,
7ecfbfd3	67	* - and wacom_wac.c deals with Wacom specific code
8d32e3ae	68	* - Support Intuos3 4x6
7ecfbfd3	69	* v1.47 (pc) - Added support for Bamboo
0e1763f5	70	* v1.48 (pc) - Added support for Bamboo1, BambooFun, and Cintiq 12WX
545f4e99	71	* v1.49 (pc) - Added support for USB Tablet PC (0x90, 0x93, and 0x9A)
384318ec	72	* v1.50 (pc) - Fixed a TabletPC touch bug in 2.6.28
6f660f12	73	* v1.51 (pc) - Added support for Intuos4
232f5693	74	* v1.52 (pc) - Query Wacom data upon system resume
ee54500d	75	* - add defines for features->type
ec67bbed	76	* - add new devices (0x9F, 0xE2, and 0XE3)
1c3c5235 BT	77	* v2.00 (bt) - conversion to a HID driver
1c3c5235 BT	78	* - integration of the Bluetooth devices
3bea733a PC	79	*/
	80
	81	/*
3bea733a PC	82	*/
	83	#ifndef WACOM_H
	84	#define WACOM_H
	85	#include <linux/kernel.h>
	86	#include <linux/slab.h>
	87	#include <linux/module.h>
b036f6fb	88	#include <linux/mod_devicetable.h>
7704ac93	89	#include <linux/hid.h>
e6f2813a	90	#include <linux/kfifo.h>
97f5541f	91	#include <linux/leds.h>
3bea733a	92	#include <linux/usb/input.h>
a1d552cc	93	#include <linux/power_supply.h>
3bea733a PC	94	#include <asm/unaligned.h>
	95
	96	/*
	97	* Version Information
	98	*/
1c3c5235	99	#define DRIVER_VERSION "v2.00"
3bea733a	100	#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
232f5693	101	#define DRIVER_DESC "USB Wacom tablet driver"
3bea733a	102
3bea733a	103	#define USB_VENDOR_ID_WACOM 0x056a
7b4b3068	104	#define USB_VENDOR_ID_LENOVO 0x17ef
3bea733a	105
d17d1f17 BT	106	enum wacom_worker {
	107	WACOM_WORKER_WIRELESS,
	108	WACOM_WORKER_BATTERY,
e6f2813a	109	WACOM_WORKER_REMOTE,
4082da80	110	WACOM_WORKER_MODE_CHANGE,
d17d1f17 BT	111	};
d17d1f17 BT	112
97f5541f BT	113	struct wacom;
	114
	115	struct wacom_led {
	116	struct led_classdev cdev;
	117	struct led_trigger trigger;
	118	struct wacom *wacom;
	119	unsigned int group;
	120	unsigned int id;
	121	u8 llv;
	122	u8 hlv;
	123	bool held;
	124	};
	125
a50aac71 BT	126	struct wacom_group_leds {
a50aac71 BT	127	u8 select; /* status led selector (0..3) */
97f5541f BT	128	struct wacom_led *leds;
97f5541f BT	129	unsigned int count;
589e5060	130	struct device *dev;
a50aac71 BT	131	};
a50aac71 BT	132
59d69bc8	133	struct wacom_battery {
9956953e	134	struct wacom *wacom;
59d69bc8	135	struct power_supply_desc bat_desc;
59d69bc8	136	struct power_supply *battery;
59d69bc8	137	char bat_name[WACOM_NAME_MAX];
16e45989	138	int bat_status;
59d69bc8 BT	139	int battery_capacity;
	140	int bat_charging;
	141	int bat_connected;
	142	int ps_connected;
	143	};
	144
83e6b40e BT	145	struct wacom_remote {
	146	spinlock_t remote_lock;
	147	struct kfifo remote_fifo;
	148	struct kobject *remote_dir;
e7749f6e BT	149	struct {
	150	struct attribute_group group;
	151	u32 serial;
7c35dc3c BT	152	struct input_dev *input;
7c35dc3c BT	153	bool registered;
59d69bc8	154	struct wacom_battery battery;
e7749f6e	155	} remotes[WACOM_MAX_REMOTES];
83e6b40e BT	156	};
83e6b40e BT	157
3bea733a	158	struct wacom {
3bea733a	159	struct usb_device *usbdev;
e7224094	160	struct usb_interface *intf;
51269fe8	161	struct wacom_wac wacom_wac;
29b47391	162	struct hid_device *hdev;
e7224094	163	struct mutex lock;
d17d1f17 BT	164	struct work_struct wireless_work;
d17d1f17 BT	165	struct work_struct battery_work;
e6f2813a	166	struct work_struct remote_work;
a544c619	167	struct delayed_work init_work;
83e6b40e	168	struct wacom_remote *remote;
4082da80	169	struct work_struct mode_change_work;
10c55cac	170	bool generic_has_leds;
a50aac71 BT	171	struct wacom_leds {
a50aac71 BT	172	struct wacom_group_leds *groups;
97f5541f	173	unsigned int count;
09e7d941 PC	174	u8 llv; /* status led brightness no button (1..127) */
09e7d941 PC	175	u8 hlv; /* status led brightness button pressed (1..127) */
5d7e7d47	176	u8 img_lum; /* OLED matrix display brightness */
97f5541f BT	177	u8 max_llv; /* maximum brightness of LED (llv) */
97f5541f BT	178	u8 max_hlv; /* maximum brightness of LED (hlv) */
5d7e7d47	179	} led;
59d69bc8	180	struct wacom_battery battery;
84dfbd7f	181	bool resources;
3bea733a PC	182	};
3bea733a PC	183
d17d1f17 BT	184	static inline void wacom_schedule_work(struct wacom_wac *wacom_wac,
d17d1f17 BT	185	enum wacom_worker which)
16bf288c CB	186	{
16bf288c CB	187	struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac);
d17d1f17 BT	188
	189	switch (which) {
	190	case WACOM_WORKER_WIRELESS:
	191	schedule_work(&wacom->wireless_work);
	192	break;
	193	case WACOM_WORKER_BATTERY:
	194	schedule_work(&wacom->battery_work);
	195	break;
e6f2813a BT	196	case WACOM_WORKER_REMOTE:
	197	schedule_work(&wacom->remote_work);
	198	break;
4082da80 BT	199	case WACOM_WORKER_MODE_CHANGE:
	200	schedule_work(&wacom->mode_change_work);
	201	break;
d17d1f17	202	}
16bf288c CB	203	}
16bf288c CB	204
29b47391	205	extern const struct hid_device_id wacom_ids[];
b036f6fb	206
95dd3b30	207	void wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len);
42f4f272	208	void wacom_setup_device_quirks(struct wacom *wacom);
2636a3f2 JG	209	int wacom_setup_pen_input_capabilities(struct input_dev *input_dev,
	210	struct wacom_wac *wacom_wac);
	211	int wacom_setup_touch_input_capabilities(struct input_dev *input_dev,
1963518b	212	struct wacom_wac *wacom_wac);
d2d13f18 BT	213	int wacom_setup_pad_input_capabilities(struct input_dev *input_dev,
d2d13f18 BT	214	struct wacom_wac *wacom_wac);
7704ac93 BT	215	void wacom_wac_usage_mapping(struct hid_device *hdev,
7704ac93 BT	216	struct hid_field field, struct hid_usage usage);
354a3298	217	void wacom_wac_event(struct hid_device hdev, struct hid_field field,
7704ac93 BT	218	struct hid_usage *usage, __s32 value);
7704ac93 BT	219	void wacom_wac_report(struct hid_device hdev, struct hid_report report);
fce9957d	220	void wacom_battery_work(struct work_struct *work);
34736aa9 BT	221	enum led_brightness wacom_leds_brightness_get(struct wacom_led *led);
	222	struct wacom_led wacom_led_find(struct wacom wacom, unsigned int group,
	223	unsigned int id);
	224	struct wacom_led wacom_led_next(struct wacom wacom, struct wacom_led *cur);
ac2423c9	225	int wacom_equivalent_usage(int usage);
10c55cac	226	int wacom_initialize_leds(struct wacom *wacom);
3bea733a	227	#endif