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