43112f040b6de336bf9b2e3428aa3b49e44c115f
[linux-2.6.git] / 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 #include <linux/usb_input.h>
66
67 #define DRIVER_VERSION "v0.0.5"
68 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
69 #define DRIVER_DESC "X-Box pad driver"
70
71 #define XPAD_PKT_LEN 32
72
73 static struct xpad_device {
74         u16 idVendor;
75         u16 idProduct;
76         char *name;
77 } xpad_device[] = {
78         { 0x045e, 0x0202, "Microsoft X-Box pad (US)" },
79         { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)" },
80         { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)" },
81         { 0x0000, 0x0000, "X-Box pad" }
82 };
83
84 static signed short xpad_btn[] = {
85         BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z,       /* "analog" buttons */
86         BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR,    /* start/back/sticks */
87         -1                                              /* terminating entry */
88 };
89
90 static signed short xpad_abs[] = {
91         ABS_X, ABS_Y,           /* left stick */
92         ABS_RX, ABS_RY,         /* right stick */
93         ABS_Z, ABS_RZ,          /* triggers left/right */
94         ABS_HAT0X, ABS_HAT0Y,   /* digital pad */
95         -1                      /* terminating entry */
96 };
97
98 static struct usb_device_id xpad_table [] = {
99         { USB_INTERFACE_INFO('X', 'B', 0) },    /* X-Box USB-IF not approved class */
100         { }
101 };
102
103 MODULE_DEVICE_TABLE (usb, xpad_table);
104
105 struct usb_xpad {
106         struct input_dev *dev;                  /* input device interface */
107         struct usb_device *udev;                /* usb device */
108
109         struct urb *irq_in;                     /* urb for interrupt in report */
110         unsigned char *idata;                   /* input data */
111         dma_addr_t idata_dma;
112
113         char phys[65];                          /* physical device path */
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         xpad->irq_in->dev = xpad->udev;
201         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
202                 return -EIO;
203
204         return 0;
205 }
206
207 static void xpad_close (struct input_dev *dev)
208 {
209         struct usb_xpad *xpad = dev->private;
210
211         usb_kill_urb(xpad->irq_in);
212 }
213
214 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
215 {
216         struct usb_device *udev = interface_to_usbdev (intf);
217         struct usb_xpad *xpad;
218         struct input_dev *input_dev;
219         struct usb_endpoint_descriptor *ep_irq_in;
220         int i;
221
222         for (i = 0; xpad_device[i].idVendor; i++) {
223                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
224                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
225                         break;
226         }
227
228         xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
229         input_dev = input_allocate_device();
230         if (!xpad || !input_dev)
231                 goto fail1;
232
233         xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
234                                        SLAB_ATOMIC, &xpad->idata_dma);
235         if (!xpad->idata)
236                 goto fail1;
237
238         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
239         if (!xpad->irq_in)
240                 goto fail2;
241
242         xpad->udev = udev;
243         xpad->dev = input_dev;
244         usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
245         strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
246
247         input_dev->name = xpad_device[i].name;
248         input_dev->phys = xpad->phys;
249         usb_to_input_id(udev, &input_dev->id);
250         input_dev->cdev.dev = &intf->dev;
251         input_dev->private = xpad;
252         input_dev->open = xpad_open;
253         input_dev->close = xpad_close;
254
255         input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
256
257         for (i = 0; xpad_btn[i] >= 0; i++)
258                 set_bit(xpad_btn[i], input_dev->keybit);
259
260         for (i = 0; xpad_abs[i] >= 0; i++) {
261
262                 signed short t = xpad_abs[i];
263
264                 set_bit(t, input_dev->absbit);
265
266                 switch (t) {
267                         case ABS_X:
268                         case ABS_Y:
269                         case ABS_RX:
270                         case ABS_RY:    /* the two sticks */
271                                 input_set_abs_params(input_dev, t, -32768, 32767, 16, 128);
272                                 break;
273                         case ABS_Z:
274                         case ABS_RZ:    /* the triggers */
275                                 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
276                                 break;
277                         case ABS_HAT0X:
278                         case ABS_HAT0Y: /* the d-pad */
279                                 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
280                                 break;
281                 }
282         }
283
284         ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
285         usb_fill_int_urb(xpad->irq_in, udev,
286                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
287                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
288                          xpad, ep_irq_in->bInterval);
289         xpad->irq_in->transfer_dma = xpad->idata_dma;
290         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
291
292         input_register_device(xpad->dev);
293
294         usb_set_intfdata(intf, xpad);
295         return 0;
296
297 fail2:  usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
298 fail1:  input_free_device(input_dev);
299         kfree(xpad);
300         return -ENOMEM;
301
302 }
303
304 static void xpad_disconnect(struct usb_interface *intf)
305 {
306         struct usb_xpad *xpad = usb_get_intfdata (intf);
307
308         usb_set_intfdata(intf, NULL);
309         if (xpad) {
310                 usb_kill_urb(xpad->irq_in);
311                 input_unregister_device(xpad->dev);
312                 usb_free_urb(xpad->irq_in);
313                 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
314                 kfree(xpad);
315         }
316 }
317
318 static struct usb_driver xpad_driver = {
319         .owner          = THIS_MODULE,
320         .name           = "xpad",
321         .probe          = xpad_probe,
322         .disconnect     = xpad_disconnect,
323         .id_table       = xpad_table,
324 };
325
326 static int __init usb_xpad_init(void)
327 {
328         int result = usb_register(&xpad_driver);
329         if (result == 0)
330                 info(DRIVER_DESC ":" DRIVER_VERSION);
331         return result;
332 }
333
334 static void __exit usb_xpad_exit(void)
335 {
336         usb_deregister(&xpad_driver);
337 }
338
339 module_init(usb_xpad_init);
340 module_exit(usb_xpad_exit);
341
342 MODULE_AUTHOR(DRIVER_AUTHOR);
343 MODULE_DESCRIPTION(DRIVER_DESC);
344 MODULE_LICENSE("GPL");