4 * Copyright (c) 2002 Marko Friedemann <mfr@bmx-chemnitz.de>
5 * 2004 Oliver Schwartz <Oliver.Schwartz@gmx.de>,
6 * Steven Toth <steve@toth.demon.co.uk>,
7 * Franz Lehner <franz@caos.at>,
8 * Ivan Hawkes <blackhawk@ivanhawkes.com>
9 * 2005 Dominic Cerquetti <binary1230@yahoo.com>
10 * 2006 Adam Buchbinder <adam.buchbinder@gmail.com>
11 * 2007 Jan Kratochvil <honza@jikos.cz>
12 * 2010 Christoph Fritz <chf.fritz@googlemail.com>
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License as
16 * published by the Free Software Foundation; either version 2 of
17 * the License, or (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 * This driver is based on:
30 * - information from http://euc.jp/periphs/xbox-controller.ja.html
31 * - the iForce driver drivers/char/joystick/iforce.c
32 * - the skeleton-driver drivers/usb/usb-skeleton.c
33 * - Xbox 360 information http://www.free60.org/wiki/Gamepad
34 * - Xbox One information https://github.com/quantus/xbox-one-controller-protocol
37 * - ITO Takayuki for providing essential xpad information on his website
38 * - Vojtech Pavlik - iforce driver / input subsystem
39 * - Greg Kroah-Hartman - usb-skeleton driver
40 * - XBOX Linux project - extra USB id's
41 * - Pekka Pöyry (quantus) - Xbox One controller reverse engineering
44 * - fine tune axes (especially trigger axes)
45 * - fix "analog" buttons (reported as digital now)
46 * - get rumble working
47 * - need USB IDs for other dance pads
51 * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
53 * 2002-07-02 - 0.0.2 : basic working version
54 * - all axes and 9 of the 10 buttons work (german InterAct device)
55 * - the black button does not work
57 * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
59 * - usb + input init sequence fixes
61 * 2002-07-16 - 0.0.4 : minor changes, merge with Vojtech's v0.0.3
62 * - verified the lack of HID and report descriptors
63 * - verified that ALL buttons WORK
64 * - fixed d-pad to axes mapping
66 * 2002-07-17 - 0.0.5 : simplified d-pad handling
68 * 2004-10-02 - 0.0.6 : DDR pad support
69 * - borrowed from the XBOX linux kernel
70 * - USB id's for commonly used dance pads are present
71 * - dance pads will map D-PAD to buttons, not axes
72 * - pass the module paramater 'dpad_to_buttons' to force
73 * the D-PAD to map to buttons if your pad is not detected
75 * Later changes can be tracked in SCM.
78 #include <linux/kernel.h>
79 #include <linux/input.h>
80 #include <linux/rcupdate.h>
81 #include <linux/slab.h>
82 #include <linux/stat.h>
83 #include <linux/module.h>
84 #include <linux/usb/input.h>
85 #include <linux/usb/quirks.h>
87 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
88 #define DRIVER_DESC "X-Box pad driver"
90 #define XPAD_PKT_LEN 64
92 /* xbox d-pads should map to buttons, as is required for DDR pads
93 but we map them to axes when possible to simplify things */
94 #define MAP_DPAD_TO_BUTTONS (1 << 0)
95 #define MAP_TRIGGERS_TO_BUTTONS (1 << 1)
96 #define MAP_STICKS_TO_NULL (1 << 2)
97 #define DANCEPAD_MAP_CONFIG (MAP_DPAD_TO_BUTTONS | \
98 MAP_TRIGGERS_TO_BUTTONS | MAP_STICKS_TO_NULL)
101 #define XTYPE_XBOX360 1
102 #define XTYPE_XBOX360W 2
103 #define XTYPE_XBOXONE 3
104 #define XTYPE_UNKNOWN 4
106 static bool dpad_to_buttons;
107 module_param(dpad_to_buttons, bool, S_IRUGO);
108 MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
110 static bool triggers_to_buttons;
111 module_param(triggers_to_buttons, bool, S_IRUGO);
112 MODULE_PARM_DESC(triggers_to_buttons, "Map triggers to buttons rather than axes for unknown pads");
114 static bool sticks_to_null;
115 module_param(sticks_to_null, bool, S_IRUGO);
116 MODULE_PARM_DESC(sticks_to_null, "Do not map sticks at all for unknown pads");
118 static bool auto_poweroff = true;
119 module_param(auto_poweroff, bool, S_IWUSR | S_IRUGO);
120 MODULE_PARM_DESC(auto_poweroff, "Power off wireless controllers on suspend");
122 static const struct xpad_device {
129 { 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", 0, XTYPE_XBOX },
130 { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", 0, XTYPE_XBOX },
131 { 0x045e, 0x0287, "Microsoft Xbox Controller S", 0, XTYPE_XBOX },
132 { 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", 0, XTYPE_XBOX },
133 { 0x045e, 0x028e, "Microsoft X-Box 360 pad", 0, XTYPE_XBOX360 },
134 { 0x045e, 0x02d1, "Microsoft X-Box One pad", 0, XTYPE_XBOXONE },
135 { 0x045e, 0x02dd, "Microsoft X-Box One pad (Firmware 2015)", 0, XTYPE_XBOXONE },
136 { 0x045e, 0x02e3, "Microsoft X-Box One Elite pad", 0, XTYPE_XBOXONE },
137 { 0x045e, 0x02ea, "Microsoft X-Box One S pad", 0, XTYPE_XBOXONE },
138 { 0x045e, 0x0291, "Xbox 360 Wireless Receiver (XBOX)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
139 { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
140 { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
141 { 0x044f, 0xb326, "Thrustmaster Gamepad GP XID", 0, XTYPE_XBOX360 },
142 { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
143 { 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
144 { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },
145 { 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
146 { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
147 { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
148 { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
149 { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
150 { 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
151 { 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
152 { 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
153 { 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
154 { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
155 { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
156 { 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
157 { 0x0738, 0x4718, "Mad Catz Street Fighter IV FightStick SE", 0, XTYPE_XBOX360 },
158 { 0x0738, 0x4726, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
159 { 0x0738, 0x4728, "Mad Catz Street Fighter IV FightPad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
160 { 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
161 { 0x0738, 0x4740, "Mad Catz Beat Pad", 0, XTYPE_XBOX360 },
162 { 0x0738, 0x4a01, "Mad Catz FightStick TE 2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
163 { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
164 { 0x0738, 0xb726, "Mad Catz Xbox controller - MW2", 0, XTYPE_XBOX360 },
165 { 0x0738, 0xbeef, "Mad Catz JOYTECH NEO SE Advanced GamePad", XTYPE_XBOX360 },
166 { 0x0738, 0xcb02, "Saitek Cyborg Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
167 { 0x0738, 0xcb03, "Saitek P3200 Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
168 { 0x0738, 0xf738, "Super SFIV FightStick TE S", 0, XTYPE_XBOX360 },
169 { 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
170 { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
171 { 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
172 { 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
173 { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
174 { 0x0d2f, 0x0002, "Andamiro Pump It Up pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
175 { 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
176 { 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
177 { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
178 { 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
179 { 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
180 { 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
181 { 0x0e6f, 0x0113, "Afterglow AX.1 Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
182 { 0x0e6f, 0x0139, "Afterglow Prismatic Wired Controller", 0, XTYPE_XBOXONE },
183 { 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
184 { 0x0e6f, 0x0213, "Afterglow Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
185 { 0x0e6f, 0x021f, "Rock Candy Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
186 { 0x0e6f, 0x0146, "Rock Candy Wired Controller for Xbox One", 0, XTYPE_XBOXONE },
187 { 0x0e6f, 0x0301, "Logic3 Controller", 0, XTYPE_XBOX360 },
188 { 0x0e6f, 0x0401, "Logic3 Controller", 0, XTYPE_XBOX360 },
189 { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
190 { 0x0e8f, 0x3008, "Generic xbox control (dealextreme)", 0, XTYPE_XBOX },
191 { 0x0f0d, 0x000a, "Hori Co. DOA4 FightStick", 0, XTYPE_XBOX360 },
192 { 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
193 { 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
194 { 0x0f0d, 0x0067, "HORIPAD ONE", 0, XTYPE_XBOXONE },
195 { 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
196 { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
197 { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
198 { 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
199 { 0x12ab, 0x0301, "PDP AFTERGLOW AX.1", 0, XTYPE_XBOX360 },
200 { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
201 { 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
202 { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
203 { 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
204 { 0x1532, 0x0037, "Razer Sabertooth", 0, XTYPE_XBOX360 },
205 { 0x15e4, 0x3f00, "Power A Mini Pro Elite", 0, XTYPE_XBOX360 },
206 { 0x15e4, 0x3f0a, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
207 { 0x15e4, 0x3f10, "Batarang Xbox 360 controller", 0, XTYPE_XBOX360 },
208 { 0x162e, 0xbeef, "Joytech Neo-Se Take2", 0, XTYPE_XBOX360 },
209 { 0x1689, 0xfd00, "Razer Onza Tournament Edition", 0, XTYPE_XBOX360 },
210 { 0x1689, 0xfd01, "Razer Onza Classic Edition", 0, XTYPE_XBOX360 },
211 { 0x24c6, 0x542a, "Xbox ONE spectra", 0, XTYPE_XBOXONE },
212 { 0x24c6, 0x5d04, "Razer Sabertooth", 0, XTYPE_XBOX360 },
213 { 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
214 { 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
215 { 0x1bad, 0xf016, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
216 { 0x1bad, 0xf023, "MLG Pro Circuit Controller (Xbox)", 0, XTYPE_XBOX360 },
217 { 0x1bad, 0xf028, "Street Fighter IV FightPad", 0, XTYPE_XBOX360 },
218 { 0x1bad, 0xf038, "Street Fighter IV FightStick TE", 0, XTYPE_XBOX360 },
219 { 0x1bad, 0xf900, "Harmonix Xbox 360 Controller", 0, XTYPE_XBOX360 },
220 { 0x1bad, 0xf901, "Gamestop Xbox 360 Controller", 0, XTYPE_XBOX360 },
221 { 0x1bad, 0xf903, "Tron Xbox 360 controller", 0, XTYPE_XBOX360 },
222 { 0x24c6, 0x5000, "Razer Atrox Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
223 { 0x24c6, 0x5300, "PowerA MINI PROEX Controller", 0, XTYPE_XBOX360 },
224 { 0x24c6, 0x5303, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
225 { 0x24c6, 0x541a, "PowerA Xbox One Mini Wired Controller", 0, XTYPE_XBOXONE },
226 { 0x24c6, 0x543a, "PowerA Xbox One wired controller", 0, XTYPE_XBOXONE },
227 { 0x24c6, 0x5500, "Hori XBOX 360 EX 2 with Turbo", 0, XTYPE_XBOX360 },
228 { 0x24c6, 0x5501, "Hori Real Arcade Pro VX-SA", 0, XTYPE_XBOX360 },
229 { 0x24c6, 0x5506, "Hori SOULCALIBUR V Stick", 0, XTYPE_XBOX360 },
230 { 0x24c6, 0x5b02, "Thrustmaster, Inc. GPX Controller", 0, XTYPE_XBOX360 },
231 { 0x24c6, 0x5b03, "Thrustmaster Ferrari 458 Racing Wheel", 0, XTYPE_XBOX360 },
232 { 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
233 { 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
236 /* buttons shared with xbox and xbox360 */
237 static const signed short xpad_common_btn[] = {
238 BTN_A, BTN_B, BTN_X, BTN_Y, /* "analog" buttons */
239 BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR, /* start/back/sticks */
240 -1 /* terminating entry */
243 /* original xbox controllers only */
244 static const signed short xpad_btn[] = {
245 BTN_C, BTN_Z, /* "analog" buttons */
246 -1 /* terminating entry */
249 /* used when dpad is mapped to buttons */
250 static const signed short xpad_btn_pad[] = {
251 BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2, /* d-pad left, right */
252 BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4, /* d-pad up, down */
253 -1 /* terminating entry */
256 /* used when triggers are mapped to buttons */
257 static const signed short xpad_btn_triggers[] = {
258 BTN_TL2, BTN_TR2, /* triggers left/right */
262 static const signed short xpad360_btn[] = { /* buttons for x360 controller */
263 BTN_TL, BTN_TR, /* Button LB/RB */
264 BTN_MODE, /* The big X button */
268 static const signed short xpad_abs[] = {
269 ABS_X, ABS_Y, /* left stick */
270 ABS_RX, ABS_RY, /* right stick */
271 -1 /* terminating entry */
274 /* used when dpad is mapped to axes */
275 static const signed short xpad_abs_pad[] = {
276 ABS_HAT0X, ABS_HAT0Y, /* d-pad axes */
277 -1 /* terminating entry */
280 /* used when triggers are mapped to axes */
281 static const signed short xpad_abs_triggers[] = {
282 ABS_Z, ABS_RZ, /* triggers left/right */
287 * Xbox 360 has a vendor-specific class, so we cannot match it with only
288 * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
289 * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
290 * wireless controllers have protocol 129.
292 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
293 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
294 .idVendor = (vend), \
295 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
296 .bInterfaceSubClass = 93, \
297 .bInterfaceProtocol = (pr)
298 #define XPAD_XBOX360_VENDOR(vend) \
299 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
300 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
302 /* The Xbox One controller uses subclass 71 and protocol 208. */
303 #define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
304 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
305 .idVendor = (vend), \
306 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
307 .bInterfaceSubClass = 71, \
308 .bInterfaceProtocol = (pr)
309 #define XPAD_XBOXONE_VENDOR(vend) \
310 { XPAD_XBOXONE_VENDOR_PROTOCOL(vend, 208) }
312 static struct usb_device_id xpad_table[] = {
313 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
314 XPAD_XBOX360_VENDOR(0x044f), /* Thrustmaster X-Box 360 controllers */
315 XPAD_XBOX360_VENDOR(0x045e), /* Microsoft X-Box 360 controllers */
316 XPAD_XBOXONE_VENDOR(0x045e), /* Microsoft X-Box One controllers */
317 XPAD_XBOX360_VENDOR(0x046d), /* Logitech X-Box 360 style controllers */
318 XPAD_XBOX360_VENDOR(0x0738), /* Mad Catz X-Box 360 controllers */
319 { USB_DEVICE(0x0738, 0x4540) }, /* Mad Catz Beat Pad */
320 XPAD_XBOXONE_VENDOR(0x0738), /* Mad Catz FightStick TE 2 */
321 XPAD_XBOX360_VENDOR(0x0e6f), /* 0x0e6f X-Box 360 controllers */
322 XPAD_XBOXONE_VENDOR(0x0e6f), /* 0x0e6f X-Box One controllers */
323 XPAD_XBOX360_VENDOR(0x0f0d), /* Hori Controllers */
324 XPAD_XBOXONE_VENDOR(0x0f0d), /* Hori Controllers */
325 XPAD_XBOX360_VENDOR(0x12ab), /* X-Box 360 dance pads */
326 XPAD_XBOX360_VENDOR(0x1430), /* RedOctane X-Box 360 controllers */
327 XPAD_XBOX360_VENDOR(0x146b), /* BigBen Interactive Controllers */
328 XPAD_XBOX360_VENDOR(0x1532), /* Razer Sabertooth */
329 XPAD_XBOX360_VENDOR(0x15e4), /* Numark X-Box 360 controllers */
330 XPAD_XBOX360_VENDOR(0x162e), /* Joytech X-Box 360 controllers */
331 XPAD_XBOX360_VENDOR(0x1689), /* Razer Onza */
332 XPAD_XBOX360_VENDOR(0x1bad), /* Harminix Rock Band Guitar and Drums */
333 XPAD_XBOX360_VENDOR(0x24c6), /* PowerA Controllers */
334 XPAD_XBOXONE_VENDOR(0x24c6), /* PowerA Controllers */
338 MODULE_DEVICE_TABLE(usb, xpad_table);
340 struct xpad_output_packet {
341 u8 data[XPAD_PKT_LEN];
346 #define XPAD_OUT_CMD_IDX 0
347 #define XPAD_OUT_FF_IDX 1
348 #define XPAD_OUT_LED_IDX (1 + IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF))
349 #define XPAD_NUM_OUT_PACKETS (1 + \
350 IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF) + \
351 IS_ENABLED(CONFIG_JOYSTICK_XPAD_LEDS))
354 struct input_dev *dev; /* input device interface */
355 struct input_dev __rcu *x360w_dev;
356 struct usb_device *udev; /* usb device */
357 struct usb_interface *intf; /* usb interface */
362 struct urb *irq_in; /* urb for interrupt in report */
363 unsigned char *idata; /* input data */
364 dma_addr_t idata_dma;
366 struct urb *irq_out; /* urb for interrupt out report */
367 struct usb_anchor irq_out_anchor;
368 bool irq_out_active; /* we must not use an active URB */
369 u8 odata_serial; /* serial number for xbox one protocol */
370 unsigned char *odata; /* output data */
371 dma_addr_t odata_dma;
372 spinlock_t odata_lock;
374 struct xpad_output_packet out_packets[XPAD_NUM_OUT_PACKETS];
377 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
378 struct xpad_led *led;
381 char phys[64]; /* physical device path */
383 int mapping; /* map d-pad to buttons or to axes */
384 int xtype; /* type of xbox device */
385 int pad_nr; /* the order x360 pads were attached */
386 const char *name; /* name of the device */
387 struct work_struct work; /* init/remove device from callback */
390 static int xpad_init_input(struct usb_xpad *xpad);
391 static void xpad_deinit_input(struct usb_xpad *xpad);
392 static void xpadone_ack_mode_report(struct usb_xpad *xpad, u8 seq_num);
395 * xpad_process_packet
397 * Completes a request by converting the data into events for the
400 * The used report descriptor was taken from ITO Takayukis website:
401 * http://euc.jp/periphs/xbox-controller.ja.html
403 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
405 struct input_dev *dev = xpad->dev;
407 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
409 input_report_abs(dev, ABS_X,
410 (__s16) le16_to_cpup((__le16 *)(data + 12)));
411 input_report_abs(dev, ABS_Y,
412 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
415 input_report_abs(dev, ABS_RX,
416 (__s16) le16_to_cpup((__le16 *)(data + 16)));
417 input_report_abs(dev, ABS_RY,
418 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
421 /* triggers left/right */
422 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
423 input_report_key(dev, BTN_TL2, data[10]);
424 input_report_key(dev, BTN_TR2, data[11]);
426 input_report_abs(dev, ABS_Z, data[10]);
427 input_report_abs(dev, ABS_RZ, data[11]);
431 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
432 /* dpad as buttons (left, right, up, down) */
433 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
434 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
435 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
436 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
438 input_report_abs(dev, ABS_HAT0X,
439 !!(data[2] & 0x08) - !!(data[2] & 0x04));
440 input_report_abs(dev, ABS_HAT0Y,
441 !!(data[2] & 0x02) - !!(data[2] & 0x01));
444 /* start/back buttons and stick press left/right */
445 input_report_key(dev, BTN_START, data[2] & 0x10);
446 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
447 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
448 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
450 /* "analog" buttons A, B, X, Y */
451 input_report_key(dev, BTN_A, data[4]);
452 input_report_key(dev, BTN_B, data[5]);
453 input_report_key(dev, BTN_X, data[6]);
454 input_report_key(dev, BTN_Y, data[7]);
456 /* "analog" buttons black, white */
457 input_report_key(dev, BTN_C, data[8]);
458 input_report_key(dev, BTN_Z, data[9]);
464 * xpad360_process_packet
466 * Completes a request by converting the data into events for the
467 * input subsystem. It is version for xbox 360 controller
469 * The used report descriptor was taken from:
470 * http://www.free60.org/wiki/Gamepad
473 static void xpad360_process_packet(struct usb_xpad *xpad, struct input_dev *dev,
474 u16 cmd, unsigned char *data)
481 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
482 /* dpad as buttons (left, right, up, down) */
483 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
484 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
485 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
486 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
490 * This should be a simple else block. However historically
491 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
492 * made no sense, but now we can not just switch back and have to
493 * support both behaviors.
495 if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
496 xpad->xtype == XTYPE_XBOX360W) {
497 input_report_abs(dev, ABS_HAT0X,
498 !!(data[2] & 0x08) - !!(data[2] & 0x04));
499 input_report_abs(dev, ABS_HAT0Y,
500 !!(data[2] & 0x02) - !!(data[2] & 0x01));
503 /* start/back buttons */
504 input_report_key(dev, BTN_START, data[2] & 0x10);
505 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
507 /* stick press left/right */
508 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
509 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
511 /* buttons A,B,X,Y,TL,TR and MODE */
512 input_report_key(dev, BTN_A, data[3] & 0x10);
513 input_report_key(dev, BTN_B, data[3] & 0x20);
514 input_report_key(dev, BTN_X, data[3] & 0x40);
515 input_report_key(dev, BTN_Y, data[3] & 0x80);
516 input_report_key(dev, BTN_TL, data[3] & 0x01);
517 input_report_key(dev, BTN_TR, data[3] & 0x02);
518 input_report_key(dev, BTN_MODE, data[3] & 0x04);
520 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
522 input_report_abs(dev, ABS_X,
523 (__s16) le16_to_cpup((__le16 *)(data + 6)));
524 input_report_abs(dev, ABS_Y,
525 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
528 input_report_abs(dev, ABS_RX,
529 (__s16) le16_to_cpup((__le16 *)(data + 10)));
530 input_report_abs(dev, ABS_RY,
531 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
534 /* triggers left/right */
535 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
536 input_report_key(dev, BTN_TL2, data[4]);
537 input_report_key(dev, BTN_TR2, data[5]);
539 input_report_abs(dev, ABS_Z, data[4]);
540 input_report_abs(dev, ABS_RZ, data[5]);
546 static void xpad_presence_work(struct work_struct *work)
548 struct usb_xpad *xpad = container_of(work, struct usb_xpad, work);
551 if (xpad->pad_present) {
552 error = xpad_init_input(xpad);
554 /* complain only, not much else we can do here */
555 dev_err(&xpad->dev->dev,
556 "unable to init device: %d\n", error);
558 rcu_assign_pointer(xpad->x360w_dev, xpad->dev);
561 RCU_INIT_POINTER(xpad->x360w_dev, NULL);
564 * Now that we are sure xpad360w_process_packet is not
565 * using input device we can get rid of it.
567 xpad_deinit_input(xpad);
572 * xpad360w_process_packet
574 * Completes a request by converting the data into events for the
575 * input subsystem. It is version for xbox 360 wireless controller.
578 * 00.1 - Status change: The controller or headset has connected/disconnected
579 * Bits 01.7 and 01.6 are valid
580 * 01.7 - Controller present
581 * 01.6 - Headset present
582 * 01.1 - Pad state (Bytes 4+) valid
585 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
587 struct input_dev *dev;
590 /* Presence change */
591 if (data[0] & 0x08) {
592 present = (data[1] & 0x80) != 0;
594 if (xpad->pad_present != present) {
595 xpad->pad_present = present;
596 schedule_work(&xpad->work);
605 dev = rcu_dereference(xpad->x360w_dev);
607 xpad360_process_packet(xpad, dev, cmd, &data[4]);
612 * xpadone_process_packet
614 * Completes a request by converting the data into events for the
615 * input subsystem. This version is for the Xbox One controller.
617 * The report format was gleaned from
618 * https://github.com/kylelemons/xbox/blob/master/xbox.go
620 static void xpadone_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
622 struct input_dev *dev = xpad->dev;
624 /* the xbox button has its own special report */
625 if (data[0] == 0X07) {
627 * The Xbox One S controller requires these reports to be
628 * acked otherwise it continues sending them forever and
629 * won't report further mode button events.
632 xpadone_ack_mode_report(xpad, data[2]);
634 input_report_key(dev, BTN_MODE, data[4] & 0x01);
638 /* check invalid packet */
639 else if (data[0] != 0X20)
642 /* menu/view buttons */
643 input_report_key(dev, BTN_START, data[4] & 0x04);
644 input_report_key(dev, BTN_SELECT, data[4] & 0x08);
646 /* buttons A,B,X,Y */
647 input_report_key(dev, BTN_A, data[4] & 0x10);
648 input_report_key(dev, BTN_B, data[4] & 0x20);
649 input_report_key(dev, BTN_X, data[4] & 0x40);
650 input_report_key(dev, BTN_Y, data[4] & 0x80);
653 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
654 /* dpad as buttons (left, right, up, down) */
655 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[5] & 0x04);
656 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[5] & 0x08);
657 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[5] & 0x01);
658 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[5] & 0x02);
660 input_report_abs(dev, ABS_HAT0X,
661 !!(data[5] & 0x08) - !!(data[5] & 0x04));
662 input_report_abs(dev, ABS_HAT0Y,
663 !!(data[5] & 0x02) - !!(data[5] & 0x01));
667 input_report_key(dev, BTN_TL, data[5] & 0x10);
668 input_report_key(dev, BTN_TR, data[5] & 0x20);
670 /* stick press left/right */
671 input_report_key(dev, BTN_THUMBL, data[5] & 0x40);
672 input_report_key(dev, BTN_THUMBR, data[5] & 0x80);
674 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
676 input_report_abs(dev, ABS_X,
677 (__s16) le16_to_cpup((__le16 *)(data + 10)));
678 input_report_abs(dev, ABS_Y,
679 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
682 input_report_abs(dev, ABS_RX,
683 (__s16) le16_to_cpup((__le16 *)(data + 14)));
684 input_report_abs(dev, ABS_RY,
685 ~(__s16) le16_to_cpup((__le16 *)(data + 16)));
688 /* triggers left/right */
689 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
690 input_report_key(dev, BTN_TL2,
691 (__u16) le16_to_cpup((__le16 *)(data + 6)));
692 input_report_key(dev, BTN_TR2,
693 (__u16) le16_to_cpup((__le16 *)(data + 8)));
695 input_report_abs(dev, ABS_Z,
696 (__u16) le16_to_cpup((__le16 *)(data + 6)));
697 input_report_abs(dev, ABS_RZ,
698 (__u16) le16_to_cpup((__le16 *)(data + 8)));
704 static void xpad_irq_in(struct urb *urb)
706 struct usb_xpad *xpad = urb->context;
707 struct device *dev = &xpad->intf->dev;
710 status = urb->status;
719 /* this urb is terminated, clean up */
720 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
724 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
729 switch (xpad->xtype) {
731 xpad360_process_packet(xpad, xpad->dev, 0, xpad->idata);
734 xpad360w_process_packet(xpad, 0, xpad->idata);
737 xpadone_process_packet(xpad, 0, xpad->idata);
740 xpad_process_packet(xpad, 0, xpad->idata);
744 retval = usb_submit_urb(urb, GFP_ATOMIC);
746 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
750 /* Callers must hold xpad->odata_lock spinlock */
751 static bool xpad_prepare_next_out_packet(struct usb_xpad *xpad)
753 struct xpad_output_packet *pkt, *packet = NULL;
756 for (i = 0; i < XPAD_NUM_OUT_PACKETS; i++) {
757 if (++xpad->last_out_packet >= XPAD_NUM_OUT_PACKETS)
758 xpad->last_out_packet = 0;
760 pkt = &xpad->out_packets[xpad->last_out_packet];
762 dev_dbg(&xpad->intf->dev,
763 "%s - found pending output packet %d\n",
764 __func__, xpad->last_out_packet);
771 memcpy(xpad->odata, packet->data, packet->len);
772 xpad->irq_out->transfer_buffer_length = packet->len;
773 packet->pending = false;
780 /* Callers must hold xpad->odata_lock spinlock */
781 static int xpad_try_sending_next_out_packet(struct usb_xpad *xpad)
785 if (!xpad->irq_out_active && xpad_prepare_next_out_packet(xpad)) {
786 usb_anchor_urb(xpad->irq_out, &xpad->irq_out_anchor);
787 error = usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
789 dev_err(&xpad->intf->dev,
790 "%s - usb_submit_urb failed with result %d\n",
792 usb_unanchor_urb(xpad->irq_out);
796 xpad->irq_out_active = true;
802 static void xpad_irq_out(struct urb *urb)
804 struct usb_xpad *xpad = urb->context;
805 struct device *dev = &xpad->intf->dev;
806 int status = urb->status;
810 spin_lock_irqsave(&xpad->odata_lock, flags);
815 xpad->irq_out_active = xpad_prepare_next_out_packet(xpad);
821 /* this urb is terminated, clean up */
822 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
824 xpad->irq_out_active = false;
828 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
833 if (xpad->irq_out_active) {
834 usb_anchor_urb(urb, &xpad->irq_out_anchor);
835 error = usb_submit_urb(urb, GFP_ATOMIC);
838 "%s - usb_submit_urb failed with result %d\n",
840 usb_unanchor_urb(urb);
841 xpad->irq_out_active = false;
845 spin_unlock_irqrestore(&xpad->odata_lock, flags);
848 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad,
849 struct usb_endpoint_descriptor *ep_irq_out)
853 if (xpad->xtype == XTYPE_UNKNOWN)
856 init_usb_anchor(&xpad->irq_out_anchor);
858 xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
859 GFP_KERNEL, &xpad->odata_dma);
863 spin_lock_init(&xpad->odata_lock);
865 xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
866 if (!xpad->irq_out) {
868 goto err_free_coherent;
871 usb_fill_int_urb(xpad->irq_out, xpad->udev,
872 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
873 xpad->odata, XPAD_PKT_LEN,
874 xpad_irq_out, xpad, ep_irq_out->bInterval);
875 xpad->irq_out->transfer_dma = xpad->odata_dma;
876 xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
881 usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
885 static void xpad_stop_output(struct usb_xpad *xpad)
887 if (xpad->xtype != XTYPE_UNKNOWN) {
888 if (!usb_wait_anchor_empty_timeout(&xpad->irq_out_anchor,
890 dev_warn(&xpad->intf->dev,
891 "timed out waiting for output URB to complete, killing\n");
892 usb_kill_anchored_urbs(&xpad->irq_out_anchor);
897 static void xpad_deinit_output(struct usb_xpad *xpad)
899 if (xpad->xtype != XTYPE_UNKNOWN) {
900 usb_free_urb(xpad->irq_out);
901 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
902 xpad->odata, xpad->odata_dma);
906 static int xpad_inquiry_pad_presence(struct usb_xpad *xpad)
908 struct xpad_output_packet *packet =
909 &xpad->out_packets[XPAD_OUT_CMD_IDX];
913 spin_lock_irqsave(&xpad->odata_lock, flags);
915 packet->data[0] = 0x08;
916 packet->data[1] = 0x00;
917 packet->data[2] = 0x0F;
918 packet->data[3] = 0xC0;
919 packet->data[4] = 0x00;
920 packet->data[5] = 0x00;
921 packet->data[6] = 0x00;
922 packet->data[7] = 0x00;
923 packet->data[8] = 0x00;
924 packet->data[9] = 0x00;
925 packet->data[10] = 0x00;
926 packet->data[11] = 0x00;
928 packet->pending = true;
930 /* Reset the sequence so we send out presence first */
931 xpad->last_out_packet = -1;
932 retval = xpad_try_sending_next_out_packet(xpad);
934 spin_unlock_irqrestore(&xpad->odata_lock, flags);
939 static int xpad_start_xbox_one(struct usb_xpad *xpad)
941 struct xpad_output_packet *packet =
942 &xpad->out_packets[XPAD_OUT_CMD_IDX];
946 spin_lock_irqsave(&xpad->odata_lock, flags);
948 /* Xbox one controller needs to be initialized. */
949 packet->data[0] = 0x05;
950 packet->data[1] = 0x20;
951 packet->data[2] = xpad->odata_serial++; /* packet serial */
952 packet->data[3] = 0x01; /* rumble bit enable? */
953 packet->data[4] = 0x00;
955 packet->pending = true;
957 /* Reset the sequence so we send out start packet first */
958 xpad->last_out_packet = -1;
959 retval = xpad_try_sending_next_out_packet(xpad);
961 spin_unlock_irqrestore(&xpad->odata_lock, flags);
966 static void xpadone_ack_mode_report(struct usb_xpad *xpad, u8 seq_num)
969 struct xpad_output_packet *packet =
970 &xpad->out_packets[XPAD_OUT_CMD_IDX];
971 static const u8 mode_report_ack[] = {
972 0x01, 0x20, 0x00, 0x09, 0x00, 0x07, 0x20, 0x02,
973 0x00, 0x00, 0x00, 0x00, 0x00
976 spin_lock_irqsave(&xpad->odata_lock, flags);
978 packet->len = sizeof(mode_report_ack);
979 memcpy(packet->data, mode_report_ack, packet->len);
980 packet->data[2] = seq_num;
981 packet->pending = true;
983 /* Reset the sequence so we send out the ack now */
984 xpad->last_out_packet = -1;
985 xpad_try_sending_next_out_packet(xpad);
987 spin_unlock_irqrestore(&xpad->odata_lock, flags);
990 #ifdef CONFIG_JOYSTICK_XPAD_FF
991 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
993 struct usb_xpad *xpad = input_get_drvdata(dev);
994 struct xpad_output_packet *packet = &xpad->out_packets[XPAD_OUT_FF_IDX];
1000 if (effect->type != FF_RUMBLE)
1003 strong = effect->u.rumble.strong_magnitude;
1004 weak = effect->u.rumble.weak_magnitude;
1006 spin_lock_irqsave(&xpad->odata_lock, flags);
1008 switch (xpad->xtype) {
1010 packet->data[0] = 0x00;
1011 packet->data[1] = 0x06;
1012 packet->data[2] = 0x00;
1013 packet->data[3] = strong / 256; /* left actuator */
1014 packet->data[4] = 0x00;
1015 packet->data[5] = weak / 256; /* right actuator */
1017 packet->pending = true;
1021 packet->data[0] = 0x00;
1022 packet->data[1] = 0x08;
1023 packet->data[2] = 0x00;
1024 packet->data[3] = strong / 256; /* left actuator? */
1025 packet->data[4] = weak / 256; /* right actuator? */
1026 packet->data[5] = 0x00;
1027 packet->data[6] = 0x00;
1028 packet->data[7] = 0x00;
1030 packet->pending = true;
1033 case XTYPE_XBOX360W:
1034 packet->data[0] = 0x00;
1035 packet->data[1] = 0x01;
1036 packet->data[2] = 0x0F;
1037 packet->data[3] = 0xC0;
1038 packet->data[4] = 0x00;
1039 packet->data[5] = strong / 256;
1040 packet->data[6] = weak / 256;
1041 packet->data[7] = 0x00;
1042 packet->data[8] = 0x00;
1043 packet->data[9] = 0x00;
1044 packet->data[10] = 0x00;
1045 packet->data[11] = 0x00;
1047 packet->pending = true;
1051 packet->data[0] = 0x09; /* activate rumble */
1052 packet->data[1] = 0x00;
1053 packet->data[2] = xpad->odata_serial++;
1054 packet->data[3] = 0x09;
1055 packet->data[4] = 0x00;
1056 packet->data[5] = 0x0F;
1057 packet->data[6] = 0x00;
1058 packet->data[7] = 0x00;
1059 packet->data[8] = strong / 512; /* left actuator */
1060 packet->data[9] = weak / 512; /* right actuator */
1061 packet->data[10] = 0xFF; /* on period */
1062 packet->data[11] = 0x00; /* off period */
1063 packet->data[12] = 0xFF; /* repeat count */
1065 packet->pending = true;
1069 dev_dbg(&xpad->dev->dev,
1070 "%s - rumble command sent to unsupported xpad type: %d\n",
1071 __func__, xpad->xtype);
1076 retval = xpad_try_sending_next_out_packet(xpad);
1079 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1083 static int xpad_init_ff(struct usb_xpad *xpad)
1085 if (xpad->xtype == XTYPE_UNKNOWN)
1088 input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
1090 return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
1094 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
1097 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
1098 #include <linux/leds.h>
1099 #include <linux/idr.h>
1101 static DEFINE_IDA(xpad_pad_seq);
1105 struct led_classdev led_cdev;
1106 struct usb_xpad *xpad;
1110 * set the LEDs on Xbox360 / Wireless Controllers
1113 * 1: all blink, then previous setting
1114 * 2: 1/top-left blink, then on
1115 * 3: 2/top-right blink, then on
1116 * 4: 3/bottom-left blink, then on
1117 * 5: 4/bottom-right blink, then on
1120 * 8: 3/bottom-left on
1121 * 9: 4/bottom-right on
1123 * 11: blink, based on previous setting
1124 * 12: slow blink, based on previous setting
1125 * 13: rotate with two lights
1126 * 14: persistent slow all blink
1127 * 15: blink once, then previous setting
1129 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
1131 struct xpad_output_packet *packet =
1132 &xpad->out_packets[XPAD_OUT_LED_IDX];
1133 unsigned long flags;
1137 spin_lock_irqsave(&xpad->odata_lock, flags);
1139 switch (xpad->xtype) {
1141 packet->data[0] = 0x01;
1142 packet->data[1] = 0x03;
1143 packet->data[2] = command;
1145 packet->pending = true;
1148 case XTYPE_XBOX360W:
1149 packet->data[0] = 0x00;
1150 packet->data[1] = 0x00;
1151 packet->data[2] = 0x08;
1152 packet->data[3] = 0x40 + command;
1153 packet->data[4] = 0x00;
1154 packet->data[5] = 0x00;
1155 packet->data[6] = 0x00;
1156 packet->data[7] = 0x00;
1157 packet->data[8] = 0x00;
1158 packet->data[9] = 0x00;
1159 packet->data[10] = 0x00;
1160 packet->data[11] = 0x00;
1162 packet->pending = true;
1166 xpad_try_sending_next_out_packet(xpad);
1168 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1172 * Light up the segment corresponding to the pad number on
1173 * Xbox 360 Controllers.
1175 static void xpad_identify_controller(struct usb_xpad *xpad)
1177 led_set_brightness(&xpad->led->led_cdev, (xpad->pad_nr % 4) + 2);
1180 static void xpad_led_set(struct led_classdev *led_cdev,
1181 enum led_brightness value)
1183 struct xpad_led *xpad_led = container_of(led_cdev,
1184 struct xpad_led, led_cdev);
1186 xpad_send_led_command(xpad_led->xpad, value);
1189 static int xpad_led_probe(struct usb_xpad *xpad)
1191 struct xpad_led *led;
1192 struct led_classdev *led_cdev;
1195 if (xpad->xtype != XTYPE_XBOX360 && xpad->xtype != XTYPE_XBOX360W)
1198 xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
1202 xpad->pad_nr = ida_simple_get(&xpad_pad_seq, 0, 0, GFP_KERNEL);
1203 if (xpad->pad_nr < 0) {
1204 error = xpad->pad_nr;
1208 snprintf(led->name, sizeof(led->name), "xpad%d", xpad->pad_nr);
1211 led_cdev = &led->led_cdev;
1212 led_cdev->name = led->name;
1213 led_cdev->brightness_set = xpad_led_set;
1214 led_cdev->flags = LED_CORE_SUSPENDRESUME;
1216 error = led_classdev_register(&xpad->udev->dev, led_cdev);
1220 xpad_identify_controller(xpad);
1225 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1232 static void xpad_led_disconnect(struct usb_xpad *xpad)
1234 struct xpad_led *xpad_led = xpad->led;
1237 led_classdev_unregister(&xpad_led->led_cdev);
1238 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1243 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
1244 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
1247 static int xpad_start_input(struct usb_xpad *xpad)
1251 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
1254 if (xpad->xtype == XTYPE_XBOXONE) {
1255 error = xpad_start_xbox_one(xpad);
1257 usb_kill_urb(xpad->irq_in);
1265 static void xpad_stop_input(struct usb_xpad *xpad)
1267 usb_kill_urb(xpad->irq_in);
1270 static void xpad360w_poweroff_controller(struct usb_xpad *xpad)
1272 unsigned long flags;
1273 struct xpad_output_packet *packet =
1274 &xpad->out_packets[XPAD_OUT_CMD_IDX];
1276 spin_lock_irqsave(&xpad->odata_lock, flags);
1278 packet->data[0] = 0x00;
1279 packet->data[1] = 0x00;
1280 packet->data[2] = 0x08;
1281 packet->data[3] = 0xC0;
1282 packet->data[4] = 0x00;
1283 packet->data[5] = 0x00;
1284 packet->data[6] = 0x00;
1285 packet->data[7] = 0x00;
1286 packet->data[8] = 0x00;
1287 packet->data[9] = 0x00;
1288 packet->data[10] = 0x00;
1289 packet->data[11] = 0x00;
1291 packet->pending = true;
1293 /* Reset the sequence so we send out poweroff now */
1294 xpad->last_out_packet = -1;
1295 xpad_try_sending_next_out_packet(xpad);
1297 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1300 static int xpad360w_start_input(struct usb_xpad *xpad)
1304 error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1309 * Send presence packet.
1310 * This will force the controller to resend connection packets.
1311 * This is useful in the case we activate the module after the
1312 * adapter has been plugged in, as it won't automatically
1313 * send us info about the controllers.
1315 error = xpad_inquiry_pad_presence(xpad);
1317 usb_kill_urb(xpad->irq_in);
1324 static void xpad360w_stop_input(struct usb_xpad *xpad)
1326 usb_kill_urb(xpad->irq_in);
1328 /* Make sure we are done with presence work if it was scheduled */
1329 flush_work(&xpad->work);
1332 static int xpad_open(struct input_dev *dev)
1334 struct usb_xpad *xpad = input_get_drvdata(dev);
1336 return xpad_start_input(xpad);
1339 static void xpad_close(struct input_dev *dev)
1341 struct usb_xpad *xpad = input_get_drvdata(dev);
1343 xpad_stop_input(xpad);
1346 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
1348 struct usb_xpad *xpad = input_get_drvdata(input_dev);
1349 set_bit(abs, input_dev->absbit);
1355 case ABS_RY: /* the two sticks */
1356 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
1359 case ABS_RZ: /* the triggers (if mapped to axes) */
1360 if (xpad->xtype == XTYPE_XBOXONE)
1361 input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
1363 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
1366 case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
1367 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
1372 static void xpad_deinit_input(struct usb_xpad *xpad)
1374 if (xpad->input_created) {
1375 xpad->input_created = false;
1376 xpad_led_disconnect(xpad);
1377 input_unregister_device(xpad->dev);
1381 static int xpad_init_input(struct usb_xpad *xpad)
1383 struct input_dev *input_dev;
1386 input_dev = input_allocate_device();
1390 xpad->dev = input_dev;
1391 input_dev->name = xpad->name;
1392 input_dev->phys = xpad->phys;
1393 usb_to_input_id(xpad->udev, &input_dev->id);
1395 if (xpad->xtype == XTYPE_XBOX360W) {
1396 /* x360w controllers and the receiver have different ids */
1397 input_dev->id.product = 0x02a1;
1400 input_dev->dev.parent = &xpad->intf->dev;
1402 input_set_drvdata(input_dev, xpad);
1404 if (xpad->xtype != XTYPE_XBOX360W) {
1405 input_dev->open = xpad_open;
1406 input_dev->close = xpad_close;
1409 __set_bit(EV_KEY, input_dev->evbit);
1411 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1412 __set_bit(EV_ABS, input_dev->evbit);
1414 for (i = 0; xpad_abs[i] >= 0; i++)
1415 xpad_set_up_abs(input_dev, xpad_abs[i]);
1418 /* set up standard buttons */
1419 for (i = 0; xpad_common_btn[i] >= 0; i++)
1420 __set_bit(xpad_common_btn[i], input_dev->keybit);
1422 /* set up model-specific ones */
1423 if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1424 xpad->xtype == XTYPE_XBOXONE) {
1425 for (i = 0; xpad360_btn[i] >= 0; i++)
1426 __set_bit(xpad360_btn[i], input_dev->keybit);
1428 for (i = 0; xpad_btn[i] >= 0; i++)
1429 __set_bit(xpad_btn[i], input_dev->keybit);
1432 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1433 for (i = 0; xpad_btn_pad[i] >= 0; i++)
1434 __set_bit(xpad_btn_pad[i], input_dev->keybit);
1438 * This should be a simple else block. However historically
1439 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
1440 * made no sense, but now we can not just switch back and have to
1441 * support both behaviors.
1443 if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
1444 xpad->xtype == XTYPE_XBOX360W) {
1445 for (i = 0; xpad_abs_pad[i] >= 0; i++)
1446 xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
1449 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1450 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
1451 __set_bit(xpad_btn_triggers[i], input_dev->keybit);
1453 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
1454 xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
1457 error = xpad_init_ff(xpad);
1459 goto err_free_input;
1461 error = xpad_led_probe(xpad);
1463 goto err_destroy_ff;
1465 error = input_register_device(xpad->dev);
1467 goto err_disconnect_led;
1469 xpad->input_created = true;
1473 xpad_led_disconnect(xpad);
1475 input_ff_destroy(input_dev);
1477 input_free_device(input_dev);
1481 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
1483 struct usb_device *udev = interface_to_usbdev(intf);
1484 struct usb_xpad *xpad;
1485 struct usb_endpoint_descriptor *ep_irq_in, *ep_irq_out;
1488 if (intf->cur_altsetting->desc.bNumEndpoints != 2)
1491 for (i = 0; xpad_device[i].idVendor; i++) {
1492 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
1493 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
1497 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
1501 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
1502 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
1504 xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
1505 GFP_KERNEL, &xpad->idata_dma);
1511 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
1512 if (!xpad->irq_in) {
1514 goto err_free_idata;
1519 xpad->mapping = xpad_device[i].mapping;
1520 xpad->xtype = xpad_device[i].xtype;
1521 xpad->name = xpad_device[i].name;
1522 INIT_WORK(&xpad->work, xpad_presence_work);
1524 if (xpad->xtype == XTYPE_UNKNOWN) {
1525 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
1526 if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
1527 xpad->xtype = XTYPE_XBOX360W;
1528 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 208)
1529 xpad->xtype = XTYPE_XBOXONE;
1531 xpad->xtype = XTYPE_XBOX360;
1533 xpad->xtype = XTYPE_XBOX;
1536 if (dpad_to_buttons)
1537 xpad->mapping |= MAP_DPAD_TO_BUTTONS;
1538 if (triggers_to_buttons)
1539 xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
1541 xpad->mapping |= MAP_STICKS_TO_NULL;
1544 if (xpad->xtype == XTYPE_XBOXONE &&
1545 intf->cur_altsetting->desc.bInterfaceNumber != 0) {
1547 * The Xbox One controller lists three interfaces all with the
1548 * same interface class, subclass and protocol. Differentiate by
1552 goto err_free_in_urb;
1555 ep_irq_in = ep_irq_out = NULL;
1557 for (i = 0; i < 2; i++) {
1558 struct usb_endpoint_descriptor *ep =
1559 &intf->cur_altsetting->endpoint[i].desc;
1561 if (usb_endpoint_dir_in(ep))
1567 if (!ep_irq_in || !ep_irq_out) {
1569 goto err_free_in_urb;
1572 error = xpad_init_output(intf, xpad, ep_irq_out);
1574 goto err_free_in_urb;
1576 usb_fill_int_urb(xpad->irq_in, udev,
1577 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
1578 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
1579 xpad, ep_irq_in->bInterval);
1580 xpad->irq_in->transfer_dma = xpad->idata_dma;
1581 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1583 usb_set_intfdata(intf, xpad);
1585 if (xpad->xtype == XTYPE_XBOX360W) {
1587 * Submit the int URB immediately rather than waiting for open
1588 * because we get status messages from the device whether
1589 * or not any controllers are attached. In fact, it's
1590 * exactly the message that a controller has arrived that
1591 * we're waiting for.
1593 error = xpad360w_start_input(xpad);
1595 goto err_deinit_output;
1597 * Wireless controllers require RESET_RESUME to work properly
1598 * after suspend. Ideally this quirk should be in usb core
1599 * quirk list, but we have too many vendors producing these
1600 * controllers and we'd need to maintain 2 identical lists
1601 * here in this driver and in usb core.
1603 udev->quirks |= USB_QUIRK_RESET_RESUME;
1605 error = xpad_init_input(xpad);
1607 goto err_deinit_output;
1612 xpad_deinit_output(xpad);
1614 usb_free_urb(xpad->irq_in);
1616 usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1622 static void xpad_disconnect(struct usb_interface *intf)
1624 struct usb_xpad *xpad = usb_get_intfdata(intf);
1626 if (xpad->xtype == XTYPE_XBOX360W)
1627 xpad360w_stop_input(xpad);
1629 xpad_deinit_input(xpad);
1632 * Now that both input device and LED device are gone we can
1635 xpad_stop_output(xpad);
1637 xpad_deinit_output(xpad);
1639 usb_free_urb(xpad->irq_in);
1640 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1641 xpad->idata, xpad->idata_dma);
1645 usb_set_intfdata(intf, NULL);
1648 static int xpad_suspend(struct usb_interface *intf, pm_message_t message)
1650 struct usb_xpad *xpad = usb_get_intfdata(intf);
1651 struct input_dev *input = xpad->dev;
1653 if (xpad->xtype == XTYPE_XBOX360W) {
1655 * Wireless controllers always listen to input so
1656 * they are notified when controller shows up
1659 xpad360w_stop_input(xpad);
1662 * The wireless adapter is going off now, so the
1663 * gamepads are going to become disconnected.
1664 * Unless explicitly disabled, power them down
1665 * so they don't just sit there flashing.
1667 if (auto_poweroff && xpad->pad_present)
1668 xpad360w_poweroff_controller(xpad);
1670 mutex_lock(&input->mutex);
1672 xpad_stop_input(xpad);
1673 mutex_unlock(&input->mutex);
1676 xpad_stop_output(xpad);
1681 static int xpad_resume(struct usb_interface *intf)
1683 struct usb_xpad *xpad = usb_get_intfdata(intf);
1684 struct input_dev *input = xpad->dev;
1687 if (xpad->xtype == XTYPE_XBOX360W) {
1688 retval = xpad360w_start_input(xpad);
1690 mutex_lock(&input->mutex);
1692 retval = xpad_start_input(xpad);
1693 } else if (xpad->xtype == XTYPE_XBOXONE) {
1695 * Even if there are no users, we'll send Xbox One pads
1696 * the startup sequence so they don't sit there and
1697 * blink until somebody opens the input device again.
1699 retval = xpad_start_xbox_one(xpad);
1701 mutex_unlock(&input->mutex);
1707 static struct usb_driver xpad_driver = {
1709 .probe = xpad_probe,
1710 .disconnect = xpad_disconnect,
1711 .suspend = xpad_suspend,
1712 .resume = xpad_resume,
1713 .reset_resume = xpad_resume,
1714 .id_table = xpad_table,
1717 module_usb_driver(xpad_driver);
1719 MODULE_AUTHOR(DRIVER_AUTHOR);
1720 MODULE_DESCRIPTION(DRIVER_DESC);
1721 MODULE_LICENSE("GPL");