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