1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Xbox gamepad driver
4 *
5 * Copyright (c) 2002 Marko Friedemann <mfr@bmx-chemnitz.de>
6 *               2004 Oliver Schwartz <Oliver.Schwartz@gmx.de>,
7 *                    Steven Toth <steve@toth.demon.co.uk>,
8 *                    Franz Lehner <franz@caos.at>,
9 *                    Ivan Hawkes <blackhawk@ivanhawkes.com>
10 *               2005 Dominic Cerquetti <binary1230@yahoo.com>
11 *               2006 Adam Buchbinder <adam.buchbinder@gmail.com>
12 *               2007 Jan Kratochvil <honza@jikos.cz>
13 *               2010 Christoph Fritz <chf.fritz@googlemail.com>
14 *
15 * This driver is based on:
16 *  - information from     http://euc.jp/periphs/xbox-controller.ja.html
17 *  - the iForce driver    drivers/char/joystick/iforce.c
18 *  - the skeleton-driver  drivers/usb/usb-skeleton.c
19 *  - Xbox 360 information http://www.free60.org/wiki/Gamepad
20 *  - Xbox One information https://github.com/quantus/xbox-one-controller-protocol
21 *
22 * Thanks to:
23 *  - ITO Takayuki for providing essential xpad information on his website
24 *  - Vojtech Pavlik     - iforce driver / input subsystem
25 *  - Greg Kroah-Hartman - usb-skeleton driver
26 *  - Xbox Linux project - extra USB IDs
27 *  - Pekka P��yry (quantus) - Xbox One controller reverse-engineering
28 *
29 * TODO:
30 *  - fine tune axes (especially trigger axes)
31 *  - fix "analog" buttons (reported as digital now)
32 *  - get rumble working
33 *  - need USB IDs for other dance pads
34 *
35 * History:
36 *
37 * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
38 *
39 * 2002-07-02 - 0.0.2 : basic working version
40 *  - all axes and 9 of the 10 buttons work (german InterAct device)
41 *  - the black button does not work
42 *
43 * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
44 *  - indentation fixes
45 *  - usb + input init sequence fixes
46 *
47 * 2002-07-16 - 0.0.4 : minor changes, merge with Vojtech's v0.0.3
48 *  - verified the lack of HID and report descriptors
49 *  - verified that ALL buttons WORK
50 *  - fixed d-pad to axes mapping
51 *
52 * 2002-07-17 - 0.0.5 : simplified d-pad handling
53 *
54 * 2004-10-02 - 0.0.6 : DDR pad support
55 *  - borrowed from the Xbox Linux kernel
56 *  - USB id's for commonly used dance pads are present
57 *  - dance pads will map D-PAD to buttons, not axes
58 *  - pass the module paramater 'dpad_to_buttons' to force
59 *    the D-PAD to map to buttons if your pad is not detected
60 *
61 * Later changes can be tracked in SCM.
62 */
63
64#include <linux/bits.h>
65#include <linux/kernel.h>
66#include <linux/input.h>
67#include <linux/rcupdate.h>
68#include <linux/slab.h>
69#include <linux/stat.h>
70#include <linux/module.h>
71#include <linux/usb/input.h>
72#include <linux/usb/quirks.h>
73
74#define XPAD_PKT_LEN 64
75
76/*
77 * xbox d-pads should map to buttons, as is required for DDR pads
78 * but we map them to axes when possible to simplify things
79 */
80#define MAP_DPAD_TO_BUTTONS		(1 << 0)
81#define MAP_TRIGGERS_TO_BUTTONS		(1 << 1)
82#define MAP_STICKS_TO_NULL		(1 << 2)
83#define MAP_SELECT_BUTTON		(1 << 3)
84#define MAP_PADDLES			(1 << 4)
85#define MAP_PROFILE_BUTTON		(1 << 5)
86
87#define DANCEPAD_MAP_CONFIG	(MAP_DPAD_TO_BUTTONS |			\
88				MAP_TRIGGERS_TO_BUTTONS | MAP_STICKS_TO_NULL)
89
90#define XTYPE_XBOX        0
91#define XTYPE_XBOX360     1
92#define XTYPE_XBOX360W    2
93#define XTYPE_XBOXONE     3
94#define XTYPE_UNKNOWN     4
95
96/* Send power-off packet to xpad360w after holding the mode button for this many
97 * seconds
98 */
99#define XPAD360W_POWEROFF_TIMEOUT 5
100
101#define PKT_XB              0
102#define PKT_XBE1            1
103#define PKT_XBE2_FW_OLD     2
104#define PKT_XBE2_FW_5_EARLY 3
105#define PKT_XBE2_FW_5_11    4
106
107static bool dpad_to_buttons;
108module_param(dpad_to_buttons, bool, S_IRUGO);
109MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
110
111static bool triggers_to_buttons;
112module_param(triggers_to_buttons, bool, S_IRUGO);
113MODULE_PARM_DESC(triggers_to_buttons, "Map triggers to buttons rather than axes for unknown pads");
114
115static bool sticks_to_null;
116module_param(sticks_to_null, bool, S_IRUGO);
117MODULE_PARM_DESC(sticks_to_null, "Do not map sticks at all for unknown pads");
118
119static bool auto_poweroff = true;
120module_param(auto_poweroff, bool, S_IWUSR | S_IRUGO);
121MODULE_PARM_DESC(auto_poweroff, "Power off wireless controllers on suspend");
122
123static const struct xpad_device {
124	u16 idVendor;
125	u16 idProduct;
126	char *name;
127	u8 mapping;
128	u8 xtype;
129} xpad_device[] = {
130	/* Please keep this list sorted by vendor and product ID. */
131	{ 0x0079, 0x18d4, "GPD Win 2 X-Box Controller", 0, XTYPE_XBOX360 },
132	{ 0x03eb, 0xff01, "Wooting One (Legacy)", 0, XTYPE_XBOX360 },
133	{ 0x03eb, 0xff02, "Wooting Two (Legacy)", 0, XTYPE_XBOX360 },
134	{ 0x03f0, 0x038D, "HyperX Clutch", 0, XTYPE_XBOX360 },			/* wired */
135	{ 0x03f0, 0x048D, "HyperX Clutch", 0, XTYPE_XBOX360 },			/* wireless */
136	{ 0x03f0, 0x0495, "HyperX Clutch Gladiate", 0, XTYPE_XBOXONE },
137	{ 0x03f0, 0x07A0, "HyperX Clutch Gladiate RGB", 0, XTYPE_XBOXONE },
138	{ 0x03f0, 0x08B6, "HyperX Clutch Gladiate", 0, XTYPE_XBOXONE },		/* v2 */
139	{ 0x03f0, 0x09B4, "HyperX Clutch Tanto", 0, XTYPE_XBOXONE },
140	{ 0x044f, 0x0f00, "Thrustmaster Wheel", 0, XTYPE_XBOX },
141	{ 0x044f, 0x0f03, "Thrustmaster Wheel", 0, XTYPE_XBOX },
142	{ 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
143	{ 0x044f, 0x0f10, "Thrustmaster Modena GT Wheel", 0, XTYPE_XBOX },
144	{ 0x044f, 0xb326, "Thrustmaster Gamepad GP XID", 0, XTYPE_XBOX360 },
145	{ 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", 0, XTYPE_XBOX },
146	{ 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", 0, XTYPE_XBOX },
147	{ 0x045e, 0x0287, "Microsoft Xbox Controller S", 0, XTYPE_XBOX },
148	{ 0x045e, 0x0288, "Microsoft Xbox Controller S v2", 0, XTYPE_XBOX },
149	{ 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", 0, XTYPE_XBOX },
150	{ 0x045e, 0x028e, "Microsoft X-Box 360 pad", 0, XTYPE_XBOX360 },
151	{ 0x045e, 0x028f, "Microsoft X-Box 360 pad v2", 0, XTYPE_XBOX360 },
152	{ 0x045e, 0x0291, "Xbox 360 Wireless Receiver (XBOX)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
153	{ 0x045e, 0x02d1, "Microsoft X-Box One pad", 0, XTYPE_XBOXONE },
154	{ 0x045e, 0x02dd, "Microsoft X-Box One pad (Firmware 2015)", 0, XTYPE_XBOXONE },
155	{ 0x045e, 0x02e3, "Microsoft X-Box One Elite pad", MAP_PADDLES, XTYPE_XBOXONE },
156	{ 0x045e, 0x02ea, "Microsoft X-Box One S pad", 0, XTYPE_XBOXONE },
157	{ 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
158	{ 0x045e, 0x0b00, "Microsoft X-Box One Elite 2 pad", MAP_PADDLES, XTYPE_XBOXONE },
159	{ 0x045e, 0x0b0a, "Microsoft X-Box Adaptive Controller", MAP_PROFILE_BUTTON, XTYPE_XBOXONE },
160	{ 0x045e, 0x0b12, "Microsoft Xbox Series S|X Controller", MAP_SELECT_BUTTON, XTYPE_XBOXONE },
161	{ 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
162	{ 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
163	{ 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },
164	{ 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
165	{ 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
166	{ 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
167	{ 0x046d, 0xca8a, "Logitech Precision Vibration Feedback Wheel", 0, XTYPE_XBOX },
168	{ 0x046d, 0xcaa3, "Logitech DriveFx Racing Wheel", 0, XTYPE_XBOX360 },
169	{ 0x056e, 0x2004, "Elecom JC-U3613M", 0, XTYPE_XBOX360 },
170	{ 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
171	{ 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
172	{ 0x05fe, 0x3030, "Chic Controller", 0, XTYPE_XBOX },
173	{ 0x05fe, 0x3031, "Chic Controller", 0, XTYPE_XBOX },
174	{ 0x062a, 0x0020, "Logic3 Xbox GamePad", 0, XTYPE_XBOX },
175	{ 0x062a, 0x0033, "Competition Pro Steering Wheel", 0, XTYPE_XBOX },
176	{ 0x06a3, 0x0200, "Saitek Racing Wheel", 0, XTYPE_XBOX },
177	{ 0x06a3, 0x0201, "Saitek Adrenalin", 0, XTYPE_XBOX },
178	{ 0x06a3, 0xf51a, "Saitek P3600", 0, XTYPE_XBOX360 },
179	{ 0x0738, 0x4506, "Mad Catz 4506 Wireless Controller", 0, XTYPE_XBOX },
180	{ 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
181	{ 0x0738, 0x4520, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
182	{ 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
183	{ 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
184	{ 0x0738, 0x4530, "Mad Catz Universal MC2 Racing Wheel and Pedals", 0, XTYPE_XBOX },
185	{ 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
186	{ 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
187	{ 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
188	{ 0x0738, 0x4586, "Mad Catz MicroCon Wireless Controller", 0, XTYPE_XBOX },
189	{ 0x0738, 0x4588, "Mad Catz Blaster", 0, XTYPE_XBOX },
190	{ 0x0738, 0x45ff, "Mad Catz Beat Pad (w/ Handle)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
191	{ 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
192	{ 0x0738, 0x4718, "Mad Catz Street Fighter IV FightStick SE", 0, XTYPE_XBOX360 },
193	{ 0x0738, 0x4726, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
194	{ 0x0738, 0x4728, "Mad Catz Street Fighter IV FightPad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
195	{ 0x0738, 0x4736, "Mad Catz MicroCon Gamepad", 0, XTYPE_XBOX360 },
196	{ 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
197	{ 0x0738, 0x4740, "Mad Catz Beat Pad", 0, XTYPE_XBOX360 },
198	{ 0x0738, 0x4743, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
199	{ 0x0738, 0x4758, "Mad Catz Arcade Game Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
200	{ 0x0738, 0x4a01, "Mad Catz FightStick TE 2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
201	{ 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
202	{ 0x0738, 0x9871, "Mad Catz Portable Drum", 0, XTYPE_XBOX360 },
203	{ 0x0738, 0xb726, "Mad Catz Xbox controller - MW2", 0, XTYPE_XBOX360 },
204	{ 0x0738, 0xb738, "Mad Catz MVC2TE Stick 2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
205	{ 0x0738, 0xbeef, "Mad Catz JOYTECH NEO SE Advanced GamePad", XTYPE_XBOX360 },
206	{ 0x0738, 0xcb02, "Saitek Cyborg Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
207	{ 0x0738, 0xcb03, "Saitek P3200 Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
208	{ 0x0738, 0xcb29, "Saitek Aviator Stick AV8R02", 0, XTYPE_XBOX360 },
209	{ 0x0738, 0xf738, "Super SFIV FightStick TE S", 0, XTYPE_XBOX360 },
210	{ 0x07ff, 0xffff, "Mad Catz GamePad", 0, XTYPE_XBOX360 },
211	{ 0x0c12, 0x0005, "Intec wireless", 0, XTYPE_XBOX },
212	{ 0x0c12, 0x8801, "Nyko Xbox Controller", 0, XTYPE_XBOX },
213	{ 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
214	{ 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
215	{ 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
216	{ 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
217	{ 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
218	{ 0x0d2f, 0x0002, "Andamiro Pump It Up pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
219	{ 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
220	{ 0x0e4c, 0x1103, "Radica Gamester Reflex", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX },
221	{ 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
222	{ 0x0e4c, 0x3510, "Radica Gamester", 0, XTYPE_XBOX },
223	{ 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
224	{ 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
225	{ 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
226	{ 0x0e6f, 0x0008, "After Glow Pro Controller", 0, XTYPE_XBOX },
227	{ 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
228	{ 0x0e6f, 0x0113, "Afterglow AX.1 Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
229	{ 0x0e6f, 0x011f, "Rock Candy Gamepad Wired Controller", 0, XTYPE_XBOX360 },
230	{ 0x0e6f, 0x0131, "PDP EA Sports Controller", 0, XTYPE_XBOX360 },
231	{ 0x0e6f, 0x0133, "Xbox 360 Wired Controller", 0, XTYPE_XBOX360 },
232	{ 0x0e6f, 0x0139, "Afterglow Prismatic Wired Controller", 0, XTYPE_XBOXONE },
233	{ 0x0e6f, 0x013a, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
234	{ 0x0e6f, 0x0146, "Rock Candy Wired Controller for Xbox One", 0, XTYPE_XBOXONE },
235	{ 0x0e6f, 0x0147, "PDP Marvel Xbox One Controller", 0, XTYPE_XBOXONE },
236	{ 0x0e6f, 0x015c, "PDP Xbox One Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
237	{ 0x0e6f, 0x0161, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
238	{ 0x0e6f, 0x0162, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
239	{ 0x0e6f, 0x0163, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
240	{ 0x0e6f, 0x0164, "PDP Battlefield One", 0, XTYPE_XBOXONE },
241	{ 0x0e6f, 0x0165, "PDP Titanfall 2", 0, XTYPE_XBOXONE },
242	{ 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
243	{ 0x0e6f, 0x0213, "Afterglow Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
244	{ 0x0e6f, 0x021f, "Rock Candy Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
245	{ 0x0e6f, 0x0246, "Rock Candy Gamepad for Xbox One 2015", 0, XTYPE_XBOXONE },
246	{ 0x0e6f, 0x02a0, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
247	{ 0x0e6f, 0x02a1, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
248	{ 0x0e6f, 0x02a2, "PDP Wired Controller for Xbox One - Crimson Red", 0, XTYPE_XBOXONE },
249	{ 0x0e6f, 0x02a4, "PDP Wired Controller for Xbox One - Stealth Series", 0, XTYPE_XBOXONE },
250	{ 0x0e6f, 0x02a6, "PDP Wired Controller for Xbox One - Camo Series", 0, XTYPE_XBOXONE },
251	{ 0x0e6f, 0x02a7, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
252	{ 0x0e6f, 0x02a8, "PDP Xbox One Controller", 0, XTYPE_XBOXONE },
253	{ 0x0e6f, 0x02ab, "PDP Controller for Xbox One", 0, XTYPE_XBOXONE },
254	{ 0x0e6f, 0x02ad, "PDP Wired Controller for Xbox One - Stealth Series", 0, XTYPE_XBOXONE },
255	{ 0x0e6f, 0x02b3, "Afterglow Prismatic Wired Controller", 0, XTYPE_XBOXONE },
256	{ 0x0e6f, 0x02b8, "Afterglow Prismatic Wired Controller", 0, XTYPE_XBOXONE },
257	{ 0x0e6f, 0x0301, "Logic3 Controller", 0, XTYPE_XBOX360 },
258	{ 0x0e6f, 0x0346, "Rock Candy Gamepad for Xbox One 2016", 0, XTYPE_XBOXONE },
259	{ 0x0e6f, 0x0401, "Logic3 Controller", 0, XTYPE_XBOX360 },
260	{ 0x0e6f, 0x0413, "Afterglow AX.1 Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
261	{ 0x0e6f, 0x0501, "PDP Xbox 360 Controller", 0, XTYPE_XBOX360 },
262	{ 0x0e6f, 0xf900, "PDP Afterglow AX.1", 0, XTYPE_XBOX360 },
263	{ 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
264	{ 0x0e8f, 0x3008, "Generic xbox control (dealextreme)", 0, XTYPE_XBOX },
265	{ 0x0f0d, 0x000a, "Hori Co. DOA4 FightStick", 0, XTYPE_XBOX360 },
266	{ 0x0f0d, 0x000c, "Hori PadEX Turbo", 0, XTYPE_XBOX360 },
267	{ 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
268	{ 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
269	{ 0x0f0d, 0x001b, "Hori Real Arcade Pro VX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
270	{ 0x0f0d, 0x0063, "Hori Real Arcade Pro Hayabusa (USA) Xbox One", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
271	{ 0x0f0d, 0x0067, "HORIPAD ONE", 0, XTYPE_XBOXONE },
272	{ 0x0f0d, 0x0078, "Hori Real Arcade Pro V Kai Xbox One", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
273	{ 0x0f0d, 0x00c5, "Hori Fighting Commander ONE", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
274	{ 0x0f0d, 0x00dc, "HORIPAD FPS for Nintendo Switch", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
275	{ 0x0f30, 0x010b, "Philips Recoil", 0, XTYPE_XBOX },
276	{ 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
277	{ 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
278	{ 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
279	{ 0x1038, 0x1430, "SteelSeries Stratus Duo", 0, XTYPE_XBOX360 },
280	{ 0x1038, 0x1431, "SteelSeries Stratus Duo", 0, XTYPE_XBOX360 },
281	{ 0x11c9, 0x55f0, "Nacon GC-100XF", 0, XTYPE_XBOX360 },
282	{ 0x11ff, 0x0511, "PXN V900", 0, XTYPE_XBOX360 },
283	{ 0x1209, 0x2882, "Ardwiino Controller", 0, XTYPE_XBOX360 },
284	{ 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
285	{ 0x12ab, 0x0301, "PDP AFTERGLOW AX.1", 0, XTYPE_XBOX360 },
286	{ 0x12ab, 0x0303, "Mortal Kombat Klassic FightStick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
287	{ 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
288	{ 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
289	{ 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
290	{ 0x1430, 0xf801, "RedOctane Controller", 0, XTYPE_XBOX360 },
291	{ 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
292	{ 0x146b, 0x0604, "Bigben Interactive DAIJA Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
293	{ 0x1532, 0x0a00, "Razer Atrox Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
294	{ 0x1532, 0x0a03, "Razer Wildcat", 0, XTYPE_XBOXONE },
295	{ 0x1532, 0x0a29, "Razer Wolverine V2", 0, XTYPE_XBOXONE },
296	{ 0x15e4, 0x3f00, "Power A Mini Pro Elite", 0, XTYPE_XBOX360 },
297	{ 0x15e4, 0x3f0a, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
298	{ 0x15e4, 0x3f10, "Batarang Xbox 360 controller", 0, XTYPE_XBOX360 },
299	{ 0x162e, 0xbeef, "Joytech Neo-Se Take2", 0, XTYPE_XBOX360 },
300	{ 0x1689, 0xfd00, "Razer Onza Tournament Edition", 0, XTYPE_XBOX360 },
301	{ 0x1689, 0xfd01, "Razer Onza Classic Edition", 0, XTYPE_XBOX360 },
302	{ 0x1689, 0xfe00, "Razer Sabertooth", 0, XTYPE_XBOX360 },
303	{ 0x17ef, 0x6182, "Lenovo Legion Controller for Windows", 0, XTYPE_XBOX360 },
304	{ 0x1949, 0x041a, "Amazon Game Controller", 0, XTYPE_XBOX360 },
305	{ 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
306	{ 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
307	{ 0x1bad, 0x0130, "Ion Drum Rocker", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
308	{ 0x1bad, 0xf016, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
309	{ 0x1bad, 0xf018, "Mad Catz Street Fighter IV SE Fighting Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
310	{ 0x1bad, 0xf019, "Mad Catz Brawlstick for Xbox 360", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
311	{ 0x1bad, 0xf021, "Mad Cats Ghost Recon FS GamePad", 0, XTYPE_XBOX360 },
312	{ 0x1bad, 0xf023, "MLG Pro Circuit Controller (Xbox)", 0, XTYPE_XBOX360 },
313	{ 0x1bad, 0xf025, "Mad Catz Call Of Duty", 0, XTYPE_XBOX360 },
314	{ 0x1bad, 0xf027, "Mad Catz FPS Pro", 0, XTYPE_XBOX360 },
315	{ 0x1bad, 0xf028, "Street Fighter IV FightPad", 0, XTYPE_XBOX360 },
316	{ 0x1bad, 0xf02e, "Mad Catz Fightpad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
317	{ 0x1bad, 0xf030, "Mad Catz Xbox 360 MC2 MicroCon Racing Wheel", 0, XTYPE_XBOX360 },
318	{ 0x1bad, 0xf036, "Mad Catz MicroCon GamePad Pro", 0, XTYPE_XBOX360 },
319	{ 0x1bad, 0xf038, "Street Fighter IV FightStick TE", 0, XTYPE_XBOX360 },
320	{ 0x1bad, 0xf039, "Mad Catz MvC2 TE", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
321	{ 0x1bad, 0xf03a, "Mad Catz SFxT Fightstick Pro", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
322	{ 0x1bad, 0xf03d, "Street Fighter IV Arcade Stick TE - Chun Li", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
323	{ 0x1bad, 0xf03e, "Mad Catz MLG FightStick TE", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
324	{ 0x1bad, 0xf03f, "Mad Catz FightStick SoulCaliber", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
325	{ 0x1bad, 0xf042, "Mad Catz FightStick TES+", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
326	{ 0x1bad, 0xf080, "Mad Catz FightStick TE2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
327	{ 0x1bad, 0xf501, "HoriPad EX2 Turbo", 0, XTYPE_XBOX360 },
328	{ 0x1bad, 0xf502, "Hori Real Arcade Pro.VX SA", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
329	{ 0x1bad, 0xf503, "Hori Fighting Stick VX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
330	{ 0x1bad, 0xf504, "Hori Real Arcade Pro. EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
331	{ 0x1bad, 0xf505, "Hori Fighting Stick EX2B", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
332	{ 0x1bad, 0xf506, "Hori Real Arcade Pro.EX Premium VLX", 0, XTYPE_XBOX360 },
333	{ 0x1bad, 0xf900, "Harmonix Xbox 360 Controller", 0, XTYPE_XBOX360 },
334	{ 0x1bad, 0xf901, "Gamestop Xbox 360 Controller", 0, XTYPE_XBOX360 },
335	{ 0x1bad, 0xf903, "Tron Xbox 360 controller", 0, XTYPE_XBOX360 },
336	{ 0x1bad, 0xf904, "PDP Versus Fighting Pad", 0, XTYPE_XBOX360 },
337	{ 0x1bad, 0xf906, "MortalKombat FightStick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
338	{ 0x1bad, 0xfa01, "MadCatz GamePad", 0, XTYPE_XBOX360 },
339	{ 0x1bad, 0xfd00, "Razer Onza TE", 0, XTYPE_XBOX360 },
340	{ 0x1bad, 0xfd01, "Razer Onza", 0, XTYPE_XBOX360 },
341	{ 0x20d6, 0x2001, "BDA Xbox Series X Wired Controller", 0, XTYPE_XBOXONE },
342	{ 0x20d6, 0x2009, "PowerA Enhanced Wired Controller for Xbox Series X|S", 0, XTYPE_XBOXONE },
343	{ 0x20d6, 0x281f, "PowerA Wired Controller For Xbox 360", 0, XTYPE_XBOX360 },
344	{ 0x24c6, 0x5000, "Razer Atrox Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
345	{ 0x24c6, 0x5300, "PowerA MINI PROEX Controller", 0, XTYPE_XBOX360 },
346	{ 0x24c6, 0x5303, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
347	{ 0x24c6, 0x530a, "Xbox 360 Pro EX Controller", 0, XTYPE_XBOX360 },
348	{ 0x24c6, 0x531a, "PowerA Pro Ex", 0, XTYPE_XBOX360 },
349	{ 0x24c6, 0x5397, "FUS1ON Tournament Controller", 0, XTYPE_XBOX360 },
350	{ 0x24c6, 0x541a, "PowerA Xbox One Mini Wired Controller", 0, XTYPE_XBOXONE },
351	{ 0x24c6, 0x542a, "Xbox ONE spectra", 0, XTYPE_XBOXONE },
352	{ 0x24c6, 0x543a, "PowerA Xbox One wired controller", 0, XTYPE_XBOXONE },
353	{ 0x24c6, 0x5500, "Hori XBOX 360 EX 2 with Turbo", 0, XTYPE_XBOX360 },
354	{ 0x24c6, 0x5501, "Hori Real Arcade Pro VX-SA", 0, XTYPE_XBOX360 },
355	{ 0x24c6, 0x5502, "Hori Fighting Stick VX Alt", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
356	{ 0x24c6, 0x5503, "Hori Fighting Edge", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
357	{ 0x24c6, 0x5506, "Hori SOULCALIBUR V Stick", 0, XTYPE_XBOX360 },
358	{ 0x24c6, 0x550d, "Hori GEM Xbox controller", 0, XTYPE_XBOX360 },
359	{ 0x24c6, 0x550e, "Hori Real Arcade Pro V Kai 360", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
360	{ 0x24c6, 0x5510, "Hori Fighting Commander ONE (Xbox 360/PC Mode)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
361	{ 0x24c6, 0x551a, "PowerA FUSION Pro Controller", 0, XTYPE_XBOXONE },
362	{ 0x24c6, 0x561a, "PowerA FUSION Controller", 0, XTYPE_XBOXONE },
363	{ 0x24c6, 0x5b00, "ThrustMaster Ferrari 458 Racing Wheel", 0, XTYPE_XBOX360 },
364	{ 0x24c6, 0x5b02, "Thrustmaster, Inc. GPX Controller", 0, XTYPE_XBOX360 },
365	{ 0x24c6, 0x5b03, "Thrustmaster Ferrari 458 Racing Wheel", 0, XTYPE_XBOX360 },
366	{ 0x24c6, 0x5d04, "Razer Sabertooth", 0, XTYPE_XBOX360 },
367	{ 0x24c6, 0xfafe, "Rock Candy Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
368	{ 0x2563, 0x058d, "OneXPlayer Gamepad", 0, XTYPE_XBOX360 },
369	{ 0x294b, 0x3303, "Snakebyte GAMEPAD BASE X", 0, XTYPE_XBOXONE },
370	{ 0x294b, 0x3404, "Snakebyte GAMEPAD RGB X", 0, XTYPE_XBOXONE },
371	{ 0x2dc8, 0x2000, "8BitDo Pro 2 Wired Controller fox Xbox", 0, XTYPE_XBOXONE },
372	{ 0x2dc8, 0x3106, "8BitDo Pro 2 Wired Controller", 0, XTYPE_XBOX360 },
373	{ 0x2e24, 0x0652, "Hyperkin Duke X-Box One pad", 0, XTYPE_XBOXONE },
374	{ 0x31e3, 0x1100, "Wooting One", 0, XTYPE_XBOX360 },
375	{ 0x31e3, 0x1200, "Wooting Two", 0, XTYPE_XBOX360 },
376	{ 0x31e3, 0x1210, "Wooting Lekker", 0, XTYPE_XBOX360 },
377	{ 0x31e3, 0x1220, "Wooting Two HE", 0, XTYPE_XBOX360 },
378	{ 0x31e3, 0x1300, "Wooting 60HE (AVR)", 0, XTYPE_XBOX360 },
379	{ 0x31e3, 0x1310, "Wooting 60HE (ARM)", 0, XTYPE_XBOX360 },
380	{ 0x3285, 0x0607, "Nacon GC-100", 0, XTYPE_XBOX360 },
381	{ 0x3537, 0x1004, "GameSir T4 Kaleid", 0, XTYPE_XBOX360 },
382	{ 0x3767, 0x0101, "Fanatec Speedster 3 Forceshock Wheel", 0, XTYPE_XBOX },
383	{ 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
384	{ 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
385};
386
387/* buttons shared with xbox and xbox360 */
388static const signed short xpad_common_btn[] = {
389	BTN_A, BTN_B, BTN_X, BTN_Y,			/* "analog" buttons */
390	BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR,	/* start/back/sticks */
391	-1						/* terminating entry */
392};
393
394/* original xbox controllers only */
395static const signed short xpad_btn[] = {
396	BTN_C, BTN_Z,		/* "analog" buttons */
397	-1			/* terminating entry */
398};
399
400/* used when dpad is mapped to buttons */
401static const signed short xpad_btn_pad[] = {
402	BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2,		/* d-pad left, right */
403	BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4,		/* d-pad up, down */
404	-1				/* terminating entry */
405};
406
407/* used when triggers are mapped to buttons */
408static const signed short xpad_btn_triggers[] = {
409	BTN_TL2, BTN_TR2,		/* triggers left/right */
410	-1
411};
412
413static const signed short xpad360_btn[] = {  /* buttons for x360 controller */
414	BTN_TL, BTN_TR,		/* Button LB/RB */
415	BTN_MODE,		/* The big X button */
416	-1
417};
418
419static const signed short xpad_abs[] = {
420	ABS_X, ABS_Y,		/* left stick */
421	ABS_RX, ABS_RY,		/* right stick */
422	-1			/* terminating entry */
423};
424
425/* used when dpad is mapped to axes */
426static const signed short xpad_abs_pad[] = {
427	ABS_HAT0X, ABS_HAT0Y,	/* d-pad axes */
428	-1			/* terminating entry */
429};
430
431/* used when triggers are mapped to axes */
432static const signed short xpad_abs_triggers[] = {
433	ABS_Z, ABS_RZ,		/* triggers left/right */
434	-1
435};
436
437/* used when the controller has extra paddle buttons */
438static const signed short xpad_btn_paddles[] = {
439	BTN_TRIGGER_HAPPY5, BTN_TRIGGER_HAPPY6, /* paddle upper right, lower right */
440	BTN_TRIGGER_HAPPY7, BTN_TRIGGER_HAPPY8, /* paddle upper left, lower left */
441	-1						/* terminating entry */
442};
443
444/*
445 * Xbox 360 has a vendor-specific class, so we cannot match it with only
446 * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
447 * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
448 * wireless controllers have protocol 129.
449 */
450#define XPAD_XBOX360_VENDOR_PROTOCOL(vend, pr) \
451	.match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
452	.idVendor = (vend), \
453	.bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
454	.bInterfaceSubClass = 93, \
455	.bInterfaceProtocol = (pr)
456#define XPAD_XBOX360_VENDOR(vend) \
457	{ XPAD_XBOX360_VENDOR_PROTOCOL((vend), 1) }, \
458	{ XPAD_XBOX360_VENDOR_PROTOCOL((vend), 129) }
459
460/* The Xbox One controller uses subclass 71 and protocol 208. */
461#define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
462	.match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
463	.idVendor = (vend), \
464	.bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
465	.bInterfaceSubClass = 71, \
466	.bInterfaceProtocol = (pr)
467#define XPAD_XBOXONE_VENDOR(vend) \
468	{ XPAD_XBOXONE_VENDOR_PROTOCOL((vend), 208) }
469
470static const struct usb_device_id xpad_table[] = {
471	/*
472	 * Please keep this list sorted by vendor ID. Note that there are 2
473	 * macros - XPAD_XBOX360_VENDOR and XPAD_XBOXONE_VENDOR.
474	 */
475	{ USB_INTERFACE_INFO('X', 'B', 0) },	/* Xbox USB-IF not-approved class */
476	XPAD_XBOX360_VENDOR(0x0079),		/* GPD Win 2 controller */
477	XPAD_XBOX360_VENDOR(0x03eb),		/* Wooting Keyboards (Legacy) */
478	XPAD_XBOX360_VENDOR(0x03f0),		/* HP HyperX Xbox 360 controllers */
479	XPAD_XBOXONE_VENDOR(0x03f0),		/* HP HyperX Xbox One controllers */
480	XPAD_XBOX360_VENDOR(0x044f),		/* Thrustmaster Xbox 360 controllers */
481	XPAD_XBOX360_VENDOR(0x045e),		/* Microsoft Xbox 360 controllers */
482	XPAD_XBOXONE_VENDOR(0x045e),		/* Microsoft Xbox One controllers */
483	XPAD_XBOX360_VENDOR(0x046d),		/* Logitech Xbox 360-style controllers */
484	XPAD_XBOX360_VENDOR(0x056e),		/* Elecom JC-U3613M */
485	XPAD_XBOX360_VENDOR(0x06a3),		/* Saitek P3600 */
486	XPAD_XBOX360_VENDOR(0x0738),		/* Mad Catz Xbox 360 controllers */
487	{ USB_DEVICE(0x0738, 0x4540) },		/* Mad Catz Beat Pad */
488	XPAD_XBOXONE_VENDOR(0x0738),		/* Mad Catz FightStick TE 2 */
489	XPAD_XBOX360_VENDOR(0x07ff),		/* Mad Catz Gamepad */
490	XPAD_XBOX360_VENDOR(0x0c12),		/* Zeroplus X-Box 360 controllers */
491	XPAD_XBOX360_VENDOR(0x0e6f),		/* 0x0e6f Xbox 360 controllers */
492	XPAD_XBOXONE_VENDOR(0x0e6f),		/* 0x0e6f Xbox One controllers */
493	XPAD_XBOX360_VENDOR(0x0f0d),		/* Hori controllers */
494	XPAD_XBOXONE_VENDOR(0x0f0d),		/* Hori controllers */
495	XPAD_XBOX360_VENDOR(0x1038),		/* SteelSeries controllers */
496	XPAD_XBOXONE_VENDOR(0x10f5),		/* Turtle Beach Controllers */
497	XPAD_XBOX360_VENDOR(0x11c9),		/* Nacon GC100XF */
498	XPAD_XBOX360_VENDOR(0x11ff),		/* PXN V900 */
499	XPAD_XBOX360_VENDOR(0x1209),		/* Ardwiino Controllers */
500	XPAD_XBOX360_VENDOR(0x12ab),		/* Xbox 360 dance pads */
501	XPAD_XBOX360_VENDOR(0x1430),		/* RedOctane Xbox 360 controllers */
502	XPAD_XBOX360_VENDOR(0x146b),		/* Bigben Interactive controllers */
503	XPAD_XBOX360_VENDOR(0x1532),		/* Razer Sabertooth */
504	XPAD_XBOXONE_VENDOR(0x1532),		/* Razer Wildcat */
505	XPAD_XBOX360_VENDOR(0x15e4),		/* Numark Xbox 360 controllers */
506	XPAD_XBOX360_VENDOR(0x162e),		/* Joytech Xbox 360 controllers */
507	XPAD_XBOX360_VENDOR(0x1689),		/* Razer Onza */
508	XPAD_XBOX360_VENDOR(0x17ef),		/* Lenovo */
509	XPAD_XBOX360_VENDOR(0x1949),		/* Amazon controllers */
510	XPAD_XBOX360_VENDOR(0x1bad),		/* Harmonix Rock Band guitar and drums */
511	XPAD_XBOX360_VENDOR(0x20d6),		/* PowerA controllers */
512	XPAD_XBOXONE_VENDOR(0x20d6),		/* PowerA controllers */
513	XPAD_XBOX360_VENDOR(0x24c6),		/* PowerA controllers */
514	XPAD_XBOXONE_VENDOR(0x24c6),		/* PowerA controllers */
515	XPAD_XBOX360_VENDOR(0x2563),		/* OneXPlayer Gamepad */
516	XPAD_XBOX360_VENDOR(0x260d),		/* Dareu H101 */
517       XPAD_XBOXONE_VENDOR(0x294b),            /* Snakebyte */
518	XPAD_XBOX360_VENDOR(0x2c22),		/* Qanba Controllers */
519	XPAD_XBOX360_VENDOR(0x2dc8),            /* 8BitDo Pro 2 Wired Controller */
520	XPAD_XBOXONE_VENDOR(0x2dc8),		/* 8BitDo Pro 2 Wired Controller for Xbox */
521	XPAD_XBOXONE_VENDOR(0x2e24),		/* Hyperkin Duke Xbox One pad */
522	XPAD_XBOX360_VENDOR(0x2f24),		/* GameSir controllers */
523	XPAD_XBOX360_VENDOR(0x31e3),		/* Wooting Keyboards */
524	XPAD_XBOX360_VENDOR(0x3285),		/* Nacon GC-100 */
525	XPAD_XBOX360_VENDOR(0x3537),		/* GameSir Controllers */
526	XPAD_XBOXONE_VENDOR(0x3537),		/* GameSir Controllers */
527	{ }
528};
529
530MODULE_DEVICE_TABLE(usb, xpad_table);
531
532struct xboxone_init_packet {
533	u16 idVendor;
534	u16 idProduct;
535	const u8 *data;
536	u8 len;
537};
538
539#define XBOXONE_INIT_PKT(_vid, _pid, _data)		\
540	{						\
541		.idVendor	= (_vid),		\
542		.idProduct	= (_pid),		\
543		.data		= (_data),		\
544		.len		= ARRAY_SIZE(_data),	\
545	}
546
547/*
548 * starting with xbox one, the game input protocol is used
549 * magic numbers are taken from
550 * - https://github.com/xpadneo/gip-dissector/blob/main/src/gip-dissector.lua
551 * - https://github.com/medusalix/xone/blob/master/bus/protocol.c
552 */
553#define GIP_CMD_ACK      0x01
554#define GIP_CMD_IDENTIFY 0x04
555#define GIP_CMD_POWER    0x05
556#define GIP_CMD_AUTHENTICATE 0x06
557#define GIP_CMD_VIRTUAL_KEY  0x07
558#define GIP_CMD_RUMBLE   0x09
559#define GIP_CMD_LED      0x0a
560#define GIP_CMD_FIRMWARE 0x0c
561#define GIP_CMD_INPUT    0x20
562
563#define GIP_SEQ0 0x00
564
565#define GIP_OPT_ACK      0x10
566#define GIP_OPT_INTERNAL 0x20
567
568/*
569 * length of the command payload encoded with
570 * https://en.wikipedia.org/wiki/LEB128
571 * which is a no-op for N < 128
572 */
573#define GIP_PL_LEN(N) (N)
574
575/*
576 * payload specific defines
577 */
578#define GIP_PWR_ON 0x00
579#define GIP_LED_ON 0x01
580
581#define GIP_MOTOR_R  BIT(0)
582#define GIP_MOTOR_L  BIT(1)
583#define GIP_MOTOR_RT BIT(2)
584#define GIP_MOTOR_LT BIT(3)
585#define GIP_MOTOR_ALL (GIP_MOTOR_R | GIP_MOTOR_L | GIP_MOTOR_RT | GIP_MOTOR_LT)
586
587#define GIP_WIRED_INTF_DATA 0
588#define GIP_WIRED_INTF_AUDIO 1
589
590/*
591 * This packet is required for all Xbox One pads with 2015
592 * or later firmware installed (or present from the factory).
593 */
594static const u8 xboxone_power_on[] = {
595	GIP_CMD_POWER, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(1), GIP_PWR_ON
596};
597
598/*
599 * This packet is required for Xbox One S (0x045e:0x02ea)
600 * and Xbox One Elite Series 2 (0x045e:0x0b00) pads to
601 * initialize the controller that was previously used in
602 * Bluetooth mode.
603 */
604static const u8 xboxone_s_init[] = {
605	GIP_CMD_POWER, GIP_OPT_INTERNAL, GIP_SEQ0, 0x0f, 0x06
606};
607
608/*
609 * This packet is required to get additional input data
610 * from Xbox One Elite Series 2 (0x045e:0x0b00) pads.
611 * We mostly do this right now to get paddle data
612 */
613static const u8 extra_input_packet_init[] = {
614	0x4d, 0x10, 0x01, 0x02, 0x07, 0x00
615};
616
617/*
618 * This packet is required for the Titanfall 2 Xbox One pads
619 * (0x0e6f:0x0165) to finish initialization and for Hori pads
620 * (0x0f0d:0x0067) to make the analog sticks work.
621 */
622static const u8 xboxone_hori_ack_id[] = {
623	GIP_CMD_ACK, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(9),
624	0x00, GIP_CMD_IDENTIFY, GIP_OPT_INTERNAL, 0x3a, 0x00, 0x00, 0x00, 0x80, 0x00
625};
626
627/*
628 * This packet is required for most (all?) of the PDP pads to start
629 * sending input reports. These pads include: (0x0e6f:0x02ab),
630 * (0x0e6f:0x02a4), (0x0e6f:0x02a6).
631 */
632static const u8 xboxone_pdp_led_on[] = {
633	GIP_CMD_LED, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(3), 0x00, GIP_LED_ON, 0x14
634};
635
636/*
637 * This packet is required for most (all?) of the PDP pads to start
638 * sending input reports. These pads include: (0x0e6f:0x02ab),
639 * (0x0e6f:0x02a4), (0x0e6f:0x02a6).
640 */
641static const u8 xboxone_pdp_auth[] = {
642	GIP_CMD_AUTHENTICATE, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(2), 0x01, 0x00
643};
644
645/*
646 * A specific rumble packet is required for some PowerA pads to start
647 * sending input reports. One of those pads is (0x24c6:0x543a).
648 */
649static const u8 xboxone_rumblebegin_init[] = {
650	GIP_CMD_RUMBLE, 0x00, GIP_SEQ0, GIP_PL_LEN(9),
651	0x00, GIP_MOTOR_ALL, 0x00, 0x00, 0x1D, 0x1D, 0xFF, 0x00, 0x00
652};
653
654/*
655 * A rumble packet with zero FF intensity will immediately
656 * terminate the rumbling required to init PowerA pads.
657 * This should happen fast enough that the motors don't
658 * spin up to enough speed to actually vibrate the gamepad.
659 */
660static const u8 xboxone_rumbleend_init[] = {
661	GIP_CMD_RUMBLE, 0x00, GIP_SEQ0, GIP_PL_LEN(9),
662	0x00, GIP_MOTOR_ALL, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
663};
664
665/*
666 * This specifies the selection of init packets that a gamepad
667 * will be sent on init *and* the order in which they will be
668 * sent. The correct sequence number will be added when the
669 * packet is going to be sent.
670 */
671static const struct xboxone_init_packet xboxone_init_packets[] = {
672	XBOXONE_INIT_PKT(0x0e6f, 0x0165, xboxone_hori_ack_id),
673	XBOXONE_INIT_PKT(0x0f0d, 0x0067, xboxone_hori_ack_id),
674	XBOXONE_INIT_PKT(0x0000, 0x0000, xboxone_power_on),
675	XBOXONE_INIT_PKT(0x045e, 0x02ea, xboxone_s_init),
676	XBOXONE_INIT_PKT(0x045e, 0x0b00, xboxone_s_init),
677	XBOXONE_INIT_PKT(0x045e, 0x0b00, extra_input_packet_init),
678	XBOXONE_INIT_PKT(0x0e6f, 0x0000, xboxone_pdp_led_on),
679	XBOXONE_INIT_PKT(0x0e6f, 0x0000, xboxone_pdp_auth),
680	XBOXONE_INIT_PKT(0x24c6, 0x541a, xboxone_rumblebegin_init),
681	XBOXONE_INIT_PKT(0x24c6, 0x542a, xboxone_rumblebegin_init),
682	XBOXONE_INIT_PKT(0x24c6, 0x543a, xboxone_rumblebegin_init),
683	XBOXONE_INIT_PKT(0x24c6, 0x541a, xboxone_rumbleend_init),
684	XBOXONE_INIT_PKT(0x24c6, 0x542a, xboxone_rumbleend_init),
685	XBOXONE_INIT_PKT(0x24c6, 0x543a, xboxone_rumbleend_init),
686};
687
688struct xpad_output_packet {
689	u8 data[XPAD_PKT_LEN];
690	u8 len;
691	bool pending;
692};
693
694#define XPAD_OUT_CMD_IDX	0
695#define XPAD_OUT_FF_IDX		1
696#define XPAD_OUT_LED_IDX	(1 + IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF))
697#define XPAD_NUM_OUT_PACKETS	(1 + \
698				 IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF) + \
699				 IS_ENABLED(CONFIG_JOYSTICK_XPAD_LEDS))
700
701struct usb_xpad {
702	struct input_dev *dev;		/* input device interface */
703	struct input_dev __rcu *x360w_dev;
704	struct usb_device *udev;	/* usb device */
705	struct usb_interface *intf;	/* usb interface */
706
707	bool pad_present;
708	bool input_created;
709
710	struct urb *irq_in;		/* urb for interrupt in report */
711	unsigned char *idata;		/* input data */
712	dma_addr_t idata_dma;
713
714	struct urb *irq_out;		/* urb for interrupt out report */
715	struct usb_anchor irq_out_anchor;
716	bool irq_out_active;		/* we must not use an active URB */
717	u8 odata_serial;		/* serial number for xbox one protocol */
718	unsigned char *odata;		/* output data */
719	dma_addr_t odata_dma;
720	spinlock_t odata_lock;
721
722	struct xpad_output_packet out_packets[XPAD_NUM_OUT_PACKETS];
723	int last_out_packet;
724	int init_seq;
725
726#if defined(CONFIG_JOYSTICK_XPAD_LEDS)
727	struct xpad_led *led;
728#endif
729
730	char phys[64];			/* physical device path */
731
732	int mapping;			/* map d-pad to buttons or to axes */
733	int xtype;			/* type of xbox device */
734	int packet_type;		/* type of the extended packet */
735	int pad_nr;			/* the order x360 pads were attached */
736	const char *name;		/* name of the device */
737	struct work_struct work;	/* init/remove device from callback */
738	time64_t mode_btn_down_ts;
739};
740
741static int xpad_init_input(struct usb_xpad *xpad);
742static void xpad_deinit_input(struct usb_xpad *xpad);
743static void xpadone_ack_mode_report(struct usb_xpad *xpad, u8 seq_num);
744static void xpad360w_poweroff_controller(struct usb_xpad *xpad);
745
746/*
747 *	xpad_process_packet
748 *
749 *	Completes a request by converting the data into events for the
750 *	input subsystem.
751 *
752 *	The used report descriptor was taken from ITO Takayuki's website:
753 *	 http://euc.jp/periphs/xbox-controller.ja.html
754 */
755static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
756{
757	struct input_dev *dev = xpad->dev;
758
759	if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
760		/* left stick */
761		input_report_abs(dev, ABS_X,
762				 (__s16) le16_to_cpup((__le16 *)(data + 12)));
763		input_report_abs(dev, ABS_Y,
764				 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
765
766		/* right stick */
767		input_report_abs(dev, ABS_RX,
768				 (__s16) le16_to_cpup((__le16 *)(data + 16)));
769		input_report_abs(dev, ABS_RY,
770				 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
771	}
772
773	/* triggers left/right */
774	if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
775		input_report_key(dev, BTN_TL2, data[10]);
776		input_report_key(dev, BTN_TR2, data[11]);
777	} else {
778		input_report_abs(dev, ABS_Z, data[10]);
779		input_report_abs(dev, ABS_RZ, data[11]);
780	}
781
782	/* digital pad */
783	if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
784		/* dpad as buttons (left, right, up, down) */
785		input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & BIT(2));
786		input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & BIT(3));
787		input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & BIT(0));
788		input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & BIT(1));
789	} else {
790		input_report_abs(dev, ABS_HAT0X,
791				 !!(data[2] & 0x08) - !!(data[2] & 0x04));
792		input_report_abs(dev, ABS_HAT0Y,
793				 !!(data[2] & 0x02) - !!(data[2] & 0x01));
794	}
795
796	/* start/back buttons and stick press left/right */
797	input_report_key(dev, BTN_START,  data[2] & BIT(4));
798	input_report_key(dev, BTN_SELECT, data[2] & BIT(5));
799	input_report_key(dev, BTN_THUMBL, data[2] & BIT(6));
800	input_report_key(dev, BTN_THUMBR, data[2] & BIT(7));
801
802	/* "analog" buttons A, B, X, Y */
803	input_report_key(dev, BTN_A, data[4]);
804	input_report_key(dev, BTN_B, data[5]);
805	input_report_key(dev, BTN_X, data[6]);
806	input_report_key(dev, BTN_Y, data[7]);
807
808	/* "analog" buttons black, white */
809	input_report_key(dev, BTN_C, data[8]);
810	input_report_key(dev, BTN_Z, data[9]);
811
812
813	input_sync(dev);
814}
815
816/*
817 *	xpad360_process_packet
818 *
819 *	Completes a request by converting the data into events for the
820 *	input subsystem. It is version for xbox 360 controller
821 *
822 *	The used report descriptor was taken from:
823 *		http://www.free60.org/wiki/Gamepad
824 */
825
826static void xpad360_process_packet(struct usb_xpad *xpad, struct input_dev *dev,
827				   u16 cmd, unsigned char *data)
828{
829	/* valid pad data */
830	if (data[0] != 0x00)
831		return;
832
833	/* digital pad */
834	if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
835		/* dpad as buttons (left, right, up, down) */
836		input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & BIT(2));
837		input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & BIT(3));
838		input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & BIT(0));
839		input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & BIT(1));
840	}
841
842	/*
843	 * This should be a simple else block. However historically
844	 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
845	 * made no sense, but now we can not just switch back and have to
846	 * support both behaviors.
847	 */
848	if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
849	    xpad->xtype == XTYPE_XBOX360W) {
850		input_report_abs(dev, ABS_HAT0X,
851				 !!(data[2] & 0x08) - !!(data[2] & 0x04));
852		input_report_abs(dev, ABS_HAT0Y,
853				 !!(data[2] & 0x02) - !!(data[2] & 0x01));
854	}
855
856	/* start/back buttons */
857	input_report_key(dev, BTN_START,  data[2] & BIT(4));
858	input_report_key(dev, BTN_SELECT, data[2] & BIT(5));
859
860	/* stick press left/right */
861	input_report_key(dev, BTN_THUMBL, data[2] & BIT(6));
862	input_report_key(dev, BTN_THUMBR, data[2] & BIT(7));
863
864	/* buttons A,B,X,Y,TL,TR and MODE */
865	input_report_key(dev, BTN_A,	data[3] & BIT(4));
866	input_report_key(dev, BTN_B,	data[3] & BIT(5));
867	input_report_key(dev, BTN_X,	data[3] & BIT(6));
868	input_report_key(dev, BTN_Y,	data[3] & BIT(7));
869	input_report_key(dev, BTN_TL,	data[3] & BIT(0));
870	input_report_key(dev, BTN_TR,	data[3] & BIT(1));
871	input_report_key(dev, BTN_MODE,	data[3] & BIT(2));
872
873	if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
874		/* left stick */
875		input_report_abs(dev, ABS_X,
876				 (__s16) le16_to_cpup((__le16 *)(data + 6)));
877		input_report_abs(dev, ABS_Y,
878				 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
879
880		/* right stick */
881		input_report_abs(dev, ABS_RX,
882				 (__s16) le16_to_cpup((__le16 *)(data + 10)));
883		input_report_abs(dev, ABS_RY,
884				 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
885	}
886
887	/* triggers left/right */
888	if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
889		input_report_key(dev, BTN_TL2, data[4]);
890		input_report_key(dev, BTN_TR2, data[5]);
891	} else {
892		input_report_abs(dev, ABS_Z, data[4]);
893		input_report_abs(dev, ABS_RZ, data[5]);
894	}
895
896	input_sync(dev);
897
898	/* XBOX360W controllers can't be turned off without driver assistance */
899	if (xpad->xtype == XTYPE_XBOX360W) {
900		if (xpad->mode_btn_down_ts > 0 && xpad->pad_present &&
901		    ((ktime_get_seconds() - xpad->mode_btn_down_ts) >=
902		     XPAD360W_POWEROFF_TIMEOUT)) {
903			xpad360w_poweroff_controller(xpad);
904			xpad->mode_btn_down_ts = 0;
905			return;
906		}
907
908		/* mode button down/up */
909		if (data[3] & BIT(2))
910			xpad->mode_btn_down_ts = ktime_get_seconds();
911		else
912			xpad->mode_btn_down_ts = 0;
913	}
914}
915
916static void xpad_presence_work(struct work_struct *work)
917{
918	struct usb_xpad *xpad = container_of(work, struct usb_xpad, work);
919	int error;
920
921	if (xpad->pad_present) {
922		error = xpad_init_input(xpad);
923		if (error) {
924			/* complain only, not much else we can do here */
925			dev_err(&xpad->dev->dev,
926				"unable to init device: %d\n", error);
927		} else {
928			rcu_assign_pointer(xpad->x360w_dev, xpad->dev);
929		}
930	} else {
931		RCU_INIT_POINTER(xpad->x360w_dev, NULL);
932		synchronize_rcu();
933		/*
934		 * Now that we are sure xpad360w_process_packet is not
935		 * using input device we can get rid of it.
936		 */
937		xpad_deinit_input(xpad);
938	}
939}
940
941/*
942 * xpad360w_process_packet
943 *
944 * Completes a request by converting the data into events for the
945 * input subsystem. It is version for xbox 360 wireless controller.
946 *
947 * Byte.Bit
948 * 00.1 - Status change: The controller or headset has connected/disconnected
949 *                       Bits 01.7 and 01.6 are valid
950 * 01.7 - Controller present
951 * 01.6 - Headset present
952 * 01.1 - Pad state (Bytes 4+) valid
953 *
954 */
955static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
956{
957	struct input_dev *dev;
958	bool present;
959
960	/* Presence change */
961	if (data[0] & 0x08) {
962		present = (data[1] & 0x80) != 0;
963
964		if (xpad->pad_present != present) {
965			xpad->pad_present = present;
966			schedule_work(&xpad->work);
967		}
968	}
969
970	/* Valid pad data */
971	if (data[1] != 0x1)
972		return;
973
974	rcu_read_lock();
975	dev = rcu_dereference(xpad->x360w_dev);
976	if (dev)
977		xpad360_process_packet(xpad, dev, cmd, &data[4]);
978	rcu_read_unlock();
979}
980
981/*
982 *	xpadone_process_packet
983 *
984 *	Completes a request by converting the data into events for the
985 *	input subsystem. This version is for the Xbox One controller.
986 *
987 *	The report format was gleaned from
988 *	https://github.com/kylelemons/xbox/blob/master/xbox.go
989 */
990static void xpadone_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
991{
992	struct input_dev *dev = xpad->dev;
993	bool do_sync = false;
994
995	/* the xbox button has its own special report */
996	if (data[0] == GIP_CMD_VIRTUAL_KEY) {
997		/*
998		 * The Xbox One S controller requires these reports to be
999		 * acked otherwise it continues sending them forever and
1000		 * won't report further mode button events.
1001		 */
1002		if (data[1] == (GIP_OPT_ACK | GIP_OPT_INTERNAL))
1003			xpadone_ack_mode_report(xpad, data[2]);
1004
1005		input_report_key(dev, BTN_MODE, data[4] & GENMASK(1, 0));
1006		input_sync(dev);
1007
1008		do_sync = true;
1009	} else if (data[0] == GIP_CMD_FIRMWARE) {
1010		/* Some packet formats force us to use this separate to poll paddle inputs */
1011		if (xpad->packet_type == PKT_XBE2_FW_5_11) {
1012			/* Mute paddles if controller is in a custom profile slot
1013			 * Checked by looking at the active profile slot to
1014			 * verify it's the default slot
1015			 */
1016			if (data[19] != 0)
1017				data[18] = 0;
1018
1019			/* Elite Series 2 split packet paddle bits */
1020			input_report_key(dev, BTN_TRIGGER_HAPPY5, data[18] & BIT(0));
1021			input_report_key(dev, BTN_TRIGGER_HAPPY6, data[18] & BIT(1));
1022			input_report_key(dev, BTN_TRIGGER_HAPPY7, data[18] & BIT(2));
1023			input_report_key(dev, BTN_TRIGGER_HAPPY8, data[18] & BIT(3));
1024
1025			do_sync = true;
1026		}
1027	} else if (data[0] == GIP_CMD_INPUT) { /* The main valid packet type for inputs */
1028		/* menu/view buttons */
1029		input_report_key(dev, BTN_START,  data[4] & BIT(2));
1030		input_report_key(dev, BTN_SELECT, data[4] & BIT(3));
1031		if (xpad->mapping & MAP_SELECT_BUTTON)
1032			input_report_key(dev, KEY_RECORD, data[22] & BIT(0));
1033
1034		/* buttons A,B,X,Y */
1035		input_report_key(dev, BTN_A,	data[4] & BIT(4));
1036		input_report_key(dev, BTN_B,	data[4] & BIT(5));
1037		input_report_key(dev, BTN_X,	data[4] & BIT(6));
1038		input_report_key(dev, BTN_Y,	data[4] & BIT(7));
1039
1040		/* digital pad */
1041		if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1042			/* dpad as buttons (left, right, up, down) */
1043			input_report_key(dev, BTN_TRIGGER_HAPPY1, data[5] & BIT(2));
1044			input_report_key(dev, BTN_TRIGGER_HAPPY2, data[5] & BIT(3));
1045			input_report_key(dev, BTN_TRIGGER_HAPPY3, data[5] & BIT(0));
1046			input_report_key(dev, BTN_TRIGGER_HAPPY4, data[5] & BIT(1));
1047		} else {
1048			input_report_abs(dev, ABS_HAT0X,
1049					!!(data[5] & 0x08) - !!(data[5] & 0x04));
1050			input_report_abs(dev, ABS_HAT0Y,
1051					!!(data[5] & 0x02) - !!(data[5] & 0x01));
1052		}
1053
1054		/* TL/TR */
1055		input_report_key(dev, BTN_TL,	data[5] & BIT(4));
1056		input_report_key(dev, BTN_TR,	data[5] & BIT(5));
1057
1058		/* stick press left/right */
1059		input_report_key(dev, BTN_THUMBL, data[5] & BIT(6));
1060		input_report_key(dev, BTN_THUMBR, data[5] & BIT(7));
1061
1062		if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1063			/* left stick */
1064			input_report_abs(dev, ABS_X,
1065					(__s16) le16_to_cpup((__le16 *)(data + 10)));
1066			input_report_abs(dev, ABS_Y,
1067					~(__s16) le16_to_cpup((__le16 *)(data + 12)));
1068
1069			/* right stick */
1070			input_report_abs(dev, ABS_RX,
1071					(__s16) le16_to_cpup((__le16 *)(data + 14)));
1072			input_report_abs(dev, ABS_RY,
1073					~(__s16) le16_to_cpup((__le16 *)(data + 16)));
1074		}
1075
1076		/* triggers left/right */
1077		if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1078			input_report_key(dev, BTN_TL2,
1079					(__u16) le16_to_cpup((__le16 *)(data + 6)));
1080			input_report_key(dev, BTN_TR2,
1081					(__u16) le16_to_cpup((__le16 *)(data + 8)));
1082		} else {
1083			input_report_abs(dev, ABS_Z,
1084					(__u16) le16_to_cpup((__le16 *)(data + 6)));
1085			input_report_abs(dev, ABS_RZ,
1086					(__u16) le16_to_cpup((__le16 *)(data + 8)));
1087		}
1088
1089		/* Profile button has a value of 0-3, so it is reported as an axis */
1090		if (xpad->mapping & MAP_PROFILE_BUTTON)
1091			input_report_abs(dev, ABS_PROFILE, data[34]);
1092
1093		/* paddle handling */
1094		/* based on SDL's SDL_hidapi_xboxone.c */
1095		if (xpad->mapping & MAP_PADDLES) {
1096			if (xpad->packet_type == PKT_XBE1) {
1097				/* Mute paddles if controller has a custom mapping applied.
1098				 * Checked by comparing the current mapping
1099				 * config against the factory mapping config
1100				 */
1101				if (memcmp(&data[4], &data[18], 2) != 0)
1102					data[32] = 0;
1103
1104				/* OG Elite Series Controller paddle bits */
1105				input_report_key(dev, BTN_TRIGGER_HAPPY5, data[32] & BIT(1));
1106				input_report_key(dev, BTN_TRIGGER_HAPPY6, data[32] & BIT(3));
1107				input_report_key(dev, BTN_TRIGGER_HAPPY7, data[32] & BIT(0));
1108				input_report_key(dev, BTN_TRIGGER_HAPPY8, data[32] & BIT(2));
1109			} else if (xpad->packet_type == PKT_XBE2_FW_OLD) {
1110				/* Mute paddles if controller has a custom mapping applied.
1111				 * Checked by comparing the current mapping
1112				 * config against the factory mapping config
1113				 */
1114				if (data[19] != 0)
1115					data[18] = 0;
1116
1117				/* Elite Series 2 4.x firmware paddle bits */
1118				input_report_key(dev, BTN_TRIGGER_HAPPY5, data[18] & BIT(0));
1119				input_report_key(dev, BTN_TRIGGER_HAPPY6, data[18] & BIT(1));
1120				input_report_key(dev, BTN_TRIGGER_HAPPY7, data[18] & BIT(2));
1121				input_report_key(dev, BTN_TRIGGER_HAPPY8, data[18] & BIT(3));
1122			} else if (xpad->packet_type == PKT_XBE2_FW_5_EARLY) {
1123				/* Mute paddles if controller has a custom mapping applied.
1124				 * Checked by comparing the current mapping
1125				 * config against the factory mapping config
1126				 */
1127				if (data[23] != 0)
1128					data[22] = 0;
1129
1130				/* Elite Series 2 5.x firmware paddle bits
1131				 * (before the packet was split)
1132				 */
1133				input_report_key(dev, BTN_TRIGGER_HAPPY5, data[22] & BIT(0));
1134				input_report_key(dev, BTN_TRIGGER_HAPPY6, data[22] & BIT(1));
1135				input_report_key(dev, BTN_TRIGGER_HAPPY7, data[22] & BIT(2));
1136				input_report_key(dev, BTN_TRIGGER_HAPPY8, data[22] & BIT(3));
1137			}
1138		}
1139
1140		do_sync = true;
1141	}
1142
1143	if (do_sync)
1144		input_sync(dev);
1145}
1146
1147static void xpad_irq_in(struct urb *urb)
1148{
1149	struct usb_xpad *xpad = urb->context;
1150	struct device *dev = &xpad->intf->dev;
1151	int retval, status;
1152
1153	status = urb->status;
1154
1155	switch (status) {
1156	case 0:
1157		/* success */
1158		break;
1159	case -ECONNRESET:
1160	case -ENOENT:
1161	case -ESHUTDOWN:
1162		/* this urb is terminated, clean up */
1163		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1164			__func__, status);
1165		return;
1166	default:
1167		dev_dbg(dev, "%s - nonzero urb status received: %d\n",
1168			__func__, status);
1169		goto exit;
1170	}
1171
1172	switch (xpad->xtype) {
1173	case XTYPE_XBOX360:
1174		xpad360_process_packet(xpad, xpad->dev, 0, xpad->idata);
1175		break;
1176	case XTYPE_XBOX360W:
1177		xpad360w_process_packet(xpad, 0, xpad->idata);
1178		break;
1179	case XTYPE_XBOXONE:
1180		xpadone_process_packet(xpad, 0, xpad->idata);
1181		break;
1182	default:
1183		xpad_process_packet(xpad, 0, xpad->idata);
1184	}
1185
1186exit:
1187	retval = usb_submit_urb(urb, GFP_ATOMIC);
1188	if (retval)
1189		dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
1190			__func__, retval);
1191}
1192
1193/* Callers must hold xpad->odata_lock spinlock */
1194static bool xpad_prepare_next_init_packet(struct usb_xpad *xpad)
1195{
1196	const struct xboxone_init_packet *init_packet;
1197
1198	if (xpad->xtype != XTYPE_XBOXONE)
1199		return false;
1200
1201	/* Perform initialization sequence for Xbox One pads that require it */
1202	while (xpad->init_seq < ARRAY_SIZE(xboxone_init_packets)) {
1203		init_packet = &xboxone_init_packets[xpad->init_seq++];
1204
1205		if (init_packet->idVendor != 0 &&
1206		    init_packet->idVendor != xpad->dev->id.vendor)
1207			continue;
1208
1209		if (init_packet->idProduct != 0 &&
1210		    init_packet->idProduct != xpad->dev->id.product)
1211			continue;
1212
1213		/* This packet applies to our device, so prepare to send it */
1214		memcpy(xpad->odata, init_packet->data, init_packet->len);
1215		xpad->irq_out->transfer_buffer_length = init_packet->len;
1216
1217		/* Update packet with current sequence number */
1218		xpad->odata[2] = xpad->odata_serial++;
1219		return true;
1220	}
1221
1222	return false;
1223}
1224
1225/* Callers must hold xpad->odata_lock spinlock */
1226static bool xpad_prepare_next_out_packet(struct usb_xpad *xpad)
1227{
1228	struct xpad_output_packet *pkt, *packet = NULL;
1229	int i;
1230
1231	/* We may have init packets to send before we can send user commands */
1232	if (xpad_prepare_next_init_packet(xpad))
1233		return true;
1234
1235	for (i = 0; i < XPAD_NUM_OUT_PACKETS; i++) {
1236		if (++xpad->last_out_packet >= XPAD_NUM_OUT_PACKETS)
1237			xpad->last_out_packet = 0;
1238
1239		pkt = &xpad->out_packets[xpad->last_out_packet];
1240		if (pkt->pending) {
1241			dev_dbg(&xpad->intf->dev,
1242				"%s - found pending output packet %d\n",
1243				__func__, xpad->last_out_packet);
1244			packet = pkt;
1245			break;
1246		}
1247	}
1248
1249	if (packet) {
1250		memcpy(xpad->odata, packet->data, packet->len);
1251		xpad->irq_out->transfer_buffer_length = packet->len;
1252		packet->pending = false;
1253		return true;
1254	}
1255
1256	return false;
1257}
1258
1259/* Callers must hold xpad->odata_lock spinlock */
1260static int xpad_try_sending_next_out_packet(struct usb_xpad *xpad)
1261{
1262	int error;
1263
1264	if (!xpad->irq_out_active && xpad_prepare_next_out_packet(xpad)) {
1265		usb_anchor_urb(xpad->irq_out, &xpad->irq_out_anchor);
1266		error = usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
1267		if (error) {
1268			dev_err(&xpad->intf->dev,
1269				"%s - usb_submit_urb failed with result %d\n",
1270				__func__, error);
1271			usb_unanchor_urb(xpad->irq_out);
1272			return -EIO;
1273		}
1274
1275		xpad->irq_out_active = true;
1276	}
1277
1278	return 0;
1279}
1280
1281static void xpad_irq_out(struct urb *urb)
1282{
1283	struct usb_xpad *xpad = urb->context;
1284	struct device *dev = &xpad->intf->dev;
1285	int status = urb->status;
1286	int error;
1287	unsigned long flags;
1288
1289	spin_lock_irqsave(&xpad->odata_lock, flags);
1290
1291	switch (status) {
1292	case 0:
1293		/* success */
1294		xpad->irq_out_active = xpad_prepare_next_out_packet(xpad);
1295		break;
1296
1297	case -ECONNRESET:
1298	case -ENOENT:
1299	case -ESHUTDOWN:
1300		/* this urb is terminated, clean up */
1301		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1302			__func__, status);
1303		xpad->irq_out_active = false;
1304		break;
1305
1306	default:
1307		dev_dbg(dev, "%s - nonzero urb status received: %d\n",
1308			__func__, status);
1309		break;
1310	}
1311
1312	if (xpad->irq_out_active) {
1313		usb_anchor_urb(urb, &xpad->irq_out_anchor);
1314		error = usb_submit_urb(urb, GFP_ATOMIC);
1315		if (error) {
1316			dev_err(dev,
1317				"%s - usb_submit_urb failed with result %d\n",
1318				__func__, error);
1319			usb_unanchor_urb(urb);
1320			xpad->irq_out_active = false;
1321		}
1322	}
1323
1324	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1325}
1326
1327static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad,
1328			struct usb_endpoint_descriptor *ep_irq_out)
1329{
1330	int error;
1331
1332	if (xpad->xtype == XTYPE_UNKNOWN)
1333		return 0;
1334
1335	init_usb_anchor(&xpad->irq_out_anchor);
1336
1337	xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
1338					 GFP_KERNEL, &xpad->odata_dma);
1339	if (!xpad->odata)
1340		return -ENOMEM;
1341
1342	spin_lock_init(&xpad->odata_lock);
1343
1344	xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
1345	if (!xpad->irq_out) {
1346		error = -ENOMEM;
1347		goto err_free_coherent;
1348	}
1349
1350	usb_fill_int_urb(xpad->irq_out, xpad->udev,
1351			 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
1352			 xpad->odata, XPAD_PKT_LEN,
1353			 xpad_irq_out, xpad, ep_irq_out->bInterval);
1354	xpad->irq_out->transfer_dma = xpad->odata_dma;
1355	xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1356
1357	return 0;
1358
1359err_free_coherent:
1360	usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
1361	return error;
1362}
1363
1364static void xpad_stop_output(struct usb_xpad *xpad)
1365{
1366	if (xpad->xtype != XTYPE_UNKNOWN) {
1367		if (!usb_wait_anchor_empty_timeout(&xpad->irq_out_anchor,
1368						   5000)) {
1369			dev_warn(&xpad->intf->dev,
1370				 "timed out waiting for output URB to complete, killing\n");
1371			usb_kill_anchored_urbs(&xpad->irq_out_anchor);
1372		}
1373	}
1374}
1375
1376static void xpad_deinit_output(struct usb_xpad *xpad)
1377{
1378	if (xpad->xtype != XTYPE_UNKNOWN) {
1379		usb_free_urb(xpad->irq_out);
1380		usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1381				xpad->odata, xpad->odata_dma);
1382	}
1383}
1384
1385static int xpad_inquiry_pad_presence(struct usb_xpad *xpad)
1386{
1387	struct xpad_output_packet *packet =
1388			&xpad->out_packets[XPAD_OUT_CMD_IDX];
1389	unsigned long flags;
1390	int retval;
1391
1392	spin_lock_irqsave(&xpad->odata_lock, flags);
1393
1394	packet->data[0] = 0x08;
1395	packet->data[1] = 0x00;
1396	packet->data[2] = 0x0F;
1397	packet->data[3] = 0xC0;
1398	packet->data[4] = 0x00;
1399	packet->data[5] = 0x00;
1400	packet->data[6] = 0x00;
1401	packet->data[7] = 0x00;
1402	packet->data[8] = 0x00;
1403	packet->data[9] = 0x00;
1404	packet->data[10] = 0x00;
1405	packet->data[11] = 0x00;
1406	packet->len = 12;
1407	packet->pending = true;
1408
1409	/* Reset the sequence so we send out presence first */
1410	xpad->last_out_packet = -1;
1411	retval = xpad_try_sending_next_out_packet(xpad);
1412
1413	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1414
1415	return retval;
1416}
1417
1418static int xpad_start_xbox_one(struct usb_xpad *xpad)
1419{
1420	unsigned long flags;
1421	int retval;
1422
1423	if (usb_ifnum_to_if(xpad->udev, GIP_WIRED_INTF_AUDIO)) {
1424		/*
1425		 * Explicitly disable the audio interface. This is needed
1426		 * for some controllers, such as the PowerA Enhanced Wired
1427		 * Controller for Series X|S (0x20d6:0x200e) to report the
1428		 * guide button.
1429		 */
1430		retval = usb_set_interface(xpad->udev,
1431					   GIP_WIRED_INTF_AUDIO, 0);
1432		if (retval)
1433			dev_warn(&xpad->dev->dev,
1434				 "unable to disable audio interface: %d\n",
1435				 retval);
1436	}
1437
1438	spin_lock_irqsave(&xpad->odata_lock, flags);
1439
1440	/*
1441	 * Begin the init sequence by attempting to send a packet.
1442	 * We will cycle through the init packet sequence before
1443	 * sending any packets from the output ring.
1444	 */
1445	xpad->init_seq = 0;
1446	retval = xpad_try_sending_next_out_packet(xpad);
1447
1448	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1449
1450	return retval;
1451}
1452
1453static void xpadone_ack_mode_report(struct usb_xpad *xpad, u8 seq_num)
1454{
1455	unsigned long flags;
1456	struct xpad_output_packet *packet =
1457			&xpad->out_packets[XPAD_OUT_CMD_IDX];
1458	static const u8 mode_report_ack[] = {
1459		GIP_CMD_ACK, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(9),
1460		0x00, GIP_CMD_VIRTUAL_KEY, GIP_OPT_INTERNAL, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00
1461	};
1462
1463	spin_lock_irqsave(&xpad->odata_lock, flags);
1464
1465	packet->len = sizeof(mode_report_ack);
1466	memcpy(packet->data, mode_report_ack, packet->len);
1467	packet->data[2] = seq_num;
1468	packet->pending = true;
1469
1470	/* Reset the sequence so we send out the ack now */
1471	xpad->last_out_packet = -1;
1472	xpad_try_sending_next_out_packet(xpad);
1473
1474	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1475}
1476
1477#ifdef CONFIG_JOYSTICK_XPAD_FF
1478static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
1479{
1480	struct usb_xpad *xpad = input_get_drvdata(dev);
1481	struct xpad_output_packet *packet = &xpad->out_packets[XPAD_OUT_FF_IDX];
1482	__u16 strong;
1483	__u16 weak;
1484	int retval;
1485	unsigned long flags;
1486
1487	if (effect->type != FF_RUMBLE)
1488		return 0;
1489
1490	strong = effect->u.rumble.strong_magnitude;
1491	weak = effect->u.rumble.weak_magnitude;
1492
1493	spin_lock_irqsave(&xpad->odata_lock, flags);
1494
1495	switch (xpad->xtype) {
1496	case XTYPE_XBOX:
1497		packet->data[0] = 0x00;
1498		packet->data[1] = 0x06;
1499		packet->data[2] = 0x00;
1500		packet->data[3] = strong / 256;	/* left actuator */
1501		packet->data[4] = 0x00;
1502		packet->data[5] = weak / 256;	/* right actuator */
1503		packet->len = 6;
1504		packet->pending = true;
1505		break;
1506
1507	case XTYPE_XBOX360:
1508		packet->data[0] = 0x00;
1509		packet->data[1] = 0x08;
1510		packet->data[2] = 0x00;
1511		packet->data[3] = strong / 256;  /* left actuator? */
1512		packet->data[4] = weak / 256;	/* right actuator? */
1513		packet->data[5] = 0x00;
1514		packet->data[6] = 0x00;
1515		packet->data[7] = 0x00;
1516		packet->len = 8;
1517		packet->pending = true;
1518		break;
1519
1520	case XTYPE_XBOX360W:
1521		packet->data[0] = 0x00;
1522		packet->data[1] = 0x01;
1523		packet->data[2] = 0x0F;
1524		packet->data[3] = 0xC0;
1525		packet->data[4] = 0x00;
1526		packet->data[5] = strong / 256;
1527		packet->data[6] = weak / 256;
1528		packet->data[7] = 0x00;
1529		packet->data[8] = 0x00;
1530		packet->data[9] = 0x00;
1531		packet->data[10] = 0x00;
1532		packet->data[11] = 0x00;
1533		packet->len = 12;
1534		packet->pending = true;
1535		break;
1536
1537	case XTYPE_XBOXONE:
1538		packet->data[0] = GIP_CMD_RUMBLE; /* activate rumble */
1539		packet->data[1] = 0x00;
1540		packet->data[2] = xpad->odata_serial++;
1541		packet->data[3] = GIP_PL_LEN(9);
1542		packet->data[4] = 0x00;
1543		packet->data[5] = GIP_MOTOR_ALL;
1544		packet->data[6] = 0x00; /* left trigger */
1545		packet->data[7] = 0x00; /* right trigger */
1546		packet->data[8] = strong / 512;	/* left actuator */
1547		packet->data[9] = weak / 512;	/* right actuator */
1548		packet->data[10] = 0xFF; /* on period */
1549		packet->data[11] = 0x00; /* off period */
1550		packet->data[12] = 0xFF; /* repeat count */
1551		packet->len = 13;
1552		packet->pending = true;
1553		break;
1554
1555	default:
1556		dev_dbg(&xpad->dev->dev,
1557			"%s - rumble command sent to unsupported xpad type: %d\n",
1558			__func__, xpad->xtype);
1559		retval = -EINVAL;
1560		goto out;
1561	}
1562
1563	retval = xpad_try_sending_next_out_packet(xpad);
1564
1565out:
1566	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1567	return retval;
1568}
1569
1570static int xpad_init_ff(struct usb_xpad *xpad)
1571{
1572	if (xpad->xtype == XTYPE_UNKNOWN)
1573		return 0;
1574
1575	input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
1576
1577	return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
1578}
1579
1580#else
1581static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
1582#endif
1583
1584#if defined(CONFIG_JOYSTICK_XPAD_LEDS)
1585#include <linux/leds.h>
1586#include <linux/idr.h>
1587
1588static DEFINE_IDA(xpad_pad_seq);
1589
1590struct xpad_led {
1591	char name[16];
1592	struct led_classdev led_cdev;
1593	struct usb_xpad *xpad;
1594};
1595
1596/*
1597 * set the LEDs on Xbox 360 / Wireless Controllers
1598 * @param command
1599 *  0: off
1600 *  1: all blink, then previous setting
1601 *  2: 1/top-left blink, then on
1602 *  3: 2/top-right blink, then on
1603 *  4: 3/bottom-left blink, then on
1604 *  5: 4/bottom-right blink, then on
1605 *  6: 1/top-left on
1606 *  7: 2/top-right on
1607 *  8: 3/bottom-left on
1608 *  9: 4/bottom-right on
1609 * 10: rotate
1610 * 11: blink, based on previous setting
1611 * 12: slow blink, based on previous setting
1612 * 13: rotate with two lights
1613 * 14: persistent slow all blink
1614 * 15: blink once, then previous setting
1615 */
1616static void xpad_send_led_command(struct usb_xpad *xpad, int command)
1617{
1618	struct xpad_output_packet *packet =
1619			&xpad->out_packets[XPAD_OUT_LED_IDX];
1620	unsigned long flags;
1621
1622	command %= 16;
1623
1624	spin_lock_irqsave(&xpad->odata_lock, flags);
1625
1626	switch (xpad->xtype) {
1627	case XTYPE_XBOX360:
1628		packet->data[0] = 0x01;
1629		packet->data[1] = 0x03;
1630		packet->data[2] = command;
1631		packet->len = 3;
1632		packet->pending = true;
1633		break;
1634
1635	case XTYPE_XBOX360W:
1636		packet->data[0] = 0x00;
1637		packet->data[1] = 0x00;
1638		packet->data[2] = 0x08;
1639		packet->data[3] = 0x40 + command;
1640		packet->data[4] = 0x00;
1641		packet->data[5] = 0x00;
1642		packet->data[6] = 0x00;
1643		packet->data[7] = 0x00;
1644		packet->data[8] = 0x00;
1645		packet->data[9] = 0x00;
1646		packet->data[10] = 0x00;
1647		packet->data[11] = 0x00;
1648		packet->len = 12;
1649		packet->pending = true;
1650		break;
1651	}
1652
1653	xpad_try_sending_next_out_packet(xpad);
1654
1655	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1656}
1657
1658/*
1659 * Light up the segment corresponding to the pad number on
1660 * Xbox 360 Controllers.
1661 */
1662static void xpad_identify_controller(struct usb_xpad *xpad)
1663{
1664	led_set_brightness(&xpad->led->led_cdev, (xpad->pad_nr % 4) + 2);
1665}
1666
1667static void xpad_led_set(struct led_classdev *led_cdev,
1668			 enum led_brightness value)
1669{
1670	struct xpad_led *xpad_led = container_of(led_cdev,
1671						 struct xpad_led, led_cdev);
1672
1673	xpad_send_led_command(xpad_led->xpad, value);
1674}
1675
1676static int xpad_led_probe(struct usb_xpad *xpad)
1677{
1678	struct xpad_led *led;
1679	struct led_classdev *led_cdev;
1680	int error;
1681
1682	if (xpad->xtype != XTYPE_XBOX360 && xpad->xtype != XTYPE_XBOX360W)
1683		return 0;
1684
1685	xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
1686	if (!led)
1687		return -ENOMEM;
1688
1689	xpad->pad_nr = ida_alloc(&xpad_pad_seq, GFP_KERNEL);
1690	if (xpad->pad_nr < 0) {
1691		error = xpad->pad_nr;
1692		goto err_free_mem;
1693	}
1694
1695	snprintf(led->name, sizeof(led->name), "xpad%d", xpad->pad_nr);
1696	led->xpad = xpad;
1697
1698	led_cdev = &led->led_cdev;
1699	led_cdev->name = led->name;
1700	led_cdev->brightness_set = xpad_led_set;
1701	led_cdev->flags = LED_CORE_SUSPENDRESUME;
1702
1703	error = led_classdev_register(&xpad->udev->dev, led_cdev);
1704	if (error)
1705		goto err_free_id;
1706
1707	xpad_identify_controller(xpad);
1708
1709	return 0;
1710
1711err_free_id:
1712	ida_free(&xpad_pad_seq, xpad->pad_nr);
1713err_free_mem:
1714	kfree(led);
1715	xpad->led = NULL;
1716	return error;
1717}
1718
1719static void xpad_led_disconnect(struct usb_xpad *xpad)
1720{
1721	struct xpad_led *xpad_led = xpad->led;
1722
1723	if (xpad_led) {
1724		led_classdev_unregister(&xpad_led->led_cdev);
1725		ida_free(&xpad_pad_seq, xpad->pad_nr);
1726		kfree(xpad_led);
1727	}
1728}
1729#else
1730static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
1731static void xpad_led_disconnect(struct usb_xpad *xpad) { }
1732#endif
1733
1734static int xpad_start_input(struct usb_xpad *xpad)
1735{
1736	int error;
1737
1738	if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
1739		return -EIO;
1740
1741	if (xpad->xtype == XTYPE_XBOXONE) {
1742		error = xpad_start_xbox_one(xpad);
1743		if (error) {
1744			usb_kill_urb(xpad->irq_in);
1745			return error;
1746		}
1747	}
1748	if (xpad->xtype == XTYPE_XBOX360) {
1749		/*
1750		 * Some third-party controllers Xbox 360-style controllers
1751		 * require this message to finish initialization.
1752		 */
1753		u8 dummy[20];
1754
1755		error = usb_control_msg_recv(xpad->udev, 0,
1756					     /* bRequest */ 0x01,
1757					     /* bmRequestType */
1758					     USB_TYPE_VENDOR | USB_DIR_IN |
1759						USB_RECIP_INTERFACE,
1760					     /* wValue */ 0x100,
1761					     /* wIndex */ 0x00,
1762					     dummy, sizeof(dummy),
1763					     25, GFP_KERNEL);
1764		if (error)
1765			dev_warn(&xpad->dev->dev,
1766				 "unable to receive magic message: %d\n",
1767				 error);
1768	}
1769
1770	return 0;
1771}
1772
1773static void xpad_stop_input(struct usb_xpad *xpad)
1774{
1775	usb_kill_urb(xpad->irq_in);
1776}
1777
1778static void xpad360w_poweroff_controller(struct usb_xpad *xpad)
1779{
1780	unsigned long flags;
1781	struct xpad_output_packet *packet =
1782			&xpad->out_packets[XPAD_OUT_CMD_IDX];
1783
1784	spin_lock_irqsave(&xpad->odata_lock, flags);
1785
1786	packet->data[0] = 0x00;
1787	packet->data[1] = 0x00;
1788	packet->data[2] = 0x08;
1789	packet->data[3] = 0xC0;
1790	packet->data[4] = 0x00;
1791	packet->data[5] = 0x00;
1792	packet->data[6] = 0x00;
1793	packet->data[7] = 0x00;
1794	packet->data[8] = 0x00;
1795	packet->data[9] = 0x00;
1796	packet->data[10] = 0x00;
1797	packet->data[11] = 0x00;
1798	packet->len = 12;
1799	packet->pending = true;
1800
1801	/* Reset the sequence so we send out poweroff now */
1802	xpad->last_out_packet = -1;
1803	xpad_try_sending_next_out_packet(xpad);
1804
1805	spin_unlock_irqrestore(&xpad->odata_lock, flags);
1806}
1807
1808static int xpad360w_start_input(struct usb_xpad *xpad)
1809{
1810	int error;
1811
1812	error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1813	if (error)
1814		return -EIO;
1815
1816	/*
1817	 * Send presence packet.
1818	 * This will force the controller to resend connection packets.
1819	 * This is useful in the case we activate the module after the
1820	 * adapter has been plugged in, as it won't automatically
1821	 * send us info about the controllers.
1822	 */
1823	error = xpad_inquiry_pad_presence(xpad);
1824	if (error) {
1825		usb_kill_urb(xpad->irq_in);
1826		return error;
1827	}
1828
1829	return 0;
1830}
1831
1832static void xpad360w_stop_input(struct usb_xpad *xpad)
1833{
1834	usb_kill_urb(xpad->irq_in);
1835
1836	/* Make sure we are done with presence work if it was scheduled */
1837	flush_work(&xpad->work);
1838}
1839
1840static int xpad_open(struct input_dev *dev)
1841{
1842	struct usb_xpad *xpad = input_get_drvdata(dev);
1843
1844	return xpad_start_input(xpad);
1845}
1846
1847static void xpad_close(struct input_dev *dev)
1848{
1849	struct usb_xpad *xpad = input_get_drvdata(dev);
1850
1851	xpad_stop_input(xpad);
1852}
1853
1854static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
1855{
1856	struct usb_xpad *xpad = input_get_drvdata(input_dev);
1857
1858	switch (abs) {
1859	case ABS_X:
1860	case ABS_Y:
1861	case ABS_RX:
1862	case ABS_RY:	/* the two sticks */
1863		input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
1864		break;
1865	case ABS_Z:
1866	case ABS_RZ:	/* the triggers (if mapped to axes) */
1867		if (xpad->xtype == XTYPE_XBOXONE)
1868			input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
1869		else
1870			input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
1871		break;
1872	case ABS_HAT0X:
1873	case ABS_HAT0Y:	/* the d-pad (only if dpad is mapped to axes */
1874		input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
1875		break;
1876	case ABS_PROFILE: /* 4 value profile button (such as on XAC) */
1877		input_set_abs_params(input_dev, abs, 0, 4, 0, 0);
1878		break;
1879	default:
1880		input_set_abs_params(input_dev, abs, 0, 0, 0, 0);
1881		break;
1882	}
1883}
1884
1885static void xpad_deinit_input(struct usb_xpad *xpad)
1886{
1887	if (xpad->input_created) {
1888		xpad->input_created = false;
1889		xpad_led_disconnect(xpad);
1890		input_unregister_device(xpad->dev);
1891	}
1892}
1893
1894static int xpad_init_input(struct usb_xpad *xpad)
1895{
1896	struct input_dev *input_dev;
1897	int i, error;
1898
1899	input_dev = input_allocate_device();
1900	if (!input_dev)
1901		return -ENOMEM;
1902
1903	xpad->dev = input_dev;
1904	input_dev->name = xpad->name;
1905	input_dev->phys = xpad->phys;
1906	usb_to_input_id(xpad->udev, &input_dev->id);
1907
1908	if (xpad->xtype == XTYPE_XBOX360W) {
1909		/* x360w controllers and the receiver have different ids */
1910		input_dev->id.product = 0x02a1;
1911	}
1912
1913	input_dev->dev.parent = &xpad->intf->dev;
1914
1915	input_set_drvdata(input_dev, xpad);
1916
1917	if (xpad->xtype != XTYPE_XBOX360W) {
1918		input_dev->open = xpad_open;
1919		input_dev->close = xpad_close;
1920	}
1921
1922	if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1923		/* set up axes */
1924		for (i = 0; xpad_abs[i] >= 0; i++)
1925			xpad_set_up_abs(input_dev, xpad_abs[i]);
1926	}
1927
1928	/* set up standard buttons */
1929	for (i = 0; xpad_common_btn[i] >= 0; i++)
1930		input_set_capability(input_dev, EV_KEY, xpad_common_btn[i]);
1931
1932	/* set up model-specific ones */
1933	if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1934	    xpad->xtype == XTYPE_XBOXONE) {
1935		for (i = 0; xpad360_btn[i] >= 0; i++)
1936			input_set_capability(input_dev, EV_KEY, xpad360_btn[i]);
1937		if (xpad->mapping & MAP_SELECT_BUTTON)
1938			input_set_capability(input_dev, EV_KEY, KEY_RECORD);
1939	} else {
1940		for (i = 0; xpad_btn[i] >= 0; i++)
1941			input_set_capability(input_dev, EV_KEY, xpad_btn[i]);
1942	}
1943
1944	if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1945		for (i = 0; xpad_btn_pad[i] >= 0; i++)
1946			input_set_capability(input_dev, EV_KEY,
1947					     xpad_btn_pad[i]);
1948	}
1949
1950	/* set up paddles if the controller has them */
1951	if (xpad->mapping & MAP_PADDLES) {
1952		for (i = 0; xpad_btn_paddles[i] >= 0; i++)
1953			input_set_capability(input_dev, EV_KEY, xpad_btn_paddles[i]);
1954	}
1955
1956	/*
1957	 * This should be a simple else block. However historically
1958	 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
1959	 * made no sense, but now we can not just switch back and have to
1960	 * support both behaviors.
1961	 */
1962	if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
1963	    xpad->xtype == XTYPE_XBOX360W) {
1964		for (i = 0; xpad_abs_pad[i] >= 0; i++)
1965			xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
1966	}
1967
1968	if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1969		for (i = 0; xpad_btn_triggers[i] >= 0; i++)
1970			input_set_capability(input_dev, EV_KEY,
1971					     xpad_btn_triggers[i]);
1972	} else {
1973		for (i = 0; xpad_abs_triggers[i] >= 0; i++)
1974			xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
1975	}
1976
1977	/* setup profile button as an axis with 4 possible values */
1978	if (xpad->mapping & MAP_PROFILE_BUTTON)
1979		xpad_set_up_abs(input_dev, ABS_PROFILE);
1980
1981	error = xpad_init_ff(xpad);
1982	if (error)
1983		goto err_free_input;
1984
1985	error = xpad_led_probe(xpad);
1986	if (error)
1987		goto err_destroy_ff;
1988
1989	error = input_register_device(xpad->dev);
1990	if (error)
1991		goto err_disconnect_led;
1992
1993	xpad->input_created = true;
1994	return 0;
1995
1996err_disconnect_led:
1997	xpad_led_disconnect(xpad);
1998err_destroy_ff:
1999	input_ff_destroy(input_dev);
2000err_free_input:
2001	input_free_device(input_dev);
2002	return error;
2003}
2004
2005static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
2006{
2007	struct usb_device *udev = interface_to_usbdev(intf);
2008	struct usb_xpad *xpad;
2009	struct usb_endpoint_descriptor *ep_irq_in, *ep_irq_out;
2010	int i, error;
2011
2012	if (intf->cur_altsetting->desc.bNumEndpoints != 2)
2013		return -ENODEV;
2014
2015	for (i = 0; xpad_device[i].idVendor; i++) {
2016		if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
2017		    (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
2018			break;
2019	}
2020
2021	xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
2022	if (!xpad)
2023		return -ENOMEM;
2024
2025	usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
2026	strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
2027
2028	xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
2029					 GFP_KERNEL, &xpad->idata_dma);
2030	if (!xpad->idata) {
2031		error = -ENOMEM;
2032		goto err_free_mem;
2033	}
2034
2035	xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
2036	if (!xpad->irq_in) {
2037		error = -ENOMEM;
2038		goto err_free_idata;
2039	}
2040
2041	xpad->udev = udev;
2042	xpad->intf = intf;
2043	xpad->mapping = xpad_device[i].mapping;
2044	xpad->xtype = xpad_device[i].xtype;
2045	xpad->name = xpad_device[i].name;
2046	xpad->packet_type = PKT_XB;
2047	INIT_WORK(&xpad->work, xpad_presence_work);
2048
2049	if (xpad->xtype == XTYPE_UNKNOWN) {
2050		if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
2051			if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
2052				xpad->xtype = XTYPE_XBOX360W;
2053			else if (intf->cur_altsetting->desc.bInterfaceProtocol == 208)
2054				xpad->xtype = XTYPE_XBOXONE;
2055			else
2056				xpad->xtype = XTYPE_XBOX360;
2057		} else {
2058			xpad->xtype = XTYPE_XBOX;
2059		}
2060
2061		if (dpad_to_buttons)
2062			xpad->mapping |= MAP_DPAD_TO_BUTTONS;
2063		if (triggers_to_buttons)
2064			xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
2065		if (sticks_to_null)
2066			xpad->mapping |= MAP_STICKS_TO_NULL;
2067	}
2068
2069	if (xpad->xtype == XTYPE_XBOXONE &&
2070	    intf->cur_altsetting->desc.bInterfaceNumber != GIP_WIRED_INTF_DATA) {
2071		/*
2072		 * The Xbox One controller lists three interfaces all with the
2073		 * same interface class, subclass and protocol. Differentiate by
2074		 * interface number.
2075		 */
2076		error = -ENODEV;
2077		goto err_free_in_urb;
2078	}
2079
2080	ep_irq_in = ep_irq_out = NULL;
2081
2082	for (i = 0; i < 2; i++) {
2083		struct usb_endpoint_descriptor *ep =
2084				&intf->cur_altsetting->endpoint[i].desc;
2085
2086		if (usb_endpoint_xfer_int(ep)) {
2087			if (usb_endpoint_dir_in(ep))
2088				ep_irq_in = ep;
2089			else
2090				ep_irq_out = ep;
2091		}
2092	}
2093
2094	if (!ep_irq_in || !ep_irq_out) {
2095		error = -ENODEV;
2096		goto err_free_in_urb;
2097	}
2098
2099	error = xpad_init_output(intf, xpad, ep_irq_out);
2100	if (error)
2101		goto err_free_in_urb;
2102
2103	usb_fill_int_urb(xpad->irq_in, udev,
2104			 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
2105			 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
2106			 xpad, ep_irq_in->bInterval);
2107	xpad->irq_in->transfer_dma = xpad->idata_dma;
2108	xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2109
2110	usb_set_intfdata(intf, xpad);
2111
2112	/* Packet type detection */
2113	if (le16_to_cpu(udev->descriptor.idVendor) == 0x045e) { /* Microsoft controllers */
2114		if (le16_to_cpu(udev->descriptor.idProduct) == 0x02e3) {
2115			/* The original elite controller always uses the oldest
2116			 * type of extended packet
2117			 */
2118			xpad->packet_type = PKT_XBE1;
2119		} else if (le16_to_cpu(udev->descriptor.idProduct) == 0x0b00) {
2120			/* The elite 2 controller has seen multiple packet
2121			 * revisions. These are tied to specific firmware
2122			 * versions
2123			 */
2124			if (le16_to_cpu(udev->descriptor.bcdDevice) < 0x0500) {
2125				/* This is the format that the Elite 2 used
2126				 * prior to the BLE update
2127				 */
2128				xpad->packet_type = PKT_XBE2_FW_OLD;
2129			} else if (le16_to_cpu(udev->descriptor.bcdDevice) <
2130				   0x050b) {
2131				/* This is the format that the Elite 2 used
2132				 * prior to the update that split the packet
2133				 */
2134				xpad->packet_type = PKT_XBE2_FW_5_EARLY;
2135			} else {
2136				/* The split packet format that was introduced
2137				 * in firmware v5.11
2138				 */
2139				xpad->packet_type = PKT_XBE2_FW_5_11;
2140			}
2141		}
2142	}
2143
2144	if (xpad->xtype == XTYPE_XBOX360W) {
2145		/*
2146		 * Submit the int URB immediately rather than waiting for open
2147		 * because we get status messages from the device whether
2148		 * or not any controllers are attached.  In fact, it's
2149		 * exactly the message that a controller has arrived that
2150		 * we're waiting for.
2151		 */
2152		error = xpad360w_start_input(xpad);
2153		if (error)
2154			goto err_deinit_output;
2155		/*
2156		 * Wireless controllers require RESET_RESUME to work properly
2157		 * after suspend. Ideally this quirk should be in usb core
2158		 * quirk list, but we have too many vendors producing these
2159		 * controllers and we'd need to maintain 2 identical lists
2160		 * here in this driver and in usb core.
2161		 */
2162		udev->quirks |= USB_QUIRK_RESET_RESUME;
2163	} else {
2164		error = xpad_init_input(xpad);
2165		if (error)
2166			goto err_deinit_output;
2167	}
2168	return 0;
2169
2170err_deinit_output:
2171	xpad_deinit_output(xpad);
2172err_free_in_urb:
2173	usb_free_urb(xpad->irq_in);
2174err_free_idata:
2175	usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
2176err_free_mem:
2177	kfree(xpad);
2178	return error;
2179}
2180
2181static void xpad_disconnect(struct usb_interface *intf)
2182{
2183	struct usb_xpad *xpad = usb_get_intfdata(intf);
2184
2185	if (xpad->xtype == XTYPE_XBOX360W)
2186		xpad360w_stop_input(xpad);
2187
2188	xpad_deinit_input(xpad);
2189
2190	/*
2191	 * Now that both input device and LED device are gone we can
2192	 * stop output URB.
2193	 */
2194	xpad_stop_output(xpad);
2195
2196	xpad_deinit_output(xpad);
2197
2198	usb_free_urb(xpad->irq_in);
2199	usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
2200			xpad->idata, xpad->idata_dma);
2201
2202	kfree(xpad);
2203
2204	usb_set_intfdata(intf, NULL);
2205}
2206
2207static int xpad_suspend(struct usb_interface *intf, pm_message_t message)
2208{
2209	struct usb_xpad *xpad = usb_get_intfdata(intf);
2210	struct input_dev *input = xpad->dev;
2211
2212	if (xpad->xtype == XTYPE_XBOX360W) {
2213		/*
2214		 * Wireless controllers always listen to input so
2215		 * they are notified when controller shows up
2216		 * or goes away.
2217		 */
2218		xpad360w_stop_input(xpad);
2219
2220		/*
2221		 * The wireless adapter is going off now, so the
2222		 * gamepads are going to become disconnected.
2223		 * Unless explicitly disabled, power them down
2224		 * so they don't just sit there flashing.
2225		 */
2226		if (auto_poweroff && xpad->pad_present)
2227			xpad360w_poweroff_controller(xpad);
2228	} else {
2229		mutex_lock(&input->mutex);
2230		if (input_device_enabled(input))
2231			xpad_stop_input(xpad);
2232		mutex_unlock(&input->mutex);
2233	}
2234
2235	xpad_stop_output(xpad);
2236
2237	return 0;
2238}
2239
2240static int xpad_resume(struct usb_interface *intf)
2241{
2242	struct usb_xpad *xpad = usb_get_intfdata(intf);
2243	struct input_dev *input = xpad->dev;
2244	int retval = 0;
2245
2246	if (xpad->xtype == XTYPE_XBOX360W) {
2247		retval = xpad360w_start_input(xpad);
2248	} else {
2249		mutex_lock(&input->mutex);
2250		if (input_device_enabled(input)) {
2251			retval = xpad_start_input(xpad);
2252		} else if (xpad->xtype == XTYPE_XBOXONE) {
2253			/*
2254			 * Even if there are no users, we'll send Xbox One pads
2255			 * the startup sequence so they don't sit there and
2256			 * blink until somebody opens the input device again.
2257			 */
2258			retval = xpad_start_xbox_one(xpad);
2259		}
2260		mutex_unlock(&input->mutex);
2261	}
2262
2263	return retval;
2264}
2265
2266static struct usb_driver xpad_driver = {
2267	.name		= "xpad",
2268	.probe		= xpad_probe,
2269	.disconnect	= xpad_disconnect,
2270	.suspend	= xpad_suspend,
2271	.resume		= xpad_resume,
2272	.id_table	= xpad_table,
2273};
2274
2275module_usb_driver(xpad_driver);
2276
2277MODULE_AUTHOR("Marko Friedemann <mfr@bmx-chemnitz.de>");
2278MODULE_DESCRIPTION("Xbox pad driver");
2279MODULE_LICENSE("GPL");
2280