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: head/share/man/man4/ral.4 286290 2015-08-04 15:04:28Z kevlo $
  16 .\"
  17 .Dd May 26, 2016
  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, RT3090 and RT3900E 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 RT3900E chipset is a single-chip 802.11n adapters from Ralink.
 108 The MAC/Baseband Processor can be an RT5390 or RT5392.
 109 The RT5390 chip operates in the 2GHz spectrum and supports 1 transmit path
 110 and 1 receiver path (1T1R).
 111 The RT5392 chip operates in the 2GHz spectrum and supports up to 2 transmit
 112 paths and 2 receiver paths (2T2R).
 113 .Pp
 114 The transmit speed is user-selectable or can be adapted automatically by the
 115 driver depending on the number of hardware transmission retries.
 116 For more information on configuring this device, see
 117 .Xr ifconfig 8 .
 118 .Sh HARDWARE
 119 The
 120 .Nm
 121 driver supports PCI/PCIe/CardBus wireless adapters based on Ralink Technology
 122 chipsets, including:
 123 .Pp
 124 .Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "RT2561S" "CardBus"
 125 .It Em Card Ta Em MAC/BBP Ta Em Bus
 126 .It "A-Link WL54H" Ta RT2560 Ta PCI
 127 .It "A-Link WL54PC" Ta RT2560 Ta CardBus
 128 .It "AirLink101 AWLC5025" Ta RT2661 Ta CardBus
 129 .It "AirLink101 AWLH5025" Ta RT2661 Ta PCI
 130 .It "Amigo AWI-914W" Ta RT2560 Ta CardBus
 131 .It "Amigo AWI-922W" Ta RT2560 Ta mini-PCI
 132 .It "Amigo AWI-926W" Ta RT2560 Ta PCI
 133 .It "AMIT WL531C" Ta RT2560 Ta CardBus
 134 .It "AMIT WL531P" Ta RT2560 Ta PCI
 135 .It "AOpen AOI-831" Ta RT2560 Ta PCI
 136 .It "ASUS WL-107G" Ta RT2560 Ta CardBus
 137 .It "ASUS WL-130g" Ta RT2560 Ta PCI
 138 .It "Atlantis Land A02-PCI-W54" Ta RT2560 Ta PCI
 139 .It "Atlantis Land A02-PCM-W54" Ta RT2560 Ta CardBus
 140 .It "Belkin F5D7000 v3" Ta RT2560 Ta PCI
 141 .It "Belkin F5D7010 v2" Ta RT2560 Ta CardBus
 142 .It "Billionton MIWLGRL" Ta RT2560 Ta mini-PCI
 143 .It "Canyon CN-WF511" Ta RT2560 Ta PCI
 144 .It "Canyon CN-WF513" Ta RT2560 Ta CardBus
 145 .It "CC&C WL-2102" Ta RT2560 Ta CardBus
 146 .It "CNet CWC-854" Ta RT2560 Ta CardBus
 147 .It "CNet CWP-854" Ta RT2560 Ta PCI
 148 .It "Compex WL54G" Ta RT2560 Ta CardBus
 149 .It "Compex WLP54G" Ta RT2560 Ta PCI
 150 .It "Conceptronic C54RC" Ta RT2560 Ta CardBus
 151 .It "Conceptronic C54Ri" Ta RT2560 Ta PCI
 152 .It "D-Link DWA-525 rev A2" Ta RT5392 Ta PCI
 153 .It "Digitus DN-7001G-RA" Ta RT2560 Ta CardBus
 154 .It "Digitus DN-7006G-RA" Ta RT2560 Ta PCI
 155 .It "E-Tech WGPC02" Ta RT2560 Ta CardBus
 156 .It "E-Tech WGPI02" Ta RT2560 Ta PCI
 157 .It "Edimax EW-7108PCg" Ta RT2560 Ta CardBus
 158 .It "Edimax EW-7128g" Ta RT2560 Ta PCI
 159 .It "Eminent EM3036" Ta RT2560 Ta CardBus
 160 .It "Eminent EM3037" Ta RT2560 Ta PCI
 161 .It "Encore ENLWI-G-RLAM" Ta RT2560 Ta PCI
 162 .It "Encore ENPWI-G-RLAM" Ta RT2560 Ta CardBus
 163 .It "Fiberline WL-400P" Ta RT2560 Ta PCI
 164 .It "Fibreline WL-400X" Ta RT2560 Ta CardBus
 165 .It "Gigabyte GN-WI01GS" Ta RT2561S Ta mini-PCI
 166 .It "Gigabyte GN-WIKG" Ta RT2560 Ta mini-PCI
 167 .It "Gigabyte GN-WMKG" Ta RT2560 Ta CardBus
 168 .It "Gigabyte GN-WP01GS" Ta RT2561S Ta PCI
 169 .It "Gigabyte GN-WPKG" Ta RT2560 Ta PCI
 170 .It "Hawking HWC54GR" Ta RT2560 Ta CardBus
 171 .It "Hawking HWP54GR" Ta RT2560 Ta PCI
 172 .It "iNexQ CR054g-009 (R03)" Ta RT2560 Ta PCI
 173 .It "JAHT WN-4054P" Ta RT2560 Ta CardBus
 174 .It "JAHT WN-4054PCI" Ta RT2560 Ta PCI
 175 .It "LevelOne WNC-0301 v2" Ta RT2560 Ta PCI
 176 .It "LevelOne WPC-0301 v2" Ta RT2560 Ta CardBus
 177 .It "Linksys WMP54G v4" Ta RT2560 Ta PCI
 178 .It "Micronet SP906GK" Ta RT2560 Ta PCI
 179 .It "Micronet SP908GK V3" Ta RT2560 Ta CardBus
 180 .It "Minitar MN54GCB-R" Ta RT2560 Ta CardBus
 181 .It "Minitar MN54GPC-R" Ta RT2560 Ta PCI
 182 .It "MSI CB54G2" Ta RT2560 Ta CardBus
 183 .It "MSI MP54G2" Ta RT2560 Ta mini-PCI
 184 .It "MSI PC54G2" Ta RT2560 Ta PCI
 185 .It "OvisLink EVO-W54PCI" Ta RT2560 Ta PCI
 186 .It "PheeNet HWL-PCIG/RA" Ta RT2560 Ta PCI
 187 .It "Planex GW-NS300N" Ta RT2860 Ta CardBus
 188 .It "Pro-Nets CB80211G" Ta RT2560 Ta CardBus
 189 .It "Pro-Nets PC80211G" Ta RT2560 Ta PCI
 190 .It "Repotec RP-WB7108" Ta RT2560 Ta CardBus
 191 .It "Repotec RP-WP0854" Ta RT2560 Ta PCI
 192 .It "SATech SN-54C" Ta RT2560 Ta CardBus
 193 .It "SATech SN-54P" Ta RT2560 Ta PCI
 194 .It "Sitecom WL-112" Ta RT2560 Ta CardBus
 195 .It "Sitecom WL-115" Ta RT2560 Ta PCI
 196 .It "SMC SMCWCB-GM" Ta RT2661 Ta CardBus
 197 .It "SMC SMCWPCI-GM" Ta RT2661 Ta PCI
 198 .It "SparkLAN WL-685R" Ta RT2560 Ta CardBus
 199 .It "Surecom EP-9321-g" Ta RT2560 Ta PCI
 200 .It "Surecom EP-9321-g1" Ta RT2560 Ta PCI
 201 .It "Surecom EP-9428-g" Ta RT2560 Ta CardBus
 202 .It "Sweex LC500050" Ta RT2560 Ta CardBus
 203 .It "Sweex LC700030" Ta RT2560 Ta PCI
 204 .It "TekComm NE-9321-g" Ta RT2560 Ta PCI
 205 .It "TekComm NE-9428-g" Ta RT2560 Ta CardBus
 206 .It "Unex CR054g-R02" Ta RT2560 Ta PCI
 207 .It "Unex MR054g-R02" Ta RT2560 Ta CardBus
 208 .It "Zinwell ZWX-G160" Ta RT2560 Ta CardBus
 209 .It "Zinwell ZWX-G360" Ta RT2560 Ta mini-PCI
 210 .It "Zinwell ZWX-G361" Ta RT2560 Ta PCI
 211 .It "Zonet ZEW1500" Ta RT2560 Ta CardBus
 212 .It "Zonet ZEW1600" Ta RT2560 Ta PCI
 213 .El
 214 .Sh EXAMPLES
 215 Join an existing BSS network (i.e., connect to an access point):
 216 .Pp
 217 .Dl "ifconfig wlan create wlandev ral0 inet 192.168.0.20 netmask 0xffffff00"
 218 .Pp
 219 Join a specific BSS network with network name
 220 .Dq Li my_net :
 221 .Bd -literal -offset indent
 222 ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
 223     netmask 0xffffff00 ssid my_net
 224 .Ed
 225 .Pp
 226 Join a specific BSS network with 40-bit WEP encryption:
 227 .Bd -literal -offset indent
 228 ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
 229     netmask 0xffffff00 ssid my_net \e
 230     wepmode on wepkey 0x1234567890 weptxkey 1
 231 .Ed
 232 .Pp
 233 Join a specific BSS network with 104-bit WEP encryption:
 234 .Bd -literal -offset indent
 235 ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
 236     netmask 0xffffff00 ssid my_net \e
 237     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 238 .Ed
 239 .Sh DIAGNOSTICS
 240 .Bl -diag
 241 .It "ral%d: could not load 8051 microcode"
 242 An error occurred while attempting to upload the microcode to the onboard 8051
 243 microcontroller unit.
 244 .It "ral%d: timeout waiting for MCU to initialize"
 245 The onboard 8051 microcontroller unit failed to initialize in time.
 246 .It "ral%d: device timeout"
 247 A frame dispatched to the hardware for transmission did not complete in time.
 248 The driver will reset the hardware.
 249 This should not happen.
 250 .El
 251 .Sh SEE ALSO
 252 .Xr cardbus 4 ,
 253 .Xr ifmedia 4 ,
 254 .Xr intro 4 ,
 255 .Xr wlan 4 ,
 256 .Xr wlan_ccmp 4 ,
 257 .Xr wlan_tkip 4 ,
 258 .Xr wlan_wep 4 ,
 259 .Xr wlan_xauth 4 ,
 260 .Xr hostapd 8 ,
 261 .Xr ifconfig 8 ,
 262 .Xr wpa_supplicant 8 ,
 263 .Xr firmware 9
 264 .Rs
 265 .%T "Ralink Technology"
 266 .%U http://www.ralinktech.com/
 267 .Re
 268 .Sh HISTORY
 269 The
 270 .Nm
 271 driver first appeared in
 272 .Ox 3.7 .
 273 Support for the RT2501 and RT2600 chipsets was added in
 274 .Ox 3.9 .
 275 Support for the RT2800 chipset was added in
 276 .Ox 4.3 .
 277 Support for the RT2700 chipset was added in
 278 .Ox 4.4 .
 279 Support for the RT3090 chipset was added in
 280 .Ox 4.9 .
 281 .Sh AUTHORS
 282 The original
 283 .Nm
 284 driver was written by
 285 .An Damien Bergamini Aq Mt damien@openbsd.org .
 286 .Sh CAVEATS
 287 The
 288 .Nm
 289 driver does not make use of the hardware cryptographic engine.
 290 .Pp
 291 The
 292 .Nm
 293 driver does not support any of the 802.11n capabilities offered by
 294 the RT2700 and RT2800 chipsets.
 295 Additional work is required in before those features can be supported.
 296 .Pp
 297 Host AP mode doesn't support power saving.
 298 Clients attempting to use power saving mode may experience significant
 299 packet loss (disabling power saving on the client will fix this).
 300 .Pp
 301 Some PCI
 302 .Nm
 303 adapters seem to strictly require a system supporting PCI 2.2 or greater and
 304 will likely not work in systems based on older revisions of the PCI
 305 specification.
 306 Check the board's PCI version before purchasing the card.