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 int 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 int 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 int 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
 256         int pad_present;
 257
 258         struct urb *irq_in;             /* urb for interrupt in report */
 259         unsigned char *idata;           /* input data */
 260         dma_addr_t idata_dma;
 261
 262         struct urb *bulk_out;
 263         unsigned char *bdata;
 264
 265 #if defined(CONFIG_JOYSTICK_XPAD_FF) || defined(CONFIG_JOYSTICK_XPAD_LEDS)
 266         struct urb *irq_out;            /* urb for interrupt out report */
 267         unsigned char *odata;           /* output data */
 268         dma_addr_t odata_dma;
 269         struct mutex odata_mutex;
 270 #endif
 271
 272 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
 273         struct xpad_led *led;
 274 #endif
 275
 276         char phys[64];                  /* physical device path */
 277
 278         int mapping;                    /* map d-pad to buttons or to axes */
 279         int xtype;                      /* type of xbox device */
 280 };
 281
 282 /*
 283  *      xpad_process_packet
 284  *
 285  *      Completes a request by converting the data into events for the
 286  *      input subsystem.
 287  *
 288  *      The used report descriptor was taken from ITO Takayukis website:
 289  *       http://euc.jp/periphs/xbox-controller.ja.html
 290  */
 291
 292 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
 293 {
 294         struct input_dev *dev = xpad->dev;
 295
 296         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
 297                 /* left stick */
 298                 input_report_abs(dev, ABS_X,
 299                                  (__s16) le16_to_cpup((__le16 *)(data + 12)));
 300                 input_report_abs(dev, ABS_Y,
 301                                  ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
 302
 303                 /* right stick */
 304                 input_report_abs(dev, ABS_RX,
 305                                  (__s16) le16_to_cpup((__le16 *)(data + 16)));
 306                 input_report_abs(dev, ABS_RY,
 307                                  ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
 308         }
 309
 310         /* triggers left/right */
 311         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
 312                 input_report_key(dev, BTN_TL2, data[10]);
 313                 input_report_key(dev, BTN_TR2, data[11]);
 314         } else {
 315                 input_report_abs(dev, ABS_Z, data[10]);
 316                 input_report_abs(dev, ABS_RZ, data[11]);
 317         }
 318
 319         /* digital pad */
 320         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
 321                 /* dpad as buttons (left, right, up, down) */
 322                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
 323                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
 324                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
 325                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
 326         } else {
 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         }
 332
 333         /* start/back buttons and stick press left/right */
 334         input_report_key(dev, BTN_START,  data[2] & 0x10);
 335         input_report_key(dev, BTN_SELECT, data[2] & 0x20);
 336         input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
 337         input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
 338
 339         /* "analog" buttons A, B, X, Y */
 340         input_report_key(dev, BTN_A, data[4]);
 341         input_report_key(dev, BTN_B, data[5]);
 342         input_report_key(dev, BTN_X, data[6]);
 343         input_report_key(dev, BTN_Y, data[7]);
 344
 345         /* "analog" buttons black, white */
 346         input_report_key(dev, BTN_C, data[8]);
 347         input_report_key(dev, BTN_Z, data[9]);
 348
 349         input_sync(dev);
 350 }
 351
 352 /*
 353  *      xpad360_process_packet
 354  *
 355  *      Completes a request by converting the data into events for the
 356  *      input subsystem. It is version for xbox 360 controller
 357  *
 358  *      The used report descriptor was taken from:
 359  *              http://www.free60.org/wiki/Gamepad
 360  */
 361
 362 static void xpad360_process_packet(struct usb_xpad *xpad,
 363                                    u16 cmd, unsigned char *data)
 364 {
 365         struct input_dev *dev = xpad->dev;
 366
 367         /* digital pad */
 368         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
 369                 /* dpad as buttons (left, right, up, down) */
 370                 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
 371                 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
 372                 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
 373                 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
 374         } else {
 375                 input_report_abs(dev, ABS_HAT0X,
 376                                  !!(data[2] & 0x08) - !!(data[2] & 0x04));
 377                 input_report_abs(dev, ABS_HAT0Y,
 378                                  !!(data[2] & 0x02) - !!(data[2] & 0x01));
 379         }
 380
 381         /* start/back buttons */
 382         input_report_key(dev, BTN_START,  data[2] & 0x10);
 383         input_report_key(dev, BTN_SELECT, data[2] & 0x20);
 384
 385         /* stick press left/right */
 386         input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
 387         input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
 388
 389         /* buttons A,B,X,Y,TL,TR and MODE */
 390         input_report_key(dev, BTN_A,    data[3] & 0x10);
 391         input_report_key(dev, BTN_B,    data[3] & 0x20);
 392         input_report_key(dev, BTN_X,    data[3] & 0x40);
 393         input_report_key(dev, BTN_Y,    data[3] & 0x80);
 394         input_report_key(dev, BTN_TL,   data[3] & 0x01);
 395         input_report_key(dev, BTN_TR,   data[3] & 0x02);
 396         input_report_key(dev, BTN_MODE, data[3] & 0x04);
 397
 398         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
 399                 /* left stick */
 400                 input_report_abs(dev, ABS_X,
 401                                  (__s16) le16_to_cpup((__le16 *)(data + 6)));
 402                 input_report_abs(dev, ABS_Y,
 403                                  ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
 404
 405                 /* right stick */
 406                 input_report_abs(dev, ABS_RX,
 407                                  (__s16) le16_to_cpup((__le16 *)(data + 10)));
 408                 input_report_abs(dev, ABS_RY,
 409                                  ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
 410         }
 411
 412         /* triggers left/right */
 413         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
 414                 input_report_key(dev, BTN_TL2, data[4]);
 415                 input_report_key(dev, BTN_TR2, data[5]);
 416         } else {
 417                 input_report_abs(dev, ABS_Z, data[4]);
 418                 input_report_abs(dev, ABS_RZ, data[5]);
 419         }
 420
 421         input_sync(dev);
 422 }
 423
 424 /*
 425  * xpad360w_process_packet
 426  *
 427  * Completes a request by converting the data into events for the
 428  * input subsystem. It is version for xbox 360 wireless controller.
 429  *
 430  * Byte.Bit
 431  * 00.1 - Status change: The controller or headset has connected/disconnected
 432  *                       Bits 01.7 and 01.6 are valid
 433  * 01.7 - Controller present
 434  * 01.6 - Headset present
 435  * 01.1 - Pad state (Bytes 4+) valid
 436  *
 437  */
 438
 439 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
 440 {
 441         /* Presence change */
 442         if (data[0] & 0x08) {
 443                 if (data[1] & 0x80) {
 444                         xpad->pad_present = 1;
 445                         usb_submit_urb(xpad->bulk_out, GFP_ATOMIC);
 446                 } else
 447                         xpad->pad_present = 0;
 448         }
 449
 450         /* Valid pad data */
 451         if (!(data[1] & 0x1))
 452                 return;
 453
 454         xpad360_process_packet(xpad, cmd, &data[4]);
 455 }
 456
 457 static void xpad_irq_in(struct urb *urb)
 458 {
 459         struct usb_xpad *xpad = urb->context;
 460         int retval, status;
 461
 462         status = urb->status;
 463
 464         switch (status) {
 465         case 0:
 466                 /* success */
 467                 break;
 468         case -ECONNRESET:
 469         case -ENOENT:
 470         case -ESHUTDOWN:
 471                 /* this urb is terminated, clean up */
 472                 dbg("%s - urb shutting down with status: %d",
 473                         __func__, status);
 474                 return;
 475         default:
 476                 dbg("%s - nonzero urb status received: %d",
 477                         __func__, status);
 478                 goto exit;
 479         }
 480
 481         switch (xpad->xtype) {
 482         case XTYPE_XBOX360:
 483                 xpad360_process_packet(xpad, 0, xpad->idata);
 484                 break;
 485         case XTYPE_XBOX360W:
 486                 xpad360w_process_packet(xpad, 0, xpad->idata);
 487                 break;
 488         default:
 489                 xpad_process_packet(xpad, 0, xpad->idata);
 490         }
 491
 492 exit:
 493         retval = usb_submit_urb(urb, GFP_ATOMIC);
 494         if (retval)
 495                 err ("%s - usb_submit_urb failed with result %d",
 496                      __func__, retval);
 497 }
 498
 499 static void xpad_bulk_out(struct urb *urb)
 500 {
 501         switch (urb->status) {
 502         case 0:
 503                 /* success */
 504                 break;
 505         case -ECONNRESET:
 506         case -ENOENT:
 507         case -ESHUTDOWN:
 508                 /* this urb is terminated, clean up */
 509                 dbg("%s - urb shutting down with status: %d", __func__, urb->status);
 510                 break;
 511         default:
 512                 dbg("%s - nonzero urb status received: %d", __func__, urb->status);
 513         }
 514 }
 515
 516 #if defined(CONFIG_JOYSTICK_XPAD_FF) || defined(CONFIG_JOYSTICK_XPAD_LEDS)
 517 static void xpad_irq_out(struct urb *urb)
 518 {
 519         int retval, status;
 520
 521         status = urb->status;
 522
 523         switch (status) {
 524         case 0:
 525                 /* success */
 526                 return;
 527
 528         case -ECONNRESET:
 529         case -ENOENT:
 530         case -ESHUTDOWN:
 531                 /* this urb is terminated, clean up */
 532                 dbg("%s - urb shutting down with status: %d", __func__, status);
 533                 return;
 534
 535         default:
 536                 dbg("%s - nonzero urb status received: %d", __func__, status);
 537                 goto exit;
 538         }
 539
 540 exit:
 541         retval = usb_submit_urb(urb, GFP_ATOMIC);
 542         if (retval)
 543                 err("%s - usb_submit_urb failed with result %d",
 544                     __func__, retval);
 545 }
 546
 547 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
 548 {
 549         struct usb_endpoint_descriptor *ep_irq_out;
 550         int error;
 551
 552         if (xpad->xtype == XTYPE_UNKNOWN)
 553                 return 0;
 554
 555         xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
 556                                          GFP_KERNEL, &xpad->odata_dma);
 557         if (!xpad->odata) {
 558                 error = -ENOMEM;
 559                 goto fail1;
 560         }
 561
 562         mutex_init(&xpad->odata_mutex);
 563
 564         xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
 565         if (!xpad->irq_out) {
 566                 error = -ENOMEM;
 567                 goto fail2;
 568         }
 569
 570         ep_irq_out = &intf->cur_altsetting->endpoint[1].desc;
 571         usb_fill_int_urb(xpad->irq_out, xpad->udev,
 572                          usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
 573                          xpad->odata, XPAD_PKT_LEN,
 574                          xpad_irq_out, xpad, ep_irq_out->bInterval);
 575         xpad->irq_out->transfer_dma = xpad->odata_dma;
 576         xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 577
 578         return 0;
 579
 580  fail2: usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
 581  fail1: return error;
 582 }
 583
 584 static void xpad_stop_output(struct usb_xpad *xpad)
 585 {
 586         if (xpad->xtype != XTYPE_UNKNOWN)
 587                 usb_kill_urb(xpad->irq_out);
 588 }
 589
 590 static void xpad_deinit_output(struct usb_xpad *xpad)
 591 {
 592         if (xpad->xtype != XTYPE_UNKNOWN) {
 593                 usb_free_urb(xpad->irq_out);
 594                 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
 595                                 xpad->odata, xpad->odata_dma);
 596         }
 597 }
 598 #else
 599 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad) { return 0; }
 600 static void xpad_deinit_output(struct usb_xpad *xpad) {}
 601 static void xpad_stop_output(struct usb_xpad *xpad) {}
 602 #endif
 603
 604 #ifdef CONFIG_JOYSTICK_XPAD_FF
 605 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
 606 {
 607         struct usb_xpad *xpad = input_get_drvdata(dev);
 608
 609         if (effect->type == FF_RUMBLE) {
 610                 __u16 strong = effect->u.rumble.strong_magnitude;
 611                 __u16 weak = effect->u.rumble.weak_magnitude;
 612
 613                 switch (xpad->xtype) {
 614
 615                 case XTYPE_XBOX:
 616                         xpad->odata[0] = 0x00;
 617                         xpad->odata[1] = 0x06;
 618                         xpad->odata[2] = 0x00;
 619                         xpad->odata[3] = strong / 256;  /* left actuator */
 620                         xpad->odata[4] = 0x00;
 621                         xpad->odata[5] = weak / 256;    /* right actuator */
 622                         xpad->irq_out->transfer_buffer_length = 6;
 623
 624                         return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
 625
 626                 case XTYPE_XBOX360:
 627                         xpad->odata[0] = 0x00;
 628                         xpad->odata[1] = 0x08;
 629                         xpad->odata[2] = 0x00;
 630                         xpad->odata[3] = strong / 256;  /* left actuator? */
 631                         xpad->odata[4] = weak / 256;    /* right actuator? */
 632                         xpad->odata[5] = 0x00;
 633                         xpad->odata[6] = 0x00;
 634                         xpad->odata[7] = 0x00;
 635                         xpad->irq_out->transfer_buffer_length = 8;
 636
 637                         return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
 638
 639                 case XTYPE_XBOX360W:
 640                         xpad->odata[0] = 0x00;
 641                         xpad->odata[1] = 0x01;
 642                         xpad->odata[2] = 0x0F;
 643                         xpad->odata[3] = 0xC0;
 644                         xpad->odata[4] = 0x00;
 645                         xpad->odata[5] = strong / 256;
 646                         xpad->odata[6] = weak / 256;
 647                         xpad->odata[7] = 0x00;
 648                         xpad->odata[8] = 0x00;
 649                         xpad->odata[9] = 0x00;
 650                         xpad->odata[10] = 0x00;
 651                         xpad->odata[11] = 0x00;
 652                         xpad->irq_out->transfer_buffer_length = 12;
 653
 654                         return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
 655
 656                 default:
 657                         dbg("%s - rumble command sent to unsupported xpad type: %d",
 658                                 __func__, xpad->xtype);
 659                         return -1;
 660                 }
 661         }
 662
 663         return 0;
 664 }
 665
 666 static int xpad_init_ff(struct usb_xpad *xpad)
 667 {
 668         if (xpad->xtype == XTYPE_UNKNOWN)
 669                 return 0;
 670
 671         input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
 672
 673         return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
 674 }
 675
 676 #else
 677 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
 678 #endif
 679
 680 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
 681 #include <linux/leds.h>
 682
 683 struct xpad_led {
 684         char name[16];
 685         struct led_classdev led_cdev;
 686         struct usb_xpad *xpad;
 687 };
 688
 689 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
 690 {
 691         if (command >= 0 && command < 14) {
 692                 mutex_lock(&xpad->odata_mutex);
 693                 xpad->odata[0] = 0x01;
 694                 xpad->odata[1] = 0x03;
 695                 xpad->odata[2] = command;
 696                 xpad->irq_out->transfer_buffer_length = 3;
 697                 usb_submit_urb(xpad->irq_out, GFP_KERNEL);
 698                 mutex_unlock(&xpad->odata_mutex);
 699         }
 700 }
 701
 702 static void xpad_led_set(struct led_classdev *led_cdev,
 703                          enum led_brightness value)
 704 {
 705         struct xpad_led *xpad_led = container_of(led_cdev,
 706                                                  struct xpad_led, led_cdev);
 707
 708         xpad_send_led_command(xpad_led->xpad, value);
 709 }
 710
 711 static int xpad_led_probe(struct usb_xpad *xpad)
 712 {
 713         static atomic_t led_seq = ATOMIC_INIT(0);
 714         long led_no;
 715         struct xpad_led *led;
 716         struct led_classdev *led_cdev;
 717         int error;
 718
 719         if (xpad->xtype != XTYPE_XBOX360)
 720                 return 0;
 721
 722         xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
 723         if (!led)
 724                 return -ENOMEM;
 725
 726         led_no = (long)atomic_inc_return(&led_seq) - 1;
 727
 728         snprintf(led->name, sizeof(led->name), "xpad%ld", led_no);
 729         led->xpad = xpad;
 730
 731         led_cdev = &led->led_cdev;
 732         led_cdev->name = led->name;
 733         led_cdev->brightness_set = xpad_led_set;
 734
 735         error = led_classdev_register(&xpad->udev->dev, led_cdev);
 736         if (error) {
 737                 kfree(led);
 738                 xpad->led = NULL;
 739                 return error;
 740         }
 741
 742         /*
 743          * Light up the segment corresponding to controller number
 744          */
 745         xpad_send_led_command(xpad, (led_no % 4) + 2);
 746
 747         return 0;
 748 }
 749
 750 static void xpad_led_disconnect(struct usb_xpad *xpad)
 751 {
 752         struct xpad_led *xpad_led = xpad->led;
 753
 754         if (xpad_led) {
 755                 led_classdev_unregister(&xpad_led->led_cdev);
 756                 kfree(xpad_led);
 757         }
 758 }
 759 #else
 760 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
 761 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
 762 #endif
 763
 764
 765 static int xpad_open(struct input_dev *dev)
 766 {
 767         struct usb_xpad *xpad = input_get_drvdata(dev);
 768
 769         /* URB was submitted in probe */
 770         if(xpad->xtype == XTYPE_XBOX360W)
 771                 return 0;
 772
 773         xpad->irq_in->dev = xpad->udev;
 774         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
 775                 return -EIO;
 776
 777         return 0;
 778 }
 779
 780 static void xpad_close(struct input_dev *dev)
 781 {
 782         struct usb_xpad *xpad = input_get_drvdata(dev);
 783
 784         if (xpad->xtype != XTYPE_XBOX360W)
 785                 usb_kill_urb(xpad->irq_in);
 786
 787         xpad_stop_output(xpad);
 788 }
 789
 790 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
 791 {
 792         set_bit(abs, input_dev->absbit);
 793
 794         switch (abs) {
 795         case ABS_X:
 796         case ABS_Y:
 797         case ABS_RX:
 798         case ABS_RY:    /* the two sticks */
 799                 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
 800                 break;
 801         case ABS_Z:
 802         case ABS_RZ:    /* the triggers (if mapped to axes) */
 803                 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
 804                 break;
 805         case ABS_HAT0X:
 806         case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
 807                 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
 808                 break;
 809         }
 810 }
 811
 812 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
 813 {
 814         struct usb_device *udev = interface_to_usbdev(intf);
 815         struct usb_xpad *xpad;
 816         struct input_dev *input_dev;
 817         struct usb_endpoint_descriptor *ep_irq_in;
 818         int i, error;
 819
 820         for (i = 0; xpad_device[i].idVendor; i++) {
 821                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
 822                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
 823                         break;
 824         }
 825
 826         xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
 827         input_dev = input_allocate_device();
 828         if (!xpad || !input_dev) {
 829                 error = -ENOMEM;
 830                 goto fail1;
 831         }
 832
 833         xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
 834                                          GFP_KERNEL, &xpad->idata_dma);
 835         if (!xpad->idata) {
 836                 error = -ENOMEM;
 837                 goto fail1;
 838         }
 839
 840         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
 841         if (!xpad->irq_in) {
 842                 error = -ENOMEM;
 843                 goto fail2;
 844         }
 845
 846         xpad->udev = udev;
 847         xpad->mapping = xpad_device[i].mapping;
 848         xpad->xtype = xpad_device[i].xtype;
 849
 850         if (xpad->xtype == XTYPE_UNKNOWN) {
 851                 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
 852                         if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
 853                                 xpad->xtype = XTYPE_XBOX360W;
 854                         else
 855                                 xpad->xtype = XTYPE_XBOX360;
 856                 } else
 857                         xpad->xtype = XTYPE_XBOX;
 858
 859                 if (dpad_to_buttons)
 860                         xpad->mapping |= MAP_DPAD_TO_BUTTONS;
 861                 if (triggers_to_buttons)
 862                         xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
 863                 if (sticks_to_null)
 864                         xpad->mapping |= MAP_STICKS_TO_NULL;
 865         }
 866
 867         xpad->dev = input_dev;
 868         usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
 869         strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
 870
 871         input_dev->name = xpad_device[i].name;
 872         input_dev->phys = xpad->phys;
 873         usb_to_input_id(udev, &input_dev->id);
 874         input_dev->dev.parent = &intf->dev;
 875
 876         input_set_drvdata(input_dev, xpad);
 877
 878         input_dev->open = xpad_open;
 879         input_dev->close = xpad_close;
 880
 881         input_dev->evbit[0] = BIT_MASK(EV_KEY);
 882
 883         if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
 884                 input_dev->evbit[0] |= BIT_MASK(EV_ABS);
 885                 /* set up axes */
 886                 for (i = 0; xpad_abs[i] >= 0; i++)
 887                         xpad_set_up_abs(input_dev, xpad_abs[i]);
 888         }
 889
 890         /* set up standard buttons */
 891         for (i = 0; xpad_common_btn[i] >= 0; i++)
 892                 __set_bit(xpad_common_btn[i], input_dev->keybit);
 893
 894         /* set up model-specific ones */
 895         if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W) {
 896                 for (i = 0; xpad360_btn[i] >= 0; i++)
 897                         __set_bit(xpad360_btn[i], input_dev->keybit);
 898         } else {
 899                 for (i = 0; xpad_btn[i] >= 0; i++)
 900                         __set_bit(xpad_btn[i], input_dev->keybit);
 901         }
 902
 903         if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
 904                 for (i = 0; xpad_btn_pad[i] >= 0; i++)
 905                         __set_bit(xpad_btn_pad[i], input_dev->keybit);
 906         } else {
 907                 for (i = 0; xpad_abs_pad[i] >= 0; i++)
 908                     xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
 909         }
 910
 911         if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
 912                 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
 913                         __set_bit(xpad_btn_triggers[i], input_dev->keybit);
 914         } else {
 915                 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
 916                         xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
 917         }
 918
 919         error = xpad_init_output(intf, xpad);
 920         if (error)
 921                 goto fail3;
 922
 923         error = xpad_init_ff(xpad);
 924         if (error)
 925                 goto fail4;
 926
 927         error = xpad_led_probe(xpad);
 928         if (error)
 929                 goto fail5;
 930
 931         ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
 932         usb_fill_int_urb(xpad->irq_in, udev,
 933                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
 934                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
 935                          xpad, ep_irq_in->bInterval);
 936         xpad->irq_in->transfer_dma = xpad->idata_dma;
 937         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 938
 939         error = input_register_device(xpad->dev);
 940         if (error)
 941                 goto fail6;
 942
 943         usb_set_intfdata(intf, xpad);
 944
 945         if (xpad->xtype == XTYPE_XBOX360W) {
 946                 /*
 947                  * Setup the message to set the LEDs on the
 948                  * controller when it shows up
 949                  */
 950                 xpad->bulk_out = usb_alloc_urb(0, GFP_KERNEL);
 951                 if (!xpad->bulk_out) {
 952                         error = -ENOMEM;
 953                         goto fail7;
 954                 }
 955
 956                 xpad->bdata = kzalloc(XPAD_PKT_LEN, GFP_KERNEL);
 957                 if (!xpad->bdata) {
 958                         error = -ENOMEM;
 959                         goto fail8;
 960                 }
 961
 962                 xpad->bdata[2] = 0x08;
 963                 switch (intf->cur_altsetting->desc.bInterfaceNumber) {
 964                 case 0:
 965                         xpad->bdata[3] = 0x42;
 966                         break;
 967                 case 2:
 968                         xpad->bdata[3] = 0x43;
 969                         break;
 970                 case 4:
 971                         xpad->bdata[3] = 0x44;
 972                         break;
 973                 case 6:
 974                         xpad->bdata[3] = 0x45;
 975                 }
 976
 977                 ep_irq_in = &intf->cur_altsetting->endpoint[1].desc;
 978                 usb_fill_bulk_urb(xpad->bulk_out, udev,
 979                                 usb_sndbulkpipe(udev, ep_irq_in->bEndpointAddress),
 980                                 xpad->bdata, XPAD_PKT_LEN, xpad_bulk_out, xpad);
 981
 982                 /*
 983                  * Submit the int URB immediately rather than waiting for open
 984                  * because we get status messages from the device whether
 985                  * or not any controllers are attached.  In fact, it's
 986                  * exactly the message that a controller has arrived that
 987                  * we're waiting for.
 988                  */
 989                 xpad->irq_in->dev = xpad->udev;
 990                 error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
 991                 if (error)
 992                         goto fail9;
 993         }
 994
 995         return 0;
 996
 997  fail9: kfree(xpad->bdata);
 998  fail8: usb_free_urb(xpad->bulk_out);
 999  fail7: input_unregister_device(input_dev);
1000         input_dev = NULL;
1001  fail6: xpad_led_disconnect(xpad);
1002  fail5: if (input_dev)
1003                 input_ff_destroy(input_dev);
1004  fail4: xpad_deinit_output(xpad);
1005  fail3: usb_free_urb(xpad->irq_in);
1006  fail2: usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1007  fail1: input_free_device(input_dev);
1008         kfree(xpad);
1009         return error;
1010
1011 }
1012
1013 static void xpad_disconnect(struct usb_interface *intf)
1014 {
1015         struct usb_xpad *xpad = usb_get_intfdata (intf);
1016
1017         xpad_led_disconnect(xpad);
1018         input_unregister_device(xpad->dev);
1019         xpad_deinit_output(xpad);
1020
1021         if (xpad->xtype == XTYPE_XBOX360W) {
1022                 usb_kill_urb(xpad->bulk_out);
1023                 usb_free_urb(xpad->bulk_out);
1024                 usb_kill_urb(xpad->irq_in);
1025         }
1026
1027         usb_free_urb(xpad->irq_in);
1028         usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1029                         xpad->idata, xpad->idata_dma);
1030
1031         kfree(xpad->bdata);
1032         kfree(xpad);
1033
1034         usb_set_intfdata(intf, NULL);
1035 }
1036
1037 static struct usb_driver xpad_driver = {
1038         .name           = "xpad",
1039         .probe          = xpad_probe,
1040         .disconnect     = xpad_disconnect,
1041         .id_table       = xpad_table,
1042 };
1043
1044 static int __init usb_xpad_init(void)
1045 {
1046         return usb_register(&xpad_driver);
1047 }
1048
1049 static void __exit usb_xpad_exit(void)
1050 {
1051         usb_deregister(&xpad_driver);
1052 }
1053
1054 module_init(usb_xpad_init);
1055 module_exit(usb_xpad_exit);
1056
1057 MODULE_AUTHOR(DRIVER_AUTHOR);
1058 MODULE_DESCRIPTION(DRIVER_DESC);
1059 MODULE_LICENSE("GPL");