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