Merge with rsync://fileserver/linux
[linux-2.6] / 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
66 #define DRIVER_VERSION "v0.0.5"
67 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
68 #define DRIVER_DESC "X-Box pad driver"
69
70 #define XPAD_PKT_LEN 32
71
72 static struct xpad_device {
73         u16 idVendor;
74         u16 idProduct;
75         char *name;
76 } xpad_device[] = {
77         { 0x045e, 0x0202, "Microsoft X-Box pad (US)" },
78         { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)" },
79         { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)" },
80         { 0x0000, 0x0000, "X-Box pad" }
81 };
82
83 static signed short xpad_btn[] = {
84         BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z,       /* "analog" buttons */
85         BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR,    /* start/back/sticks */
86         -1                                              /* terminating entry */
87 };
88
89 static signed short xpad_abs[] = {
90         ABS_X, ABS_Y,           /* left stick */
91         ABS_RX, ABS_RY,         /* right stick */
92         ABS_Z, ABS_RZ,          /* triggers left/right */
93         ABS_HAT0X, ABS_HAT0Y,   /* digital pad */
94         -1                      /* terminating entry */
95 };
96
97 static struct usb_device_id xpad_table [] = {
98         { USB_INTERFACE_INFO('X', 'B', 0) },    /* X-Box USB-IF not approved class */
99         { }
100 };
101
102 MODULE_DEVICE_TABLE (usb, xpad_table);
103
104 struct usb_xpad {
105         struct input_dev dev;                   /* input device interface */
106         struct usb_device *udev;                /* usb device */
107
108         struct urb *irq_in;                     /* urb for interrupt in report */
109         unsigned char *idata;                   /* input data */
110         dma_addr_t idata_dma;
111
112         char phys[65];                          /* physical device path */
113 };
114
115 /*
116  *      xpad_process_packet
117  *
118  *      Completes a request by converting the data into events for the
119  *      input subsystem.
120  *
121  *      The used report descriptor was taken from ITO Takayukis website:
122  *       http://euc.jp/periphs/xbox-controller.ja.html
123  */
124
125 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data, struct pt_regs *regs)
126 {
127         struct input_dev *dev = &xpad->dev;
128
129         input_regs(dev, regs);
130
131         /* left stick */
132         input_report_abs(dev, ABS_X, (__s16) (((__s16)data[13] << 8) | data[12]));
133         input_report_abs(dev, ABS_Y, (__s16) (((__s16)data[15] << 8) | data[14]));
134
135         /* right stick */
136         input_report_abs(dev, ABS_RX, (__s16) (((__s16)data[17] << 8) | data[16]));
137         input_report_abs(dev, ABS_RY, (__s16) (((__s16)data[19] << 8) | data[18]));
138
139         /* triggers left/right */
140         input_report_abs(dev, ABS_Z, data[10]);
141         input_report_abs(dev, ABS_RZ, data[11]);
142
143         /* digital pad */
144         input_report_abs(dev, ABS_HAT0X, !!(data[2] & 0x08) - !!(data[2] & 0x04));
145         input_report_abs(dev, ABS_HAT0Y, !!(data[2] & 0x02) - !!(data[2] & 0x01));
146
147         /* start/back buttons and stick press left/right */
148         input_report_key(dev, BTN_START, (data[2] & 0x10) >> 4);
149         input_report_key(dev, BTN_BACK, (data[2] & 0x20) >> 5);
150         input_report_key(dev, BTN_THUMBL, (data[2] & 0x40) >> 6);
151         input_report_key(dev, BTN_THUMBR, data[2] >> 7);
152
153         /* "analog" buttons A, B, X, Y */
154         input_report_key(dev, BTN_A, data[4]);
155         input_report_key(dev, BTN_B, data[5]);
156         input_report_key(dev, BTN_X, data[6]);
157         input_report_key(dev, BTN_Y, data[7]);
158
159         /* "analog" buttons black, white */
160         input_report_key(dev, BTN_C, data[8]);
161         input_report_key(dev, BTN_Z, data[9]);
162
163         input_sync(dev);
164 }
165
166 static void xpad_irq_in(struct urb *urb, struct pt_regs *regs)
167 {
168         struct usb_xpad *xpad = urb->context;
169         int retval;
170
171         switch (urb->status) {
172         case 0:
173                 /* success */
174                 break;
175         case -ECONNRESET:
176         case -ENOENT:
177         case -ESHUTDOWN:
178                 /* this urb is terminated, clean up */
179                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
180                 return;
181         default:
182                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
183                 goto exit;
184         }
185
186         xpad_process_packet(xpad, 0, xpad->idata, regs);
187
188 exit:
189         retval = usb_submit_urb (urb, GFP_ATOMIC);
190         if (retval)
191                 err ("%s - usb_submit_urb failed with result %d",
192                      __FUNCTION__, retval);
193 }
194
195 static int xpad_open (struct input_dev *dev)
196 {
197         struct usb_xpad *xpad = dev->private;
198
199         xpad->irq_in->dev = xpad->udev;
200         if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
201                 return -EIO;
202
203         return 0;
204 }
205
206 static void xpad_close (struct input_dev *dev)
207 {
208         struct usb_xpad *xpad = dev->private;
209
210         usb_kill_urb(xpad->irq_in);
211 }
212
213 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
214 {
215         struct usb_device *udev = interface_to_usbdev (intf);
216         struct usb_xpad *xpad = NULL;
217         struct usb_endpoint_descriptor *ep_irq_in;
218         char path[64];
219         int i;
220
221         for (i = 0; xpad_device[i].idVendor; i++) {
222                 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
223                     (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
224                         break;
225         }
226
227         if ((xpad = kmalloc (sizeof(struct usb_xpad), GFP_KERNEL)) == NULL) {
228                 err("cannot allocate memory for new pad");
229                 return -ENOMEM;
230         }
231         memset(xpad, 0, sizeof(struct usb_xpad));
232
233         xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
234                                        SLAB_ATOMIC, &xpad->idata_dma);
235         if (!xpad->idata) {
236                 kfree(xpad);
237                 return -ENOMEM;
238         }
239
240         xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
241         if (!xpad->irq_in) {
242                 err("cannot allocate memory for new pad irq urb");
243                 usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
244                 kfree(xpad);
245                 return -ENOMEM;
246         }
247
248         ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
249
250         usb_fill_int_urb(xpad->irq_in, udev,
251                          usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
252                          xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
253                          xpad, ep_irq_in->bInterval);
254         xpad->irq_in->transfer_dma = xpad->idata_dma;
255         xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
256
257         xpad->udev = udev;
258
259         xpad->dev.id.bustype = BUS_USB;
260         xpad->dev.id.vendor = le16_to_cpu(udev->descriptor.idVendor);
261         xpad->dev.id.product = le16_to_cpu(udev->descriptor.idProduct);
262         xpad->dev.id.version = le16_to_cpu(udev->descriptor.bcdDevice);
263         xpad->dev.dev = &intf->dev;
264         xpad->dev.private = xpad;
265         xpad->dev.name = xpad_device[i].name;
266         xpad->dev.phys = xpad->phys;
267         xpad->dev.open = xpad_open;
268         xpad->dev.close = xpad_close;
269
270         usb_make_path(udev, path, 64);
271         snprintf(xpad->phys, 64,  "%s/input0", path);
272
273         xpad->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
274
275         for (i = 0; xpad_btn[i] >= 0; i++)
276                 set_bit(xpad_btn[i], xpad->dev.keybit);
277
278         for (i = 0; xpad_abs[i] >= 0; i++) {
279
280                 signed short t = xpad_abs[i];
281
282                 set_bit(t, xpad->dev.absbit);
283
284                 switch (t) {
285                         case ABS_X:
286                         case ABS_Y:
287                         case ABS_RX:
288                         case ABS_RY:    /* the two sticks */
289                                 xpad->dev.absmax[t] =  32767;
290                                 xpad->dev.absmin[t] = -32768;
291                                 xpad->dev.absflat[t] = 128;
292                                 xpad->dev.absfuzz[t] = 16;
293                                 break;
294                         case ABS_Z:
295                         case ABS_RZ:    /* the triggers */
296                                 xpad->dev.absmax[t] = 255;
297                                 xpad->dev.absmin[t] = 0;
298                                 break;
299                         case ABS_HAT0X:
300                         case ABS_HAT0Y: /* the d-pad */
301                                 xpad->dev.absmax[t] =  1;
302                                 xpad->dev.absmin[t] = -1;
303                                 break;
304                 }
305         }
306
307         input_register_device(&xpad->dev);
308
309         printk(KERN_INFO "input: %s on %s", xpad->dev.name, path);
310
311         usb_set_intfdata(intf, xpad);
312         return 0;
313 }
314
315 static void xpad_disconnect(struct usb_interface *intf)
316 {
317         struct usb_xpad *xpad = usb_get_intfdata (intf);
318
319         usb_set_intfdata(intf, NULL);
320         if (xpad) {
321                 usb_kill_urb(xpad->irq_in);
322                 input_unregister_device(&xpad->dev);
323                 usb_free_urb(xpad->irq_in);
324                 usb_buffer_free(interface_to_usbdev(intf), XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
325                 kfree(xpad);
326         }
327 }
328
329 static struct usb_driver xpad_driver = {
330         .owner          = THIS_MODULE,
331         .name           = "xpad",
332         .probe          = xpad_probe,
333         .disconnect     = xpad_disconnect,
334         .id_table       = xpad_table,
335 };
336
337 static int __init usb_xpad_init(void)
338 {
339         int result = usb_register(&xpad_driver);
340         if (result == 0)
341                 info(DRIVER_DESC ":" DRIVER_VERSION);
342         return result;
343 }
344
345 static void __exit usb_xpad_exit(void)
346 {
347         usb_deregister(&xpad_driver);
348 }
349
350 module_init(usb_xpad_init);
351 module_exit(usb_xpad_exit);
352
353 MODULE_AUTHOR(DRIVER_AUTHOR);
354 MODULE_DESCRIPTION(DRIVER_DESC);
355 MODULE_LICENSE("GPL");