blob: b9111a703ce0c37a8a3ad59cc442da283629a0b2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001xpad - Linux USB driver for X-Box gamepads
2
3This is the very first release of a driver for X-Box gamepads.
4Basically, this was hacked away in just a few hours, so don't expect
5miracles.
6In particular, there is currently NO support for the rumble pack.
7You won't find many ff-aware linux applications anyway.
8
9
100. Status
11---------
12
13For now, this driver has only been tested on just one Linux-Box.
14This one is running a 2.4.18 kernel with usb-uhci on an amd athlon 600.
15
16The jstest-program from joystick-1.2.15 (jstest-version 2.1.0) reports
178 axes and 10 buttons.
18
19Alls 8 axes work, though they all have the same range (-32768..32767)
20and the zero-setting is not correct for the triggers (I don't know if that
21is some limitation of jstest, since the input device setup should be fine. I
22didn't have a look at jstest itself yet).
23
24All of the 10 buttons work (in digital mode). The six buttons on the
25right side (A, B, X, Y, black, white) are said to be "analog" and
26report their values as 8 bit unsigned, not sure what this is good for.
27
28I tested the controller with quake3, and configuration and
29in game functionality were OK. However, I find it rather difficult to
30play first person shooters with a pad. Your mileage may vary.
31
32
331. USB adapter
34--------------
35
36Before you can actually use the driver, you need to get yourself an
37adapter cable to connect the X-Box controller to your Linux-Box.
38
39Such a cable is pretty easy to build. The Controller itself is a USB compound
40device (a hub with three ports for two expansion slots and the controller
41device) with the only difference in a nonstandard connector (5 pins vs. 4 on
42standard USB connector).
43
44You just need to solder a USB connector onto the cable and keep the
45yellow wire unconnected. The other pins have the same order on both
46connectors so there is no magic to it. Detailed info on these matters
47can be found on the net ([1], [2], [3]).
48
49Thanks to the trip splitter found on the cable you don't even need to cut the
50original one. You can buy an extension cable and cut that instead. That way,
51you can still use the controller with your X-Box, if you have one ;)
52
53
542. driver installation
55----------------------
56
57Once you have the adapter cable and the controller is connected, you need
58to load your USB subsystem and should cat /proc/bus/usb/devices.
59There should be an entry like the one at the end [4].
60
61Currently (as of version 0.0.4), the following three devices are included:
62 original Microsoft XBOX controller (US), vendor=0x045e, product=0x0202
63 original Microsoft XBOX controller (Japan), vendor=0x045e, product=0x0285
64 InterAct PowerPad Pro (Germany), vendor=0x05fd, product=0x107a
65
66If you have another controller that is not listed above and is not recognized
67by the driver, please drop me a line with the appropriate info (that is, include
68the name, vendor and product ID, as well as the country where you bought it;
69sending the whole dump out of /proc/bus/usb/devices along would be even better).
70
71In theory, the driver should work with other controllers than mine
72(InterAct PowerPad pro, bought in Germany) just fine, but I cannot test this
73for I only have this one controller.
74
75If you compiled and installed the driver, test the functionality:
76> modprobe xpad
77> modprobe joydev
78> jstest /dev/js0
79
80There should be a single line showing 18 inputs (8 axes, 10 buttons), and
81it's values should change if you move the sticks and push the buttons.
82
83It works? Voila, your done ;)
84
85
863. Thanks
87---------
88
89I have to thank ITO Takayuki for the detailed info on his site
90 http://euc.jp/periphs/xbox-controller.ja.html.
91
92His useful info and both the usb-skeleton as well as the iforce input driver
93(Greg Kroah-Hartmann; Vojtech Pavlik) helped a lot in rapid prototyping
94the basic functionality.
95
96
974. References
98-------------
99
1001. http://euc.jp/periphs/xbox-controller.ja.html (ITO Takayuki)
1012. http://xpad.xbox-scene.com/
1023. http://www.xboxhackz.com/Hackz-Reference.htm
103
1044. /proc/bus/usb/devices - dump from InterAct PowerPad Pro (Germany):
105
106T: Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#= 5 Spd=12 MxCh= 0
107D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs= 1
108P: Vendor=05fd ProdID=107a Rev= 1.00
109C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA
110I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none)
111E: Ad=81(I) Atr=03(Int.) MxPS= 32 Ivl= 10ms
112E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl= 10ms
113
114--
115Marko Friedemann <mfr@bmx-chemnitz.de>
1162002-07-16