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/usb/input.h>
94#include <linux/power_supply.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#define DRIVER_LICENSE "GPL"
104
105#define USB_VENDOR_ID_WACOM	0x056a
106#define USB_VENDOR_ID_LENOVO	0x17ef
107
108struct wacom {
109	struct usb_device *usbdev;
110	struct usb_interface *intf;
111	struct wacom_wac wacom_wac;
112	struct hid_device *hdev;
113	struct mutex lock;
114	struct work_struct work;
115	struct wacom_led {
116		u8 select[2]; /* status led selector (0..3) */
117		u8 llv;       /* status led brightness no button (1..127) */
118		u8 hlv;       /* status led brightness button pressed (1..127) */
119		u8 img_lum;   /* OLED matrix display brightness */
120	} led;
121	bool led_initialized;
122	struct power_supply *battery;
123	struct power_supply *ac;
124	struct power_supply_desc battery_desc;
125	struct power_supply_desc ac_desc;
126};
127
128static inline void wacom_schedule_work(struct wacom_wac *wacom_wac)
129{
130	struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac);
131	schedule_work(&wacom->work);
132}
133
134extern const struct hid_device_id wacom_ids[];
135
136void wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len);
137void wacom_setup_device_quirks(struct wacom_features *features);
138int wacom_setup_pentouch_input_capabilities(struct input_dev *input_dev,
139				   struct wacom_wac *wacom_wac);
140int wacom_setup_pad_input_capabilities(struct input_dev *input_dev,
141				       struct wacom_wac *wacom_wac);
142void wacom_wac_usage_mapping(struct hid_device *hdev,
143		struct hid_field *field, struct hid_usage *usage);
144int wacom_wac_event(struct hid_device *hdev, struct hid_field *field,
145		struct hid_usage *usage, __s32 value);
146void wacom_wac_report(struct hid_device *hdev, struct hid_report *report);
147void wacom_battery_work(struct work_struct *work);
148#endif
149