xref: /freebsd/share/man/man4/run.4 (revision 93b30f1b6caec5083efacf3fb5049b72e75cc09e) 
1.\"-
2.\" SPDX-License-Identifier: ISC
3.\"
4.\" $OpenBSD: run.4,v 1.22 2009/11/23 06:16:32 jmc Exp $
5.\"
6.\" Copyright (c) 2008 Damien Bergamini <damien.bergamini@free.fr>
7.\"
8.\" Permission to use, copy, modify, and distribute this software for any
9.\" purpose with or without fee is hereby granted, provided that the above
10.\" copyright notice and this permission notice appear in all copies.
11.\"
12.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19.\"
20.Dd November 10, 2024
21.Dt RUN 4
22.Os
23.Sh NAME
24.Nm run
25.Nd Ralink Technology USB IEEE 802.11a/g/n wireless network driver
26.Sh SYNOPSIS
27To compile this driver into the kernel,
28place the following lines in your
29kernel configuration file:
30.Bd -ragged -offset indent
31.Cd "device ehci"
32.Cd "device uhci"
33.Cd "device ohci"
34.Cd "device usb"
35.Cd "device run"
36.Cd "device wlan"
37.Cd "device wlan_amrr"
38.Ed
39.Pp
40Firmware is also needed, and provided by:
41.Bd -ragged -offset indent
42.Cd "device runfw"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following lines in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49if_run_load="YES"
50runfw_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver supports USB 2.0 wireless adapters based on the Ralink RT2700U,
56RT2800U, RT3000U and RT3900E chipsets.
57.Pp
58The RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and
59an RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver.
60.Pp
61The RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and
62an RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver.
63.Pp
64The RT3000U is a single-chip solution based on an RT3070 MAC/BBP and
65an RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio
66transceiver.
67.Pp
68The RT3900E is a single-chip USB 2.0 802.11n solution.
69The MAC/Baseband Processor can be an RT3593, RT5390, RT5392 or an RT5592.
70The radio can be an RT3053, RT5370, RT5372 or an RT5572.
71The RT3053 chip operates in the 2GHz and 5GHz spectra and supports up to
723 transmit paths and 3 receiver paths (3T3R).
73The RT5370 chip operates in the 2GHz spectrum and supports 1 transmit path
74and 1 receiver path (1T1R).
75The RT5372 chip operates in the 2GHz spectrum and supports up to 2 transmit
76paths and 2 receiver paths (2T2R).
77The RT5572 chip operates in the 2GHz and 5GHz spectra and supports up to
782 transmit paths and 2 receiver paths (2T2R).
79.Pp
80These are the modes the
81.Nm
82driver can operate in:
83.Bl -tag -width "IBSS-masterXX"
84.It BSS mode
85Also known as
86.Em infrastructure
87mode, this is used when associating with an access point, through
88which all traffic passes.
89This mode is the default.
90.It Host AP mode
91In this mode the driver acts as an access point (base station)
92for other cards.
93.It monitor mode
94In this mode the driver is able to receive packets without
95associating with an access point.
96This disables the internal receive filter and enables the card to
97capture packets from networks which it wouldn't normally have access to,
98or to scan for access points.
99.El
100.Pp
101The
102.Nm
103driver can be configured to use
104Wired Equivalent Privacy (WEP) or
105Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
106WPA is the de facto encryption standard for wireless networks.
107It is strongly recommended that WEP
108not be used as the sole mechanism
109to secure wireless communication,
110due to serious weaknesses in it.
111The
112.Nm
113driver offloads both encryption and decryption of data frames to the
114hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
115.Pp
116The
117.Nm
118driver can be configured at runtime with
119.Xr ifconfig 8 .
120.Sh HARDWARE
121The
122.Nm
123driver supports the following wireless adapters:
124.Pp
125.Bl -bullet -offset indent -compact
126.It
127Airlink101 AWLL6090
128.It
129ASUS USB-N11
130.It
131ASUS USB-N13 ver. A1
132.It
133ASUS USB-N14
134.It
135ASUS USB-N66
136.It
137ASUS WL-160N
138.It
139Belkin F5D8051 ver 3000
140.It
141Belkin F5D8053
142.It
143Belkin F5D8055
144.It
145Belkin F6D4050 ver 1
146.It
147Belkin F9L1103
148.It
149Buffalo WLI-UC-AG300N
150.It
151Buffalo WLI-UC-G300HP
152.It
153Buffalo WLI-UC-G300N
154.It
155Buffalo WLI-UC-G301N
156.It
157Buffalo WLI-UC-GN
158.It
159Buffalo WLI-UC-GNM
160.It
161Buffalo WLI-UC-GNM2
162.It
163Corega CG-WLUSB2GNL
164.It
165Corega CG-WLUSB2GNR
166.It
167Corega CG-WLUSB300AGN
168.It
169Corega CG-WLUSB300GNM
170.It
171D-Link DWA-130 rev B1
172.It
173D-Link DWA-130 rev F1
174.It
175D-Link DWA-140 rev B1, B2, B3, \&D1
176.It
177D-Link DWA-160 rev B2
178.It
179D-Link DWA-162
180.It
181DrayTek Vigor N61
182.It
183Edimax EW-7711UAn
184.It
185Edimax EW-7711UTn
186.It
187Edimax EW-7717Un
188.It
189Edimax EW-7718Un
190.It
191Edimax EW-7733UnD
192.It
193Gigabyte GN-WB30N
194.It
195Gigabyte GN-WB31N
196.It
197Gigabyte GN-WB32L
198.It
199Hawking HWDN1
200.It
201Hawking HWUN1
202.It
203Hawking HWUN2
204.It
205Hercules HWNU-300
206.It
207Linksys WUSB54GC v3
208.It
209Linksys WUSB600N
210.It
211Logitec LAN-W150N/U2
212.It
213Mvix Nubbin MS-811N
214.It
215Panda Wireless PAU06
216.It
217Planex GW-USMicroN
218.It
219Planex GW-US300MiniS
220.It
221Sitecom WL-182
222.It
223Sitecom WL-188
224.It
225Sitecom WL-301
226.It
227Sitecom WL-302
228.It
229Sitecom WL-315
230.It
231SMC SMCWUSBS-N2
232.It
233Sweex LW303
234.It
235Sweex LW313
236.It
237TP-LINK TL-WDN3200
238.It
239TP-LINK TL-WN321G v4
240.It
241TP-LINK TL-WN727N v3
242.It
243Unex DNUR-81
244.It
245Unex DNUR-82
246.It
247ZyXEL NWD2705
248.It
249ZyXEL NWD210N
250.It
251ZyXEL NWD270N
252.El
253.Sh EXAMPLES
254Join an existing BSS network (i.e., connect to an access point):
255.Pp
256.Dl ifconfig wlan create wlandev run0 inet 192.0.2.20/24
257.Pp
258Join a specific BSS network with network name
259.Ar my_net :
260.Pp
261.Dl ifconfig wlan create wlandev run0 ssid my_net up
262.Pp
263Join a specific BSS network with 64-bit WEP encryption:
264.Bd -literal -offset indent
265ifconfig wlan create wlandev run0 ssid my_net \e
266    wepmode on wepkey 0x1234567890 weptxkey 1 up
267.Ed
268.Pp
269Join a specific BSS network with 128-bit WEP encryption:
270.Bd -literal -offset indent
271ifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
272    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
273.Ed
274.Sh DIAGNOSTICS
275.Bl -diag
276.It "run%d: failed load firmware of file runfw"
277For some reason, the driver was unable to read the microcode file from the
278filesystem.
279The file might be missing or corrupted.
280.It "run%d: could not load 8051 microcode"
281An error occurred while attempting to upload the microcode to the onboard 8051
282microcontroller unit.
283.It "run%d: device timeout"
284A frame dispatched to the hardware for transmission did not complete in time.
285The driver will reset the hardware.
286This should not happen.
287.El
288.Sh SEE ALSO
289.Xr intro 4 ,
290.Xr netintro 4 ,
291.Xr runfw 4 ,
292.Xr usb 4 ,
293.Xr wlan 4 ,
294.Xr wlan_amrr 4 ,
295.Xr wlan_ccmp 4 ,
296.Xr wlan_tkip 4 ,
297.Xr wlan_wep 4 ,
298.Xr wlan_xauth 4 ,
299.Xr networking 7 ,
300.Xr hostapd 8 ,
301.Xr ifconfig 8 ,
302.Xr wpa_supplicant 8
303.Sh HISTORY
304The
305.Nm
306driver first appeared in
307.Ox 4.5 .
308.Sh AUTHORS
309The
310.Nm
311driver was written by
312.An Damien Bergamini Aq Mt damien@openbsd.org .
313.Sh CAVEATS
314The
315.Nm
316driver supports some of the 11n capabilities found in the
317RT2800, RT3000 and RT3900 chipsets.
318