drivers/usb/input/xpad.c

   1 /*
   2  * X-Box gamepad - v0.0.5
   3  *
   4  * Copyright (c) 2002 Marko Friedemann <mfr@bmx-chemnitz.de>
   5  *
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of
  10  * the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  *
  21  *
  22  * This driver is based on:
  23  *  - information from     http://euc.jp/periphs/xbox-controller.ja.html
  24  *  - the iForce driver    drivers/char/joystick/iforce.c
  25  *  - the skeleton-driver  drivers/usb/usb-skeleton.c
  26  *
  27  * Thanks to:
  28  *  - ITO Takayuki for providing essential xpad information on his website
  29  *  - Vojtech Pavlik     - iforce driver / input subsystem
  30  *  - Greg Kroah-Hartman - usb-skeleton driver
  31  *
  32  * TODO:
  33  *  - fine tune axes
  34  *  - fix "analog" buttons (reported as digital now)
  35  *  - get rumble working
  36  *
  37  * History:
  38  *
  39  * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
  40  *
  41  * 2002-07-02 - 0.0.2 : basic working version
  42  *  - all axes and 9 of the 10 buttons work (german InterAct device)
  43  *  - the black button does not work
  44  *
  45  * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
  46  *  - indentation fixes
  47  *  - usb + input init sequence fixes
  48  *
  49  * 2002-07-16 - 0.0.4 : minor changes, merge with Vojtech's v0.0.3
  50  *  - verified the lack of HID and report descriptors
  51  *  - verified that ALL buttons WORK
  52  *  - fixed d-pad to axes mapping
  53  *
  54  * 2002-07-17 - 0.0.5 : simplified d-pad handling
  55  */
  56
  57 #include <linux/kernel.h>
  58 #include <linux/init.h>
  59 #include <linux/slab.h>
  60 #include <linux/module.h>
  61 #include <linux/smp_lock.h>
  62 #include <linux/usb/input.h>
  63
  64 #define DRIVER_VERSION "v0.0.5"
  65 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
  66 #define DRIVER_DESC "X-Box pad driver"
  67
  68 #define XPAD_PKT_LEN 32
  69
  70 static const struct xpad_device {
  71         u16 idVendor;
  72         u16 idProduct;
  73         char *name;
  74 } xpad_device[] = {
  75         { 0x045e, 0x0202, "Microsoft X-Box pad (US)" },
  76         { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)" },
  77         { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)" },
  78         { 0x0000, 0x0000, "X-Box pad" }
  79 };
  80
  81 static const signed short xpad_btn[] = {
  82         BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z,       /* "analog" buttons */
  83         BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR,    /* start/back/sticks */
  84         -1                                              /* terminating entry */
  85 };
  86
  87 static const signed short xpad_abs[] = {
  88         ABS_X, ABS_Y,           /* left stick */
  89         ABS_RX, ABS_RY,         /* right stick */
  90         ABS_Z, ABS_RZ,          /* triggers left/right */
  91         ABS_HAT0X, ABS_HAT0Y,   /* digital pad */
  92         -1                      /* terminating entry */
  93 };
  94
  95 static struct usb_device_id xpad_table [] = {
  96         { USB_INTERFACE_INFO('X', 'B', 0) },    /* X-Box USB-IF not approved class */
  97         { }
  98 };
  99
 100 MODULE_DEVICE_TABLE (usb, xpad_table);
 101
 102 struct usb_xpad {
 103         struct input_dev *dev;                  /* input device interface */
 104         struct usb_device *udev;                /* usb device */
 105
 106         struct urb *irq_in;                     /* urb for interrupt in report */
 107         unsigned char *idata;                   /* input data */
 108         dma_addr_t idata_dma;
 109
 110         char phys[65];                          /* physical device path */
 111 };
 112
 113 /*
 114  *      xpad_process_packet
 115  *
 116  *      Completes a request by converting the data into events for the
 117  *      input subsystem.
 118  *
 119  *      The used report descriptor was taken from ITO Takayukis website:
 120  *       http://euc.jp/periphs/xbox-controller.ja.html
 121  */
 122
 123 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data, struct pt_regs *regs)
 124 {
 125         struct input_dev *dev = xpad->dev;
 126
 127         input_regs(dev, regs);
 128
 129         /* left stick */
 130         input_report_abs(dev, ABS_X, (__s16) (((__s16)data[13] << 8) | data[12]));
 131         input_report_abs(dev, ABS_Y, (__s16) (((__s16)data[15] << 8) | data[14]));
 132
 133         /* right stick */
 134         input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[17] << 8) | data[16]));
 135         input_report_abs(dev, ABS_RY, (__s16) (((__s16)data[19] << 8) | data[18]));
 136
 137         /* triggers left/right */
 138         input_report_abs(dev, ABS_Z, data[10]);
 139         input_report_abs(dev, ABS_RZ, data[11]);
 140
 141         /* digital pad */
 142         input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x08) - !!(data[2] & 0x04));
 143         input_report_abs(dev, ABS_HAT0Y, !!(data[2] & 0x02) - !!(data[2] & 0x01));
 144
 145         /* start/back buttons and stick press left/right */
 146         input_report_key(dev, BTN_START, (data[2] & 0x10) >> 4);
 147         input_report_key(dev, BTN_BACK, (data[2] & 0x20) >> 5);
 148         input_report_key(dev, BTN_THUMBL, (data[2] & 0x40) >> 6);
 149         input_report_key(dev, BTN_THUMBR, data[2] >> 7);
 150
 151         /* "analog" buttons A, B, X, Y */
 152         input_report_key(dev, BTN_A, data[4]);
 153         input_report_key(dev, BTN_B, data[5]);
 154         input_report_key(dev, BTN_X, data[6]);
 155         input_report_key(dev, BTN_Y, data[7]);
 156
 157         /* "analog" buttons black, white */
 158         input_report_key(dev, BTN_C, data[8]);
 159         input_report_key(dev, BTN_Z, data[9]);
 160
 161         input_sync(dev);
 162 }
 163
 164 static void xpad_irq_in(struct urb *urb, struct pt_regs *regs)
 165 {
 166         struct usb_xpad *xpad = urb->context;
 167         int retval;
 168
 169         switch (urb->status) {
 170         case 0:
 171                 /* success */
 172                 break;
 173         case -ECONNRESET:
 174         case -ENOENT:
 175         case -ESHUTDOWN:
 176                 /* this urb is terminated, clean up */
 177                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
 178                 return;
 179         default:
 180                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
 181                 goto exit;
 182         }
 183
 184         xpad_process_packet(xpad, 0, xpad->idata, regs);
 185
 186 exit:
 187         retval = usb_submit_urb (urb, GFP_ATOMIC);
 188         if (retval)
 189                 err ("%s - usb_submit_urb failed with result %d",
 190                      __FUNCTION__, retval);
 191 }
 192
 193 static int xpad_open (struct input_dev *dev)
 194 {
 195         struct usb_xpad *xpad = dev->private;
 196
 197         xpad->irq_in->dev = xpad->udev;
 198         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
 199                 return -EIO;
 200
 201         return 0;
 202 }
 203
 204 static void xpad_close (struct input_dev *dev)
 205 {
 206         struct usb_xpad *xpad = dev->private;
 207
 208         usb_kill_urb(xpad->irq_in);
 209 }
 210
 211 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
 212 {
 213         struct usb_device *udev = interface_to_usbdev (intf);
 214         struct usb_xpad *xpad;
 215         struct input_dev *input_dev;
 216         struct usb_endpoint_descriptor *ep_irq_in;
 217         int i;
 218
 219         for (i = 0; xpad_device[i].idVendor; i++) {
 220                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
 221                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
 222                         break;
 223         }
 224
 225         xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
 226         input_dev = input_allocate_device();
 227         if (!xpad || !input_dev)
 228                 goto fail1;
 229
 230         xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
 231                                        SLAB_ATOMIC, &xpad->idata_dma);
 232         if (!xpad->idata)
 233                 goto fail1;
 234
 235         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
 236         if (!xpad->irq_in)
 237                 goto fail2;
 238
 239         xpad->udev = udev;
 240         xpad->dev = input_dev;
 241         usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
 242         strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
 243
 244         input_dev->name = xpad_device[i].name;
 245         input_dev->phys = xpad->phys;
 246         usb_to_input_id(udev, &input_dev->id);
 247         input_dev->cdev.dev = &intf->dev;
 248         input_dev->private = xpad;
 249         input_dev->open = xpad_open;
 250         input_dev->close = xpad_close;
 251
 252         input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
 253
 254         for (i = 0; xpad_btn[i] >= 0; i++)
 255                 set_bit(xpad_btn[i], input_dev->keybit);
 256
 257         for (i = 0; xpad_abs[i] >= 0; i++) {
 258
 259                 signed short t = xpad_abs[i];
 260
 261                 set_bit(t, input_dev->absbit);
 262
 263                 switch (t) {
 264                         case ABS_X:
 265                         case ABS_Y:
 266                         case ABS_RX:
 267                         case ABS_RY:    /* the two sticks */
 268                                 input_set_abs_params(input_dev, t, -32768, 32767, 16, 128);
 269                                 break;
 270                         case ABS_Z:
 271                         case ABS_RZ:    /* the triggers */
 272                                 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
 273                                 break;
 274                         case ABS_HAT0X:
 275                         case ABS_HAT0Y: /* the d-pad */
 276                                 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
 277                                 break;
 278                 }
 279         }
 280
 281         ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
 282         usb_fill_int_urb(xpad->irq_in, udev,
 283                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
 284                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
 285                          xpad, ep_irq_in->bInterval);
 286         xpad->irq_in->transfer_dma = xpad->idata_dma;
 287         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 288
 289         input_register_device(xpad->dev);
 290
 291         usb_set_intfdata(intf, xpad);
 292         return 0;
 293
 294 fail2:  usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
 295 fail1:  input_free_device(input_dev);
 296         kfree(xpad);
 297         return -ENOMEM;
 298
 299 }
 300
 301 static void xpad_disconnect(struct usb_interface *intf)
 302 {
 303         struct usb_xpad *xpad = usb_get_intfdata (intf);
 304
 305         usb_set_intfdata(intf, NULL);
 306         if (xpad) {
 307                 usb_kill_urb(xpad->irq_in);
 308                 input_unregister_device(xpad->dev);
 309                 usb_free_urb(xpad->irq_in);
 310                 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
 311                 kfree(xpad);
 312         }
 313 }
 314
 315 static struct usb_driver xpad_driver = {
 316         .name           = "xpad",
 317         .probe          = xpad_probe,
 318         .disconnect     = xpad_disconnect,
 319         .id_table       = xpad_table,
 320 };
 321
 322 static int __init usb_xpad_init(void)
 323 {
 324         int result = usb_register(&xpad_driver);
 325         if (result == 0)
 326                 info(DRIVER_DESC ":" DRIVER_VERSION);
 327         return result;
 328 }
 329
 330 static void __exit usb_xpad_exit(void)
 331 {
 332         usb_deregister(&xpad_driver);
 333 }
 334
 335 module_init(usb_xpad_init);
 336 module_exit(usb_xpad_exit);
 337
 338 MODULE_AUTHOR(DRIVER_AUTHOR);
 339 MODULE_DESCRIPTION(DRIVER_DESC);
 340 MODULE_LICENSE("GPL");