drivers/hid/wacom.h

   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 <linux/timer.h>
  98 #include <asm/unaligned.h>
  99
 100 /*
 101  * Version Information
 102  */
 103 #define DRIVER_VERSION "v2.00"
 104 #define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
 105 #define DRIVER_DESC "USB Wacom tablet driver"
 106
 107 #define USB_VENDOR_ID_WACOM     0x056a
 108 #define USB_VENDOR_ID_LENOVO    0x17ef
 109
 110 enum wacom_worker {
 111         WACOM_WORKER_WIRELESS,
 112         WACOM_WORKER_BATTERY,
 113         WACOM_WORKER_REMOTE,
 114         WACOM_WORKER_MODE_CHANGE,
 115 };
 116
 117 struct wacom;
 118
 119 struct wacom_led {
 120         struct led_classdev cdev;
 121         struct led_trigger trigger;
 122         struct wacom *wacom;
 123         unsigned int group;
 124         unsigned int id;
 125         u8 llv;
 126         u8 hlv;
 127         bool held;
 128 };
 129
 130 struct wacom_group_leds {
 131         u8 select; /* status led selector (0..3) */
 132         struct wacom_led *leds;
 133         unsigned int count;
 134         struct device *dev;
 135 };
 136
 137 struct wacom_battery {
 138         struct wacom *wacom;
 139         struct power_supply_desc bat_desc;
 140         struct power_supply *battery;
 141         char bat_name[WACOM_NAME_MAX];
 142         int bat_status;
 143         int battery_capacity;
 144         int bat_charging;
 145         int bat_connected;
 146         int ps_connected;
 147 };
 148
 149 struct wacom_remote {
 150         spinlock_t remote_lock;
 151         struct kfifo remote_fifo;
 152         struct kobject *remote_dir;
 153         struct {
 154                 struct attribute_group group;
 155                 u32 serial;
 156                 struct input_dev *input;
 157                 bool registered;
 158                 struct wacom_battery battery;
 159                 ktime_t active_time;
 160         } remotes[WACOM_MAX_REMOTES];
 161 };
 162
 163 struct wacom {
 164         struct usb_device *usbdev;
 165         struct usb_interface *intf;
 166         struct wacom_wac wacom_wac;
 167         struct hid_device *hdev;
 168         struct mutex lock;
 169         struct work_struct wireless_work;
 170         struct work_struct battery_work;
 171         struct work_struct remote_work;
 172         struct delayed_work init_work;
 173         struct wacom_remote *remote;
 174         struct work_struct mode_change_work;
 175         struct timer_list idleprox_timer;
 176         bool generic_has_leds;
 177         struct wacom_leds {
 178                 struct wacom_group_leds *groups;
 179                 unsigned int count;
 180                 u8 llv;       /* status led brightness no button (1..127) */
 181                 u8 hlv;       /* status led brightness button pressed (1..127) */
 182                 u8 img_lum;   /* OLED matrix display brightness */
 183                 u8 max_llv;   /* maximum brightness of LED (llv) */
 184                 u8 max_hlv;   /* maximum brightness of LED (hlv) */
 185         } led;
 186         struct wacom_battery battery;
 187         bool resources;
 188 };
 189
 190 static inline void wacom_schedule_work(struct wacom_wac *wacom_wac,
 191                                        enum wacom_worker which)
 192 {
 193         struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac);
 194
 195         switch (which) {
 196         case WACOM_WORKER_WIRELESS:
 197                 schedule_work(&wacom->wireless_work);
 198                 break;
 199         case WACOM_WORKER_BATTERY:
 200                 schedule_work(&wacom->battery_work);
 201                 break;
 202         case WACOM_WORKER_REMOTE:
 203                 schedule_work(&wacom->remote_work);
 204                 break;
 205         case WACOM_WORKER_MODE_CHANGE:
 206                 schedule_work(&wacom->mode_change_work);
 207                 break;
 208         }
 209 }
 210
 211 /*
 212  * Convert a signed 32-bit integer to an unsigned n-bit integer. Undoes
 213  * the normally-helpful work of 'hid_snto32' for fields that use signed
 214  * ranges for questionable reasons.
 215  */
 216 static inline __u32 wacom_s32tou(s32 value, __u8 n)
 217 {
 218         switch (n) {
 219         case 8:  return ((__u8)value);
 220         case 16: return ((__u16)value);
 221         case 32: return ((__u32)value);
 222         }
 223         return value & (1 << (n - 1)) ? value & (~(~0U << n)) : value;
 224 }
 225
 226 extern const struct hid_device_id wacom_ids[];
 227
 228 void wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len);
 229 void wacom_setup_device_quirks(struct wacom *wacom);
 230 int wacom_setup_pen_input_capabilities(struct input_dev *input_dev,
 231                                    struct wacom_wac *wacom_wac);
 232 int wacom_setup_touch_input_capabilities(struct input_dev *input_dev,
 233                                    struct wacom_wac *wacom_wac);
 234 int wacom_setup_pad_input_capabilities(struct input_dev *input_dev,
 235                                        struct wacom_wac *wacom_wac);
 236 void wacom_wac_usage_mapping(struct hid_device *hdev,
 237                 struct hid_field *field, struct hid_usage *usage);
 238 void wacom_wac_event(struct hid_device *hdev, struct hid_field *field,
 239                 struct hid_usage *usage, __s32 value);
 240 void wacom_wac_report(struct hid_device *hdev, struct hid_report *report);
 241 void wacom_battery_work(struct work_struct *work);
 242 enum led_brightness wacom_leds_brightness_get(struct wacom_led *led);
 243 struct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group,
 244                                  unsigned int id);
 245 struct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur);
 246 int wacom_equivalent_usage(int usage);
 247 int wacom_initialize_leds(struct wacom *wacom);
 248 void wacom_idleprox_timeout(struct timer_list *list);
 249 #endif