drivers/input/joystick/xpad.c

   1 /*
   2  * X-Box gamepad driver
   3  *
   4  * Copyright (c) 2002 Marko Friedemann <mfr@bmx-chemnitz.de>
   5  *               2004 Oliver Schwartz <Oliver.Schwartz@gmx.de>,
   6  *                    Steven Toth <steve@toth.demon.co.uk>,
   7  *                    Franz Lehner <franz@caos.at>,
   8  *                    Ivan Hawkes <blackhawk@ivanhawkes.com>
   9  *               2005 Dominic Cerquetti <binary1230@yahoo.com>
  10  *               2006 Adam Buchbinder <adam.buchbinder@gmail.com>
  11  *               2007 Jan Kratochvil <honza@jikos.cz>
  12  *               2010 Christoph Fritz <chf.fritz@googlemail.com>
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License as
  16  * published by the Free Software Foundation; either version 2 of
  17  * the License, or (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  *
  28  *
  29  * This driver is based on:
  30  *  - information from     http://euc.jp/periphs/xbox-controller.ja.html
  31  *  - the iForce driver    drivers/char/joystick/iforce.c
  32  *  - the skeleton-driver  drivers/usb/usb-skeleton.c
  33  *  - Xbox 360 information http://www.free60.org/wiki/Gamepad
  34  *
  35  * Thanks to:
  36  *  - ITO Takayuki for providing essential xpad information on his website
  37  *  - Vojtech Pavlik     - iforce driver / input subsystem
  38  *  - Greg Kroah-Hartman - usb-skeleton driver
  39  *  - XBOX Linux project - extra USB id's
  40  *
  41  * TODO:
  42  *  - fine tune axes (especially trigger axes)
  43  *  - fix "analog" buttons (reported as digital now)
  44  *  - get rumble working
  45  *  - need USB IDs for other dance pads
  46  *
  47  * History:
  48  *
  49  * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
  50  *
  51  * 2002-07-02 - 0.0.2 : basic working version
  52  *  - all axes and 9 of the 10 buttons work (german InterAct device)
  53  *  - the black button does not work
  54  *
  55  * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
  56  *  - indentation fixes
  57  *  - usb + input init sequence fixes
  58  *
  59  * 2002-07-16 - 0.0.4 : minor changes, merge with Vojtech's v0.0.3
  60  *  - verified the lack of HID and report descriptors
  61  *  - verified that ALL buttons WORK
  62  *  - fixed d-pad to axes mapping
  63  *
  64  * 2002-07-17 - 0.0.5 : simplified d-pad handling
  65  *
  66  * 2004-10-02 - 0.0.6 : DDR pad support
  67  *  - borrowed from the XBOX linux kernel
  68  *  - USB id's for commonly used dance pads are present
  69  *  - dance pads will map D-PAD to buttons, not axes
  70  *  - pass the module paramater 'dpad_to_buttons' to force
  71  *    the D-PAD to map to buttons if your pad is not detected
  72  *
  73  * Later changes can be tracked in SCM.
  74  */
  75
  76 #include <linux/kernel.h>
  77 #include <linux/init.h>
  78 #include <linux/slab.h>
  79 #include <linux/stat.h>
  80 #include <linux/module.h>
  81 #include <linux/usb/input.h>
  82
  83 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
  84 #define DRIVER_DESC "X-Box pad driver"
  85
  86 #define XPAD_PKT_LEN 32
  87
  88 /* xbox d-pads should map to buttons, as is required for DDR pads
  89    but we map them to axes when possible to simplify things */
  90 #define MAP_DPAD_TO_BUTTONS             (1 << 0)
  91 #define MAP_TRIGGERS_TO_BUTTONS         (1 << 1)
  92 #define MAP_STICKS_TO_NULL              (1 << 2)
  93 #define DANCEPAD_MAP_CONFIG     (MAP_DPAD_TO_BUTTONS |                  \
  94                                 MAP_TRIGGERS_TO_BUTTONS | MAP_STICKS_TO_NULL)
  95
  96 #define XTYPE_XBOX        0
  97 #define XTYPE_XBOX360     1
  98 #define XTYPE_XBOX360W    2
  99 #define XTYPE_UNKNOWN     3
 100
 101 static bool dpad_to_buttons;
 102 module_param(dpad_to_buttons, bool, S_IRUGO);
 103 MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
 104
 105 static bool triggers_to_buttons;
 106 module_param(triggers_to_buttons, bool, S_IRUGO);
 107 MODULE_PARM_DESC(triggers_to_buttons, "Map triggers to buttons rather than axes for unknown pads");
 108
 109 static bool sticks_to_null;
 110 module_param(sticks_to_null, bool, S_IRUGO);
 111 MODULE_PARM_DESC(sticks_to_null, "Do not map sticks at all for unknown pads");
 112
 113 static const struct xpad_device {
 114         u16 idVendor;
 115         u16 idProduct;
 116         char *name;
 117         u8 mapping;
 118         u8 xtype;
 119 } xpad_device[] = {
 120         { 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", 0, XTYPE_XBOX },
 121         { 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", 0, XTYPE_XBOX },
 122         { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", 0, XTYPE_XBOX },
 123         { 0x045e, 0x0287, "Microsoft Xbox Controller S", 0, XTYPE_XBOX },
 124         { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
 125         { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
 126         { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
 127         { 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
 128         { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
 129         { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
 130         { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
 131         { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
 132         { 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
 133         { 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
 134         { 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
 135         { 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
 136         { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
 137         { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
 138         { 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
 139         { 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
 140         { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
 141         { 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
 142         { 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
 143         { 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
 144         { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
 145         { 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
 146         { 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
 147         { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
 148         { 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
 149         { 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
 150         { 0x0e6f, 0x0006, "Pelican 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
 151         { 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
 152         { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
 153         { 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
 154         { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
 155         { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
 156         { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
 157         { 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
 158         { 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
 159         { 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
 160         { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
 161         { 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
 162         { 0x045e, 0x028e, "Microsoft X-Box 360 pad", 0, XTYPE_XBOX360 },
 163         { 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
 164         { 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
 165         { 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
 166         { 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
 167         { 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
 168         { 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
 169 };
 170
 171 /* buttons shared with xbox and xbox360 */
 172 static const signed short xpad_common_btn[] = {
 173         BTN_A, BTN_B, BTN_X, BTN_Y,                     /* "analog" buttons */
 174         BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR,  /* start/back/sticks */
 175         -1                                              /* terminating entry */
 176 };
 177
 178 /* original xbox controllers only */
 179 static const signed short xpad_btn[] = {
 180         BTN_C, BTN_Z,           /* "analog" buttons */
 181         -1                      /* terminating entry */
 182 };
 183
 184 /* used when dpad is mapped to buttons */
 185 static const signed short xpad_btn_pad[] = {
 186         BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2,         /* d-pad left, right */
 187         BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4,         /* d-pad up, down */
 188         -1                              /* terminating entry */
 189 };
 190
 191 /* used when triggers are mapped to buttons */
 192 static const signed short xpad_btn_triggers[] = {
 193         BTN_TL2, BTN_TR2,               /* triggers left/right */
 194         -1
 195 };
 196
 197
 198 static const signed short xpad360_btn[] = {  /* buttons for x360 controller */
 199         BTN_TL, BTN_TR,         /* Button LB/RB */
 200         BTN_MODE,               /* The big X button */
 201         -1
 202 };
 203
 204 static const signed short xpad_abs[] = {
 205         ABS_X, ABS_Y,           /* left stick */
 206         ABS_RX, ABS_RY,         /* right stick */
 207         -1                      /* terminating entry */
 208 };
 209
 210 /* used when dpad is mapped to axes */
 211 static const signed short xpad_abs_pad[] = {
 212         ABS_HAT0X, ABS_HAT0Y,   /* d-pad axes */
 213         -1                      /* terminating entry */
 214 };
 215
 216 /* used when triggers are mapped to axes */
 217 static const signed short xpad_abs_triggers[] = {
 218         ABS_Z, ABS_RZ,          /* triggers left/right */
 219         -1
 220 };
 221
 222 /* Xbox 360 has a vendor-specific class, so we cannot match it with only
 223  * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
 224  * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
 225  * wireless controllers have protocol 129. */
 226 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
 227         .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
 228         .idVendor = (vend), \
 229         .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
 230         .bInterfaceSubClass = 93, \
 231         .bInterfaceProtocol = (pr)
 232 #define XPAD_XBOX360_VENDOR(vend) \
 233         { XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
 234         { XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
 235
 236 static struct usb_device_id xpad_table [] = {
 237         { USB_INTERFACE_INFO('X', 'B', 0) },    /* X-Box USB-IF not approved class */
 238         XPAD_XBOX360_VENDOR(0x045e),            /* Microsoft X-Box 360 controllers */
 239         XPAD_XBOX360_VENDOR(0x046d),            /* Logitech X-Box 360 style controllers */
 240         XPAD_XBOX360_VENDOR(0x0738),            /* Mad Catz X-Box 360 controllers */
 241         XPAD_XBOX360_VENDOR(0x0e6f),            /* 0x0e6f X-Box 360 controllers */
 242         XPAD_XBOX360_VENDOR(0x12ab),            /* X-Box 360 dance pads */
 243         XPAD_XBOX360_VENDOR(0x1430),            /* RedOctane X-Box 360 controllers */
 244         XPAD_XBOX360_VENDOR(0x146b),            /* BigBen Interactive Controllers */
 245         XPAD_XBOX360_VENDOR(0x1bad),            /* Harminix Rock Band Guitar and Drums */
 246         XPAD_XBOX360_VENDOR(0x0f0d),            /* Hori Controllers */
 247         { }
 248 };
 249
 250 MODULE_DEVICE_TABLE (usb, xpad_table);
 251
 252 struct usb_xpad {
 253         struct input_dev *dev;          /* input device interface */
 254         struct usb_device *udev;        /* usb device */
 255         struct usb_interface *intf;     /* usb interface */
 256
 257         int pad_present;
 258
 259         struct urb *irq_in;             /* urb for interrupt in report */
 260         unsigned char *idata;           /* input data */
 261         dma_addr_t idata_dma;
 262
 263         struct urb *bulk_out;
 264         unsigned char *bdata;
 265
 266 #if defined(CONFIG_JOYSTICK_XPAD_FF) || defined(CONFIG_JOYSTICK_XPAD_LEDS)
 267         struct urb *irq_out;            /* urb for interrupt out report */
 268         unsigned char *odata;           /* output data */
 269         dma_addr_t odata_dma;
 270         struct mutex odata_mutex;
 271 #endif
 272
 273 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
 274         struct xpad_led *led;
 275 #endif
 276
 277         char phys[64];                  /* physical device path */
 278
 279         int mapping;                    /* map d-pad to buttons or to axes */
 280         int xtype;                      /* type of xbox device */
 281 };
 282
 283 /*
 284  *      xpad_process_packet
 285  *
 286  *      Completes a request by converting the data into events for the
 287  *      input subsystem.
 288  *
 289  *      The used report descriptor was taken from ITO Takayukis website:
 290  *       http://euc.jp/periphs/xbox-controller.ja.html
 291  */
 292
 293 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
 294 {
 295         struct input_dev *dev = xpad->dev;
 296
 297         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
 298                 /* left stick */
 299                 input_report_abs(dev, ABS_X,
 300                                  (__s16) le16_to_cpup((__le16 *)(data + 12)));
 301                 input_report_abs(dev, ABS_Y,
 302                                  ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
 303
 304                 /* right stick */
 305                 input_report_abs(dev, ABS_RX,
 306                                  (__s16) le16_to_cpup((__le16 *)(data + 16)));
 307                 input_report_abs(dev, ABS_RY,
 308                                  ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
 309         }
 310
 311         /* triggers left/right */
 312         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
 313                 input_report_key(dev, BTN_TL2, data[10]);
 314                 input_report_key(dev, BTN_TR2, data[11]);
 315         } else {
 316                 input_report_abs(dev, ABS_Z, data[10]);
 317                 input_report_abs(dev, ABS_RZ, data[11]);
 318         }
 319
 320         /* digital pad */
 321         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
 322                 /* dpad as buttons (left, right, up, down) */
 323                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
 324                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
 325                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
 326                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
 327         } else {
 328                 input_report_abs(dev, ABS_HAT0X,
 329                                  !!(data[2] & 0x08) - !!(data[2] & 0x04));
 330                 input_report_abs(dev, ABS_HAT0Y,
 331                                  !!(data[2] & 0x02) - !!(data[2] & 0x01));
 332         }
 333
 334         /* start/back buttons and stick press left/right */
 335         input_report_key(dev, BTN_START,  data[2] & 0x10);
 336         input_report_key(dev, BTN_SELECT, data[2] & 0x20);
 337         input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
 338         input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
 339
 340         /* "analog" buttons A, B, X, Y */
 341         input_report_key(dev, BTN_A, data[4]);
 342         input_report_key(dev, BTN_B, data[5]);
 343         input_report_key(dev, BTN_X, data[6]);
 344         input_report_key(dev, BTN_Y, data[7]);
 345
 346         /* "analog" buttons black, white */
 347         input_report_key(dev, BTN_C, data[8]);
 348         input_report_key(dev, BTN_Z, data[9]);
 349
 350         input_sync(dev);
 351 }
 352
 353 /*
 354  *      xpad360_process_packet
 355  *
 356  *      Completes a request by converting the data into events for the
 357  *      input subsystem. It is version for xbox 360 controller
 358  *
 359  *      The used report descriptor was taken from:
 360  *              http://www.free60.org/wiki/Gamepad
 361  */
 362
 363 static void xpad360_process_packet(struct usb_xpad *xpad,
 364                                    u16 cmd, unsigned char *data)
 365 {
 366         struct input_dev *dev = xpad->dev;
 367
 368         /* digital pad */
 369         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
 370                 /* dpad as buttons (left, right, up, down) */
 371                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
 372                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
 373                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
 374                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
 375         } else {
 376                 input_report_abs(dev, ABS_HAT0X,
 377                                  !!(data[2] & 0x08) - !!(data[2] & 0x04));
 378                 input_report_abs(dev, ABS_HAT0Y,
 379                                  !!(data[2] & 0x02) - !!(data[2] & 0x01));
 380         }
 381
 382         /* start/back buttons */
 383         input_report_key(dev, BTN_START,  data[2] & 0x10);
 384         input_report_key(dev, BTN_SELECT, data[2] & 0x20);
 385
 386         /* stick press left/right */
 387         input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
 388         input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
 389
 390         /* buttons A,B,X,Y,TL,TR and MODE */
 391         input_report_key(dev, BTN_A,    data[3] & 0x10);
 392         input_report_key(dev, BTN_B,    data[3] & 0x20);
 393         input_report_key(dev, BTN_X,    data[3] & 0x40);
 394         input_report_key(dev, BTN_Y,    data[3] & 0x80);
 395         input_report_key(dev, BTN_TL,   data[3] & 0x01);
 396         input_report_key(dev, BTN_TR,   data[3] & 0x02);
 397         input_report_key(dev, BTN_MODE, data[3] & 0x04);
 398
 399         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
 400                 /* left stick */
 401                 input_report_abs(dev, ABS_X,
 402                                  (__s16) le16_to_cpup((__le16 *)(data + 6)));
 403                 input_report_abs(dev, ABS_Y,
 404                                  ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
 405
 406                 /* right stick */
 407                 input_report_abs(dev, ABS_RX,
 408                                  (__s16) le16_to_cpup((__le16 *)(data + 10)));
 409                 input_report_abs(dev, ABS_RY,
 410                                  ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
 411         }
 412
 413         /* triggers left/right */
 414         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
 415                 input_report_key(dev, BTN_TL2, data[4]);
 416                 input_report_key(dev, BTN_TR2, data[5]);
 417         } else {
 418                 input_report_abs(dev, ABS_Z, data[4]);
 419                 input_report_abs(dev, ABS_RZ, data[5]);
 420         }
 421
 422         input_sync(dev);
 423 }
 424
 425 /*
 426  * xpad360w_process_packet
 427  *
 428  * Completes a request by converting the data into events for the
 429  * input subsystem. It is version for xbox 360 wireless controller.
 430  *
 431  * Byte.Bit
 432  * 00.1 - Status change: The controller or headset has connected/disconnected
 433  *                       Bits 01.7 and 01.6 are valid
 434  * 01.7 - Controller present
 435  * 01.6 - Headset present
 436  * 01.1 - Pad state (Bytes 4+) valid
 437  *
 438  */
 439
 440 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
 441 {
 442         /* Presence change */
 443         if (data[0] & 0x08) {
 444                 if (data[1] & 0x80) {
 445                         xpad->pad_present = 1;
 446                         usb_submit_urb(xpad->bulk_out, GFP_ATOMIC);
 447                 } else
 448                         xpad->pad_present = 0;
 449         }
 450
 451         /* Valid pad data */
 452         if (!(data[1] & 0x1))
 453                 return;
 454
 455         xpad360_process_packet(xpad, cmd, &data[4]);
 456 }
 457
 458 static void xpad_irq_in(struct urb *urb)
 459 {
 460         struct usb_xpad *xpad = urb->context;
 461         struct device *dev = &xpad->intf->dev;
 462         int retval, status;
 463
 464         status = urb->status;
 465
 466         switch (status) {
 467         case 0:
 468                 /* success */
 469                 break;
 470         case -ECONNRESET:
 471         case -ENOENT:
 472         case -ESHUTDOWN:
 473                 /* this urb is terminated, clean up */
 474                 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
 475                         __func__, status);
 476                 return;
 477         default:
 478                 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
 479                         __func__, status);
 480                 goto exit;
 481         }
 482
 483         switch (xpad->xtype) {
 484         case XTYPE_XBOX360:
 485                 xpad360_process_packet(xpad, 0, xpad->idata);
 486                 break;
 487         case XTYPE_XBOX360W:
 488                 xpad360w_process_packet(xpad, 0, xpad->idata);
 489                 break;
 490         default:
 491                 xpad_process_packet(xpad, 0, xpad->idata);
 492         }
 493
 494 exit:
 495         retval = usb_submit_urb(urb, GFP_ATOMIC);
 496         if (retval)
 497                 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
 498                         __func__, retval);
 499 }
 500
 501 static void xpad_bulk_out(struct urb *urb)
 502 {
 503         struct usb_xpad *xpad = urb->context;
 504         struct device *dev = &xpad->intf->dev;
 505
 506         switch (urb->status) {
 507         case 0:
 508                 /* success */
 509                 break;
 510         case -ECONNRESET:
 511         case -ENOENT:
 512         case -ESHUTDOWN:
 513                 /* this urb is terminated, clean up */
 514                 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
 515                         __func__, urb->status);
 516                 break;
 517         default:
 518                 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
 519                         __func__, urb->status);
 520         }
 521 }
 522
 523 #if defined(CONFIG_JOYSTICK_XPAD_FF) || defined(CONFIG_JOYSTICK_XPAD_LEDS)
 524 static void xpad_irq_out(struct urb *urb)
 525 {
 526         struct usb_xpad *xpad = urb->context;
 527         struct device *dev = &xpad->intf->dev;
 528         int retval, status;
 529
 530         status = urb->status;
 531
 532         switch (status) {
 533         case 0:
 534                 /* success */
 535                 return;
 536
 537         case -ECONNRESET:
 538         case -ENOENT:
 539         case -ESHUTDOWN:
 540                 /* this urb is terminated, clean up */
 541                 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
 542                         __func__, status);
 543                 return;
 544
 545         default:
 546                 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
 547                         __func__, status);
 548                 goto exit;
 549         }
 550
 551 exit:
 552         retval = usb_submit_urb(urb, GFP_ATOMIC);
 553         if (retval)
 554                 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
 555                         __func__, retval);
 556 }
 557
 558 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
 559 {
 560         struct usb_endpoint_descriptor *ep_irq_out;
 561         int error;
 562
 563         if (xpad->xtype == XTYPE_UNKNOWN)
 564                 return 0;
 565
 566         xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
 567                                          GFP_KERNEL, &xpad->odata_dma);
 568         if (!xpad->odata) {
 569                 error = -ENOMEM;
 570                 goto fail1;
 571         }
 572
 573         mutex_init(&xpad->odata_mutex);
 574
 575         xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
 576         if (!xpad->irq_out) {
 577                 error = -ENOMEM;
 578                 goto fail2;
 579         }
 580
 581         ep_irq_out = &intf->cur_altsetting->endpoint[1].desc;
 582         usb_fill_int_urb(xpad->irq_out, xpad->udev,
 583                          usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
 584                          xpad->odata, XPAD_PKT_LEN,
 585                          xpad_irq_out, xpad, ep_irq_out->bInterval);
 586         xpad->irq_out->transfer_dma = xpad->odata_dma;
 587         xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 588
 589         return 0;
 590
 591  fail2: usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
 592  fail1: return error;
 593 }
 594
 595 static void xpad_stop_output(struct usb_xpad *xpad)
 596 {
 597         if (xpad->xtype != XTYPE_UNKNOWN)
 598                 usb_kill_urb(xpad->irq_out);
 599 }
 600
 601 static void xpad_deinit_output(struct usb_xpad *xpad)
 602 {
 603         if (xpad->xtype != XTYPE_UNKNOWN) {
 604                 usb_free_urb(xpad->irq_out);
 605                 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
 606                                 xpad->odata, xpad->odata_dma);
 607         }
 608 }
 609 #else
 610 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad) { return 0; }
 611 static void xpad_deinit_output(struct usb_xpad *xpad) {}
 612 static void xpad_stop_output(struct usb_xpad *xpad) {}
 613 #endif
 614
 615 #ifdef CONFIG_JOYSTICK_XPAD_FF
 616 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
 617 {
 618         struct usb_xpad *xpad = input_get_drvdata(dev);
 619
 620         if (effect->type == FF_RUMBLE) {
 621                 __u16 strong = effect->u.rumble.strong_magnitude;
 622                 __u16 weak = effect->u.rumble.weak_magnitude;
 623
 624                 switch (xpad->xtype) {
 625
 626                 case XTYPE_XBOX:
 627                         xpad->odata[0] = 0x00;
 628                         xpad->odata[1] = 0x06;
 629                         xpad->odata[2] = 0x00;
 630                         xpad->odata[3] = strong / 256;  /* left actuator */
 631                         xpad->odata[4] = 0x00;
 632                         xpad->odata[5] = weak / 256;    /* right actuator */
 633                         xpad->irq_out->transfer_buffer_length = 6;
 634
 635                         return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
 636
 637                 case XTYPE_XBOX360:
 638                         xpad->odata[0] = 0x00;
 639                         xpad->odata[1] = 0x08;
 640                         xpad->odata[2] = 0x00;
 641                         xpad->odata[3] = strong / 256;  /* left actuator? */
 642                         xpad->odata[4] = weak / 256;    /* right actuator? */
 643                         xpad->odata[5] = 0x00;
 644                         xpad->odata[6] = 0x00;
 645                         xpad->odata[7] = 0x00;
 646                         xpad->irq_out->transfer_buffer_length = 8;
 647
 648                         return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
 649
 650                 case XTYPE_XBOX360W:
 651                         xpad->odata[0] = 0x00;
 652                         xpad->odata[1] = 0x01;
 653                         xpad->odata[2] = 0x0F;
 654                         xpad->odata[3] = 0xC0;
 655                         xpad->odata[4] = 0x00;
 656                         xpad->odata[5] = strong / 256;
 657                         xpad->odata[6] = weak / 256;
 658                         xpad->odata[7] = 0x00;
 659                         xpad->odata[8] = 0x00;
 660                         xpad->odata[9] = 0x00;
 661                         xpad->odata[10] = 0x00;
 662                         xpad->odata[11] = 0x00;
 663                         xpad->irq_out->transfer_buffer_length = 12;
 664
 665                         return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
 666
 667                 default:
 668                         dev_dbg(&xpad->dev->dev,
 669                                 "%s - rumble command sent to unsupported xpad type: %d\n",
 670                                 __func__, xpad->xtype);
 671                         return -1;
 672                 }
 673         }
 674
 675         return 0;
 676 }
 677
 678 static int xpad_init_ff(struct usb_xpad *xpad)
 679 {
 680         if (xpad->xtype == XTYPE_UNKNOWN)
 681                 return 0;
 682
 683         input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
 684
 685         return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
 686 }
 687
 688 #else
 689 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
 690 #endif
 691
 692 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
 693 #include <linux/leds.h>
 694
 695 struct xpad_led {
 696         char name[16];
 697         struct led_classdev led_cdev;
 698         struct usb_xpad *xpad;
 699 };
 700
 701 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
 702 {
 703         if (command >= 0 && command < 14) {
 704                 mutex_lock(&xpad->odata_mutex);
 705                 xpad->odata[0] = 0x01;
 706                 xpad->odata[1] = 0x03;
 707                 xpad->odata[2] = command;
 708                 xpad->irq_out->transfer_buffer_length = 3;
 709                 usb_submit_urb(xpad->irq_out, GFP_KERNEL);
 710                 mutex_unlock(&xpad->odata_mutex);
 711         }
 712 }
 713
 714 static void xpad_led_set(struct led_classdev *led_cdev,
 715                          enum led_brightness value)
 716 {
 717         struct xpad_led *xpad_led = container_of(led_cdev,
 718                                                  struct xpad_led, led_cdev);
 719
 720         xpad_send_led_command(xpad_led->xpad, value);
 721 }
 722
 723 static int xpad_led_probe(struct usb_xpad *xpad)
 724 {
 725         static atomic_t led_seq = ATOMIC_INIT(0);
 726         long led_no;
 727         struct xpad_led *led;
 728         struct led_classdev *led_cdev;
 729         int error;
 730
 731         if (xpad->xtype != XTYPE_XBOX360)
 732                 return 0;
 733
 734         xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
 735         if (!led)
 736                 return -ENOMEM;
 737
 738         led_no = (long)atomic_inc_return(&led_seq) - 1;
 739
 740         snprintf(led->name, sizeof(led->name), "xpad%ld", led_no);
 741         led->xpad = xpad;
 742
 743         led_cdev = &led->led_cdev;
 744         led_cdev->name = led->name;
 745         led_cdev->brightness_set = xpad_led_set;
 746
 747         error = led_classdev_register(&xpad->udev->dev, led_cdev);
 748         if (error) {
 749                 kfree(led);
 750                 xpad->led = NULL;
 751                 return error;
 752         }
 753
 754         /*
 755          * Light up the segment corresponding to controller number
 756          */
 757         xpad_send_led_command(xpad, (led_no % 4) + 2);
 758
 759         return 0;
 760 }
 761
 762 static void xpad_led_disconnect(struct usb_xpad *xpad)
 763 {
 764         struct xpad_led *xpad_led = xpad->led;
 765
 766         if (xpad_led) {
 767                 led_classdev_unregister(&xpad_led->led_cdev);
 768                 kfree(xpad_led);
 769         }
 770 }
 771 #else
 772 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
 773 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
 774 #endif
 775
 776
 777 static int xpad_open(struct input_dev *dev)
 778 {
 779         struct usb_xpad *xpad = input_get_drvdata(dev);
 780
 781         /* URB was submitted in probe */
 782         if(xpad->xtype == XTYPE_XBOX360W)
 783                 return 0;
 784
 785         xpad->irq_in->dev = xpad->udev;
 786         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
 787                 return -EIO;
 788
 789         return 0;
 790 }
 791
 792 static void xpad_close(struct input_dev *dev)
 793 {
 794         struct usb_xpad *xpad = input_get_drvdata(dev);
 795
 796         if (xpad->xtype != XTYPE_XBOX360W)
 797                 usb_kill_urb(xpad->irq_in);
 798
 799         xpad_stop_output(xpad);
 800 }
 801
 802 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
 803 {
 804         set_bit(abs, input_dev->absbit);
 805
 806         switch (abs) {
 807         case ABS_X:
 808         case ABS_Y:
 809         case ABS_RX:
 810         case ABS_RY:    /* the two sticks */
 811                 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
 812                 break;
 813         case ABS_Z:
 814         case ABS_RZ:    /* the triggers (if mapped to axes) */
 815                 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
 816                 break;
 817         case ABS_HAT0X:
 818         case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
 819                 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
 820                 break;
 821         }
 822 }
 823
 824 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
 825 {
 826         struct usb_device *udev = interface_to_usbdev(intf);
 827         struct usb_xpad *xpad;
 828         struct input_dev *input_dev;
 829         struct usb_endpoint_descriptor *ep_irq_in;
 830         int i, error;
 831
 832         for (i = 0; xpad_device[i].idVendor; i++) {
 833                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
 834                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
 835                         break;
 836         }
 837
 838         xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
 839         input_dev = input_allocate_device();
 840         if (!xpad || !input_dev) {
 841                 error = -ENOMEM;
 842                 goto fail1;
 843         }
 844
 845         xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
 846                                          GFP_KERNEL, &xpad->idata_dma);
 847         if (!xpad->idata) {
 848                 error = -ENOMEM;
 849                 goto fail1;
 850         }
 851
 852         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
 853         if (!xpad->irq_in) {
 854                 error = -ENOMEM;
 855                 goto fail2;
 856         }
 857
 858         xpad->udev = udev;
 859         xpad->intf = intf;
 860         xpad->mapping = xpad_device[i].mapping;
 861         xpad->xtype = xpad_device[i].xtype;
 862
 863         if (xpad->xtype == XTYPE_UNKNOWN) {
 864                 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
 865                         if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
 866                                 xpad->xtype = XTYPE_XBOX360W;
 867                         else
 868                                 xpad->xtype = XTYPE_XBOX360;
 869                 } else
 870                         xpad->xtype = XTYPE_XBOX;
 871
 872                 if (dpad_to_buttons)
 873                         xpad->mapping |= MAP_DPAD_TO_BUTTONS;
 874                 if (triggers_to_buttons)
 875                         xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
 876                 if (sticks_to_null)
 877                         xpad->mapping |= MAP_STICKS_TO_NULL;
 878         }
 879
 880         xpad->dev = input_dev;
 881         usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
 882         strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
 883
 884         input_dev->name = xpad_device[i].name;
 885         input_dev->phys = xpad->phys;
 886         usb_to_input_id(udev, &input_dev->id);
 887         input_dev->dev.parent = &intf->dev;
 888
 889         input_set_drvdata(input_dev, xpad);
 890
 891         input_dev->open = xpad_open;
 892         input_dev->close = xpad_close;
 893
 894         input_dev->evbit[0] = BIT_MASK(EV_KEY);
 895
 896         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
 897                 input_dev->evbit[0] |= BIT_MASK(EV_ABS);
 898                 /* set up axes */
 899                 for (i = 0; xpad_abs[i] >= 0; i++)
 900                         xpad_set_up_abs(input_dev, xpad_abs[i]);
 901         }
 902
 903         /* set up standard buttons */
 904         for (i = 0; xpad_common_btn[i] >= 0; i++)
 905                 __set_bit(xpad_common_btn[i], input_dev->keybit);
 906
 907         /* set up model-specific ones */
 908         if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W) {
 909                 for (i = 0; xpad360_btn[i] >= 0; i++)
 910                         __set_bit(xpad360_btn[i], input_dev->keybit);
 911         } else {
 912                 for (i = 0; xpad_btn[i] >= 0; i++)
 913                         __set_bit(xpad_btn[i], input_dev->keybit);
 914         }
 915
 916         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
 917                 for (i = 0; xpad_btn_pad[i] >= 0; i++)
 918                         __set_bit(xpad_btn_pad[i], input_dev->keybit);
 919         } else {
 920                 for (i = 0; xpad_abs_pad[i] >= 0; i++)
 921                     xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
 922         }
 923
 924         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
 925                 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
 926                         __set_bit(xpad_btn_triggers[i], input_dev->keybit);
 927         } else {
 928                 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
 929                         xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
 930         }
 931
 932         error = xpad_init_output(intf, xpad);
 933         if (error)
 934                 goto fail3;
 935
 936         error = xpad_init_ff(xpad);
 937         if (error)
 938                 goto fail4;
 939
 940         error = xpad_led_probe(xpad);
 941         if (error)
 942                 goto fail5;
 943
 944         ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
 945         usb_fill_int_urb(xpad->irq_in, udev,
 946                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
 947                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
 948                          xpad, ep_irq_in->bInterval);
 949         xpad->irq_in->transfer_dma = xpad->idata_dma;
 950         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 951
 952         error = input_register_device(xpad->dev);
 953         if (error)
 954                 goto fail6;
 955
 956         usb_set_intfdata(intf, xpad);
 957
 958         if (xpad->xtype == XTYPE_XBOX360W) {
 959                 /*
 960                  * Setup the message to set the LEDs on the
 961                  * controller when it shows up
 962                  */
 963                 xpad->bulk_out = usb_alloc_urb(0, GFP_KERNEL);
 964                 if (!xpad->bulk_out) {
 965                         error = -ENOMEM;
 966                         goto fail7;
 967                 }
 968
 969                 xpad->bdata = kzalloc(XPAD_PKT_LEN, GFP_KERNEL);
 970                 if (!xpad->bdata) {
 971                         error = -ENOMEM;
 972                         goto fail8;
 973                 }
 974
 975                 xpad->bdata[2] = 0x08;
 976                 switch (intf->cur_altsetting->desc.bInterfaceNumber) {
 977                 case 0:
 978                         xpad->bdata[3] = 0x42;
 979                         break;
 980                 case 2:
 981                         xpad->bdata[3] = 0x43;
 982                         break;
 983                 case 4:
 984                         xpad->bdata[3] = 0x44;
 985                         break;
 986                 case 6:
 987                         xpad->bdata[3] = 0x45;
 988                 }
 989
 990                 ep_irq_in = &intf->cur_altsetting->endpoint[1].desc;
 991                 usb_fill_bulk_urb(xpad->bulk_out, udev,
 992                                 usb_sndbulkpipe(udev, ep_irq_in->bEndpointAddress),
 993                                 xpad->bdata, XPAD_PKT_LEN, xpad_bulk_out, xpad);
 994
 995                 /*
 996                  * Submit the int URB immediately rather than waiting for open
 997                  * because we get status messages from the device whether
 998                  * or not any controllers are attached.  In fact, it's
 999                  * exactly the message that a controller has arrived that
1000                  * we're waiting for.
1001                  */
1002                 xpad->irq_in->dev = xpad->udev;
1003                 error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1004                 if (error)
1005                         goto fail9;
1006         }
1007
1008         return 0;
1009
1010  fail9: kfree(xpad->bdata);
1011  fail8: usb_free_urb(xpad->bulk_out);
1012  fail7: input_unregister_device(input_dev);
1013         input_dev = NULL;
1014  fail6: xpad_led_disconnect(xpad);
1015  fail5: if (input_dev)
1016                 input_ff_destroy(input_dev);
1017  fail4: xpad_deinit_output(xpad);
1018  fail3: usb_free_urb(xpad->irq_in);
1019  fail2: usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1020  fail1: input_free_device(input_dev);
1021         kfree(xpad);
1022         return error;
1023
1024 }
1025
1026 static void xpad_disconnect(struct usb_interface *intf)
1027 {
1028         struct usb_xpad *xpad = usb_get_intfdata (intf);
1029
1030         xpad_led_disconnect(xpad);
1031         input_unregister_device(xpad->dev);
1032         xpad_deinit_output(xpad);
1033
1034         if (xpad->xtype == XTYPE_XBOX360W) {
1035                 usb_kill_urb(xpad->bulk_out);
1036                 usb_free_urb(xpad->bulk_out);
1037                 usb_kill_urb(xpad->irq_in);
1038         }
1039
1040         usb_free_urb(xpad->irq_in);
1041         usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1042                         xpad->idata, xpad->idata_dma);
1043
1044         kfree(xpad->bdata);
1045         kfree(xpad);
1046
1047         usb_set_intfdata(intf, NULL);
1048 }
1049
1050 static struct usb_driver xpad_driver = {
1051         .name           = "xpad",
1052         .probe          = xpad_probe,
1053         .disconnect     = xpad_disconnect,
1054         .id_table       = xpad_table,
1055 };
1056
1057 module_usb_driver(xpad_driver);
1058
1059 MODULE_AUTHOR(DRIVER_AUTHOR);
1060 MODULE_DESCRIPTION(DRIVER_DESC);
1061 MODULE_LICENSE("GPL");