Merge branches 'pm-core', 'pm-clk', 'pm-domains' and 'pm-pci'
[deliverable/linux.git] / drivers / input / joystick / xpad.c
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 * - Xbox One information https://github.com/quantus/xbox-one-controller-protocol
35 *
36 * Thanks to:
37 * - ITO Takayuki for providing essential xpad information on his website
38 * - Vojtech Pavlik - iforce driver / input subsystem
39 * - Greg Kroah-Hartman - usb-skeleton driver
40 * - XBOX Linux project - extra USB id's
41 * - Pekka Pöyry (quantus) - Xbox One controller reverse engineering
42 *
43 * TODO:
44 * - fine tune axes (especially trigger axes)
45 * - fix "analog" buttons (reported as digital now)
46 * - get rumble working
47 * - need USB IDs for other dance pads
48 *
49 * History:
50 *
51 * 2002-06-27 - 0.0.1 : first version, just said "XBOX HID controller"
52 *
53 * 2002-07-02 - 0.0.2 : basic working version
54 * - all axes and 9 of the 10 buttons work (german InterAct device)
55 * - the black button does not work
56 *
57 * 2002-07-14 - 0.0.3 : rework by Vojtech Pavlik
58 * - indentation fixes
59 * - usb + input init sequence fixes
60 *
61 * 2002-07-16 - 0.0.4 : minor changes, merge with Vojtech's v0.0.3
62 * - verified the lack of HID and report descriptors
63 * - verified that ALL buttons WORK
64 * - fixed d-pad to axes mapping
65 *
66 * 2002-07-17 - 0.0.5 : simplified d-pad handling
67 *
68 * 2004-10-02 - 0.0.6 : DDR pad support
69 * - borrowed from the XBOX linux kernel
70 * - USB id's for commonly used dance pads are present
71 * - dance pads will map D-PAD to buttons, not axes
72 * - pass the module paramater 'dpad_to_buttons' to force
73 * the D-PAD to map to buttons if your pad is not detected
74 *
75 * Later changes can be tracked in SCM.
76 */
77
78 #include <linux/kernel.h>
79 #include <linux/input.h>
80 #include <linux/rcupdate.h>
81 #include <linux/slab.h>
82 #include <linux/stat.h>
83 #include <linux/module.h>
84 #include <linux/usb/input.h>
85 #include <linux/usb/quirks.h>
86
87 #define DRIVER_AUTHOR "Marko Friedemann <mfr@bmx-chemnitz.de>"
88 #define DRIVER_DESC "X-Box pad driver"
89
90 #define XPAD_PKT_LEN 64
91
92 /* xbox d-pads should map to buttons, as is required for DDR pads
93 but we map them to axes when possible to simplify things */
94 #define MAP_DPAD_TO_BUTTONS (1 << 0)
95 #define MAP_TRIGGERS_TO_BUTTONS (1 << 1)
96 #define MAP_STICKS_TO_NULL (1 << 2)
97 #define DANCEPAD_MAP_CONFIG (MAP_DPAD_TO_BUTTONS | \
98 MAP_TRIGGERS_TO_BUTTONS | MAP_STICKS_TO_NULL)
99
100 #define XTYPE_XBOX 0
101 #define XTYPE_XBOX360 1
102 #define XTYPE_XBOX360W 2
103 #define XTYPE_XBOXONE 3
104 #define XTYPE_UNKNOWN 4
105
106 static bool dpad_to_buttons;
107 module_param(dpad_to_buttons, bool, S_IRUGO);
108 MODULE_PARM_DESC(dpad_to_buttons, "Map D-PAD to buttons rather than axes for unknown pads");
109
110 static bool triggers_to_buttons;
111 module_param(triggers_to_buttons, bool, S_IRUGO);
112 MODULE_PARM_DESC(triggers_to_buttons, "Map triggers to buttons rather than axes for unknown pads");
113
114 static bool sticks_to_null;
115 module_param(sticks_to_null, bool, S_IRUGO);
116 MODULE_PARM_DESC(sticks_to_null, "Do not map sticks at all for unknown pads");
117
118 static const struct xpad_device {
119 u16 idVendor;
120 u16 idProduct;
121 char *name;
122 u8 mapping;
123 u8 xtype;
124 } xpad_device[] = {
125 { 0x045e, 0x0202, "Microsoft X-Box pad v1 (US)", 0, XTYPE_XBOX },
126 { 0x045e, 0x0285, "Microsoft X-Box pad (Japan)", 0, XTYPE_XBOX },
127 { 0x045e, 0x0287, "Microsoft Xbox Controller S", 0, XTYPE_XBOX },
128 { 0x045e, 0x0289, "Microsoft X-Box pad v2 (US)", 0, XTYPE_XBOX },
129 { 0x045e, 0x028e, "Microsoft X-Box 360 pad", 0, XTYPE_XBOX360 },
130 { 0x045e, 0x02d1, "Microsoft X-Box One pad", 0, XTYPE_XBOXONE },
131 { 0x045e, 0x02dd, "Microsoft X-Box One pad (Firmware 2015)", 0, XTYPE_XBOXONE },
132 { 0x045e, 0x02e3, "Microsoft X-Box One Elite pad", 0, XTYPE_XBOXONE },
133 { 0x045e, 0x0291, "Xbox 360 Wireless Receiver (XBOX)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
134 { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
135 { 0x044f, 0x0f07, "Thrustmaster, Inc. Controller", 0, XTYPE_XBOX },
136 { 0x044f, 0xb326, "Thrustmaster Gamepad GP XID", 0, XTYPE_XBOX360 },
137 { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
138 { 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
139 { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },
140 { 0x046d, 0xc242, "Logitech Chillstream Controller", 0, XTYPE_XBOX360 },
141 { 0x046d, 0xca84, "Logitech Xbox Cordless Controller", 0, XTYPE_XBOX },
142 { 0x046d, 0xca88, "Logitech Compact Controller for Xbox", 0, XTYPE_XBOX },
143 { 0x05fd, 0x1007, "Mad Catz Controller (unverified)", 0, XTYPE_XBOX },
144 { 0x05fd, 0x107a, "InterAct 'PowerPad Pro' X-Box pad (Germany)", 0, XTYPE_XBOX },
145 { 0x0738, 0x4516, "Mad Catz Control Pad", 0, XTYPE_XBOX },
146 { 0x0738, 0x4522, "Mad Catz LumiCON", 0, XTYPE_XBOX },
147 { 0x0738, 0x4526, "Mad Catz Control Pad Pro", 0, XTYPE_XBOX },
148 { 0x0738, 0x4536, "Mad Catz MicroCON", 0, XTYPE_XBOX },
149 { 0x0738, 0x4540, "Mad Catz Beat Pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
150 { 0x0738, 0x4556, "Mad Catz Lynx Wireless Controller", 0, XTYPE_XBOX },
151 { 0x0738, 0x4716, "Mad Catz Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
152 { 0x0738, 0x4718, "Mad Catz Street Fighter IV FightStick SE", 0, XTYPE_XBOX360 },
153 { 0x0738, 0x4726, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
154 { 0x0738, 0x4728, "Mad Catz Street Fighter IV FightPad", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
155 { 0x0738, 0x4738, "Mad Catz Wired Xbox 360 Controller (SFIV)", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
156 { 0x0738, 0x4740, "Mad Catz Beat Pad", 0, XTYPE_XBOX360 },
157 { 0x0738, 0x4a01, "Mad Catz FightStick TE 2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOXONE },
158 { 0x0738, 0x6040, "Mad Catz Beat Pad Pro", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
159 { 0x0738, 0xb726, "Mad Catz Xbox controller - MW2", 0, XTYPE_XBOX360 },
160 { 0x0738, 0xbeef, "Mad Catz JOYTECH NEO SE Advanced GamePad", XTYPE_XBOX360 },
161 { 0x0738, 0xcb02, "Saitek Cyborg Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
162 { 0x0738, 0xcb03, "Saitek P3200 Rumble Pad - PC/Xbox 360", 0, XTYPE_XBOX360 },
163 { 0x0738, 0xf738, "Super SFIV FightStick TE S", 0, XTYPE_XBOX360 },
164 { 0x0c12, 0x8802, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
165 { 0x0c12, 0x8809, "RedOctane Xbox Dance Pad", DANCEPAD_MAP_CONFIG, XTYPE_XBOX },
166 { 0x0c12, 0x880a, "Pelican Eclipse PL-2023", 0, XTYPE_XBOX },
167 { 0x0c12, 0x8810, "Zeroplus Xbox Controller", 0, XTYPE_XBOX },
168 { 0x0c12, 0x9902, "HAMA VibraX - *FAULTY HARDWARE*", 0, XTYPE_XBOX },
169 { 0x0d2f, 0x0002, "Andamiro Pump It Up pad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
170 { 0x0e4c, 0x1097, "Radica Gamester Controller", 0, XTYPE_XBOX },
171 { 0x0e4c, 0x2390, "Radica Games Jtech Controller", 0, XTYPE_XBOX },
172 { 0x0e6f, 0x0003, "Logic3 Freebird wireless Controller", 0, XTYPE_XBOX },
173 { 0x0e6f, 0x0005, "Eclipse wireless Controller", 0, XTYPE_XBOX },
174 { 0x0e6f, 0x0006, "Edge wireless Controller", 0, XTYPE_XBOX },
175 { 0x0e6f, 0x0105, "HSM3 Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
176 { 0x0e6f, 0x0113, "Afterglow AX.1 Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
177 { 0x0e6f, 0x0139, "Afterglow Prismatic Wired Controller", 0, XTYPE_XBOXONE },
178 { 0x0e6f, 0x0201, "Pelican PL-3601 'TSZ' Wired Xbox 360 Controller", 0, XTYPE_XBOX360 },
179 { 0x0e6f, 0x0213, "Afterglow Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
180 { 0x0e6f, 0x021f, "Rock Candy Gamepad for Xbox 360", 0, XTYPE_XBOX360 },
181 { 0x0e6f, 0x0146, "Rock Candy Wired Controller for Xbox One", 0, XTYPE_XBOXONE },
182 { 0x0e6f, 0x0301, "Logic3 Controller", 0, XTYPE_XBOX360 },
183 { 0x0e6f, 0x0401, "Logic3 Controller", 0, XTYPE_XBOX360 },
184 { 0x0e8f, 0x0201, "SmartJoy Frag Xpad/PS2 adaptor", 0, XTYPE_XBOX },
185 { 0x0e8f, 0x3008, "Generic xbox control (dealextreme)", 0, XTYPE_XBOX },
186 { 0x0f0d, 0x000a, "Hori Co. DOA4 FightStick", 0, XTYPE_XBOX360 },
187 { 0x0f0d, 0x000d, "Hori Fighting Stick EX2", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
188 { 0x0f0d, 0x0016, "Hori Real Arcade Pro.EX", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
189 { 0x0f0d, 0x0067, "HORIPAD ONE", 0, XTYPE_XBOXONE },
190 { 0x0f30, 0x0202, "Joytech Advanced Controller", 0, XTYPE_XBOX },
191 { 0x0f30, 0x8888, "BigBen XBMiniPad Controller", 0, XTYPE_XBOX },
192 { 0x102c, 0xff0c, "Joytech Wireless Advanced Controller", 0, XTYPE_XBOX },
193 { 0x12ab, 0x0004, "Honey Bee Xbox360 dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
194 { 0x12ab, 0x0301, "PDP AFTERGLOW AX.1", 0, XTYPE_XBOX360 },
195 { 0x12ab, 0x8809, "Xbox DDR dancepad", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
196 { 0x1430, 0x4748, "RedOctane Guitar Hero X-plorer", 0, XTYPE_XBOX360 },
197 { 0x1430, 0x8888, "TX6500+ Dance Pad (first generation)", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX },
198 { 0x146b, 0x0601, "BigBen Interactive XBOX 360 Controller", 0, XTYPE_XBOX360 },
199 { 0x1532, 0x0037, "Razer Sabertooth", 0, XTYPE_XBOX360 },
200 { 0x15e4, 0x3f00, "Power A Mini Pro Elite", 0, XTYPE_XBOX360 },
201 { 0x15e4, 0x3f0a, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
202 { 0x15e4, 0x3f10, "Batarang Xbox 360 controller", 0, XTYPE_XBOX360 },
203 { 0x162e, 0xbeef, "Joytech Neo-Se Take2", 0, XTYPE_XBOX360 },
204 { 0x1689, 0xfd00, "Razer Onza Tournament Edition", 0, XTYPE_XBOX360 },
205 { 0x1689, 0xfd01, "Razer Onza Classic Edition", 0, XTYPE_XBOX360 },
206 { 0x24c6, 0x542a, "Xbox ONE spectra", 0, XTYPE_XBOXONE },
207 { 0x24c6, 0x5d04, "Razer Sabertooth", 0, XTYPE_XBOX360 },
208 { 0x1bad, 0x0002, "Harmonix Rock Band Guitar", 0, XTYPE_XBOX360 },
209 { 0x1bad, 0x0003, "Harmonix Rock Band Drumkit", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360 },
210 { 0x1bad, 0xf016, "Mad Catz Xbox 360 Controller", 0, XTYPE_XBOX360 },
211 { 0x1bad, 0xf023, "MLG Pro Circuit Controller (Xbox)", 0, XTYPE_XBOX360 },
212 { 0x1bad, 0xf028, "Street Fighter IV FightPad", 0, XTYPE_XBOX360 },
213 { 0x1bad, 0xf038, "Street Fighter IV FightStick TE", 0, XTYPE_XBOX360 },
214 { 0x1bad, 0xf900, "Harmonix Xbox 360 Controller", 0, XTYPE_XBOX360 },
215 { 0x1bad, 0xf901, "Gamestop Xbox 360 Controller", 0, XTYPE_XBOX360 },
216 { 0x1bad, 0xf903, "Tron Xbox 360 controller", 0, XTYPE_XBOX360 },
217 { 0x24c6, 0x5000, "Razer Atrox Arcade Stick", MAP_TRIGGERS_TO_BUTTONS, XTYPE_XBOX360 },
218 { 0x24c6, 0x5300, "PowerA MINI PROEX Controller", 0, XTYPE_XBOX360 },
219 { 0x24c6, 0x5303, "Xbox Airflo wired controller", 0, XTYPE_XBOX360 },
220 { 0x24c6, 0x541a, "PowerA Xbox One Mini Wired Controller", 0, XTYPE_XBOXONE },
221 { 0x24c6, 0x543a, "PowerA Xbox One wired controller", 0, XTYPE_XBOXONE },
222 { 0x24c6, 0x5500, "Hori XBOX 360 EX 2 with Turbo", 0, XTYPE_XBOX360 },
223 { 0x24c6, 0x5501, "Hori Real Arcade Pro VX-SA", 0, XTYPE_XBOX360 },
224 { 0x24c6, 0x5506, "Hori SOULCALIBUR V Stick", 0, XTYPE_XBOX360 },
225 { 0x24c6, 0x5b02, "Thrustmaster, Inc. GPX Controller", 0, XTYPE_XBOX360 },
226 { 0x24c6, 0x5b03, "Thrustmaster Ferrari 458 Racing Wheel", 0, XTYPE_XBOX360 },
227 { 0xffff, 0xffff, "Chinese-made Xbox Controller", 0, XTYPE_XBOX },
228 { 0x0000, 0x0000, "Generic X-Box pad", 0, XTYPE_UNKNOWN }
229 };
230
231 /* buttons shared with xbox and xbox360 */
232 static const signed short xpad_common_btn[] = {
233 BTN_A, BTN_B, BTN_X, BTN_Y, /* "analog" buttons */
234 BTN_START, BTN_SELECT, BTN_THUMBL, BTN_THUMBR, /* start/back/sticks */
235 -1 /* terminating entry */
236 };
237
238 /* original xbox controllers only */
239 static const signed short xpad_btn[] = {
240 BTN_C, BTN_Z, /* "analog" buttons */
241 -1 /* terminating entry */
242 };
243
244 /* used when dpad is mapped to buttons */
245 static const signed short xpad_btn_pad[] = {
246 BTN_TRIGGER_HAPPY1, BTN_TRIGGER_HAPPY2, /* d-pad left, right */
247 BTN_TRIGGER_HAPPY3, BTN_TRIGGER_HAPPY4, /* d-pad up, down */
248 -1 /* terminating entry */
249 };
250
251 /* used when triggers are mapped to buttons */
252 static const signed short xpad_btn_triggers[] = {
253 BTN_TL2, BTN_TR2, /* triggers left/right */
254 -1
255 };
256
257 static const signed short xpad360_btn[] = { /* buttons for x360 controller */
258 BTN_TL, BTN_TR, /* Button LB/RB */
259 BTN_MODE, /* The big X button */
260 -1
261 };
262
263 static const signed short xpad_abs[] = {
264 ABS_X, ABS_Y, /* left stick */
265 ABS_RX, ABS_RY, /* right stick */
266 -1 /* terminating entry */
267 };
268
269 /* used when dpad is mapped to axes */
270 static const signed short xpad_abs_pad[] = {
271 ABS_HAT0X, ABS_HAT0Y, /* d-pad axes */
272 -1 /* terminating entry */
273 };
274
275 /* used when triggers are mapped to axes */
276 static const signed short xpad_abs_triggers[] = {
277 ABS_Z, ABS_RZ, /* triggers left/right */
278 -1
279 };
280
281 /*
282 * Xbox 360 has a vendor-specific class, so we cannot match it with only
283 * USB_INTERFACE_INFO (also specifically refused by USB subsystem), so we
284 * match against vendor id as well. Wired Xbox 360 devices have protocol 1,
285 * wireless controllers have protocol 129.
286 */
287 #define XPAD_XBOX360_VENDOR_PROTOCOL(vend,pr) \
288 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
289 .idVendor = (vend), \
290 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
291 .bInterfaceSubClass = 93, \
292 .bInterfaceProtocol = (pr)
293 #define XPAD_XBOX360_VENDOR(vend) \
294 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,1) }, \
295 { XPAD_XBOX360_VENDOR_PROTOCOL(vend,129) }
296
297 /* The Xbox One controller uses subclass 71 and protocol 208. */
298 #define XPAD_XBOXONE_VENDOR_PROTOCOL(vend, pr) \
299 .match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_INT_INFO, \
300 .idVendor = (vend), \
301 .bInterfaceClass = USB_CLASS_VENDOR_SPEC, \
302 .bInterfaceSubClass = 71, \
303 .bInterfaceProtocol = (pr)
304 #define XPAD_XBOXONE_VENDOR(vend) \
305 { XPAD_XBOXONE_VENDOR_PROTOCOL(vend, 208) }
306
307 static struct usb_device_id xpad_table[] = {
308 { USB_INTERFACE_INFO('X', 'B', 0) }, /* X-Box USB-IF not approved class */
309 XPAD_XBOX360_VENDOR(0x044f), /* Thrustmaster X-Box 360 controllers */
310 XPAD_XBOX360_VENDOR(0x045e), /* Microsoft X-Box 360 controllers */
311 XPAD_XBOXONE_VENDOR(0x045e), /* Microsoft X-Box One controllers */
312 XPAD_XBOX360_VENDOR(0x046d), /* Logitech X-Box 360 style controllers */
313 XPAD_XBOX360_VENDOR(0x0738), /* Mad Catz X-Box 360 controllers */
314 { USB_DEVICE(0x0738, 0x4540) }, /* Mad Catz Beat Pad */
315 XPAD_XBOXONE_VENDOR(0x0738), /* Mad Catz FightStick TE 2 */
316 XPAD_XBOX360_VENDOR(0x0e6f), /* 0x0e6f X-Box 360 controllers */
317 XPAD_XBOXONE_VENDOR(0x0e6f), /* 0x0e6f X-Box One controllers */
318 XPAD_XBOX360_VENDOR(0x12ab), /* X-Box 360 dance pads */
319 XPAD_XBOX360_VENDOR(0x1430), /* RedOctane X-Box 360 controllers */
320 XPAD_XBOX360_VENDOR(0x146b), /* BigBen Interactive Controllers */
321 XPAD_XBOX360_VENDOR(0x1bad), /* Harminix Rock Band Guitar and Drums */
322 XPAD_XBOX360_VENDOR(0x0f0d), /* Hori Controllers */
323 XPAD_XBOXONE_VENDOR(0x0f0d), /* Hori Controllers */
324 XPAD_XBOX360_VENDOR(0x1689), /* Razer Onza */
325 XPAD_XBOX360_VENDOR(0x24c6), /* PowerA Controllers */
326 XPAD_XBOXONE_VENDOR(0x24c6), /* PowerA Controllers */
327 XPAD_XBOX360_VENDOR(0x1532), /* Razer Sabertooth */
328 XPAD_XBOX360_VENDOR(0x15e4), /* Numark X-Box 360 controllers */
329 XPAD_XBOX360_VENDOR(0x162e), /* Joytech X-Box 360 controllers */
330 { }
331 };
332
333 MODULE_DEVICE_TABLE(usb, xpad_table);
334
335 struct xpad_output_packet {
336 u8 data[XPAD_PKT_LEN];
337 u8 len;
338 bool pending;
339 };
340
341 #define XPAD_OUT_CMD_IDX 0
342 #define XPAD_OUT_FF_IDX 1
343 #define XPAD_OUT_LED_IDX (1 + IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF))
344 #define XPAD_NUM_OUT_PACKETS (1 + \
345 IS_ENABLED(CONFIG_JOYSTICK_XPAD_FF) + \
346 IS_ENABLED(CONFIG_JOYSTICK_XPAD_LEDS))
347
348 struct usb_xpad {
349 struct input_dev *dev; /* input device interface */
350 struct input_dev __rcu *x360w_dev;
351 struct usb_device *udev; /* usb device */
352 struct usb_interface *intf; /* usb interface */
353
354 bool pad_present;
355 bool input_created;
356
357 struct urb *irq_in; /* urb for interrupt in report */
358 unsigned char *idata; /* input data */
359 dma_addr_t idata_dma;
360
361 struct urb *irq_out; /* urb for interrupt out report */
362 struct usb_anchor irq_out_anchor;
363 bool irq_out_active; /* we must not use an active URB */
364 u8 odata_serial; /* serial number for xbox one protocol */
365 unsigned char *odata; /* output data */
366 dma_addr_t odata_dma;
367 spinlock_t odata_lock;
368
369 struct xpad_output_packet out_packets[XPAD_NUM_OUT_PACKETS];
370 int last_out_packet;
371
372 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
373 struct xpad_led *led;
374 #endif
375
376 char phys[64]; /* physical device path */
377
378 int mapping; /* map d-pad to buttons or to axes */
379 int xtype; /* type of xbox device */
380 int pad_nr; /* the order x360 pads were attached */
381 const char *name; /* name of the device */
382 struct work_struct work; /* init/remove device from callback */
383 };
384
385 static int xpad_init_input(struct usb_xpad *xpad);
386 static void xpad_deinit_input(struct usb_xpad *xpad);
387
388 /*
389 * xpad_process_packet
390 *
391 * Completes a request by converting the data into events for the
392 * input subsystem.
393 *
394 * The used report descriptor was taken from ITO Takayukis website:
395 * http://euc.jp/periphs/xbox-controller.ja.html
396 */
397 static void xpad_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
398 {
399 struct input_dev *dev = xpad->dev;
400
401 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
402 /* left stick */
403 input_report_abs(dev, ABS_X,
404 (__s16) le16_to_cpup((__le16 *)(data + 12)));
405 input_report_abs(dev, ABS_Y,
406 ~(__s16) le16_to_cpup((__le16 *)(data + 14)));
407
408 /* right stick */
409 input_report_abs(dev, ABS_RX,
410 (__s16) le16_to_cpup((__le16 *)(data + 16)));
411 input_report_abs(dev, ABS_RY,
412 ~(__s16) le16_to_cpup((__le16 *)(data + 18)));
413 }
414
415 /* triggers left/right */
416 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
417 input_report_key(dev, BTN_TL2, data[10]);
418 input_report_key(dev, BTN_TR2, data[11]);
419 } else {
420 input_report_abs(dev, ABS_Z, data[10]);
421 input_report_abs(dev, ABS_RZ, data[11]);
422 }
423
424 /* digital pad */
425 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
426 /* dpad as buttons (left, right, up, down) */
427 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
428 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
429 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
430 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
431 } else {
432 input_report_abs(dev, ABS_HAT0X,
433 !!(data[2] & 0x08) - !!(data[2] & 0x04));
434 input_report_abs(dev, ABS_HAT0Y,
435 !!(data[2] & 0x02) - !!(data[2] & 0x01));
436 }
437
438 /* start/back buttons and stick press left/right */
439 input_report_key(dev, BTN_START, data[2] & 0x10);
440 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
441 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
442 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
443
444 /* "analog" buttons A, B, X, Y */
445 input_report_key(dev, BTN_A, data[4]);
446 input_report_key(dev, BTN_B, data[5]);
447 input_report_key(dev, BTN_X, data[6]);
448 input_report_key(dev, BTN_Y, data[7]);
449
450 /* "analog" buttons black, white */
451 input_report_key(dev, BTN_C, data[8]);
452 input_report_key(dev, BTN_Z, data[9]);
453
454 input_sync(dev);
455 }
456
457 /*
458 * xpad360_process_packet
459 *
460 * Completes a request by converting the data into events for the
461 * input subsystem. It is version for xbox 360 controller
462 *
463 * The used report descriptor was taken from:
464 * http://www.free60.org/wiki/Gamepad
465 */
466
467 static void xpad360_process_packet(struct usb_xpad *xpad, struct input_dev *dev,
468 u16 cmd, unsigned char *data)
469 {
470 /* valid pad data */
471 if (data[0] != 0x00)
472 return;
473
474 /* digital pad */
475 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
476 /* dpad as buttons (left, right, up, down) */
477 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[2] & 0x04);
478 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[2] & 0x08);
479 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[2] & 0x01);
480 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[2] & 0x02);
481 }
482
483 /*
484 * This should be a simple else block. However historically
485 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
486 * made no sense, but now we can not just switch back and have to
487 * support both behaviors.
488 */
489 if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
490 xpad->xtype == XTYPE_XBOX360W) {
491 input_report_abs(dev, ABS_HAT0X,
492 !!(data[2] & 0x08) - !!(data[2] & 0x04));
493 input_report_abs(dev, ABS_HAT0Y,
494 !!(data[2] & 0x02) - !!(data[2] & 0x01));
495 }
496
497 /* start/back buttons */
498 input_report_key(dev, BTN_START, data[2] & 0x10);
499 input_report_key(dev, BTN_SELECT, data[2] & 0x20);
500
501 /* stick press left/right */
502 input_report_key(dev, BTN_THUMBL, data[2] & 0x40);
503 input_report_key(dev, BTN_THUMBR, data[2] & 0x80);
504
505 /* buttons A,B,X,Y,TL,TR and MODE */
506 input_report_key(dev, BTN_A, data[3] & 0x10);
507 input_report_key(dev, BTN_B, data[3] & 0x20);
508 input_report_key(dev, BTN_X, data[3] & 0x40);
509 input_report_key(dev, BTN_Y, data[3] & 0x80);
510 input_report_key(dev, BTN_TL, data[3] & 0x01);
511 input_report_key(dev, BTN_TR, data[3] & 0x02);
512 input_report_key(dev, BTN_MODE, data[3] & 0x04);
513
514 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
515 /* left stick */
516 input_report_abs(dev, ABS_X,
517 (__s16) le16_to_cpup((__le16 *)(data + 6)));
518 input_report_abs(dev, ABS_Y,
519 ~(__s16) le16_to_cpup((__le16 *)(data + 8)));
520
521 /* right stick */
522 input_report_abs(dev, ABS_RX,
523 (__s16) le16_to_cpup((__le16 *)(data + 10)));
524 input_report_abs(dev, ABS_RY,
525 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
526 }
527
528 /* triggers left/right */
529 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
530 input_report_key(dev, BTN_TL2, data[4]);
531 input_report_key(dev, BTN_TR2, data[5]);
532 } else {
533 input_report_abs(dev, ABS_Z, data[4]);
534 input_report_abs(dev, ABS_RZ, data[5]);
535 }
536
537 input_sync(dev);
538 }
539
540 static void xpad_presence_work(struct work_struct *work)
541 {
542 struct usb_xpad *xpad = container_of(work, struct usb_xpad, work);
543 int error;
544
545 if (xpad->pad_present) {
546 error = xpad_init_input(xpad);
547 if (error) {
548 /* complain only, not much else we can do here */
549 dev_err(&xpad->dev->dev,
550 "unable to init device: %d\n", error);
551 } else {
552 rcu_assign_pointer(xpad->x360w_dev, xpad->dev);
553 }
554 } else {
555 RCU_INIT_POINTER(xpad->x360w_dev, NULL);
556 synchronize_rcu();
557 /*
558 * Now that we are sure xpad360w_process_packet is not
559 * using input device we can get rid of it.
560 */
561 xpad_deinit_input(xpad);
562 }
563 }
564
565 /*
566 * xpad360w_process_packet
567 *
568 * Completes a request by converting the data into events for the
569 * input subsystem. It is version for xbox 360 wireless controller.
570 *
571 * Byte.Bit
572 * 00.1 - Status change: The controller or headset has connected/disconnected
573 * Bits 01.7 and 01.6 are valid
574 * 01.7 - Controller present
575 * 01.6 - Headset present
576 * 01.1 - Pad state (Bytes 4+) valid
577 *
578 */
579 static void xpad360w_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char *data)
580 {
581 struct input_dev *dev;
582 bool present;
583
584 /* Presence change */
585 if (data[0] & 0x08) {
586 present = (data[1] & 0x80) != 0;
587
588 if (xpad->pad_present != present) {
589 xpad->pad_present = present;
590 schedule_work(&xpad->work);
591 }
592 }
593
594 /* Valid pad data */
595 if (data[1] != 0x1)
596 return;
597
598 rcu_read_lock();
599 dev = rcu_dereference(xpad->x360w_dev);
600 if (dev)
601 xpad360_process_packet(xpad, dev, cmd, &data[4]);
602 rcu_read_unlock();
603 }
604
605 /*
606 * xpadone_process_buttons
607 *
608 * Process a button update packet from an Xbox one controller.
609 */
610 static void xpadone_process_buttons(struct usb_xpad *xpad,
611 struct input_dev *dev,
612 unsigned char *data)
613 {
614 /* menu/view buttons */
615 input_report_key(dev, BTN_START, data[4] & 0x04);
616 input_report_key(dev, BTN_SELECT, data[4] & 0x08);
617
618 /* buttons A,B,X,Y */
619 input_report_key(dev, BTN_A, data[4] & 0x10);
620 input_report_key(dev, BTN_B, data[4] & 0x20);
621 input_report_key(dev, BTN_X, data[4] & 0x40);
622 input_report_key(dev, BTN_Y, data[4] & 0x80);
623
624 /* digital pad */
625 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
626 /* dpad as buttons (left, right, up, down) */
627 input_report_key(dev, BTN_TRIGGER_HAPPY1, data[5] & 0x04);
628 input_report_key(dev, BTN_TRIGGER_HAPPY2, data[5] & 0x08);
629 input_report_key(dev, BTN_TRIGGER_HAPPY3, data[5] & 0x01);
630 input_report_key(dev, BTN_TRIGGER_HAPPY4, data[5] & 0x02);
631 } else {
632 input_report_abs(dev, ABS_HAT0X,
633 !!(data[5] & 0x08) - !!(data[5] & 0x04));
634 input_report_abs(dev, ABS_HAT0Y,
635 !!(data[5] & 0x02) - !!(data[5] & 0x01));
636 }
637
638 /* TL/TR */
639 input_report_key(dev, BTN_TL, data[5] & 0x10);
640 input_report_key(dev, BTN_TR, data[5] & 0x20);
641
642 /* stick press left/right */
643 input_report_key(dev, BTN_THUMBL, data[5] & 0x40);
644 input_report_key(dev, BTN_THUMBR, data[5] & 0x80);
645
646 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
647 /* left stick */
648 input_report_abs(dev, ABS_X,
649 (__s16) le16_to_cpup((__le16 *)(data + 10)));
650 input_report_abs(dev, ABS_Y,
651 ~(__s16) le16_to_cpup((__le16 *)(data + 12)));
652
653 /* right stick */
654 input_report_abs(dev, ABS_RX,
655 (__s16) le16_to_cpup((__le16 *)(data + 14)));
656 input_report_abs(dev, ABS_RY,
657 ~(__s16) le16_to_cpup((__le16 *)(data + 16)));
658 }
659
660 /* triggers left/right */
661 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
662 input_report_key(dev, BTN_TL2,
663 (__u16) le16_to_cpup((__le16 *)(data + 6)));
664 input_report_key(dev, BTN_TR2,
665 (__u16) le16_to_cpup((__le16 *)(data + 8)));
666 } else {
667 input_report_abs(dev, ABS_Z,
668 (__u16) le16_to_cpup((__le16 *)(data + 6)));
669 input_report_abs(dev, ABS_RZ,
670 (__u16) le16_to_cpup((__le16 *)(data + 8)));
671 }
672
673 input_sync(dev);
674 }
675
676 /*
677 * xpadone_process_packet
678 *
679 * Completes a request by converting the data into events for the
680 * input subsystem. This version is for the Xbox One controller.
681 *
682 * The report format was gleaned from
683 * https://github.com/kylelemons/xbox/blob/master/xbox.go
684 */
685
686 static void xpadone_process_packet(struct usb_xpad *xpad,
687 u16 cmd, unsigned char *data)
688 {
689 struct input_dev *dev = xpad->dev;
690
691 switch (data[0]) {
692 case 0x20:
693 xpadone_process_buttons(xpad, dev, data);
694 break;
695
696 case 0x07:
697 /* the xbox button has its own special report */
698 input_report_key(dev, BTN_MODE, data[4] & 0x01);
699 input_sync(dev);
700 break;
701 }
702 }
703
704 static void xpad_irq_in(struct urb *urb)
705 {
706 struct usb_xpad *xpad = urb->context;
707 struct device *dev = &xpad->intf->dev;
708 int retval, status;
709
710 status = urb->status;
711
712 switch (status) {
713 case 0:
714 /* success */
715 break;
716 case -ECONNRESET:
717 case -ENOENT:
718 case -ESHUTDOWN:
719 /* this urb is terminated, clean up */
720 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
721 __func__, status);
722 return;
723 default:
724 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
725 __func__, status);
726 goto exit;
727 }
728
729 switch (xpad->xtype) {
730 case XTYPE_XBOX360:
731 xpad360_process_packet(xpad, xpad->dev, 0, xpad->idata);
732 break;
733 case XTYPE_XBOX360W:
734 xpad360w_process_packet(xpad, 0, xpad->idata);
735 break;
736 case XTYPE_XBOXONE:
737 xpadone_process_packet(xpad, 0, xpad->idata);
738 break;
739 default:
740 xpad_process_packet(xpad, 0, xpad->idata);
741 }
742
743 exit:
744 retval = usb_submit_urb(urb, GFP_ATOMIC);
745 if (retval)
746 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
747 __func__, retval);
748 }
749
750 /* Callers must hold xpad->odata_lock spinlock */
751 static bool xpad_prepare_next_out_packet(struct usb_xpad *xpad)
752 {
753 struct xpad_output_packet *pkt, *packet = NULL;
754 int i;
755
756 for (i = 0; i < XPAD_NUM_OUT_PACKETS; i++) {
757 if (++xpad->last_out_packet >= XPAD_NUM_OUT_PACKETS)
758 xpad->last_out_packet = 0;
759
760 pkt = &xpad->out_packets[xpad->last_out_packet];
761 if (pkt->pending) {
762 dev_dbg(&xpad->intf->dev,
763 "%s - found pending output packet %d\n",
764 __func__, xpad->last_out_packet);
765 packet = pkt;
766 break;
767 }
768 }
769
770 if (packet) {
771 memcpy(xpad->odata, packet->data, packet->len);
772 xpad->irq_out->transfer_buffer_length = packet->len;
773 packet->pending = false;
774 return true;
775 }
776
777 return false;
778 }
779
780 /* Callers must hold xpad->odata_lock spinlock */
781 static int xpad_try_sending_next_out_packet(struct usb_xpad *xpad)
782 {
783 int error;
784
785 if (!xpad->irq_out_active && xpad_prepare_next_out_packet(xpad)) {
786 usb_anchor_urb(xpad->irq_out, &xpad->irq_out_anchor);
787 error = usb_submit_urb(xpad->irq_out, GFP_ATOMIC);
788 if (error) {
789 dev_err(&xpad->intf->dev,
790 "%s - usb_submit_urb failed with result %d\n",
791 __func__, error);
792 usb_unanchor_urb(xpad->irq_out);
793 return -EIO;
794 }
795
796 xpad->irq_out_active = true;
797 }
798
799 return 0;
800 }
801
802 static void xpad_irq_out(struct urb *urb)
803 {
804 struct usb_xpad *xpad = urb->context;
805 struct device *dev = &xpad->intf->dev;
806 int status = urb->status;
807 int error;
808 unsigned long flags;
809
810 spin_lock_irqsave(&xpad->odata_lock, flags);
811
812 switch (status) {
813 case 0:
814 /* success */
815 xpad->irq_out_active = xpad_prepare_next_out_packet(xpad);
816 break;
817
818 case -ECONNRESET:
819 case -ENOENT:
820 case -ESHUTDOWN:
821 /* this urb is terminated, clean up */
822 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
823 __func__, status);
824 xpad->irq_out_active = false;
825 break;
826
827 default:
828 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
829 __func__, status);
830 break;
831 }
832
833 if (xpad->irq_out_active) {
834 usb_anchor_urb(urb, &xpad->irq_out_anchor);
835 error = usb_submit_urb(urb, GFP_ATOMIC);
836 if (error) {
837 dev_err(dev,
838 "%s - usb_submit_urb failed with result %d\n",
839 __func__, error);
840 usb_unanchor_urb(urb);
841 xpad->irq_out_active = false;
842 }
843 }
844
845 spin_unlock_irqrestore(&xpad->odata_lock, flags);
846 }
847
848 static int xpad_init_output(struct usb_interface *intf, struct usb_xpad *xpad)
849 {
850 struct usb_endpoint_descriptor *ep_irq_out;
851 int ep_irq_out_idx;
852 int error;
853
854 if (xpad->xtype == XTYPE_UNKNOWN)
855 return 0;
856
857 init_usb_anchor(&xpad->irq_out_anchor);
858
859 xpad->odata = usb_alloc_coherent(xpad->udev, XPAD_PKT_LEN,
860 GFP_KERNEL, &xpad->odata_dma);
861 if (!xpad->odata) {
862 error = -ENOMEM;
863 goto fail1;
864 }
865
866 spin_lock_init(&xpad->odata_lock);
867
868 xpad->irq_out = usb_alloc_urb(0, GFP_KERNEL);
869 if (!xpad->irq_out) {
870 error = -ENOMEM;
871 goto fail2;
872 }
873
874 /* Xbox One controller has in/out endpoints swapped. */
875 ep_irq_out_idx = xpad->xtype == XTYPE_XBOXONE ? 0 : 1;
876 ep_irq_out = &intf->cur_altsetting->endpoint[ep_irq_out_idx].desc;
877
878 usb_fill_int_urb(xpad->irq_out, xpad->udev,
879 usb_sndintpipe(xpad->udev, ep_irq_out->bEndpointAddress),
880 xpad->odata, XPAD_PKT_LEN,
881 xpad_irq_out, xpad, ep_irq_out->bInterval);
882 xpad->irq_out->transfer_dma = xpad->odata_dma;
883 xpad->irq_out->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
884
885 return 0;
886
887 fail2: usb_free_coherent(xpad->udev, XPAD_PKT_LEN, xpad->odata, xpad->odata_dma);
888 fail1: return error;
889 }
890
891 static void xpad_stop_output(struct usb_xpad *xpad)
892 {
893 if (xpad->xtype != XTYPE_UNKNOWN) {
894 if (!usb_wait_anchor_empty_timeout(&xpad->irq_out_anchor,
895 5000)) {
896 dev_warn(&xpad->intf->dev,
897 "timed out waiting for output URB to complete, killing\n");
898 usb_kill_anchored_urbs(&xpad->irq_out_anchor);
899 }
900 }
901 }
902
903 static void xpad_deinit_output(struct usb_xpad *xpad)
904 {
905 if (xpad->xtype != XTYPE_UNKNOWN) {
906 usb_free_urb(xpad->irq_out);
907 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
908 xpad->odata, xpad->odata_dma);
909 }
910 }
911
912 static int xpad_inquiry_pad_presence(struct usb_xpad *xpad)
913 {
914 struct xpad_output_packet *packet =
915 &xpad->out_packets[XPAD_OUT_CMD_IDX];
916 unsigned long flags;
917 int retval;
918
919 spin_lock_irqsave(&xpad->odata_lock, flags);
920
921 packet->data[0] = 0x08;
922 packet->data[1] = 0x00;
923 packet->data[2] = 0x0F;
924 packet->data[3] = 0xC0;
925 packet->data[4] = 0x00;
926 packet->data[5] = 0x00;
927 packet->data[6] = 0x00;
928 packet->data[7] = 0x00;
929 packet->data[8] = 0x00;
930 packet->data[9] = 0x00;
931 packet->data[10] = 0x00;
932 packet->data[11] = 0x00;
933 packet->len = 12;
934 packet->pending = true;
935
936 /* Reset the sequence so we send out presence first */
937 xpad->last_out_packet = -1;
938 retval = xpad_try_sending_next_out_packet(xpad);
939
940 spin_unlock_irqrestore(&xpad->odata_lock, flags);
941
942 return retval;
943 }
944
945 static int xpad_start_xbox_one(struct usb_xpad *xpad)
946 {
947 struct xpad_output_packet *packet =
948 &xpad->out_packets[XPAD_OUT_CMD_IDX];
949 unsigned long flags;
950 int retval;
951
952 spin_lock_irqsave(&xpad->odata_lock, flags);
953
954 /* Xbox one controller needs to be initialized. */
955 packet->data[0] = 0x05;
956 packet->data[1] = 0x20;
957 packet->data[2] = xpad->odata_serial++; /* packet serial */
958 packet->data[3] = 0x01; /* rumble bit enable? */
959 packet->data[4] = 0x00;
960 packet->len = 5;
961 packet->pending = true;
962
963 /* Reset the sequence so we send out start packet first */
964 xpad->last_out_packet = -1;
965 retval = xpad_try_sending_next_out_packet(xpad);
966
967 spin_unlock_irqrestore(&xpad->odata_lock, flags);
968
969 return retval;
970 }
971
972 #ifdef CONFIG_JOYSTICK_XPAD_FF
973 static int xpad_play_effect(struct input_dev *dev, void *data, struct ff_effect *effect)
974 {
975 struct usb_xpad *xpad = input_get_drvdata(dev);
976 struct xpad_output_packet *packet = &xpad->out_packets[XPAD_OUT_FF_IDX];
977 __u16 strong;
978 __u16 weak;
979 int retval;
980 unsigned long flags;
981
982 if (effect->type != FF_RUMBLE)
983 return 0;
984
985 strong = effect->u.rumble.strong_magnitude;
986 weak = effect->u.rumble.weak_magnitude;
987
988 spin_lock_irqsave(&xpad->odata_lock, flags);
989
990 switch (xpad->xtype) {
991 case XTYPE_XBOX:
992 packet->data[0] = 0x00;
993 packet->data[1] = 0x06;
994 packet->data[2] = 0x00;
995 packet->data[3] = strong / 256; /* left actuator */
996 packet->data[4] = 0x00;
997 packet->data[5] = weak / 256; /* right actuator */
998 packet->len = 6;
999 packet->pending = true;
1000 break;
1001
1002 case XTYPE_XBOX360:
1003 packet->data[0] = 0x00;
1004 packet->data[1] = 0x08;
1005 packet->data[2] = 0x00;
1006 packet->data[3] = strong / 256; /* left actuator? */
1007 packet->data[4] = weak / 256; /* right actuator? */
1008 packet->data[5] = 0x00;
1009 packet->data[6] = 0x00;
1010 packet->data[7] = 0x00;
1011 packet->len = 8;
1012 packet->pending = true;
1013 break;
1014
1015 case XTYPE_XBOX360W:
1016 packet->data[0] = 0x00;
1017 packet->data[1] = 0x01;
1018 packet->data[2] = 0x0F;
1019 packet->data[3] = 0xC0;
1020 packet->data[4] = 0x00;
1021 packet->data[5] = strong / 256;
1022 packet->data[6] = weak / 256;
1023 packet->data[7] = 0x00;
1024 packet->data[8] = 0x00;
1025 packet->data[9] = 0x00;
1026 packet->data[10] = 0x00;
1027 packet->data[11] = 0x00;
1028 packet->len = 12;
1029 packet->pending = true;
1030 break;
1031
1032 case XTYPE_XBOXONE:
1033 packet->data[0] = 0x09; /* activate rumble */
1034 packet->data[1] = 0x00;
1035 packet->data[2] = xpad->odata_serial++;
1036 packet->data[3] = 0x09;
1037 packet->data[4] = 0x00;
1038 packet->data[5] = 0x0F;
1039 packet->data[6] = 0x00;
1040 packet->data[7] = 0x00;
1041 packet->data[8] = strong / 512; /* left actuator */
1042 packet->data[9] = weak / 512; /* right actuator */
1043 packet->data[10] = 0xFF;
1044 packet->data[11] = 0x00;
1045 packet->data[12] = 0x00;
1046 packet->len = 13;
1047 packet->pending = true;
1048 break;
1049
1050 default:
1051 dev_dbg(&xpad->dev->dev,
1052 "%s - rumble command sent to unsupported xpad type: %d\n",
1053 __func__, xpad->xtype);
1054 retval = -EINVAL;
1055 goto out;
1056 }
1057
1058 retval = xpad_try_sending_next_out_packet(xpad);
1059
1060 out:
1061 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1062 return retval;
1063 }
1064
1065 static int xpad_init_ff(struct usb_xpad *xpad)
1066 {
1067 if (xpad->xtype == XTYPE_UNKNOWN)
1068 return 0;
1069
1070 input_set_capability(xpad->dev, EV_FF, FF_RUMBLE);
1071
1072 return input_ff_create_memless(xpad->dev, NULL, xpad_play_effect);
1073 }
1074
1075 #else
1076 static int xpad_init_ff(struct usb_xpad *xpad) { return 0; }
1077 #endif
1078
1079 #if defined(CONFIG_JOYSTICK_XPAD_LEDS)
1080 #include <linux/leds.h>
1081 #include <linux/idr.h>
1082
1083 static DEFINE_IDA(xpad_pad_seq);
1084
1085 struct xpad_led {
1086 char name[16];
1087 struct led_classdev led_cdev;
1088 struct usb_xpad *xpad;
1089 };
1090
1091 /**
1092 * set the LEDs on Xbox360 / Wireless Controllers
1093 * @param command
1094 * 0: off
1095 * 1: all blink, then previous setting
1096 * 2: 1/top-left blink, then on
1097 * 3: 2/top-right blink, then on
1098 * 4: 3/bottom-left blink, then on
1099 * 5: 4/bottom-right blink, then on
1100 * 6: 1/top-left on
1101 * 7: 2/top-right on
1102 * 8: 3/bottom-left on
1103 * 9: 4/bottom-right on
1104 * 10: rotate
1105 * 11: blink, based on previous setting
1106 * 12: slow blink, based on previous setting
1107 * 13: rotate with two lights
1108 * 14: persistent slow all blink
1109 * 15: blink once, then previous setting
1110 */
1111 static void xpad_send_led_command(struct usb_xpad *xpad, int command)
1112 {
1113 struct xpad_output_packet *packet =
1114 &xpad->out_packets[XPAD_OUT_LED_IDX];
1115 unsigned long flags;
1116
1117 command %= 16;
1118
1119 spin_lock_irqsave(&xpad->odata_lock, flags);
1120
1121 switch (xpad->xtype) {
1122 case XTYPE_XBOX360:
1123 packet->data[0] = 0x01;
1124 packet->data[1] = 0x03;
1125 packet->data[2] = command;
1126 packet->len = 3;
1127 packet->pending = true;
1128 break;
1129
1130 case XTYPE_XBOX360W:
1131 packet->data[0] = 0x00;
1132 packet->data[1] = 0x00;
1133 packet->data[2] = 0x08;
1134 packet->data[3] = 0x40 + command;
1135 packet->data[4] = 0x00;
1136 packet->data[5] = 0x00;
1137 packet->data[6] = 0x00;
1138 packet->data[7] = 0x00;
1139 packet->data[8] = 0x00;
1140 packet->data[9] = 0x00;
1141 packet->data[10] = 0x00;
1142 packet->data[11] = 0x00;
1143 packet->len = 12;
1144 packet->pending = true;
1145 break;
1146 }
1147
1148 xpad_try_sending_next_out_packet(xpad);
1149
1150 spin_unlock_irqrestore(&xpad->odata_lock, flags);
1151 }
1152
1153 /*
1154 * Light up the segment corresponding to the pad number on
1155 * Xbox 360 Controllers.
1156 */
1157 static void xpad_identify_controller(struct usb_xpad *xpad)
1158 {
1159 led_set_brightness(&xpad->led->led_cdev, (xpad->pad_nr % 4) + 2);
1160 }
1161
1162 static void xpad_led_set(struct led_classdev *led_cdev,
1163 enum led_brightness value)
1164 {
1165 struct xpad_led *xpad_led = container_of(led_cdev,
1166 struct xpad_led, led_cdev);
1167
1168 xpad_send_led_command(xpad_led->xpad, value);
1169 }
1170
1171 static int xpad_led_probe(struct usb_xpad *xpad)
1172 {
1173 struct xpad_led *led;
1174 struct led_classdev *led_cdev;
1175 int error;
1176
1177 if (xpad->xtype != XTYPE_XBOX360 && xpad->xtype != XTYPE_XBOX360W)
1178 return 0;
1179
1180 xpad->led = led = kzalloc(sizeof(struct xpad_led), GFP_KERNEL);
1181 if (!led)
1182 return -ENOMEM;
1183
1184 xpad->pad_nr = ida_simple_get(&xpad_pad_seq, 0, 0, GFP_KERNEL);
1185 if (xpad->pad_nr < 0) {
1186 error = xpad->pad_nr;
1187 goto err_free_mem;
1188 }
1189
1190 snprintf(led->name, sizeof(led->name), "xpad%d", xpad->pad_nr);
1191 led->xpad = xpad;
1192
1193 led_cdev = &led->led_cdev;
1194 led_cdev->name = led->name;
1195 led_cdev->brightness_set = xpad_led_set;
1196
1197 error = led_classdev_register(&xpad->udev->dev, led_cdev);
1198 if (error)
1199 goto err_free_id;
1200
1201 xpad_identify_controller(xpad);
1202
1203 return 0;
1204
1205 err_free_id:
1206 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1207 err_free_mem:
1208 kfree(led);
1209 xpad->led = NULL;
1210 return error;
1211 }
1212
1213 static void xpad_led_disconnect(struct usb_xpad *xpad)
1214 {
1215 struct xpad_led *xpad_led = xpad->led;
1216
1217 if (xpad_led) {
1218 led_classdev_unregister(&xpad_led->led_cdev);
1219 ida_simple_remove(&xpad_pad_seq, xpad->pad_nr);
1220 kfree(xpad_led);
1221 }
1222 }
1223 #else
1224 static int xpad_led_probe(struct usb_xpad *xpad) { return 0; }
1225 static void xpad_led_disconnect(struct usb_xpad *xpad) { }
1226 #endif
1227
1228 static int xpad_start_input(struct usb_xpad *xpad)
1229 {
1230 int error;
1231
1232 if (usb_submit_urb(xpad->irq_in, GFP_KERNEL))
1233 return -EIO;
1234
1235 if (xpad->xtype == XTYPE_XBOXONE) {
1236 error = xpad_start_xbox_one(xpad);
1237 if (error) {
1238 usb_kill_urb(xpad->irq_in);
1239 return error;
1240 }
1241 }
1242
1243 return 0;
1244 }
1245
1246 static void xpad_stop_input(struct usb_xpad *xpad)
1247 {
1248 usb_kill_urb(xpad->irq_in);
1249 }
1250
1251 static int xpad360w_start_input(struct usb_xpad *xpad)
1252 {
1253 int error;
1254
1255 error = usb_submit_urb(xpad->irq_in, GFP_KERNEL);
1256 if (error)
1257 return -EIO;
1258
1259 /*
1260 * Send presence packet.
1261 * This will force the controller to resend connection packets.
1262 * This is useful in the case we activate the module after the
1263 * adapter has been plugged in, as it won't automatically
1264 * send us info about the controllers.
1265 */
1266 error = xpad_inquiry_pad_presence(xpad);
1267 if (error) {
1268 usb_kill_urb(xpad->irq_in);
1269 return error;
1270 }
1271
1272 return 0;
1273 }
1274
1275 static void xpad360w_stop_input(struct usb_xpad *xpad)
1276 {
1277 usb_kill_urb(xpad->irq_in);
1278
1279 /* Make sure we are done with presence work if it was scheduled */
1280 flush_work(&xpad->work);
1281 }
1282
1283 static int xpad_open(struct input_dev *dev)
1284 {
1285 struct usb_xpad *xpad = input_get_drvdata(dev);
1286
1287 return xpad_start_input(xpad);
1288 }
1289
1290 static void xpad_close(struct input_dev *dev)
1291 {
1292 struct usb_xpad *xpad = input_get_drvdata(dev);
1293
1294 xpad_stop_input(xpad);
1295 }
1296
1297 static void xpad_set_up_abs(struct input_dev *input_dev, signed short abs)
1298 {
1299 struct usb_xpad *xpad = input_get_drvdata(input_dev);
1300 set_bit(abs, input_dev->absbit);
1301
1302 switch (abs) {
1303 case ABS_X:
1304 case ABS_Y:
1305 case ABS_RX:
1306 case ABS_RY: /* the two sticks */
1307 input_set_abs_params(input_dev, abs, -32768, 32767, 16, 128);
1308 break;
1309 case ABS_Z:
1310 case ABS_RZ: /* the triggers (if mapped to axes) */
1311 if (xpad->xtype == XTYPE_XBOXONE)
1312 input_set_abs_params(input_dev, abs, 0, 1023, 0, 0);
1313 else
1314 input_set_abs_params(input_dev, abs, 0, 255, 0, 0);
1315 break;
1316 case ABS_HAT0X:
1317 case ABS_HAT0Y: /* the d-pad (only if dpad is mapped to axes */
1318 input_set_abs_params(input_dev, abs, -1, 1, 0, 0);
1319 break;
1320 }
1321 }
1322
1323 static void xpad_deinit_input(struct usb_xpad *xpad)
1324 {
1325 if (xpad->input_created) {
1326 xpad->input_created = false;
1327 xpad_led_disconnect(xpad);
1328 input_unregister_device(xpad->dev);
1329 }
1330 }
1331
1332 static int xpad_init_input(struct usb_xpad *xpad)
1333 {
1334 struct input_dev *input_dev;
1335 int i, error;
1336
1337 input_dev = input_allocate_device();
1338 if (!input_dev)
1339 return -ENOMEM;
1340
1341 xpad->dev = input_dev;
1342 input_dev->name = xpad->name;
1343 input_dev->phys = xpad->phys;
1344 usb_to_input_id(xpad->udev, &input_dev->id);
1345 input_dev->dev.parent = &xpad->intf->dev;
1346
1347 input_set_drvdata(input_dev, xpad);
1348
1349 if (xpad->xtype != XTYPE_XBOX360W) {
1350 input_dev->open = xpad_open;
1351 input_dev->close = xpad_close;
1352 }
1353
1354 __set_bit(EV_KEY, input_dev->evbit);
1355
1356 if (!(xpad->mapping & MAP_STICKS_TO_NULL)) {
1357 __set_bit(EV_ABS, input_dev->evbit);
1358 /* set up axes */
1359 for (i = 0; xpad_abs[i] >= 0; i++)
1360 xpad_set_up_abs(input_dev, xpad_abs[i]);
1361 }
1362
1363 /* set up standard buttons */
1364 for (i = 0; xpad_common_btn[i] >= 0; i++)
1365 __set_bit(xpad_common_btn[i], input_dev->keybit);
1366
1367 /* set up model-specific ones */
1368 if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
1369 xpad->xtype == XTYPE_XBOXONE) {
1370 for (i = 0; xpad360_btn[i] >= 0; i++)
1371 __set_bit(xpad360_btn[i], input_dev->keybit);
1372 } else {
1373 for (i = 0; xpad_btn[i] >= 0; i++)
1374 __set_bit(xpad_btn[i], input_dev->keybit);
1375 }
1376
1377 if (xpad->mapping & MAP_DPAD_TO_BUTTONS) {
1378 for (i = 0; xpad_btn_pad[i] >= 0; i++)
1379 __set_bit(xpad_btn_pad[i], input_dev->keybit);
1380 }
1381
1382 /*
1383 * This should be a simple else block. However historically
1384 * xbox360w has mapped DPAD to buttons while xbox360 did not. This
1385 * made no sense, but now we can not just switch back and have to
1386 * support both behaviors.
1387 */
1388 if (!(xpad->mapping & MAP_DPAD_TO_BUTTONS) ||
1389 xpad->xtype == XTYPE_XBOX360W) {
1390 for (i = 0; xpad_abs_pad[i] >= 0; i++)
1391 xpad_set_up_abs(input_dev, xpad_abs_pad[i]);
1392 }
1393
1394 if (xpad->mapping & MAP_TRIGGERS_TO_BUTTONS) {
1395 for (i = 0; xpad_btn_triggers[i] >= 0; i++)
1396 __set_bit(xpad_btn_triggers[i], input_dev->keybit);
1397 } else {
1398 for (i = 0; xpad_abs_triggers[i] >= 0; i++)
1399 xpad_set_up_abs(input_dev, xpad_abs_triggers[i]);
1400 }
1401
1402 error = xpad_init_ff(xpad);
1403 if (error)
1404 goto err_free_input;
1405
1406 error = xpad_led_probe(xpad);
1407 if (error)
1408 goto err_destroy_ff;
1409
1410 error = input_register_device(xpad->dev);
1411 if (error)
1412 goto err_disconnect_led;
1413
1414 xpad->input_created = true;
1415 return 0;
1416
1417 err_disconnect_led:
1418 xpad_led_disconnect(xpad);
1419 err_destroy_ff:
1420 input_ff_destroy(input_dev);
1421 err_free_input:
1422 input_free_device(input_dev);
1423 return error;
1424 }
1425
1426 static int xpad_probe(struct usb_interface *intf, const struct usb_device_id *id)
1427 {
1428 struct usb_device *udev = interface_to_usbdev(intf);
1429 struct usb_xpad *xpad;
1430 struct usb_endpoint_descriptor *ep_irq_in;
1431 int ep_irq_in_idx;
1432 int i, error;
1433
1434 if (intf->cur_altsetting->desc.bNumEndpoints != 2)
1435 return -ENODEV;
1436
1437 for (i = 0; xpad_device[i].idVendor; i++) {
1438 if ((le16_to_cpu(udev->descriptor.idVendor) == xpad_device[i].idVendor) &&
1439 (le16_to_cpu(udev->descriptor.idProduct) == xpad_device[i].idProduct))
1440 break;
1441 }
1442
1443 xpad = kzalloc(sizeof(struct usb_xpad), GFP_KERNEL);
1444 if (!xpad)
1445 return -ENOMEM;
1446
1447 usb_make_path(udev, xpad->phys, sizeof(xpad->phys));
1448 strlcat(xpad->phys, "/input0", sizeof(xpad->phys));
1449
1450 xpad->idata = usb_alloc_coherent(udev, XPAD_PKT_LEN,
1451 GFP_KERNEL, &xpad->idata_dma);
1452 if (!xpad->idata) {
1453 error = -ENOMEM;
1454 goto err_free_mem;
1455 }
1456
1457 xpad->irq_in = usb_alloc_urb(0, GFP_KERNEL);
1458 if (!xpad->irq_in) {
1459 error = -ENOMEM;
1460 goto err_free_idata;
1461 }
1462
1463 xpad->udev = udev;
1464 xpad->intf = intf;
1465 xpad->mapping = xpad_device[i].mapping;
1466 xpad->xtype = xpad_device[i].xtype;
1467 xpad->name = xpad_device[i].name;
1468 INIT_WORK(&xpad->work, xpad_presence_work);
1469
1470 if (xpad->xtype == XTYPE_UNKNOWN) {
1471 if (intf->cur_altsetting->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC) {
1472 if (intf->cur_altsetting->desc.bInterfaceProtocol == 129)
1473 xpad->xtype = XTYPE_XBOX360W;
1474 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 208)
1475 xpad->xtype = XTYPE_XBOXONE;
1476 else
1477 xpad->xtype = XTYPE_XBOX360;
1478 } else {
1479 xpad->xtype = XTYPE_XBOX;
1480 }
1481
1482 if (dpad_to_buttons)
1483 xpad->mapping |= MAP_DPAD_TO_BUTTONS;
1484 if (triggers_to_buttons)
1485 xpad->mapping |= MAP_TRIGGERS_TO_BUTTONS;
1486 if (sticks_to_null)
1487 xpad->mapping |= MAP_STICKS_TO_NULL;
1488 }
1489
1490 if (xpad->xtype == XTYPE_XBOXONE &&
1491 intf->cur_altsetting->desc.bInterfaceNumber != 0) {
1492 /*
1493 * The Xbox One controller lists three interfaces all with the
1494 * same interface class, subclass and protocol. Differentiate by
1495 * interface number.
1496 */
1497 error = -ENODEV;
1498 goto err_free_in_urb;
1499 }
1500
1501 error = xpad_init_output(intf, xpad);
1502 if (error)
1503 goto err_free_in_urb;
1504
1505 /* Xbox One controller has in/out endpoints swapped. */
1506 ep_irq_in_idx = xpad->xtype == XTYPE_XBOXONE ? 1 : 0;
1507 ep_irq_in = &intf->cur_altsetting->endpoint[ep_irq_in_idx].desc;
1508
1509 usb_fill_int_urb(xpad->irq_in, udev,
1510 usb_rcvintpipe(udev, ep_irq_in->bEndpointAddress),
1511 xpad->idata, XPAD_PKT_LEN, xpad_irq_in,
1512 xpad, ep_irq_in->bInterval);
1513 xpad->irq_in->transfer_dma = xpad->idata_dma;
1514 xpad->irq_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1515
1516 usb_set_intfdata(intf, xpad);
1517
1518 if (xpad->xtype == XTYPE_XBOX360W) {
1519 /*
1520 * Submit the int URB immediately rather than waiting for open
1521 * because we get status messages from the device whether
1522 * or not any controllers are attached. In fact, it's
1523 * exactly the message that a controller has arrived that
1524 * we're waiting for.
1525 */
1526 error = xpad360w_start_input(xpad);
1527 if (error)
1528 goto err_deinit_output;
1529 /*
1530 * Wireless controllers require RESET_RESUME to work properly
1531 * after suspend. Ideally this quirk should be in usb core
1532 * quirk list, but we have too many vendors producing these
1533 * controllers and we'd need to maintain 2 identical lists
1534 * here in this driver and in usb core.
1535 */
1536 udev->quirks |= USB_QUIRK_RESET_RESUME;
1537 } else {
1538 error = xpad_init_input(xpad);
1539 if (error)
1540 goto err_deinit_output;
1541 }
1542 return 0;
1543
1544 err_deinit_output:
1545 xpad_deinit_output(xpad);
1546 err_free_in_urb:
1547 usb_free_urb(xpad->irq_in);
1548 err_free_idata:
1549 usb_free_coherent(udev, XPAD_PKT_LEN, xpad->idata, xpad->idata_dma);
1550 err_free_mem:
1551 kfree(xpad);
1552 return error;
1553 }
1554
1555 static void xpad_disconnect(struct usb_interface *intf)
1556 {
1557 struct usb_xpad *xpad = usb_get_intfdata(intf);
1558
1559 if (xpad->xtype == XTYPE_XBOX360W)
1560 xpad360w_stop_input(xpad);
1561
1562 xpad_deinit_input(xpad);
1563
1564 /*
1565 * Now that both input device and LED device are gone we can
1566 * stop output URB.
1567 */
1568 xpad_stop_output(xpad);
1569
1570 xpad_deinit_output(xpad);
1571
1572 usb_free_urb(xpad->irq_in);
1573 usb_free_coherent(xpad->udev, XPAD_PKT_LEN,
1574 xpad->idata, xpad->idata_dma);
1575
1576 kfree(xpad);
1577
1578 usb_set_intfdata(intf, NULL);
1579 }
1580
1581 static int xpad_suspend(struct usb_interface *intf, pm_message_t message)
1582 {
1583 struct usb_xpad *xpad = usb_get_intfdata(intf);
1584 struct input_dev *input = xpad->dev;
1585
1586 if (xpad->xtype == XTYPE_XBOX360W) {
1587 /*
1588 * Wireless controllers always listen to input so
1589 * they are notified when controller shows up
1590 * or goes away.
1591 */
1592 xpad360w_stop_input(xpad);
1593 } else {
1594 mutex_lock(&input->mutex);
1595 if (input->users)
1596 xpad_stop_input(xpad);
1597 mutex_unlock(&input->mutex);
1598 }
1599
1600 xpad_stop_output(xpad);
1601
1602 return 0;
1603 }
1604
1605 static int xpad_resume(struct usb_interface *intf)
1606 {
1607 struct usb_xpad *xpad = usb_get_intfdata(intf);
1608 struct input_dev *input = xpad->dev;
1609 int retval = 0;
1610
1611 if (xpad->xtype == XTYPE_XBOX360W) {
1612 retval = xpad360w_start_input(xpad);
1613 } else {
1614 mutex_lock(&input->mutex);
1615 if (input->users)
1616 retval = xpad_start_input(xpad);
1617 mutex_unlock(&input->mutex);
1618 }
1619
1620 return retval;
1621 }
1622
1623 static struct usb_driver xpad_driver = {
1624 .name = "xpad",
1625 .probe = xpad_probe,
1626 .disconnect = xpad_disconnect,
1627 .suspend = xpad_suspend,
1628 .resume = xpad_resume,
1629 .reset_resume = xpad_resume,
1630 .id_table = xpad_table,
1631 };
1632
1633 module_usb_driver(xpad_driver);
1634
1635 MODULE_AUTHOR(DRIVER_AUTHOR);
1636 MODULE_DESCRIPTION(DRIVER_DESC);
1637 MODULE_LICENSE("GPL");
This page took 0.072036 seconds and 5 git commands to generate.