blob: 4681a65a4579cf1b9fbcae830f583e4e9c3d4d73 [file] [log] [blame]
Ping Cheng3bea7332006-07-13 18:01:36 -07001/*
Dmitry Torokhov4104d132007-05-07 16:16:29 -04002 * drivers/input/tablet/wacom.h
Ping Cheng3bea7332006-07-13 18:01:36 -07003 *
Ping Cheng232f5692009-12-15 00:35:24 -08004 * USB Wacom tablet support
Ping Cheng3bea7332006-07-13 18:01:36 -07005 *
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>
Ping Cheng09e7d942011-10-04 23:51:14 -070014 * Copyright (c) 2002-2011 Ping Cheng <pingc@wacom.com>
Benjamin Tissoires1c3c5232014-08-06 14:04:23 -070015 * Copyright (c) 2014 Benjamin Tissoires <benjamin.tissoires@redhat.com>
Ping Cheng3bea7332006-07-13 18:01:36 -070016 *
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,
Ping Cheng7ecfbfd2007-06-14 23:32:48 -040066 * - and wacom_wac.c deals with Wacom specific code
Ping Cheng8d32e3a2006-09-26 13:34:47 -070067 * - Support Intuos3 4x6
Ping Cheng7ecfbfd2007-06-14 23:32:48 -040068 * v1.47 (pc) - Added support for Bamboo
Ping Cheng0e1763f2008-03-13 16:46:46 -040069 * v1.48 (pc) - Added support for Bamboo1, BambooFun, and Cintiq 12WX
Ping Cheng545f4e92008-11-24 11:44:27 -050070 * v1.49 (pc) - Added support for USB Tablet PC (0x90, 0x93, and 0x9A)
Ping Cheng384318e2009-04-28 07:49:54 -070071 * v1.50 (pc) - Fixed a TabletPC touch bug in 2.6.28
Ping Cheng6f660f12009-05-08 18:30:33 -070072 * v1.51 (pc) - Added support for Intuos4
Ping Cheng232f5692009-12-15 00:35:24 -080073 * v1.52 (pc) - Query Wacom data upon system resume
Ping Chengee545002009-12-15 00:35:24 -080074 * - add defines for features->type
Ping Chengec67bbe2009-12-15 00:35:24 -080075 * - add new devices (0x9F, 0xE2, and 0XE3)
Benjamin Tissoires1c3c5232014-08-06 14:04:23 -070076 * v2.00 (bt) - conversion to a HID driver
77 * - integration of the Bluetooth devices
Ping Cheng3bea7332006-07-13 18:01:36 -070078 */
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>
Bastian Blankb036f6f2010-02-10 23:06:23 -080091#include <linux/mod_devicetable.h>
Benjamin Tissoires7704ac92014-09-23 12:08:08 -040092#include <linux/hid.h>
Ping Cheng3bea7332006-07-13 18:01:36 -070093#include <linux/usb/input.h>
Chris Bagwella1d552c2012-03-25 23:26:30 -070094#include <linux/power_supply.h>
Ping Cheng3bea7332006-07-13 18:01:36 -070095#include <asm/unaligned.h>
96
97/*
98 * Version Information
99 */
Benjamin Tissoires1c3c5232014-08-06 14:04:23 -0700100#define DRIVER_VERSION "v2.00"
Ping Cheng3bea7332006-07-13 18:01:36 -0700101#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
Ping Cheng232f5692009-12-15 00:35:24 -0800102#define DRIVER_DESC "USB Wacom tablet driver"
Ping Cheng3bea7332006-07-13 18:01:36 -0700103#define DRIVER_LICENSE "GPL"
104
Ping Cheng3bea7332006-07-13 18:01:36 -0700105#define USB_VENDOR_ID_WACOM 0x056a
Ajay Ramaswamy7b4b3062010-12-23 01:19:39 -0800106#define USB_VENDOR_ID_LENOVO 0x17ef
Ping Cheng3bea7332006-07-13 18:01:36 -0700107
108struct wacom {
Ping Cheng3bea7332006-07-13 18:01:36 -0700109 struct usb_device *usbdev;
Oliver Neukume7224092008-04-15 01:31:57 -0400110 struct usb_interface *intf;
Dmitry Torokhov51269fe2010-03-19 22:18:15 -0700111 struct wacom_wac wacom_wac;
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700112 struct hid_device *hdev;
Oliver Neukume7224092008-04-15 01:31:57 -0400113 struct mutex lock;
Chris Bagwell16bf2882012-03-25 23:26:20 -0700114 struct work_struct work;
Eduard Hasenleithner5d7e7d42011-09-07 14:08:54 -0700115 struct wacom_led {
Aaron Skomra72b236d2015-08-20 16:05:17 -0700116 u8 select[5]; /* status led selector (0..3) */
Ping Cheng09e7d942011-10-04 23:51:14 -0700117 u8 llv; /* status led brightness no button (1..127) */
118 u8 hlv; /* status led brightness button pressed (1..127) */
Eduard Hasenleithner5d7e7d42011-09-07 14:08:54 -0700119 u8 img_lum; /* OLED matrix display brightness */
120 } led;
Benjamin Tissoiresc757cba2014-07-24 13:16:17 -0700121 bool led_initialized;
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100122 struct power_supply *battery;
123 struct power_supply *ac;
124 struct power_supply_desc battery_desc;
125 struct power_supply_desc ac_desc;
Aaron Skomra72b236d2015-08-20 16:05:17 -0700126 struct kobject *remote_dir;
127 struct attribute_group remote_group[5];
Ping Cheng3bea7332006-07-13 18:01:36 -0700128};
129
Chris Bagwell16bf2882012-03-25 23:26:20 -0700130static inline void wacom_schedule_work(struct wacom_wac *wacom_wac)
131{
132 struct wacom *wacom = container_of(wacom_wac, struct wacom, wacom_wac);
133 schedule_work(&wacom->work);
134}
135
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700136extern const struct hid_device_id wacom_ids[];
Bastian Blankb036f6f2010-02-10 23:06:23 -0800137
Dmitry Torokhov95dd3b32010-03-19 22:18:15 -0700138void wacom_wac_irq(struct wacom_wac *wacom_wac, size_t len);
Ping Cheng42f4f272015-04-15 16:53:54 -0700139void wacom_setup_device_quirks(struct wacom *wacom);
Jason Gerecke2636a3f2015-06-15 18:01:44 -0700140int wacom_setup_pen_input_capabilities(struct input_dev *input_dev,
141 struct wacom_wac *wacom_wac);
142int wacom_setup_touch_input_capabilities(struct input_dev *input_dev,
Ping Cheng19635182012-04-29 21:09:18 -0700143 struct wacom_wac *wacom_wac);
Benjamin Tissoiresd2d13f12014-07-24 12:48:28 -0700144int wacom_setup_pad_input_capabilities(struct input_dev *input_dev,
145 struct wacom_wac *wacom_wac);
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400146void wacom_wac_usage_mapping(struct hid_device *hdev,
147 struct hid_field *field, struct hid_usage *usage);
148int wacom_wac_event(struct hid_device *hdev, struct hid_field *field,
149 struct hid_usage *usage, __s32 value);
150void wacom_wac_report(struct hid_device *hdev, struct hid_report *report);
Jason Gereckefce99572015-03-06 11:47:40 -0800151void wacom_battery_work(struct work_struct *work);
Aaron Skomra72b236d2015-08-20 16:05:17 -0700152int wacom_remote_create_attr_group(struct wacom *wacom, __u32 serial,
153 int index);
154void wacom_remote_destroy_attr_group(struct wacom *wacom, __u32 serial);
Ping Cheng3bea7332006-07-13 18:01:36 -0700155#endif