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