xref: /openbsd-src/share/man/man4/ral.4 (revision 4b70baf6e17fc8b27fc1f7fa7929335753fa94c3)
1.\" $OpenBSD: ral.4,v 1.114 2019/03/29 07:07:05 jmc Exp $
2.\"
3.\" Copyright (c) 2005-2010 Damien Bergamini <damien.bergamini@free.fr>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 29 2019 $
18.Dt RAL 4
19.Os
20.Sh NAME
21.Nm ral
22.Nd Ralink Technology/MediaTek IEEE 802.11a/b/g/n wireless network device
23.Sh SYNOPSIS
24.Cd "ral* at cardbus?"
25.Cd "ral* at pci?"
26.Sh DESCRIPTION
27The
28.Nm
29driver supports PCI/PCIe/CardBus wireless adapters based on the Ralink RT2500,
30RT2501, RT2600, RT2700, RT2800, RT3090 and RT3900E chipsets.
31.Pp
32The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink.
33It consists of two integrated chips, an RT2560 MAC/BBP and an RT2525 radio
34transceiver.
35.Pp
36The RT2501 chipset is the second generation of 802.11a/b/g adapters from
37Ralink.
38It consists of two integrated chips, an RT2561 MAC/BBP and an RT2527 radio
39transceiver.
40This chipset provides support for the IEEE 802.11e standard with multiple
41hardware transmission queues and allows scatter/gather for efficient DMA
42operations.
43.Pp
44The RT2600 chipset consists of two integrated chips, an RT2661 MAC/BBP and an
45RT2529 radio transceiver.
46This chipset uses the MIMO (multiple-input multiple-output) technology with
47multiple radio transceivers to extend the operating range of the adapter and
48to achieve higher throughput.
49However, the RT2600 chipset does not support any of the 802.11n features.
50.Pp
51The RT2700 chipset is a low-cost version of the RT2800 chipset.
52It supports a single transmit path and two receiver paths (1T2R).
53It consists of two integrated chips, an RT2760 or RT2790 (PCIe) MAC/BBP and
54an RT2720 (2.4GHz) or RT2750 (2.4GHz/5GHz) radio transceiver.
55.Pp
56The RT2800 chipset is the first generation of 802.11n adapters from Ralink.
57It consists of two integrated chips, an RT2860 or RT2890 (PCIe) MAC/BBP and
58an RT2820 (2.4GHz) or RT2850 (2.4GHz/5GHz) radio transceiver.
59The RT2800 chipset supports two transmit paths and up to three receiver
60paths (2T2R/2T3R).
61It can achieve speeds up to 144Mbps (20MHz bandwidth) and 300Mbps (40MHz
62bandwidth.)
63.Pp
64The RT3090 chipset is the first generation of single-chip 802.11n adapters
65from Ralink.
66.Pp
67The RT3900E chipset is a single-chip 802.11n adapter from Ralink.
68The MAC/Baseband Processor can be an RT3290, RT5390 or RT5392.
69The RT3290 is a combo 802.11n and Bluetooth chip.
70It operates in the 2 Ghz spectrum and supports one transmit path and on one
71receiver path (1T1R).
72The RT5390 chip operates in the 2GHz spectrum and supports one transmit path
73and one receiver path (1T1R).
74The RT5392 chip operates in the 2GHz spectrum and supports up to two transmit
75paths and two receiver paths (2T2R).
76.Pp
77These are the modes the
78.Nm
79driver can operate in:
80.Bl -tag -width "IBSS-masterXX"
81.It BSS mode
82Also known as
83.Em infrastructure
84mode, this is used when associating with an access point, through
85which all traffic passes.
86This mode is the default.
87.It IBSS mode
88Also known as
89.Em IEEE ad-hoc
90mode or
91.Em peer-to-peer
92mode.
93This is the standardized method of operating without an access point.
94Stations associate with a service set.
95However, actual connections between stations are peer-to-peer.
96.It Host AP
97In this mode the driver acts as an access point (base station)
98for other cards.
99.It monitor mode
100In this mode the driver is able to receive packets without
101associating with an access point.
102This disables the internal receive filter and enables the card to
103capture packets from networks which it wouldn't normally have access to,
104or to scan for access points.
105.El
106.Pp
107The
108.Nm
109driver can be configured to use
110Wired Equivalent Privacy (WEP) or
111Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
112WPA is the current encryption standard for wireless networks.
113It is strongly recommended that WEP
114not be used as the sole mechanism
115to secure wireless communication,
116due to serious weaknesses in it.
117.Pp
118The
119.Nm
120driver relies on the software 802.11 stack for both encryption and
121decryption of data frames on the RT2500, RT2501 and RT2600 chipsets.
122On the RT2700 and RT2800 chipsets, the
123.Nm
124driver offloads both encryption and decryption of data frames to the
125hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
126.Pp
127The transmit speed is user-selectable or can be adapted automatically by the
128driver depending on the number of hardware transmission retries.
129.Pp
130In Host AP mode,
131devices with the RT2700, RT2800, RT3090, and RT3900E chipsets
132are compatible with clients using powersave.
133.Pp
134The
135.Nm
136driver can be configured at runtime with
137.Xr ifconfig 8
138or on boot with
139.Xr hostname.if 5 .
140.Sh FILES
141The RT2501, RT2600, RT2700 and RT2800 chipsets require the following firmware
142files to be loaded when an interface is brought up:
143.Pp
144.Bl -tag -width Ds -offset indent -compact
145.It /etc/firmware/ral-rt2561
146.It /etc/firmware/ral-rt2561s
147.It /etc/firmware/ral-rt2661
148.It /etc/firmware/ral-rt2860
149.It /etc/firmware/ral-rt3290
150.El
151.Pp
152The RT2500 chipset does not require a firmware file to operate.
153.Sh HARDWARE
154The following PCI adapters should work:
155.Bd -filled
156A-Link WL54H.
157AirLive WN-5000PCI.
158Amigo AWI-926W.
159AMIT WL531P.
160AOpen AOI-831.
161ASUS WL-130G.
162ASUS WL-130N.
163ASUS WIFI-G-AAY.
164Atlantis Land A02-PCI-W54.
165Belkin F5D7000 v3.
166Canyon CN-WF511.
167CNet CWP-854.
168Compex WLP54G.
169Conceptronic C54Ri.
170Corega CG-WLPCI54GL.
171D-Link DWA-525 rev A2.
172Digitus DN-7006G-RA.
173Dynalink WLG25PCI.
174E-Tech WGPI02.
175Edimax EW-7128g.
176Edimax EW-7628Ig.
177Edimax EW-7728In.
178Eminent EM3037.
179Encore ENLWI-G-RLAM.
180Eusso UGL2454-VPR.
181Fiberline WL-400P.
182Foxconn WLL-3350.
183Gigabyte GN-WPKG.
184Gigabyte GN-WP01GS.
185Gigabyte GN-WI02GM.
186Gigabyte GN-WP01GM.
187Hawking HWP54GR.
188Hercules HWGPCI-54.
189iNexQ CR054g-009 (R03).
190JAHT WN-4054PCI.
191KCORP LifeStyle KLS-660.
192LevelOne WNC-0301 v2.
193Linksys WMP54G v4.
194Longshine LCS-8031N.
195Micronet SP906GK.
196Minitar MN54GPC-R.
197MSI MS-6834.
198MSI PC54G2.
199OvisLink EVO-W54PCI.
200PheeNet HWL-PCIG/RA.
201Planex PCI-GW-DS300N.
202Pro-Nets PC80211G.
203Repotec RP-WP0854.
204SATech SN-54P.
205Signamax 065-1798.
206Sitecom WL-115.
207SparkLAN WL-660R.
208Surecom EP-9321-g.
209Surecom EP-9321-g1.
210Sweex LC700030.
211TekComm NE-9321-g.
212Tonze PC-6200C.
213Unex CR054g-R02.
214Zinwell ZWX-G361.
215Zonet ZEW1600.
216.Ed
217.Pp
218The following CardBus adapters should work:
219.Bd -filled
220A-Link WL54PC.
221Alfa AWPC036.
222Amigo AWI-914W.
223AMIT WL531C.
224ASUS WL-107G.
225Atlantis Land A02-PCM-W54.
226Belkin F5D7010 v2.
227Canyon CN-WF513.
228CC&C WL-2102.
229CNet CWC-854.
230Compex WL54.
231Conceptronic C54RC.
232Corega CG-WLCB54GL.
233Digiconnect WL591C.
234Digitus DN-7001G-RA.
235Dynalink WLG25CARDBUS.
236E-Tech WGPC02.
237E-Tech WGPC03.
238Edimax EW-7108PCg.
239Edimax EW-7708PN.
240Eminent EM3036.
241Encore ENPWI-G-RLAM.
242Eusso UGL2454-01R.
243Fiberline WL-400X.
244Gigabyte GN-WMKG.
245Gigabyte GN-WM01GS.
246Gigabyte GN-WM01GM.
247Hawking HWC54GR.
248Hercules HWGPCMCIA-54.
249JAHT WN-4054P(E).
250KCORP LifeStyle KLS-611.
251LevelOne WPC-0301 v2.
252Micronet SP908GK V3.
253Minitar MN54GCB-R.
254MSI CB54G2.
255MSI MS-6835.
256Pro-Nets CB80211G.
257Repotec RP-WB7108.
258SATech SN-54C.
259Sitecom WL-112.
260SparkLAN WL-611R.
261SparkLAN WPCR-501.
262Surecom EP-9428-g.
263Sweex LC500050.
264TekComm NE-9428-g.
265Tonze PW-6200C.
266Unex MR054g-R02.
267Zinwell ZWX-G160.
268Zonet ZEW1500.
269.Ed
270.Pp
271The following Mini PCI adapters should work:
272.Bd -filled
273Amigo AWI-922W.
274Billionton MIWLGRL.
275Gigabyte GN-WIKG.
276Gigabyte GN-WI01GS.
277Gigabyte GN-WI02GM.
278MSI MP54G2.
279MSI MS-6833.
280SparkLAN WMIR-215GN.
281Tonze PC-620C.
282Zinwell ZWX-G360.
283.Ed
284.Sh EXAMPLES
285The following example scans for available networks:
286.Pp
287.Dl # ifconfig ral0 scan
288.Pp
289The following
290.Xr hostname.if 5
291example configures ral0 to join network
292.Dq mynwid ,
293using WPA key
294.Dq mywpakey ,
295obtaining an IP address using DHCP:
296.Bd -literal -offset indent
297nwid mynwid wpakey mywpakey
298dhcp
299.Ed
300.Pp
301The following
302.Xr hostname.if 5
303example creates a host-based access point on boot:
304.Bd -literal -offset indent
305mediaopt hostap
306nwid mynwid wpakey mywpakey
307inet 192.168.1.1 255.255.255.0
308.Ed
309.Sh SEE ALSO
310.Xr arp 4 ,
311.Xr cardbus 4 ,
312.Xr ifmedia 4 ,
313.Xr intro 4 ,
314.Xr netintro 4 ,
315.Xr pci 4 ,
316.Xr hostname.if 5 ,
317.Xr hostapd 8 ,
318.Xr ifconfig 8
319.Sh HISTORY
320The
321.Nm
322driver first appeared in
323.Ox 3.7 .
324Support for the RT2501 and RT2600 chipsets was added in
325.Ox 3.9 .
326Support for the RT2800 chipset was added in
327.Ox 4.3 .
328Support for the RT2700 chipset was added in
329.Ox 4.4 .
330Support for the RT3090 chipset was added in
331.Ox 4.9 .
332.Sh AUTHORS
333The
334.Nm
335driver was written by
336.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
337.Sh CAVEATS
338The
339.Nm
340driver does not make use of the hardware cryptographic engine present on
341the RT2500, RT2501 and RT2600 chipsets.
342.Pp
343The
344.Nm
345driver does not support any of the 802.11n capabilities offered by
346the RT2700, RT2800 and RT3090 chipsets.
347Additional work is required in
348.Xr ieee80211 9
349before those features can be supported.
350.Pp
351On the RT2500, RT2501 and RT2600 chipsets, host AP mode doesn't
352support power saving.
353Clients attempting to use power saving mode may experience significant
354packet loss.
355.Pp
356Some PCI
357.Nm
358adapters seem to strictly require a system supporting PCI 2.2 or greater and
359will likely not work in systems based on older revisions of the PCI
360specification.
361Check the board's PCI version before purchasing the card.
362