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