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