share/man/man4/ral.4

   1 .\" Copyright (c) 2005-2010 Damien Bergamini <damien.bergamini@free.fr>
   2 .\"
   3 .\" Permission to use, copy, modify, and distribute this software for any
   4 .\" purpose with or without fee is hereby granted, provided that the above
   5 .\" copyright notice and this permission notice appear in all copies.
   6 .\"
   7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  14 .\"
  15 .\" $FreeBSD$
  16 .\"
  17 .Dd May 10, 2012
  18 .Dt RAL 4
  19 .Os
  20 .Sh NAME
  21 .Nm ral
  22 .Nd "Ralink Technology IEEE 802.11a/g/n wireless network device"
  23 .Sh SYNOPSIS
  24 To compile this driver into the kernel,
  25 place the following lines in your
  26 kernel configuration file:
  27 .Bd -ragged -offset indent
  28 .Cd "device ral"
  29 .Cd "device ralfw"
  30 .Cd "device wlan"
  31 .Cd "device wlan_amrr"
  32 .Cd "device firmware"
  33 .Ed
  34 .Pp
  35 Alternatively, to load the driver as a
  36 module at boot time, place the following line in
  37 .Xr loader.conf 5 :
  38 .Bd -literal -offset indent
  39 if_ral_load="YES"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver supports PCI/PCIe/CardBus wireless adapters based on the Ralink RT2500,
  45 RT2501, RT2600, RT2700, RT2800 and RT3090 chipsets.
  46 .Pp
  47 The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink.
  48 It consists of two integrated chips, an RT2560 MAC/BBP and an RT2525 radio
  49 transceiver.
  50 .Pp
  51 The RT2501 chipset is the second generation of 802.11a/b/g adapters from
  52 Ralink.
  53 It consists of two integrated chips, an RT2561 MAC/BBP and an RT2527 radio
  54 transceiver.
  55 This chipset provides support for the IEEE 802.11e standard with multiple
  56 hardware transmission queues and allows scatter/gather for efficient DMA
  57 operations.
  58 .Pp
  59 The RT2600 chipset consists of two integrated chips, an RT2661 MAC/BBP and an
  60 RT2529 radio transceiver.
  61 This chipset uses the MIMO (multiple-input multiple-output) technology with
  62 multiple radio transceivers to extend the operating range of the adapter and
  63 to achieve higher throughput.
  64 However, the RT2600 chipset does not support any of the 802.11n features.
  65 .Pp
  66 The RT2700 chipset is a low-cost version of the RT2800 chipset.
  67 It supports a single transmit path and two receiver paths (1T2R).
  68 It consists of two integrated chips, an RT2760 or RT2790 (PCIe) MAC/BBP and
  69 an RT2720 (2.4GHz) or RT2750 (2.4GHz/5GHz) radio transceiver.
  70 .Pp
  71 The RT2800 chipset is the first generation of 802.11n adapters from Ralink.
  72 It consists of two integrated chips, an RT2860 or RT2890 (PCIe) MAC/BBP and
  73 an RT2820 (2.4GHz) or RT2850 (2.4GHz/5GHz) radio transceiver.
  74 The RT2800 chipset supports two transmit paths and up to three receiver
  75 paths (2T2R/2T3R).
  76 It can achieve speeds up to 144Mbps (20MHz bandwidth) and 300Mbps (40MHz
  77 bandwidth.)
  78 .Pp
  79 The RT3090 chipset is the first generation of single-chip 802.11n adapters
  80 from Ralink.
  81 .Nm
  82 supports
  83 .Cm station ,
  84 .Cm adhoc ,
  85 .Cm hostap ,
  86 .Cm mesh ,
  87 .Cm wds ,
  88 and
  89 .Cm monitor
  90 mode operation.
  91 Only one
  92 .Cm hostap
  93 or
  94 .Cm mesh
  95 virtual interface may be configured at a time.
  96 Any number of
  97 .Cm wds
  98 virtual interfaces may be configured together with a
  99 .Cm hostap
 100 interface.
 101 Multiple
 102 .Cm station
 103 interfaces may be operated together with a
 104 .Cm hostap
 105 interface to construct a wireless repeater device.
 106 .Pp
 107 The transmit speed is user-selectable or can be adapted automatically by the
 108 driver depending on the number of hardware transmission retries.
 109 For more information on configuring this device, see
 110 .Xr ifconfig 8 .
 111 .Sh HARDWARE
 112 The
 113 .Nm
 114 driver supports PCI/PCIe/CardBus wireless adapters based on Ralink Technology
 115 chipsets, including:
 116 .Pp
 117 .Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "RT2561S" "CardBus"
 118 .It Em Card Ta Em MAC/BBP Ta Em Bus
 119 .It "A-Link WL54H" Ta RT2560 Ta PCI
 120 .It "A-Link WL54PC" Ta RT2560 Ta CardBus
 121 .It "AirLink101 AWLC5025" Ta RT2661 Ta CardBus
 122 .It "AirLink101 AWLH5025" Ta RT2661 Ta PCI
 123 .It "Amigo AWI-914W" Ta RT2560 Ta CardBus
 124 .It "Amigo AWI-922W" Ta RT2560 Ta mini-PCI
 125 .It "Amigo AWI-926W" Ta RT2560 Ta PCI
 126 .It "AMIT WL531C" Ta RT2560 Ta CardBus
 127 .It "AMIT WL531P" Ta RT2560 Ta PCI
 128 .It "AOpen AOI-831" Ta RT2560 Ta PCI
 129 .It "ASUS WL-107G" Ta RT2560 Ta CardBus
 130 .It "ASUS WL-130g" Ta RT2560 Ta PCI
 131 .It "Atlantis Land A02-PCI-W54" Ta RT2560 Ta PCI
 132 .It "Atlantis Land A02-PCM-W54" Ta RT2560 Ta CardBus
 133 .It "Belkin F5D7000 v3" Ta RT2560 Ta PCI
 134 .It "Belkin F5D7010 v2" Ta RT2560 Ta CardBus
 135 .It "Billionton MIWLGRL" Ta RT2560 Ta mini-PCI
 136 .It "Canyon CN-WF511" Ta RT2560 Ta PCI
 137 .It "Canyon CN-WF513" Ta RT2560 Ta CardBus
 138 .It "CC&C WL-2102" Ta RT2560 Ta CardBus
 139 .It "CNet CWC-854" Ta RT2560 Ta CardBus
 140 .It "CNet CWP-854" Ta RT2560 Ta PCI
 141 .It "Compex WL54G" Ta RT2560 Ta CardBus
 142 .It "Compex WLP54G" Ta RT2560 Ta PCI
 143 .It "Conceptronic C54RC" Ta RT2560 Ta CardBus
 144 .It "Conceptronic C54Ri" Ta RT2560 Ta PCI
 145 .It "Digitus DN-7001G-RA" Ta RT2560 Ta CardBus
 146 .It "Digitus DN-7006G-RA" Ta RT2560 Ta PCI
 147 .It "E-Tech WGPC02" Ta RT2560 Ta CardBus
 148 .It "E-Tech WGPI02" Ta RT2560 Ta PCI
 149 .It "Edimax EW-7108PCg" Ta RT2560 Ta CardBus
 150 .It "Edimax EW-7128g" Ta RT2560 Ta PCI
 151 .It "Eminent EM3036" Ta RT2560 Ta CardBus
 152 .It "Eminent EM3037" Ta RT2560 Ta PCI
 153 .It "Encore ENLWI-G-RLAM" Ta RT2560 Ta PCI
 154 .It "Encore ENPWI-G-RLAM" Ta RT2560 Ta CardBus
 155 .It "Fiberline WL-400P" Ta RT2560 Ta PCI
 156 .It "Fibreline WL-400X" Ta RT2560 Ta CardBus
 157 .It "Gigabyte GN-WI01GS" Ta RT2561S Ta mini-PCI
 158 .It "Gigabyte GN-WIKG" Ta RT2560 Ta mini-PCI
 159 .It "Gigabyte GN-WMKG" Ta RT2560 Ta CardBus
 160 .It "Gigabyte GN-WP01GS" Ta RT2561S Ta PCI
 161 .It "Gigabyte GN-WPKG" Ta RT2560 Ta PCI
 162 .It "Hawking HWC54GR" Ta RT2560 Ta CardBus
 163 .It "Hawking HWP54GR" Ta RT2560 Ta PCI
 164 .It "iNexQ CR054g-009 (R03)" Ta RT2560 Ta PCI
 165 .It "JAHT WN-4054P" Ta RT2560 Ta CardBus
 166 .It "JAHT WN-4054PCI" Ta RT2560 Ta PCI
 167 .It "LevelOne WNC-0301 v2" Ta RT2560 Ta PCI
 168 .It "LevelOne WPC-0301 v2" Ta RT2560 Ta CardBus
 169 .It "Linksys WMP54G v4" Ta RT2560 Ta PCI
 170 .It "Micronet SP906GK" Ta RT2560 Ta PCI
 171 .It "Micronet SP908GK V3" Ta RT2560 Ta CardBus
 172 .It "Minitar MN54GCB-R" Ta RT2560 Ta CardBus
 173 .It "Minitar MN54GPC-R" Ta RT2560 Ta PCI
 174 .It "MSI CB54G2" Ta RT2560 Ta CardBus
 175 .It "MSI MP54G2" Ta RT2560 Ta mini-PCI
 176 .It "MSI PC54G2" Ta RT2560 Ta PCI
 177 .It "OvisLink EVO-W54PCI" Ta RT2560 Ta PCI
 178 .It "PheeNet HWL-PCIG/RA" Ta RT2560 Ta PCI
 179 .It "Pro-Nets CB80211G" Ta RT2560 Ta CardBus
 180 .It "Pro-Nets PC80211G" Ta RT2560 Ta PCI
 181 .It "Repotec RP-WB7108" Ta RT2560 Ta CardBus
 182 .It "Repotec RP-WP0854" Ta RT2560 Ta PCI
 183 .It "SATech SN-54C" Ta RT2560 Ta CardBus
 184 .It "SATech SN-54P" Ta RT2560 Ta PCI
 185 .It "Sitecom WL-112" Ta RT2560 Ta CardBus
 186 .It "Sitecom WL-115" Ta RT2560 Ta PCI
 187 .It "SMC SMCWCB-GM" Ta RT2661 Ta CardBus
 188 .It "SMC SMCWPCI-GM" Ta RT2661 Ta PCI
 189 .It "SparkLAN WL-685R" Ta RT2560 Ta CardBus
 190 .It "Surecom EP-9321-g" Ta RT2560 Ta PCI
 191 .It "Surecom EP-9321-g1" Ta RT2560 Ta PCI
 192 .It "Surecom EP-9428-g" Ta RT2560 Ta CardBus
 193 .It "Sweex LC500050" Ta RT2560 Ta CardBus
 194 .It "Sweex LC700030" Ta RT2560 Ta PCI
 195 .It "TekComm NE-9321-g" Ta RT2560 Ta PCI
 196 .It "TekComm NE-9428-g" Ta RT2560 Ta CardBus
 197 .It "Unex CR054g-R02" Ta RT2560 Ta PCI
 198 .It "Unex MR054g-R02" Ta RT2560 Ta CardBus
 199 .It "Zinwell ZWX-G160" Ta RT2560 Ta CardBus
 200 .It "Zinwell ZWX-G360" Ta RT2560 Ta mini-PCI
 201 .It "Zinwell ZWX-G361" Ta RT2560 Ta PCI
 202 .It "Zonet ZEW1500" Ta RT2560 Ta CardBus
 203 .It "Zonet ZEW1600" Ta RT2560 Ta PCI
 204 .El
 205 .Sh EXAMPLES
 206 Join an existing BSS network (i.e., connect to an access point):
 207 .Pp
 208 .Dl "ifconfig wlan create wlandev ral0 inet 192.168.0.20 netmask 0xffffff00"
 209 .Pp
 210 Join a specific BSS network with network name
 211 .Dq Li my_net :
 212 .Bd -literal -offset indent
 213 ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
 214     netmask 0xffffff00 ssid my_net
 215 .Ed
 216 .Pp
 217 Join a specific BSS network with 40-bit WEP encryption:
 218 .Bd -literal -offset indent
 219 ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
 220     netmask 0xffffff00 ssid my_net \e
 221     wepmode on wepkey 0x1234567890 weptxkey 1
 222 .Ed
 223 .Pp
 224 Join a specific BSS network with 104-bit WEP encryption:
 225 .Bd -literal -offset indent
 226 ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
 227     netmask 0xffffff00 ssid my_net \e
 228     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 229 .Ed
 230 .Sh DIAGNOSTICS
 231 .Bl -diag
 232 .It "ral%d: could not load 8051 microcode"
 233 An error occurred while attempting to upload the microcode to the onboard 8051
 234 microcontroller unit.
 235 .It "ral%d: timeout waiting for MCU to initialize"
 236 The onboard 8051 microcontroller unit failed to initialize in time.
 237 .It "ral%d: device timeout"
 238 A frame dispatched to the hardware for transmission did not complete in time.
 239 The driver will reset the hardware.
 240 This should not happen.
 241 .El
 242 .Sh SEE ALSO
 243 .Xr intro 4 ,
 244 .Xr cardbus 4 ,
 245 .Xr wlan 4 ,
 246 .Xr wlan_ccmp 4 ,
 247 .Xr wlan_tkip 4 ,
 248 .Xr wlan_wep 4 ,
 249 .Xr wlan_xauth 4 ,
 250 .Xr hostapd 8 ,
 251 .Xr ifconfig 8 ,
 252 .Xr wpa_supplicant 8
 253 .Rs
 254 .%T "Ralink Technology"
 255 .%U http://www.ralinktech.com/
 256 .Re
 257 .Sh HISTORY
 258 The
 259 .Nm
 260 driver first appeared in
 261 .Ox 3.7 .
 262 Support for the RT2501 and RT2600 chipsets was added in
 263 .Ox 3.9 .
 264 Support for the RT2800 chipset was added in
 265 .Ox 4.3 .
 266 Support for the RT2700 chipset was added in
 267 .Ox 4.4 .
 268 Support for the RT3090 chipset was added in
 269 .Ox 4.9 .
 270 .Sh AUTHORS
 271 The original
 272 .Nm
 273 driver was written by
 274 .An Damien Bergamini Aq damien@openbsd.org .
 275 .Sh CAVEATS
 276 The
 277 .Nm
 278 driver does not make use of the hardware cryptographic engine.
 279 .Pp
 280 The
 281 .Nm
 282 driver does not support any of the 802.11n capabilities offered by
 283 the RT2700 and RT2800 chipsets.
 284 Additional work is required in before those features can be supported.
 285 .Pp
 286 Host AP mode doesn't support power saving.
 287 Clients attempting to use power saving mode may experience significant
 288 packet loss (disabling power saving on the client will fix this).
 289 .Pp
 290 Some PCI
 291 .Nm
 292 adapters seem to strictly require a system supporting PCI 2.2 or greater and
 293 will likely not work in systems based on older revisions of the PCI
 294 specification.
 295 Check the board's PCI version before purchasing the card.