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