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>
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.
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.
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
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
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
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
49 * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
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
55 * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
57 * - usb + input init sequence fixes
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
64 * 2002-07-17 - 0.0.5 : simplified d-pad handling
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
73 * Later changes can be tracked in SCM.
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>
82 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
83 #define DRIVER_DESC "X-Box pad driver"
85 #define XPAD_PKT_LEN 32
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)
96 #define XTYPE_XBOX360 1
97 #define XTYPE_XBOX360W 2
98 #define XTYPE_XBOXONE 3
99 #define XTYPE_UNKNOWN 4
101 static bool dpad_to_buttons;
102 module_param(dpad_to_buttons, bool, S_IRUGO);
103 MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
105 static bool triggers_to_buttons;
106 module_param(triggers_to_buttons, bool, S_IRUGO);
107 MODULE_PARM_DESC(triggers_to_buttons, "Map triggers to buttons rather than axes for unknown pads");
109 static bool sticks_to_null;
110 module_param(sticks_to_null, bool, S_IRUGO);
111 MODULE_PARM_DESC(sticks_to_null, "Do not map sticks at all for unknown pads");
113 static const struct xpad_device {
120 { 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", 0, XTYPE_XBOX },
121 { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", 0, XTYPE_XBOX },
122 { 0x045e, 0x0287, "Microsoft Xbox Controller S", 0, XTYPE_XBOX },
123 { 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", 0, XTYPE_XBOX },
124 { 0x045e, 0x028e, "Microsoft X-Box 360 pad", 0, XTYPE_XBOX360 },
125 { 0x045e, 0x02d1, "Microsoft X-Box One pad", 0, XTYPE_XBOXONE },
126 { 0x045e, 0x0291, "Xbox 360 Wireless Receiver (XBOX)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
127 { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
128 { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
129 { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
130 { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },
131 { 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
132 { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
133 { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
134 { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
135 { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
136 { 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
137 { 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
138 { 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
139 { 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
140 { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
141 { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
142 { 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
143 { 0x0738, 0x4728, "Mad Catz Street Fighter IV FightPad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
144 { 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
145 { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
146 { 0x0738, 0xbeef, "Mad Catz JOYTECH NEO SE Advanced GamePad", XTYPE_XBOX360 },
147 { 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
148 { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
149 { 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
150 { 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
151 { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
152 { 0x0d2f, 0x0002, "Andamiro Pump It Up pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
153 { 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
154 { 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
155 { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
156 { 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
157 { 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
158 { 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
159 { 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
160 { 0x0e6f, 0x0213, "Afterglow Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
161 { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
162 { 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
163 { 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
164 { 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
165 { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
166 { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
167 { 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
168 { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
169 { 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
170 { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
171 { 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
172 { 0x1689, 0xfd00, "Razer Onza Tournament Edition", 0, XTYPE_XBOX360 },
173 { 0x1689, 0xfd01, "Razer Onza Classic Edition", 0, XTYPE_XBOX360 },
174 { 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
175 { 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
176 { 0x1bad, 0xf016, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
177 { 0x1bad, 0xf028, "Street Fighter IV FightPad", 0, XTYPE_XBOX360 },
178 { 0x1bad, 0xf901, "Gamestop Xbox 360 Controller", 0, XTYPE_XBOX360 },
179 { 0x1bad, 0xf903, "Tron Xbox 360 controller", 0, XTYPE_XBOX360 },
180 { 0x24c6, 0x5300, "PowerA MINI PROEX Controller", 0, XTYPE_XBOX360 },
181 { 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
182 { 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
185 /* buttons shared with xbox and xbox360 */
186 static const signed short xpad_common_btn[] = {
187 BTN_A, BTN_B, BTN_X, BTN_Y, /* "analog" buttons */
188 BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR, /* start/back/sticks */
189 -1 /* terminating entry */
192 /* original xbox controllers only */
193 static const signed short xpad_btn[] = {
194 BTN_C, BTN_Z, /* "analog" buttons */
195 -1 /* terminating entry */
198 /* used when dpad is mapped to buttons */
199 static const signed short xpad_btn_pad[] = {
200 BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2, /* d-pad left, right */
201 BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4, /* d-pad up, down */
202 -1 /* terminating entry */
205 /* used when triggers are mapped to buttons */
206 static const signed short xpad_btn_triggers[] = {
207 BTN_TL2, BTN_TR2, /* triggers left/right */
212 static const signed short xpad360_btn[] = { /* buttons for x360 controller */
213 BTN_TL, BTN_TR, /* Button LB/RB */
214 BTN_MODE, /* The big X button */
218 static const signed short xpad_abs[] = {
219 ABS_X, ABS_Y, /* left stick */
220 ABS_RX, ABS_RY, /* right stick */
221 -1 /* terminating entry */
224 /* used when dpad is mapped to axes */
225 static const signed short xpad_abs_pad[] = {
226 ABS_HAT0X, ABS_HAT0Y, /* d-pad axes */
227 -1 /* terminating entry */
230 /* used when triggers are mapped to axes */
231 static const signed short xpad_abs_triggers[] = {
232 ABS_Z, ABS_RZ, /* triggers left/right */
237 * Xbox 360 has a vendor-specific class, so we cannot match it with only
238 * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
239 * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
240 * wireless controllers have protocol 129.
242 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
243 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
244 .idVendor = (vend), \
245 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
246 .bInterfaceSubClass = 93, \
247 .bInterfaceProtocol = (pr)
248 #define XPAD_XBOX360_VENDOR(vend) \
249 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
250 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
252 /* The Xbox One controller uses subclass 71 and protocol 208. */
253 #define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
254 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
255 .idVendor = (vend), \
256 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
257 .bInterfaceSubClass = 71, \
258 .bInterfaceProtocol = (pr)
259 #define XPAD_XBOXONE_VENDOR(vend) \
260 { XPAD_XBOXONE_VENDOR_PROTOCOL(vend, 208) }
262 static struct usb_device_id xpad_table[] = {
263 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
264 XPAD_XBOX360_VENDOR(0x045e), /* Microsoft X-Box 360 controllers */
265 XPAD_XBOXONE_VENDOR(0x045e), /* Microsoft X-Box One controllers */
266 XPAD_XBOX360_VENDOR(0x046d), /* Logitech X-Box 360 style controllers */
267 XPAD_XBOX360_VENDOR(0x0738), /* Mad Catz X-Box 360 controllers */
268 { USB_DEVICE(0x0738, 0x4540) }, /* Mad Catz Beat Pad */
269 XPAD_XBOX360_VENDOR(0x0e6f), /* 0x0e6f X-Box 360 controllers */
270 XPAD_XBOX360_VENDOR(0x12ab), /* X-Box 360 dance pads */
271 XPAD_XBOX360_VENDOR(0x1430), /* RedOctane X-Box 360 controllers */
272 XPAD_XBOX360_VENDOR(0x146b), /* BigBen Interactive Controllers */
273 XPAD_XBOX360_VENDOR(0x1bad), /* Harminix Rock Band Guitar and Drums */
274 XPAD_XBOX360_VENDOR(0x0f0d), /* Hori Controllers */
275 XPAD_XBOX360_VENDOR(0x1689), /* Razer Onza */
276 XPAD_XBOX360_VENDOR(0x24c6), /* PowerA Controllers */
280 MODULE_DEVICE_TABLE(usb, xpad_table);
283 struct input_dev *dev; /* input device interface */
284 struct usb_device *udev; /* usb device */
285 struct usb_interface *intf; /* usb interface */
289 struct urb *irq_in; /* urb for interrupt in report */
290 unsigned char *idata; /* input data */
291 dma_addr_t idata_dma;
293 struct urb *bulk_out;
294 unsigned char *bdata;
296 struct urb *irq_out; /* urb for interrupt out report */
297 unsigned char *odata; /* output data */
298 dma_addr_t odata_dma;
299 struct mutex odata_mutex;
301 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
302 struct xpad_led *led;
305 char phys[64]; /* physical device path */
307 int mapping; /* map d-pad to buttons or to axes */
308 int xtype; /* type of xbox device */
312 * xpad_process_packet
314 * Completes a request by converting the data into events for the
317 * The used report descriptor was taken from ITO Takayukis website:
318 * http://euc.jp/periphs/xbox-controller.ja.html
321 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
323 struct input_dev *dev = xpad->dev;
325 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
327 input_report_abs(dev, ABS_X,
328 (__s16) le16_to_cpup((__le16 *)(data + 12)));
329 input_report_abs(dev, ABS_Y,
330 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
333 input_report_abs(dev, ABS_RX,
334 (__s16) le16_to_cpup((__le16 *)(data + 16)));
335 input_report_abs(dev, ABS_RY,
336 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
339 /* triggers left/right */
340 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
341 input_report_key(dev, BTN_TL2, data[10]);
342 input_report_key(dev, BTN_TR2, data[11]);
344 input_report_abs(dev, ABS_Z, data[10]);
345 input_report_abs(dev, ABS_RZ, data[11]);
349 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
350 /* dpad as buttons (left, right, up, down) */
351 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
352 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
353 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
354 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
356 input_report_abs(dev, ABS_HAT0X,
357 !!(data[2] & 0x08) - !!(data[2] & 0x04));
358 input_report_abs(dev, ABS_HAT0Y,
359 !!(data[2] & 0x02) - !!(data[2] & 0x01));
362 /* start/back buttons and stick press left/right */
363 input_report_key(dev, BTN_START, data[2] & 0x10);
364 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
365 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
366 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
368 /* "analog" buttons A, B, X, Y */
369 input_report_key(dev, BTN_A, data[4]);
370 input_report_key(dev, BTN_B, data[5]);
371 input_report_key(dev, BTN_X, data[6]);
372 input_report_key(dev, BTN_Y, data[7]);
374 /* "analog" buttons black, white */
375 input_report_key(dev, BTN_C, data[8]);
376 input_report_key(dev, BTN_Z, data[9]);
382 * xpad360_process_packet
384 * Completes a request by converting the data into events for the
385 * input subsystem. It is version for xbox 360 controller
387 * The used report descriptor was taken from:
388 * http://www.free60.org/wiki/Gamepad
391 static void xpad360_process_packet(struct usb_xpad *xpad,
392 u16 cmd, unsigned char *data)
394 struct input_dev *dev = xpad->dev;
397 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
398 /* dpad as buttons (left, right, up, down) */
399 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
400 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
401 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
402 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
404 input_report_abs(dev, ABS_HAT0X,
405 !!(data[2] & 0x08) - !!(data[2] & 0x04));
406 input_report_abs(dev, ABS_HAT0Y,
407 !!(data[2] & 0x02) - !!(data[2] & 0x01));
410 /* start/back buttons */
411 input_report_key(dev, BTN_START, data[2] & 0x10);
412 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
414 /* stick press left/right */
415 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
416 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
418 /* buttons A,B,X,Y,TL,TR and MODE */
419 input_report_key(dev, BTN_A, data[3] & 0x10);
420 input_report_key(dev, BTN_B, data[3] & 0x20);
421 input_report_key(dev, BTN_X, data[3] & 0x40);
422 input_report_key(dev, BTN_Y, data[3] & 0x80);
423 input_report_key(dev, BTN_TL, data[3] & 0x01);
424 input_report_key(dev, BTN_TR, data[3] & 0x02);
425 input_report_key(dev, BTN_MODE, data[3] & 0x04);
427 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
429 input_report_abs(dev, ABS_X,
430 (__s16) le16_to_cpup((__le16 *)(data + 6)));
431 input_report_abs(dev, ABS_Y,
432 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
435 input_report_abs(dev, ABS_RX,
436 (__s16) le16_to_cpup((__le16 *)(data + 10)));
437 input_report_abs(dev, ABS_RY,
438 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
441 /* triggers left/right */
442 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
443 input_report_key(dev, BTN_TL2, data[4]);
444 input_report_key(dev, BTN_TR2, data[5]);
446 input_report_abs(dev, ABS_Z, data[4]);
447 input_report_abs(dev, ABS_RZ, data[5]);
454 * xpad360w_process_packet
456 * Completes a request by converting the data into events for the
457 * input subsystem. It is version for xbox 360 wireless controller.
460 * 00.1 - Status change: The controller or headset has connected/disconnected
461 * Bits 01.7 and 01.6 are valid
462 * 01.7 - Controller present
463 * 01.6 - Headset present
464 * 01.1 - Pad state (Bytes 4+) valid
468 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
470 /* Presence change */
471 if (data[0] & 0x08) {
472 if (data[1] & 0x80) {
473 xpad->pad_present = 1;
474 usb_submit_urb(xpad->bulk_out, GFP_ATOMIC);
476 xpad->pad_present = 0;
480 if (!(data[1] & 0x1))
483 xpad360_process_packet(xpad, cmd, &data[4]);
487 * xpadone_process_buttons
489 * Process a button update packet from an Xbox one controller.
491 static void xpadone_process_buttons(struct usb_xpad *xpad,
492 struct input_dev *dev,
495 /* menu/view buttons */
496 input_report_key(dev, BTN_START, data[4] & 0x04);
497 input_report_key(dev, BTN_SELECT, data[4] & 0x08);
499 /* buttons A,B,X,Y */
500 input_report_key(dev, BTN_A, data[4] & 0x10);
501 input_report_key(dev, BTN_B, data[4] & 0x20);
502 input_report_key(dev, BTN_X, data[4] & 0x40);
503 input_report_key(dev, BTN_Y, data[4] & 0x80);
506 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
507 /* dpad as buttons (left, right, up, down) */
508 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[5] & 0x04);
509 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[5] & 0x08);
510 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[5] & 0x01);
511 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[5] & 0x02);
513 input_report_abs(dev, ABS_HAT0X,
514 !!(data[5] & 0x08) - !!(data[5] & 0x04));
515 input_report_abs(dev, ABS_HAT0Y,
516 !!(data[5] & 0x02) - !!(data[5] & 0x01));
520 input_report_key(dev, BTN_TL, data[5] & 0x10);
521 input_report_key(dev, BTN_TR, data[5] & 0x20);
523 /* stick press left/right */
524 input_report_key(dev, BTN_THUMBL, data[5] & 0x40);
525 input_report_key(dev, BTN_THUMBR, data[5] & 0x80);
527 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
529 input_report_abs(dev, ABS_X,
530 (__s16) le16_to_cpup((__le16 *)(data + 10)));
531 input_report_abs(dev, ABS_Y,
532 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
535 input_report_abs(dev, ABS_RX,
536 (__s16) le16_to_cpup((__le16 *)(data + 14)));
537 input_report_abs(dev, ABS_RY,
538 ~(__s16) le16_to_cpup((__le16 *)(data + 16)));
541 /* triggers left/right */
542 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
543 input_report_key(dev, BTN_TL2,
544 (__u16) le16_to_cpup((__le16 *)(data + 6)));
545 input_report_key(dev, BTN_TR2,
546 (__u16) le16_to_cpup((__le16 *)(data + 8)));
548 input_report_abs(dev, ABS_Z,
549 (__u16) le16_to_cpup((__le16 *)(data + 6)));
550 input_report_abs(dev, ABS_RZ,
551 (__u16) le16_to_cpup((__le16 *)(data + 8)));
558 * xpadone_process_packet
560 * Completes a request by converting the data into events for the
561 * input subsystem. This version is for the Xbox One controller.
563 * The report format was gleaned from
564 * https://github.com/kylelemons/xbox/blob/master/xbox.go
567 static void xpadone_process_packet(struct usb_xpad *xpad,
568 u16 cmd, unsigned char *data)
570 struct input_dev *dev = xpad->dev;
574 xpadone_process_buttons(xpad, dev, data);
578 /* the xbox button has its own special report */
579 input_report_key(dev, BTN_MODE, data[4] & 0x01);
585 static void xpad_irq_in(struct urb *urb)
587 struct usb_xpad *xpad = urb->context;
588 struct device *dev = &xpad->intf->dev;
591 status = urb->status;
600 /* this urb is terminated, clean up */
601 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
605 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
610 switch (xpad->xtype) {
612 xpad360_process_packet(xpad, 0, xpad->idata);
615 xpad360w_process_packet(xpad, 0, xpad->idata);
618 xpadone_process_packet(xpad, 0, xpad->idata);
621 xpad_process_packet(xpad, 0, xpad->idata);
625 retval = usb_submit_urb(urb, GFP_ATOMIC);
627 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
631 static void xpad_bulk_out(struct urb *urb)
633 struct usb_xpad *xpad = urb->context;
634 struct device *dev = &xpad->intf->dev;
636 switch (urb->status) {
643 /* this urb is terminated, clean up */
644 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
645 __func__, urb->status);
648 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
649 __func__, urb->status);
653 static void xpad_irq_out(struct urb *urb)
655 struct usb_xpad *xpad = urb->context;
656 struct device *dev = &xpad->intf->dev;
659 status = urb->status;
669 /* this urb is terminated, clean up */
670 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
675 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
681 retval = usb_submit_urb(urb, GFP_ATOMIC);
683 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
687 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
689 struct usb_endpoint_descriptor *ep_irq_out;
693 if (xpad->xtype == XTYPE_UNKNOWN)
696 xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
697 GFP_KERNEL, &xpad->odata_dma);
703 mutex_init(&xpad->odata_mutex);
705 xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
706 if (!xpad->irq_out) {
711 /* Xbox One controller has in/out endpoints swapped. */
712 ep_irq_out_idx = xpad->xtype == XTYPE_XBOXONE ? 0 : 1;
713 ep_irq_out = &intf->cur_altsetting->endpoint[ep_irq_out_idx].desc;
715 usb_fill_int_urb(xpad->irq_out, xpad->udev,
716 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
717 xpad->odata, XPAD_PKT_LEN,
718 xpad_irq_out, xpad, ep_irq_out->bInterval);
719 xpad->irq_out->transfer_dma = xpad->odata_dma;
720 xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
724 fail2: usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
728 static void xpad_stop_output(struct usb_xpad *xpad)
730 if (xpad->xtype != XTYPE_UNKNOWN)
731 usb_kill_urb(xpad->irq_out);
734 static void xpad_deinit_output(struct usb_xpad *xpad)
736 if (xpad->xtype != XTYPE_UNKNOWN) {
737 usb_free_urb(xpad->irq_out);
738 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
739 xpad->odata, xpad->odata_dma);
743 #ifdef CONFIG_JOYSTICK_XPAD_FF
744 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
746 struct usb_xpad *xpad = input_get_drvdata(dev);
748 if (effect->type == FF_RUMBLE) {
749 __u16 strong = effect->u.rumble.strong_magnitude;
750 __u16 weak = effect->u.rumble.weak_magnitude;
752 switch (xpad->xtype) {
755 xpad->odata[0] = 0x00;
756 xpad->odata[1] = 0x06;
757 xpad->odata[2] = 0x00;
758 xpad->odata[3] = strong / 256; /* left actuator */
759 xpad->odata[4] = 0x00;
760 xpad->odata[5] = weak / 256; /* right actuator */
761 xpad->irq_out->transfer_buffer_length = 6;
763 return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
766 xpad->odata[0] = 0x00;
767 xpad->odata[1] = 0x08;
768 xpad->odata[2] = 0x00;
769 xpad->odata[3] = strong / 256; /* left actuator? */
770 xpad->odata[4] = weak / 256; /* right actuator? */
771 xpad->odata[5] = 0x00;
772 xpad->odata[6] = 0x00;
773 xpad->odata[7] = 0x00;
774 xpad->irq_out->transfer_buffer_length = 8;
776 return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
779 xpad->odata[0] = 0x00;
780 xpad->odata[1] = 0x01;
781 xpad->odata[2] = 0x0F;
782 xpad->odata[3] = 0xC0;
783 xpad->odata[4] = 0x00;
784 xpad->odata[5] = strong / 256;
785 xpad->odata[6] = weak / 256;
786 xpad->odata[7] = 0x00;
787 xpad->odata[8] = 0x00;
788 xpad->odata[9] = 0x00;
789 xpad->odata[10] = 0x00;
790 xpad->odata[11] = 0x00;
791 xpad->irq_out->transfer_buffer_length = 12;
793 return usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
796 dev_dbg(&xpad->dev->dev,
797 "%s - rumble command sent to unsupported xpad type: %d\n",
798 __func__, xpad->xtype);
806 static int xpad_init_ff(struct usb_xpad *xpad)
808 if (xpad->xtype == XTYPE_UNKNOWN || xpad->xtype == XTYPE_XBOXONE)
811 input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
813 return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
817 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
820 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
821 #include <linux/leds.h>
825 struct led_classdev led_cdev;
826 struct usb_xpad *xpad;
829 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
831 if (command >= 0 && command < 14) {
832 mutex_lock(&xpad->odata_mutex);
833 xpad->odata[0] = 0x01;
834 xpad->odata[1] = 0x03;
835 xpad->odata[2] = command;
836 xpad->irq_out->transfer_buffer_length = 3;
837 usb_submit_urb(xpad->irq_out, GFP_KERNEL);
838 mutex_unlock(&xpad->odata_mutex);
842 static void xpad_led_set(struct led_classdev *led_cdev,
843 enum led_brightness value)
845 struct xpad_led *xpad_led = container_of(led_cdev,
846 struct xpad_led, led_cdev);
848 xpad_send_led_command(xpad_led->xpad, value);
851 static int xpad_led_probe(struct usb_xpad *xpad)
853 static atomic_t led_seq = ATOMIC_INIT(0);
855 struct xpad_led *led;
856 struct led_classdev *led_cdev;
859 if (xpad->xtype != XTYPE_XBOX360)
862 xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
866 led_no = (long)atomic_inc_return(&led_seq) - 1;
868 snprintf(led->name, sizeof(led->name), "xpad%ld", led_no);
871 led_cdev = &led->led_cdev;
872 led_cdev->name = led->name;
873 led_cdev->brightness_set = xpad_led_set;
875 error = led_classdev_register(&xpad->udev->dev, led_cdev);
883 * Light up the segment corresponding to controller number
885 xpad_send_led_command(xpad, (led_no % 4) + 2);
890 static void xpad_led_disconnect(struct usb_xpad *xpad)
892 struct xpad_led *xpad_led = xpad->led;
895 led_classdev_unregister(&xpad_led->led_cdev);
900 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
901 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
905 static int xpad_open(struct input_dev *dev)
907 struct usb_xpad *xpad = input_get_drvdata(dev);
909 /* URB was submitted in probe */
910 if (xpad->xtype == XTYPE_XBOX360W)
913 xpad->irq_in->dev = xpad->udev;
914 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
917 if (xpad->xtype == XTYPE_XBOXONE) {
918 /* Xbox one controller needs to be initialized. */
919 xpad->odata[0] = 0x05;
920 xpad->odata[1] = 0x20;
921 xpad->irq_out->transfer_buffer_length = 2;
922 return usb_submit_urb(xpad->irq_out, GFP_KERNEL);
928 static void xpad_close(struct input_dev *dev)
930 struct usb_xpad *xpad = input_get_drvdata(dev);
932 if (xpad->xtype != XTYPE_XBOX360W)
933 usb_kill_urb(xpad->irq_in);
935 xpad_stop_output(xpad);
938 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
940 struct usb_xpad *xpad = input_get_drvdata(input_dev);
941 set_bit(abs, input_dev->absbit);
947 case ABS_RY: /* the two sticks */
948 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
951 case ABS_RZ: /* the triggers (if mapped to axes) */
952 if (xpad->xtype == XTYPE_XBOXONE)
953 input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
955 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
958 case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
959 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
964 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
966 struct usb_device *udev = interface_to_usbdev(intf);
967 struct usb_xpad *xpad;
968 struct input_dev *input_dev;
969 struct usb_endpoint_descriptor *ep_irq_in;
973 for (i = 0; xpad_device[i].idVendor; i++) {
974 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
975 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
979 if (xpad_device[i].xtype == XTYPE_XBOXONE &&
980 intf->cur_altsetting->desc.bInterfaceNumber != 0) {
982 * The Xbox One controller lists three interfaces all with the
983 * same interface class, subclass and protocol. Differentiate by
989 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
990 input_dev = input_allocate_device();
991 if (!xpad || !input_dev) {
996 xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
997 GFP_KERNEL, &xpad->idata_dma);
1003 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
1004 if (!xpad->irq_in) {
1011 xpad->mapping = xpad_device[i].mapping;
1012 xpad->xtype = xpad_device[i].xtype;
1014 if (xpad->xtype == XTYPE_UNKNOWN) {
1015 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
1016 if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
1017 xpad->xtype = XTYPE_XBOX360W;
1019 xpad->xtype = XTYPE_XBOX360;
1021 xpad->xtype = XTYPE_XBOX;
1023 if (dpad_to_buttons)
1024 xpad->mapping |= MAP_DPAD_TO_BUTTONS;
1025 if (triggers_to_buttons)
1026 xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
1028 xpad->mapping |= MAP_STICKS_TO_NULL;
1031 xpad->dev = input_dev;
1032 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
1033 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
1035 input_dev->name = xpad_device[i].name;
1036 input_dev->phys = xpad->phys;
1037 usb_to_input_id(udev, &input_dev->id);
1038 input_dev->dev.parent = &intf->dev;
1040 input_set_drvdata(input_dev, xpad);
1042 input_dev->open = xpad_open;
1043 input_dev->close = xpad_close;
1045 input_dev->evbit[0] = BIT_MASK(EV_KEY);
1047 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1048 input_dev->evbit[0] |= BIT_MASK(EV_ABS);
1050 for (i = 0; xpad_abs[i] >= 0; i++)
1051 xpad_set_up_abs(input_dev, xpad_abs[i]);
1054 /* set up standard buttons */
1055 for (i = 0; xpad_common_btn[i] >= 0; i++)
1056 __set_bit(xpad_common_btn[i], input_dev->keybit);
1058 /* set up model-specific ones */
1059 if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1060 xpad->xtype == XTYPE_XBOXONE) {
1061 for (i = 0; xpad360_btn[i] >= 0; i++)
1062 __set_bit(xpad360_btn[i], input_dev->keybit);
1064 for (i = 0; xpad_btn[i] >= 0; i++)
1065 __set_bit(xpad_btn[i], input_dev->keybit);
1068 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1069 for (i = 0; xpad_btn_pad[i] >= 0; i++)
1070 __set_bit(xpad_btn_pad[i], input_dev->keybit);
1072 for (i = 0; xpad_abs_pad[i] >= 0; i++)
1073 xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
1076 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1077 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
1078 __set_bit(xpad_btn_triggers[i], input_dev->keybit);
1080 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
1081 xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
1084 error = xpad_init_output(intf, xpad);
1088 error = xpad_init_ff(xpad);
1092 error = xpad_led_probe(xpad);
1096 /* Xbox One controller has in/out endpoints swapped. */
1097 ep_irq_in_idx = xpad->xtype == XTYPE_XBOXONE ? 1 : 0;
1098 ep_irq_in = &intf->cur_altsetting->endpoint[ep_irq_in_idx].desc;
1100 usb_fill_int_urb(xpad->irq_in, udev,
1101 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
1102 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
1103 xpad, ep_irq_in->bInterval);
1104 xpad->irq_in->transfer_dma = xpad->idata_dma;
1105 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1107 error = input_register_device(xpad->dev);
1111 usb_set_intfdata(intf, xpad);
1113 if (xpad->xtype == XTYPE_XBOX360W) {
1115 * Setup the message to set the LEDs on the
1116 * controller when it shows up
1118 xpad->bulk_out = usb_alloc_urb(0, GFP_KERNEL);
1119 if (!xpad->bulk_out) {
1124 xpad->bdata = kzalloc(XPAD_PKT_LEN, GFP_KERNEL);
1130 xpad->bdata[2] = 0x08;
1131 switch (intf->cur_altsetting->desc.bInterfaceNumber) {
1133 xpad->bdata[3] = 0x42;
1136 xpad->bdata[3] = 0x43;
1139 xpad->bdata[3] = 0x44;
1142 xpad->bdata[3] = 0x45;
1145 ep_irq_in = &intf->cur_altsetting->endpoint[1].desc;
1146 usb_fill_bulk_urb(xpad->bulk_out, udev,
1147 usb_sndbulkpipe(udev, ep_irq_in->bEndpointAddress),
1148 xpad->bdata, XPAD_PKT_LEN, xpad_bulk_out, xpad);
1151 * Submit the int URB immediately rather than waiting for open
1152 * because we get status messages from the device whether
1153 * or not any controllers are attached. In fact, it's
1154 * exactly the message that a controller has arrived that
1155 * we're waiting for.
1157 xpad->irq_in->dev = xpad->udev;
1158 error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1165 fail9: kfree(xpad->bdata);
1166 fail8: usb_free_urb(xpad->bulk_out);
1167 fail7: input_unregister_device(input_dev);
1169 fail6: xpad_led_disconnect(xpad);
1170 fail5: if (input_dev)
1171 input_ff_destroy(input_dev);
1172 fail4: xpad_deinit_output(xpad);
1173 fail3: usb_free_urb(xpad->irq_in);
1174 fail2: usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1175 fail1: input_free_device(input_dev);
1181 static void xpad_disconnect(struct usb_interface *intf)
1183 struct usb_xpad *xpad = usb_get_intfdata (intf);
1185 xpad_led_disconnect(xpad);
1186 input_unregister_device(xpad->dev);
1187 xpad_deinit_output(xpad);
1189 if (xpad->xtype == XTYPE_XBOX360W) {
1190 usb_kill_urb(xpad->bulk_out);
1191 usb_free_urb(xpad->bulk_out);
1192 usb_kill_urb(xpad->irq_in);
1195 usb_free_urb(xpad->irq_in);
1196 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1197 xpad->idata, xpad->idata_dma);
1202 usb_set_intfdata(intf, NULL);
1205 static struct usb_driver xpad_driver = {
1207 .probe = xpad_probe,
1208 .disconnect = xpad_disconnect,
1209 .id_table = xpad_table,
1212 module_usb_driver(xpad_driver);
1214 MODULE_AUTHOR(DRIVER_AUTHOR);
1215 MODULE_DESCRIPTION(DRIVER_DESC);
1216 MODULE_LICENSE("GPL");