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