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/config.h>
  58 #include <linux/kernel.h>
  59 #include <linux/input.h>
  60 #include <linux/init.h>
  61 #include <linux/slab.h>
  62 #include <linux/module.h>
  63 #include <linux/smp_lock.h>
  64 #include <linux/usb.h>
  65
  66 #define DRIVER_VERSION "v0.0.5"
  67 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
  68 #define DRIVER_DESC "X-Box pad driver"
  69
  70 #define XPAD_PKT_LEN 32
  71
  72 static struct xpad_device {
  73         u16 idVendor;
  74         u16 idProduct;
  75         char *name;
  76 } xpad_device[] = {
  77         { 0x045e, 0x0202, "Microsoft X-Box pad (US)" },
  78         { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)" },
  79         { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)" },
  80         { 0x0000, 0x0000, "X-Box pad" }
  81 };
  82
  83 static signed short xpad_btn[] = {
  84         BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z,       /* "analog" buttons */
  85         BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR,    /* start/back/sticks */
  86         -1                                              /* terminating entry */
  87 };
  88
  89 static signed short xpad_abs[] = {
  90         ABS_X, ABS_Y,           /* left stick */
  91         ABS_RX, ABS_RY,         /* right stick */
  92         ABS_Z, ABS_RZ,          /* triggers left/right */
  93         ABS_HAT0X, ABS_HAT0Y,   /* digital pad */
  94         -1                      /* terminating entry */
  95 };
  96
  97 static struct usb_device_id xpad_table [] = {
  98         { USB_INTERFACE_INFO('X', 'B', 0) },    /* X-Box USB-IF not approved class */
  99         { }
 100 };
 101
 102 MODULE_DEVICE_TABLE (usb, xpad_table);
 103
 104 struct usb_xpad {
 105         struct input_dev dev;                   /* input device interface */
 106         struct usb_device *udev;                /* usb device */
 107
 108         struct urb *irq_in;                     /* urb for interrupt in report */
 109         unsigned char *idata;                   /* input data */
 110         dma_addr_t idata_dma;
 111
 112         char phys[65];                          /* physical device path */
 113         int open_count;                         /* reference count */
 114 };
 115
 116 /*
 117  *      xpad_process_packet
 118  *
 119  *      Completes a request by converting the data into events for the
 120  *      input subsystem.
 121  *
 122  *      The used report descriptor was taken from ITO Takayukis website:
 123  *       http://euc.jp/periphs/xbox-controller.ja.html
 124  */
 125
 126 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data, struct pt_regs *regs)
 127 {
 128         struct input_dev *dev = &xpad->dev;
 129
 130         input_regs(dev, regs);
 131
 132         /* left stick */
 133         input_report_abs(dev, ABS_X, (__s16) (((__s16)data[13] << 8) | data[12]));
 134         input_report_abs(dev, ABS_Y, (__s16) (((__s16)data[15] << 8) | data[14]));
 135
 136         /* right stick */
 137         input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[17] << 8) | data[16]));
 138         input_report_abs(dev, ABS_RY, (__s16) (((__s16)data[19] << 8) | data[18]));
 139
 140         /* triggers left/right */
 141         input_report_abs(dev, ABS_Z, data[10]);
 142         input_report_abs(dev, ABS_RZ, data[11]);
 143
 144         /* digital pad */
 145         input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x08) - !!(data[2] & 0x04));
 146         input_report_abs(dev, ABS_HAT0Y, !!(data[2] & 0x02) - !!(data[2] & 0x01));
 147
 148         /* start/back buttons and stick press left/right */
 149         input_report_key(dev, BTN_START, (data[2] & 0x10) >> 4);
 150         input_report_key(dev, BTN_BACK, (data[2] & 0x20) >> 5);
 151         input_report_key(dev, BTN_THUMBL, (data[2] & 0x40) >> 6);
 152         input_report_key(dev, BTN_THUMBR, data[2] >> 7);
 153
 154         /* "analog" buttons A, B, X, Y */
 155         input_report_key(dev, BTN_A, data[4]);
 156         input_report_key(dev, BTN_B, data[5]);
 157         input_report_key(dev, BTN_X, data[6]);
 158         input_report_key(dev, BTN_Y, data[7]);
 159
 160         /* "analog" buttons black, white */
 161         input_report_key(dev, BTN_C, data[8]);
 162         input_report_key(dev, BTN_Z, data[9]);
 163
 164         input_sync(dev);
 165 }
 166
 167 static void xpad_irq_in(struct urb *urb, struct pt_regs *regs)
 168 {
 169         struct usb_xpad *xpad = urb->context;
 170         int retval;
 171
 172         switch (urb->status) {
 173         case 0:
 174                 /* success */
 175                 break;
 176         case -ECONNRESET:
 177         case -ENOENT:
 178         case -ESHUTDOWN:
 179                 /* this urb is terminated, clean up */
 180                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
 181                 return;
 182         default:
 183                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
 184                 goto exit;
 185         }
 186
 187         xpad_process_packet(xpad, 0, xpad->idata, regs);
 188
 189 exit:
 190         retval = usb_submit_urb (urb, GFP_ATOMIC);
 191         if (retval)
 192                 err ("%s - usb_submit_urb failed with result %d",
 193                      __FUNCTION__, retval);
 194 }
 195
 196 static int xpad_open (struct input_dev *dev)
 197 {
 198         struct usb_xpad *xpad = dev->private;
 199
 200         if (xpad->open_count++)
 201                 return 0;
 202
 203         xpad->irq_in->dev = xpad->udev;
 204         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL)) {
 205                 xpad->open_count--;
 206                 return -EIO;
 207         }
 208
 209         return 0;
 210 }
 211
 212 static void xpad_close (struct input_dev *dev)
 213 {
 214         struct usb_xpad *xpad = dev->private;
 215
 216         if (!--xpad->open_count)
 217                 usb_kill_urb(xpad->irq_in);
 218 }
 219
 220 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
 221 {
 222         struct usb_device *udev = interface_to_usbdev (intf);
 223         struct usb_xpad *xpad = NULL;
 224         struct usb_endpoint_descriptor *ep_irq_in;
 225         char path[64];
 226         int i;
 227
 228         for (i = 0; xpad_device[i].idVendor; i++) {
 229                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
 230                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
 231                         break;
 232         }
 233
 234         if ((xpad = kmalloc (sizeof(struct usb_xpad), GFP_KERNEL)) == NULL) {
 235                 err("cannot allocate memory for new pad");
 236                 return -ENOMEM;
 237         }
 238         memset(xpad, 0, sizeof(struct usb_xpad));
 239
 240         xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
 241                                        SLAB_ATOMIC, &xpad->idata_dma);
 242         if (!xpad->idata) {
 243                 kfree(xpad);
 244                 return -ENOMEM;
 245         }
 246
 247         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
 248         if (!xpad->irq_in) {
 249                 err("cannot allocate memory for new pad irq urb");
 250                 usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
 251                 kfree(xpad);
 252                 return -ENOMEM;
 253         }
 254
 255         ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
 256
 257         usb_fill_int_urb(xpad->irq_in, udev,
 258                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
 259                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
 260                          xpad, ep_irq_in->bInterval);
 261         xpad->irq_in->transfer_dma = xpad->idata_dma;
 262         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 263
 264         xpad->udev = udev;
 265
 266         xpad->dev.id.bustype = BUS_USB;
 267         xpad->dev.id.vendor = le16_to_cpu(udev->descriptor.idVendor);
 268         xpad->dev.id.product = le16_to_cpu(udev->descriptor.idProduct);
 269         xpad->dev.id.version = le16_to_cpu(udev->descriptor.bcdDevice);
 270         xpad->dev.dev = &intf->dev;
 271         xpad->dev.private = xpad;
 272         xpad->dev.name = xpad_device[i].name;
 273         xpad->dev.phys = xpad->phys;
 274         xpad->dev.open = xpad_open;
 275         xpad->dev.close = xpad_close;
 276
 277         usb_make_path(udev, path, 64);
 278         snprintf(xpad->phys, 64,  "%s/input0", path);
 279
 280         xpad->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
 281
 282         for (i = 0; xpad_btn[i] >= 0; i++)
 283                 set_bit(xpad_btn[i], xpad->dev.keybit);
 284
 285         for (i = 0; xpad_abs[i] >= 0; i++) {
 286
 287                 signed short t = xpad_abs[i];
 288
 289                 set_bit(t, xpad->dev.absbit);
 290
 291                 switch (t) {
 292                         case ABS_X:
 293                         case ABS_Y:
 294                         case ABS_RX:
 295                         case ABS_RY:    /* the two sticks */
 296                                 xpad->dev.absmax[t] =  32767;
 297                                 xpad->dev.absmin[t] = -32768;
 298                                 xpad->dev.absflat[t] = 128;
 299                                 xpad->dev.absfuzz[t] = 16;
 300                                 break;
 301                         case ABS_Z:
 302                         case ABS_RZ:    /* the triggers */
 303                                 xpad->dev.absmax[t] = 255;
 304                                 xpad->dev.absmin[t] = 0;
 305                                 break;
 306                         case ABS_HAT0X:
 307                         case ABS_HAT0Y: /* the d-pad */
 308                                 xpad->dev.absmax[t] =  1;
 309                                 xpad->dev.absmin[t] = -1;
 310                                 break;
 311                 }
 312         }
 313
 314         input_register_device(&xpad->dev);
 315
 316         printk(KERN_INFO "input: %s on %s", xpad->dev.name, path);
 317
 318         usb_set_intfdata(intf, xpad);
 319         return 0;
 320 }
 321
 322 static void xpad_disconnect(struct usb_interface *intf)
 323 {
 324         struct usb_xpad *xpad = usb_get_intfdata (intf);
 325
 326         usb_set_intfdata(intf, NULL);
 327         if (xpad) {
 328                 usb_kill_urb(xpad->irq_in);
 329                 input_unregister_device(&xpad->dev);
 330                 usb_free_urb(xpad->irq_in);
 331                 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
 332                 kfree(xpad);
 333         }
 334 }
 335
 336 static struct usb_driver xpad_driver = {
 337         .owner          = THIS_MODULE,
 338         .name           = "xpad",
 339         .probe          = xpad_probe,
 340         .disconnect     = xpad_disconnect,
 341         .id_table       = xpad_table,
 342 };
 343
 344 static int __init usb_xpad_init(void)
 345 {
 346         int result = usb_register(&xpad_driver);
 347         if (result == 0)
 348                 info(DRIVER_DESC ":" DRIVER_VERSION);
 349         return result;
 350 }
 351
 352 static void __exit usb_xpad_exit(void)
 353 {
 354         usb_deregister(&xpad_driver);
 355 }
 356
 357 module_init(usb_xpad_init);
 358 module_exit(usb_xpad_exit);
 359
 360 MODULE_AUTHOR(DRIVER_AUTHOR);
 361 MODULE_DESCRIPTION(DRIVER_DESC);
 362 MODULE_LICENSE("GPL");