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