1145522Sdarrenr/* SPDX-License-Identifier: GPL-2.0-or-later */ 2145522Sdarrenr/* 353642Sguido * USB Wacom tablet support 4255332Scy * 553642Sguido * Copyright (c) 2000-2004 Vojtech Pavlik <vojtech@ucw.cz> 680482Sdarrenr * Copyright (c) 2000 Andreas Bach Aaen <abach@stofanet.dk> 753642Sguido * Copyright (c) 2000 Clifford Wolf <clifford@clifford.at> 857126Sguido * Copyright (c) 2000 Sam Mosel <sam.mosel@computer.org> 9145522Sdarrenr * Copyright (c) 2000 James E. Blair <corvus@gnu.org> 1053642Sguido * Copyright (c) 2000 Daniel Egger <egger@suse.de> 1153642Sguido * Copyright (c) 2001 Frederic Lepied <flepied@mandrakesoft.com> 1253642Sguido * Copyright (c) 2004 Panagiotis Issaris <panagiotis.issaris@mech.kuleuven.ac.be> 1353642Sguido * Copyright (c) 2002-2011 Ping Cheng <pingc@wacom.com> 1453642Sguido * Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@redhat.com> 1553642Sguido * 1653642Sguido * ChangeLog: 1753642Sguido * v0.1 (vp) - Initial release 1853642Sguido * v0.2 (aba) - Support for all buttons / combinations 19153876Sguido * v0.3 (vp) - Support for Intuos added 20145579Sdarrenr * v0.4 (sm) - Support for more Intuos models, menustrip 21145579Sdarrenr * relative mode, proximity. 22145579Sdarrenr * v0.5 (vp) - Big cleanup, nifty features removed, 23145579Sdarrenr * they belong in userspace 24145579Sdarrenr * v1.8 (vp) - Submit URB only when operating, moved to CVS, 2553642Sguido * use input_report_key instead of report_btn and 2653642Sguido * other cleanups 2753642Sguido * v1.11 (vp) - Add URB ->dev setting for new kernels 2853642Sguido * v1.11 (jb) - Add support for the 4D Mouse & Lens 2953642Sguido * v1.12 (de) - Add support for two more inking pen IDs 3053642Sguido * v1.14 (vp) - Use new USB device id probing scheme. 3153642Sguido * Fix Wacom Graphire mouse wheel 32145579Sdarrenr * v1.18 (vp) - Fix mouse wheel direction 3353642Sguido * Make mouse relative 3453642Sguido * v1.20 (fl) - Report tool id for Intuos devices 3553642Sguido * - Multi tools support 3653642Sguido * - Corrected Intuos protocol decoding (airbrush, 4D mouse, lens cursor...) 3753642Sguido * - Add PL models support 3853642Sguido * - Fix Wacom Graphire mouse wheel again 39145579Sdarrenr * v1.21 (vp) - Removed protocol descriptions 4053642Sguido * - Added MISC_SERIAL for tool serial numbers 41145579Sdarrenr * (gb) - Identify version on module load. 4253642Sguido * v1.21.1 (fl) - added Graphire2 support 4353642Sguido * v1.21.2 (fl) - added Intuos2 support 4453642Sguido * - added all the PL ids 4553642Sguido * v1.21.3 (fl) - added another eraser id from Neil Okamoto 4653642Sguido * - added smooth filter for Graphire from Peri Hankey 4753642Sguido * - added PenPartner support from Olaf van Es 4853642Sguido * - new tool ids from Ole Martin Bjoerndalen 4953642Sguido * v1.29 (pc) - Add support for more tablets 5053642Sguido * - Fix pressure reporting 5153642Sguido * v1.30 (vp) - Merge 2.4 and 2.5 drivers 5253642Sguido * - Since 2.5 now has input_sync(), remove MSC_SERIAL abuse 5353642Sguido * - Cleanups here and there 5453642Sguido * v1.30.1 (pi) - Added Graphire3 support 5553642Sguido * v1.40 (pc) - Add support for several new devices, fix eraser reporting, ... 5653642Sguido * v1.43 (pc) - Added support for Cintiq 21UX 5753642Sguido * - Fixed a Graphire bug 5853642Sguido * - Merged wacom_intuos3_irq into wacom_intuos_irq 5953642Sguido * v1.44 (pc) - Added support for Graphire4, Cintiq 710, Intuos3 6x11, etc. 6053642Sguido * - Report Device IDs 6153642Sguido * v1.45 (pc) - Added support for DTF 521, Intuos3 12x12 and 12x19 6260855Sdarrenr * - Minor data report fix 6353642Sguido * v1.46 (pc) - Split wacom.c into wacom_sys.c and wacom_wac.c, 6453642Sguido * - where wacom_sys.c deals with system specific code, 6553642Sguido * - and wacom_wac.c deals with Wacom specific code 6653642Sguido * - Support Intuos3 4x6 6753642Sguido * v1.47 (pc) - Added support for Bamboo 6853642Sguido * v1.48 (pc) - Added support for Bamboo1, BambooFun, and Cintiq 12WX 6953642Sguido * v1.49 (pc) - Added support for USB Tablet PC (0x90, 0x93, and 0x9A) 7053642Sguido * v1.50 (pc) - Fixed a TabletPC touch bug in 2.6.28 7153642Sguido * v1.51 (pc) - Added support for Intuos4 7253642Sguido * v1.52 (pc) - Query Wacom data upon system resume 7353642Sguido * - add defines for features->type 74145522Sdarrenr * - add new devices (0x9F, 0xE2, and 0XE3) 75145522Sdarrenr * v2.00 (bt) - conversion to a HID driver 76255332Scy * - integration of the Bluetooth devices 77145522Sdarrenr */ 78145522Sdarrenr 79145522Sdarrenr#ifndef WACOM_H 80145522Sdarrenr#define WACOM_H 81145522Sdarrenr 82145522Sdarrenr#include <linux/kernel.h> 83145522Sdarrenr#include <linux/slab.h> 84145522Sdarrenr#include <linux/module.h> 85145522Sdarrenr#include <linux/mod_devicetable.h> 86145522Sdarrenr#include <linux/hid.h> 87145522Sdarrenr#include <linux/kfifo.h> 88145522Sdarrenr#include <linux/leds.h> 89145522Sdarrenr#include <linux/usb/input.h> 90145522Sdarrenr#include <linux/power_supply.h> 91145522Sdarrenr#include <linux/timer.h> 92145522Sdarrenr#include <asm/unaligned.h> 93145522Sdarrenr 94255332Scy/* 95255332Scy * Version Information 96145522Sdarrenr */ 97255332Scy#define DRIVER_VERSION "v2.00" 9853642Sguido#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>" 9960855Sdarrenr#define DRIVER_DESC "USB Wacom tablet driver" 100255332Scy 10153642Sguido#define USB_VENDOR_ID_WACOM 0x056a 102255332Scy#define USB_VENDOR_ID_LENOVO 0x17ef 10353642Sguido 104255332Scyenum wacom_worker { 105255332Scy WACOM_WORKER_WIRELESS, 106255332Scy WACOM_WORKER_BATTERY, 107255332Scy WACOM_WORKER_REMOTE, 108255332Scy WACOM_WORKER_MODE_CHANGE, 109255332Scy}; 110255332Scy 111255332Scystruct wacom; 112255332Scy 113255332Scystruct wacom_led { 114255332Scy struct led_classdev cdev; 115255332Scy struct led_trigger trigger; 116255332Scy struct wacom *wacom; 117255332Scy unsigned int group; 118255332Scy unsigned int id; 11992685Sdarrenr u8 llv; 120255332Scy u8 hlv; 121255332Scy bool held; 122255332Scy}; 123255332Scy 12453642Sguidostruct wacom_group_leds { 12553642Sguido u8 select; /* status led selector (0..3) */ 12653642Sguido struct wacom_led *leds; 12753642Sguido unsigned int count; 128145522Sdarrenr struct device *dev; 12960855Sdarrenr}; 13060855Sdarrenr 13153642Sguidostruct wacom_battery { 132255332Scy struct wacom *wacom; 133255332Scy struct power_supply_desc bat_desc; 13453642Sguido struct power_supply *battery; 135145522Sdarrenr char bat_name[WACOM_NAME_MAX]; 13660855Sdarrenr int bat_status; 137255332Scy int battery_capacity; 138255332Scy int bat_charging; 139255332Scy int bat_connected; 140255332Scy int ps_connected; 141255332Scy}; 142255332Scy 143255332Scystruct wacom_remote { 144255332Scy spinlock_t remote_lock; 145255332Scy struct kfifo remote_fifo; 146255332Scy struct kobject *remote_dir; 147255332Scy struct { 148255332Scy struct attribute_group group; 149255332Scy u32 serial; 150255332Scy struct input_dev *input; 151255332Scy bool registered; 152255332Scy struct wacom_battery battery; 153255332Scy ktime_t active_time; 154145522Sdarrenr } remotes[WACOM_MAX_REMOTES]; 155255332Scy}; 156255332Scy 157145522Sdarrenrstruct wacom { 158145522Sdarrenr struct usb_device *usbdev; 159255332Scy struct usb_interface *intf; 160145522Sdarrenr struct wacom_wac wacom_wac; 161255332Scy struct hid_device *hdev; 162255332Scy struct mutex lock; 163145522Sdarrenr struct work_struct wireless_work; 16460855Sdarrenr struct work_struct battery_work; 16560855Sdarrenr struct work_struct remote_work; 16660855Sdarrenr struct delayed_work init_work; 167145522Sdarrenr struct delayed_work aes_battery_work; 168102520Sdarrenr struct wacom_remote *remote; 16972006Sdarrenr struct work_struct mode_change_work; 170255332Scy struct timer_list idleprox_timer; 17192685Sdarrenr bool generic_has_leds; 172255332Scy struct wacom_leds { 17360855Sdarrenr struct wacom_group_leds *groups; 17460855Sdarrenr unsigned int count; 17560855Sdarrenr u8 llv; /* status led brightness no button (1..127) */ 17660855Sdarrenr u8 hlv; /* status led brightness button pressed (1..127) */ 17780482Sdarrenr u8 img_lum; /* OLED matrix display brightness */ 17880482Sdarrenr u8 max_llv; /* maximum brightness of LED (llv) */ 179255332Scy u8 max_hlv; /* maximum brightness of LED (hlv) */ 180255332Scy } led; 18160855Sdarrenr struct wacom_battery battery; 18260855Sdarrenr bool resources; 18360855Sdarrenr}; 184145522Sdarrenr 18560855Sdarrenrstatic inline void wacom_schedule_work(struct wacom_wac *wacom_wac, 186255332Scy enum wacom_worker which) 187255332Scy{ 188255332Scy struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac); 189255332Scy 190255332Scy switch (which) { 191255332Scy case WACOM_WORKER_WIRELESS: 192255332Scy schedule_work(&wacom->wireless_work); 193255332Scy break; 194255332Scy case WACOM_WORKER_BATTERY: 195255332Scy schedule_work(&wacom->battery_work); 196255332Scy break; 197255332Scy case WACOM_WORKER_REMOTE: 198255332Scy schedule_work(&wacom->remote_work); 199255332Scy break; 200255332Scy case WACOM_WORKER_MODE_CHANGE: 201145522Sdarrenr schedule_work(&wacom->mode_change_work); 202145522Sdarrenr break; 203145522Sdarrenr } 204145522Sdarrenr} 205145522Sdarrenr 206145522Sdarrenr/* 207145522Sdarrenr * Convert a signed 32-bit integer to an unsigned n-bit integer. Undoes 208145522Sdarrenr * the normally-helpful work of 'hid_snto32' for fields that use signed 209145522Sdarrenr * ranges for questionable reasons. 210145522Sdarrenr */ 211145522Sdarrenrstatic inline __u32 wacom_s32tou(s32 value, __u8 n) 212145522Sdarrenr{ 213145522Sdarrenr switch (n) { 214145522Sdarrenr case 8: return ((__u8)value); 215145522Sdarrenr case 16: return ((__u16)value); 216255332Scy case 32: return ((__u32)value); 217255332Scy } 218255332Scy return value & (1 << (n - 1)) ? value & (~(~0U << n)) : value; 219255332Scy} 220255332Scy 221255332Scyextern const struct hid_device_id wacom_ids[]; 222255332Scy 223255332Scyvoid wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len); 224255332Scyvoid wacom_setup_device_quirks(struct wacom *wacom); 225255332Scyint wacom_setup_pen_input_capabilities(struct input_dev *input_dev, 22653642Sguido struct wacom_wac *wacom_wac); 22753642Sguidoint wacom_setup_touch_input_capabilities(struct input_dev *input_dev, 22892685Sdarrenr struct wacom_wac *wacom_wac); 22953642Sguidoint wacom_setup_pad_input_capabilities(struct input_dev *input_dev, 23053642Sguido struct wacom_wac *wacom_wac); 23153642Sguidovoid wacom_wac_usage_mapping(struct hid_device *hdev, 23253642Sguido struct hid_field *field, struct hid_usage *usage); 23353642Sguidovoid wacom_wac_event(struct hid_device *hdev, struct hid_field *field, 23453642Sguido struct hid_usage *usage, __s32 value); 23553642Sguidovoid wacom_wac_report(struct hid_device *hdev, struct hid_report *report); 23653642Sguidovoid wacom_battery_work(struct work_struct *work); 23753642Sguidoenum led_brightness wacom_leds_brightness_get(struct wacom_led *led); 23853642Sguidostruct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group, 23953642Sguido unsigned int id); 24053642Sguidostruct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur); 24153642Sguidoint wacom_equivalent_usage(int usage); 24253642Sguidoint wacom_initialize_leds(struct wacom *wacom); 24353642Sguidovoid wacom_idleprox_timeout(struct timer_list *list); 244145579Sdarrenr#endif 24553642Sguido