1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * drivers/input/tablet/wacom.h 4 * 5 * USB Wacom tablet support 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> 15 * Copyright (c) 2002-2011 Ping Cheng <pingc@wacom.com> 16 * Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@redhat.com> 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, 67 * - and wacom_wac.c deals with Wacom specific code 68 * - Support Intuos3 4x6 69 * v1.47 (pc) - Added support for Bamboo 70 * v1.48 (pc) - Added support for Bamboo1, BambooFun, and Cintiq 12WX 71 * v1.49 (pc) - Added support for USB Tablet PC (0x90, 0x93, and 0x9A) 72 * v1.50 (pc) - Fixed a TabletPC touch bug in 2.6.28 73 * v1.51 (pc) - Added support for Intuos4 74 * v1.52 (pc) - Query Wacom data upon system resume 75 * - add defines for features->type 76 * - add new devices (0x9F, 0xE2, and 0XE3) 77 * v2.00 (bt) - conversion to a HID driver 78 * - integration of the Bluetooth devices 79 */ 80 81 /* 82 */ 83 #ifndef WACOM_H 84 #define WACOM_H 85 #include <linux/kernel.h> 86 #include <linux/slab.h> 87 #include <linux/module.h> 88 #include <linux/mod_devicetable.h> 89 #include <linux/hid.h> 90 #include <linux/kfifo.h> 91 #include <linux/leds.h> 92 #include <linux/usb/input.h> 93 #include <linux/power_supply.h> 94 #include <linux/timer.h> 95 #include <asm/unaligned.h> 96 97 /* 98 * Version Information 99 */ 100 #define DRIVER_VERSION "v2.00" 101 #define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>" 102 #define DRIVER_DESC "USB Wacom tablet driver" 103 104 #define USB_VENDOR_ID_WACOM 0x056a 105 #define USB_VENDOR_ID_LENOVO 0x17ef 106 107 enum wacom_worker { 108 WACOM_WORKER_WIRELESS, 109 WACOM_WORKER_BATTERY, 110 WACOM_WORKER_REMOTE, 111 WACOM_WORKER_MODE_CHANGE, 112 }; 113 114 struct wacom; 115 116 struct wacom_led { 117 struct led_classdev cdev; 118 struct led_trigger trigger; 119 struct wacom *wacom; 120 unsigned int group; 121 unsigned int id; 122 u8 llv; 123 u8 hlv; 124 bool held; 125 }; 126 127 struct wacom_group_leds { 128 u8 select; /* status led selector (0..3) */ 129 struct wacom_led *leds; 130 unsigned int count; 131 struct device *dev; 132 }; 133 134 struct wacom_battery { 135 struct wacom *wacom; 136 struct power_supply_desc bat_desc; 137 struct power_supply *battery; 138 char bat_name[WACOM_NAME_MAX]; 139 int bat_status; 140 int battery_capacity; 141 int bat_charging; 142 int bat_connected; 143 int ps_connected; 144 }; 145 146 struct wacom_remote { 147 spinlock_t remote_lock; 148 struct kfifo remote_fifo; 149 struct kobject *remote_dir; 150 struct { 151 struct attribute_group group; 152 u32 serial; 153 struct input_dev *input; 154 bool registered; 155 struct wacom_battery battery; 156 } remotes[WACOM_MAX_REMOTES]; 157 }; 158 159 struct wacom { 160 struct usb_device *usbdev; 161 struct usb_interface *intf; 162 struct wacom_wac wacom_wac; 163 struct hid_device *hdev; 164 struct mutex lock; 165 struct work_struct wireless_work; 166 struct work_struct battery_work; 167 struct work_struct remote_work; 168 struct delayed_work init_work; 169 struct wacom_remote *remote; 170 struct work_struct mode_change_work; 171 struct timer_list idleprox_timer; 172 bool generic_has_leds; 173 struct wacom_leds { 174 struct wacom_group_leds *groups; 175 unsigned int count; 176 u8 llv; /* status led brightness no button (1..127) */ 177 u8 hlv; /* status led brightness button pressed (1..127) */ 178 u8 img_lum; /* OLED matrix display brightness */ 179 u8 max_llv; /* maximum brightness of LED (llv) */ 180 u8 max_hlv; /* maximum brightness of LED (hlv) */ 181 } led; 182 struct wacom_battery battery; 183 bool resources; 184 }; 185 186 static inline void wacom_schedule_work(struct wacom_wac *wacom_wac, 187 enum wacom_worker which) 188 { 189 struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac); 190 191 switch (which) { 192 case WACOM_WORKER_WIRELESS: 193 schedule_work(&wacom->wireless_work); 194 break; 195 case WACOM_WORKER_BATTERY: 196 schedule_work(&wacom->battery_work); 197 break; 198 case WACOM_WORKER_REMOTE: 199 schedule_work(&wacom->remote_work); 200 break; 201 case WACOM_WORKER_MODE_CHANGE: 202 schedule_work(&wacom->mode_change_work); 203 break; 204 } 205 } 206 207 /* 208 * Convert a signed 32-bit integer to an unsigned n-bit integer. Undoes 209 * the normally-helpful work of 'hid_snto32' for fields that use signed 210 * ranges for questionable reasons. 211 */ 212 static inline __u32 wacom_s32tou(s32 value, __u8 n) 213 { 214 switch (n) { 215 case 8: return ((__u8)value); 216 case 16: return ((__u16)value); 217 case 32: return ((__u32)value); 218 } 219 return value & (1 << (n - 1)) ? value & (~(~0U << n)) : value; 220 } 221 222 extern const struct hid_device_id wacom_ids[]; 223 224 void wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len); 225 void wacom_setup_device_quirks(struct wacom *wacom); 226 int wacom_setup_pen_input_capabilities(struct input_dev *input_dev, 227 struct wacom_wac *wacom_wac); 228 int wacom_setup_touch_input_capabilities(struct input_dev *input_dev, 229 struct wacom_wac *wacom_wac); 230 int wacom_setup_pad_input_capabilities(struct input_dev *input_dev, 231 struct wacom_wac *wacom_wac); 232 void wacom_wac_usage_mapping(struct hid_device *hdev, 233 struct hid_field *field, struct hid_usage *usage); 234 void wacom_wac_event(struct hid_device *hdev, struct hid_field *field, 235 struct hid_usage *usage, __s32 value); 236 void wacom_wac_report(struct hid_device *hdev, struct hid_report *report); 237 void wacom_battery_work(struct work_struct *work); 238 enum led_brightness wacom_leds_brightness_get(struct wacom_led *led); 239 struct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group, 240 unsigned int id); 241 struct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur); 242 int wacom_equivalent_usage(int usage); 243 int wacom_initialize_leds(struct wacom *wacom); 244 void wacom_idleprox_timeout(struct timer_list *list); 245 #endif 246