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