Version:  2.0.40 2.2.26 2.4.37 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5

Linux/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 DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
 88 #define DRIVER_DESC "X-Box pad driver"
 89 
 90 #define XPAD_PKT_LEN 32
 91 
 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)
 99 
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
105 
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");
109 
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");
113 
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");
117 
118 static const struct xpad_device {
119         u16 idVendor;
120         u16 idProduct;
121         char *name;
122         u8 mapping;
123         u8 xtype;
124 } xpad_device[] = {
125         { 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", 0, XTYPE_XBOX },
126         { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", 0, XTYPE_XBOX },
127         { 0x045e, 0x0287, "Microsoft Xbox Controller S", 0, XTYPE_XBOX },
128         { 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", 0, XTYPE_XBOX },
129         { 0x045e, 0x028e, "Microsoft X-Box 360 pad", 0, XTYPE_XBOX360 },
130         { 0x045e, 0x02d1, "Microsoft X-Box One pad", 0, XTYPE_XBOXONE },
131         { 0x045e, 0x02dd, "Microsoft X-Box One pad (Firmware 2015)", 0, XTYPE_XBOXONE },
132         { 0x045e, 0x0291, "Xbox 360 Wireless Receiver (XBOX)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
133         { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
134         { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
135         { 0x044f, 0xb326, "Thrustmaster Gamepad GP XID", 0, XTYPE_XBOX360 },
136         { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
137         { 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
138         { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },
139         { 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
140         { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
141         { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
142         { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
143         { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
144         { 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
145         { 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
146         { 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
147         { 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
148         { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
149         { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
150         { 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
151         { 0x0738, 0x4718, "Mad Catz Street Fighter IV FightStick SE", 0, XTYPE_XBOX360 },
152         { 0x0738, 0x4726, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
153         { 0x0738, 0x4728, "Mad Catz Street Fighter IV FightPad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
154         { 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
155         { 0x0738, 0x4740, "Mad Catz Beat Pad", 0, XTYPE_XBOX360 },
156         { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
157         { 0x0738, 0xb726, "Mad Catz Xbox controller - MW2", 0, XTYPE_XBOX360 },
158         { 0x0738, 0xbeef, "Mad Catz JOYTECH NEO SE Advanced GamePad", XTYPE_XBOX360 },
159         { 0x0738, 0xcb02, "Saitek Cyborg Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
160         { 0x0738, 0xcb03, "Saitek P3200 Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
161         { 0x0738, 0xf738, "Super SFIV FightStick TE S", 0, XTYPE_XBOX360 },
162         { 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
163         { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
164         { 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
165         { 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
166         { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
167         { 0x0d2f, 0x0002, "Andamiro Pump It Up pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
168         { 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
169         { 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
170         { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
171         { 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
172         { 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
173         { 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
174         { 0x0e6f, 0x0113, "Afterglow AX.1 Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
175         { 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
176         { 0x0e6f, 0x0213, "Afterglow Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
177         { 0x0e6f, 0x021f, "Rock Candy Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
178         { 0x0e6f, 0x0301, "Logic3 Controller", 0, XTYPE_XBOX360 },
179         { 0x0e6f, 0x0401, "Logic3 Controller", 0, XTYPE_XBOX360 },
180         { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
181         { 0x0e8f, 0x3008, "Generic xbox control (dealextreme)", 0, XTYPE_XBOX },
182         { 0x0f0d, 0x000a, "Hori Co. DOA4 FightStick", 0, XTYPE_XBOX360 },
183         { 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
184         { 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
185         { 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
186         { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
187         { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
188         { 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
189         { 0x12ab, 0x0301, "PDP AFTERGLOW AX.1", 0, XTYPE_XBOX360 },
190         { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
191         { 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
192         { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
193         { 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
194         { 0x1532, 0x0037, "Razer Sabertooth", 0, XTYPE_XBOX360 },
195         { 0x15e4, 0x3f00, "Power A Mini Pro Elite", 0, XTYPE_XBOX360 },
196         { 0x15e4, 0x3f0a, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
197         { 0x15e4, 0x3f10, "Batarang Xbox 360 controller", 0, XTYPE_XBOX360 },
198         { 0x162e, 0xbeef, "Joytech Neo-Se Take2", 0, XTYPE_XBOX360 },
199         { 0x1689, 0xfd00, "Razer Onza Tournament Edition", 0, XTYPE_XBOX360 },
200         { 0x1689, 0xfd01, "Razer Onza Classic Edition", 0, XTYPE_XBOX360 },
201         { 0x24c6, 0x5d04, "Razer Sabertooth", 0, XTYPE_XBOX360 },
202         { 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
203         { 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
204         { 0x1bad, 0xf016, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
205         { 0x1bad, 0xf023, "MLG Pro Circuit Controller (Xbox)", 0, XTYPE_XBOX360 },
206         { 0x1bad, 0xf028, "Street Fighter IV FightPad", 0, XTYPE_XBOX360 },
207         { 0x1bad, 0xf038, "Street Fighter IV FightStick TE", 0, XTYPE_XBOX360 },
208         { 0x1bad, 0xf900, "Harmonix Xbox 360 Controller", 0, XTYPE_XBOX360 },
209         { 0x1bad, 0xf901, "Gamestop Xbox 360 Controller", 0, XTYPE_XBOX360 },
210         { 0x1bad, 0xf903, "Tron Xbox 360 controller", 0, XTYPE_XBOX360 },
211         { 0x24c6, 0x5000, "Razer Atrox Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
212         { 0x24c6, 0x5300, "PowerA MINI PROEX Controller", 0, XTYPE_XBOX360 },
213         { 0x24c6, 0x5303, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
214         { 0x24c6, 0x5500, "Hori XBOX 360 EX 2 with Turbo", 0, XTYPE_XBOX360 },
215         { 0x24c6, 0x5501, "Hori Real Arcade Pro VX-SA", 0, XTYPE_XBOX360 },
216         { 0x24c6, 0x5506, "Hori SOULCALIBUR V Stick", 0, XTYPE_XBOX360 },
217         { 0x24c6, 0x5b02, "Thrustmaster, Inc. GPX Controller", 0, XTYPE_XBOX360 },
218         { 0x24c6, 0x5b03, "Thrustmaster Ferrari 458 Racing Wheel", 0, XTYPE_XBOX360 },
219         { 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
220         { 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
221 };
222 
223 /* buttons shared with xbox and xbox360 */
224 static const signed short xpad_common_btn[] = {
225         BTN_A, BTN_B, BTN_X, BTN_Y,                     /* "analog" buttons */
226         BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR,  /* start/back/sticks */
227         -1                                              /* terminating entry */
228 };
229 
230 /* original xbox controllers only */
231 static const signed short xpad_btn[] = {
232         BTN_C, BTN_Z,           /* "analog" buttons */
233         -1                      /* terminating entry */
234 };
235 
236 /* used when dpad is mapped to buttons */
237 static const signed short xpad_btn_pad[] = {
238         BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2,         /* d-pad left, right */
239         BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4,         /* d-pad up, down */
240         -1                              /* terminating entry */
241 };
242 
243 /* used when triggers are mapped to buttons */
244 static const signed short xpad_btn_triggers[] = {
245         BTN_TL2, BTN_TR2,               /* triggers left/right */
246         -1
247 };
248 
249 static const signed short xpad360_btn[] = {  /* buttons for x360 controller */
250         BTN_TL, BTN_TR,         /* Button LB/RB */
251         BTN_MODE,               /* The big X button */
252         -1
253 };
254 
255 static const signed short xpad_abs[] = {
256         ABS_X, ABS_Y,           /* left stick */
257         ABS_RX, ABS_RY,         /* right stick */
258         -1                      /* terminating entry */
259 };
260 
261 /* used when dpad is mapped to axes */
262 static const signed short xpad_abs_pad[] = {
263         ABS_HAT0X, ABS_HAT0Y,   /* d-pad axes */
264         -1                      /* terminating entry */
265 };
266 
267 /* used when triggers are mapped to axes */
268 static const signed short xpad_abs_triggers[] = {
269         ABS_Z, ABS_RZ,          /* triggers left/right */
270         -1
271 };
272 
273 /*
274  * Xbox 360 has a vendor-specific class, so we cannot match it with only
275  * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
276  * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
277  * wireless controllers have protocol 129.
278  */
279 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
280         .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
281         .idVendor = (vend), \
282         .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
283         .bInterfaceSubClass = 93, \
284         .bInterfaceProtocol = (pr)
285 #define XPAD_XBOX360_VENDOR(vend) \
286         { XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
287         { XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
288 
289 /* The Xbox One controller uses subclass 71 and protocol 208. */
290 #define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
291         .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
292         .idVendor = (vend), \
293         .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
294         .bInterfaceSubClass = 71, \
295         .bInterfaceProtocol = (pr)
296 #define XPAD_XBOXONE_VENDOR(vend) \
297         { XPAD_XBOXONE_VENDOR_PROTOCOL(vend, 208) }
298 
299 static struct usb_device_id xpad_table[] = {
300         { USB_INTERFACE_INFO('X', 'B', 0) },    /* X-Box USB-IF not approved class */
301         XPAD_XBOX360_VENDOR(0x044f),            /* Thrustmaster X-Box 360 controllers */
302         XPAD_XBOX360_VENDOR(0x045e),            /* Microsoft X-Box 360 controllers */
303         XPAD_XBOXONE_VENDOR(0x045e),            /* Microsoft X-Box One controllers */
304         XPAD_XBOX360_VENDOR(0x046d),            /* Logitech X-Box 360 style controllers */
305         XPAD_XBOX360_VENDOR(0x0738),            /* Mad Catz X-Box 360 controllers */
306         { USB_DEVICE(0x0738, 0x4540) },         /* Mad Catz Beat Pad */
307         XPAD_XBOX360_VENDOR(0x0e6f),            /* 0x0e6f X-Box 360 controllers */
308         XPAD_XBOX360_VENDOR(0x12ab),            /* X-Box 360 dance pads */
309         XPAD_XBOX360_VENDOR(0x1430),            /* RedOctane X-Box 360 controllers */
310         XPAD_XBOX360_VENDOR(0x146b),            /* BigBen Interactive Controllers */
311         XPAD_XBOX360_VENDOR(0x1bad),            /* Harminix Rock Band Guitar and Drums */
312         XPAD_XBOX360_VENDOR(0x0f0d),            /* Hori Controllers */
313         XPAD_XBOX360_VENDOR(0x1689),            /* Razer Onza */
314         XPAD_XBOX360_VENDOR(0x24c6),            /* PowerA Controllers */
315         XPAD_XBOX360_VENDOR(0x1532),            /* Razer Sabertooth */
316         XPAD_XBOX360_VENDOR(0x15e4),            /* Numark X-Box 360 controllers */
317         XPAD_XBOX360_VENDOR(0x162e),            /* Joytech X-Box 360 controllers */
318         { }
319 };
320 
321 MODULE_DEVICE_TABLE(usb, xpad_table);
322 
323 struct xpad_output_packet {
324         u8 data[XPAD_PKT_LEN];
325         u8 len;
326         bool pending;
327 };
328 
329 #define XPAD_OUT_CMD_IDX        0
330 #define XPAD_OUT_FF_IDX         1
331 #define XPAD_OUT_LED_IDX        (1 + IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF))
332 #define XPAD_NUM_OUT_PACKETS    (1 + \
333                                  IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF) + \
334                                  IS_ENABLED(CONFIG_JOYSTICK_XPAD_LEDS))
335 
336 struct usb_xpad {
337         struct input_dev *dev;          /* input device interface */
338         struct input_dev __rcu *x360w_dev;
339         struct usb_device *udev;        /* usb device */
340         struct usb_interface *intf;     /* usb interface */
341 
342         bool pad_present;
343         bool input_created;
344 
345         struct urb *irq_in;             /* urb for interrupt in report */
346         unsigned char *idata;           /* input data */
347         dma_addr_t idata_dma;
348 
349         struct urb *irq_out;            /* urb for interrupt out report */
350         struct usb_anchor irq_out_anchor;
351         bool irq_out_active;            /* we must not use an active URB */
352         u8 odata_serial;                /* serial number for xbox one protocol */
353         unsigned char *odata;           /* output data */
354         dma_addr_t odata_dma;
355         spinlock_t odata_lock;
356 
357         struct xpad_output_packet out_packets[XPAD_NUM_OUT_PACKETS];
358         int last_out_packet;
359 
360 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
361         struct xpad_led *led;
362 #endif
363 
364         char phys[64];                  /* physical device path */
365 
366         int mapping;                    /* map d-pad to buttons or to axes */
367         int xtype;                      /* type of xbox device */
368         int pad_nr;                     /* the order x360 pads were attached */
369         const char *name;               /* name of the device */
370         struct work_struct work;        /* init/remove device from callback */
371 };
372 
373 static int xpad_init_input(struct usb_xpad *xpad);
374 static void xpad_deinit_input(struct usb_xpad *xpad);
375 
376 /*
377  *      xpad_process_packet
378  *
379  *      Completes a request by converting the data into events for the
380  *      input subsystem.
381  *
382  *      The used report descriptor was taken from ITO Takayukis website:
383  *       http://euc.jp/periphs/xbox-controller.ja.html
384  */
385 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
386 {
387         struct input_dev *dev = xpad->dev;
388 
389         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
390                 /* left stick */
391                 input_report_abs(dev, ABS_X,
392                                  (__s16) le16_to_cpup((__le16 *)(data + 12)));
393                 input_report_abs(dev, ABS_Y,
394                                  ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
395 
396                 /* right stick */
397                 input_report_abs(dev, ABS_RX,
398                                  (__s16) le16_to_cpup((__le16 *)(data + 16)));
399                 input_report_abs(dev, ABS_RY,
400                                  ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
401         }
402 
403         /* triggers left/right */
404         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
405                 input_report_key(dev, BTN_TL2, data[10]);
406                 input_report_key(dev, BTN_TR2, data[11]);
407         } else {
408                 input_report_abs(dev, ABS_Z, data[10]);
409                 input_report_abs(dev, ABS_RZ, data[11]);
410         }
411 
412         /* digital pad */
413         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
414                 /* dpad as buttons (left, right, up, down) */
415                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
416                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
417                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
418                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
419         } else {
420                 input_report_abs(dev, ABS_HAT0X,
421                                  !!(data[2] & 0x08) - !!(data[2] & 0x04));
422                 input_report_abs(dev, ABS_HAT0Y,
423                                  !!(data[2] & 0x02) - !!(data[2] & 0x01));
424         }
425 
426         /* start/back buttons and stick press left/right */
427         input_report_key(dev, BTN_START,  data[2] & 0x10);
428         input_report_key(dev, BTN_SELECT, data[2] & 0x20);
429         input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
430         input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
431 
432         /* "analog" buttons A, B, X, Y */
433         input_report_key(dev, BTN_A, data[4]);
434         input_report_key(dev, BTN_B, data[5]);
435         input_report_key(dev, BTN_X, data[6]);
436         input_report_key(dev, BTN_Y, data[7]);
437 
438         /* "analog" buttons black, white */
439         input_report_key(dev, BTN_C, data[8]);
440         input_report_key(dev, BTN_Z, data[9]);
441 
442         input_sync(dev);
443 }
444 
445 /*
446  *      xpad360_process_packet
447  *
448  *      Completes a request by converting the data into events for the
449  *      input subsystem. It is version for xbox 360 controller
450  *
451  *      The used report descriptor was taken from:
452  *              http://www.free60.org/wiki/Gamepad
453  */
454 
455 static void xpad360_process_packet(struct usb_xpad *xpad, struct input_dev *dev,
456                                    u16 cmd, unsigned char *data)
457 {
458         /* digital pad */
459         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
460                 /* dpad as buttons (left, right, up, down) */
461                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
462                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
463                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
464                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
465         }
466 
467         /*
468          * This should be a simple else block. However historically
469          * xbox360w has mapped DPAD to buttons while xbox360 did not. This
470          * made no sense, but now we can not just switch back and have to
471          * support both behaviors.
472          */
473         if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
474             xpad->xtype == XTYPE_XBOX360W) {
475                 input_report_abs(dev, ABS_HAT0X,
476                                  !!(data[2] & 0x08) - !!(data[2] & 0x04));
477                 input_report_abs(dev, ABS_HAT0Y,
478                                  !!(data[2] & 0x02) - !!(data[2] & 0x01));
479         }
480 
481         /* start/back buttons */
482         input_report_key(dev, BTN_START,  data[2] & 0x10);
483         input_report_key(dev, BTN_SELECT, data[2] & 0x20);
484 
485         /* stick press left/right */
486         input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
487         input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
488 
489         /* buttons A,B,X,Y,TL,TR and MODE */
490         input_report_key(dev, BTN_A,    data[3] & 0x10);
491         input_report_key(dev, BTN_B,    data[3] & 0x20);
492         input_report_key(dev, BTN_X,    data[3] & 0x40);
493         input_report_key(dev, BTN_Y,    data[3] & 0x80);
494         input_report_key(dev, BTN_TL,   data[3] & 0x01);
495         input_report_key(dev, BTN_TR,   data[3] & 0x02);
496         input_report_key(dev, BTN_MODE, data[3] & 0x04);
497 
498         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
499                 /* left stick */
500                 input_report_abs(dev, ABS_X,
501                                  (__s16) le16_to_cpup((__le16 *)(data + 6)));
502                 input_report_abs(dev, ABS_Y,
503                                  ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
504 
505                 /* right stick */
506                 input_report_abs(dev, ABS_RX,
507                                  (__s16) le16_to_cpup((__le16 *)(data + 10)));
508                 input_report_abs(dev, ABS_RY,
509                                  ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
510         }
511 
512         /* triggers left/right */
513         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
514                 input_report_key(dev, BTN_TL2, data[4]);
515                 input_report_key(dev, BTN_TR2, data[5]);
516         } else {
517                 input_report_abs(dev, ABS_Z, data[4]);
518                 input_report_abs(dev, ABS_RZ, data[5]);
519         }
520 
521         input_sync(dev);
522 }
523 
524 static void xpad_presence_work(struct work_struct *work)
525 {
526         struct usb_xpad *xpad = container_of(work, struct usb_xpad, work);
527         int error;
528 
529         if (xpad->pad_present) {
530                 error = xpad_init_input(xpad);
531                 if (error) {
532                         /* complain only, not much else we can do here */
533                         dev_err(&xpad->dev->dev,
534                                 "unable to init device: %d\n", error);
535                 } else {
536                         rcu_assign_pointer(xpad->x360w_dev, xpad->dev);
537                 }
538         } else {
539                 RCU_INIT_POINTER(xpad->x360w_dev, NULL);
540                 synchronize_rcu();
541                 /*
542                  * Now that we are sure xpad360w_process_packet is not
543                  * using input device we can get rid of it.
544                  */
545                 xpad_deinit_input(xpad);
546         }
547 }
548 
549 /*
550  * xpad360w_process_packet
551  *
552  * Completes a request by converting the data into events for the
553  * input subsystem. It is version for xbox 360 wireless controller.
554  *
555  * Byte.Bit
556  * 00.1 - Status change: The controller or headset has connected/disconnected
557  *                       Bits 01.7 and 01.6 are valid
558  * 01.7 - Controller present
559  * 01.6 - Headset present
560  * 01.1 - Pad state (Bytes 4+) valid
561  *
562  */
563 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
564 {
565         struct input_dev *dev;
566         bool present;
567 
568         /* Presence change */
569         if (data[0] & 0x08) {
570                 present = (data[1] & 0x80) != 0;
571 
572                 if (xpad->pad_present != present) {
573                         xpad->pad_present = present;
574                         schedule_work(&xpad->work);
575                 }
576         }
577 
578         /* Valid pad data */
579         if (data[1] != 0x1)
580                 return;
581 
582         rcu_read_lock();
583         dev = rcu_dereference(xpad->x360w_dev);
584         if (dev)
585                 xpad360_process_packet(xpad, dev, cmd, &data[4]);
586         rcu_read_unlock();
587 }
588 
589 /*
590  *      xpadone_process_buttons
591  *
592  *      Process a button update packet from an Xbox one controller.
593  */
594 static void xpadone_process_buttons(struct usb_xpad *xpad,
595                                 struct input_dev *dev,
596                                 unsigned char *data)
597 {
598         /* menu/view buttons */
599         input_report_key(dev, BTN_START,  data[4] & 0x04);
600         input_report_key(dev, BTN_SELECT, data[4] & 0x08);
601 
602         /* buttons A,B,X,Y */
603         input_report_key(dev, BTN_A,    data[4] & 0x10);
604         input_report_key(dev, BTN_B,    data[4] & 0x20);
605         input_report_key(dev, BTN_X,    data[4] & 0x40);
606         input_report_key(dev, BTN_Y,    data[4] & 0x80);
607 
608         /* digital pad */
609         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
610                 /* dpad as buttons (left, right, up, down) */
611                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[5] & 0x04);
612                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[5] & 0x08);
613                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[5] & 0x01);
614                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[5] & 0x02);
615         } else {
616                 input_report_abs(dev, ABS_HAT0X,
617                                  !!(data[5] & 0x08) - !!(data[5] & 0x04));
618                 input_report_abs(dev, ABS_HAT0Y,
619                                  !!(data[5] & 0x02) - !!(data[5] & 0x01));
620         }
621 
622         /* TL/TR */
623         input_report_key(dev, BTN_TL,   data[5] & 0x10);
624         input_report_key(dev, BTN_TR,   data[5] & 0x20);
625 
626         /* stick press left/right */
627         input_report_key(dev, BTN_THUMBL, data[5] & 0x40);
628         input_report_key(dev, BTN_THUMBR, data[5] & 0x80);
629 
630         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
631                 /* left stick */
632                 input_report_abs(dev, ABS_X,
633                                  (__s16) le16_to_cpup((__le16 *)(data + 10)));
634                 input_report_abs(dev, ABS_Y,
635                                  ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
636 
637                 /* right stick */
638                 input_report_abs(dev, ABS_RX,
639                                  (__s16) le16_to_cpup((__le16 *)(data + 14)));
640                 input_report_abs(dev, ABS_RY,
641                                  ~(__s16) le16_to_cpup((__le16 *)(data + 16)));
642         }
643 
644         /* triggers left/right */
645         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
646                 input_report_key(dev, BTN_TL2,
647                                  (__u16) le16_to_cpup((__le16 *)(data + 6)));
648                 input_report_key(dev, BTN_TR2,
649                                  (__u16) le16_to_cpup((__le16 *)(data + 8)));
650         } else {
651                 input_report_abs(dev, ABS_Z,
652                                  (__u16) le16_to_cpup((__le16 *)(data + 6)));
653                 input_report_abs(dev, ABS_RZ,
654                                  (__u16) le16_to_cpup((__le16 *)(data + 8)));
655         }
656 
657         input_sync(dev);
658 }
659 
660 /*
661  *      xpadone_process_packet
662  *
663  *      Completes a request by converting the data into events for the
664  *      input subsystem. This version is for the Xbox One controller.
665  *
666  *      The report format was gleaned from
667  *      https://github.com/kylelemons/xbox/blob/master/xbox.go
668  */
669 
670 static void xpadone_process_packet(struct usb_xpad *xpad,
671                                 u16 cmd, unsigned char *data)
672 {
673         struct input_dev *dev = xpad->dev;
674 
675         switch (data[0]) {
676         case 0x20:
677                 xpadone_process_buttons(xpad, dev, data);
678                 break;
679 
680         case 0x07:
681                 /* the xbox button has its own special report */
682                 input_report_key(dev, BTN_MODE, data[4] & 0x01);
683                 input_sync(dev);
684                 break;
685         }
686 }
687 
688 static void xpad_irq_in(struct urb *urb)
689 {
690         struct usb_xpad *xpad = urb->context;
691         struct device *dev = &xpad->intf->dev;
692         int retval, status;
693 
694         status = urb->status;
695 
696         switch (status) {
697         case 0:
698                 /* success */
699                 break;
700         case -ECONNRESET:
701         case -ENOENT:
702         case -ESHUTDOWN:
703                 /* this urb is terminated, clean up */
704                 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
705                         __func__, status);
706                 return;
707         default:
708                 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
709                         __func__, status);
710                 goto exit;
711         }
712 
713         switch (xpad->xtype) {
714         case XTYPE_XBOX360:
715                 xpad360_process_packet(xpad, xpad->dev, 0, xpad->idata);
716                 break;
717         case XTYPE_XBOX360W:
718                 xpad360w_process_packet(xpad, 0, xpad->idata);
719                 break;
720         case XTYPE_XBOXONE:
721                 xpadone_process_packet(xpad, 0, xpad->idata);
722                 break;
723         default:
724                 xpad_process_packet(xpad, 0, xpad->idata);
725         }
726 
727 exit:
728         retval = usb_submit_urb(urb, GFP_ATOMIC);
729         if (retval)
730                 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
731                         __func__, retval);
732 }
733 
734 /* Callers must hold xpad->odata_lock spinlock */
735 static bool xpad_prepare_next_out_packet(struct usb_xpad *xpad)
736 {
737         struct xpad_output_packet *pkt, *packet = NULL;
738         int i;
739 
740         for (i = 0; i < XPAD_NUM_OUT_PACKETS; i++) {
741                 if (++xpad->last_out_packet >= XPAD_NUM_OUT_PACKETS)
742                         xpad->last_out_packet = 0;
743 
744                 pkt = &xpad->out_packets[xpad->last_out_packet];
745                 if (pkt->pending) {
746                         dev_dbg(&xpad->intf->dev,
747                                 "%s - found pending output packet %d\n",
748                                 __func__, xpad->last_out_packet);
749                         packet = pkt;
750                         break;
751                 }
752         }
753 
754         if (packet) {
755                 memcpy(xpad->odata, packet->data, packet->len);
756                 xpad->irq_out->transfer_buffer_length = packet->len;
757                 return true;
758         }
759 
760         return false;
761 }
762 
763 /* Callers must hold xpad->odata_lock spinlock */
764 static int xpad_try_sending_next_out_packet(struct usb_xpad *xpad)
765 {
766         int error;
767 
768         if (!xpad->irq_out_active && xpad_prepare_next_out_packet(xpad)) {
769                 usb_anchor_urb(xpad->irq_out, &xpad->irq_out_anchor);
770                 error = usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
771                 if (error) {
772                         dev_err(&xpad->intf->dev,
773                                 "%s - usb_submit_urb failed with result %d\n",
774                                 __func__, error);
775                         usb_unanchor_urb(xpad->irq_out);
776                         return -EIO;
777                 }
778 
779                 xpad->irq_out_active = true;
780         }
781 
782         return 0;
783 }
784 
785 static void xpad_irq_out(struct urb *urb)
786 {
787         struct usb_xpad *xpad = urb->context;
788         struct device *dev = &xpad->intf->dev;
789         int status = urb->status;
790         int error;
791         unsigned long flags;
792 
793         spin_lock_irqsave(&xpad->odata_lock, flags);
794 
795         switch (status) {
796         case 0:
797                 /* success */
798                 xpad->out_packets[xpad->last_out_packet].pending = false;
799                 xpad->irq_out_active = xpad_prepare_next_out_packet(xpad);
800                 break;
801 
802         case -ECONNRESET:
803         case -ENOENT:
804         case -ESHUTDOWN:
805                 /* this urb is terminated, clean up */
806                 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
807                         __func__, status);
808                 xpad->irq_out_active = false;
809                 break;
810 
811         default:
812                 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
813                         __func__, status);
814                 break;
815         }
816 
817         if (xpad->irq_out_active) {
818                 usb_anchor_urb(urb, &xpad->irq_out_anchor);
819                 error = usb_submit_urb(urb, GFP_ATOMIC);
820                 if (error) {
821                         dev_err(dev,
822                                 "%s - usb_submit_urb failed with result %d\n",
823                                 __func__, error);
824                         usb_unanchor_urb(urb);
825                         xpad->irq_out_active = false;
826                 }
827         }
828 
829         spin_unlock_irqrestore(&xpad->odata_lock, flags);
830 }
831 
832 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
833 {
834         struct usb_endpoint_descriptor *ep_irq_out;
835         int ep_irq_out_idx;
836         int error;
837 
838         if (xpad->xtype == XTYPE_UNKNOWN)
839                 return 0;
840 
841         init_usb_anchor(&xpad->irq_out_anchor);
842 
843         xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
844                                          GFP_KERNEL, &xpad->odata_dma);
845         if (!xpad->odata) {
846                 error = -ENOMEM;
847                 goto fail1;
848         }
849 
850         spin_lock_init(&xpad->odata_lock);
851 
852         xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
853         if (!xpad->irq_out) {
854                 error = -ENOMEM;
855                 goto fail2;
856         }
857 
858         /* Xbox One controller has in/out endpoints swapped. */
859         ep_irq_out_idx = xpad->xtype == XTYPE_XBOXONE ? 0 : 1;
860         ep_irq_out = &intf->cur_altsetting->endpoint[ep_irq_out_idx].desc;
861 
862         usb_fill_int_urb(xpad->irq_out, xpad->udev,
863                          usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
864                          xpad->odata, XPAD_PKT_LEN,
865                          xpad_irq_out, xpad, ep_irq_out->bInterval);
866         xpad->irq_out->transfer_dma = xpad->odata_dma;
867         xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
868 
869         return 0;
870 
871  fail2: usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
872  fail1: return error;
873 }
874 
875 static void xpad_stop_output(struct usb_xpad *xpad)
876 {
877         if (xpad->xtype != XTYPE_UNKNOWN) {
878                 if (!usb_wait_anchor_empty_timeout(&xpad->irq_out_anchor,
879                                                    5000)) {
880                         dev_warn(&xpad->intf->dev,
881                                  "timed out waiting for output URB to complete, killing\n");
882                         usb_kill_anchored_urbs(&xpad->irq_out_anchor);
883                 }
884         }
885 }
886 
887 static void xpad_deinit_output(struct usb_xpad *xpad)
888 {
889         if (xpad->xtype != XTYPE_UNKNOWN) {
890                 usb_free_urb(xpad->irq_out);
891                 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
892                                 xpad->odata, xpad->odata_dma);
893         }
894 }
895 
896 static int xpad_inquiry_pad_presence(struct usb_xpad *xpad)
897 {
898         struct xpad_output_packet *packet =
899                         &xpad->out_packets[XPAD_OUT_CMD_IDX];
900         unsigned long flags;
901         int retval;
902 
903         spin_lock_irqsave(&xpad->odata_lock, flags);
904 
905         packet->data[0] = 0x08;
906         packet->data[1] = 0x00;
907         packet->data[2] = 0x0F;
908         packet->data[3] = 0xC0;
909         packet->data[4] = 0x00;
910         packet->data[5] = 0x00;
911         packet->data[6] = 0x00;
912         packet->data[7] = 0x00;
913         packet->data[8] = 0x00;
914         packet->data[9] = 0x00;
915         packet->data[10] = 0x00;
916         packet->data[11] = 0x00;
917         packet->len = 12;
918         packet->pending = true;
919 
920         /* Reset the sequence so we send out presence first */
921         xpad->last_out_packet = -1;
922         retval = xpad_try_sending_next_out_packet(xpad);
923 
924         spin_unlock_irqrestore(&xpad->odata_lock, flags);
925 
926         return retval;
927 }
928 
929 static int xpad_start_xbox_one(struct usb_xpad *xpad)
930 {
931         struct xpad_output_packet *packet =
932                         &xpad->out_packets[XPAD_OUT_CMD_IDX];
933         unsigned long flags;
934         int retval;
935 
936         spin_lock_irqsave(&xpad->odata_lock, flags);
937 
938         /* Xbox one controller needs to be initialized. */
939         packet->data[0] = 0x05;
940         packet->data[1] = 0x20;
941         packet->data[2] = xpad->odata_serial++; /* packet serial */
942         packet->data[3] = 0x01; /* rumble bit enable?  */
943         packet->data[4] = 0x00;
944         packet->len = 5;
945         packet->pending = true;
946 
947         /* Reset the sequence so we send out start packet first */
948         xpad->last_out_packet = -1;
949         retval = xpad_try_sending_next_out_packet(xpad);
950 
951         spin_unlock_irqrestore(&xpad->odata_lock, flags);
952 
953         return retval;
954 }
955 
956 #ifdef CONFIG_JOYSTICK_XPAD_FF
957 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
958 {
959         struct usb_xpad *xpad = input_get_drvdata(dev);
960         struct xpad_output_packet *packet = &xpad->out_packets[XPAD_OUT_FF_IDX];
961         __u16 strong;
962         __u16 weak;
963         int retval;
964         unsigned long flags;
965 
966         if (effect->type != FF_RUMBLE)
967                 return 0;
968 
969         strong = effect->u.rumble.strong_magnitude;
970         weak = effect->u.rumble.weak_magnitude;
971 
972         spin_lock_irqsave(&xpad->odata_lock, flags);
973 
974         switch (xpad->xtype) {
975         case XTYPE_XBOX:
976                 packet->data[0] = 0x00;
977                 packet->data[1] = 0x06;
978                 packet->data[2] = 0x00;
979                 packet->data[3] = strong / 256; /* left actuator */
980                 packet->data[4] = 0x00;
981                 packet->data[5] = weak / 256;   /* right actuator */
982                 packet->len = 6;
983                 packet->pending = true;
984                 break;
985 
986         case XTYPE_XBOX360:
987                 packet->data[0] = 0x00;
988                 packet->data[1] = 0x08;
989                 packet->data[2] = 0x00;
990                 packet->data[3] = strong / 256;  /* left actuator? */
991                 packet->data[4] = weak / 256;   /* right actuator? */
992                 packet->data[5] = 0x00;
993                 packet->data[6] = 0x00;
994                 packet->data[7] = 0x00;
995                 packet->len = 8;
996                 packet->pending = true;
997                 break;
998 
999         case XTYPE_XBOX360W:
1000                 packet->data[0] = 0x00;
1001                 packet->data[1] = 0x01;
1002                 packet->data[2] = 0x0F;
1003                 packet->data[3] = 0xC0;
1004                 packet->data[4] = 0x00;
1005                 packet->data[5] = strong / 256;
1006                 packet->data[6] = weak / 256;
1007                 packet->data[7] = 0x00;
1008                 packet->data[8] = 0x00;
1009                 packet->data[9] = 0x00;
1010                 packet->data[10] = 0x00;
1011                 packet->data[11] = 0x00;
1012                 packet->len = 12;
1013                 packet->pending = true;
1014                 break;
1015 
1016         case XTYPE_XBOXONE:
1017                 packet->data[0] = 0x09; /* activate rumble */
1018                 packet->data[1] = 0x08;
1019                 packet->data[2] = xpad->odata_serial++;
1020                 packet->data[3] = 0x08; /* continuous effect */
1021                 packet->data[4] = 0x00; /* simple rumble mode */
1022                 packet->data[5] = 0x03; /* L and R actuator only */
1023                 packet->data[6] = 0x00; /* TODO: LT actuator */
1024                 packet->data[7] = 0x00; /* TODO: RT actuator */
1025                 packet->data[8] = strong / 512; /* left actuator */
1026                 packet->data[9] = weak / 512;   /* right actuator */
1027                 packet->data[10] = 0x80;        /* length of pulse */
1028                 packet->data[11] = 0x00;        /* stop period of pulse */
1029                 packet->data[12] = 0x00;
1030                 packet->len = 13;
1031                 packet->pending = true;
1032                 break;
1033 
1034         default:
1035                 dev_dbg(&xpad->dev->dev,
1036                         "%s - rumble command sent to unsupported xpad type: %d\n",
1037                         __func__, xpad->xtype);
1038                 retval = -EINVAL;
1039                 goto out;
1040         }
1041 
1042         retval = xpad_try_sending_next_out_packet(xpad);
1043 
1044 out:
1045         spin_unlock_irqrestore(&xpad->odata_lock, flags);
1046         return retval;
1047 }
1048 
1049 static int xpad_init_ff(struct usb_xpad *xpad)
1050 {
1051         if (xpad->xtype == XTYPE_UNKNOWN)
1052                 return 0;
1053 
1054         input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
1055 
1056         return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
1057 }
1058 
1059 #else
1060 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
1061 #endif
1062 
1063 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
1064 #include <linux/leds.h>
1065 #include <linux/idr.h>
1066 
1067 static DEFINE_IDA(xpad_pad_seq);
1068 
1069 struct xpad_led {
1070         char name[16];
1071         struct led_classdev led_cdev;
1072         struct usb_xpad *xpad;
1073 };
1074 
1075 /**
1076  * set the LEDs on Xbox360 / Wireless Controllers
1077  * @param command
1078  *  0: off
1079  *  1: all blink, then previous setting
1080  *  2: 1/top-left blink, then on
1081  *  3: 2/top-right blink, then on
1082  *  4: 3/bottom-left blink, then on
1083  *  5: 4/bottom-right blink, then on
1084  *  6: 1/top-left on
1085  *  7: 2/top-right on
1086  *  8: 3/bottom-left on
1087  *  9: 4/bottom-right on
1088  * 10: rotate
1089  * 11: blink, based on previous setting
1090  * 12: slow blink, based on previous setting
1091  * 13: rotate with two lights
1092  * 14: persistent slow all blink
1093  * 15: blink once, then previous setting
1094  */
1095 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
1096 {
1097         struct xpad_output_packet *packet =
1098                         &xpad->out_packets[XPAD_OUT_LED_IDX];
1099         unsigned long flags;
1100 
1101         command %= 16;
1102 
1103         spin_lock_irqsave(&xpad->odata_lock, flags);
1104 
1105         switch (xpad->xtype) {
1106         case XTYPE_XBOX360:
1107                 packet->data[0] = 0x01;
1108                 packet->data[1] = 0x03;
1109                 packet->data[2] = command;
1110                 packet->len = 3;
1111                 packet->pending = true;
1112                 break;
1113 
1114         case XTYPE_XBOX360W:
1115                 packet->data[0] = 0x00;
1116                 packet->data[1] = 0x00;
1117                 packet->data[2] = 0x08;
1118                 packet->data[3] = 0x40 + command;
1119                 packet->data[4] = 0x00;
1120                 packet->data[5] = 0x00;
1121                 packet->data[6] = 0x00;
1122                 packet->data[7] = 0x00;
1123                 packet->data[8] = 0x00;
1124                 packet->data[9] = 0x00;
1125                 packet->data[10] = 0x00;
1126                 packet->data[11] = 0x00;
1127                 packet->len = 12;
1128                 packet->pending = true;
1129                 break;
1130         }
1131 
1132         xpad_try_sending_next_out_packet(xpad);
1133 
1134         spin_unlock_irqrestore(&xpad->odata_lock, flags);
1135 }
1136 
1137 /*
1138  * Light up the segment corresponding to the pad number on
1139  * Xbox 360 Controllers.
1140  */
1141 static void xpad_identify_controller(struct usb_xpad *xpad)
1142 {
1143         led_set_brightness(&xpad->led->led_cdev, (xpad->pad_nr % 4) + 2);
1144 }
1145 
1146 static void xpad_led_set(struct led_classdev *led_cdev,
1147                          enum led_brightness value)
1148 {
1149         struct xpad_led *xpad_led = container_of(led_cdev,
1150                                                  struct xpad_led, led_cdev);
1151 
1152         xpad_send_led_command(xpad_led->xpad, value);
1153 }
1154 
1155 static int xpad_led_probe(struct usb_xpad *xpad)
1156 {
1157         struct xpad_led *led;
1158         struct led_classdev *led_cdev;
1159         int error;
1160 
1161         if (xpad->xtype != XTYPE_XBOX360 && xpad->xtype != XTYPE_XBOX360W)
1162                 return 0;
1163 
1164         xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
1165         if (!led)
1166                 return -ENOMEM;
1167 
1168         xpad->pad_nr = ida_simple_get(&xpad_pad_seq, 0, 0, GFP_KERNEL);
1169         if (xpad->pad_nr < 0) {
1170                 error = xpad->pad_nr;
1171                 goto err_free_mem;
1172         }
1173 
1174         snprintf(led->name, sizeof(led->name), "xpad%d", xpad->pad_nr);
1175         led->xpad = xpad;
1176 
1177         led_cdev = &led->led_cdev;
1178         led_cdev->name = led->name;
1179         led_cdev->brightness_set = xpad_led_set;
1180 
1181         error = led_classdev_register(&xpad->udev->dev, led_cdev);
1182         if (error)
1183                 goto err_free_id;
1184 
1185         xpad_identify_controller(xpad);
1186 
1187         return 0;
1188 
1189 err_free_id:
1190         ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1191 err_free_mem:
1192         kfree(led);
1193         xpad->led = NULL;
1194         return error;
1195 }
1196 
1197 static void xpad_led_disconnect(struct usb_xpad *xpad)
1198 {
1199         struct xpad_led *xpad_led = xpad->led;
1200 
1201         if (xpad_led) {
1202                 led_classdev_unregister(&xpad_led->led_cdev);
1203                 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1204                 kfree(xpad_led);
1205         }
1206 }
1207 #else
1208 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
1209 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
1210 #endif
1211 
1212 static int xpad_start_input(struct usb_xpad *xpad)
1213 {
1214         int error;
1215 
1216         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
1217                 return -EIO;
1218 
1219         if (xpad->xtype == XTYPE_XBOXONE) {
1220                 error = xpad_start_xbox_one(xpad);
1221                 if (error) {
1222                         usb_kill_urb(xpad->irq_in);
1223                         return error;
1224                 }
1225         }
1226 
1227         return 0;
1228 }
1229 
1230 static void xpad_stop_input(struct usb_xpad *xpad)
1231 {
1232         usb_kill_urb(xpad->irq_in);
1233 }
1234 
1235 static int xpad360w_start_input(struct usb_xpad *xpad)
1236 {
1237         int error;
1238 
1239         error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1240         if (error)
1241                 return -EIO;
1242 
1243         /*
1244          * Send presence packet.
1245          * This will force the controller to resend connection packets.
1246          * This is useful in the case we activate the module after the
1247          * adapter has been plugged in, as it won't automatically
1248          * send us info about the controllers.
1249          */
1250         error = xpad_inquiry_pad_presence(xpad);
1251         if (error) {
1252                 usb_kill_urb(xpad->irq_in);
1253                 return error;
1254         }
1255 
1256         return 0;
1257 }
1258 
1259 static void xpad360w_stop_input(struct usb_xpad *xpad)
1260 {
1261         usb_kill_urb(xpad->irq_in);
1262 
1263         /* Make sure we are done with presence work if it was scheduled */
1264         flush_work(&xpad->work);
1265 }
1266 
1267 static int xpad_open(struct input_dev *dev)
1268 {
1269         struct usb_xpad *xpad = input_get_drvdata(dev);
1270 
1271         return xpad_start_input(xpad);
1272 }
1273 
1274 static void xpad_close(struct input_dev *dev)
1275 {
1276         struct usb_xpad *xpad = input_get_drvdata(dev);
1277 
1278         xpad_stop_input(xpad);
1279 }
1280 
1281 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
1282 {
1283         struct usb_xpad *xpad = input_get_drvdata(input_dev);
1284         set_bit(abs, input_dev->absbit);
1285 
1286         switch (abs) {
1287         case ABS_X:
1288         case ABS_Y:
1289         case ABS_RX:
1290         case ABS_RY:    /* the two sticks */
1291                 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
1292                 break;
1293         case ABS_Z:
1294         case ABS_RZ:    /* the triggers (if mapped to axes) */
1295                 if (xpad->xtype == XTYPE_XBOXONE)
1296                         input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
1297                 else
1298                         input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
1299                 break;
1300         case ABS_HAT0X:
1301         case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
1302                 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
1303                 break;
1304         }
1305 }
1306 
1307 static void xpad_deinit_input(struct usb_xpad *xpad)
1308 {
1309         if (xpad->input_created) {
1310                 xpad->input_created = false;
1311                 xpad_led_disconnect(xpad);
1312                 input_unregister_device(xpad->dev);
1313         }
1314 }
1315 
1316 static int xpad_init_input(struct usb_xpad *xpad)
1317 {
1318         struct input_dev *input_dev;
1319         int i, error;
1320 
1321         input_dev = input_allocate_device();
1322         if (!input_dev)
1323                 return -ENOMEM;
1324 
1325         xpad->dev = input_dev;
1326         input_dev->name = xpad->name;
1327         input_dev->phys = xpad->phys;
1328         usb_to_input_id(xpad->udev, &input_dev->id);
1329         input_dev->dev.parent = &xpad->intf->dev;
1330 
1331         input_set_drvdata(input_dev, xpad);
1332 
1333         if (xpad->xtype != XTYPE_XBOX360W) {
1334                 input_dev->open = xpad_open;
1335                 input_dev->close = xpad_close;
1336         }
1337 
1338         __set_bit(EV_KEY, input_dev->evbit);
1339 
1340         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1341                 __set_bit(EV_ABS, input_dev->evbit);
1342                 /* set up axes */
1343                 for (i = 0; xpad_abs[i] >= 0; i++)
1344                         xpad_set_up_abs(input_dev, xpad_abs[i]);
1345         }
1346 
1347         /* set up standard buttons */
1348         for (i = 0; xpad_common_btn[i] >= 0; i++)
1349                 __set_bit(xpad_common_btn[i], input_dev->keybit);
1350 
1351         /* set up model-specific ones */
1352         if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1353             xpad->xtype == XTYPE_XBOXONE) {
1354                 for (i = 0; xpad360_btn[i] >= 0; i++)
1355                         __set_bit(xpad360_btn[i], input_dev->keybit);
1356         } else {
1357                 for (i = 0; xpad_btn[i] >= 0; i++)
1358                         __set_bit(xpad_btn[i], input_dev->keybit);
1359         }
1360 
1361         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1362                 for (i = 0; xpad_btn_pad[i] >= 0; i++)
1363                         __set_bit(xpad_btn_pad[i], input_dev->keybit);
1364         }
1365 
1366         /*
1367          * This should be a simple else block. However historically
1368          * xbox360w has mapped DPAD to buttons while xbox360 did not. This
1369          * made no sense, but now we can not just switch back and have to
1370          * support both behaviors.
1371          */
1372         if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
1373             xpad->xtype == XTYPE_XBOX360W) {
1374                 for (i = 0; xpad_abs_pad[i] >= 0; i++)
1375                         xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
1376         }
1377 
1378         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1379                 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
1380                         __set_bit(xpad_btn_triggers[i], input_dev->keybit);
1381         } else {
1382                 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
1383                         xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
1384         }
1385 
1386         error = xpad_init_ff(xpad);
1387         if (error)
1388                 goto err_free_input;
1389 
1390         error = xpad_led_probe(xpad);
1391         if (error)
1392                 goto err_destroy_ff;
1393 
1394         error = input_register_device(xpad->dev);
1395         if (error)
1396                 goto err_disconnect_led;
1397 
1398         xpad->input_created = true;
1399         return 0;
1400 
1401 err_disconnect_led:
1402         xpad_led_disconnect(xpad);
1403 err_destroy_ff:
1404         input_ff_destroy(input_dev);
1405 err_free_input:
1406         input_free_device(input_dev);
1407         return error;
1408 }
1409 
1410 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
1411 {
1412         struct usb_device *udev = interface_to_usbdev(intf);
1413         struct usb_xpad *xpad;
1414         struct usb_endpoint_descriptor *ep_irq_in;
1415         int ep_irq_in_idx;
1416         int i, error;
1417 
1418         for (i = 0; xpad_device[i].idVendor; i++) {
1419                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
1420                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
1421                         break;
1422         }
1423 
1424         if (xpad_device[i].xtype == XTYPE_XBOXONE &&
1425             intf->cur_altsetting->desc.bInterfaceNumber != 0) {
1426                 /*
1427                  * The Xbox One controller lists three interfaces all with the
1428                  * same interface class, subclass and protocol. Differentiate by
1429                  * interface number.
1430                  */
1431                 return -ENODEV;
1432         }
1433 
1434         xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
1435         if (!xpad)
1436                 return -ENOMEM;
1437 
1438         usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
1439         strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
1440 
1441         xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
1442                                          GFP_KERNEL, &xpad->idata_dma);
1443         if (!xpad->idata) {
1444                 error = -ENOMEM;
1445                 goto err_free_mem;
1446         }
1447 
1448         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
1449         if (!xpad->irq_in) {
1450                 error = -ENOMEM;
1451                 goto err_free_idata;
1452         }
1453 
1454         xpad->udev = udev;
1455         xpad->intf = intf;
1456         xpad->mapping = xpad_device[i].mapping;
1457         xpad->xtype = xpad_device[i].xtype;
1458         xpad->name = xpad_device[i].name;
1459         INIT_WORK(&xpad->work, xpad_presence_work);
1460 
1461         if (xpad->xtype == XTYPE_UNKNOWN) {
1462                 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
1463                         if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
1464                                 xpad->xtype = XTYPE_XBOX360W;
1465                         else
1466                                 xpad->xtype = XTYPE_XBOX360;
1467                 } else {
1468                         xpad->xtype = XTYPE_XBOX;
1469                 }
1470 
1471                 if (dpad_to_buttons)
1472                         xpad->mapping |= MAP_DPAD_TO_BUTTONS;
1473                 if (triggers_to_buttons)
1474                         xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
1475                 if (sticks_to_null)
1476                         xpad->mapping |= MAP_STICKS_TO_NULL;
1477         }
1478 
1479         error = xpad_init_output(intf, xpad);
1480         if (error)
1481                 goto err_free_in_urb;
1482 
1483         /* Xbox One controller has in/out endpoints swapped. */
1484         ep_irq_in_idx = xpad->xtype == XTYPE_XBOXONE ? 1 : 0;
1485         ep_irq_in = &intf->cur_altsetting->endpoint[ep_irq_in_idx].desc;
1486 
1487         usb_fill_int_urb(xpad->irq_in, udev,
1488                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
1489                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
1490                          xpad, ep_irq_in->bInterval);
1491         xpad->irq_in->transfer_dma = xpad->idata_dma;
1492         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1493 
1494         usb_set_intfdata(intf, xpad);
1495 
1496         if (xpad->xtype == XTYPE_XBOX360W) {
1497                 /*
1498                  * Submit the int URB immediately rather than waiting for open
1499                  * because we get status messages from the device whether
1500                  * or not any controllers are attached.  In fact, it's
1501                  * exactly the message that a controller has arrived that
1502                  * we're waiting for.
1503                  */
1504                 error = xpad360w_start_input(xpad);
1505                 if (error)
1506                         goto err_deinit_output;
1507                 /*
1508                  * Wireless controllers require RESET_RESUME to work properly
1509                  * after suspend. Ideally this quirk should be in usb core
1510                  * quirk list, but we have too many vendors producing these
1511                  * controllers and we'd need to maintain 2 identical lists
1512                  * here in this driver and in usb core.
1513                  */
1514                 udev->quirks |= USB_QUIRK_RESET_RESUME;
1515         } else {
1516                 error = xpad_init_input(xpad);
1517                 if (error)
1518                         goto err_deinit_output;
1519         }
1520         return 0;
1521 
1522 err_deinit_output:
1523         xpad_deinit_output(xpad);
1524 err_free_in_urb:
1525         usb_free_urb(xpad->irq_in);
1526 err_free_idata:
1527         usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1528 err_free_mem:
1529         kfree(xpad);
1530         return error;
1531 }
1532 
1533 static void xpad_disconnect(struct usb_interface *intf)
1534 {
1535         struct usb_xpad *xpad = usb_get_intfdata(intf);
1536 
1537         if (xpad->xtype == XTYPE_XBOX360W)
1538                 xpad360w_stop_input(xpad);
1539 
1540         xpad_deinit_input(xpad);
1541 
1542         /*
1543          * Now that both input device and LED device are gone we can
1544          * stop output URB.
1545          */
1546         xpad_stop_output(xpad);
1547 
1548         xpad_deinit_output(xpad);
1549 
1550         usb_free_urb(xpad->irq_in);
1551         usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1552                         xpad->idata, xpad->idata_dma);
1553 
1554         kfree(xpad);
1555 
1556         usb_set_intfdata(intf, NULL);
1557 }
1558 
1559 static int xpad_suspend(struct usb_interface *intf, pm_message_t message)
1560 {
1561         struct usb_xpad *xpad = usb_get_intfdata(intf);
1562         struct input_dev *input = xpad->dev;
1563 
1564         if (xpad->xtype == XTYPE_XBOX360W) {
1565                 /*
1566                  * Wireless controllers always listen to input so
1567                  * they are notified when controller shows up
1568                  * or goes away.
1569                  */
1570                 xpad360w_stop_input(xpad);
1571         } else {
1572                 mutex_lock(&input->mutex);
1573                 if (input->users)
1574                         xpad_stop_input(xpad);
1575                 mutex_unlock(&input->mutex);
1576         }
1577 
1578         xpad_stop_output(xpad);
1579 
1580         return 0;
1581 }
1582 
1583 static int xpad_resume(struct usb_interface *intf)
1584 {
1585         struct usb_xpad *xpad = usb_get_intfdata(intf);
1586         struct input_dev *input = xpad->dev;
1587         int retval = 0;
1588 
1589         if (xpad->xtype == XTYPE_XBOX360W) {
1590                 retval = xpad360w_start_input(xpad);
1591         } else {
1592                 mutex_lock(&input->mutex);
1593                 if (input->users)
1594                         retval = xpad_start_input(xpad);
1595                 mutex_unlock(&input->mutex);
1596         }
1597 
1598         return retval;
1599 }
1600 
1601 static struct usb_driver xpad_driver = {
1602         .name           = "xpad",
1603         .probe          = xpad_probe,
1604         .disconnect     = xpad_disconnect,
1605         .suspend        = xpad_suspend,
1606         .resume         = xpad_resume,
1607         .reset_resume   = xpad_resume,
1608         .id_table       = xpad_table,
1609 };
1610 
1611 module_usb_driver(xpad_driver);
1612 
1613 MODULE_AUTHOR(DRIVER_AUTHOR);
1614 MODULE_DESCRIPTION(DRIVER_DESC);
1615 MODULE_LICENSE("GPL");
1616 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us