Linux Audio

Check our new training course

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