xref: /freebsd/share/man/man4/run.4 (revision 93b30f1b6caec5083efacf3fb5049b72e75cc09e)
1*93b30f1bSAlexander Ziaee.\"-
2*93b30f1bSAlexander Ziaee.\" SPDX-License-Identifier: ISC
3*93b30f1bSAlexander Ziaee.\"
4069f1a80SAndrew Thompson.\" $OpenBSD: run.4,v 1.22 2009/11/23 06:16:32 jmc Exp $
5069f1a80SAndrew Thompson.\"
6069f1a80SAndrew Thompson.\" Copyright (c) 2008 Damien Bergamini <damien.bergamini@free.fr>
7069f1a80SAndrew Thompson.\"
8069f1a80SAndrew Thompson.\" Permission to use, copy, modify, and distribute this software for any
9069f1a80SAndrew Thompson.\" purpose with or without fee is hereby granted, provided that the above
10069f1a80SAndrew Thompson.\" copyright notice and this permission notice appear in all copies.
11069f1a80SAndrew Thompson.\"
12069f1a80SAndrew Thompson.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13069f1a80SAndrew Thompson.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14069f1a80SAndrew Thompson.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15069f1a80SAndrew Thompson.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16069f1a80SAndrew Thompson.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17069f1a80SAndrew Thompson.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18069f1a80SAndrew Thompson.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19069f1a80SAndrew Thompson.\"
20*93b30f1bSAlexander Ziaee.Dd November 10, 2024
21069f1a80SAndrew Thompson.Dt RUN 4
22aa12cea2SUlrich Spörlein.Os
23069f1a80SAndrew Thompson.Sh NAME
24069f1a80SAndrew Thompson.Nm run
25*93b30f1bSAlexander Ziaee.Nd Ralink Technology USB IEEE 802.11a/g/n wireless network driver
26069f1a80SAndrew Thompson.Sh SYNOPSIS
27069f1a80SAndrew ThompsonTo compile this driver into the kernel,
28069f1a80SAndrew Thompsonplace the following lines in your
29069f1a80SAndrew Thompsonkernel configuration file:
30069f1a80SAndrew Thompson.Bd -ragged -offset indent
31069f1a80SAndrew Thompson.Cd "device ehci"
32069f1a80SAndrew Thompson.Cd "device uhci"
33069f1a80SAndrew Thompson.Cd "device ohci"
34069f1a80SAndrew Thompson.Cd "device usb"
35069f1a80SAndrew Thompson.Cd "device run"
36069f1a80SAndrew Thompson.Cd "device wlan"
37069f1a80SAndrew Thompson.Cd "device wlan_amrr"
38069f1a80SAndrew Thompson.Ed
39069f1a80SAndrew Thompson.Pp
4002d09fbbSAndrew ThompsonFirmware is also needed, and provided by:
4102d09fbbSAndrew Thompson.Bd -ragged -offset indent
4202d09fbbSAndrew Thompson.Cd "device runfw"
4302d09fbbSAndrew Thompson.Ed
4402d09fbbSAndrew Thompson.Pp
45069f1a80SAndrew ThompsonAlternatively, to load the driver as a
4602d09fbbSAndrew Thompsonmodule at boot time, place the following lines in
47069f1a80SAndrew Thompson.Xr loader.conf 5 :
48069f1a80SAndrew Thompson.Bd -literal -offset indent
49069f1a80SAndrew Thompsonif_run_load="YES"
5002d09fbbSAndrew Thompsonrunfw_load="YES"
51069f1a80SAndrew Thompson.Ed
52069f1a80SAndrew Thompson.Sh DESCRIPTION
53069f1a80SAndrew ThompsonThe
54069f1a80SAndrew Thompson.Nm
55069f1a80SAndrew Thompsondriver supports USB 2.0 wireless adapters based on the Ralink RT2700U,
56bd4c283dSKevin LoRT2800U, RT3000U and RT3900E chipsets.
57069f1a80SAndrew Thompson.Pp
58069f1a80SAndrew ThompsonThe RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and
59069f1a80SAndrew Thompsonan RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver.
60069f1a80SAndrew Thompson.Pp
61069f1a80SAndrew ThompsonThe RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and
62069f1a80SAndrew Thompsonan RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver.
63069f1a80SAndrew Thompson.Pp
64069f1a80SAndrew ThompsonThe RT3000U is a single-chip solution based on an RT3070 MAC/BBP and
65069f1a80SAndrew Thompsonan RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio
66069f1a80SAndrew Thompsontransceiver.
67069f1a80SAndrew Thompson.Pp
687a7e01caSKevin LoThe RT3900E is a single-chip USB 2.0 802.11n solution.
697a7e01caSKevin LoThe MAC/Baseband Processor can be an RT3593, RT5390, RT5392 or an RT5592.
707a7e01caSKevin LoThe radio can be an RT3053, RT5370, RT5372 or an RT5572.
717a7e01caSKevin LoThe RT3053 chip operates in the 2GHz and 5GHz spectra and supports up to
727a7e01caSKevin Lo3 transmit paths and 3 receiver paths (3T3R).
737a7e01caSKevin LoThe RT5370 chip operates in the 2GHz spectrum and supports 1 transmit path
747a7e01caSKevin Loand 1 receiver path (1T1R).
757a7e01caSKevin LoThe RT5372 chip operates in the 2GHz spectrum and supports up to 2 transmit
767a7e01caSKevin Lopaths and 2 receiver paths (2T2R).
777a7e01caSKevin LoThe RT5572 chip operates in the 2GHz and 5GHz spectra and supports up to
787a7e01caSKevin Lo2 transmit paths and 2 receiver paths (2T2R).
79bd4c283dSKevin Lo.Pp
80069f1a80SAndrew ThompsonThese are the modes the
81069f1a80SAndrew Thompson.Nm
82069f1a80SAndrew Thompsondriver can operate in:
83069f1a80SAndrew Thompson.Bl -tag -width "IBSS-masterXX"
84069f1a80SAndrew Thompson.It BSS mode
85069f1a80SAndrew ThompsonAlso known as
86069f1a80SAndrew Thompson.Em infrastructure
87069f1a80SAndrew Thompsonmode, this is used when associating with an access point, through
88069f1a80SAndrew Thompsonwhich all traffic passes.
89069f1a80SAndrew ThompsonThis mode is the default.
9002d09fbbSAndrew Thompson.It Host AP mode
9102d09fbbSAndrew ThompsonIn this mode the driver acts as an access point (base station)
9202d09fbbSAndrew Thompsonfor other cards.
93069f1a80SAndrew Thompson.It monitor mode
94069f1a80SAndrew ThompsonIn this mode the driver is able to receive packets without
95069f1a80SAndrew Thompsonassociating with an access point.
96069f1a80SAndrew ThompsonThis disables the internal receive filter and enables the card to
97069f1a80SAndrew Thompsoncapture packets from networks which it wouldn't normally have access to,
98069f1a80SAndrew Thompsonor to scan for access points.
99069f1a80SAndrew Thompson.El
100069f1a80SAndrew Thompson.Pp
101069f1a80SAndrew ThompsonThe
102069f1a80SAndrew Thompson.Nm
103069f1a80SAndrew Thompsondriver can be configured to use
104069f1a80SAndrew ThompsonWired Equivalent Privacy (WEP) or
105069f1a80SAndrew ThompsonWi-Fi Protected Access (WPA-PSK and WPA2-PSK).
106069f1a80SAndrew ThompsonWPA is the de facto encryption standard for wireless networks.
107069f1a80SAndrew ThompsonIt is strongly recommended that WEP
108069f1a80SAndrew Thompsonnot be used as the sole mechanism
109069f1a80SAndrew Thompsonto secure wireless communication,
110069f1a80SAndrew Thompsondue to serious weaknesses in it.
111069f1a80SAndrew ThompsonThe
112069f1a80SAndrew Thompson.Nm
113069f1a80SAndrew Thompsondriver offloads both encryption and decryption of data frames to the
114069f1a80SAndrew Thompsonhardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
115069f1a80SAndrew Thompson.Pp
116069f1a80SAndrew ThompsonThe
117069f1a80SAndrew Thompson.Nm
118069f1a80SAndrew Thompsondriver can be configured at runtime with
11902d09fbbSAndrew Thompson.Xr ifconfig 8 .
120069f1a80SAndrew Thompson.Sh HARDWARE
1218680e929SChristian BruefferThe
1228680e929SChristian Brueffer.Nm
1238680e929SChristian Bruefferdriver supports the following wireless adapters:
124069f1a80SAndrew Thompson.Pp
125*93b30f1bSAlexander Ziaee.Bl -bullet -offset indent -compact
126*93b30f1bSAlexander Ziaee.It
127*93b30f1bSAlexander ZiaeeAirlink101 AWLL6090
128*93b30f1bSAlexander Ziaee.It
129*93b30f1bSAlexander ZiaeeASUS USB-N11
130*93b30f1bSAlexander Ziaee.It
131*93b30f1bSAlexander ZiaeeASUS USB-N13 ver. A1
132*93b30f1bSAlexander Ziaee.It
133*93b30f1bSAlexander ZiaeeASUS USB-N14
134*93b30f1bSAlexander Ziaee.It
135*93b30f1bSAlexander ZiaeeASUS USB-N66
136*93b30f1bSAlexander Ziaee.It
137*93b30f1bSAlexander ZiaeeASUS WL-160N
138*93b30f1bSAlexander Ziaee.It
139*93b30f1bSAlexander ZiaeeBelkin F5D8051 ver 3000
140*93b30f1bSAlexander Ziaee.It
141*93b30f1bSAlexander ZiaeeBelkin F5D8053
142*93b30f1bSAlexander Ziaee.It
143*93b30f1bSAlexander ZiaeeBelkin F5D8055
144*93b30f1bSAlexander Ziaee.It
145*93b30f1bSAlexander ZiaeeBelkin F6D4050 ver 1
146*93b30f1bSAlexander Ziaee.It
147*93b30f1bSAlexander ZiaeeBelkin F9L1103
148*93b30f1bSAlexander Ziaee.It
149*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-AG300N
150*93b30f1bSAlexander Ziaee.It
151*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-G300HP
152*93b30f1bSAlexander Ziaee.It
153*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-G300N
154*93b30f1bSAlexander Ziaee.It
155*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-G301N
156*93b30f1bSAlexander Ziaee.It
157*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-GN
158*93b30f1bSAlexander Ziaee.It
159*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-GNM
160*93b30f1bSAlexander Ziaee.It
161*93b30f1bSAlexander ZiaeeBuffalo WLI-UC-GNM2
162*93b30f1bSAlexander Ziaee.It
163*93b30f1bSAlexander ZiaeeCorega CG-WLUSB2GNL
164*93b30f1bSAlexander Ziaee.It
165*93b30f1bSAlexander ZiaeeCorega CG-WLUSB2GNR
166*93b30f1bSAlexander Ziaee.It
167*93b30f1bSAlexander ZiaeeCorega CG-WLUSB300AGN
168*93b30f1bSAlexander Ziaee.It
169*93b30f1bSAlexander ZiaeeCorega CG-WLUSB300GNM
170*93b30f1bSAlexander Ziaee.It
171*93b30f1bSAlexander ZiaeeD-Link DWA-130 rev B1
172*93b30f1bSAlexander Ziaee.It
173*93b30f1bSAlexander ZiaeeD-Link DWA-130 rev F1
174*93b30f1bSAlexander Ziaee.It
175*93b30f1bSAlexander ZiaeeD-Link DWA-140 rev B1, B2, B3, \&D1
176*93b30f1bSAlexander Ziaee.It
177*93b30f1bSAlexander ZiaeeD-Link DWA-160 rev B2
178*93b30f1bSAlexander Ziaee.It
179*93b30f1bSAlexander ZiaeeD-Link DWA-162
180*93b30f1bSAlexander Ziaee.It
181*93b30f1bSAlexander ZiaeeDrayTek Vigor N61
182*93b30f1bSAlexander Ziaee.It
183*93b30f1bSAlexander ZiaeeEdimax EW-7711UAn
184*93b30f1bSAlexander Ziaee.It
185*93b30f1bSAlexander ZiaeeEdimax EW-7711UTn
186*93b30f1bSAlexander Ziaee.It
187*93b30f1bSAlexander ZiaeeEdimax EW-7717Un
188*93b30f1bSAlexander Ziaee.It
189*93b30f1bSAlexander ZiaeeEdimax EW-7718Un
190*93b30f1bSAlexander Ziaee.It
191*93b30f1bSAlexander ZiaeeEdimax EW-7733UnD
192*93b30f1bSAlexander Ziaee.It
193*93b30f1bSAlexander ZiaeeGigabyte GN-WB30N
194*93b30f1bSAlexander Ziaee.It
195*93b30f1bSAlexander ZiaeeGigabyte GN-WB31N
196*93b30f1bSAlexander Ziaee.It
197*93b30f1bSAlexander ZiaeeGigabyte GN-WB32L
198*93b30f1bSAlexander Ziaee.It
199*93b30f1bSAlexander ZiaeeHawking HWDN1
200*93b30f1bSAlexander Ziaee.It
201*93b30f1bSAlexander ZiaeeHawking HWUN1
202*93b30f1bSAlexander Ziaee.It
203*93b30f1bSAlexander ZiaeeHawking HWUN2
204*93b30f1bSAlexander Ziaee.It
205*93b30f1bSAlexander ZiaeeHercules HWNU-300
206*93b30f1bSAlexander Ziaee.It
207*93b30f1bSAlexander ZiaeeLinksys WUSB54GC v3
208*93b30f1bSAlexander Ziaee.It
209*93b30f1bSAlexander ZiaeeLinksys WUSB600N
210*93b30f1bSAlexander Ziaee.It
211*93b30f1bSAlexander ZiaeeLogitec LAN-W150N/U2
212*93b30f1bSAlexander Ziaee.It
213*93b30f1bSAlexander ZiaeeMvix Nubbin MS-811N
214*93b30f1bSAlexander Ziaee.It
215*93b30f1bSAlexander ZiaeePanda Wireless PAU06
216*93b30f1bSAlexander Ziaee.It
217*93b30f1bSAlexander ZiaeePlanex GW-USMicroN
218*93b30f1bSAlexander Ziaee.It
219*93b30f1bSAlexander ZiaeePlanex GW-US300MiniS
220*93b30f1bSAlexander Ziaee.It
221*93b30f1bSAlexander ZiaeeSitecom WL-182
222*93b30f1bSAlexander Ziaee.It
223*93b30f1bSAlexander ZiaeeSitecom WL-188
224*93b30f1bSAlexander Ziaee.It
225*93b30f1bSAlexander ZiaeeSitecom WL-301
226*93b30f1bSAlexander Ziaee.It
227*93b30f1bSAlexander ZiaeeSitecom WL-302
228*93b30f1bSAlexander Ziaee.It
229*93b30f1bSAlexander ZiaeeSitecom WL-315
230*93b30f1bSAlexander Ziaee.It
231*93b30f1bSAlexander ZiaeeSMC SMCWUSBS-N2
232*93b30f1bSAlexander Ziaee.It
233*93b30f1bSAlexander ZiaeeSweex LW303
234*93b30f1bSAlexander Ziaee.It
235*93b30f1bSAlexander ZiaeeSweex LW313
236*93b30f1bSAlexander Ziaee.It
237*93b30f1bSAlexander ZiaeeTP-LINK TL-WDN3200
238*93b30f1bSAlexander Ziaee.It
239*93b30f1bSAlexander ZiaeeTP-LINK TL-WN321G v4
240*93b30f1bSAlexander Ziaee.It
241*93b30f1bSAlexander ZiaeeTP-LINK TL-WN727N v3
242*93b30f1bSAlexander Ziaee.It
243*93b30f1bSAlexander ZiaeeUnex DNUR-81
244*93b30f1bSAlexander Ziaee.It
245*93b30f1bSAlexander ZiaeeUnex DNUR-82
246*93b30f1bSAlexander Ziaee.It
247*93b30f1bSAlexander ZiaeeZyXEL NWD2705
248*93b30f1bSAlexander Ziaee.It
249*93b30f1bSAlexander ZiaeeZyXEL NWD210N
250*93b30f1bSAlexander Ziaee.It
251*93b30f1bSAlexander ZiaeeZyXEL NWD270N
252069f1a80SAndrew Thompson.El
253069f1a80SAndrew Thompson.Sh EXAMPLES
254069f1a80SAndrew ThompsonJoin an existing BSS network (i.e., connect to an access point):
255*93b30f1bSAlexander Ziaee.Pp
256*93b30f1bSAlexander Ziaee.Dl ifconfig wlan create wlandev run0 inet 192.0.2.20/24
257069f1a80SAndrew Thompson.Pp
258069f1a80SAndrew ThompsonJoin a specific BSS network with network name
259*93b30f1bSAlexander Ziaee.Ar my_net :
260069f1a80SAndrew Thompson.Pp
261*93b30f1bSAlexander Ziaee.Dl ifconfig wlan create wlandev run0 ssid my_net up
262069f1a80SAndrew Thompson.Pp
263069f1a80SAndrew ThompsonJoin a specific BSS network with 64-bit WEP encryption:
264069f1a80SAndrew Thompson.Bd -literal -offset indent
265069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 ssid my_net \e
266069f1a80SAndrew Thompson    wepmode on wepkey 0x1234567890 weptxkey 1 up
267069f1a80SAndrew Thompson.Ed
268069f1a80SAndrew Thompson.Pp
269069f1a80SAndrew ThompsonJoin a specific BSS network with 128-bit WEP encryption:
270069f1a80SAndrew Thompson.Bd -literal -offset indent
271069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
272069f1a80SAndrew Thompson    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
273069f1a80SAndrew Thompson.Ed
274069f1a80SAndrew Thompson.Sh DIAGNOSTICS
275069f1a80SAndrew Thompson.Bl -diag
2761cc4c2f9SGordon Bergling.It "run%d: failed load firmware of file runfw"
277069f1a80SAndrew ThompsonFor some reason, the driver was unable to read the microcode file from the
278069f1a80SAndrew Thompsonfilesystem.
279069f1a80SAndrew ThompsonThe file might be missing or corrupted.
280069f1a80SAndrew Thompson.It "run%d: could not load 8051 microcode"
281069f1a80SAndrew ThompsonAn error occurred while attempting to upload the microcode to the onboard 8051
282069f1a80SAndrew Thompsonmicrocontroller unit.
283069f1a80SAndrew Thompson.It "run%d: device timeout"
284069f1a80SAndrew ThompsonA frame dispatched to the hardware for transmission did not complete in time.
285069f1a80SAndrew ThompsonThe driver will reset the hardware.
286069f1a80SAndrew ThompsonThis should not happen.
287069f1a80SAndrew Thompson.El
288069f1a80SAndrew Thompson.Sh SEE ALSO
289069f1a80SAndrew Thompson.Xr intro 4 ,
290069f1a80SAndrew Thompson.Xr netintro 4 ,
291923544aaSBaptiste Daroussin.Xr runfw 4 ,
292069f1a80SAndrew Thompson.Xr usb 4 ,
293069f1a80SAndrew Thompson.Xr wlan 4 ,
294069f1a80SAndrew Thompson.Xr wlan_amrr 4 ,
295069f1a80SAndrew Thompson.Xr wlan_ccmp 4 ,
296069f1a80SAndrew Thompson.Xr wlan_tkip 4 ,
297069f1a80SAndrew Thompson.Xr wlan_wep 4 ,
298069f1a80SAndrew Thompson.Xr wlan_xauth 4 ,
299*93b30f1bSAlexander Ziaee.Xr networking 7 ,
300069f1a80SAndrew Thompson.Xr hostapd 8 ,
301923544aaSBaptiste Daroussin.Xr ifconfig 8 ,
30250d922a0SGlen Barber.Xr wpa_supplicant 8
303069f1a80SAndrew Thompson.Sh HISTORY
304069f1a80SAndrew ThompsonThe
305069f1a80SAndrew Thompson.Nm
306069f1a80SAndrew Thompsondriver first appeared in
307069f1a80SAndrew Thompson.Ox 4.5 .
308069f1a80SAndrew Thompson.Sh AUTHORS
309069f1a80SAndrew ThompsonThe
310069f1a80SAndrew Thompson.Nm
311069f1a80SAndrew Thompsondriver was written by
3126c899950SBaptiste Daroussin.An Damien Bergamini Aq Mt damien@openbsd.org .
313069f1a80SAndrew Thompson.Sh CAVEATS
314069f1a80SAndrew ThompsonThe
315069f1a80SAndrew Thompson.Nm
316dd1d42a9SAdrian Chadddriver supports some of the 11n capabilities found in the
3177a7e01caSKevin LoRT2800, RT3000 and RT3900 chipsets.
318