share/man/man4/ral.4

   1 .\" Copyright (c) 2005, 2006
   2 .\"     Damien Bergamini <damien.bergamini@free.fr>
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $FreeBSD$
  17 .\"
  18 .Dd March 5, 2006
  19 .Os
  20 .Dt RAL 4
  21 .Sh NAME
  22 .Nm ral
  23 .Nd "Ralink Technology IEEE 802.11 wireless network driver"
  24 .Sh SYNOPSIS
  25 To compile this driver into the kernel,
  26 place the following lines in your
  27 kernel configuration file:
  28 .Bd -ragged -offset indent
  29 .Cd "device ral"
  30 .Cd "device wlan"
  31 .Ed
  32 .Pp
  33 Alternatively, to load the driver as a
  34 module at boot time, place the following line in
  35 .Xr loader.conf 5 :
  36 .Bd -literal -offset indent
  37 if_ral_load="YES"
  38 .Ed
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver supports PCI/CardBus wireless adapters based on the Ralink Technology
  43 RT2500, RT2501, and RT2600 chipsets.
  44 .Pp
  45 The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink.
  46 It consists of two integrated chips, a RT2560 MAC/BBP and a RT2525 radio
  47 transceiver.
  48 .Pp
  49 The RT2501 chipset is the second generation of 802.11b/g adapters from Ralink.
  50 It consists of two integrated chips, a RT2561 MAC/BBP and a RT2527 radio
  51 transceiver.
  52 This chipset provides support for the IEEE 802.11e standard with multiple
  53 hardware transmission queues and allows scatter/gather for efficient DMA
  54 operations.
  55 .Pp
  56 The RT2600 chipset consists of two integrated chips, a RT2661 MAC/BBP and a
  57 RT2529 radio transceiver.
  58 This chipset uses the MIMO (multiple-input multiple-output) technology with
  59 multiple antennas to extend the operating range of the adapter and to achieve
  60 higher throughput.
  61 MIMO is the basis of the forthcoming IEEE 802.11n standard.
  62 .Pp
  63 The transmit speed is user-selectable or can be adapted automatically by the
  64 driver depending on the received signal strength and on the number of hardware
  65 transmission retries.
  66 .Sh HARDWARE
  67 The
  68 .Nm
  69 driver supports the following adapters:
  70 .Pp
  71 .Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "RT2561S" "CardBus"
  72 .It Em Card Ta Em MAC/BBP Ta Em Bus
  73 .It Li "A-Link WL54H" Ta RT2560 Ta PCI
  74 .It Li "A-Link WL54PC" Ta RT2560 Ta CardBus
  75 .It Li "AirLink101 AWLC5025" Ta RT2661 Ta CardBus
  76 .It Li "AirLink101 AWLH5025" Ta RT2661 Ta PCI
  77 .It Li "Amigo AWI-914W" Ta RT2560 Ta CardBus
  78 .It Li "Amigo AWI-922W" Ta RT2560 Ta mini-PCI
  79 .It Li "Amigo AWI-926W" Ta RT2560 Ta PCI
  80 .It Li "AMIT WL531C" Ta RT2560 Ta CardBus
  81 .It Li "AMIT WL531P" Ta RT2560 Ta PCI
  82 .It Li "AOpen AOI-831" Ta RT2560 Ta PCI
  83 .It Li "ASUS WL-107G" Ta RT2560 Ta CardBus
  84 .It Li "ASUS WL-130g" Ta RT2560 Ta PCI
  85 .It Li "Atlantis Land A02-PCI-W54" Ta RT2560 Ta PCI
  86 .It Li "Atlantis Land A02-PCM-W54" Ta RT2560 Ta CardBus
  87 .It Li "Belkin F5D7000 v3" Ta RT2560 Ta PCI
  88 .It Li "Belkin F5D7010 v2" Ta RT2560 Ta CardBus
  89 .It Li "Billionton MIWLGRL" Ta RT2560 Ta mini-PCI
  90 .It Li "Canyon CN-WF511" Ta RT2560 Ta PCI
  91 .It Li "Canyon CN-WF513" Ta RT2560 Ta CardBus
  92 .It Li "CC&C WL-2102" Ta RT2560 Ta CardBus
  93 .It Li "CNet CWC-854" Ta RT2560 Ta CardBus
  94 .It Li "CNet CWP-854" Ta RT2560 Ta PCI
  95 .It Li "Compex WL54G" Ta RT2560 Ta CardBus
  96 .It Li "Compex WLP54G" Ta RT2560 Ta PCI
  97 .It Li "Conceptronic C54RC" Ta RT2560 Ta CardBus
  98 .It Li "Conceptronic C54Ri" Ta RT2560 Ta PCI
  99 .It Li "Digitus DN-7001G-RA" Ta RT2560 Ta CardBus
 100 .It Li "Digitus DN-7006G-RA" Ta RT2560 Ta PCI
 101 .It Li "E-Tech WGPC02" Ta RT2560 Ta CardBus
 102 .It Li "E-Tech WGPI02" Ta RT2560 Ta PCI
 103 .It Li "Edimax EW-7108PCg" Ta RT2560 Ta CardBus
 104 .It Li "Edimax EW-7128g" Ta RT2560 Ta PCI
 105 .It Li "Eminent EM3036" Ta RT2560 Ta CardBus
 106 .It Li "Eminent EM3037" Ta RT2560 Ta PCI
 107 .It Li "Encore ENLWI-G-RLAM" Ta RT2560 Ta PCI
 108 .It Li "Encore ENPWI-G-RLAM" Ta RT2560 Ta CardBus
 109 .It Li "Fiberline WL-400P" Ta RT2560 Ta PCI
 110 .It Li "Fibreline WL-400X" Ta RT2560 Ta CardBus
 111 .It Li "Gigabyte GN-WI01GS" Ta RT2561S Ta mini-PCI
 112 .It Li "Gigabyte GN-WIKG" Ta RT2560 Ta mini-PCI
 113 .It Li "Gigabyte GN-WMKG" Ta RT2560 Ta CardBus
 114 .It Li "Gigabyte GN-WP01GS" Ta RT2561S Ta PCI
 115 .It Li "Gigabyte GN-WPKG" Ta RT2560 Ta PCI
 116 .It Li "Hawking HWC54GR" Ta RT2560 Ta CardBus
 117 .It Li "Hawking HWP54GR" Ta RT2560 Ta PCI
 118 .It Li "iNexQ CR054g-009 (R03)" Ta RT2560 Ta PCI
 119 .It Li "JAHT WN-4054P" Ta RT2560 Ta CardBus
 120 .It Li "JAHT WN-4054PCI" Ta RT2560 Ta PCI
 121 .It Li "LevelOne WNC-0301 v2" Ta RT2560 Ta PCI
 122 .It Li "LevelOne WPC-0301 v2" Ta RT2560 Ta CardBus
 123 .It Li "Linksys WMP54G v4" Ta RT2560 Ta PCI
 124 .It Li "Micronet SP906GK" Ta RT2560 Ta PCI
 125 .It Li "Micronet SP908GK V3" Ta RT2560 Ta CardBus
 126 .It Li "Minitar MN54GCB-R" Ta RT2560 Ta CardBus
 127 .It Li "Minitar MN54GPC-R" Ta RT2560 Ta PCI
 128 .It Li "MSI CB54G2" Ta RT2560 Ta CardBus
 129 .It Li "MSI MP54G2" Ta RT2560 Ta mini-PCI
 130 .It Li "MSI PC54G2" Ta RT2560 Ta PCI
 131 .It Li "OvisLink EVO-W54PCI" Ta RT2560 Ta PCI
 132 .It Li "PheeNet HWL-PCIG/RA" Ta RT2560 Ta PCI
 133 .It Li "Pro-Nets CB80211G" Ta RT2560 Ta CardBus
 134 .It Li "Pro-Nets PC80211G" Ta RT2560 Ta PCI
 135 .It Li "Repotec RP-WB7108" Ta RT2560 Ta CardBus
 136 .It Li "Repotec RP-WP0854" Ta RT2560 Ta PCI
 137 .It Li "SATech SN-54C" Ta RT2560 Ta CardBus
 138 .It Li "SATech SN-54P" Ta RT2560 Ta PCI
 139 .It Li "Sitecom WL-112" Ta RT2560 Ta CardBus
 140 .It Li "Sitecom WL-115" Ta RT2560 Ta PCI
 141 .It Li "SMC SMCWCB-GM" Ta RT2661 Ta CardBus
 142 .It Li "SMC SMCWPCI-GM" Ta RT2661 Ta PCI
 143 .It Li "SparkLAN WL-685R" Ta RT2560 Ta CardBus
 144 .It Li "Surecom EP-9321-g" Ta RT2560 Ta PCI
 145 .It Li "Surecom EP-9321-g1" Ta RT2560 Ta PCI
 146 .It Li "Surecom EP-9428-g" Ta RT2560 Ta CardBus
 147 .It Li "Sweex LC500050" Ta RT2560 Ta CardBus
 148 .It Li "Sweex LC700030" Ta RT2560 Ta PCI
 149 .It Li "TekComm NE-9321-g" Ta RT2560 Ta PCI
 150 .It Li "TekComm NE-9428-g" Ta RT2560 Ta CardBus
 151 .It Li "Unex CR054g-R02" Ta RT2560 Ta PCI
 152 .It Li "Unex MR054g-R02" Ta RT2560 Ta CardBus
 153 .It Li "Zinwell ZWX-G160" Ta RT2560 Ta CardBus
 154 .It Li "Zinwell ZWX-G360" Ta RT2560 Ta mini-PCI
 155 .It Li "Zinwell ZWX-G361" Ta RT2560 Ta PCI
 156 .It Li "Zonet ZEW1500" Ta RT2560 Ta CardBus
 157 .It Li "Zonet ZEW1600" Ta RT2560 Ta PCI
 158 .El
 159 .Pp
 160 An up to date list can be found at
 161 .Pa http://damien.bergamini.free.fr/ral/list.html .
 162 .Sh EXAMPLES
 163 Join an existing BSS network (i.e., connect to an access point):
 164 .Pp
 165 .Dl "ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00"
 166 .Pp
 167 Join a specific BSS network with network name
 168 .Dq Li my_net :
 169 .Pp
 170 .Dl "ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 171 .Pp
 172 Join a specific BSS network with 40-bit WEP encryption:
 173 .Bd -literal -offset indent
 174 ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 175     wepmode on wepkey 0x1234567890 weptxkey 1
 176 .Ed
 177 .Pp
 178 Join a specific BSS network with 104-bit WEP encryption:
 179 .Bd -literal -offset indent
 180 ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 181     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 182 .Ed
 183 .Sh DIAGNOSTICS
 184 .Bl -diag
 185 .It "ral%d: could not load 8051 microcode"
 186 An error occurred while attempting to upload the microcode to the onboard 8051
 187 microcontroller unit.
 188 .It "ral%d: timeout waiting for MCU to initialize"
 189 The onboard 8051 microcontroller unit failed to initialize in time.
 190 .It "ral%d: device timeout"
 191 A frame dispatched to the hardware for transmission did not complete in time.
 192 The driver will reset the hardware.
 193 This should not happen.
 194 .El
 195 .Sh SEE ALSO
 196 .Xr altq 4 ,
 197 .Xr arp 4 ,
 198 .Xr cardbus 4 ,
 199 .Xr netintro 4 ,
 200 .Xr pci 4 ,
 201 .Xr wlan 4 ,
 202 .Xr ifconfig 8
 203 .Rs
 204 .%T "Ralink Technology"
 205 .%O http://www.ralinktech.com/
 206 .Re
 207 .Sh HISTORY
 208 The
 209 .Nm
 210 driver first appeared in
 211 .Ox 3.7 .
 212 .Sh CAVEATS
 213 PCI
 214 .Nm
 215 adapters seem to require a PCI 2.2 compliant motherboard and will likely not
 216 work with PCI 2.1 only motherboard.
 217 .Pp
 218 The
 219 .Nm
 220 driver does not implement frame aggregation.
 221 .Sh AUTHORS
 222 The
 223 .Nm
 224 driver was written by
 225 .An Damien Bergamini Aq damien@FreeBSD.org .