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