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