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