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