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