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