drivers/input/joystick/xpad.c

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