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