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