2 * X-Box gamepad - v0.0.5
4 * Copyright (c) 2002 Marko Friedemann <mfr@bmx-chemnitz.de>
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.
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.
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
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
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
34 * - fix "analog" buttons (reported as digital now)
35 * - get rumble working
39 * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
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
45 * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
47 * - usb + input init sequence fixes
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
54 * 2002-07-17 - 0.0.5 : simplified d-pad handling
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>
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"
68 #define XPAD_PKT_LEN 32
70 static const struct 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" }
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 */
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 */
95 static struct usb_device_id xpad_table [] = {
96 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
100 MODULE_DEVICE_TABLE (usb, xpad_table);
103 struct input_dev *dev; /* input device interface */
104 struct usb_device *udev; /* usb device */
106 struct urb *irq_in; /* urb for interrupt in report */
107 unsigned char *idata; /* input data */
108 dma_addr_t idata_dma;
110 char phys[65]; /* physical device path */
114 * xpad_process_packet
116 * Completes a request by converting the data into events for the
119 * The used report descriptor was taken from ITO Takayukis website:
120 * http://euc.jp/periphs/xbox-controller.ja.html
123 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data, struct pt_regs *regs)
125 struct input_dev *dev = xpad->dev;
127 input_regs(dev, regs);
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]));
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]));
137 /* triggers left/right */
138 input_report_abs(dev, ABS_Z, data[10]);
139 input_report_abs(dev, ABS_RZ, data[11]);
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));
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);
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]);
157 /* "analog" buttons black, white */
158 input_report_key(dev, BTN_C, data[8]);
159 input_report_key(dev, BTN_Z, data[9]);
164 static void xpad_irq_in(struct urb *urb, struct pt_regs *regs)
166 struct usb_xpad *xpad = urb->context;
169 switch (urb->status) {
176 /* this urb is terminated, clean up */
177 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
180 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
184 xpad_process_packet(xpad, 0, xpad->idata, regs);
187 retval = usb_submit_urb (urb, GFP_ATOMIC);
189 err ("%s - usb_submit_urb failed with result %d",
190 __FUNCTION__, retval);
193 static int xpad_open (struct input_dev *dev)
195 struct usb_xpad *xpad = dev->private;
197 xpad->irq_in->dev = xpad->udev;
198 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
204 static void xpad_close (struct input_dev *dev)
206 struct usb_xpad *xpad = dev->private;
208 usb_kill_urb(xpad->irq_in);
211 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
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;
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))
225 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
226 input_dev = input_allocate_device();
227 if (!xpad || !input_dev)
230 xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
231 SLAB_ATOMIC, &xpad->idata_dma);
235 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
240 xpad->dev = input_dev;
241 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
242 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
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;
252 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
254 for (i = 0; xpad_btn[i] >= 0; i++)
255 set_bit(xpad_btn[i], input_dev->keybit);
257 for (i = 0; xpad_abs[i] >= 0; i++) {
259 signed short t = xpad_abs[i];
261 set_bit(t, input_dev->absbit);
267 case ABS_RY: /* the two sticks */
268 input_set_abs_params(input_dev, t, -32768, 32767, 16, 128);
271 case ABS_RZ: /* the triggers */
272 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
275 case ABS_HAT0Y: /* the d-pad */
276 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
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;
289 input_register_device(xpad->dev);
291 usb_set_intfdata(intf, xpad);
294 fail2: usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
295 fail1: input_free_device(input_dev);
301 static void xpad_disconnect(struct usb_interface *intf)
303 struct usb_xpad *xpad = usb_get_intfdata (intf);
305 usb_set_intfdata(intf, NULL);
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);
315 static struct usb_driver xpad_driver = {
318 .disconnect = xpad_disconnect,
319 .id_table = xpad_table,
322 static int __init usb_xpad_init(void)
324 int result = usb_register(&xpad_driver);
326 info(DRIVER_DESC ":" DRIVER_VERSION);
330 static void __exit usb_xpad_exit(void)
332 usb_deregister(&xpad_driver);
335 module_init(usb_xpad_init);
336 module_exit(usb_xpad_exit);
338 MODULE_AUTHOR(DRIVER_AUTHOR);
339 MODULE_DESCRIPTION(DRIVER_DESC);
340 MODULE_LICENSE("GPL");