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 January 29, 2006
  19 .Os
  20 .Dt RAL 4
  21 .Sh NAME
  22 .Nm ral
  23 .Nd "Ralink Technology RT2500 IEEE 802.11 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 RT2500
  43 chipset.
  44 .Pp
  45 The RT2500 chipset consists of two integrated chips, a RT2560 MAC/BBP and a
  46 radio transceiver (the model of which depends on the card revision).
  47 .Pp
  48 The RT2522, RT2523, RT2524, RT2525, RT2525e and RT2526 radio transceivers
  49 operate in the 2.4GHz band (802.11b/g) whereas the RT5222 is a dual-band radio
  50 transceiver that can operate in the 2.4GHz and 5.2GHz bands (802.11a).
  51 .Pp
  52 The transmit speed is user-selectable or can be adapted automatically by the
  53 driver depending on the received-signal strength and the number of transmission
  54 retries.
  55 .Sh HARDWARE
  56 The
  57 .Nm
  58 driver supports the following adapters:
  59 .Pp
  60 .Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "Bus"
  61 .It Em Card Ta Em Bus
  62 .It Li "A-Link WL54H" Ta PCI
  63 .It Li "A-Link WL54PC" Ta CardBus
  64 .It Li "Amigo AWI-914W" Ta CardBus
  65 .It Li "Amigo AWI-922W" Ta mini-PCI
  66 .It Li "Amigo AWI-926W" Ta PCI
  67 .It Li "AMIT WL531C" Ta CardBus
  68 .It Li "AMIT WL531P" Ta PCI
  69 .It Li "AOpen AOI-831" Ta PCI
  70 .It Li "ASUS WL-107G" Ta CardBus
  71 .It Li "ASUS WL-130g" Ta PCI
  72 .It Li "Atlantis Land A02-PCI-W54" Ta PCI
  73 .It Li "Atlantis Land A02-PCM-W54" Ta CardBus
  74 .It Li "Belkin F5D7000 v3" Ta PCI
  75 .It Li "Belkin F5D7010 v2" Ta CardBus
  76 .It Li "Billionton MIWLGRL" Ta mini-PCI
  77 .It Li "Canyon CN-WF511" Ta PCI
  78 .It Li "Canyon CN-WF513" Ta CardBus
  79 .It Li "CC&C WL-2102" Ta CardBus
  80 .It Li "CNet CWC-854" Ta CardBus
  81 .It Li "CNet CWP-854" Ta PCI
  82 .It Li "Compex WL54G" Ta CardBus
  83 .It Li "Compex WLP54G" Ta PCI
  84 .It Li "Conceptronic C54RC" Ta CardBus
  85 .It Li "Conceptronic C54Ri" Ta PCI
  86 .It Li "Digitus DN-7001G-RA" Ta CardBus
  87 .It Li "Digitus DN-7006G-RA" Ta PCI
  88 .It Li "E-Tech WGPC02" Ta CardBus
  89 .It Li "E-Tech WGPI02" Ta PCI
  90 .It Li "Edimax EW-7108PCg" Ta CardBus
  91 .It Li "Edimax EW-7128g" Ta PCI
  92 .It Li "Eminent EM3036" Ta CardBus
  93 .It Li "Eminent EM3037" Ta PCI
  94 .It Li "Encore ENLWI-G-RLAM" Ta PCI
  95 .It Li "Encore ENPWI-G-RLAM" Ta CardBus
  96 .It Li "Fiberline WL-400P" Ta PCI
  97 .It Li "Fibreline WL-400X" Ta CardBus
  98 .It Li "Gigabyte GN-WIKG" Ta mini-PCI
  99 .It Li "Gigabyte GN-WMKG" Ta CardBus
 100 .It Li "Gigabyte GN-WPKG" Ta PCI
 101 .It Li "Hawking HWC54GR" Ta CardBus
 102 .It Li "Hawking HWP54GR" Ta PCI
 103 .It Li "iNexQ CR054g-009 (R03)" Ta PCI
 104 .It Li "JAHT WN-4054P" Ta CardBus
 105 .It Li "JAHT WN-4054PCI" Ta PCI
 106 .It Li "LevelOne WNC-0301 v2" Ta PCI
 107 .It Li "LevelOne WPC-0301 v2" Ta CardBus
 108 .It Li "Linksys WMP54G v4" Ta PCI
 109 .It Li "Micronet SP906GK" Ta PCI
 110 .It Li "Micronet SP908GK V3" Ta CardBus
 111 .It Li "Minitar MN54GCB-R" Ta CardBus
 112 .It Li "Minitar MN54GPC-R" Ta PCI
 113 .It Li "MSI CB54G2" Ta CardBus
 114 .It Li "MSI MP54G2" Ta mini-PCI
 115 .It Li "MSI PC54G2" Ta PCI
 116 .It Li "OvisLink EVO-W54PCI" Ta PCI
 117 .It Li "PheeNet HWL-PCIG/RA" Ta PCI
 118 .It Li "Pro-Nets CB80211G" Ta CardBus
 119 .It Li "Pro-Nets PC80211G" Ta PCI
 120 .It Li "Repotec RP-WB7108" Ta CardBus
 121 .It Li "Repotec RP-WP0854" Ta PCI
 122 .It Li "SATech SN-54C" Ta CardBus
 123 .It Li "SATech SN-54P" Ta PCI
 124 .It Li "Sitecom WL-112" Ta CardBus
 125 .It Li "Sitecom WL-115" Ta PCI
 126 .It Li "SparkLAN WL-685R" Ta CardBus
 127 .It Li "Surecom EP-9321-g" Ta PCI
 128 .It Li "Surecom EP-9321-g1" Ta PCI
 129 .It Li "Surecom EP-9428-g" Ta CardBus
 130 .It Li "Sweex LC500050" Ta CardBus
 131 .It Li "Sweex LC700030" Ta PCI
 132 .It Li "TekComm NE-9321-g" Ta PCI
 133 .It Li "TekComm NE-9428-g" Ta CardBus
 134 .It Li "Unex CR054g-R02" Ta PCI
 135 .It Li "Unex MR054g-R02" Ta CardBus
 136 .It Li "Zinwell ZWX-G160" Ta CardBus
 137 .It Li "Zinwell ZWX-G360" Ta mini-PCI
 138 .It Li "Zinwell ZWX-G361" Ta PCI
 139 .It Li "Zonet ZEW1500" Ta CardBus
 140 .It Li "Zonet ZEW1600" Ta PCI
 141 .El
 142 .Pp
 143 An up to date list can be found at
 144 .Pa http://damien.bergamini.free.fr/ral/list.html .
 145 .Sh EXAMPLES
 146 Join an existing BSS network (i.e., connect to an access point):
 147 .Pp
 148 .Dl "ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00"
 149 .Pp
 150 Join a specific BSS network with network name
 151 .Dq Li my_net :
 152 .Pp
 153 .Dl "ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 154 .Pp
 155 Join a specific BSS network with 40-bit WEP encryption:
 156 .Bd -literal -offset indent
 157 ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 158     wepmode on wepkey 0x1234567890 weptxkey 1
 159 .Ed
 160 .Pp
 161 Join a specific BSS network with 104-bit WEP encryption:
 162 .Bd -literal -offset indent
 163 ifconfig ral0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 164     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 165 .Ed
 166 .Sh DIAGNOSTICS
 167 .Bl -diag
 168 .It "ral%d: device timeout"
 169 The driver will reset the hardware.
 170 This should not happen.
 171 .El
 172 .Sh SEE ALSO
 173 .Xr arp 4 ,
 174 .Xr cardbus 4 ,
 175 .Xr netintro 4 ,
 176 .Xr pci 4 ,
 177 .Xr wlan 4 ,
 178 .Xr ifconfig 8
 179 .Rs
 180 .%T "Ralink Technology"
 181 .%O http://www.ralinktech.com/
 182 .Re
 183 .Sh HISTORY
 184 The
 185 .Nm
 186 driver first appeared in
 187 .Ox 3.7 .
 188 .Sh CAVEATS
 189 PCI
 190 .Nm
 191 adapters seem to require a PCI 2.2 compliant motherboard and will likely not
 192 work with PCI 2.1 only motherboard.
 193 .Sh AUTHORS
 194 The
 195 .Nm
 196 driver was written by
 197 .An Damien Bergamini Aq damien@FreeBSD.org .