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 05, 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 will be the basis of the future 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" "CardBus" "RT2561S"
  72 .It Em Card Ta Em Bus Ta Em MAC/BBP
  73 .It Li "A-Link WL54H" Ta PCI Ta RT2560
  74 .It Li "A-Link WL54PC" Ta CardBus Ta RT2560
  75 .It Li "Amigo AWI-914W" Ta CardBus Ta RT2560
  76 .It Li "Amigo AWI-922W" Ta mini-PCI Ta RT2560
  77 .It Li "Amigo AWI-926W" Ta PCI Ta RT2560
  78 .It Li "AMIT WL531C" Ta CardBus Ta RT2560
  79 .It Li "AMIT WL531P" Ta PCI Ta RT2560
  80 .It Li "AOpen AOI-831" Ta PCI Ta RT2560
  81 .It Li "ASUS WL-107G" Ta CardBus Ta RT2560
  82 .It Li "ASUS WL-130g" Ta PCI Ta RT2560
  83 .It Li "Atlantis Land A02-PCI-W54" Ta PCI Ta RT2560
  84 .It Li "Atlantis Land A02-PCM-W54" Ta CardBus Ta RT2560
  85 .It Li "Belkin F5D7000 v3" Ta PCI Ta RT2560
  86 .It Li "Belkin F5D7010 v2" Ta CardBus Ta RT2560
  87 .It Li "Billionton MIWLGRL" Ta mini-PCI Ta RT2560
  88 .It Li "Canyon CN-WF511" Ta PCI Ta RT2560
  89 .It Li "Canyon CN-WF513" Ta CardBus Ta RT2560
  90 .It Li "CC&C WL-2102" Ta CardBus Ta RT2560
  91 .It Li "CNet CWC-854" Ta CardBus Ta RT2560
  92 .It Li "CNet CWP-854" Ta PCI Ta RT2560
  93 .It Li "Compex WL54G" Ta CardBus Ta RT2560
  94 .It Li "Compex WLP54G" Ta PCI Ta RT2560
  95 .It Li "Conceptronic C54RC" Ta CardBus Ta RT2560
  96 .It Li "Conceptronic C54Ri" Ta PCI Ta RT2560
  97 .It Li "Digitus DN-7001G-RA" Ta CardBus Ta RT2560
  98 .It Li "Digitus DN-7006G-RA" Ta PCI Ta RT2560
  99 .It Li "E-Tech WGPC02" Ta CardBus Ta RT2560
 100 .It Li "E-Tech WGPI02" Ta PCI Ta RT2560
 101 .It Li "Edimax EW-7108PCg" Ta CardBus Ta RT2560
 102 .It Li "Edimax EW-7128g" Ta PCI Ta RT2560
 103 .It Li "Eminent EM3036" Ta CardBus Ta RT2560
 104 .It Li "Eminent EM3037" Ta PCI Ta RT2560
 105 .It Li "Encore ENLWI-G-RLAM" Ta PCI Ta RT2560
 106 .It Li "Encore ENPWI-G-RLAM" Ta CardBus Ta RT2560
 107 .It Li "Fiberline WL-400P" Ta PCI Ta RT2560
 108 .It Li "Fibreline WL-400X" Ta CardBus Ta RT2560
 109 .It Li "Gigabyte GN-WIKG" Ta mini-PCI Ta RT2560
 110 .It Li "Gigabyte GN-WMKG" Ta CardBus Ta RT2560
 111 .It Li "Gigabyte GN-WPKG" Ta PCI Ta RT2560
 112 .It Li "Hawking HWC54GR" Ta CardBus Ta RT2560
 113 .It Li "Hawking HWP54GR" Ta PCI Ta RT2560
 114 .It Li "iNexQ CR054g-009 (R03)" Ta PCI Ta RT2560
 115 .It Li "JAHT WN-4054P" Ta CardBus Ta RT2560
 116 .It Li "JAHT WN-4054PCI" Ta PCI Ta RT2560
 117 .It Li "LevelOne WNC-0301 v2" Ta PCI Ta RT2560
 118 .It Li "LevelOne WPC-0301 v2" Ta CardBus Ta RT2560
 119 .It Li "Linksys WMP54G v4" Ta PCI Ta RT2560
 120 .It Li "Micronet SP906GK" Ta PCI Ta RT2560
 121 .It Li "Micronet SP908GK V3" Ta CardBus Ta RT2560
 122 .It Li "Minitar MN54GCB-R" Ta CardBus Ta RT2560
 123 .It Li "Minitar MN54GPC-R" Ta PCI Ta RT2560
 124 .It Li "MSI CB54G2" Ta CardBus Ta RT2560
 125 .It Li "MSI MP54G2" Ta mini-PCI Ta RT2560
 126 .It Li "MSI PC54G2" Ta PCI Ta RT2560
 127 .It Li "OvisLink EVO-W54PCI" Ta PCI Ta RT2560
 128 .It Li "PheeNet HWL-PCIG/RA" Ta PCI Ta RT2560
 129 .It Li "Pro-Nets CB80211G" Ta CardBus Ta RT2560
 130 .It Li "Pro-Nets PC80211G" Ta PCI Ta RT2560
 131 .It Li "Repotec RP-WB7108" Ta CardBus Ta RT2560
 132 .It Li "Repotec RP-WP0854" Ta PCI Ta RT2560
 133 .It Li "SATech SN-54C" Ta CardBus Ta RT2560
 134 .It Li "SATech SN-54P" Ta PCI Ta RT2560
 135 .It Li "Sitecom WL-112" Ta CardBus Ta RT2560
 136 .It Li "Sitecom WL-115" Ta PCI Ta RT2560
 137 .It Li "SparkLAN WL-685R" Ta CardBus Ta RT2560
 138 .It Li "Surecom EP-9321-g" Ta PCI Ta RT2560
 139 .It Li "Surecom EP-9321-g1" Ta PCI Ta RT2560
 140 .It Li "Surecom EP-9428-g" Ta CardBus Ta RT2560
 141 .It Li "Sweex LC500050" Ta CardBus Ta RT2560
 142 .It Li "Sweex LC700030" Ta PCI Ta RT2560
 143 .It Li "TekComm NE-9321-g" Ta PCI Ta RT2560
 144 .It Li "TekComm NE-9428-g" Ta CardBus Ta RT2560
 145 .It Li "Unex CR054g-R02" Ta PCI Ta RT2560
 146 .It Li "Unex MR054g-R02" Ta CardBus Ta RT2560
 147 .It Li "Zinwell ZWX-G160" Ta CardBus Ta RT2560
 148 .It Li "Zinwell ZWX-G360" Ta mini-PCI Ta RT2560
 149 .It Li "Zinwell ZWX-G361" Ta PCI Ta RT2560
 150 .It Li "Zonet ZEW1500" Ta CardBus Ta RT2560
 151 .It Li "Zonet ZEW1600" Ta PCI Ta RT2560
 152 .El
 153 .Pp
 154 An up to date list can be found at
 155 .Pa http://damien.bergamini.free.fr/ral/list.html .
 156 .Sh EXAMPLES
 157 Join an existing BSS network (i.e., connect to an access point):
 158 .Pp
 159 .Dl "ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00"
 160 .Pp
 161 Join a specific BSS network with network name
 162 .Dq Li my_net :
 163 .Pp
 164 .Dl "ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 165 .Pp
 166 Join a specific BSS network with 40-bit WEP encryption:
 167 .Bd -literal -offset indent
 168 ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 169     wepmode on wepkey 0x1234567890 weptxkey 1
 170 .Ed
 171 .Pp
 172 Join a specific BSS network with 104-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 0x01020304050607080910111213 weptxkey 1
 176 .Ed
 177 .Sh DIAGNOSTICS
 178 .Bl -diag
 179 .It "ral%d: could not load 8051 microcode"
 180 An error occurred while attempting to upload the microcode to the onboard 8051
 181 microcontroller unit.
 182 .It "ral%d: timeout waiting for MCU to initialize"
 183 The onboard 8051 microcontroller unit failed to initialize in time.
 184 .It "ral%d: device timeout"
 185 A frame dispatched to the hardware for transmission did not complete in time.
 186 The driver will reset the hardware.
 187 This should not happen.
 188 .El
 189 .Sh SEE ALSO
 190 .Xr arp 4 ,
 191 .Xr cardbus 4 ,
 192 .Xr netintro 4 ,
 193 .Xr pci 4 ,
 194 .Xr wlan 4 ,
 195 .Xr ifconfig 8
 196 .Rs
 197 .%T "Ralink Technology"
 198 .%O http://www.ralinktech.com/
 199 .Re
 200 .Sh HISTORY
 201 The
 202 .Nm
 203 driver first appeared in
 204 .Ox 3.7 .
 205 .Sh CAVEATS
 206 PCI
 207 .Nm
 208 adapters seem to require a PCI 2.2 compliant motherboard and will likely not
 209 work with PCI 2.1 only motherboard.
 210 .Pp
 211 The
 212 .Nm
 213 driver does not implement frame aggregation.
 214 .Sh AUTHORS
 215 The
 216 .Nm
 217 driver was written by
 218 .An Damien Bergamini Aq damien@FreeBSD.org .