diff options
Diffstat (limited to 'share/man/man4/ral.4')
-rw-r--r-- | share/man/man4/ral.4 | 253 |
1 files changed, 253 insertions, 0 deletions
diff --git a/share/man/man4/ral.4 b/share/man/man4/ral.4 new file mode 100644 index 000000000000..be641239e6d2 --- /dev/null +++ b/share/man/man4/ral.4 @@ -0,0 +1,253 @@ +.\" Copyright (c) 2005, 2006 +.\" Damien Bergamini <damien.bergamini@free.fr> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" $FreeBSD$ +.\" +.Dd April 13, 2008 +.Os +.Dt RAL 4 +.Sh NAME +.Nm ral +.Nd "Ralink Technology IEEE 802.11 wireless network driver" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device ral" +.Cd "device ralfw" +.Cd "device wlan" +.Cd "device wlan_amrr" +.Cd "device firmware" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_ral_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver supports PCI/CardBus wireless adapters based on the Ralink Technology +RT2500, RT2501, and RT2600 chipsets. +.Pp +The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink. +It consists of two integrated chips, a RT2560 MAC/BBP and a RT2525 radio +transceiver. +.Pp +The RT2501 chipset is the second generation of 802.11b/g adapters from Ralink. +It consists of two integrated chips, a RT2561 MAC/BBP and a RT2527 radio +transceiver. +This chipset provides support for the IEEE 802.11e standard with multiple +hardware transmission queues and allows scatter/gather for efficient DMA +operations. +.Pp +The RT2600 chipset consists of two integrated chips, a RT2661 MAC/BBP and a +RT2529 radio transceiver. +This chipset uses the MIMO (multiple-input multiple-output) technology with +multiple antennas to extend the operating range of the adapter and to achieve +higher throughput. +MIMO is the basis of the forthcoming IEEE 802.11n standard. +.Pp +The transmit speed is user-selectable or can be adapted automatically by the +driver depending on the received signal strength and on the number of hardware +transmission retries. +.Pp +.Nm +supports +.Cm station , +.Cm adhoc , +.Cm hostap , +.Cm wds , +and +.Cm monitor +mode operation. +Only one +.Cm hostap +virtual interface may be configured at a time. +Any number of +.Cm wds +virtual interfaces may be configured together with a +.Cm hostap +interface. +Multiple +.Cm station +interfaces may be operated together with a +.Cm hostap +interface to construct a wireless repeater device. +For more information on configuring this device, see +.Xr ifconfig 8 . +.Sh HARDWARE +The +.Nm +driver supports PCI/CardBus wireless adapters based on the Ralink Technology +RT2500, RT2501, and RT2600 chipsets, including: +.Pp +.Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "RT2561S" "CardBus" +.It Em Card Ta Em MAC/BBP Ta Em Bus +.It "A-Link WL54H" Ta RT2560 Ta PCI +.It "A-Link WL54PC" Ta RT2560 Ta CardBus +.It "AirLink101 AWLC5025" Ta RT2661 Ta CardBus +.It "AirLink101 AWLH5025" Ta RT2661 Ta PCI +.It "Amigo AWI-914W" Ta RT2560 Ta CardBus +.It "Amigo AWI-922W" Ta RT2560 Ta mini-PCI +.It "Amigo AWI-926W" Ta RT2560 Ta PCI +.It "AMIT WL531C" Ta RT2560 Ta CardBus +.It "AMIT WL531P" Ta RT2560 Ta PCI +.It "AOpen AOI-831" Ta RT2560 Ta PCI +.It "ASUS WL-107G" Ta RT2560 Ta CardBus +.It "ASUS WL-130g" Ta RT2560 Ta PCI +.It "Atlantis Land A02-PCI-W54" Ta RT2560 Ta PCI +.It "Atlantis Land A02-PCM-W54" Ta RT2560 Ta CardBus +.It "Belkin F5D7000 v3" Ta RT2560 Ta PCI +.It "Belkin F5D7010 v2" Ta RT2560 Ta CardBus +.It "Billionton MIWLGRL" Ta RT2560 Ta mini-PCI +.It "Canyon CN-WF511" Ta RT2560 Ta PCI +.It "Canyon CN-WF513" Ta RT2560 Ta CardBus +.It "CC&C WL-2102" Ta RT2560 Ta CardBus +.It "CNet CWC-854" Ta RT2560 Ta CardBus +.It "CNet CWP-854" Ta RT2560 Ta PCI +.It "Compex WL54G" Ta RT2560 Ta CardBus +.It "Compex WLP54G" Ta RT2560 Ta PCI +.It "Conceptronic C54RC" Ta RT2560 Ta CardBus +.It "Conceptronic C54Ri" Ta RT2560 Ta PCI +.It "Digitus DN-7001G-RA" Ta RT2560 Ta CardBus +.It "Digitus DN-7006G-RA" Ta RT2560 Ta PCI +.It "E-Tech WGPC02" Ta RT2560 Ta CardBus +.It "E-Tech WGPI02" Ta RT2560 Ta PCI +.It "Edimax EW-7108PCg" Ta RT2560 Ta CardBus +.It "Edimax EW-7128g" Ta RT2560 Ta PCI +.It "Eminent EM3036" Ta RT2560 Ta CardBus +.It "Eminent EM3037" Ta RT2560 Ta PCI +.It "Encore ENLWI-G-RLAM" Ta RT2560 Ta PCI +.It "Encore ENPWI-G-RLAM" Ta RT2560 Ta CardBus +.It "Fiberline WL-400P" Ta RT2560 Ta PCI +.It "Fibreline WL-400X" Ta RT2560 Ta CardBus +.It "Gigabyte GN-WI01GS" Ta RT2561S Ta mini-PCI +.It "Gigabyte GN-WIKG" Ta RT2560 Ta mini-PCI +.It "Gigabyte GN-WMKG" Ta RT2560 Ta CardBus +.It "Gigabyte GN-WP01GS" Ta RT2561S Ta PCI +.It "Gigabyte GN-WPKG" Ta RT2560 Ta PCI +.It "Hawking HWC54GR" Ta RT2560 Ta CardBus +.It "Hawking HWP54GR" Ta RT2560 Ta PCI +.It "iNexQ CR054g-009 (R03)" Ta RT2560 Ta PCI +.It "JAHT WN-4054P" Ta RT2560 Ta CardBus +.It "JAHT WN-4054PCI" Ta RT2560 Ta PCI +.It "LevelOne WNC-0301 v2" Ta RT2560 Ta PCI +.It "LevelOne WPC-0301 v2" Ta RT2560 Ta CardBus +.It "Linksys WMP54G v4" Ta RT2560 Ta PCI +.It "Micronet SP906GK" Ta RT2560 Ta PCI +.It "Micronet SP908GK V3" Ta RT2560 Ta CardBus +.It "Minitar MN54GCB-R" Ta RT2560 Ta CardBus +.It "Minitar MN54GPC-R" Ta RT2560 Ta PCI +.It "MSI CB54G2" Ta RT2560 Ta CardBus +.It "MSI MP54G2" Ta RT2560 Ta mini-PCI +.It "MSI PC54G2" Ta RT2560 Ta PCI +.It "OvisLink EVO-W54PCI" Ta RT2560 Ta PCI +.It "PheeNet HWL-PCIG/RA" Ta RT2560 Ta PCI +.It "Pro-Nets CB80211G" Ta RT2560 Ta CardBus +.It "Pro-Nets PC80211G" Ta RT2560 Ta PCI +.It "Repotec RP-WB7108" Ta RT2560 Ta CardBus +.It "Repotec RP-WP0854" Ta RT2560 Ta PCI +.It "SATech SN-54C" Ta RT2560 Ta CardBus +.It "SATech SN-54P" Ta RT2560 Ta PCI +.It "Sitecom WL-112" Ta RT2560 Ta CardBus +.It "Sitecom WL-115" Ta RT2560 Ta PCI +.It "SMC SMCWCB-GM" Ta RT2661 Ta CardBus +.It "SMC SMCWPCI-GM" Ta RT2661 Ta PCI +.It "SparkLAN WL-685R" Ta RT2560 Ta CardBus +.It "Surecom EP-9321-g" Ta RT2560 Ta PCI +.It "Surecom EP-9321-g1" Ta RT2560 Ta PCI +.It "Surecom EP-9428-g" Ta RT2560 Ta CardBus +.It "Sweex LC500050" Ta RT2560 Ta CardBus +.It "Sweex LC700030" Ta RT2560 Ta PCI +.It "TekComm NE-9321-g" Ta RT2560 Ta PCI +.It "TekComm NE-9428-g" Ta RT2560 Ta CardBus +.It "Unex CR054g-R02" Ta RT2560 Ta PCI +.It "Unex MR054g-R02" Ta RT2560 Ta CardBus +.It "Zinwell ZWX-G160" Ta RT2560 Ta CardBus +.It "Zinwell ZWX-G360" Ta RT2560 Ta mini-PCI +.It "Zinwell ZWX-G361" Ta RT2560 Ta PCI +.It "Zonet ZEW1500" Ta RT2560 Ta CardBus +.It "Zonet ZEW1600" Ta RT2560 Ta PCI +.El +.Pp +An up to date list can be found at +.Pa http://damien.bergamini.free.fr/ral/list.html . +.Sh EXAMPLES +Join an existing BSS network (i.e., connect to an access point): +.Pp +.Dl "ifconfig wlan create wlandev ral0 inet 192.168.0.20 netmask 0xffffff00" +.Pp +Join a specific BSS network with network name +.Dq Li my_net : +.Pp +.Bd -literal -offset indent +ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e + netmask 0xffffff00 ssid my_net +.Ed +.Pp +Join a specific BSS network with 40-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e + netmask 0xffffff00 ssid my_net \e + wepmode on wepkey 0x1234567890 weptxkey 1 +.Ed +.Pp +Join a specific BSS network with 104-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e + netmask 0xffffff00 ssid my_net \e + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 +.Ed +.Sh DIAGNOSTICS +.Bl -diag +.It "ral%d: could not load 8051 microcode" +An error occurred while attempting to upload the microcode to the onboard 8051 +microcontroller unit. +.It "ral%d: timeout waiting for MCU to initialize" +The onboard 8051 microcontroller unit failed to initialize in time. +.It "ral%d: device timeout" +A frame dispatched to the hardware for transmission did not complete in time. +The driver will reset the hardware. +This should not happen. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr cardbus 4 , +.Xr wlan 4 , +.Xr wlan_ccmp 4 , +.Xr wlan_tkip 4 , +.Xr wlan_wep 4 , +.Xr wlan_xauth 4 , +.Xr hostapd 8 , +.Xr ifconfig 8 , +.Xr wpa_supplicant 8 . +.Rs +.%T "Ralink Technology" +.%O http://www.ralinktech.com/ +.Re +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.7 . +.Sh AUTHORS +The original +.Nm +driver was written by +.An Damien Bergamini Aq damien@FreeBSD.org . |