About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / input / xpad.txt




Custom Search

Based on kernel version 3.13. Page generated on 2014-01-20 22:03 EST.

1	xpad - Linux USB driver for X-Box gamepads
2	
3	This is the very first release of a driver for X-Box gamepads.
4	Basically, this was hacked away in just a few hours, so don't expect
5	miracles.
6	
7	In particular, there is currently NO support for the rumble pack.
8	You won't find many ff-aware linux applications anyway.
9	
10	
11	0. Notes
12	--------
13	
14	Driver updated for kernel 2.6.17.11. (Based on a patch for 2.6.11.4.)
15	
16	The number of buttons/axes reported varies based on 3 things:
17	- if you are using a known controller
18	- if you are using a known dance pad
19	- if using an unknown device (one not listed below), what you set in the
20	  module configuration for "Map D-PAD to buttons rather than axes for unknown
21	  pads" (module option dpad_to_buttons)
22	
23	If you set dpad_to_buttons to 0 and you are using an unknown device (one
24	not listed below), the driver will map the directional pad to axes (X/Y),
25	if you said N it will map the d-pad to buttons, which is needed for dance
26	style games to function correctly.  The default is Y.
27	
28	dpad_to_buttons has no effect for known pads.
29	
30	0.1 Normal Controllers
31	----------------------
32	With a normal controller, the directional pad is mapped to its own X/Y axes.
33	The jstest-program from joystick-1.2.15 (jstest-version 2.1.0) will report 8
34	axes and 10 buttons.
35	
36	All 8 axes work, though they all have the same range (-32768..32767)
37	and the zero-setting is not correct for the triggers (I don't know if that
38	is some limitation of jstest, since the input device setup should be fine. I
39	didn't have a look at jstest itself yet).
40	
41	All of the 10 buttons work (in digital mode). The six buttons on the
42	right side (A, B, X, Y, black, white) are said to be "analog" and
43	report their values as 8 bit unsigned, not sure what this is good for.
44	
45	I tested the controller with quake3, and configuration and
46	in game functionality were OK. However, I find it rather difficult to
47	play first person shooters with a pad. Your mileage may vary.
48	
49	
50	0.2 Xbox Dance Pads
51	-------------------
52	When using a known dance pad, jstest will report 6 axes and 14 buttons.
53	
54	For dance style pads (like the redoctane pad) several changes
55	have been made.  The old driver would map the d-pad to axes, resulting
56	in the driver being unable to report when the user was pressing both
57	left+right or up+down, making DDR style games unplayable.
58	
59	Known dance pads automatically map the d-pad to buttons and will work
60	correctly out of the box.
61	
62	If your dance pad is recognized by the driver but is using axes instead
63	of buttons, see section 0.3 - Unknown Controllers
64	
65	I've tested this with Stepmania, and it works quite well.
66	
67	
68	0.3 Unknown Controllers
69	----------------------
70	If you have an unknown xbox controller, it should work just fine with
71	the default settings.
72	
73	HOWEVER if you have an unknown dance pad not listed below, it will not
74	work UNLESS you set "dpad_to_buttons" to 1 in the module configuration.
75	
76	PLEASE, if you have an unknown controller, email Dom <binary1230@yahoo.com> with
77	a dump from /proc/bus/usb and a description of the pad (manufacturer, country,
78	whether it is a dance pad or normal controller) so that we can add your pad
79	to the list of supported devices, ensuring that it will work out of the
80	box in the future.
81	
82	
83	1. USB adapter
84	--------------
85	
86	Before you can actually use the driver, you need to get yourself an
87	adapter cable to connect the X-Box controller to your Linux-Box. You
88	can buy these online fairly cheap, or build your own.
89	
90	Such a cable is pretty easy to build. The Controller itself is a USB
91	compound device (a hub with three ports for two expansion slots and
92	the controller device) with the only difference in a nonstandard connector
93	(5 pins vs. 4 on standard USB connector).
94	
95	You just need to solder a USB connector onto the cable and keep the
96	yellow wire unconnected. The other pins have the same order on both
97	connectors so there is no magic to it. Detailed info on these matters
98	can be found on the net ([1], [2], [3]).
99	
100	Thanks to the trip splitter found on the cable you don't even need to cut the
101	original one. You can buy an extension cable and cut that instead. That way,
102	you can still use the controller with your X-Box, if you have one ;)
103	
104	
105	2. Driver Installation
106	----------------------
107	
108	Once you have the adapter cable and the controller is connected, you need
109	to load your USB subsystem and should cat /proc/bus/usb/devices.
110	There should be an entry like the one at the end [4].
111	
112	Currently (as of version 0.0.6), the following devices are included:
113	 original Microsoft XBOX controller (US), vendor=0x045e, product=0x0202
114	 smaller  Microsoft XBOX controller (US), vendor=0x045e, product=0x0289
115	 original Microsoft XBOX controller (Japan), vendor=0x045e, product=0x0285
116	 InterAct PowerPad Pro (Germany), vendor=0x05fd, product=0x107a
117	 RedOctane Xbox Dance Pad (US), vendor=0x0c12, product=0x8809
118	
119	The driver should work with xbox pads not listed above as well, however
120	you will need to do something extra for dance pads to work.
121	
122	If you have a controller not listed above, see 0.3 - Unknown Controllers
123	
124	If you compiled and installed the driver, test the functionality:
125	> modprobe xpad
126	> modprobe joydev
127	> jstest /dev/js0
128	
129	If you're using a normal controller, there should be a single line showing
130	18 inputs (8 axes, 10 buttons), and its values should change if you move
131	the sticks and push the buttons.  If you're using a dance pad, it should
132	show 20 inputs (6 axes, 14 buttons).
133	
134	It works? Voila, you're done ;)
135	
136	
137	3. Thanks
138	---------
139	
140	I have to thank ITO Takayuki for the detailed info on his site
141	 http://euc.jp/periphs/xbox-controller.ja.html.
142	 
143	His useful info and both the usb-skeleton as well as the iforce input driver
144	(Greg Kroah-Hartmann; Vojtech Pavlik) helped a lot in rapid prototyping
145	the basic functionality.
146	
147	
148	4. References
149	-------------
150	
151	1. http://euc.jp/periphs/xbox-controller.ja.html (ITO Takayuki)
152	2. http://xpad.xbox-scene.com/
153	3. http://www.markosweb.com/www/xboxhackz.com/ 
154	
155	4. /proc/bus/usb/devices - dump from InterAct PowerPad Pro (Germany):
156	
157	T:  Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#=  5 Spd=12  MxCh= 0
158	D:  Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs=  1
159	P:  Vendor=05fd ProdID=107a Rev= 1.00
160	C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA
161	I:  If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none)
162	E:  Ad=81(I) Atr=03(Int.) MxPS=  32 Ivl= 10ms
163	E:  Ad=02(O) Atr=03(Int.) MxPS=  32 Ivl= 10ms
164	
165	5. /proc/bus/usb/devices - dump from Redoctane Xbox Dance Pad (US):
166	
167	T:  Bus=01 Lev=02 Prnt=09 Port=00 Cnt=01 Dev#= 10 Spd=12  MxCh= 0
168	D:  Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs=  1
169	P:  Vendor=0c12 ProdID=8809 Rev= 0.01
170	S:  Product=XBOX DDR
171	C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA
172	I:  If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=xpad
173	E:  Ad=82(I) Atr=03(Int.) MxPS=  32 Ivl=4ms
174	E:  Ad=02(O) Atr=03(Int.) MxPS=  32 Ivl=4ms
175	
176	-- 
177	Marko Friedemann <mfr@bmx-chemnitz.de>
178	2002-07-16
179	 - original doc
180	
181	Dominic Cerquetti <binary1230@yahoo.com>
182	2005-03-19
183	 - added stuff for dance pads, new d-pad->axes mappings
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.