2 * X-Box gamepad - v0.0.6
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>
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of
16 * the License, or (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * This driver is based on:
29 * - information from http://euc.jp/periphs/xbox-controller.ja.html
30 * - the iForce driver drivers/char/joystick/iforce.c
31 * - the skeleton-driver drivers/usb/usb-skeleton.c
32 * - Xbox 360 information http://www.free60.org/wiki/Gamepad
35 * - ITO Takayuki for providing essential xpad information on his website
36 * - Vojtech Pavlik - iforce driver / input subsystem
37 * - Greg Kroah-Hartman - usb-skeleton driver
38 * - XBOX Linux project - extra USB id's
41 * - fine tune axes (especially trigger axes)
42 * - fix "analog" buttons (reported as digital now)
43 * - get rumble working
44 * - need USB IDs for other dance pads
48 * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
50 * 2002-07-02 - 0.0.2 : basic working version
51 * - all axes and 9 of the 10 buttons work (german InterAct device)
52 * - the black button does not work
54 * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
56 * - usb + input init sequence fixes
58 * 2002-07-16 - 0.0.4 : minor changes, merge with Vojtech's v0.0.3
59 * - verified the lack of HID and report descriptors
60 * - verified that ALL buttons WORK
61 * - fixed d-pad to axes mapping
63 * 2002-07-17 - 0.0.5 : simplified d-pad handling
65 * 2004-10-02 - 0.0.6 : DDR pad support
66 * - borrowed from the XBOX linux kernel
67 * - USB id's for commonly used dance pads are present
68 * - dance pads will map D-PAD to buttons, not axes
69 * - pass the module paramater 'dpad_to_buttons' to force
70 * the D-PAD to map to buttons if your pad is not detected
73 #include <linux/kernel.h>
74 #include <linux/init.h>
75 #include <linux/slab.h>
76 #include <linux/stat.h>
77 #include <linux/module.h>
78 #include <linux/moduleparam.h>
79 #include <linux/usb/input.h>
81 #define DRIVER_VERSION "v0.0.6"
82 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
83 #define DRIVER_DESC "X-Box pad driver"
85 #define XPAD_PKT_LEN 32
87 /* xbox d-pads should map to buttons, as is required for DDR pads
88 but we map them to axes when possible to simplify things */
89 #define MAP_DPAD_TO_BUTTONS 0
90 #define MAP_DPAD_TO_AXES 1
91 #define MAP_DPAD_UNKNOWN -1
94 #define XTYPE_XBOX360 1
96 static int dpad_to_buttons;
97 module_param(dpad_to_buttons, bool, S_IRUGO);
98 MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
100 static const struct xpad_device {
107 { 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
108 { 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
109 { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
110 { 0x045e, 0x0287, "Microsoft Xbox Controller S", MAP_DPAD_TO_AXES, XTYPE_XBOX },
111 { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
112 { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
113 { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
114 { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", MAP_DPAD_TO_AXES, XTYPE_XBOX },
115 { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
116 { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
117 { 0x0738, 0x4516, "Mad Catz Control Pad", MAP_DPAD_TO_AXES, XTYPE_XBOX },
118 { 0x0738, 0x4522, "Mad Catz LumiCON", MAP_DPAD_TO_AXES, XTYPE_XBOX },
119 { 0x0738, 0x4526, "Mad Catz Control Pad Pro", MAP_DPAD_TO_AXES, XTYPE_XBOX },
120 { 0x0738, 0x4536, "Mad Catz MicroCON", MAP_DPAD_TO_AXES, XTYPE_XBOX },
121 { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
122 { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
123 { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
124 { 0x0c12, 0x8802, "Zeroplus Xbox Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
125 { 0x0c12, 0x8810, "Zeroplus Xbox Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
126 { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", MAP_DPAD_TO_AXES, XTYPE_XBOX },
127 { 0x0e4c, 0x1097, "Radica Gamester Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
128 { 0x0e4c, 0x2390, "Radica Games Jtech Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
129 { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
130 { 0x0e6f, 0x0005, "Eclipse wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
131 { 0x0e6f, 0x0006, "Edge wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
132 { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", MAP_DPAD_TO_AXES, XTYPE_XBOX },
133 { 0x0f30, 0x0202, "Joytech Advanced Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
134 { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
135 { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
136 { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
137 { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
138 { 0x045e, 0x028e, "Microsoft X-Box 360 pad", MAP_DPAD_TO_AXES, XTYPE_XBOX360 },
139 { 0xffff, 0xffff, "Chinese-made Xbox Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
140 { 0x0000, 0x0000, "Generic X-Box pad", MAP_DPAD_UNKNOWN, XTYPE_XBOX }
143 static const signed short xpad_btn[] = {
144 BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, /* "analog" buttons */
145 BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR, /* start/back/sticks */
146 -1 /* terminating entry */
149 /* only used if MAP_DPAD_TO_BUTTONS */
150 static const signed short xpad_btn_pad[] = {
151 BTN_LEFT, BTN_RIGHT, /* d-pad left, right */
152 BTN_0, BTN_1, /* d-pad up, down (XXX names??) */
153 -1 /* terminating entry */
156 static const signed short xpad360_btn[] = { /* buttons for x360 controller */
157 BTN_TL, BTN_TR, /* Button LB/RB */
158 BTN_MODE, /* The big X button */
162 static const signed short xpad_abs[] = {
163 ABS_X, ABS_Y, /* left stick */
164 ABS_RX, ABS_RY, /* right stick */
165 ABS_Z, ABS_RZ, /* triggers left/right */
166 -1 /* terminating entry */
169 /* only used if MAP_DPAD_TO_AXES */
170 static const signed short xpad_abs_pad[] = {
171 ABS_HAT0X, ABS_HAT0Y, /* d-pad axes */
172 -1 /* terminating entry */
175 /* Xbox 360 has a vendor-specific (sub)class, so we cannot match it with only
176 * USB_INTERFACE_INFO, more to that this device has 4 InterfaceProtocols,
177 * but we need only one of them. */
178 static struct usb_device_id xpad_table [] = {
179 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
180 { USB_DEVICE_INTERFACE_PROTOCOL(0x045e, 0x028e, 1) }, /* X-Box 360 controller */
184 MODULE_DEVICE_TABLE (usb, xpad_table);
187 struct input_dev *dev; /* input device interface */
188 struct usb_device *udev; /* usb device */
190 struct urb *irq_in; /* urb for interrupt in report */
191 unsigned char *idata; /* input data */
192 dma_addr_t idata_dma;
194 char phys[65]; /* physical device path */
196 int dpad_mapping; /* map d-pad to buttons or to axes */
197 int xtype; /* type of xbox device */
201 * xpad_process_packet
203 * Completes a request by converting the data into events for the
206 * The used report descriptor was taken from ITO Takayukis website:
207 * http://euc.jp/periphs/xbox-controller.ja.html
210 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
212 struct input_dev *dev = xpad->dev;
215 input_report_abs(dev, ABS_X, (__s16) (((__s16)data[13] << 8) | data[12]));
216 input_report_abs(dev, ABS_Y, (__s16) (((__s16)data[15] << 8) | data[14]));
219 input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[17] << 8) | data[16]));
220 input_report_abs(dev, ABS_RY, (__s16) (((__s16)data[19] << 8) | data[18]));
222 /* triggers left/right */
223 input_report_abs(dev, ABS_Z, data[10]);
224 input_report_abs(dev, ABS_RZ, data[11]);
227 if (xpad->dpad_mapping == MAP_DPAD_TO_AXES) {
228 input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x08) - !!(data[2] & 0x04));
229 input_report_abs(dev, ABS_HAT0Y, !!(data[2] & 0x02) - !!(data[2] & 0x01));
230 } else /* xpad->dpad_mapping == MAP_DPAD_TO_BUTTONS */ {
231 input_report_key(dev, BTN_LEFT, data[2] & 0x04);
232 input_report_key(dev, BTN_RIGHT, data[2] & 0x08);
233 input_report_key(dev, BTN_0, data[2] & 0x01); // up
234 input_report_key(dev, BTN_1, data[2] & 0x02); // down
237 /* start/back buttons and stick press left/right */
238 input_report_key(dev, BTN_START, data[2] & 0x10);
239 input_report_key(dev, BTN_BACK, data[2] & 0x20);
240 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
241 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
243 /* "analog" buttons A, B, X, Y */
244 input_report_key(dev, BTN_A, data[4]);
245 input_report_key(dev, BTN_B, data[5]);
246 input_report_key(dev, BTN_X, data[6]);
247 input_report_key(dev, BTN_Y, data[7]);
249 /* "analog" buttons black, white */
250 input_report_key(dev, BTN_C, data[8]);
251 input_report_key(dev, BTN_Z, data[9]);
257 * xpad360_process_packet
259 * Completes a request by converting the data into events for the
260 * input subsystem. It is version for xbox 360 controller
262 * The used report descriptor was taken from:
263 * http://www.free60.org/wiki/Gamepad
266 static void xpad360_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
268 struct input_dev *dev = xpad->dev;
271 if (xpad->dpad_mapping == MAP_DPAD_TO_AXES) {
272 input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x01) - !!((data[2] & 0x08) >> 3));
273 input_report_abs(dev, ABS_HAT0Y, !!((data[2] & 0x02) >> 1) - !!((data[2] & 0x04) >> 2));
274 } else if ( xpad->dpad_mapping == MAP_DPAD_TO_BUTTONS ) {
275 /* dpad as buttons (right, left, down, up) */
276 input_report_key(dev, BTN_RIGHT, (data[2] & 0x01));
277 input_report_key(dev, BTN_LEFT, (data[2] & 0x08) >> 3);
278 input_report_key(dev, BTN_0, (data[2] & 0x02) >> 1);
279 input_report_key(dev, BTN_1, (data[2] & 0x04) >> 2);
282 /* start/back buttons */
283 input_report_key(dev, BTN_START, (data[2] & 0x10) >> 4);
284 input_report_key(dev, BTN_BACK, (data[2] & 0x20) >> 5);
286 /* stick press left/right */
287 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
288 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
290 /* buttons A,B,X,Y,TL,TR and MODE */
291 input_report_key(dev, BTN_A, (data[3] & 0x10) >> 4);
292 input_report_key(dev, BTN_B, (data[3] & 0x20) >> 5);
293 input_report_key(dev, BTN_X, (data[3] & 0x40) >> 6);
294 input_report_key(dev, BTN_Y, (data[3] & 0x80) >> 7);
295 input_report_key(dev, BTN_TL, data[3] & 0x01 );
296 input_report_key(dev, BTN_TR, (data[3] & 0x02) >> 1);
297 input_report_key(dev, BTN_MODE, (data[3] & 0x04) >> 2);
300 input_report_abs(dev, ABS_X, (__s16) (((__s16)data[7] << 8) | (__s16)data[6]));
301 input_report_abs(dev, ABS_Y, ~(__s16) (((__s16)data[9] << 8) | (__s16)data[8]));
304 input_report_abs(dev, ABS_RY, ~(__s16) (((__s16)data[13] << 8) | (__s16)data[12]));
305 input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[11] << 8) | (__s16)data[10]));
307 /* triggers left/right */
308 input_report_abs(dev, ABS_Z, data[4]);
309 input_report_abs(dev, ABS_RZ, data[5]);
314 static void xpad_irq_in(struct urb *urb)
316 struct usb_xpad *xpad = urb->context;
319 switch (urb->status) {
326 /* this urb is terminated, clean up */
327 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
330 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
334 if (xpad->xtype == XTYPE_XBOX360)
335 xpad360_process_packet(xpad, 0, xpad->idata);
337 xpad_process_packet(xpad, 0, xpad->idata);
340 retval = usb_submit_urb (urb, GFP_ATOMIC);
342 err ("%s - usb_submit_urb failed with result %d",
343 __FUNCTION__, retval);
346 static int xpad_open (struct input_dev *dev)
348 struct usb_xpad *xpad = input_get_drvdata(dev);
350 xpad->irq_in->dev = xpad->udev;
351 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
357 static void xpad_close (struct input_dev *dev)
359 struct usb_xpad *xpad = input_get_drvdata(dev);
361 usb_kill_urb(xpad->irq_in);
364 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
366 set_bit(abs, input_dev->absbit);
372 case ABS_RY: /* the two sticks */
373 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
376 case ABS_RZ: /* the triggers */
377 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
380 case ABS_HAT0Y: /* the d-pad (only if MAP_DPAD_TO_AXES) */
381 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
386 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
388 struct usb_device *udev = interface_to_usbdev (intf);
389 struct usb_xpad *xpad;
390 struct input_dev *input_dev;
391 struct usb_endpoint_descriptor *ep_irq_in;
395 for (i = 0; xpad_device[i].idVendor; i++) {
396 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
397 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
401 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
402 input_dev = input_allocate_device();
403 if (!xpad || !input_dev)
406 xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
407 GFP_ATOMIC, &xpad->idata_dma);
411 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
416 xpad->dpad_mapping = xpad_device[i].dpad_mapping;
417 xpad->xtype = xpad_device[i].xtype;
418 if (xpad->dpad_mapping == MAP_DPAD_UNKNOWN)
419 xpad->dpad_mapping = dpad_to_buttons;
420 xpad->dev = input_dev;
421 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
422 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
424 input_dev->name = xpad_device[i].name;
425 input_dev->phys = xpad->phys;
426 usb_to_input_id(udev, &input_dev->id);
427 input_dev->dev.parent = &intf->dev;
429 input_set_drvdata(input_dev, xpad);
431 input_dev->open = xpad_open;
432 input_dev->close = xpad_close;
434 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
437 for (i = 0; xpad_btn[i] >= 0; i++)
438 set_bit(xpad_btn[i], input_dev->keybit);
439 if (xpad->xtype == XTYPE_XBOX360)
440 for (i = 0; xpad360_btn[i] >= 0; i++)
441 set_bit(xpad360_btn[i], input_dev->keybit);
442 if (xpad->dpad_mapping == MAP_DPAD_TO_BUTTONS)
443 for (i = 0; xpad_btn_pad[i] >= 0; i++)
444 set_bit(xpad_btn_pad[i], input_dev->keybit);
447 for (i = 0; xpad_abs[i] >= 0; i++)
448 xpad_set_up_abs(input_dev, xpad_abs[i]);
449 if (xpad->dpad_mapping == MAP_DPAD_TO_AXES)
450 for (i = 0; xpad_abs_pad[i] >= 0; i++)
451 xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
453 ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
454 usb_fill_int_urb(xpad->irq_in, udev,
455 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
456 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
457 xpad, ep_irq_in->bInterval);
458 xpad->irq_in->transfer_dma = xpad->idata_dma;
459 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
461 error = input_register_device(xpad->dev);
465 usb_set_intfdata(intf, xpad);
468 fail3: usb_free_urb(xpad->irq_in);
469 fail2: usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
470 fail1: input_free_device(input_dev);
476 static void xpad_disconnect(struct usb_interface *intf)
478 struct usb_xpad *xpad = usb_get_intfdata (intf);
480 usb_set_intfdata(intf, NULL);
482 usb_kill_urb(xpad->irq_in);
483 input_unregister_device(xpad->dev);
484 usb_free_urb(xpad->irq_in);
485 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN,
486 xpad->idata, xpad->idata_dma);
491 static struct usb_driver xpad_driver = {
494 .disconnect = xpad_disconnect,
495 .id_table = xpad_table,
498 static int __init usb_xpad_init(void)
500 int result = usb_register(&xpad_driver);
502 info(DRIVER_DESC ":" DRIVER_VERSION);
506 static void __exit usb_xpad_exit(void)
508 usb_deregister(&xpad_driver);
511 module_init(usb_xpad_init);
512 module_exit(usb_xpad_exit);
514 MODULE_AUTHOR(DRIVER_AUTHOR);
515 MODULE_DESCRIPTION(DRIVER_DESC);
516 MODULE_LICENSE("GPL");