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