Merge branch 'perf-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[cris-mirror.git] / drivers / input / joystick / xpad.c
blob83af17ad0f1f131d6d397e3df2e15521d0c24b55
1 /*
2 * X-Box gamepad driver
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
36 * Thanks to:
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
43 * TODO:
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
49 * History:
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
58 * - indentation fixes
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)
100 #define XTYPE_XBOX 0
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 {
123 u16 idVendor;
124 u16 idProduct;
125 char *name;
126 u8 mapping;
127 u8 xtype;
128 } 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, 0x0291, "Xbox 360 Wireless Receiver (XBOX)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
138 { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
139 { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
140 { 0x044f, 0xb326, "Thrustmaster Gamepad GP XID", 0, XTYPE_XBOX360 },
141 { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
142 { 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
143 { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },
144 { 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
145 { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
146 { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
147 { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
148 { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
149 { 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
150 { 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
151 { 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
152 { 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
153 { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
154 { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
155 { 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
156 { 0x0738, 0x4718, "Mad Catz Street Fighter IV FightStick SE", 0, XTYPE_XBOX360 },
157 { 0x0738, 0x4726, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
158 { 0x0738, 0x4728, "Mad Catz Street Fighter IV FightPad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
159 { 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
160 { 0x0738, 0x4740, "Mad Catz Beat Pad", 0, XTYPE_XBOX360 },
161 { 0x0738, 0x4a01, "Mad Catz FightStick TE 2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
162 { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
163 { 0x0738, 0xb726, "Mad Catz Xbox controller - MW2", 0, XTYPE_XBOX360 },
164 { 0x0738, 0xbeef, "Mad Catz JOYTECH NEO SE Advanced GamePad", XTYPE_XBOX360 },
165 { 0x0738, 0xcb02, "Saitek Cyborg Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
166 { 0x0738, 0xcb03, "Saitek P3200 Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
167 { 0x0738, 0xf738, "Super SFIV FightStick TE S", 0, XTYPE_XBOX360 },
168 { 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
169 { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
170 { 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
171 { 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
172 { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
173 { 0x0d2f, 0x0002, "Andamiro Pump It Up pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
174 { 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
175 { 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
176 { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
177 { 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
178 { 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
179 { 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
180 { 0x0e6f, 0x0113, "Afterglow AX.1 Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
181 { 0x0e6f, 0x0139, "Afterglow Prismatic Wired Controller", 0, XTYPE_XBOXONE },
182 { 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
183 { 0x0e6f, 0x0213, "Afterglow Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
184 { 0x0e6f, 0x021f, "Rock Candy Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
185 { 0x0e6f, 0x0146, "Rock Candy Wired Controller for Xbox One", 0, XTYPE_XBOXONE },
186 { 0x0e6f, 0x0301, "Logic3 Controller", 0, XTYPE_XBOX360 },
187 { 0x0e6f, 0x0401, "Logic3 Controller", 0, XTYPE_XBOX360 },
188 { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
189 { 0x0e8f, 0x3008, "Generic xbox control (dealextreme)", 0, XTYPE_XBOX },
190 { 0x0f0d, 0x000a, "Hori Co. DOA4 FightStick", 0, XTYPE_XBOX360 },
191 { 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
192 { 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
193 { 0x0f0d, 0x0067, "HORIPAD ONE", 0, XTYPE_XBOXONE },
194 { 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
195 { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
196 { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
197 { 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
198 { 0x12ab, 0x0301, "PDP AFTERGLOW AX.1", 0, XTYPE_XBOX360 },
199 { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
200 { 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
201 { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
202 { 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
203 { 0x1532, 0x0037, "Razer Sabertooth", 0, XTYPE_XBOX360 },
204 { 0x15e4, 0x3f00, "Power A Mini Pro Elite", 0, XTYPE_XBOX360 },
205 { 0x15e4, 0x3f0a, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
206 { 0x15e4, 0x3f10, "Batarang Xbox 360 controller", 0, XTYPE_XBOX360 },
207 { 0x162e, 0xbeef, "Joytech Neo-Se Take2", 0, XTYPE_XBOX360 },
208 { 0x1689, 0xfd00, "Razer Onza Tournament Edition", 0, XTYPE_XBOX360 },
209 { 0x1689, 0xfd01, "Razer Onza Classic Edition", 0, XTYPE_XBOX360 },
210 { 0x24c6, 0x542a, "Xbox ONE spectra", 0, XTYPE_XBOXONE },
211 { 0x24c6, 0x5d04, "Razer Sabertooth", 0, XTYPE_XBOX360 },
212 { 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
213 { 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
214 { 0x1bad, 0xf016, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
215 { 0x1bad, 0xf023, "MLG Pro Circuit Controller (Xbox)", 0, XTYPE_XBOX360 },
216 { 0x1bad, 0xf028, "Street Fighter IV FightPad", 0, XTYPE_XBOX360 },
217 { 0x1bad, 0xf038, "Street Fighter IV FightStick TE", 0, XTYPE_XBOX360 },
218 { 0x1bad, 0xf900, "Harmonix Xbox 360 Controller", 0, XTYPE_XBOX360 },
219 { 0x1bad, 0xf901, "Gamestop Xbox 360 Controller", 0, XTYPE_XBOX360 },
220 { 0x1bad, 0xf903, "Tron Xbox 360 controller", 0, XTYPE_XBOX360 },
221 { 0x24c6, 0x5000, "Razer Atrox Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
222 { 0x24c6, 0x5300, "PowerA MINI PROEX Controller", 0, XTYPE_XBOX360 },
223 { 0x24c6, 0x5303, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
224 { 0x24c6, 0x541a, "PowerA Xbox One Mini Wired Controller", 0, XTYPE_XBOXONE },
225 { 0x24c6, 0x543a, "PowerA Xbox One wired controller", 0, XTYPE_XBOXONE },
226 { 0x24c6, 0x5500, "Hori XBOX 360 EX 2 with Turbo", 0, XTYPE_XBOX360 },
227 { 0x24c6, 0x5501, "Hori Real Arcade Pro VX-SA", 0, XTYPE_XBOX360 },
228 { 0x24c6, 0x5506, "Hori SOULCALIBUR V Stick", 0, XTYPE_XBOX360 },
229 { 0x24c6, 0x5b02, "Thrustmaster, Inc. GPX Controller", 0, XTYPE_XBOX360 },
230 { 0x24c6, 0x5b03, "Thrustmaster Ferrari 458 Racing Wheel", 0, XTYPE_XBOX360 },
231 { 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
232 { 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
235 /* buttons shared with xbox and xbox360 */
236 static const signed short xpad_common_btn[] = {
237 BTN_A, BTN_B, BTN_X, BTN_Y, /* "analog" buttons */
238 BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR, /* start/back/sticks */
239 -1 /* terminating entry */
242 /* original xbox controllers only */
243 static const signed short xpad_btn[] = {
244 BTN_C, BTN_Z, /* "analog" buttons */
245 -1 /* terminating entry */
248 /* used when dpad is mapped to buttons */
249 static const signed short xpad_btn_pad[] = {
250 BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2, /* d-pad left, right */
251 BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4, /* d-pad up, down */
252 -1 /* terminating entry */
255 /* used when triggers are mapped to buttons */
256 static const signed short xpad_btn_triggers[] = {
257 BTN_TL2, BTN_TR2, /* triggers left/right */
261 static const signed short xpad360_btn[] = { /* buttons for x360 controller */
262 BTN_TL, BTN_TR, /* Button LB/RB */
263 BTN_MODE, /* The big X button */
267 static const signed short xpad_abs[] = {
268 ABS_X, ABS_Y, /* left stick */
269 ABS_RX, ABS_RY, /* right stick */
270 -1 /* terminating entry */
273 /* used when dpad is mapped to axes */
274 static const signed short xpad_abs_pad[] = {
275 ABS_HAT0X, ABS_HAT0Y, /* d-pad axes */
276 -1 /* terminating entry */
279 /* used when triggers are mapped to axes */
280 static const signed short xpad_abs_triggers[] = {
281 ABS_Z, ABS_RZ, /* triggers left/right */
286 * Xbox 360 has a vendor-specific class, so we cannot match it with only
287 * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
288 * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
289 * wireless controllers have protocol 129.
291 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
292 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
293 .idVendor = (vend), \
294 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
295 .bInterfaceSubClass = 93, \
296 .bInterfaceProtocol = (pr)
297 #define XPAD_XBOX360_VENDOR(vend) \
298 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
299 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
301 /* The Xbox One controller uses subclass 71 and protocol 208. */
302 #define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
303 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
304 .idVendor = (vend), \
305 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
306 .bInterfaceSubClass = 71, \
307 .bInterfaceProtocol = (pr)
308 #define XPAD_XBOXONE_VENDOR(vend) \
309 { XPAD_XBOXONE_VENDOR_PROTOCOL(vend, 208) }
311 static struct usb_device_id xpad_table[] = {
312 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
313 XPAD_XBOX360_VENDOR(0x044f), /* Thrustmaster X-Box 360 controllers */
314 XPAD_XBOX360_VENDOR(0x045e), /* Microsoft X-Box 360 controllers */
315 XPAD_XBOXONE_VENDOR(0x045e), /* Microsoft X-Box One controllers */
316 XPAD_XBOX360_VENDOR(0x046d), /* Logitech X-Box 360 style controllers */
317 XPAD_XBOX360_VENDOR(0x0738), /* Mad Catz X-Box 360 controllers */
318 { USB_DEVICE(0x0738, 0x4540) }, /* Mad Catz Beat Pad */
319 XPAD_XBOXONE_VENDOR(0x0738), /* Mad Catz FightStick TE 2 */
320 XPAD_XBOX360_VENDOR(0x0e6f), /* 0x0e6f X-Box 360 controllers */
321 XPAD_XBOXONE_VENDOR(0x0e6f), /* 0x0e6f X-Box One controllers */
322 XPAD_XBOX360_VENDOR(0x12ab), /* X-Box 360 dance pads */
323 XPAD_XBOX360_VENDOR(0x1430), /* RedOctane X-Box 360 controllers */
324 XPAD_XBOX360_VENDOR(0x146b), /* BigBen Interactive Controllers */
325 XPAD_XBOX360_VENDOR(0x1bad), /* Harminix Rock Band Guitar and Drums */
326 XPAD_XBOX360_VENDOR(0x0f0d), /* Hori Controllers */
327 XPAD_XBOXONE_VENDOR(0x0f0d), /* Hori Controllers */
328 XPAD_XBOX360_VENDOR(0x1689), /* Razer Onza */
329 XPAD_XBOX360_VENDOR(0x24c6), /* PowerA Controllers */
330 XPAD_XBOXONE_VENDOR(0x24c6), /* PowerA Controllers */
331 XPAD_XBOX360_VENDOR(0x1532), /* Razer Sabertooth */
332 XPAD_XBOX360_VENDOR(0x15e4), /* Numark X-Box 360 controllers */
333 XPAD_XBOX360_VENDOR(0x162e), /* Joytech X-Box 360 controllers */
337 MODULE_DEVICE_TABLE(usb, xpad_table);
339 struct xpad_output_packet {
340 u8 data[XPAD_PKT_LEN];
341 u8 len;
342 bool pending;
345 #define XPAD_OUT_CMD_IDX 0
346 #define XPAD_OUT_FF_IDX 1
347 #define XPAD_OUT_LED_IDX (1 + IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF))
348 #define XPAD_NUM_OUT_PACKETS (1 + \
349 IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF) + \
350 IS_ENABLED(CONFIG_JOYSTICK_XPAD_LEDS))
352 struct usb_xpad {
353 struct input_dev *dev; /* input device interface */
354 struct input_dev __rcu *x360w_dev;
355 struct usb_device *udev; /* usb device */
356 struct usb_interface *intf; /* usb interface */
358 bool pad_present;
359 bool input_created;
361 struct urb *irq_in; /* urb for interrupt in report */
362 unsigned char *idata; /* input data */
363 dma_addr_t idata_dma;
365 struct urb *irq_out; /* urb for interrupt out report */
366 struct usb_anchor irq_out_anchor;
367 bool irq_out_active; /* we must not use an active URB */
368 u8 odata_serial; /* serial number for xbox one protocol */
369 unsigned char *odata; /* output data */
370 dma_addr_t odata_dma;
371 spinlock_t odata_lock;
373 struct xpad_output_packet out_packets[XPAD_NUM_OUT_PACKETS];
374 int last_out_packet;
376 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
377 struct xpad_led *led;
378 #endif
380 char phys[64]; /* physical device path */
382 int mapping; /* map d-pad to buttons or to axes */
383 int xtype; /* type of xbox device */
384 int pad_nr; /* the order x360 pads were attached */
385 const char *name; /* name of the device */
386 struct work_struct work; /* init/remove device from callback */
389 static int xpad_init_input(struct usb_xpad *xpad);
390 static void xpad_deinit_input(struct usb_xpad *xpad);
393 * xpad_process_packet
395 * Completes a request by converting the data into events for the
396 * input subsystem.
398 * The used report descriptor was taken from ITO Takayukis website:
399 * http://euc.jp/periphs/xbox-controller.ja.html
401 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
403 struct input_dev *dev = xpad->dev;
405 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
406 /* left stick */
407 input_report_abs(dev, ABS_X,
408 (__s16) le16_to_cpup((__le16 *)(data + 12)));
409 input_report_abs(dev, ABS_Y,
410 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
412 /* right stick */
413 input_report_abs(dev, ABS_RX,
414 (__s16) le16_to_cpup((__le16 *)(data + 16)));
415 input_report_abs(dev, ABS_RY,
416 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
419 /* triggers left/right */
420 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
421 input_report_key(dev, BTN_TL2, data[10]);
422 input_report_key(dev, BTN_TR2, data[11]);
423 } else {
424 input_report_abs(dev, ABS_Z, data[10]);
425 input_report_abs(dev, ABS_RZ, data[11]);
428 /* digital pad */
429 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
430 /* dpad as buttons (left, right, up, down) */
431 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
432 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
433 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
434 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
435 } else {
436 input_report_abs(dev, ABS_HAT0X,
437 !!(data[2] & 0x08) - !!(data[2] & 0x04));
438 input_report_abs(dev, ABS_HAT0Y,
439 !!(data[2] & 0x02) - !!(data[2] & 0x01));
442 /* start/back buttons and stick press left/right */
443 input_report_key(dev, BTN_START, data[2] & 0x10);
444 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
445 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
446 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
448 /* "analog" buttons A, B, X, Y */
449 input_report_key(dev, BTN_A, data[4]);
450 input_report_key(dev, BTN_B, data[5]);
451 input_report_key(dev, BTN_X, data[6]);
452 input_report_key(dev, BTN_Y, data[7]);
454 /* "analog" buttons black, white */
455 input_report_key(dev, BTN_C, data[8]);
456 input_report_key(dev, BTN_Z, data[9]);
458 input_sync(dev);
462 * xpad360_process_packet
464 * Completes a request by converting the data into events for the
465 * input subsystem. It is version for xbox 360 controller
467 * The used report descriptor was taken from:
468 * http://www.free60.org/wiki/Gamepad
471 static void xpad360_process_packet(struct usb_xpad *xpad, struct input_dev *dev,
472 u16 cmd, unsigned char *data)
474 /* valid pad data */
475 if (data[0] != 0x00)
476 return;
478 /* digital pad */
479 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
480 /* dpad as buttons (left, right, up, down) */
481 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
482 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
483 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
484 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
488 * This should be a simple else block. However historically
489 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
490 * made no sense, but now we can not just switch back and have to
491 * support both behaviors.
493 if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
494 xpad->xtype == XTYPE_XBOX360W) {
495 input_report_abs(dev, ABS_HAT0X,
496 !!(data[2] & 0x08) - !!(data[2] & 0x04));
497 input_report_abs(dev, ABS_HAT0Y,
498 !!(data[2] & 0x02) - !!(data[2] & 0x01));
501 /* start/back buttons */
502 input_report_key(dev, BTN_START, data[2] & 0x10);
503 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
505 /* stick press left/right */
506 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
507 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
509 /* buttons A,B,X,Y,TL,TR and MODE */
510 input_report_key(dev, BTN_A, data[3] & 0x10);
511 input_report_key(dev, BTN_B, data[3] & 0x20);
512 input_report_key(dev, BTN_X, data[3] & 0x40);
513 input_report_key(dev, BTN_Y, data[3] & 0x80);
514 input_report_key(dev, BTN_TL, data[3] & 0x01);
515 input_report_key(dev, BTN_TR, data[3] & 0x02);
516 input_report_key(dev, BTN_MODE, data[3] & 0x04);
518 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
519 /* left stick */
520 input_report_abs(dev, ABS_X,
521 (__s16) le16_to_cpup((__le16 *)(data + 6)));
522 input_report_abs(dev, ABS_Y,
523 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
525 /* right stick */
526 input_report_abs(dev, ABS_RX,
527 (__s16) le16_to_cpup((__le16 *)(data + 10)));
528 input_report_abs(dev, ABS_RY,
529 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
532 /* triggers left/right */
533 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
534 input_report_key(dev, BTN_TL2, data[4]);
535 input_report_key(dev, BTN_TR2, data[5]);
536 } else {
537 input_report_abs(dev, ABS_Z, data[4]);
538 input_report_abs(dev, ABS_RZ, data[5]);
541 input_sync(dev);
544 static void xpad_presence_work(struct work_struct *work)
546 struct usb_xpad *xpad = container_of(work, struct usb_xpad, work);
547 int error;
549 if (xpad->pad_present) {
550 error = xpad_init_input(xpad);
551 if (error) {
552 /* complain only, not much else we can do here */
553 dev_err(&xpad->dev->dev,
554 "unable to init device: %d\n", error);
555 } else {
556 rcu_assign_pointer(xpad->x360w_dev, xpad->dev);
558 } else {
559 RCU_INIT_POINTER(xpad->x360w_dev, NULL);
560 synchronize_rcu();
562 * Now that we are sure xpad360w_process_packet is not
563 * using input device we can get rid of it.
565 xpad_deinit_input(xpad);
570 * xpad360w_process_packet
572 * Completes a request by converting the data into events for the
573 * input subsystem. It is version for xbox 360 wireless controller.
575 * Byte.Bit
576 * 00.1 - Status change: The controller or headset has connected/disconnected
577 * Bits 01.7 and 01.6 are valid
578 * 01.7 - Controller present
579 * 01.6 - Headset present
580 * 01.1 - Pad state (Bytes 4+) valid
583 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
585 struct input_dev *dev;
586 bool present;
588 /* Presence change */
589 if (data[0] & 0x08) {
590 present = (data[1] & 0x80) != 0;
592 if (xpad->pad_present != present) {
593 xpad->pad_present = present;
594 schedule_work(&xpad->work);
598 /* Valid pad data */
599 if (data[1] != 0x1)
600 return;
602 rcu_read_lock();
603 dev = rcu_dereference(xpad->x360w_dev);
604 if (dev)
605 xpad360_process_packet(xpad, dev, cmd, &data[4]);
606 rcu_read_unlock();
610 * xpadone_process_buttons
612 * Process a button update packet from an Xbox one controller.
614 static void xpadone_process_buttons(struct usb_xpad *xpad,
615 struct input_dev *dev,
616 unsigned char *data)
618 /* menu/view buttons */
619 input_report_key(dev, BTN_START, data[4] & 0x04);
620 input_report_key(dev, BTN_SELECT, data[4] & 0x08);
622 /* buttons A,B,X,Y */
623 input_report_key(dev, BTN_A, data[4] & 0x10);
624 input_report_key(dev, BTN_B, data[4] & 0x20);
625 input_report_key(dev, BTN_X, data[4] & 0x40);
626 input_report_key(dev, BTN_Y, data[4] & 0x80);
628 /* digital pad */
629 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
630 /* dpad as buttons (left, right, up, down) */
631 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[5] & 0x04);
632 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[5] & 0x08);
633 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[5] & 0x01);
634 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[5] & 0x02);
635 } else {
636 input_report_abs(dev, ABS_HAT0X,
637 !!(data[5] & 0x08) - !!(data[5] & 0x04));
638 input_report_abs(dev, ABS_HAT0Y,
639 !!(data[5] & 0x02) - !!(data[5] & 0x01));
642 /* TL/TR */
643 input_report_key(dev, BTN_TL, data[5] & 0x10);
644 input_report_key(dev, BTN_TR, data[5] & 0x20);
646 /* stick press left/right */
647 input_report_key(dev, BTN_THUMBL, data[5] & 0x40);
648 input_report_key(dev, BTN_THUMBR, data[5] & 0x80);
650 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
651 /* left stick */
652 input_report_abs(dev, ABS_X,
653 (__s16) le16_to_cpup((__le16 *)(data + 10)));
654 input_report_abs(dev, ABS_Y,
655 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
657 /* right stick */
658 input_report_abs(dev, ABS_RX,
659 (__s16) le16_to_cpup((__le16 *)(data + 14)));
660 input_report_abs(dev, ABS_RY,
661 ~(__s16) le16_to_cpup((__le16 *)(data + 16)));
664 /* triggers left/right */
665 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
666 input_report_key(dev, BTN_TL2,
667 (__u16) le16_to_cpup((__le16 *)(data + 6)));
668 input_report_key(dev, BTN_TR2,
669 (__u16) le16_to_cpup((__le16 *)(data + 8)));
670 } else {
671 input_report_abs(dev, ABS_Z,
672 (__u16) le16_to_cpup((__le16 *)(data + 6)));
673 input_report_abs(dev, ABS_RZ,
674 (__u16) le16_to_cpup((__le16 *)(data + 8)));
677 input_sync(dev);
681 * xpadone_process_packet
683 * Completes a request by converting the data into events for the
684 * input subsystem. This version is for the Xbox One controller.
686 * The report format was gleaned from
687 * https://github.com/kylelemons/xbox/blob/master/xbox.go
690 static void xpadone_process_packet(struct usb_xpad *xpad,
691 u16 cmd, unsigned char *data)
693 struct input_dev *dev = xpad->dev;
695 switch (data[0]) {
696 case 0x20:
697 xpadone_process_buttons(xpad, dev, data);
698 break;
700 case 0x07:
701 /* the xbox button has its own special report */
702 input_report_key(dev, BTN_MODE, data[4] & 0x01);
703 input_sync(dev);
704 break;
708 static void xpad_irq_in(struct urb *urb)
710 struct usb_xpad *xpad = urb->context;
711 struct device *dev = &xpad->intf->dev;
712 int retval, status;
714 status = urb->status;
716 switch (status) {
717 case 0:
718 /* success */
719 break;
720 case -ECONNRESET:
721 case -ENOENT:
722 case -ESHUTDOWN:
723 /* this urb is terminated, clean up */
724 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
725 __func__, status);
726 return;
727 default:
728 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
729 __func__, status);
730 goto exit;
733 switch (xpad->xtype) {
734 case XTYPE_XBOX360:
735 xpad360_process_packet(xpad, xpad->dev, 0, xpad->idata);
736 break;
737 case XTYPE_XBOX360W:
738 xpad360w_process_packet(xpad, 0, xpad->idata);
739 break;
740 case XTYPE_XBOXONE:
741 xpadone_process_packet(xpad, 0, xpad->idata);
742 break;
743 default:
744 xpad_process_packet(xpad, 0, xpad->idata);
747 exit:
748 retval = usb_submit_urb(urb, GFP_ATOMIC);
749 if (retval)
750 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
751 __func__, retval);
754 /* Callers must hold xpad->odata_lock spinlock */
755 static bool xpad_prepare_next_out_packet(struct usb_xpad *xpad)
757 struct xpad_output_packet *pkt, *packet = NULL;
758 int i;
760 for (i = 0; i < XPAD_NUM_OUT_PACKETS; i++) {
761 if (++xpad->last_out_packet >= XPAD_NUM_OUT_PACKETS)
762 xpad->last_out_packet = 0;
764 pkt = &xpad->out_packets[xpad->last_out_packet];
765 if (pkt->pending) {
766 dev_dbg(&xpad->intf->dev,
767 "%s - found pending output packet %d\n",
768 __func__, xpad->last_out_packet);
769 packet = pkt;
770 break;
774 if (packet) {
775 memcpy(xpad->odata, packet->data, packet->len);
776 xpad->irq_out->transfer_buffer_length = packet->len;
777 packet->pending = false;
778 return true;
781 return false;
784 /* Callers must hold xpad->odata_lock spinlock */
785 static int xpad_try_sending_next_out_packet(struct usb_xpad *xpad)
787 int error;
789 if (!xpad->irq_out_active && xpad_prepare_next_out_packet(xpad)) {
790 usb_anchor_urb(xpad->irq_out, &xpad->irq_out_anchor);
791 error = usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
792 if (error) {
793 dev_err(&xpad->intf->dev,
794 "%s - usb_submit_urb failed with result %d\n",
795 __func__, error);
796 usb_unanchor_urb(xpad->irq_out);
797 return -EIO;
800 xpad->irq_out_active = true;
803 return 0;
806 static void xpad_irq_out(struct urb *urb)
808 struct usb_xpad *xpad = urb->context;
809 struct device *dev = &xpad->intf->dev;
810 int status = urb->status;
811 int error;
812 unsigned long flags;
814 spin_lock_irqsave(&xpad->odata_lock, flags);
816 switch (status) {
817 case 0:
818 /* success */
819 xpad->irq_out_active = xpad_prepare_next_out_packet(xpad);
820 break;
822 case -ECONNRESET:
823 case -ENOENT:
824 case -ESHUTDOWN:
825 /* this urb is terminated, clean up */
826 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
827 __func__, status);
828 xpad->irq_out_active = false;
829 break;
831 default:
832 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
833 __func__, status);
834 break;
837 if (xpad->irq_out_active) {
838 usb_anchor_urb(urb, &xpad->irq_out_anchor);
839 error = usb_submit_urb(urb, GFP_ATOMIC);
840 if (error) {
841 dev_err(dev,
842 "%s - usb_submit_urb failed with result %d\n",
843 __func__, error);
844 usb_unanchor_urb(urb);
845 xpad->irq_out_active = false;
849 spin_unlock_irqrestore(&xpad->odata_lock, flags);
852 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
854 struct usb_endpoint_descriptor *ep_irq_out;
855 int ep_irq_out_idx;
856 int error;
858 if (xpad->xtype == XTYPE_UNKNOWN)
859 return 0;
861 init_usb_anchor(&xpad->irq_out_anchor);
863 xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
864 GFP_KERNEL, &xpad->odata_dma);
865 if (!xpad->odata) {
866 error = -ENOMEM;
867 goto fail1;
870 spin_lock_init(&xpad->odata_lock);
872 xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
873 if (!xpad->irq_out) {
874 error = -ENOMEM;
875 goto fail2;
878 /* Xbox One controller has in/out endpoints swapped. */
879 ep_irq_out_idx = xpad->xtype == XTYPE_XBOXONE ? 0 : 1;
880 ep_irq_out = &intf->cur_altsetting->endpoint[ep_irq_out_idx].desc;
882 usb_fill_int_urb(xpad->irq_out, xpad->udev,
883 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
884 xpad->odata, XPAD_PKT_LEN,
885 xpad_irq_out, xpad, ep_irq_out->bInterval);
886 xpad->irq_out->transfer_dma = xpad->odata_dma;
887 xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
889 return 0;
891 fail2: usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
892 fail1: return error;
895 static void xpad_stop_output(struct usb_xpad *xpad)
897 if (xpad->xtype != XTYPE_UNKNOWN) {
898 if (!usb_wait_anchor_empty_timeout(&xpad->irq_out_anchor,
899 5000)) {
900 dev_warn(&xpad->intf->dev,
901 "timed out waiting for output URB to complete, killing\n");
902 usb_kill_anchored_urbs(&xpad->irq_out_anchor);
907 static void xpad_deinit_output(struct usb_xpad *xpad)
909 if (xpad->xtype != XTYPE_UNKNOWN) {
910 usb_free_urb(xpad->irq_out);
911 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
912 xpad->odata, xpad->odata_dma);
916 static int xpad_inquiry_pad_presence(struct usb_xpad *xpad)
918 struct xpad_output_packet *packet =
919 &xpad->out_packets[XPAD_OUT_CMD_IDX];
920 unsigned long flags;
921 int retval;
923 spin_lock_irqsave(&xpad->odata_lock, flags);
925 packet->data[0] = 0x08;
926 packet->data[1] = 0x00;
927 packet->data[2] = 0x0F;
928 packet->data[3] = 0xC0;
929 packet->data[4] = 0x00;
930 packet->data[5] = 0x00;
931 packet->data[6] = 0x00;
932 packet->data[7] = 0x00;
933 packet->data[8] = 0x00;
934 packet->data[9] = 0x00;
935 packet->data[10] = 0x00;
936 packet->data[11] = 0x00;
937 packet->len = 12;
938 packet->pending = true;
940 /* Reset the sequence so we send out presence first */
941 xpad->last_out_packet = -1;
942 retval = xpad_try_sending_next_out_packet(xpad);
944 spin_unlock_irqrestore(&xpad->odata_lock, flags);
946 return retval;
949 static int xpad_start_xbox_one(struct usb_xpad *xpad)
951 struct xpad_output_packet *packet =
952 &xpad->out_packets[XPAD_OUT_CMD_IDX];
953 unsigned long flags;
954 int retval;
956 spin_lock_irqsave(&xpad->odata_lock, flags);
958 /* Xbox one controller needs to be initialized. */
959 packet->data[0] = 0x05;
960 packet->data[1] = 0x20;
961 packet->data[2] = xpad->odata_serial++; /* packet serial */
962 packet->data[3] = 0x01; /* rumble bit enable? */
963 packet->data[4] = 0x00;
964 packet->len = 5;
965 packet->pending = true;
967 /* Reset the sequence so we send out start packet first */
968 xpad->last_out_packet = -1;
969 retval = xpad_try_sending_next_out_packet(xpad);
971 spin_unlock_irqrestore(&xpad->odata_lock, flags);
973 return retval;
976 #ifdef CONFIG_JOYSTICK_XPAD_FF
977 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
979 struct usb_xpad *xpad = input_get_drvdata(dev);
980 struct xpad_output_packet *packet = &xpad->out_packets[XPAD_OUT_FF_IDX];
981 __u16 strong;
982 __u16 weak;
983 int retval;
984 unsigned long flags;
986 if (effect->type != FF_RUMBLE)
987 return 0;
989 strong = effect->u.rumble.strong_magnitude;
990 weak = effect->u.rumble.weak_magnitude;
992 spin_lock_irqsave(&xpad->odata_lock, flags);
994 switch (xpad->xtype) {
995 case XTYPE_XBOX:
996 packet->data[0] = 0x00;
997 packet->data[1] = 0x06;
998 packet->data[2] = 0x00;
999 packet->data[3] = strong / 256; /* left actuator */
1000 packet->data[4] = 0x00;
1001 packet->data[5] = weak / 256; /* right actuator */
1002 packet->len = 6;
1003 packet->pending = true;
1004 break;
1006 case XTYPE_XBOX360:
1007 packet->data[0] = 0x00;
1008 packet->data[1] = 0x08;
1009 packet->data[2] = 0x00;
1010 packet->data[3] = strong / 256; /* left actuator? */
1011 packet->data[4] = weak / 256; /* right actuator? */
1012 packet->data[5] = 0x00;
1013 packet->data[6] = 0x00;
1014 packet->data[7] = 0x00;
1015 packet->len = 8;
1016 packet->pending = true;
1017 break;
1019 case XTYPE_XBOX360W:
1020 packet->data[0] = 0x00;
1021 packet->data[1] = 0x01;
1022 packet->data[2] = 0x0F;
1023 packet->data[3] = 0xC0;
1024 packet->data[4] = 0x00;
1025 packet->data[5] = strong / 256;
1026 packet->data[6] = weak / 256;
1027 packet->data[7] = 0x00;
1028 packet->data[8] = 0x00;
1029 packet->data[9] = 0x00;
1030 packet->data[10] = 0x00;
1031 packet->data[11] = 0x00;
1032 packet->len = 12;
1033 packet->pending = true;
1034 break;
1036 case XTYPE_XBOXONE:
1037 packet->data[0] = 0x09; /* activate rumble */
1038 packet->data[1] = 0x00;
1039 packet->data[2] = xpad->odata_serial++;
1040 packet->data[3] = 0x09;
1041 packet->data[4] = 0x00;
1042 packet->data[5] = 0x0F;
1043 packet->data[6] = 0x00;
1044 packet->data[7] = 0x00;
1045 packet->data[8] = strong / 512; /* left actuator */
1046 packet->data[9] = weak / 512; /* right actuator */
1047 packet->data[10] = 0xFF;
1048 packet->data[11] = 0x00;
1049 packet->data[12] = 0x00;
1050 packet->len = 13;
1051 packet->pending = true;
1052 break;
1054 default:
1055 dev_dbg(&xpad->dev->dev,
1056 "%s - rumble command sent to unsupported xpad type: %d\n",
1057 __func__, xpad->xtype);
1058 retval = -EINVAL;
1059 goto out;
1062 retval = xpad_try_sending_next_out_packet(xpad);
1064 out:
1065 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1066 return retval;
1069 static int xpad_init_ff(struct usb_xpad *xpad)
1071 if (xpad->xtype == XTYPE_UNKNOWN)
1072 return 0;
1074 input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
1076 return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
1079 #else
1080 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
1081 #endif
1083 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
1084 #include <linux/leds.h>
1085 #include <linux/idr.h>
1087 static DEFINE_IDA(xpad_pad_seq);
1089 struct xpad_led {
1090 char name[16];
1091 struct led_classdev led_cdev;
1092 struct usb_xpad *xpad;
1096 * set the LEDs on Xbox360 / Wireless Controllers
1097 * @param command
1098 * 0: off
1099 * 1: all blink, then previous setting
1100 * 2: 1/top-left blink, then on
1101 * 3: 2/top-right blink, then on
1102 * 4: 3/bottom-left blink, then on
1103 * 5: 4/bottom-right blink, then on
1104 * 6: 1/top-left on
1105 * 7: 2/top-right on
1106 * 8: 3/bottom-left on
1107 * 9: 4/bottom-right on
1108 * 10: rotate
1109 * 11: blink, based on previous setting
1110 * 12: slow blink, based on previous setting
1111 * 13: rotate with two lights
1112 * 14: persistent slow all blink
1113 * 15: blink once, then previous setting
1115 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
1117 struct xpad_output_packet *packet =
1118 &xpad->out_packets[XPAD_OUT_LED_IDX];
1119 unsigned long flags;
1121 command %= 16;
1123 spin_lock_irqsave(&xpad->odata_lock, flags);
1125 switch (xpad->xtype) {
1126 case XTYPE_XBOX360:
1127 packet->data[0] = 0x01;
1128 packet->data[1] = 0x03;
1129 packet->data[2] = command;
1130 packet->len = 3;
1131 packet->pending = true;
1132 break;
1134 case XTYPE_XBOX360W:
1135 packet->data[0] = 0x00;
1136 packet->data[1] = 0x00;
1137 packet->data[2] = 0x08;
1138 packet->data[3] = 0x40 + command;
1139 packet->data[4] = 0x00;
1140 packet->data[5] = 0x00;
1141 packet->data[6] = 0x00;
1142 packet->data[7] = 0x00;
1143 packet->data[8] = 0x00;
1144 packet->data[9] = 0x00;
1145 packet->data[10] = 0x00;
1146 packet->data[11] = 0x00;
1147 packet->len = 12;
1148 packet->pending = true;
1149 break;
1152 xpad_try_sending_next_out_packet(xpad);
1154 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1158 * Light up the segment corresponding to the pad number on
1159 * Xbox 360 Controllers.
1161 static void xpad_identify_controller(struct usb_xpad *xpad)
1163 led_set_brightness(&xpad->led->led_cdev, (xpad->pad_nr % 4) + 2);
1166 static void xpad_led_set(struct led_classdev *led_cdev,
1167 enum led_brightness value)
1169 struct xpad_led *xpad_led = container_of(led_cdev,
1170 struct xpad_led, led_cdev);
1172 xpad_send_led_command(xpad_led->xpad, value);
1175 static int xpad_led_probe(struct usb_xpad *xpad)
1177 struct xpad_led *led;
1178 struct led_classdev *led_cdev;
1179 int error;
1181 if (xpad->xtype != XTYPE_XBOX360 && xpad->xtype != XTYPE_XBOX360W)
1182 return 0;
1184 xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
1185 if (!led)
1186 return -ENOMEM;
1188 xpad->pad_nr = ida_simple_get(&xpad_pad_seq, 0, 0, GFP_KERNEL);
1189 if (xpad->pad_nr < 0) {
1190 error = xpad->pad_nr;
1191 goto err_free_mem;
1194 snprintf(led->name, sizeof(led->name), "xpad%d", xpad->pad_nr);
1195 led->xpad = xpad;
1197 led_cdev = &led->led_cdev;
1198 led_cdev->name = led->name;
1199 led_cdev->brightness_set = xpad_led_set;
1201 error = led_classdev_register(&xpad->udev->dev, led_cdev);
1202 if (error)
1203 goto err_free_id;
1205 xpad_identify_controller(xpad);
1207 return 0;
1209 err_free_id:
1210 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1211 err_free_mem:
1212 kfree(led);
1213 xpad->led = NULL;
1214 return error;
1217 static void xpad_led_disconnect(struct usb_xpad *xpad)
1219 struct xpad_led *xpad_led = xpad->led;
1221 if (xpad_led) {
1222 led_classdev_unregister(&xpad_led->led_cdev);
1223 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1224 kfree(xpad_led);
1227 #else
1228 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
1229 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
1230 #endif
1232 static int xpad_start_input(struct usb_xpad *xpad)
1234 int error;
1236 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
1237 return -EIO;
1239 if (xpad->xtype == XTYPE_XBOXONE) {
1240 error = xpad_start_xbox_one(xpad);
1241 if (error) {
1242 usb_kill_urb(xpad->irq_in);
1243 return error;
1247 return 0;
1250 static void xpad_stop_input(struct usb_xpad *xpad)
1252 usb_kill_urb(xpad->irq_in);
1255 static void xpad360w_poweroff_controller(struct usb_xpad *xpad)
1257 unsigned long flags;
1258 struct xpad_output_packet *packet =
1259 &xpad->out_packets[XPAD_OUT_CMD_IDX];
1261 spin_lock_irqsave(&xpad->odata_lock, flags);
1263 packet->data[0] = 0x00;
1264 packet->data[1] = 0x00;
1265 packet->data[2] = 0x08;
1266 packet->data[3] = 0xC0;
1267 packet->data[4] = 0x00;
1268 packet->data[5] = 0x00;
1269 packet->data[6] = 0x00;
1270 packet->data[7] = 0x00;
1271 packet->data[8] = 0x00;
1272 packet->data[9] = 0x00;
1273 packet->data[10] = 0x00;
1274 packet->data[11] = 0x00;
1275 packet->len = 12;
1276 packet->pending = true;
1278 /* Reset the sequence so we send out poweroff now */
1279 xpad->last_out_packet = -1;
1280 xpad_try_sending_next_out_packet(xpad);
1282 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1285 static int xpad360w_start_input(struct usb_xpad *xpad)
1287 int error;
1289 error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1290 if (error)
1291 return -EIO;
1294 * Send presence packet.
1295 * This will force the controller to resend connection packets.
1296 * This is useful in the case we activate the module after the
1297 * adapter has been plugged in, as it won't automatically
1298 * send us info about the controllers.
1300 error = xpad_inquiry_pad_presence(xpad);
1301 if (error) {
1302 usb_kill_urb(xpad->irq_in);
1303 return error;
1306 return 0;
1309 static void xpad360w_stop_input(struct usb_xpad *xpad)
1311 usb_kill_urb(xpad->irq_in);
1313 /* Make sure we are done with presence work if it was scheduled */
1314 flush_work(&xpad->work);
1317 static int xpad_open(struct input_dev *dev)
1319 struct usb_xpad *xpad = input_get_drvdata(dev);
1321 return xpad_start_input(xpad);
1324 static void xpad_close(struct input_dev *dev)
1326 struct usb_xpad *xpad = input_get_drvdata(dev);
1328 xpad_stop_input(xpad);
1331 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
1333 struct usb_xpad *xpad = input_get_drvdata(input_dev);
1334 set_bit(abs, input_dev->absbit);
1336 switch (abs) {
1337 case ABS_X:
1338 case ABS_Y:
1339 case ABS_RX:
1340 case ABS_RY: /* the two sticks */
1341 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
1342 break;
1343 case ABS_Z:
1344 case ABS_RZ: /* the triggers (if mapped to axes) */
1345 if (xpad->xtype == XTYPE_XBOXONE)
1346 input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
1347 else
1348 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
1349 break;
1350 case ABS_HAT0X:
1351 case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
1352 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
1353 break;
1357 static void xpad_deinit_input(struct usb_xpad *xpad)
1359 if (xpad->input_created) {
1360 xpad->input_created = false;
1361 xpad_led_disconnect(xpad);
1362 input_unregister_device(xpad->dev);
1366 static int xpad_init_input(struct usb_xpad *xpad)
1368 struct input_dev *input_dev;
1369 int i, error;
1371 input_dev = input_allocate_device();
1372 if (!input_dev)
1373 return -ENOMEM;
1375 xpad->dev = input_dev;
1376 input_dev->name = xpad->name;
1377 input_dev->phys = xpad->phys;
1378 usb_to_input_id(xpad->udev, &input_dev->id);
1379 input_dev->dev.parent = &xpad->intf->dev;
1381 input_set_drvdata(input_dev, xpad);
1383 if (xpad->xtype != XTYPE_XBOX360W) {
1384 input_dev->open = xpad_open;
1385 input_dev->close = xpad_close;
1388 __set_bit(EV_KEY, input_dev->evbit);
1390 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1391 __set_bit(EV_ABS, input_dev->evbit);
1392 /* set up axes */
1393 for (i = 0; xpad_abs[i] >= 0; i++)
1394 xpad_set_up_abs(input_dev, xpad_abs[i]);
1397 /* set up standard buttons */
1398 for (i = 0; xpad_common_btn[i] >= 0; i++)
1399 __set_bit(xpad_common_btn[i], input_dev->keybit);
1401 /* set up model-specific ones */
1402 if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1403 xpad->xtype == XTYPE_XBOXONE) {
1404 for (i = 0; xpad360_btn[i] >= 0; i++)
1405 __set_bit(xpad360_btn[i], input_dev->keybit);
1406 } else {
1407 for (i = 0; xpad_btn[i] >= 0; i++)
1408 __set_bit(xpad_btn[i], input_dev->keybit);
1411 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1412 for (i = 0; xpad_btn_pad[i] >= 0; i++)
1413 __set_bit(xpad_btn_pad[i], input_dev->keybit);
1417 * This should be a simple else block. However historically
1418 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
1419 * made no sense, but now we can not just switch back and have to
1420 * support both behaviors.
1422 if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
1423 xpad->xtype == XTYPE_XBOX360W) {
1424 for (i = 0; xpad_abs_pad[i] >= 0; i++)
1425 xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
1428 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1429 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
1430 __set_bit(xpad_btn_triggers[i], input_dev->keybit);
1431 } else {
1432 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
1433 xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
1436 error = xpad_init_ff(xpad);
1437 if (error)
1438 goto err_free_input;
1440 error = xpad_led_probe(xpad);
1441 if (error)
1442 goto err_destroy_ff;
1444 error = input_register_device(xpad->dev);
1445 if (error)
1446 goto err_disconnect_led;
1448 xpad->input_created = true;
1449 return 0;
1451 err_disconnect_led:
1452 xpad_led_disconnect(xpad);
1453 err_destroy_ff:
1454 input_ff_destroy(input_dev);
1455 err_free_input:
1456 input_free_device(input_dev);
1457 return error;
1460 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
1462 struct usb_device *udev = interface_to_usbdev(intf);
1463 struct usb_xpad *xpad;
1464 struct usb_endpoint_descriptor *ep_irq_in;
1465 int ep_irq_in_idx;
1466 int i, error;
1468 if (intf->cur_altsetting->desc.bNumEndpoints != 2)
1469 return -ENODEV;
1471 for (i = 0; xpad_device[i].idVendor; i++) {
1472 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
1473 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
1474 break;
1477 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
1478 if (!xpad)
1479 return -ENOMEM;
1481 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
1482 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
1484 xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
1485 GFP_KERNEL, &xpad->idata_dma);
1486 if (!xpad->idata) {
1487 error = -ENOMEM;
1488 goto err_free_mem;
1491 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
1492 if (!xpad->irq_in) {
1493 error = -ENOMEM;
1494 goto err_free_idata;
1497 xpad->udev = udev;
1498 xpad->intf = intf;
1499 xpad->mapping = xpad_device[i].mapping;
1500 xpad->xtype = xpad_device[i].xtype;
1501 xpad->name = xpad_device[i].name;
1502 INIT_WORK(&xpad->work, xpad_presence_work);
1504 if (xpad->xtype == XTYPE_UNKNOWN) {
1505 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
1506 if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
1507 xpad->xtype = XTYPE_XBOX360W;
1508 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 208)
1509 xpad->xtype = XTYPE_XBOXONE;
1510 else
1511 xpad->xtype = XTYPE_XBOX360;
1512 } else {
1513 xpad->xtype = XTYPE_XBOX;
1516 if (dpad_to_buttons)
1517 xpad->mapping |= MAP_DPAD_TO_BUTTONS;
1518 if (triggers_to_buttons)
1519 xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
1520 if (sticks_to_null)
1521 xpad->mapping |= MAP_STICKS_TO_NULL;
1524 if (xpad->xtype == XTYPE_XBOXONE &&
1525 intf->cur_altsetting->desc.bInterfaceNumber != 0) {
1527 * The Xbox One controller lists three interfaces all with the
1528 * same interface class, subclass and protocol. Differentiate by
1529 * interface number.
1531 error = -ENODEV;
1532 goto err_free_in_urb;
1535 error = xpad_init_output(intf, xpad);
1536 if (error)
1537 goto err_free_in_urb;
1539 /* Xbox One controller has in/out endpoints swapped. */
1540 ep_irq_in_idx = xpad->xtype == XTYPE_XBOXONE ? 1 : 0;
1541 ep_irq_in = &intf->cur_altsetting->endpoint[ep_irq_in_idx].desc;
1543 usb_fill_int_urb(xpad->irq_in, udev,
1544 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
1545 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
1546 xpad, ep_irq_in->bInterval);
1547 xpad->irq_in->transfer_dma = xpad->idata_dma;
1548 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1550 usb_set_intfdata(intf, xpad);
1552 if (xpad->xtype == XTYPE_XBOX360W) {
1554 * Submit the int URB immediately rather than waiting for open
1555 * because we get status messages from the device whether
1556 * or not any controllers are attached. In fact, it's
1557 * exactly the message that a controller has arrived that
1558 * we're waiting for.
1560 error = xpad360w_start_input(xpad);
1561 if (error)
1562 goto err_deinit_output;
1564 * Wireless controllers require RESET_RESUME to work properly
1565 * after suspend. Ideally this quirk should be in usb core
1566 * quirk list, but we have too many vendors producing these
1567 * controllers and we'd need to maintain 2 identical lists
1568 * here in this driver and in usb core.
1570 udev->quirks |= USB_QUIRK_RESET_RESUME;
1571 } else {
1572 error = xpad_init_input(xpad);
1573 if (error)
1574 goto err_deinit_output;
1576 return 0;
1578 err_deinit_output:
1579 xpad_deinit_output(xpad);
1580 err_free_in_urb:
1581 usb_free_urb(xpad->irq_in);
1582 err_free_idata:
1583 usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1584 err_free_mem:
1585 kfree(xpad);
1586 return error;
1589 static void xpad_disconnect(struct usb_interface *intf)
1591 struct usb_xpad *xpad = usb_get_intfdata(intf);
1593 if (xpad->xtype == XTYPE_XBOX360W)
1594 xpad360w_stop_input(xpad);
1596 xpad_deinit_input(xpad);
1599 * Now that both input device and LED device are gone we can
1600 * stop output URB.
1602 xpad_stop_output(xpad);
1604 xpad_deinit_output(xpad);
1606 usb_free_urb(xpad->irq_in);
1607 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1608 xpad->idata, xpad->idata_dma);
1610 kfree(xpad);
1612 usb_set_intfdata(intf, NULL);
1615 static int xpad_suspend(struct usb_interface *intf, pm_message_t message)
1617 struct usb_xpad *xpad = usb_get_intfdata(intf);
1618 struct input_dev *input = xpad->dev;
1620 if (xpad->xtype == XTYPE_XBOX360W) {
1622 * Wireless controllers always listen to input so
1623 * they are notified when controller shows up
1624 * or goes away.
1626 xpad360w_stop_input(xpad);
1629 * The wireless adapter is going off now, so the
1630 * gamepads are going to become disconnected.
1631 * Unless explicitly disabled, power them down
1632 * so they don't just sit there flashing.
1634 if (auto_poweroff && xpad->pad_present)
1635 xpad360w_poweroff_controller(xpad);
1636 } else {
1637 mutex_lock(&input->mutex);
1638 if (input->users)
1639 xpad_stop_input(xpad);
1640 mutex_unlock(&input->mutex);
1643 xpad_stop_output(xpad);
1645 return 0;
1648 static int xpad_resume(struct usb_interface *intf)
1650 struct usb_xpad *xpad = usb_get_intfdata(intf);
1651 struct input_dev *input = xpad->dev;
1652 int retval = 0;
1654 if (xpad->xtype == XTYPE_XBOX360W) {
1655 retval = xpad360w_start_input(xpad);
1656 } else {
1657 mutex_lock(&input->mutex);
1658 if (input->users)
1659 retval = xpad_start_input(xpad);
1660 mutex_unlock(&input->mutex);
1663 return retval;
1666 static struct usb_driver xpad_driver = {
1667 .name = "xpad",
1668 .probe = xpad_probe,
1669 .disconnect = xpad_disconnect,
1670 .suspend = xpad_suspend,
1671 .resume = xpad_resume,
1672 .reset_resume = xpad_resume,
1673 .id_table = xpad_table,
1676 module_usb_driver(xpad_driver);
1678 MODULE_AUTHOR(DRIVER_AUTHOR);
1679 MODULE_DESCRIPTION(DRIVER_DESC);
1680 MODULE_LICENSE("GPL");