Input: xpad - convert documentation into ReST format

+68 -52

1 changed file

expand all

Documentation

input

xpad.txt

+68 -52

Documentation/input/xpad.txt

··· 1 + ======================================================= 1 2 xpad - Linux USB driver for Xbox compatible controllers 3 + ======================================================= 2 4 3 5 This driver exposes all first-party and third-party Xbox compatible 4 6 controllers. It has a long history and has enjoyed considerable usage ··· 17 15 the future could be supported. 18 16 19 17 20 - 0. Notes 21 - -------- 18 + Notes 19 + ===== 20 + 22 21 The number of buttons/axes reported varies based on 3 things: 22 + 23 23 - if you are using a known controller 24 24 - if you are using a known dance pad 25 25 - if using an unknown device (one not listed below), what you set in the ··· 39 35 unknown controllers. 40 36 41 37 42 - 0.1 Normal Controllers 43 - ---------------------- 38 + Normal Controllers 39 + ------------------ 40 + 44 41 With a normal controller, the directional pad is mapped to its own X/Y axes. 45 42 The jstest-program from joystick-1.2.15 (jstest-version 2.1.0) will report 8 46 43 axes and 10 buttons. ··· 60 55 play first person shooters with a pad. Your mileage may vary. 61 56 62 57 63 - 0.2 Xbox Dance Pads 64 - ------------------- 58 + Xbox Dance Pads 59 + --------------- 60 + 65 61 When using a known dance pad, jstest will report 6 axes and 14 buttons. 66 62 67 63 For dance style pads (like the redoctane pad) several changes ··· 79 73 I've tested this with Stepmania, and it works quite well. 80 74 81 75 82 - 0.3 Unknown Controllers 83 - ---------------------- 76 + Unknown Controllers 77 + ------------------- 78 + 84 79 If you have an unknown xbox controller, it should work just fine with 85 80 the default settings. 86 81 ··· 95 88 box in the future. 96 89 97 90 98 - 1. USB adapters 99 - -------------- 91 + USB adapters 92 + ============ 93 + 100 94 All generations of Xbox controllers speak USB over the wire. 95 + 101 96 - Original Xbox controllers use a proprietary connector and require adapters. 102 97 - Wireless Xbox 360 controllers require a 'Xbox 360 Wireless Gaming Receiver 103 98 for Windows' ··· 110 101 111 102 112 103 113 - 1.1 Original Xbox USB adapters 114 - -------------- 104 + Original Xbox USB adapters 105 + -------------------------- 106 + 115 107 Using this driver with an Original Xbox controller requires an 116 108 adapter cable to break out the proprietary connector's pins to USB. 117 109 You can buy these online fairly cheap, or build your own. ··· 133 123 134 124 135 125 136 - 2. Driver Installation 137 - ---------------------- 126 + Driver Installation 127 + =================== 138 128 139 129 Once you have the adapter cable, if needed, and the controller connected 140 130 the xpad module should be auto loaded. To confirm you can cat ··· 142 132 143 133 144 134 145 - 3. Supported Controllers 146 - ------------------------ 135 + Supported Controllers 136 + ===================== 137 + 147 138 For a full list of supported controllers and associated vendor and product 148 139 IDs see the xpad_device[] array[6]. 149 140 150 141 As of the historic version 0.0.6 (2006-10-10) the following devices 151 - were supported: 142 + were supported:: 143 + 152 144 original Microsoft XBOX controller (US), vendor=0x045e, product=0x0202 153 145 smaller Microsoft XBOX controller (US), vendor=0x045e, product=0x0289 154 146 original Microsoft XBOX controller (Japan), vendor=0x045e, product=0x0285 ··· 164 152 If you have an unrecognized controller please see 0.3 - Unknown Controllers 165 153 166 154 167 - 4. Manual Testing 168 - ----------------- 155 + Manual Testing 156 + ============== 157 + 169 158 To test this driver's functionality you may use 'jstest'. 170 159 171 - For example: 172 - > modprobe xpad 173 - > modprobe joydev 174 - > jstest /dev/js0 160 + For example:: 161 + 162 + > modprobe xpad 163 + > modprobe joydev 164 + > jstest /dev/js0 175 165 176 166 If you're using a normal controller, there should be a single line showing 177 167 18 inputs (8 axes, 10 buttons), and its values should change if you move ··· 184 170 185 171 186 172 187 - 5. Thanks 188 - --------- 173 + Thanks 174 + ====== 189 175 190 176 I have to thank ITO Takayuki for the detailed info on his site 191 - http://euc.jp/periphs/xbox-controller.ja.html. 192 - 177 + http://euc.jp/periphs/xbox-controller.ja.html. 178 + 193 179 His useful info and both the usb-skeleton as well as the iforce input driver 194 180 (Greg Kroah-Hartmann; Vojtech Pavlik) helped a lot in rapid prototyping 195 181 the basic functionality. 196 182 197 183 198 184 199 - 6. References 200 - ------------- 185 + References 186 + ========== 201 187 202 188 [1]: http://euc.jp/periphs/xbox-controller.ja.html (ITO Takayuki) 189 + 203 190 [2]: http://xpad.xbox-scene.com/ 191 + 204 192 [3]: http://www.markosweb.com/www/xboxhackz.com/ 205 - [4]: /proc/bus/usb/devices - dump from InterAct PowerPad Pro (Germany): 206 193 207 - T: Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#= 5 Spd=12 MxCh= 0 208 - D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs= 1 209 - P: Vendor=05fd ProdID=107a Rev= 1.00 210 - C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA 211 - I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none) 212 - E: Ad=81(I) Atr=03(Int.) MxPS= 32 Ivl= 10ms 213 - E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl= 10ms 194 + [4]: /proc/bus/usb/devices - dump from InterAct PowerPad Pro (Germany):: 214 195 215 - [5]: /proc/bus/usb/devices - dump from Redoctane Xbox Dance Pad (US): 196 + T: Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#= 5 Spd=12 MxCh= 0 197 + D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs= 1 198 + P: Vendor=05fd ProdID=107a Rev= 1.00 199 + C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA 200 + I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none) 201 + E: Ad=81(I) Atr=03(Int.) MxPS= 32 Ivl= 10ms 202 + E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl= 10ms 216 203 217 - T: Bus=01 Lev=02 Prnt=09 Port=00 Cnt=01 Dev#= 10 Spd=12 MxCh= 0 218 - D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 219 - P: Vendor=0c12 ProdID=8809 Rev= 0.01 220 - S: Product=XBOX DDR 221 - C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA 222 - I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=xpad 223 - E: Ad=82(I) Atr=03(Int.) MxPS= 32 Ivl=4ms 224 - E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl=4ms 204 + [5]: /proc/bus/usb/devices - dump from Redoctane Xbox Dance Pad (US):: 205 + 206 + T: Bus=01 Lev=02 Prnt=09 Port=00 Cnt=01 Dev#= 10 Spd=12 MxCh= 0 207 + D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 208 + P: Vendor=0c12 ProdID=8809 Rev= 0.01 209 + S: Product=XBOX DDR 210 + C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA 211 + I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=xpad 212 + E: Ad=82(I) Atr=03(Int.) MxPS= 32 Ivl=4ms 213 + E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl=4ms 225 214 226 215 [6]: http://lxr.free-electrons.com/ident?i=xpad_device 227 216 228 217 229 218 230 - 7. Historic Edits 231 - ----------------- 232 - Marko Friedemann <mfr@bmx-chemnitz.de> 233 - 2002-07-16 219 + Historic Edits 220 + ============== 221 + 222 + 2002-07-16 - Marko Friedemann <mfr@bmx-chemnitz.de> 234 223 - original doc 235 224 236 - Dominic Cerquetti <binary1230@yahoo.com> 237 - 2005-03-19 225 + 2005-03-19 - Dominic Cerquetti <binary1230@yahoo.com> 238 226 - added stuff for dance pads, new d-pad->axes mappings 239 227 240 228 Later changes may be viewed with 'git log Documentation/input/xpad.txt'

Configure Feed

Configure Feed