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