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