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