xref: /linux/drivers/input/joystick/xpad.c (revision 563b3f6ef521895045117055bf3ee08fbe27a8a7)
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 	{ 0x0502, 0x1305, "Acer NGR200", 0, XTYPE_XBOX360 },
176 	{ 0x056e, 0x2004, "Elecom JC-U3613M", 0, XTYPE_XBOX360 },
177 	{ 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
178 	{ 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
179 	{ 0x05fe, 0x3030, "Chic Controller", 0, XTYPE_XBOX },
180 	{ 0x05fe, 0x3031, "Chic Controller", 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 	{ 0x37d7, 0x2501, "Flydigi Apex 5", 0, XTYPE_XBOX360 },
426 	{ 0x413d, 0x2104, "Black Shark Green Ghost Gamepad", 0, XTYPE_XBOX360 },
427 	{ 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
428 	{ 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
429 };
430 
431 /* buttons shared with xbox and xbox360 */
432 static const signed short xpad_common_btn[] = {
433 	BTN_A, BTN_B, BTN_X, BTN_Y,			/* "analog" buttons */
434 	BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR,	/* start/back/sticks */
435 	-1						/* terminating entry */
436 };
437 
438 /* original xbox controllers only */
439 static const signed short xpad_btn[] = {
440 	BTN_C, BTN_Z,		/* "analog" buttons */
441 	-1			/* terminating entry */
442 };
443 
444 /* used when dpad is mapped to buttons */
445 static const signed short xpad_btn_pad[] = {
446 	BTN_DPAD_LEFT, BTN_DPAD_RIGHT,	/* d-pad left, right */
447 	BTN_DPAD_UP, BTN_DPAD_DOWN,	/* d-pad up, down */
448 	-1				/* terminating entry */
449 };
450 
451 /* used when triggers are mapped to buttons */
452 static const signed short xpad_btn_triggers[] = {
453 	BTN_TL2, BTN_TR2,		/* triggers left/right */
454 	-1
455 };
456 
457 static const signed short xpad360_btn[] = {  /* buttons for x360 controller */
458 	BTN_TL, BTN_TR,		/* Button LB/RB */
459 	BTN_MODE,		/* The big X button */
460 	-1
461 };
462 
463 static const signed short xpad_abs[] = {
464 	ABS_X, ABS_Y,		/* left stick */
465 	ABS_RX, ABS_RY,		/* right stick */
466 	-1			/* terminating entry */
467 };
468 
469 /* used when dpad is mapped to axes */
470 static const signed short xpad_abs_pad[] = {
471 	ABS_HAT0X, ABS_HAT0Y,	/* d-pad axes */
472 	-1			/* terminating entry */
473 };
474 
475 /* used when triggers are mapped to axes */
476 static const signed short xpad_abs_triggers[] = {
477 	ABS_Z, ABS_RZ,		/* triggers left/right */
478 	-1
479 };
480 
481 /* used when the controller has extra paddle buttons */
482 static const signed short xpad_btn_paddles[] = {
483 	BTN_GRIPR, BTN_GRIPR2, /* paddle upper right, lower right */
484 	BTN_GRIPL, BTN_GRIPL2, /* paddle upper left, lower left */
485 	-1						/* terminating entry */
486 };
487 
488 /*
489  * Xbox 360 has a vendor-specific class, so we cannot match it with only
490  * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
491  * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
492  * wireless controllers have protocol 129.
493  */
494 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend, pr) \
495 	.match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
496 	.idVendor = (vend), \
497 	.bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
498 	.bInterfaceSubClass = 93, \
499 	.bInterfaceProtocol = (pr)
500 #define XPAD_XBOX360_VENDOR(vend) \
501 	{ XPAD_XBOX360_VENDOR_PROTOCOL((vend), 1) }, \
502 	{ XPAD_XBOX360_VENDOR_PROTOCOL((vend), 129) }
503 
504 /* The Xbox One controller uses subclass 71 and protocol 208. */
505 #define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
506 	.match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
507 	.idVendor = (vend), \
508 	.bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
509 	.bInterfaceSubClass = 71, \
510 	.bInterfaceProtocol = (pr)
511 #define XPAD_XBOXONE_VENDOR(vend) \
512 	{ XPAD_XBOXONE_VENDOR_PROTOCOL((vend), 208) }
513 
514 static const struct usb_device_id xpad_table[] = {
515 	/*
516 	 * Please keep this list sorted by vendor ID. Note that there are 2
517 	 * macros - XPAD_XBOX360_VENDOR and XPAD_XBOXONE_VENDOR.
518 	 */
519 	{ USB_INTERFACE_INFO('X', 'B', 0) },	/* Xbox USB-IF not-approved class */
520 	XPAD_XBOX360_VENDOR(0x0079),		/* GPD Win 2 controller */
521 	XPAD_XBOX360_VENDOR(0x03eb),		/* Wooting Keyboards (Legacy) */
522 	XPAD_XBOX360_VENDOR(0x03f0),		/* HP HyperX Xbox 360 controllers */
523 	XPAD_XBOXONE_VENDOR(0x03f0),		/* HP HyperX Xbox One controllers */
524 	XPAD_XBOX360_VENDOR(0x044f),		/* Thrustmaster Xbox 360 controllers */
525 	XPAD_XBOXONE_VENDOR(0x044f),		/* Thrustmaster Xbox One controllers */
526 	XPAD_XBOX360_VENDOR(0x045e),		/* Microsoft Xbox 360 controllers */
527 	XPAD_XBOXONE_VENDOR(0x045e),		/* Microsoft Xbox One controllers */
528 	XPAD_XBOX360_VENDOR(0x046d),		/* Logitech Xbox 360-style controllers */
529 	XPAD_XBOX360_VENDOR(0x0502),		/* Acer Inc. Xbox 360 style controllers */
530 	XPAD_XBOX360_VENDOR(0x056e),		/* Elecom JC-U3613M */
531 	XPAD_XBOX360_VENDOR(0x06a3),		/* Saitek P3600 */
532 	XPAD_XBOX360_VENDOR(0x0738),		/* Mad Catz Xbox 360 controllers */
533 	{ USB_DEVICE(0x0738, 0x4540) },		/* Mad Catz Beat Pad */
534 	XPAD_XBOXONE_VENDOR(0x0738),		/* Mad Catz FightStick TE 2 */
535 	XPAD_XBOX360_VENDOR(0x07ff),		/* Mad Catz Gamepad */
536 	XPAD_XBOXONE_VENDOR(0x0b05),		/* ASUS controllers */
537 	XPAD_XBOX360_VENDOR(0x0c12),		/* Zeroplus X-Box 360 controllers */
538 	XPAD_XBOX360_VENDOR(0x0db0),		/* Micro Star International X-Box 360 controllers */
539 	XPAD_XBOX360_VENDOR(0x0e6f),		/* 0x0e6f Xbox 360 controllers */
540 	XPAD_XBOXONE_VENDOR(0x0e6f),		/* 0x0e6f Xbox One controllers */
541 	XPAD_XBOX360_VENDOR(0x0f0d),		/* Hori controllers */
542 	XPAD_XBOXONE_VENDOR(0x0f0d),		/* Hori controllers */
543 	XPAD_XBOX360_VENDOR(0x1038),		/* SteelSeries controllers */
544 	XPAD_XBOXONE_VENDOR(0x10f5),		/* Turtle Beach Controllers */
545 	XPAD_XBOX360_VENDOR(0x11c9),		/* Nacon GC100XF */
546 	XPAD_XBOX360_VENDOR(0x11ff),		/* PXN V900 */
547 	XPAD_XBOX360_VENDOR(0x1209),		/* Ardwiino Controllers */
548 	XPAD_XBOX360_VENDOR(0x12ab),		/* Xbox 360 dance pads */
549 	XPAD_XBOX360_VENDOR(0x1430),		/* RedOctane Xbox 360 controllers */
550 	XPAD_XBOX360_VENDOR(0x146b),		/* Bigben Interactive controllers */
551 	XPAD_XBOX360_VENDOR(0x1532),		/* Razer Sabertooth */
552 	XPAD_XBOXONE_VENDOR(0x1532),		/* Razer Wildcat */
553 	XPAD_XBOX360_VENDOR(0x15e4),		/* Numark Xbox 360 controllers */
554 	XPAD_XBOX360_VENDOR(0x162e),		/* Joytech Xbox 360 controllers */
555 	XPAD_XBOX360_VENDOR(0x1689),		/* Razer Onza */
556 	XPAD_XBOX360_VENDOR(0x17ef),		/* Lenovo */
557 	XPAD_XBOX360_VENDOR(0x1949),		/* Amazon controllers */
558 	XPAD_XBOX360_VENDOR(0x1a86),		/* Nanjing Qinheng Microelectronics (WCH) */
559 	XPAD_XBOX360_VENDOR(0x1bad),		/* Harmonix Rock Band guitar and drums */
560 	XPAD_XBOX360_VENDOR(0x1ee9),		/* ZOTAC Technology Limited */
561 	XPAD_XBOX360_VENDOR(0x20d6),		/* PowerA controllers */
562 	XPAD_XBOXONE_VENDOR(0x20d6),		/* PowerA controllers */
563 	XPAD_XBOX360_VENDOR(0x2345),		/* Machenike Controllers */
564 	XPAD_XBOX360_VENDOR(0x24c6),		/* PowerA controllers */
565 	XPAD_XBOXONE_VENDOR(0x24c6),		/* PowerA controllers */
566 	XPAD_XBOX360_VENDOR(0x2563),		/* OneXPlayer Gamepad */
567 	XPAD_XBOX360_VENDOR(0x260d),		/* Dareu H101 */
568 	XPAD_XBOXONE_VENDOR(0x294b),		/* Snakebyte */
569 	XPAD_XBOX360_VENDOR(0x2993),		/* TECNO Mobile */
570 	XPAD_XBOX360_VENDOR(0x2c22),		/* Qanba Controllers */
571 	XPAD_XBOX360_VENDOR(0x2dc8),		/* 8BitDo Controllers */
572 	XPAD_XBOXONE_VENDOR(0x2dc8),		/* 8BitDo Controllers */
573 	XPAD_XBOXONE_VENDOR(0x2e24),		/* Hyperkin Controllers */
574 	XPAD_XBOX360_VENDOR(0x2f24),		/* GameSir Controllers */
575 	XPAD_XBOXONE_VENDOR(0x2e95),		/* SCUF Gaming Controller */
576 	XPAD_XBOX360_VENDOR(0x31e3),		/* Wooting Keyboards */
577 	XPAD_XBOX360_VENDOR(0x3285),		/* Nacon GC-100 */
578 	XPAD_XBOXONE_VENDOR(0x3285),		/* Nacon Evol-X */
579 	XPAD_XBOX360_VENDOR(0x3537),		/* GameSir Controllers */
580 	XPAD_XBOXONE_VENDOR(0x3537),		/* GameSir Controllers */
581 	XPAD_XBOXONE_VENDOR(0x366c),		/* ByoWave controllers */
582 	XPAD_XBOX360_VENDOR(0x37d7),		/* Flydigi Controllers */
583 	XPAD_XBOX360_VENDOR(0x413d),		/* Black Shark Green Ghost Controller */
584 	{ }
585 };
586 
587 MODULE_DEVICE_TABLE(usb, xpad_table);
588 
589 struct xboxone_init_packet {
590 	u16 idVendor;
591 	u16 idProduct;
592 	const u8 *data;
593 	u8 len;
594 };
595 
596 #define XBOXONE_INIT_PKT(_vid, _pid, _data)		\
597 	{						\
598 		.idVendor	= (_vid),		\
599 		.idProduct	= (_pid),		\
600 		.data		= (_data),		\
601 		.len		= ARRAY_SIZE(_data),	\
602 	}
603 
604 /*
605  * starting with xbox one, the game input protocol is used
606  * magic numbers are taken from
607  * - https://github.com/xpadneo/gip-dissector/blob/main/src/gip-dissector.lua
608  * - https://github.com/medusalix/xone/blob/master/bus/protocol.c
609  */
610 #define GIP_CMD_ACK      0x01
611 #define GIP_CMD_ANNOUNCE 0x02
612 #define GIP_CMD_IDENTIFY 0x04
613 #define GIP_CMD_POWER    0x05
614 #define GIP_CMD_AUTHENTICATE 0x06
615 #define GIP_CMD_VIRTUAL_KEY  0x07
616 #define GIP_CMD_RUMBLE   0x09
617 #define GIP_CMD_LED      0x0a
618 #define GIP_CMD_FIRMWARE 0x0c
619 #define GIP_CMD_INPUT    0x20
620 
621 #define GIP_SEQ0 0x00
622 
623 #define GIP_OPT_ACK      0x10
624 #define GIP_OPT_INTERNAL 0x20
625 
626 /*
627  * length of the command payload encoded with
628  * https://en.wikipedia.org/wiki/LEB128
629  * which is a no-op for N < 128
630  */
631 #define GIP_PL_LEN(N) (N)
632 
633 /*
634  * payload specific defines
635  */
636 #define GIP_PWR_ON 0x00
637 #define GIP_LED_ON 0x01
638 
639 #define GIP_MOTOR_R  BIT(0)
640 #define GIP_MOTOR_L  BIT(1)
641 #define GIP_MOTOR_RT BIT(2)
642 #define GIP_MOTOR_LT BIT(3)
643 #define GIP_MOTOR_ALL (GIP_MOTOR_R | GIP_MOTOR_L | GIP_MOTOR_RT | GIP_MOTOR_LT)
644 
645 #define GIP_WIRED_INTF_DATA 0
646 #define GIP_WIRED_INTF_AUDIO 1
647 
648 /*
649  * This packet is required for all Xbox One pads with 2015
650  * or later firmware installed (or present from the factory).
651  */
652 static const u8 xboxone_power_on[] = {
653 	GIP_CMD_POWER, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(1), GIP_PWR_ON
654 };
655 
656 /*
657  * This packet is required for Xbox One S (0x045e:0x02ea)
658  * and Xbox One Elite Series 2 (0x045e:0x0b00) pads to
659  * initialize the controller that was previously used in
660  * Bluetooth mode.
661  */
662 static const u8 xboxone_s_init[] = {
663 	GIP_CMD_POWER, GIP_OPT_INTERNAL, GIP_SEQ0, 0x0f, 0x06
664 };
665 
666 /*
667  * This packet is required to get additional input data
668  * from Xbox One Elite Series 2 (0x045e:0x0b00) pads.
669  * We mostly do this right now to get paddle data
670  */
671 static const u8 extra_input_packet_init[] = {
672 	0x4d, 0x10, 0x01, 0x02, 0x07, 0x00
673 };
674 
675 /*
676  * This packet is required for the Titanfall 2 Xbox One pads
677  * (0x0e6f:0x0165) to finish initialization and for Hori pads
678  * (0x0f0d:0x0067) to make the analog sticks work.
679  */
680 static const u8 xboxone_hori_ack_id[] = {
681 	GIP_CMD_ACK, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(9),
682 	0x00, GIP_CMD_IDENTIFY, GIP_OPT_INTERNAL, 0x3a, 0x00, 0x00, 0x00, 0x80, 0x00
683 };
684 
685 /*
686  * This packet is sent by default on Windows, and is required for some pads to
687  * start sending input reports, including most (all?) of the PDP. These pads
688  * include: (0x0e6f:0x02ab), (0x0e6f:0x02a4), (0x0e6f:0x02a6).
689  */
690 static const u8 xboxone_led_on[] = { GIP_CMD_LED, GIP_OPT_INTERNAL, GIP_SEQ0,
691 GIP_PL_LEN(3), 0x00, GIP_LED_ON, 0x14 };
692 
693 /*
694  * This packet is required for most (all?) of the PDP pads to start
695  * sending input reports. These pads include: (0x0e6f:0x02ab),
696  * (0x0e6f:0x02a4), (0x0e6f:0x02a6).
697  */
698 static const u8 xboxone_auth_done[] = {
699 	GIP_CMD_AUTHENTICATE, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(2), 0x01, 0x00
700 };
701 
702 /*
703  * A specific rumble packet is required for some PowerA pads to start
704  * sending input reports. One of those pads is (0x24c6:0x543a).
705  */
706 static const u8 xboxone_rumblebegin_init[] = {
707 	GIP_CMD_RUMBLE, 0x00, GIP_SEQ0, GIP_PL_LEN(9),
708 	0x00, GIP_MOTOR_ALL, 0x00, 0x00, 0x1D, 0x1D, 0xFF, 0x00, 0x00
709 };
710 
711 /*
712  * A rumble packet with zero FF intensity will immediately
713  * terminate the rumbling required to init PowerA pads.
714  * This should happen fast enough that the motors don't
715  * spin up to enough speed to actually vibrate the gamepad.
716  */
717 static const u8 xboxone_rumbleend_init[] = {
718 	GIP_CMD_RUMBLE, 0x00, GIP_SEQ0, GIP_PL_LEN(9),
719 	0x00, GIP_MOTOR_ALL, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
720 };
721 
722 /*
723  * This specifies the selection of init packets that a gamepad
724  * will be sent on init *and* the order in which they will be
725  * sent. The correct sequence number will be added when the
726  * packet is going to be sent.
727  */
728 static const struct xboxone_init_packet xboxone_init_packets[] = {
729 	XBOXONE_INIT_PKT(0x0e6f, 0x0165, xboxone_hori_ack_id),
730 	XBOXONE_INIT_PKT(0x0f0d, 0x0067, xboxone_hori_ack_id),
731 	XBOXONE_INIT_PKT(0x0000, 0x0000, xboxone_power_on),
732 	XBOXONE_INIT_PKT(0x045e, 0x02ea, xboxone_s_init),
733 	XBOXONE_INIT_PKT(0x045e, 0x0b00, xboxone_s_init),
734 	XBOXONE_INIT_PKT(0x045e, 0x0b00, extra_input_packet_init),
735 	XBOXONE_INIT_PKT(0x0000, 0x0000, xboxone_led_on),
736 	XBOXONE_INIT_PKT(0x0000, 0x0000, xboxone_auth_done),
737 	XBOXONE_INIT_PKT(0x24c6, 0x541a, xboxone_rumblebegin_init),
738 	XBOXONE_INIT_PKT(0x24c6, 0x542a, xboxone_rumblebegin_init),
739 	XBOXONE_INIT_PKT(0x24c6, 0x543a, xboxone_rumblebegin_init),
740 	XBOXONE_INIT_PKT(0x24c6, 0x541a, xboxone_rumbleend_init),
741 	XBOXONE_INIT_PKT(0x24c6, 0x542a, xboxone_rumbleend_init),
742 	XBOXONE_INIT_PKT(0x24c6, 0x543a, xboxone_rumbleend_init),
743 };
744 
745 struct xpad_output_packet {
746 	u8 data[XPAD_PKT_LEN];
747 	u8 len;
748 	bool pending;
749 };
750 
751 #define XPAD_OUT_CMD_IDX	0
752 #define XPAD_OUT_FF_IDX		1
753 #define XPAD_OUT_LED_IDX	(1 + IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF))
754 #define XPAD_NUM_OUT_PACKETS	(1 + \
755 				 IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF) + \
756 				 IS_ENABLED(CONFIG_JOYSTICK_XPAD_LEDS))
757 
758 struct usb_xpad {
759 	struct input_dev *dev;		/* input device interface */
760 	struct input_dev __rcu *x360w_dev;
761 	struct usb_device *udev;	/* usb device */
762 	struct usb_interface *intf;	/* usb interface */
763 
764 	bool pad_present;
765 	bool input_created;
766 
767 	struct urb *irq_in;		/* urb for interrupt in report */
768 	unsigned char *idata;		/* input data */
769 	dma_addr_t idata_dma;
770 
771 	struct urb *irq_out;		/* urb for interrupt out report */
772 	struct usb_anchor irq_out_anchor;
773 	bool irq_out_active;		/* we must not use an active URB */
774 	u8 odata_serial;		/* serial number for xbox one protocol */
775 	unsigned char *odata;		/* output data */
776 	dma_addr_t odata_dma;
777 	spinlock_t odata_lock;
778 
779 	struct xpad_output_packet out_packets[XPAD_NUM_OUT_PACKETS];
780 	int last_out_packet;
781 	int init_seq;
782 
783 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
784 	struct xpad_led *led;
785 #endif
786 
787 	char phys[64];			/* physical device path */
788 
789 	int mapping;			/* map d-pad to buttons or to axes */
790 	int xtype;			/* type of xbox device */
791 	int packet_type;		/* type of the extended packet */
792 	int pad_nr;			/* the order x360 pads were attached */
793 	const char *name;		/* name of the device */
794 	struct work_struct work;	/* init/remove device from callback */
795 	time64_t mode_btn_down_ts;
796 	bool delay_init;		/* init packets should be delayed */
797 	bool delayed_init_done;
798 };
799 
800 static int xpad_init_input(struct usb_xpad *xpad);
801 static void xpad_deinit_input(struct usb_xpad *xpad);
802 static int xpad_start_input(struct usb_xpad *xpad);
803 static void xpadone_ack_mode_report(struct usb_xpad *xpad, u8 seq_num);
804 static void xpad360w_poweroff_controller(struct usb_xpad *xpad);
805 
806 /*
807  *	xpad_process_packet
808  *
809  *	Completes a request by converting the data into events for the
810  *	input subsystem.
811  *
812  *	The used report descriptor was taken from ITO Takayuki's website:
813  *	 http://euc.jp/periphs/xbox-controller.ja.html
814  */
xpad_process_packet(struct usb_xpad * xpad,u16 cmd,unsigned char * data)815 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
816 {
817 	struct input_dev *dev = xpad->dev;
818 
819 	if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
820 		/* left stick */
821 		input_report_abs(dev, ABS_X,
822 				 (__s16) le16_to_cpup((__le16 *)(data + 12)));
823 		input_report_abs(dev, ABS_Y,
824 				 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
825 
826 		/* right stick */
827 		input_report_abs(dev, ABS_RX,
828 				 (__s16) le16_to_cpup((__le16 *)(data + 16)));
829 		input_report_abs(dev, ABS_RY,
830 				 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
831 	}
832 
833 	/* triggers left/right */
834 	if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
835 		input_report_key(dev, BTN_TL2, data[10]);
836 		input_report_key(dev, BTN_TR2, data[11]);
837 	} else {
838 		input_report_abs(dev, ABS_Z, data[10]);
839 		input_report_abs(dev, ABS_RZ, data[11]);
840 	}
841 
842 	/* digital pad */
843 	if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
844 		/* dpad as buttons (left, right, up, down) */
845 		input_report_key(dev, BTN_DPAD_LEFT, data[2] & BIT(2));
846 		input_report_key(dev, BTN_DPAD_RIGHT, data[2] & BIT(3));
847 		input_report_key(dev, BTN_DPAD_UP, data[2] & BIT(0));
848 		input_report_key(dev, BTN_DPAD_DOWN, data[2] & BIT(1));
849 	} else {
850 		input_report_abs(dev, ABS_HAT0X,
851 				 !!(data[2] & 0x08) - !!(data[2] & 0x04));
852 		input_report_abs(dev, ABS_HAT0Y,
853 				 !!(data[2] & 0x02) - !!(data[2] & 0x01));
854 	}
855 
856 	/* start/back buttons and stick press left/right */
857 	input_report_key(dev, BTN_START,  data[2] & BIT(4));
858 	input_report_key(dev, BTN_SELECT, data[2] & BIT(5));
859 	input_report_key(dev, BTN_THUMBL, data[2] & BIT(6));
860 	input_report_key(dev, BTN_THUMBR, data[2] & BIT(7));
861 
862 	/* "analog" buttons A, B, X, Y */
863 	input_report_key(dev, BTN_A, data[4]);
864 	input_report_key(dev, BTN_B, data[5]);
865 	input_report_key(dev, BTN_X, data[6]);
866 	input_report_key(dev, BTN_Y, data[7]);
867 
868 	/* "analog" buttons black, white */
869 	input_report_key(dev, BTN_C, data[8]);
870 	input_report_key(dev, BTN_Z, data[9]);
871 
872 
873 	input_sync(dev);
874 }
875 
876 /*
877  *	xpad360_process_packet
878  *
879  *	Completes a request by converting the data into events for the
880  *	input subsystem. It is version for xbox 360 controller
881  *
882  *	The used report descriptor was taken from:
883  *		http://www.free60.org/wiki/Gamepad
884  */
885 
xpad360_process_packet(struct usb_xpad * xpad,struct input_dev * dev,u16 cmd,unsigned char * data)886 static void xpad360_process_packet(struct usb_xpad *xpad, struct input_dev *dev,
887 				   u16 cmd, unsigned char *data)
888 {
889 	/* valid pad data */
890 	if (data[0] != 0x00)
891 		return;
892 
893 	/* digital pad */
894 	if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
895 		/* dpad as buttons (left, right, up, down) */
896 		input_report_key(dev, BTN_DPAD_LEFT, data[2] & BIT(2));
897 		input_report_key(dev, BTN_DPAD_RIGHT, data[2] & BIT(3));
898 		input_report_key(dev, BTN_DPAD_UP, data[2] & BIT(0));
899 		input_report_key(dev, BTN_DPAD_DOWN, data[2] & BIT(1));
900 	}
901 
902 	/*
903 	 * This should be a simple else block. However historically
904 	 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
905 	 * made no sense, but now we can not just switch back and have to
906 	 * support both behaviors.
907 	 */
908 	if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
909 	    xpad->xtype == XTYPE_XBOX360W) {
910 		input_report_abs(dev, ABS_HAT0X,
911 				 !!(data[2] & 0x08) - !!(data[2] & 0x04));
912 		input_report_abs(dev, ABS_HAT0Y,
913 				 !!(data[2] & 0x02) - !!(data[2] & 0x01));
914 	}
915 
916 	/* start/back buttons */
917 	input_report_key(dev, BTN_START,  data[2] & BIT(4));
918 	input_report_key(dev, BTN_SELECT, data[2] & BIT(5));
919 
920 	/* stick press left/right */
921 	input_report_key(dev, BTN_THUMBL, data[2] & BIT(6));
922 	input_report_key(dev, BTN_THUMBR, data[2] & BIT(7));
923 
924 	/* buttons A,B,X,Y,TL,TR and MODE */
925 	input_report_key(dev, BTN_A,	data[3] & BIT(4));
926 	input_report_key(dev, BTN_B,	data[3] & BIT(5));
927 	input_report_key(dev, BTN_X,	data[3] & BIT(6));
928 	input_report_key(dev, BTN_Y,	data[3] & BIT(7));
929 	input_report_key(dev, BTN_TL,	data[3] & BIT(0));
930 	input_report_key(dev, BTN_TR,	data[3] & BIT(1));
931 	input_report_key(dev, BTN_MODE,	data[3] & BIT(2));
932 
933 	if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
934 		/* left stick */
935 		input_report_abs(dev, ABS_X,
936 				 (__s16) le16_to_cpup((__le16 *)(data + 6)));
937 		input_report_abs(dev, ABS_Y,
938 				 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
939 
940 		/* right stick */
941 		input_report_abs(dev, ABS_RX,
942 				 (__s16) le16_to_cpup((__le16 *)(data + 10)));
943 		input_report_abs(dev, ABS_RY,
944 				 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
945 	}
946 
947 	/* triggers left/right */
948 	if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
949 		input_report_key(dev, BTN_TL2, data[4]);
950 		input_report_key(dev, BTN_TR2, data[5]);
951 	} else {
952 		input_report_abs(dev, ABS_Z, data[4]);
953 		input_report_abs(dev, ABS_RZ, data[5]);
954 	}
955 
956 	input_sync(dev);
957 
958 	/* XBOX360W controllers can't be turned off without driver assistance */
959 	if (xpad->xtype == XTYPE_XBOX360W) {
960 		if (xpad->mode_btn_down_ts > 0 && xpad->pad_present &&
961 		    ((ktime_get_seconds() - xpad->mode_btn_down_ts) >=
962 		     XPAD360W_POWEROFF_TIMEOUT)) {
963 			xpad360w_poweroff_controller(xpad);
964 			xpad->mode_btn_down_ts = 0;
965 			return;
966 		}
967 
968 		/* mode button down/up */
969 		if (data[3] & BIT(2))
970 			xpad->mode_btn_down_ts = ktime_get_seconds();
971 		else
972 			xpad->mode_btn_down_ts = 0;
973 	}
974 }
975 
xpad_presence_work(struct work_struct * work)976 static void xpad_presence_work(struct work_struct *work)
977 {
978 	struct usb_xpad *xpad = container_of(work, struct usb_xpad, work);
979 	int error;
980 
981 	if (xpad->pad_present) {
982 		error = xpad_init_input(xpad);
983 		if (error) {
984 			/* complain only, not much else we can do here */
985 			dev_err(&xpad->dev->dev,
986 				"unable to init device: %d\n", error);
987 		} else {
988 			rcu_assign_pointer(xpad->x360w_dev, xpad->dev);
989 		}
990 	} else {
991 		RCU_INIT_POINTER(xpad->x360w_dev, NULL);
992 		synchronize_rcu();
993 		/*
994 		 * Now that we are sure xpad360w_process_packet is not
995 		 * using input device we can get rid of it.
996 		 */
997 		xpad_deinit_input(xpad);
998 	}
999 }
1000 
1001 /*
1002  * xpad360w_process_packet
1003  *
1004  * Completes a request by converting the data into events for the
1005  * input subsystem. It is version for xbox 360 wireless controller.
1006  *
1007  * Byte.Bit
1008  * 00.1 - Status change: The controller or headset has connected/disconnected
1009  *                       Bits 01.7 and 01.6 are valid
1010  * 01.7 - Controller present
1011  * 01.6 - Headset present
1012  * 01.1 - Pad state (Bytes 4+) valid
1013  *
1014  */
xpad360w_process_packet(struct usb_xpad * xpad,u16 cmd,unsigned char * data)1015 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
1016 {
1017 	struct input_dev *dev;
1018 	bool present;
1019 
1020 	/* Presence change */
1021 	if (data[0] & 0x08) {
1022 		present = (data[1] & 0x80) != 0;
1023 
1024 		if (xpad->pad_present != present) {
1025 			xpad->pad_present = present;
1026 			schedule_work(&xpad->work);
1027 		}
1028 	}
1029 
1030 	/* Valid pad data */
1031 	if (data[1] != 0x1)
1032 		return;
1033 
1034 	rcu_read_lock();
1035 	dev = rcu_dereference(xpad->x360w_dev);
1036 	if (dev)
1037 		xpad360_process_packet(xpad, dev, cmd, &data[4]);
1038 	rcu_read_unlock();
1039 }
1040 
1041 /*
1042  *	xpadone_process_packet
1043  *
1044  *	Completes a request by converting the data into events for the
1045  *	input subsystem. This version is for the Xbox One controller.
1046  *
1047  *	The report format was gleaned from
1048  *	https://github.com/kylelemons/xbox/blob/master/xbox.go
1049  */
xpadone_process_packet(struct usb_xpad * xpad,u16 cmd,unsigned char * data,u32 len)1050 static void xpadone_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data, u32 len)
1051 {
1052 	struct input_dev *dev = xpad->dev;
1053 	bool do_sync = false;
1054 
1055 	/* the xbox button has its own special report */
1056 	if (data[0] == GIP_CMD_VIRTUAL_KEY) {
1057 		/*
1058 		 * The Xbox One S controller requires these reports to be
1059 		 * acked otherwise it continues sending them forever and
1060 		 * won't report further mode button events.
1061 		 */
1062 		if (data[1] == (GIP_OPT_ACK | GIP_OPT_INTERNAL))
1063 			xpadone_ack_mode_report(xpad, data[2]);
1064 
1065 		input_report_key(dev, BTN_MODE, data[4] & GENMASK(1, 0));
1066 		input_sync(dev);
1067 
1068 		do_sync = true;
1069 	} else if (data[0] == GIP_CMD_FIRMWARE) {
1070 		/* Some packet formats force us to use this separate to poll paddle inputs */
1071 		if (xpad->packet_type == PKT_XBE2_FW_5_11) {
1072 			/* Mute paddles if controller is in a custom profile slot
1073 			 * Checked by looking at the active profile slot to
1074 			 * verify it's the default slot
1075 			 */
1076 			if (data[19] != 0)
1077 				data[18] = 0;
1078 
1079 			/* Elite Series 2 split packet paddle bits */
1080 			input_report_key(dev, BTN_GRIPR, data[18] & BIT(0));
1081 			input_report_key(dev, BTN_GRIPR2, data[18] & BIT(1));
1082 			input_report_key(dev, BTN_GRIPL, data[18] & BIT(2));
1083 			input_report_key(dev, BTN_GRIPL2, data[18] & BIT(3));
1084 
1085 			do_sync = true;
1086 		}
1087 	} else if (data[0] == GIP_CMD_ANNOUNCE) {
1088 		int error;
1089 
1090 		if (xpad->delay_init && !xpad->delayed_init_done) {
1091 			xpad->delayed_init_done = true;
1092 			error = xpad_start_input(xpad);
1093 			if (error)
1094 				dev_warn(&xpad->dev->dev,
1095 					 "unable to start delayed input: %d\n",
1096 					 error);
1097 		}
1098 	} else if (data[0] == GIP_CMD_INPUT) { /* The main valid packet type for inputs */
1099 		/* menu/view buttons */
1100 		input_report_key(dev, BTN_START,  data[4] & BIT(2));
1101 		input_report_key(dev, BTN_SELECT, data[4] & BIT(3));
1102 		if (xpad->mapping & MAP_SHARE_BUTTON) {
1103 			if (xpad->mapping & MAP_SHARE_OFFSET)
1104 				input_report_key(dev, KEY_RECORD, data[len - 26] & BIT(0));
1105 			else
1106 				input_report_key(dev, KEY_RECORD, data[len - 18] & BIT(0));
1107 		}
1108 
1109 		/* buttons A,B,X,Y */
1110 		input_report_key(dev, BTN_A,	data[4] & BIT(4));
1111 		input_report_key(dev, BTN_B,	data[4] & BIT(5));
1112 		input_report_key(dev, BTN_X,	data[4] & BIT(6));
1113 		input_report_key(dev, BTN_Y,	data[4] & BIT(7));
1114 
1115 		/* digital pad */
1116 		if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1117 			/* dpad as buttons (left, right, up, down) */
1118 			input_report_key(dev, BTN_DPAD_LEFT, data[5] & BIT(2));
1119 			input_report_key(dev, BTN_DPAD_RIGHT, data[5] & BIT(3));
1120 			input_report_key(dev, BTN_DPAD_UP, data[5] & BIT(0));
1121 			input_report_key(dev, BTN_DPAD_DOWN, data[5] & BIT(1));
1122 		} else {
1123 			input_report_abs(dev, ABS_HAT0X,
1124 					!!(data[5] & 0x08) - !!(data[5] & 0x04));
1125 			input_report_abs(dev, ABS_HAT0Y,
1126 					!!(data[5] & 0x02) - !!(data[5] & 0x01));
1127 		}
1128 
1129 		/* TL/TR */
1130 		input_report_key(dev, BTN_TL,	data[5] & BIT(4));
1131 		input_report_key(dev, BTN_TR,	data[5] & BIT(5));
1132 
1133 		/* stick press left/right */
1134 		input_report_key(dev, BTN_THUMBL, data[5] & BIT(6));
1135 		input_report_key(dev, BTN_THUMBR, data[5] & BIT(7));
1136 
1137 		if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1138 			/* left stick */
1139 			input_report_abs(dev, ABS_X,
1140 					(__s16) le16_to_cpup((__le16 *)(data + 10)));
1141 			input_report_abs(dev, ABS_Y,
1142 					~(__s16) le16_to_cpup((__le16 *)(data + 12)));
1143 
1144 			/* right stick */
1145 			input_report_abs(dev, ABS_RX,
1146 					(__s16) le16_to_cpup((__le16 *)(data + 14)));
1147 			input_report_abs(dev, ABS_RY,
1148 					~(__s16) le16_to_cpup((__le16 *)(data + 16)));
1149 		}
1150 
1151 		/* triggers left/right */
1152 		if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1153 			input_report_key(dev, BTN_TL2,
1154 					(__u16) le16_to_cpup((__le16 *)(data + 6)));
1155 			input_report_key(dev, BTN_TR2,
1156 					(__u16) le16_to_cpup((__le16 *)(data + 8)));
1157 		} else {
1158 			input_report_abs(dev, ABS_Z,
1159 					(__u16) le16_to_cpup((__le16 *)(data + 6)));
1160 			input_report_abs(dev, ABS_RZ,
1161 					(__u16) le16_to_cpup((__le16 *)(data + 8)));
1162 		}
1163 
1164 		/* Profile button has a value of 0-3, so it is reported as an axis */
1165 		if (xpad->mapping & MAP_PROFILE_BUTTON)
1166 			input_report_abs(dev, ABS_PROFILE, data[34]);
1167 
1168 		/* paddle handling */
1169 		/* based on SDL's SDL_hidapi_xboxone.c */
1170 		if (xpad->mapping & MAP_PADDLES) {
1171 			if (xpad->packet_type == PKT_XBE1) {
1172 				/* Mute paddles if controller has a custom mapping applied.
1173 				 * Checked by comparing the current mapping
1174 				 * config against the factory mapping config
1175 				 */
1176 				if (memcmp(&data[4], &data[18], 2) != 0)
1177 					data[32] = 0;
1178 
1179 				/* OG Elite Series Controller paddle bits */
1180 				input_report_key(dev, BTN_GRIPR, data[32] & BIT(1));
1181 				input_report_key(dev, BTN_GRIPR2, data[32] & BIT(3));
1182 				input_report_key(dev, BTN_GRIPL, data[32] & BIT(0));
1183 				input_report_key(dev, BTN_GRIPL2, data[32] & BIT(2));
1184 			} else if (xpad->packet_type == PKT_XBE2_FW_OLD) {
1185 				/* Mute paddles if controller has a custom mapping applied.
1186 				 * Checked by comparing the current mapping
1187 				 * config against the factory mapping config
1188 				 */
1189 				if (data[19] != 0)
1190 					data[18] = 0;
1191 
1192 				/* Elite Series 2 4.x firmware paddle bits */
1193 				input_report_key(dev, BTN_GRIPR, data[18] & BIT(0));
1194 				input_report_key(dev, BTN_GRIPR2, data[18] & BIT(1));
1195 				input_report_key(dev, BTN_GRIPL, data[18] & BIT(2));
1196 				input_report_key(dev, BTN_GRIPL2, data[18] & BIT(3));
1197 			} else if (xpad->packet_type == PKT_XBE2_FW_5_EARLY) {
1198 				/* Mute paddles if controller has a custom mapping applied.
1199 				 * Checked by comparing the current mapping
1200 				 * config against the factory mapping config
1201 				 */
1202 				if (data[23] != 0)
1203 					data[22] = 0;
1204 
1205 				/* Elite Series 2 5.x firmware paddle bits
1206 				 * (before the packet was split)
1207 				 */
1208 				input_report_key(dev, BTN_GRIPR, data[22] & BIT(0));
1209 				input_report_key(dev, BTN_GRIPR2, data[22] & BIT(1));
1210 				input_report_key(dev, BTN_GRIPL, data[22] & BIT(2));
1211 				input_report_key(dev, BTN_GRIPL2, data[22] & BIT(3));
1212 			}
1213 		}
1214 
1215 		do_sync = true;
1216 	}
1217 
1218 	if (do_sync)
1219 		input_sync(dev);
1220 }
1221 
xpad_irq_in(struct urb * urb)1222 static void xpad_irq_in(struct urb *urb)
1223 {
1224 	struct usb_xpad *xpad = urb->context;
1225 	struct device *dev = &xpad->intf->dev;
1226 	int retval, status;
1227 
1228 	status = urb->status;
1229 
1230 	switch (status) {
1231 	case 0:
1232 		/* success */
1233 		break;
1234 	case -ECONNRESET:
1235 	case -ENOENT:
1236 	case -ESHUTDOWN:
1237 		/* this urb is terminated, clean up */
1238 		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1239 			__func__, status);
1240 		return;
1241 	default:
1242 		dev_dbg(dev, "%s - nonzero urb status received: %d\n",
1243 			__func__, status);
1244 		goto exit;
1245 	}
1246 
1247 	switch (xpad->xtype) {
1248 	case XTYPE_XBOX360:
1249 		xpad360_process_packet(xpad, xpad->dev, 0, xpad->idata);
1250 		break;
1251 	case XTYPE_XBOX360W:
1252 		xpad360w_process_packet(xpad, 0, xpad->idata);
1253 		break;
1254 	case XTYPE_XBOXONE:
1255 		xpadone_process_packet(xpad, 0, xpad->idata, urb->actual_length);
1256 		break;
1257 	default:
1258 		xpad_process_packet(xpad, 0, xpad->idata);
1259 	}
1260 
1261 exit:
1262 	retval = usb_submit_urb(urb, GFP_ATOMIC);
1263 	if (retval)
1264 		dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
1265 			__func__, retval);
1266 }
1267 
1268 /* Callers must hold xpad->odata_lock spinlock */
xpad_prepare_next_init_packet(struct usb_xpad * xpad)1269 static bool xpad_prepare_next_init_packet(struct usb_xpad *xpad)
1270 {
1271 	const struct xboxone_init_packet *init_packet;
1272 
1273 	if (xpad->xtype != XTYPE_XBOXONE)
1274 		return false;
1275 
1276 	/*
1277 	 * Some dongles will discard init packets if they're sent before the
1278 	 * controller connects. In these cases, we need to wait until we get
1279 	 * an announce packet from them to send the init packet sequence.
1280 	 */
1281 	if (xpad->delay_init && !xpad->delayed_init_done)
1282 		return false;
1283 
1284 	/* Perform initialization sequence for Xbox One pads that require it */
1285 	while (xpad->init_seq < ARRAY_SIZE(xboxone_init_packets)) {
1286 		init_packet = &xboxone_init_packets[xpad->init_seq++];
1287 
1288 		if (init_packet->idVendor != 0 &&
1289 		    init_packet->idVendor != xpad->dev->id.vendor)
1290 			continue;
1291 
1292 		if (init_packet->idProduct != 0 &&
1293 		    init_packet->idProduct != xpad->dev->id.product)
1294 			continue;
1295 
1296 		/* This packet applies to our device, so prepare to send it */
1297 		memcpy(xpad->odata, init_packet->data, init_packet->len);
1298 		xpad->irq_out->transfer_buffer_length = init_packet->len;
1299 
1300 		/* Update packet with current sequence number */
1301 		xpad->odata[2] = xpad->odata_serial++;
1302 		return true;
1303 	}
1304 
1305 	return false;
1306 }
1307 
1308 /* Callers must hold xpad->odata_lock spinlock */
xpad_prepare_next_out_packet(struct usb_xpad * xpad)1309 static bool xpad_prepare_next_out_packet(struct usb_xpad *xpad)
1310 {
1311 	struct xpad_output_packet *pkt, *packet = NULL;
1312 	int i;
1313 
1314 	/* We may have init packets to send before we can send user commands */
1315 	if (xpad_prepare_next_init_packet(xpad))
1316 		return true;
1317 
1318 	for (i = 0; i < XPAD_NUM_OUT_PACKETS; i++) {
1319 		if (++xpad->last_out_packet >= XPAD_NUM_OUT_PACKETS)
1320 			xpad->last_out_packet = 0;
1321 
1322 		pkt = &xpad->out_packets[xpad->last_out_packet];
1323 		if (pkt->pending) {
1324 			dev_dbg(&xpad->intf->dev,
1325 				"%s - found pending output packet %d\n",
1326 				__func__, xpad->last_out_packet);
1327 			packet = pkt;
1328 			break;
1329 		}
1330 	}
1331 
1332 	if (packet) {
1333 		memcpy(xpad->odata, packet->data, packet->len);
1334 		xpad->irq_out->transfer_buffer_length = packet->len;
1335 		packet->pending = false;
1336 		return true;
1337 	}
1338 
1339 	return false;
1340 }
1341 
1342 /* Callers must hold xpad->odata_lock spinlock */
xpad_try_sending_next_out_packet(struct usb_xpad * xpad)1343 static int xpad_try_sending_next_out_packet(struct usb_xpad *xpad)
1344 {
1345 	int error;
1346 
1347 	if (!xpad->irq_out_active && xpad_prepare_next_out_packet(xpad)) {
1348 		usb_anchor_urb(xpad->irq_out, &xpad->irq_out_anchor);
1349 		error = usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
1350 		if (error) {
1351 			if (error != -ENODEV)
1352 				dev_err(&xpad->intf->dev,
1353 					"%s - usb_submit_urb failed with result %d\n",
1354 					__func__, error);
1355 			usb_unanchor_urb(xpad->irq_out);
1356 			return error;
1357 		}
1358 
1359 		xpad->irq_out_active = true;
1360 	}
1361 
1362 	return 0;
1363 }
1364 
xpad_irq_out(struct urb * urb)1365 static void xpad_irq_out(struct urb *urb)
1366 {
1367 	struct usb_xpad *xpad = urb->context;
1368 	struct device *dev = &xpad->intf->dev;
1369 	int status = urb->status;
1370 	int error;
1371 
1372 	guard(spinlock_irqsave)(&xpad->odata_lock);
1373 
1374 	switch (status) {
1375 	case 0:
1376 		/* success */
1377 		xpad->irq_out_active = xpad_prepare_next_out_packet(xpad);
1378 		break;
1379 
1380 	case -ECONNRESET:
1381 	case -ENOENT:
1382 	case -ESHUTDOWN:
1383 		/* this urb is terminated, clean up */
1384 		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1385 			__func__, status);
1386 		xpad->irq_out_active = false;
1387 		break;
1388 
1389 	default:
1390 		dev_dbg(dev, "%s - nonzero urb status received: %d\n",
1391 			__func__, status);
1392 		break;
1393 	}
1394 
1395 	if (xpad->irq_out_active) {
1396 		usb_anchor_urb(urb, &xpad->irq_out_anchor);
1397 		error = usb_submit_urb(urb, GFP_ATOMIC);
1398 		if (error) {
1399 			dev_err(dev,
1400 				"%s - usb_submit_urb failed with result %d\n",
1401 				__func__, error);
1402 			usb_unanchor_urb(urb);
1403 			xpad->irq_out_active = false;
1404 		}
1405 	}
1406 }
1407 
xpad_init_output(struct usb_interface * intf,struct usb_xpad * xpad,struct usb_endpoint_descriptor * ep_irq_out)1408 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad,
1409 			struct usb_endpoint_descriptor *ep_irq_out)
1410 {
1411 	int error;
1412 
1413 	if (xpad->xtype == XTYPE_UNKNOWN)
1414 		return 0;
1415 
1416 	init_usb_anchor(&xpad->irq_out_anchor);
1417 
1418 	xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
1419 					 GFP_KERNEL, &xpad->odata_dma);
1420 	if (!xpad->odata)
1421 		return -ENOMEM;
1422 
1423 	spin_lock_init(&xpad->odata_lock);
1424 
1425 	xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
1426 	if (!xpad->irq_out) {
1427 		error = -ENOMEM;
1428 		goto err_free_coherent;
1429 	}
1430 
1431 	usb_fill_int_urb(xpad->irq_out, xpad->udev,
1432 			 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
1433 			 xpad->odata, XPAD_PKT_LEN,
1434 			 xpad_irq_out, xpad, ep_irq_out->bInterval);
1435 	xpad->irq_out->transfer_dma = xpad->odata_dma;
1436 	xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1437 
1438 	return 0;
1439 
1440 err_free_coherent:
1441 	usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
1442 	return error;
1443 }
1444 
xpad_stop_output(struct usb_xpad * xpad)1445 static void xpad_stop_output(struct usb_xpad *xpad)
1446 {
1447 	if (xpad->xtype != XTYPE_UNKNOWN) {
1448 		if (!usb_wait_anchor_empty_timeout(&xpad->irq_out_anchor,
1449 						   5000)) {
1450 			dev_warn(&xpad->intf->dev,
1451 				 "timed out waiting for output URB to complete, killing\n");
1452 			usb_kill_anchored_urbs(&xpad->irq_out_anchor);
1453 		}
1454 	}
1455 }
1456 
xpad_deinit_output(struct usb_xpad * xpad)1457 static void xpad_deinit_output(struct usb_xpad *xpad)
1458 {
1459 	if (xpad->xtype != XTYPE_UNKNOWN) {
1460 		usb_free_urb(xpad->irq_out);
1461 		usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1462 				xpad->odata, xpad->odata_dma);
1463 	}
1464 }
1465 
xpad_inquiry_pad_presence(struct usb_xpad * xpad)1466 static int xpad_inquiry_pad_presence(struct usb_xpad *xpad)
1467 {
1468 	struct xpad_output_packet *packet =
1469 			&xpad->out_packets[XPAD_OUT_CMD_IDX];
1470 
1471 	guard(spinlock_irqsave)(&xpad->odata_lock);
1472 
1473 	packet->data[0] = 0x08;
1474 	packet->data[1] = 0x00;
1475 	packet->data[2] = 0x0F;
1476 	packet->data[3] = 0xC0;
1477 	packet->data[4] = 0x00;
1478 	packet->data[5] = 0x00;
1479 	packet->data[6] = 0x00;
1480 	packet->data[7] = 0x00;
1481 	packet->data[8] = 0x00;
1482 	packet->data[9] = 0x00;
1483 	packet->data[10] = 0x00;
1484 	packet->data[11] = 0x00;
1485 	packet->len = 12;
1486 	packet->pending = true;
1487 
1488 	/* Reset the sequence so we send out presence first */
1489 	xpad->last_out_packet = -1;
1490 	return xpad_try_sending_next_out_packet(xpad);
1491 }
1492 
xpad_start_xbox_one(struct usb_xpad * xpad)1493 static int xpad_start_xbox_one(struct usb_xpad *xpad)
1494 {
1495 	int error;
1496 
1497 	if (usb_ifnum_to_if(xpad->udev, GIP_WIRED_INTF_AUDIO)) {
1498 		/*
1499 		 * Explicitly disable the audio interface. This is needed
1500 		 * for some controllers, such as the PowerA Enhanced Wired
1501 		 * Controller for Series X|S (0x20d6:0x200e) to report the
1502 		 * guide button.
1503 		 */
1504 		error = usb_set_interface(xpad->udev,
1505 					  GIP_WIRED_INTF_AUDIO, 0);
1506 		if (error)
1507 			dev_warn(&xpad->dev->dev,
1508 				 "unable to disable audio interface: %d\n",
1509 				 error);
1510 	}
1511 
1512 	guard(spinlock_irqsave)(&xpad->odata_lock);
1513 
1514 	/*
1515 	 * Begin the init sequence by attempting to send a packet.
1516 	 * We will cycle through the init packet sequence before
1517 	 * sending any packets from the output ring.
1518 	 */
1519 	xpad->init_seq = 0;
1520 	return xpad_try_sending_next_out_packet(xpad);
1521 }
1522 
xpadone_ack_mode_report(struct usb_xpad * xpad,u8 seq_num)1523 static void xpadone_ack_mode_report(struct usb_xpad *xpad, u8 seq_num)
1524 {
1525 	struct xpad_output_packet *packet =
1526 			&xpad->out_packets[XPAD_OUT_CMD_IDX];
1527 	static const u8 mode_report_ack[] = {
1528 		GIP_CMD_ACK, GIP_OPT_INTERNAL, GIP_SEQ0, GIP_PL_LEN(9),
1529 		0x00, GIP_CMD_VIRTUAL_KEY, GIP_OPT_INTERNAL, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00
1530 	};
1531 
1532 	guard(spinlock_irqsave)(&xpad->odata_lock);
1533 
1534 	packet->len = sizeof(mode_report_ack);
1535 	memcpy(packet->data, mode_report_ack, packet->len);
1536 	packet->data[2] = seq_num;
1537 	packet->pending = true;
1538 
1539 	/* Reset the sequence so we send out the ack now */
1540 	xpad->last_out_packet = -1;
1541 	xpad_try_sending_next_out_packet(xpad);
1542 }
1543 
1544 #ifdef CONFIG_JOYSTICK_XPAD_FF
xpad_play_effect(struct input_dev * dev,void * data,struct ff_effect * effect)1545 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
1546 {
1547 	struct usb_xpad *xpad = input_get_drvdata(dev);
1548 	struct xpad_output_packet *packet = &xpad->out_packets[XPAD_OUT_FF_IDX];
1549 	__u16 strong;
1550 	__u16 weak;
1551 
1552 	if (effect->type != FF_RUMBLE)
1553 		return 0;
1554 
1555 	strong = effect->u.rumble.strong_magnitude;
1556 	weak = effect->u.rumble.weak_magnitude;
1557 
1558 	guard(spinlock_irqsave)(&xpad->odata_lock);
1559 
1560 	switch (xpad->xtype) {
1561 	case XTYPE_XBOX:
1562 		packet->data[0] = 0x00;
1563 		packet->data[1] = 0x06;
1564 		packet->data[2] = 0x00;
1565 		packet->data[3] = strong / 256;	/* left actuator */
1566 		packet->data[4] = 0x00;
1567 		packet->data[5] = weak / 256;	/* right actuator */
1568 		packet->len = 6;
1569 		packet->pending = true;
1570 		break;
1571 
1572 	case XTYPE_XBOX360:
1573 		packet->data[0] = 0x00;
1574 		packet->data[1] = 0x08;
1575 		packet->data[2] = 0x00;
1576 		packet->data[3] = strong / 256;  /* left actuator? */
1577 		packet->data[4] = weak / 256;	/* right actuator? */
1578 		packet->data[5] = 0x00;
1579 		packet->data[6] = 0x00;
1580 		packet->data[7] = 0x00;
1581 		packet->len = 8;
1582 		packet->pending = true;
1583 		break;
1584 
1585 	case XTYPE_XBOX360W:
1586 		packet->data[0] = 0x00;
1587 		packet->data[1] = 0x01;
1588 		packet->data[2] = 0x0F;
1589 		packet->data[3] = 0xC0;
1590 		packet->data[4] = 0x00;
1591 		packet->data[5] = strong / 256;
1592 		packet->data[6] = weak / 256;
1593 		packet->data[7] = 0x00;
1594 		packet->data[8] = 0x00;
1595 		packet->data[9] = 0x00;
1596 		packet->data[10] = 0x00;
1597 		packet->data[11] = 0x00;
1598 		packet->len = 12;
1599 		packet->pending = true;
1600 		break;
1601 
1602 	case XTYPE_XBOXONE:
1603 		packet->data[0] = GIP_CMD_RUMBLE; /* activate rumble */
1604 		packet->data[1] = 0x00;
1605 		packet->data[2] = xpad->odata_serial++;
1606 		packet->data[3] = GIP_PL_LEN(9);
1607 		packet->data[4] = 0x00;
1608 		packet->data[5] = GIP_MOTOR_ALL;
1609 		packet->data[6] = 0x00; /* left trigger */
1610 		packet->data[7] = 0x00; /* right trigger */
1611 		packet->data[8] = strong / 512;	/* left actuator */
1612 		packet->data[9] = weak / 512;	/* right actuator */
1613 		packet->data[10] = 0xFF; /* on period */
1614 		packet->data[11] = 0x00; /* off period */
1615 		packet->data[12] = 0xFF; /* repeat count */
1616 		packet->len = 13;
1617 		packet->pending = true;
1618 		break;
1619 
1620 	default:
1621 		dev_dbg(&xpad->dev->dev,
1622 			"%s - rumble command sent to unsupported xpad type: %d\n",
1623 			__func__, xpad->xtype);
1624 		return -EINVAL;
1625 	}
1626 
1627 	return xpad_try_sending_next_out_packet(xpad);
1628 }
1629 
xpad_init_ff(struct usb_xpad * xpad)1630 static int xpad_init_ff(struct usb_xpad *xpad)
1631 {
1632 	if (xpad->xtype == XTYPE_UNKNOWN)
1633 		return 0;
1634 
1635 	input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
1636 
1637 	return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
1638 }
1639 
1640 #else
xpad_init_ff(struct usb_xpad * xpad)1641 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
1642 #endif
1643 
1644 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
1645 #include <linux/leds.h>
1646 #include <linux/idr.h>
1647 
1648 static DEFINE_IDA(xpad_pad_seq);
1649 
1650 struct xpad_led {
1651 	char name[16];
1652 	struct led_classdev led_cdev;
1653 	struct usb_xpad *xpad;
1654 };
1655 
1656 /*
1657  * set the LEDs on Xbox 360 / Wireless Controllers
1658  * @param command
1659  *  0: off
1660  *  1: all blink, then previous setting
1661  *  2: 1/top-left blink, then on
1662  *  3: 2/top-right blink, then on
1663  *  4: 3/bottom-left blink, then on
1664  *  5: 4/bottom-right blink, then on
1665  *  6: 1/top-left on
1666  *  7: 2/top-right on
1667  *  8: 3/bottom-left on
1668  *  9: 4/bottom-right on
1669  * 10: rotate
1670  * 11: blink, based on previous setting
1671  * 12: slow blink, based on previous setting
1672  * 13: rotate with two lights
1673  * 14: persistent slow all blink
1674  * 15: blink once, then previous setting
1675  */
xpad_send_led_command(struct usb_xpad * xpad,int command)1676 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
1677 {
1678 	struct xpad_output_packet *packet =
1679 			&xpad->out_packets[XPAD_OUT_LED_IDX];
1680 
1681 	command %= 16;
1682 
1683 	guard(spinlock_irqsave)(&xpad->odata_lock);
1684 
1685 	switch (xpad->xtype) {
1686 	case XTYPE_XBOX360:
1687 		packet->data[0] = 0x01;
1688 		packet->data[1] = 0x03;
1689 		packet->data[2] = command;
1690 		packet->len = 3;
1691 		packet->pending = true;
1692 		break;
1693 
1694 	case XTYPE_XBOX360W:
1695 		packet->data[0] = 0x00;
1696 		packet->data[1] = 0x00;
1697 		packet->data[2] = 0x08;
1698 		packet->data[3] = 0x40 + command;
1699 		packet->data[4] = 0x00;
1700 		packet->data[5] = 0x00;
1701 		packet->data[6] = 0x00;
1702 		packet->data[7] = 0x00;
1703 		packet->data[8] = 0x00;
1704 		packet->data[9] = 0x00;
1705 		packet->data[10] = 0x00;
1706 		packet->data[11] = 0x00;
1707 		packet->len = 12;
1708 		packet->pending = true;
1709 		break;
1710 	}
1711 
1712 	xpad_try_sending_next_out_packet(xpad);
1713 }
1714 
1715 /*
1716  * Light up the segment corresponding to the pad number on
1717  * Xbox 360 Controllers.
1718  */
xpad_identify_controller(struct usb_xpad * xpad)1719 static void xpad_identify_controller(struct usb_xpad *xpad)
1720 {
1721 	led_set_brightness(&xpad->led->led_cdev, (xpad->pad_nr % 4) + 2);
1722 }
1723 
xpad_led_set(struct led_classdev * led_cdev,enum led_brightness value)1724 static void xpad_led_set(struct led_classdev *led_cdev,
1725 			 enum led_brightness value)
1726 {
1727 	struct xpad_led *xpad_led = container_of(led_cdev,
1728 						 struct xpad_led, led_cdev);
1729 
1730 	xpad_send_led_command(xpad_led->xpad, value);
1731 }
1732 
xpad_led_probe(struct usb_xpad * xpad)1733 static int xpad_led_probe(struct usb_xpad *xpad)
1734 {
1735 	struct xpad_led *led;
1736 	struct led_classdev *led_cdev;
1737 	int error;
1738 
1739 	if (xpad->xtype != XTYPE_XBOX360 && xpad->xtype != XTYPE_XBOX360W)
1740 		return 0;
1741 
1742 	xpad->led = led = kzalloc(sizeof(*led), GFP_KERNEL);
1743 	if (!led)
1744 		return -ENOMEM;
1745 
1746 	xpad->pad_nr = ida_alloc(&xpad_pad_seq, GFP_KERNEL);
1747 	if (xpad->pad_nr < 0) {
1748 		error = xpad->pad_nr;
1749 		goto err_free_mem;
1750 	}
1751 
1752 	snprintf(led->name, sizeof(led->name), "xpad%d", xpad->pad_nr);
1753 	led->xpad = xpad;
1754 
1755 	led_cdev = &led->led_cdev;
1756 	led_cdev->name = led->name;
1757 	led_cdev->brightness_set = xpad_led_set;
1758 	led_cdev->flags = LED_CORE_SUSPENDRESUME;
1759 
1760 	error = led_classdev_register(&xpad->udev->dev, led_cdev);
1761 	if (error)
1762 		goto err_free_id;
1763 
1764 	xpad_identify_controller(xpad);
1765 
1766 	return 0;
1767 
1768 err_free_id:
1769 	ida_free(&xpad_pad_seq, xpad->pad_nr);
1770 err_free_mem:
1771 	kfree(led);
1772 	xpad->led = NULL;
1773 	return error;
1774 }
1775 
xpad_led_disconnect(struct usb_xpad * xpad)1776 static void xpad_led_disconnect(struct usb_xpad *xpad)
1777 {
1778 	struct xpad_led *xpad_led = xpad->led;
1779 
1780 	if (xpad_led) {
1781 		led_classdev_unregister(&xpad_led->led_cdev);
1782 		ida_free(&xpad_pad_seq, xpad->pad_nr);
1783 		kfree(xpad_led);
1784 	}
1785 }
1786 #else
xpad_led_probe(struct usb_xpad * xpad)1787 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
xpad_led_disconnect(struct usb_xpad * xpad)1788 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
1789 #endif
1790 
xpad_start_input(struct usb_xpad * xpad)1791 static int xpad_start_input(struct usb_xpad *xpad)
1792 {
1793 	int error;
1794 
1795 	if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
1796 		return -EIO;
1797 
1798 	if (xpad->xtype == XTYPE_XBOXONE) {
1799 		error = xpad_start_xbox_one(xpad);
1800 		if (error) {
1801 			usb_kill_urb(xpad->irq_in);
1802 			return error;
1803 		}
1804 	}
1805 	if (xpad->xtype == XTYPE_XBOX360) {
1806 		/*
1807 		 * Some third-party controllers Xbox 360-style controllers
1808 		 * require this message to finish initialization.
1809 		 */
1810 		u8 dummy[20];
1811 
1812 		error = usb_control_msg_recv(xpad->udev, 0,
1813 					     /* bRequest */ 0x01,
1814 					     /* bmRequestType */
1815 					     USB_TYPE_VENDOR | USB_DIR_IN |
1816 						USB_RECIP_INTERFACE,
1817 					     /* wValue */ 0x100,
1818 					     /* wIndex */ 0x00,
1819 					     dummy, sizeof(dummy),
1820 					     25, GFP_KERNEL);
1821 		if (error)
1822 			dev_warn(&xpad->dev->dev,
1823 				 "unable to receive magic message: %d\n",
1824 				 error);
1825 	}
1826 
1827 	return 0;
1828 }
1829 
xpad_stop_input(struct usb_xpad * xpad)1830 static void xpad_stop_input(struct usb_xpad *xpad)
1831 {
1832 	usb_kill_urb(xpad->irq_in);
1833 }
1834 
xpad360w_poweroff_controller(struct usb_xpad * xpad)1835 static void xpad360w_poweroff_controller(struct usb_xpad *xpad)
1836 {
1837 	struct xpad_output_packet *packet =
1838 			&xpad->out_packets[XPAD_OUT_CMD_IDX];
1839 
1840 	guard(spinlock_irqsave)(&xpad->odata_lock);
1841 
1842 	packet->data[0] = 0x00;
1843 	packet->data[1] = 0x00;
1844 	packet->data[2] = 0x08;
1845 	packet->data[3] = 0xC0;
1846 	packet->data[4] = 0x00;
1847 	packet->data[5] = 0x00;
1848 	packet->data[6] = 0x00;
1849 	packet->data[7] = 0x00;
1850 	packet->data[8] = 0x00;
1851 	packet->data[9] = 0x00;
1852 	packet->data[10] = 0x00;
1853 	packet->data[11] = 0x00;
1854 	packet->len = 12;
1855 	packet->pending = true;
1856 
1857 	/* Reset the sequence so we send out poweroff now */
1858 	xpad->last_out_packet = -1;
1859 	xpad_try_sending_next_out_packet(xpad);
1860 }
1861 
xpad360w_start_input(struct usb_xpad * xpad)1862 static int xpad360w_start_input(struct usb_xpad *xpad)
1863 {
1864 	int error;
1865 
1866 	error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1867 	if (error)
1868 		return -EIO;
1869 
1870 	/*
1871 	 * Send presence packet.
1872 	 * This will force the controller to resend connection packets.
1873 	 * This is useful in the case we activate the module after the
1874 	 * adapter has been plugged in, as it won't automatically
1875 	 * send us info about the controllers.
1876 	 */
1877 	error = xpad_inquiry_pad_presence(xpad);
1878 	if (error) {
1879 		usb_kill_urb(xpad->irq_in);
1880 		return error;
1881 	}
1882 
1883 	return 0;
1884 }
1885 
xpad360w_stop_input(struct usb_xpad * xpad)1886 static void xpad360w_stop_input(struct usb_xpad *xpad)
1887 {
1888 	usb_kill_urb(xpad->irq_in);
1889 
1890 	/* Make sure we are done with presence work if it was scheduled */
1891 	flush_work(&xpad->work);
1892 }
1893 
xpad_open(struct input_dev * dev)1894 static int xpad_open(struct input_dev *dev)
1895 {
1896 	struct usb_xpad *xpad = input_get_drvdata(dev);
1897 
1898 	return xpad_start_input(xpad);
1899 }
1900 
xpad_close(struct input_dev * dev)1901 static void xpad_close(struct input_dev *dev)
1902 {
1903 	struct usb_xpad *xpad = input_get_drvdata(dev);
1904 
1905 	xpad_stop_input(xpad);
1906 }
1907 
xpad_set_up_abs(struct input_dev * input_dev,signed short abs)1908 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
1909 {
1910 	struct usb_xpad *xpad = input_get_drvdata(input_dev);
1911 
1912 	switch (abs) {
1913 	case ABS_X:
1914 	case ABS_Y:
1915 	case ABS_RX:
1916 	case ABS_RY:	/* the two sticks */
1917 		input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
1918 		break;
1919 	case ABS_Z:
1920 	case ABS_RZ:	/* the triggers (if mapped to axes) */
1921 		if (xpad->xtype == XTYPE_XBOXONE)
1922 			input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
1923 		else
1924 			input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
1925 		break;
1926 	case ABS_HAT0X:
1927 	case ABS_HAT0Y:	/* the d-pad (only if dpad is mapped to axes */
1928 		input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
1929 		break;
1930 	case ABS_PROFILE: /* 4 value profile button (such as on XAC) */
1931 		input_set_abs_params(input_dev, abs, 0, 4, 0, 0);
1932 		break;
1933 	default:
1934 		input_set_abs_params(input_dev, abs, 0, 0, 0, 0);
1935 		break;
1936 	}
1937 }
1938 
xpad_deinit_input(struct usb_xpad * xpad)1939 static void xpad_deinit_input(struct usb_xpad *xpad)
1940 {
1941 	if (xpad->input_created) {
1942 		xpad->input_created = false;
1943 		xpad_led_disconnect(xpad);
1944 		input_unregister_device(xpad->dev);
1945 	}
1946 }
1947 
xpad_init_input(struct usb_xpad * xpad)1948 static int xpad_init_input(struct usb_xpad *xpad)
1949 {
1950 	struct input_dev *input_dev;
1951 	int i, error;
1952 
1953 	input_dev = input_allocate_device();
1954 	if (!input_dev)
1955 		return -ENOMEM;
1956 
1957 	xpad->dev = input_dev;
1958 	input_dev->name = xpad->name;
1959 	input_dev->phys = xpad->phys;
1960 	usb_to_input_id(xpad->udev, &input_dev->id);
1961 
1962 	if (xpad->xtype == XTYPE_XBOX360W) {
1963 		/* x360w controllers and the receiver have different ids */
1964 		input_dev->id.product = 0x02a1;
1965 	}
1966 
1967 	input_dev->dev.parent = &xpad->intf->dev;
1968 
1969 	input_set_drvdata(input_dev, xpad);
1970 
1971 	if (xpad->xtype != XTYPE_XBOX360W) {
1972 		input_dev->open = xpad_open;
1973 		input_dev->close = xpad_close;
1974 	}
1975 
1976 	if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1977 		/* set up axes */
1978 		for (i = 0; xpad_abs[i] >= 0; i++)
1979 			xpad_set_up_abs(input_dev, xpad_abs[i]);
1980 	}
1981 
1982 	/* set up standard buttons */
1983 	for (i = 0; xpad_common_btn[i] >= 0; i++)
1984 		input_set_capability(input_dev, EV_KEY, xpad_common_btn[i]);
1985 
1986 	/* set up model-specific ones */
1987 	if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1988 	    xpad->xtype == XTYPE_XBOXONE) {
1989 		for (i = 0; xpad360_btn[i] >= 0; i++)
1990 			input_set_capability(input_dev, EV_KEY, xpad360_btn[i]);
1991 		if (xpad->mapping & MAP_SHARE_BUTTON)
1992 			input_set_capability(input_dev, EV_KEY, KEY_RECORD);
1993 	} else {
1994 		for (i = 0; xpad_btn[i] >= 0; i++)
1995 			input_set_capability(input_dev, EV_KEY, xpad_btn[i]);
1996 	}
1997 
1998 	if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1999 		for (i = 0; xpad_btn_pad[i] >= 0; i++)
2000 			input_set_capability(input_dev, EV_KEY,
2001 					     xpad_btn_pad[i]);
2002 	}
2003 
2004 	/* set up paddles if the controller has them */
2005 	if (xpad->mapping & MAP_PADDLES) {
2006 		for (i = 0; xpad_btn_paddles[i] >= 0; i++)
2007 			input_set_capability(input_dev, EV_KEY, xpad_btn_paddles[i]);
2008 	}
2009 
2010 	/*
2011 	 * This should be a simple else block. However historically
2012 	 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
2013 	 * made no sense, but now we can not just switch back and have to
2014 	 * support both behaviors.
2015 	 */
2016 	if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
2017 	    xpad->xtype == XTYPE_XBOX360W) {
2018 		for (i = 0; xpad_abs_pad[i] >= 0; i++)
2019 			xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
2020 	}
2021 
2022 	if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
2023 		for (i = 0; xpad_btn_triggers[i] >= 0; i++)
2024 			input_set_capability(input_dev, EV_KEY,
2025 					     xpad_btn_triggers[i]);
2026 	} else {
2027 		for (i = 0; xpad_abs_triggers[i] >= 0; i++)
2028 			xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
2029 	}
2030 
2031 	/* setup profile button as an axis with 4 possible values */
2032 	if (xpad->mapping & MAP_PROFILE_BUTTON)
2033 		xpad_set_up_abs(input_dev, ABS_PROFILE);
2034 
2035 	error = xpad_init_ff(xpad);
2036 	if (error)
2037 		goto err_free_input;
2038 
2039 	error = xpad_led_probe(xpad);
2040 	if (error)
2041 		goto err_destroy_ff;
2042 
2043 	error = input_register_device(xpad->dev);
2044 	if (error)
2045 		goto err_disconnect_led;
2046 
2047 	xpad->input_created = true;
2048 	return 0;
2049 
2050 err_disconnect_led:
2051 	xpad_led_disconnect(xpad);
2052 err_destroy_ff:
2053 	input_ff_destroy(input_dev);
2054 err_free_input:
2055 	input_free_device(input_dev);
2056 	return error;
2057 }
2058 
xpad_probe(struct usb_interface * intf,const struct usb_device_id * id)2059 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
2060 {
2061 	struct usb_device *udev = interface_to_usbdev(intf);
2062 	struct usb_xpad *xpad;
2063 	struct usb_endpoint_descriptor *ep_irq_in, *ep_irq_out;
2064 	int i, error;
2065 
2066 	if (intf->cur_altsetting->desc.bNumEndpoints != 2)
2067 		return -ENODEV;
2068 
2069 	for (i = 0; xpad_device[i].idVendor; i++) {
2070 		if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
2071 		    (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
2072 			break;
2073 	}
2074 
2075 	xpad = kzalloc(sizeof(*xpad), GFP_KERNEL);
2076 	if (!xpad)
2077 		return -ENOMEM;
2078 
2079 	usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
2080 	strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
2081 
2082 	xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
2083 					 GFP_KERNEL, &xpad->idata_dma);
2084 	if (!xpad->idata) {
2085 		error = -ENOMEM;
2086 		goto err_free_mem;
2087 	}
2088 
2089 	xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
2090 	if (!xpad->irq_in) {
2091 		error = -ENOMEM;
2092 		goto err_free_idata;
2093 	}
2094 
2095 	xpad->udev = udev;
2096 	xpad->intf = intf;
2097 	xpad->mapping = xpad_device[i].mapping;
2098 	xpad->xtype = xpad_device[i].xtype;
2099 	xpad->name = xpad_device[i].name;
2100 	if (xpad_device[i].flags & FLAG_DELAY_INIT)
2101 		xpad->delay_init = true;
2102 
2103 	xpad->packet_type = PKT_XB;
2104 	INIT_WORK(&xpad->work, xpad_presence_work);
2105 
2106 	if (xpad->xtype == XTYPE_UNKNOWN) {
2107 		if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
2108 			if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
2109 				xpad->xtype = XTYPE_XBOX360W;
2110 			else if (intf->cur_altsetting->desc.bInterfaceProtocol == 208)
2111 				xpad->xtype = XTYPE_XBOXONE;
2112 			else
2113 				xpad->xtype = XTYPE_XBOX360;
2114 		} else {
2115 			xpad->xtype = XTYPE_XBOX;
2116 		}
2117 
2118 		if (dpad_to_buttons)
2119 			xpad->mapping |= MAP_DPAD_TO_BUTTONS;
2120 		if (triggers_to_buttons)
2121 			xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
2122 		if (sticks_to_null)
2123 			xpad->mapping |= MAP_STICKS_TO_NULL;
2124 	}
2125 
2126 	if (xpad->xtype == XTYPE_XBOXONE &&
2127 	    intf->cur_altsetting->desc.bInterfaceNumber != GIP_WIRED_INTF_DATA) {
2128 		/*
2129 		 * The Xbox One controller lists three interfaces all with the
2130 		 * same interface class, subclass and protocol. Differentiate by
2131 		 * interface number.
2132 		 */
2133 		error = -ENODEV;
2134 		goto err_free_in_urb;
2135 	}
2136 
2137 	ep_irq_in = ep_irq_out = NULL;
2138 
2139 	for (i = 0; i < 2; i++) {
2140 		struct usb_endpoint_descriptor *ep =
2141 				&intf->cur_altsetting->endpoint[i].desc;
2142 
2143 		if (usb_endpoint_xfer_int(ep)) {
2144 			if (usb_endpoint_dir_in(ep))
2145 				ep_irq_in = ep;
2146 			else
2147 				ep_irq_out = ep;
2148 		}
2149 	}
2150 
2151 	if (!ep_irq_in || !ep_irq_out) {
2152 		error = -ENODEV;
2153 		goto err_free_in_urb;
2154 	}
2155 
2156 	error = xpad_init_output(intf, xpad, ep_irq_out);
2157 	if (error)
2158 		goto err_free_in_urb;
2159 
2160 	usb_fill_int_urb(xpad->irq_in, udev,
2161 			 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
2162 			 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
2163 			 xpad, ep_irq_in->bInterval);
2164 	xpad->irq_in->transfer_dma = xpad->idata_dma;
2165 	xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2166 
2167 	usb_set_intfdata(intf, xpad);
2168 
2169 	/* Packet type detection */
2170 	if (le16_to_cpu(udev->descriptor.idVendor) == 0x045e) { /* Microsoft controllers */
2171 		if (le16_to_cpu(udev->descriptor.idProduct) == 0x02e3) {
2172 			/* The original elite controller always uses the oldest
2173 			 * type of extended packet
2174 			 */
2175 			xpad->packet_type = PKT_XBE1;
2176 		} else if (le16_to_cpu(udev->descriptor.idProduct) == 0x0b00) {
2177 			/* The elite 2 controller has seen multiple packet
2178 			 * revisions. These are tied to specific firmware
2179 			 * versions
2180 			 */
2181 			if (le16_to_cpu(udev->descriptor.bcdDevice) < 0x0500) {
2182 				/* This is the format that the Elite 2 used
2183 				 * prior to the BLE update
2184 				 */
2185 				xpad->packet_type = PKT_XBE2_FW_OLD;
2186 			} else if (le16_to_cpu(udev->descriptor.bcdDevice) <
2187 				   0x050b) {
2188 				/* This is the format that the Elite 2 used
2189 				 * prior to the update that split the packet
2190 				 */
2191 				xpad->packet_type = PKT_XBE2_FW_5_EARLY;
2192 			} else {
2193 				/* The split packet format that was introduced
2194 				 * in firmware v5.11
2195 				 */
2196 				xpad->packet_type = PKT_XBE2_FW_5_11;
2197 			}
2198 		}
2199 	}
2200 
2201 	if (xpad->xtype == XTYPE_XBOX360W) {
2202 		/*
2203 		 * Submit the int URB immediately rather than waiting for open
2204 		 * because we get status messages from the device whether
2205 		 * or not any controllers are attached.  In fact, it's
2206 		 * exactly the message that a controller has arrived that
2207 		 * we're waiting for.
2208 		 */
2209 		error = xpad360w_start_input(xpad);
2210 		if (error)
2211 			goto err_deinit_output;
2212 		/*
2213 		 * Wireless controllers require RESET_RESUME to work properly
2214 		 * after suspend. Ideally this quirk should be in usb core
2215 		 * quirk list, but we have too many vendors producing these
2216 		 * controllers and we'd need to maintain 2 identical lists
2217 		 * here in this driver and in usb core.
2218 		 */
2219 		udev->quirks |= USB_QUIRK_RESET_RESUME;
2220 	} else {
2221 		error = xpad_init_input(xpad);
2222 		if (error)
2223 			goto err_deinit_output;
2224 	}
2225 	return 0;
2226 
2227 err_deinit_output:
2228 	xpad_deinit_output(xpad);
2229 err_free_in_urb:
2230 	usb_free_urb(xpad->irq_in);
2231 err_free_idata:
2232 	usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
2233 err_free_mem:
2234 	kfree(xpad);
2235 	return error;
2236 }
2237 
xpad_disconnect(struct usb_interface * intf)2238 static void xpad_disconnect(struct usb_interface *intf)
2239 {
2240 	struct usb_xpad *xpad = usb_get_intfdata(intf);
2241 
2242 	if (xpad->xtype == XTYPE_XBOX360W)
2243 		xpad360w_stop_input(xpad);
2244 
2245 	xpad_deinit_input(xpad);
2246 
2247 	/*
2248 	 * Now that both input device and LED device are gone we can
2249 	 * stop output URB.
2250 	 */
2251 	xpad_stop_output(xpad);
2252 
2253 	xpad_deinit_output(xpad);
2254 
2255 	usb_free_urb(xpad->irq_in);
2256 	usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
2257 			xpad->idata, xpad->idata_dma);
2258 
2259 	kfree(xpad);
2260 
2261 	usb_set_intfdata(intf, NULL);
2262 }
2263 
xpad_suspend(struct usb_interface * intf,pm_message_t message)2264 static int xpad_suspend(struct usb_interface *intf, pm_message_t message)
2265 {
2266 	struct usb_xpad *xpad = usb_get_intfdata(intf);
2267 	struct input_dev *input = xpad->dev;
2268 
2269 	if (xpad->xtype == XTYPE_XBOX360W) {
2270 		/*
2271 		 * Wireless controllers always listen to input so
2272 		 * they are notified when controller shows up
2273 		 * or goes away.
2274 		 */
2275 		xpad360w_stop_input(xpad);
2276 
2277 		/*
2278 		 * The wireless adapter is going off now, so the
2279 		 * gamepads are going to become disconnected.
2280 		 * Unless explicitly disabled, power them down
2281 		 * so they don't just sit there flashing.
2282 		 */
2283 		if (auto_poweroff && xpad->pad_present)
2284 			xpad360w_poweroff_controller(xpad);
2285 	} else {
2286 		guard(mutex)(&input->mutex);
2287 
2288 		if (input_device_enabled(input))
2289 			xpad_stop_input(xpad);
2290 	}
2291 
2292 	xpad_stop_output(xpad);
2293 
2294 	return 0;
2295 }
2296 
xpad_resume(struct usb_interface * intf)2297 static int xpad_resume(struct usb_interface *intf)
2298 {
2299 	struct usb_xpad *xpad = usb_get_intfdata(intf);
2300 	struct input_dev *input = xpad->dev;
2301 
2302 	xpad->delayed_init_done = false;
2303 	if (xpad->xtype == XTYPE_XBOX360W)
2304 		return xpad360w_start_input(xpad);
2305 
2306 	guard(mutex)(&input->mutex);
2307 
2308 	if (input_device_enabled(input))
2309 		return xpad_start_input(xpad);
2310 
2311 	if (xpad->xtype == XTYPE_XBOXONE) {
2312 		/*
2313 		 * Even if there are no users, we'll send Xbox One pads
2314 		 * the startup sequence so they don't sit there and
2315 		 * blink until somebody opens the input device again.
2316 		 */
2317 		return xpad_start_xbox_one(xpad);
2318 	}
2319 
2320 	return 0;
2321 }
2322 
2323 static struct usb_driver xpad_driver = {
2324 	.name		= "xpad",
2325 	.probe		= xpad_probe,
2326 	.disconnect	= xpad_disconnect,
2327 	.suspend	= xpad_suspend,
2328 	.resume		= xpad_resume,
2329 	.id_table	= xpad_table,
2330 };
2331 
2332 module_usb_driver(xpad_driver);
2333 
2334 MODULE_AUTHOR("Marko Friedemann <mfr@bmx-chemnitz.de>");
2335 MODULE_DESCRIPTION("Xbox pad driver");
2336 MODULE_LICENSE("GPL");
2337