blob: cebb6c463bfbadcdf204c5d8453c10a9d4a1acaf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#include <linux/init.h>
59#include <linux/slab.h>
60#include <linux/module.h>
61#include <linux/smp_lock.h>
David Brownellae0dadc2006-06-13 10:04:34 -070062#include <linux/usb/input.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
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
Arjan van de Ven4c4c9432005-11-29 09:43:42 +010070static const struct xpad_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 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
Arjan van de Ven4c4c9432005-11-29 09:43:42 +010081static const signed short xpad_btn[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 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
Arjan van de Ven4c4c9432005-11-29 09:43:42 +010087static const signed short xpad_abs[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 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
95static struct usb_device_id xpad_table [] = {
96 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
97 { }
98};
99
100MODULE_DEVICE_TABLE (usb, xpad_table);
101
102struct usb_xpad {
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500103 struct input_dev *dev; /* input device interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 struct usb_device *udev; /* usb device */
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 struct urb *irq_in; /* urb for interrupt in report */
107 unsigned char *idata; /* input data */
108 dma_addr_t idata_dma;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 char phys[65]; /* physical device path */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111};
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
David Howells7d12e782006-10-05 14:55:46 +0100123static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500125 struct input_dev *dev = xpad->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 /* left stick */
128 input_report_abs(dev, ABS_X, (__s16) (((__s16)data[13] << 8) | data[12]));
129 input_report_abs(dev, ABS_Y, (__s16) (((__s16)data[15] << 8) | data[14]));
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 /* right stick */
132 input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[17] << 8) | data[16]));
133 input_report_abs(dev, ABS_RY, (__s16) (((__s16)data[19] << 8) | data[18]));
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 /* triggers left/right */
136 input_report_abs(dev, ABS_Z, data[10]);
137 input_report_abs(dev, ABS_RZ, data[11]);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 /* digital pad */
140 input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x08) - !!(data[2] & 0x04));
141 input_report_abs(dev, ABS_HAT0Y, !!(data[2] & 0x02) - !!(data[2] & 0x01));
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 /* start/back buttons and stick press left/right */
144 input_report_key(dev, BTN_START, (data[2] & 0x10) >> 4);
145 input_report_key(dev, BTN_BACK, (data[2] & 0x20) >> 5);
146 input_report_key(dev, BTN_THUMBL, (data[2] & 0x40) >> 6);
147 input_report_key(dev, BTN_THUMBR, data[2] >> 7);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 /* "analog" buttons A, B, X, Y */
150 input_report_key(dev, BTN_A, data[4]);
151 input_report_key(dev, BTN_B, data[5]);
152 input_report_key(dev, BTN_X, data[6]);
153 input_report_key(dev, BTN_Y, data[7]);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 /* "analog" buttons black, white */
156 input_report_key(dev, BTN_C, data[8]);
157 input_report_key(dev, BTN_Z, data[9]);
158
159 input_sync(dev);
160}
161
David Howells7d12e782006-10-05 14:55:46 +0100162static void xpad_irq_in(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
164 struct usb_xpad *xpad = urb->context;
165 int retval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 switch (urb->status) {
168 case 0:
169 /* success */
170 break;
171 case -ECONNRESET:
172 case -ENOENT:
173 case -ESHUTDOWN:
174 /* this urb is terminated, clean up */
175 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
176 return;
177 default:
178 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
179 goto exit;
180 }
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500181
David Howells7d12e782006-10-05 14:55:46 +0100182 xpad_process_packet(xpad, 0, xpad->idata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184exit:
185 retval = usb_submit_urb (urb, GFP_ATOMIC);
186 if (retval)
187 err ("%s - usb_submit_urb failed with result %d",
188 __FUNCTION__, retval);
189}
190
191static int xpad_open (struct input_dev *dev)
192{
193 struct usb_xpad *xpad = dev->private;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 xpad->irq_in->dev = xpad->udev;
Dmitry Torokhov65cde542005-05-29 02:29:38 -0500196 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 return -EIO;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 return 0;
200}
201
202static void xpad_close (struct input_dev *dev)
203{
204 struct usb_xpad *xpad = dev->private;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500205
Dmitry Torokhov65cde542005-05-29 02:29:38 -0500206 usb_kill_urb(xpad->irq_in);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207}
208
209static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
210{
211 struct usb_device *udev = interface_to_usbdev (intf);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500212 struct usb_xpad *xpad;
213 struct input_dev *input_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 struct usb_endpoint_descriptor *ep_irq_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 int i;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 for (i = 0; xpad_device[i].idVendor; i++) {
218 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
219 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
220 break;
221 }
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500222
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500223 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
224 input_dev = input_allocate_device();
225 if (!xpad || !input_dev)
226 goto fail1;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
229 SLAB_ATOMIC, &xpad->idata_dma);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500230 if (!xpad->idata)
231 goto fail1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500234 if (!xpad->irq_in)
235 goto fail2;
236
237 xpad->udev = udev;
238 xpad->dev = input_dev;
239 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
240 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
241
242 input_dev->name = xpad_device[i].name;
243 input_dev->phys = xpad->phys;
244 usb_to_input_id(udev, &input_dev->id);
245 input_dev->cdev.dev = &intf->dev;
246 input_dev->private = xpad;
247 input_dev->open = xpad_open;
248 input_dev->close = xpad_close;
249
250 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
251
252 for (i = 0; xpad_btn[i] >= 0; i++)
253 set_bit(xpad_btn[i], input_dev->keybit);
254
255 for (i = 0; xpad_abs[i] >= 0; i++) {
256
257 signed short t = xpad_abs[i];
258
259 set_bit(t, input_dev->absbit);
260
261 switch (t) {
262 case ABS_X:
263 case ABS_Y:
264 case ABS_RX:
265 case ABS_RY: /* the two sticks */
266 input_set_abs_params(input_dev, t, -32768, 32767, 16, 128);
267 break;
268 case ABS_Z:
269 case ABS_RZ: /* the triggers */
270 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
271 break;
272 case ABS_HAT0X:
273 case ABS_HAT0Y: /* the d-pad */
274 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
275 break;
276 }
277 }
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 usb_fill_int_urb(xpad->irq_in, udev,
281 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
282 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
283 xpad, ep_irq_in->bInterval);
284 xpad->irq_in->transfer_dma = xpad->idata_dma;
285 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500286
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500287 input_register_device(xpad->dev);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 usb_set_intfdata(intf, xpad);
290 return 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500291
292fail2: usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
293fail1: input_free_device(input_dev);
294 kfree(xpad);
295 return -ENOMEM;
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297}
298
299static void xpad_disconnect(struct usb_interface *intf)
300{
301 struct usb_xpad *xpad = usb_get_intfdata (intf);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 usb_set_intfdata(intf, NULL);
304 if (xpad) {
305 usb_kill_urb(xpad->irq_in);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500306 input_unregister_device(xpad->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 usb_free_urb(xpad->irq_in);
308 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
309 kfree(xpad);
310 }
311}
312
313static struct usb_driver xpad_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 .name = "xpad",
315 .probe = xpad_probe,
316 .disconnect = xpad_disconnect,
317 .id_table = xpad_table,
318};
319
320static int __init usb_xpad_init(void)
321{
322 int result = usb_register(&xpad_driver);
323 if (result == 0)
324 info(DRIVER_DESC ":" DRIVER_VERSION);
325 return result;
326}
327
328static void __exit usb_xpad_exit(void)
329{
330 usb_deregister(&xpad_driver);
331}
332
333module_init(usb_xpad_init);
334module_exit(usb_xpad_exit);
335
336MODULE_AUTHOR(DRIVER_AUTHOR);
337MODULE_DESCRIPTION(DRIVER_DESC);
338MODULE_LICENSE("GPL");