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