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