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