xref: /openbmc/linux/drivers/input/joystick/xpad.c (revision f15cbe6f1a4b4d9df59142fc8e4abb973302cf44)
1 /*
2  * X-Box gamepad driver
3  *
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>
12  *
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.
17  *
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.
22  *
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
26  *
27  *
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
33  *
34  * Thanks to:
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
39  *
40  * TODO:
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
45  *
46  * History:
47  *
48  * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
49  *
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
53  *
54  * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
55  *  - indentation fixes
56  *  - usb + input init sequence fixes
57  *
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
62  *
63  * 2002-07-17 - 0.0.5 : simplified d-pad handling
64  *
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
71  *
72  * Later changes can be tracked in SCM.
73  */
74 
75 #include <linux/kernel.h>
76 #include <linux/init.h>
77 #include <linux/slab.h>
78 #include <linux/stat.h>
79 #include <linux/module.h>
80 #include <linux/usb/input.h>
81 
82 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
83 #define DRIVER_DESC "X-Box pad driver"
84 
85 #define XPAD_PKT_LEN 32
86 
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       2
92 
93 #define XTYPE_XBOX        0
94 #define XTYPE_XBOX360     1
95 #define XTYPE_XBOX360W    2
96 #define XTYPE_UNKNOWN     3
97 
98 static int dpad_to_buttons;
99 module_param(dpad_to_buttons, bool, S_IRUGO);
100 MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
101 
102 static const struct xpad_device {
103 	u16 idVendor;
104 	u16 idProduct;
105 	char *name;
106 	u8 dpad_mapping;
107 	u8 xtype;
108 } xpad_device[] = {
109 	{ 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
110 	{ 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
111 	{ 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
112 	{ 0x045e, 0x0287, "Microsoft Xbox Controller S", MAP_DPAD_TO_AXES, XTYPE_XBOX },
113 	{ 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
114 	{ 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
115 	{ 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
116 	{ 0x046d, 0xc242, "Logitech Chillstream Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX360 },
117 	{ 0x046d, 0xca84, "Logitech Xbox Cordless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
118 	{ 0x046d, 0xca88, "Logitech Compact Controller for Xbox", MAP_DPAD_TO_AXES, XTYPE_XBOX },
119 	{ 0x05fd, 0x1007, "Mad Catz Controller (unverified)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
120 	{ 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", MAP_DPAD_TO_AXES, XTYPE_XBOX },
121 	{ 0x0738, 0x4516, "Mad Catz Control Pad", MAP_DPAD_TO_AXES, XTYPE_XBOX },
122 	{ 0x0738, 0x4522, "Mad Catz LumiCON", MAP_DPAD_TO_AXES, XTYPE_XBOX },
123 	{ 0x0738, 0x4526, "Mad Catz Control Pad Pro", MAP_DPAD_TO_AXES, XTYPE_XBOX },
124 	{ 0x0738, 0x4536, "Mad Catz MicroCON", MAP_DPAD_TO_AXES, XTYPE_XBOX },
125 	{ 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
126 	{ 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
127 	{ 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX360 },
128 	{ 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
129 	{ 0x0c12, 0x8802, "Zeroplus Xbox Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
130 	{ 0x0c12, 0x8810, "Zeroplus Xbox Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
131 	{ 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", MAP_DPAD_TO_AXES, XTYPE_XBOX },
132 	{ 0x0e4c, 0x1097, "Radica Gamester Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
133 	{ 0x0e4c, 0x2390, "Radica Games Jtech Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
134 	{ 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
135 	{ 0x0e6f, 0x0005, "Eclipse wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
136 	{ 0x0e6f, 0x0006, "Edge wireless Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
137 	{ 0x0e6f, 0x0006, "Pelican 'TSZ' Wired Xbox 360 Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX360 },
138 	{ 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", MAP_DPAD_TO_AXES, XTYPE_XBOX },
139 	{ 0x0f30, 0x0202, "Joytech Advanced Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
140 	{ 0x0f30, 0x8888, "BigBen XBMiniPad Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
141 	{ 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
142 	{ 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
143 	{ 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", MAP_DPAD_TO_AXES, XTYPE_XBOX360 },
144 	{ 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
145 	{ 0x045e, 0x028e, "Microsoft X-Box 360 pad", MAP_DPAD_TO_AXES, XTYPE_XBOX360 },
146 	{ 0xffff, 0xffff, "Chinese-made Xbox Controller", MAP_DPAD_TO_AXES, XTYPE_XBOX },
147 	{ 0x0000, 0x0000, "Generic X-Box pad", MAP_DPAD_UNKNOWN, XTYPE_UNKNOWN }
148 };
149 
150 /* buttons shared with xbox and xbox360 */
151 static const signed short xpad_common_btn[] = {
152 	BTN_A, BTN_B, BTN_X, BTN_Y,			/* "analog" buttons */
153 	BTN_START, BTN_BACK, BTN_THUMBL, BTN_THUMBR,	/* start/back/sticks */
154 	-1						/* terminating entry */
155 };
156 
157 /* original xbox controllers only */
158 static const signed short xpad_btn[] = {
159 	BTN_C, BTN_Z,		/* "analog" buttons */
160 	-1			/* terminating entry */
161 };
162 
163 /* only used if MAP_DPAD_TO_BUTTONS */
164 static const signed short xpad_btn_pad[] = {
165 	BTN_LEFT, BTN_RIGHT,		/* d-pad left, right */
166 	BTN_0, BTN_1,			/* d-pad up, down (XXX names??) */
167 	-1				/* terminating entry */
168 };
169 
170 static const signed short xpad360_btn[] = {  /* buttons for x360 controller */
171 	BTN_TL, BTN_TR,		/* Button LB/RB */
172 	BTN_MODE,		/* The big X button */
173 	-1
174 };
175 
176 static const signed short xpad_abs[] = {
177 	ABS_X, ABS_Y,		/* left stick */
178 	ABS_RX, ABS_RY,		/* right stick */
179 	ABS_Z, ABS_RZ,		/* triggers left/right */
180 	-1			/* terminating entry */
181 };
182 
183 /* only used if MAP_DPAD_TO_AXES */
184 static const signed short xpad_abs_pad[] = {
185 	ABS_HAT0X, ABS_HAT0Y,	/* d-pad axes */
186 	-1			/* terminating entry */
187 };
188 
189 /* Xbox 360 has a vendor-specific class, so we cannot match it with only
190  * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
191  * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
192  * wireless controllers have protocol 129. */
193 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
194 	.match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
195 	.idVendor = (vend), \
196 	.bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
197 	.bInterfaceSubClass = 93, \
198 	.bInterfaceProtocol = (pr)
199 #define XPAD_XBOX360_VENDOR(vend) \
200 	{ XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
201 	{ XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
202 
203 static struct usb_device_id xpad_table [] = {
204 	{ USB_INTERFACE_INFO('X', 'B', 0) },	/* X-Box USB-IF not approved class */
205 	XPAD_XBOX360_VENDOR(0x045e),		/* Microsoft X-Box 360 controllers */
206 	XPAD_XBOX360_VENDOR(0x046d),		/* Logitech X-Box 360 style controllers */
207 	XPAD_XBOX360_VENDOR(0x0738),		/* Mad Catz X-Box 360 controllers */
208 	XPAD_XBOX360_VENDOR(0x0e6f),		/* 0x0e6f X-Box 360 controllers */
209 	XPAD_XBOX360_VENDOR(0x1430),		/* RedOctane X-Box 360 controllers */
210 	{ }
211 };
212 
213 MODULE_DEVICE_TABLE (usb, xpad_table);
214 
215 struct usb_xpad {
216 	struct input_dev *dev;		/* input device interface */
217 	struct usb_device *udev;	/* usb device */
218 
219 	int pad_present;
220 
221 	struct urb *irq_in;		/* urb for interrupt in report */
222 	unsigned char *idata;		/* input data */
223 	dma_addr_t idata_dma;
224 
225 	struct urb *bulk_out;
226 	unsigned char *bdata;
227 
228 #if defined(CONFIG_JOYSTICK_XPAD_FF) || defined(CONFIG_JOYSTICK_XPAD_LEDS)
229 	struct urb *irq_out;		/* urb for interrupt out report */
230 	unsigned char *odata;		/* output data */
231 	dma_addr_t odata_dma;
232 	struct mutex odata_mutex;
233 #endif
234 
235 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
236 	struct xpad_led *led;
237 #endif
238 
239 	char phys[64];			/* physical device path */
240 
241 	int dpad_mapping;		/* map d-pad to buttons or to axes */
242 	int xtype;			/* type of xbox device */
243 };
244 
245 /*
246  *	xpad_process_packet
247  *
248  *	Completes a request by converting the data into events for the
249  *	input subsystem.
250  *
251  *	The used report descriptor was taken from ITO Takayukis website:
252  *	 http://euc.jp/periphs/xbox-controller.ja.html
253  */
254 
255 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
256 {
257 	struct input_dev *dev = xpad->dev;
258 
259 	/* left stick */
260 	input_report_abs(dev, ABS_X,
261 			 (__s16) le16_to_cpup((__le16 *)(data + 12)));
262 	input_report_abs(dev, ABS_Y,
263 			 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
264 
265 	/* right stick */
266 	input_report_abs(dev, ABS_RX,
267 			 (__s16) le16_to_cpup((__le16 *)(data + 16)));
268 	input_report_abs(dev, ABS_RY,
269 			 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
270 
271 	/* triggers left/right */
272 	input_report_abs(dev, ABS_Z, data[10]);
273 	input_report_abs(dev, ABS_RZ, data[11]);
274 
275 	/* digital pad */
276 	if (xpad->dpad_mapping == MAP_DPAD_TO_AXES) {
277 		input_report_abs(dev, ABS_HAT0X,
278 				 !!(data[2] & 0x08) - !!(data[2] & 0x04));
279 		input_report_abs(dev, ABS_HAT0Y,
280 				 !!(data[2] & 0x02) - !!(data[2] & 0x01));
281 	} else /* xpad->dpad_mapping == MAP_DPAD_TO_BUTTONS */ {
282 		input_report_key(dev, BTN_LEFT,  data[2] & 0x04);
283 		input_report_key(dev, BTN_RIGHT, data[2] & 0x08);
284 		input_report_key(dev, BTN_0,     data[2] & 0x01); /* up */
285 		input_report_key(dev, BTN_1,     data[2] & 0x02); /* down */
286 	}
287 
288 	/* start/back buttons and stick press left/right */
289 	input_report_key(dev, BTN_START,  data[2] & 0x10);
290 	input_report_key(dev, BTN_BACK,   data[2] & 0x20);
291 	input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
292 	input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
293 
294 	/* "analog" buttons A, B, X, Y */
295 	input_report_key(dev, BTN_A, data[4]);
296 	input_report_key(dev, BTN_B, data[5]);
297 	input_report_key(dev, BTN_X, data[6]);
298 	input_report_key(dev, BTN_Y, data[7]);
299 
300 	/* "analog" buttons black, white */
301 	input_report_key(dev, BTN_C, data[8]);
302 	input_report_key(dev, BTN_Z, data[9]);
303 
304 	input_sync(dev);
305 }
306 
307 /*
308  *	xpad360_process_packet
309  *
310  *	Completes a request by converting the data into events for the
311  *	input subsystem. It is version for xbox 360 controller
312  *
313  *	The used report descriptor was taken from:
314  *		http://www.free60.org/wiki/Gamepad
315  */
316 
317 static void xpad360_process_packet(struct usb_xpad *xpad,
318 				   u16 cmd, unsigned char *data)
319 {
320 	struct input_dev *dev = xpad->dev;
321 
322 	/* digital pad */
323 	if (xpad->dpad_mapping == MAP_DPAD_TO_AXES) {
324 		input_report_abs(dev, ABS_HAT0X,
325 				 !!(data[2] & 0x08) - !!(data[2] & 0x04));
326 		input_report_abs(dev, ABS_HAT0Y,
327 				 !!(data[2] & 0x02) - !!(data[2] & 0x01));
328 	} else if (xpad->dpad_mapping == MAP_DPAD_TO_BUTTONS) {
329 		/* dpad as buttons (right, left, down, up) */
330 		input_report_key(dev, BTN_LEFT, data[2] & 0x04);
331 		input_report_key(dev, BTN_RIGHT, data[2] & 0x08);
332 		input_report_key(dev, BTN_0, data[2] & 0x01);	/* up */
333 		input_report_key(dev, BTN_1, data[2] & 0x02);	/* down */
334 	}
335 
336 	/* start/back buttons */
337 	input_report_key(dev, BTN_START,  data[2] & 0x10);
338 	input_report_key(dev, BTN_BACK,   data[2] & 0x20);
339 
340 	/* stick press left/right */
341 	input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
342 	input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
343 
344 	/* buttons A,B,X,Y,TL,TR and MODE */
345 	input_report_key(dev, BTN_A,	data[3] & 0x10);
346 	input_report_key(dev, BTN_B,	data[3] & 0x20);
347 	input_report_key(dev, BTN_X,	data[3] & 0x40);
348 	input_report_key(dev, BTN_Y,	data[3] & 0x80);
349 	input_report_key(dev, BTN_TL,	data[3] & 0x01);
350 	input_report_key(dev, BTN_TR,	data[3] & 0x02);
351 	input_report_key(dev, BTN_MODE,	data[3] & 0x04);
352 
353 	/* left stick */
354 	input_report_abs(dev, ABS_X,
355 			 (__s16) le16_to_cpup((__le16 *)(data + 6)));
356 	input_report_abs(dev, ABS_Y,
357 			 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
358 
359 	/* right stick */
360 	input_report_abs(dev, ABS_RX,
361 			 (__s16) le16_to_cpup((__le16 *)(data + 10)));
362 	input_report_abs(dev, ABS_RY,
363 			 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
364 
365 	/* triggers left/right */
366 	input_report_abs(dev, ABS_Z, data[4]);
367 	input_report_abs(dev, ABS_RZ, data[5]);
368 
369 	input_sync(dev);
370 }
371 
372 /*
373  * xpad360w_process_packet
374  *
375  * Completes a request by converting the data into events for the
376  * input subsystem. It is version for xbox 360 wireless controller.
377  *
378  * Byte.Bit
379  * 00.1 - Status change: The controller or headset has connected/disconnected
380  *                       Bits 01.7 and 01.6 are valid
381  * 01.7 - Controller present
382  * 01.6 - Headset present
383  * 01.1 - Pad state (Bytes 4+) valid
384  *
385  */
386 
387 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
388 {
389 	/* Presence change */
390 	if (data[0] & 0x08) {
391 		if (data[1] & 0x80) {
392 			xpad->pad_present = 1;
393 			usb_submit_urb(xpad->bulk_out, GFP_ATOMIC);
394 		} else
395 			xpad->pad_present = 0;
396 	}
397 
398 	/* Valid pad data */
399 	if (!(data[1] & 0x1))
400 		return;
401 
402 	xpad360_process_packet(xpad, cmd, &data[4]);
403 }
404 
405 static void xpad_irq_in(struct urb *urb)
406 {
407 	struct usb_xpad *xpad = urb->context;
408 	int retval, status;
409 
410 	status = urb->status;
411 
412 	switch (status) {
413 	case 0:
414 		/* success */
415 		break;
416 	case -ECONNRESET:
417 	case -ENOENT:
418 	case -ESHUTDOWN:
419 		/* this urb is terminated, clean up */
420 		dbg("%s - urb shutting down with status: %d",
421 			__func__, status);
422 		return;
423 	default:
424 		dbg("%s - nonzero urb status received: %d",
425 			__func__, status);
426 		goto exit;
427 	}
428 
429 	switch (xpad->xtype) {
430 	case XTYPE_XBOX360:
431 		xpad360_process_packet(xpad, 0, xpad->idata);
432 		break;
433 	case XTYPE_XBOX360W:
434 		xpad360w_process_packet(xpad, 0, xpad->idata);
435 		break;
436 	default:
437 		xpad_process_packet(xpad, 0, xpad->idata);
438 	}
439 
440 exit:
441 	retval = usb_submit_urb (urb, GFP_ATOMIC);
442 	if (retval)
443 		err ("%s - usb_submit_urb failed with result %d",
444 		     __func__, retval);
445 }
446 
447 static void xpad_bulk_out(struct urb *urb)
448 {
449 	switch (urb->status) {
450 	case 0:
451 		/* success */
452 		break;
453 	case -ECONNRESET:
454 	case -ENOENT:
455 	case -ESHUTDOWN:
456 		/* this urb is terminated, clean up */
457 		dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
458 		break;
459 	default:
460 		dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
461 	}
462 }
463 
464 #if defined(CONFIG_JOYSTICK_XPAD_FF) || defined(CONFIG_JOYSTICK_XPAD_LEDS)
465 static void xpad_irq_out(struct urb *urb)
466 {
467 	int retval, status;
468 
469 	status = urb->status;
470 
471 	switch (status) {
472 		case 0:
473 		/* success */
474 		break;
475 		case -ECONNRESET:
476 		case -ENOENT:
477 		case -ESHUTDOWN:
478 			/* this urb is terminated, clean up */
479 			dbg("%s - urb shutting down with status: %d",
480 				__func__, status);
481 			return;
482 		default:
483 			dbg("%s - nonzero urb status received: %d",
484 				__func__, status);
485 			goto exit;
486 	}
487 
488 exit:
489 	retval = usb_submit_urb(urb, GFP_ATOMIC);
490 	if (retval)
491 		err("%s - usb_submit_urb failed with result %d",
492 		    __func__, retval);
493 }
494 
495 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
496 {
497 	struct usb_endpoint_descriptor *ep_irq_out;
498 	int error = -ENOMEM;
499 
500 	if (xpad->xtype != XTYPE_XBOX360)
501 		return 0;
502 
503 	xpad->odata = usb_buffer_alloc(xpad->udev, XPAD_PKT_LEN,
504 				       GFP_KERNEL, &xpad->odata_dma);
505 	if (!xpad->odata)
506 		goto fail1;
507 
508 	mutex_init(&xpad->odata_mutex);
509 
510 	xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
511 	if (!xpad->irq_out)
512 		goto fail2;
513 
514 	ep_irq_out = &intf->cur_altsetting->endpoint[1].desc;
515 	usb_fill_int_urb(xpad->irq_out, xpad->udev,
516 			 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
517 			 xpad->odata, XPAD_PKT_LEN,
518 			 xpad_irq_out, xpad, ep_irq_out->bInterval);
519 	xpad->irq_out->transfer_dma = xpad->odata_dma;
520 	xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
521 
522 	return 0;
523 
524  fail2:	usb_buffer_free(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
525  fail1:	return error;
526 }
527 
528 static void xpad_stop_output(struct usb_xpad *xpad)
529 {
530 	if (xpad->xtype == XTYPE_XBOX360)
531 		usb_kill_urb(xpad->irq_out);
532 }
533 
534 static void xpad_deinit_output(struct usb_xpad *xpad)
535 {
536 	if (xpad->xtype == XTYPE_XBOX360) {
537 		usb_free_urb(xpad->irq_out);
538 		usb_buffer_free(xpad->udev, XPAD_PKT_LEN,
539 				xpad->odata, xpad->odata_dma);
540 	}
541 }
542 #else
543 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad) { return 0; }
544 static void xpad_deinit_output(struct usb_xpad *xpad) {}
545 static void xpad_stop_output(struct usb_xpad *xpad) {}
546 #endif
547 
548 #ifdef CONFIG_JOYSTICK_XPAD_FF
549 static int xpad_play_effect(struct input_dev *dev, void *data,
550 			    struct ff_effect *effect)
551 {
552 	struct usb_xpad *xpad = input_get_drvdata(dev);
553 
554 	if (effect->type == FF_RUMBLE) {
555 		__u16 strong = effect->u.rumble.strong_magnitude;
556 		__u16 weak = effect->u.rumble.weak_magnitude;
557 		xpad->odata[0] = 0x00;
558 		xpad->odata[1] = 0x08;
559 		xpad->odata[2] = 0x00;
560 		xpad->odata[3] = strong / 256;
561 		xpad->odata[4] = weak / 256;
562 		xpad->odata[5] = 0x00;
563 		xpad->odata[6] = 0x00;
564 		xpad->odata[7] = 0x00;
565 		xpad->irq_out->transfer_buffer_length = 8;
566 		usb_submit_urb(xpad->irq_out, GFP_KERNEL);
567 	}
568 
569 	return 0;
570 }
571 
572 static int xpad_init_ff(struct usb_xpad *xpad)
573 {
574 	if (xpad->xtype != XTYPE_XBOX360)
575 		return 0;
576 
577 	input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
578 
579 	return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
580 }
581 
582 #else
583 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
584 #endif
585 
586 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
587 #include <linux/leds.h>
588 
589 struct xpad_led {
590 	char name[16];
591 	struct led_classdev led_cdev;
592 	struct usb_xpad *xpad;
593 };
594 
595 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
596 {
597 	if (command >= 0 && command < 14) {
598 		mutex_lock(&xpad->odata_mutex);
599 		xpad->odata[0] = 0x01;
600 		xpad->odata[1] = 0x03;
601 		xpad->odata[2] = command;
602 		xpad->irq_out->transfer_buffer_length = 3;
603 		usb_submit_urb(xpad->irq_out, GFP_KERNEL);
604 		mutex_unlock(&xpad->odata_mutex);
605 	}
606 }
607 
608 static void xpad_led_set(struct led_classdev *led_cdev,
609 			 enum led_brightness value)
610 {
611 	struct xpad_led *xpad_led = container_of(led_cdev,
612 						 struct xpad_led, led_cdev);
613 
614 	xpad_send_led_command(xpad_led->xpad, value);
615 }
616 
617 static int xpad_led_probe(struct usb_xpad *xpad)
618 {
619 	static atomic_t led_seq	= ATOMIC_INIT(0);
620 	long led_no;
621 	struct xpad_led *led;
622 	struct led_classdev *led_cdev;
623 	int error;
624 
625 	if (xpad->xtype != XTYPE_XBOX360)
626 		return 0;
627 
628 	xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
629 	if (!led)
630 		return -ENOMEM;
631 
632 	led_no = (long)atomic_inc_return(&led_seq) - 1;
633 
634 	snprintf(led->name, sizeof(led->name), "xpad%ld", led_no);
635 	led->xpad = xpad;
636 
637 	led_cdev = &led->led_cdev;
638 	led_cdev->name = led->name;
639 	led_cdev->brightness_set = xpad_led_set;
640 
641 	error = led_classdev_register(&xpad->udev->dev, led_cdev);
642 	if (error) {
643 		kfree(led);
644 		xpad->led = NULL;
645 		return error;
646 	}
647 
648 	/*
649 	 * Light up the segment corresponding to controller number
650 	 */
651 	xpad_send_led_command(xpad, (led_no % 4) + 2);
652 
653 	return 0;
654 }
655 
656 static void xpad_led_disconnect(struct usb_xpad *xpad)
657 {
658 	struct xpad_led *xpad_led = xpad->led;
659 
660 	if (xpad_led) {
661 		led_classdev_unregister(&xpad_led->led_cdev);
662 		kfree(xpad_led->name);
663 	}
664 }
665 #else
666 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
667 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
668 #endif
669 
670 
671 static int xpad_open(struct input_dev *dev)
672 {
673 	struct usb_xpad *xpad = input_get_drvdata(dev);
674 
675 	/* URB was submitted in probe */
676 	if(xpad->xtype == XTYPE_XBOX360W)
677 		return 0;
678 
679 	xpad->irq_in->dev = xpad->udev;
680 	if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
681 		return -EIO;
682 
683 	return 0;
684 }
685 
686 static void xpad_close(struct input_dev *dev)
687 {
688 	struct usb_xpad *xpad = input_get_drvdata(dev);
689 
690 	if(xpad->xtype != XTYPE_XBOX360W)
691 		usb_kill_urb(xpad->irq_in);
692 	xpad_stop_output(xpad);
693 }
694 
695 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
696 {
697 	set_bit(abs, input_dev->absbit);
698 
699 	switch (abs) {
700 	case ABS_X:
701 	case ABS_Y:
702 	case ABS_RX:
703 	case ABS_RY:	/* the two sticks */
704 		input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
705 		break;
706 	case ABS_Z:
707 	case ABS_RZ:	/* the triggers */
708 		input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
709 		break;
710 	case ABS_HAT0X:
711 	case ABS_HAT0Y:	/* the d-pad (only if MAP_DPAD_TO_AXES) */
712 		input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
713 		break;
714 	}
715 }
716 
717 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
718 {
719 	struct usb_device *udev = interface_to_usbdev(intf);
720 	struct usb_xpad *xpad;
721 	struct input_dev *input_dev;
722 	struct usb_endpoint_descriptor *ep_irq_in;
723 	int i;
724 	int error = -ENOMEM;
725 
726 	for (i = 0; xpad_device[i].idVendor; i++) {
727 		if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
728 		    (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
729 			break;
730 	}
731 
732 	xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
733 	input_dev = input_allocate_device();
734 	if (!xpad || !input_dev)
735 		goto fail1;
736 
737 	xpad->idata = usb_buffer_alloc(udev, XPAD_PKT_LEN,
738 				       GFP_KERNEL, &xpad->idata_dma);
739 	if (!xpad->idata)
740 		goto fail1;
741 
742 	xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
743 	if (!xpad->irq_in)
744 		goto fail2;
745 
746 	xpad->udev = udev;
747 	xpad->dpad_mapping = xpad_device[i].dpad_mapping;
748 	xpad->xtype = xpad_device[i].xtype;
749 	if (xpad->dpad_mapping == MAP_DPAD_UNKNOWN)
750 		xpad->dpad_mapping = !dpad_to_buttons;
751 	if (xpad->xtype == XTYPE_UNKNOWN) {
752 		if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
753 			if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
754 				xpad->xtype = XTYPE_XBOX360W;
755 			else
756 				xpad->xtype = XTYPE_XBOX360;
757 		} else
758 			xpad->xtype = XTYPE_XBOX;
759 	}
760 	xpad->dev = input_dev;
761 	usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
762 	strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
763 
764 	input_dev->name = xpad_device[i].name;
765 	input_dev->phys = xpad->phys;
766 	usb_to_input_id(udev, &input_dev->id);
767 	input_dev->dev.parent = &intf->dev;
768 
769 	input_set_drvdata(input_dev, xpad);
770 
771 	input_dev->open = xpad_open;
772 	input_dev->close = xpad_close;
773 
774 	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
775 
776 	/* set up buttons */
777 	for (i = 0; xpad_common_btn[i] >= 0; i++)
778 		set_bit(xpad_common_btn[i], input_dev->keybit);
779 	if ((xpad->xtype == XTYPE_XBOX360) || (xpad->xtype == XTYPE_XBOX360W))
780 		for (i = 0; xpad360_btn[i] >= 0; i++)
781 			set_bit(xpad360_btn[i], input_dev->keybit);
782 	else
783 		for (i = 0; xpad_btn[i] >= 0; i++)
784 			set_bit(xpad_btn[i], input_dev->keybit);
785 	if (xpad->dpad_mapping == MAP_DPAD_TO_BUTTONS)
786 		for (i = 0; xpad_btn_pad[i] >= 0; i++)
787 			set_bit(xpad_btn_pad[i], input_dev->keybit);
788 
789 	/* set up axes */
790 	for (i = 0; xpad_abs[i] >= 0; i++)
791 		xpad_set_up_abs(input_dev, xpad_abs[i]);
792 	if (xpad->dpad_mapping == MAP_DPAD_TO_AXES)
793 		for (i = 0; xpad_abs_pad[i] >= 0; i++)
794 		    xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
795 
796 	error = xpad_init_output(intf, xpad);
797 	if (error)
798 		goto fail2;
799 
800 	error = xpad_init_ff(xpad);
801 	if (error)
802 		goto fail3;
803 
804 	error = xpad_led_probe(xpad);
805 	if (error)
806 		goto fail3;
807 
808 	ep_irq_in = &intf->cur_altsetting->endpoint[0].desc;
809 	usb_fill_int_urb(xpad->irq_in, udev,
810 			 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
811 			 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
812 			 xpad, ep_irq_in->bInterval);
813 	xpad->irq_in->transfer_dma = xpad->idata_dma;
814 	xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
815 
816 	error = input_register_device(xpad->dev);
817 	if (error)
818 		goto fail4;
819 
820 	usb_set_intfdata(intf, xpad);
821 
822 	/*
823 	 * Submit the int URB immediatly rather than waiting for open
824 	 * because we get status messages from the device whether
825 	 * or not any controllers are attached.  In fact, it's
826 	 * exactly the message that a controller has arrived that
827 	 * we're waiting for.
828 	 */
829 	if (xpad->xtype == XTYPE_XBOX360W) {
830 		xpad->irq_in->dev = xpad->udev;
831 		error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
832 		if (error)
833 			goto fail4;
834 
835 		/*
836 		 * Setup the message to set the LEDs on the
837 		 * controller when it shows up
838 		 */
839 		xpad->bulk_out = usb_alloc_urb(0, GFP_KERNEL);
840 		if(!xpad->bulk_out)
841 			goto fail5;
842 
843 		xpad->bdata = kzalloc(XPAD_PKT_LEN, GFP_KERNEL);
844 		if(!xpad->bdata)
845 			goto fail6;
846 
847 		xpad->bdata[2] = 0x08;
848 		switch (intf->cur_altsetting->desc.bInterfaceNumber) {
849 		case 0:
850 			xpad->bdata[3] = 0x42;
851 			break;
852 		case 2:
853 			xpad->bdata[3] = 0x43;
854 			break;
855 		case 4:
856 			xpad->bdata[3] = 0x44;
857 			break;
858 		case 6:
859 			xpad->bdata[3] = 0x45;
860 		}
861 
862 		ep_irq_in = &intf->cur_altsetting->endpoint[1].desc;
863 		usb_fill_bulk_urb(xpad->bulk_out, udev,
864 				usb_sndbulkpipe(udev, ep_irq_in->bEndpointAddress),
865 				xpad->bdata, XPAD_PKT_LEN, xpad_bulk_out, xpad);
866 	}
867 
868 	return 0;
869 
870  fail6:	usb_free_urb(xpad->bulk_out);
871  fail5:	usb_kill_urb(xpad->irq_in);
872  fail4:	usb_free_urb(xpad->irq_in);
873  fail3:	xpad_deinit_output(xpad);
874  fail2:	usb_buffer_free(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
875  fail1:	input_free_device(input_dev);
876 	kfree(xpad);
877 	return error;
878 
879 }
880 
881 static void xpad_disconnect(struct usb_interface *intf)
882 {
883 	struct usb_xpad *xpad = usb_get_intfdata (intf);
884 
885 	usb_set_intfdata(intf, NULL);
886 	if (xpad) {
887 		xpad_led_disconnect(xpad);
888 		input_unregister_device(xpad->dev);
889 		xpad_deinit_output(xpad);
890 		if (xpad->xtype == XTYPE_XBOX360W) {
891 			usb_kill_urb(xpad->bulk_out);
892 			usb_free_urb(xpad->bulk_out);
893 			usb_kill_urb(xpad->irq_in);
894 		}
895 		usb_free_urb(xpad->irq_in);
896 		usb_buffer_free(xpad->udev, XPAD_PKT_LEN,
897 				xpad->idata, xpad->idata_dma);
898 		kfree(xpad);
899 	}
900 }
901 
902 static struct usb_driver xpad_driver = {
903 	.name		= "xpad",
904 	.probe		= xpad_probe,
905 	.disconnect	= xpad_disconnect,
906 	.id_table	= xpad_table,
907 };
908 
909 static int __init usb_xpad_init(void)
910 {
911 	int result = usb_register(&xpad_driver);
912 	if (result == 0)
913 		info(DRIVER_DESC);
914 	return result;
915 }
916 
917 static void __exit usb_xpad_exit(void)
918 {
919 	usb_deregister(&xpad_driver);
920 }
921 
922 module_init(usb_xpad_init);
923 module_exit(usb_xpad_exit);
924 
925 MODULE_AUTHOR(DRIVER_AUTHOR);
926 MODULE_DESCRIPTION(DRIVER_DESC);
927 MODULE_LICENSE("GPL");
928