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/config.h>
58 #include <linux/kernel.h>
59 #include <linux/init.h>
60 #include <linux/slab.h>
61 #include <linux/module.h>
62 #include <linux/smp_lock.h>
63 #include <linux/usb/input.h>
65 #define DRIVER_VERSION "v0.0.5"
66 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
67 #define DRIVER_DESC "X-Box pad driver"
69 #define XPAD_PKT_LEN 32
71 static const struct xpad_device {
76 { 0x045e, 0x0202, "Microsoft X-Box pad (US)" },
77 { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)" },
78 { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)" },
79 { 0x0000, 0x0000, "X-Box pad" }
82 static const signed short xpad_btn[] = {
83 BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, /* "analog" buttons */
84 BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR, /* start/back/sticks */
85 -1 /* terminating entry */
88 static const signed short xpad_abs[] = {
89 ABS_X, ABS_Y, /* left stick */
90 ABS_RX, ABS_RY, /* right stick */
91 ABS_Z, ABS_RZ, /* triggers left/right */
92 ABS_HAT0X, ABS_HAT0Y, /* digital pad */
93 -1 /* terminating entry */
96 static struct usb_device_id xpad_table [] = {
97 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
101 MODULE_DEVICE_TABLE (usb, xpad_table);
104 struct input_dev *dev; /* input device interface */
105 struct usb_device *udev; /* usb device */
107 struct urb *irq_in; /* urb for interrupt in report */
108 unsigned char *idata; /* input data */
109 dma_addr_t idata_dma;
111 char phys[65]; /* physical device path */
115 * xpad_process_packet
117 * Completes a request by converting the data into events for the
120 * The used report descriptor was taken from ITO Takayukis website:
121 * http://euc.jp/periphs/xbox-controller.ja.html
124 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data, struct pt_regs *regs)
126 struct input_dev *dev = xpad->dev;
128 input_regs(dev, regs);
131 input_report_abs(dev, ABS_X, (__s16) (((__s16)data[13] << 8) | data[12]));
132 input_report_abs(dev, ABS_Y, (__s16) (((__s16)data[15] << 8) | data[14]));
135 input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[17] << 8) | data[16]));
136 input_report_abs(dev, ABS_RY, (__s16) (((__s16)data[19] << 8) | data[18]));
138 /* triggers left/right */
139 input_report_abs(dev, ABS_Z, data[10]);
140 input_report_abs(dev, ABS_RZ, data[11]);
143 input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x08) - !!(data[2] & 0x04));
144 input_report_abs(dev, ABS_HAT0Y, !!(data[2] & 0x02) - !!(data[2] & 0x01));
146 /* start/back buttons and stick press left/right */
147 input_report_key(dev, BTN_START, (data[2] & 0x10) >> 4);
148 input_report_key(dev, BTN_BACK, (data[2] & 0x20) >> 5);
149 input_report_key(dev, BTN_THUMBL, (data[2] & 0x40) >> 6);
150 input_report_key(dev, BTN_THUMBR, data[2] >> 7);
152 /* "analog" buttons A, B, X, Y */
153 input_report_key(dev, BTN_A, data[4]);
154 input_report_key(dev, BTN_B, data[5]);
155 input_report_key(dev, BTN_X, data[6]);
156 input_report_key(dev, BTN_Y, data[7]);
158 /* "analog" buttons black, white */
159 input_report_key(dev, BTN_C, data[8]);
160 input_report_key(dev, BTN_Z, data[9]);
165 static void xpad_irq_in(struct urb *urb, struct pt_regs *regs)
167 struct usb_xpad *xpad = urb->context;
170 switch (urb->status) {
177 /* this urb is terminated, clean up */
178 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
181 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
185 xpad_process_packet(xpad, 0, xpad->idata, regs);
188 retval = usb_submit_urb (urb, GFP_ATOMIC);
190 err ("%s - usb_submit_urb failed with result %d",
191 __FUNCTION__, retval);
194 static int xpad_open (struct input_dev *dev)
196 struct usb_xpad *xpad = dev->private;
198 xpad->irq_in->dev = xpad->udev;
199 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
205 static void xpad_close (struct input_dev *dev)
207 struct usb_xpad *xpad = dev->private;
209 usb_kill_urb(xpad->irq_in);
212 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
214 struct usb_device *udev = interface_to_usbdev (intf);
215 struct usb_xpad *xpad;
216 struct input_dev *input_dev;
217 struct usb_endpoint_descriptor *ep_irq_in;
220 for (i = 0; xpad_device[i].idVendor; i++) {
221 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
222 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
226 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
227 input_dev = input_allocate_device();
228 if (!xpad || !input_dev)
231 xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
232 SLAB_ATOMIC, &xpad->idata_dma);
236 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
241 xpad->dev = input_dev;
242 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
243 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
245 input_dev->name = xpad_device[i].name;
246 input_dev->phys = xpad->phys;
247 usb_to_input_id(udev, &input_dev->id);
248 input_dev->cdev.dev = &intf->dev;
249 input_dev->private = xpad;
250 input_dev->open = xpad_open;
251 input_dev->close = xpad_close;
253 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
255 for (i = 0; xpad_btn[i] >= 0; i++)
256 set_bit(xpad_btn[i], input_dev->keybit);
258 for (i = 0; xpad_abs[i] >= 0; i++) {
260 signed short t = xpad_abs[i];
262 set_bit(t, input_dev->absbit);
268 case ABS_RY: /* the two sticks */
269 input_set_abs_params(input_dev, t, -32768, 32767, 16, 128);
272 case ABS_RZ: /* the triggers */
273 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
276 case ABS_HAT0Y: /* the d-pad */
277 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
282 ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
283 usb_fill_int_urb(xpad->irq_in, udev,
284 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
285 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
286 xpad, ep_irq_in->bInterval);
287 xpad->irq_in->transfer_dma = xpad->idata_dma;
288 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
290 input_register_device(xpad->dev);
292 usb_set_intfdata(intf, xpad);
295 fail2: usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
296 fail1: input_free_device(input_dev);
302 static void xpad_disconnect(struct usb_interface *intf)
304 struct usb_xpad *xpad = usb_get_intfdata (intf);
306 usb_set_intfdata(intf, NULL);
308 usb_kill_urb(xpad->irq_in);
309 input_unregister_device(xpad->dev);
310 usb_free_urb(xpad->irq_in);
311 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
316 static struct usb_driver xpad_driver = {
319 .disconnect = xpad_disconnect,
320 .id_table = xpad_table,
323 static int __init usb_xpad_init(void)
325 int result = usb_register(&xpad_driver);
327 info(DRIVER_DESC ":" DRIVER_VERSION);
331 static void __exit usb_xpad_exit(void)
333 usb_deregister(&xpad_driver);
336 module_init(usb_xpad_init);
337 module_exit(usb_xpad_exit);
339 MODULE_AUTHOR(DRIVER_AUTHOR);
340 MODULE_DESCRIPTION(DRIVER_DESC);
341 MODULE_LICENSE("GPL");