xref: /freebsd/share/man/man4/ral.4 (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f) 
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 April 13, 2008
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
25To compile this driver into the kernel,
26place the following lines in your
27kernel configuration file:
28.Bd -ragged -offset indent
29.Cd "device ral"
30.Cd "device ralfw"
31.Cd "device wlan"
32.Cd "device wlan_amrr"
33.Cd "device firmware"
34.Ed
35.Pp
36Alternatively, to load the driver as a
37module at boot time, place the following line in
38.Xr loader.conf 5 :
39.Bd -literal -offset indent
40if_ral_load="YES"
41.Ed
42.Sh DESCRIPTION
43The
44.Nm
45driver supports PCI/CardBus wireless adapters based on the Ralink Technology
46RT2500, RT2501, and RT2600 chipsets.
47.Pp
48The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink.
49It consists of two integrated chips, a RT2560 MAC/BBP and a RT2525 radio
50transceiver.
51.Pp
52The RT2501 chipset is the second generation of 802.11b/g adapters from Ralink.
53It consists of two integrated chips, a RT2561 MAC/BBP and a RT2527 radio
54transceiver.
55This chipset provides support for the IEEE 802.11e standard with multiple
56hardware transmission queues and allows scatter/gather for efficient DMA
57operations.
58.Pp
59The RT2600 chipset consists of two integrated chips, a RT2661 MAC/BBP and a
60RT2529 radio transceiver.
61This chipset uses the MIMO (multiple-input multiple-output) technology with
62multiple antennas to extend the operating range of the adapter and to achieve
63higher throughput.
64MIMO is the basis of the forthcoming IEEE 802.11n standard.
65.Pp
66The transmit speed is user-selectable or can be adapted automatically by the
67driver depending on the received signal strength and on the number of hardware
68transmission retries.
69.Pp
70.Nm
71supports
72.Cm station ,
73.Cm adhoc ,
74.Cm hostap ,
75.Cm wds ,
76and
77.Cm monitor
78mode operation.
79Only one
80.Cm hostap
81virtual interface may be configured at a time.
82Any number of
83.Cm wds
84virtual interfaces may be configured together with a
85.Cm hostap
86interface.
87Multiple
88.Cm station
89interfaces may be operated together with a
90.Cm hostap
91interface to construct a wireless repeater device.
92For more information on configuring this device, see
93.Xr ifconfig 8 .
94.Sh HARDWARE
95The
96.Nm
97driver supports PCI/CardBus wireless adapters based on the Ralink Technology
98RT2500, RT2501, and RT2600 chipsets, including:
99.Pp
100.Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "RT2561S" "CardBus"
101.It Em Card Ta Em MAC/BBP Ta Em Bus
102.It "A-Link WL54H" Ta RT2560 Ta PCI
103.It "A-Link WL54PC" Ta RT2560 Ta CardBus
104.It "AirLink101 AWLC5025" Ta RT2661 Ta CardBus
105.It "AirLink101 AWLH5025" Ta RT2661 Ta PCI
106.It "Amigo AWI-914W" Ta RT2560 Ta CardBus
107.It "Amigo AWI-922W" Ta RT2560 Ta mini-PCI
108.It "Amigo AWI-926W" Ta RT2560 Ta PCI
109.It "AMIT WL531C" Ta RT2560 Ta CardBus
110.It "AMIT WL531P" Ta RT2560 Ta PCI
111.It "AOpen AOI-831" Ta RT2560 Ta PCI
112.It "ASUS WL-107G" Ta RT2560 Ta CardBus
113.It "ASUS WL-130g" Ta RT2560 Ta PCI
114.It "Atlantis Land A02-PCI-W54" Ta RT2560 Ta PCI
115.It "Atlantis Land A02-PCM-W54" Ta RT2560 Ta CardBus
116.It "Belkin F5D7000 v3" Ta RT2560 Ta PCI
117.It "Belkin F5D7010 v2" Ta RT2560 Ta CardBus
118.It "Billionton MIWLGRL" Ta RT2560 Ta mini-PCI
119.It "Canyon CN-WF511" Ta RT2560 Ta PCI
120.It "Canyon CN-WF513" Ta RT2560 Ta CardBus
121.It "CC&C WL-2102" Ta RT2560 Ta CardBus
122.It "CNet CWC-854" Ta RT2560 Ta CardBus
123.It "CNet CWP-854" Ta RT2560 Ta PCI
124.It "Compex WL54G" Ta RT2560 Ta CardBus
125.It "Compex WLP54G" Ta RT2560 Ta PCI
126.It "Conceptronic C54RC" Ta RT2560 Ta CardBus
127.It "Conceptronic C54Ri" Ta RT2560 Ta PCI
128.It "Digitus DN-7001G-RA" Ta RT2560 Ta CardBus
129.It "Digitus DN-7006G-RA" Ta RT2560 Ta PCI
130.It "E-Tech WGPC02" Ta RT2560 Ta CardBus
131.It "E-Tech WGPI02" Ta RT2560 Ta PCI
132.It "Edimax EW-7108PCg" Ta RT2560 Ta CardBus
133.It "Edimax EW-7128g" Ta RT2560 Ta PCI
134.It "Eminent EM3036" Ta RT2560 Ta CardBus
135.It "Eminent EM3037" Ta RT2560 Ta PCI
136.It "Encore ENLWI-G-RLAM" Ta RT2560 Ta PCI
137.It "Encore ENPWI-G-RLAM" Ta RT2560 Ta CardBus
138.It "Fiberline WL-400P" Ta RT2560 Ta PCI
139.It "Fibreline WL-400X" Ta RT2560 Ta CardBus
140.It "Gigabyte GN-WI01GS" Ta RT2561S Ta mini-PCI
141.It "Gigabyte GN-WIKG" Ta RT2560 Ta mini-PCI
142.It "Gigabyte GN-WMKG" Ta RT2560 Ta CardBus
143.It "Gigabyte GN-WP01GS" Ta RT2561S Ta PCI
144.It "Gigabyte GN-WPKG" Ta RT2560 Ta PCI
145.It "Hawking HWC54GR" Ta RT2560 Ta CardBus
146.It "Hawking HWP54GR" Ta RT2560 Ta PCI
147.It "iNexQ CR054g-009 (R03)" Ta RT2560 Ta PCI
148.It "JAHT WN-4054P" Ta RT2560 Ta CardBus
149.It "JAHT WN-4054PCI" Ta RT2560 Ta PCI
150.It "LevelOne WNC-0301 v2" Ta RT2560 Ta PCI
151.It "LevelOne WPC-0301 v2" Ta RT2560 Ta CardBus
152.It "Linksys WMP54G v4" Ta RT2560 Ta PCI
153.It "Micronet SP906GK" Ta RT2560 Ta PCI
154.It "Micronet SP908GK V3" Ta RT2560 Ta CardBus
155.It "Minitar MN54GCB-R" Ta RT2560 Ta CardBus
156.It "Minitar MN54GPC-R" Ta RT2560 Ta PCI
157.It "MSI CB54G2" Ta RT2560 Ta CardBus
158.It "MSI MP54G2" Ta RT2560 Ta mini-PCI
159.It "MSI PC54G2" Ta RT2560 Ta PCI
160.It "OvisLink EVO-W54PCI" Ta RT2560 Ta PCI
161.It "PheeNet HWL-PCIG/RA" Ta RT2560 Ta PCI
162.It "Pro-Nets CB80211G" Ta RT2560 Ta CardBus
163.It "Pro-Nets PC80211G" Ta RT2560 Ta PCI
164.It "Repotec RP-WB7108" Ta RT2560 Ta CardBus
165.It "Repotec RP-WP0854" Ta RT2560 Ta PCI
166.It "SATech SN-54C" Ta RT2560 Ta CardBus
167.It "SATech SN-54P" Ta RT2560 Ta PCI
168.It "Sitecom WL-112" Ta RT2560 Ta CardBus
169.It "Sitecom WL-115" Ta RT2560 Ta PCI
170.It "SMC SMCWCB-GM" Ta RT2661 Ta CardBus
171.It "SMC SMCWPCI-GM" Ta RT2661 Ta PCI
172.It "SparkLAN WL-685R" Ta RT2560 Ta CardBus
173.It "Surecom EP-9321-g" Ta RT2560 Ta PCI
174.It "Surecom EP-9321-g1" Ta RT2560 Ta PCI
175.It "Surecom EP-9428-g" Ta RT2560 Ta CardBus
176.It "Sweex LC500050" Ta RT2560 Ta CardBus
177.It "Sweex LC700030" Ta RT2560 Ta PCI
178.It "TekComm NE-9321-g" Ta RT2560 Ta PCI
179.It "TekComm NE-9428-g" Ta RT2560 Ta CardBus
180.It "Unex CR054g-R02" Ta RT2560 Ta PCI
181.It "Unex MR054g-R02" Ta RT2560 Ta CardBus
182.It "Zinwell ZWX-G160" Ta RT2560 Ta CardBus
183.It "Zinwell ZWX-G360" Ta RT2560 Ta mini-PCI
184.It "Zinwell ZWX-G361" Ta RT2560 Ta PCI
185.It "Zonet ZEW1500" Ta RT2560 Ta CardBus
186.It "Zonet ZEW1600" Ta RT2560 Ta PCI
187.El
188.Pp
189An up to date list can be found at
190.Pa http://damien.bergamini.free.fr/ral/list.html .
191.Sh EXAMPLES
192Join an existing BSS network (i.e., connect to an access point):
193.Pp
194.Dl "ifconfig wlan create wlandev ral0 inet 192.168.0.20 netmask 0xffffff00"
195.Pp
196Join a specific BSS network with network name
197.Dq Li my_net :
198.Pp
199.Bd -literal -offset indent
200ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
201    netmask 0xffffff00 ssid my_net
202.Ed
203.Pp
204Join a specific BSS network with 40-bit WEP encryption:
205.Bd -literal -offset indent
206ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
207    netmask 0xffffff00 ssid my_net \e
208    wepmode on wepkey 0x1234567890 weptxkey 1
209.Ed
210.Pp
211Join a specific BSS network with 104-bit WEP encryption:
212.Bd -literal -offset indent
213ifconfig wlan create wlandev ral0 inet 192.168.0.20 \e
214    netmask 0xffffff00 ssid my_net \e
215    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
216.Ed
217.Sh DIAGNOSTICS
218.Bl -diag
219.It "ral%d: could not load 8051 microcode"
220An error occurred while attempting to upload the microcode to the onboard 8051
221microcontroller unit.
222.It "ral%d: timeout waiting for MCU to initialize"
223The onboard 8051 microcontroller unit failed to initialize in time.
224.It "ral%d: device timeout"
225A frame dispatched to the hardware for transmission did not complete in time.
226The driver will reset the hardware.
227This should not happen.
228.El
229.Sh SEE ALSO
230.Xr intro 4 ,
231.Xr cardbus 4 ,
232.Xr wlan 4 ,
233.Xr wlan_ccmp 4 ,
234.Xr wlan_tkip 4 ,
235.Xr wlan_wep 4 ,
236.Xr wlan_xauth 4 ,
237.Xr hostapd 8 ,
238.Xr ifconfig 8 ,
239.Xr wpa_supplicant 8 .
240.Rs
241.%T "Ralink Technology"
242.%O http://www.ralinktech.com/
243.Re
244.Sh HISTORY
245The
246.Nm
247driver first appeared in
248.Ox 3.7 .
249.Sh AUTHORS
250The original
251.Nm
252driver was written by
253.An Damien Bergamini Aq damien@FreeBSD.org .
254