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