xref: /freebsd/share/man/man4/run.4 (revision 7a7e01caa4f2c65ad18c623e42d55ec1a5cbee16)
1069f1a80SAndrew Thompson.\" $OpenBSD: run.4,v 1.22 2009/11/23 06:16:32 jmc Exp $
2069f1a80SAndrew Thompson.\"
3069f1a80SAndrew Thompson.\" Copyright (c) 2008 Damien Bergamini <damien.bergamini@free.fr>
4069f1a80SAndrew Thompson.\"
5069f1a80SAndrew Thompson.\" Permission to use, copy, modify, and distribute this software for any
6069f1a80SAndrew Thompson.\" purpose with or without fee is hereby granted, provided that the above
7069f1a80SAndrew Thompson.\" copyright notice and this permission notice appear in all copies.
8069f1a80SAndrew Thompson.\"
9069f1a80SAndrew Thompson.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10069f1a80SAndrew Thompson.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11069f1a80SAndrew Thompson.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12069f1a80SAndrew Thompson.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13069f1a80SAndrew Thompson.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14069f1a80SAndrew Thompson.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15069f1a80SAndrew Thompson.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16069f1a80SAndrew Thompson.\"
17069f1a80SAndrew Thompson.\" $FreeBSD$
18069f1a80SAndrew Thompson.\"
19*7a7e01caSKevin Lo.Dd January 3, 2014
20069f1a80SAndrew Thompson.Dt RUN 4
21aa12cea2SUlrich Spörlein.Os
22069f1a80SAndrew Thompson.Sh NAME
23069f1a80SAndrew Thompson.Nm run
24069f1a80SAndrew Thompson.Nd Ralink Technology USB IEEE 802.11a/g/n wireless network device
25069f1a80SAndrew Thompson.Sh SYNOPSIS
26069f1a80SAndrew ThompsonTo compile this driver into the kernel,
27069f1a80SAndrew Thompsonplace the following lines in your
28069f1a80SAndrew Thompsonkernel configuration file:
29069f1a80SAndrew Thompson.Bd -ragged -offset indent
30069f1a80SAndrew Thompson.Cd "device ehci"
31069f1a80SAndrew Thompson.Cd "device uhci"
32069f1a80SAndrew Thompson.Cd "device ohci"
33069f1a80SAndrew Thompson.Cd "device usb"
34069f1a80SAndrew Thompson.Cd "device run"
35069f1a80SAndrew Thompson.Cd "device wlan"
36069f1a80SAndrew Thompson.Cd "device wlan_amrr"
37069f1a80SAndrew Thompson.Ed
38069f1a80SAndrew Thompson.Pp
3902d09fbbSAndrew ThompsonFirmware is also needed, and provided by:
4002d09fbbSAndrew Thompson.Bd -ragged -offset indent
4102d09fbbSAndrew Thompson.Cd "device runfw"
4202d09fbbSAndrew Thompson.Ed
4302d09fbbSAndrew Thompson.Pp
44069f1a80SAndrew ThompsonAlternatively, to load the driver as a
4502d09fbbSAndrew Thompsonmodule at boot time, place the following lines in
46069f1a80SAndrew Thompson.Xr loader.conf 5 :
47069f1a80SAndrew Thompson.Bd -literal -offset indent
48069f1a80SAndrew Thompsonif_run_load="YES"
4902d09fbbSAndrew Thompsonrunfw_load="YES"
50069f1a80SAndrew Thompson.Ed
51069f1a80SAndrew Thompson.Sh DESCRIPTION
52069f1a80SAndrew ThompsonThe
53069f1a80SAndrew Thompson.Nm
54069f1a80SAndrew Thompsondriver supports USB 2.0 wireless adapters based on the Ralink RT2700U,
55bd4c283dSKevin LoRT2800U, RT3000U and RT3900E chipsets.
56069f1a80SAndrew Thompson.Pp
57069f1a80SAndrew ThompsonThe RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and
58069f1a80SAndrew Thompsonan RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver.
59069f1a80SAndrew Thompson.Pp
60069f1a80SAndrew ThompsonThe RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and
61069f1a80SAndrew Thompsonan RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver.
62069f1a80SAndrew Thompson.Pp
63069f1a80SAndrew ThompsonThe RT3000U is a single-chip solution based on an RT3070 MAC/BBP and
64069f1a80SAndrew Thompsonan RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio
65069f1a80SAndrew Thompsontransceiver.
66069f1a80SAndrew Thompson.Pp
67*7a7e01caSKevin LoThe RT3900E is a single-chip USB 2.0 802.11n solution.
68*7a7e01caSKevin LoThe MAC/Baseband Processor can be an RT3593, RT5390, RT5392 or an RT5592.
69*7a7e01caSKevin LoThe radio can be an RT3053, RT5370, RT5372 or an RT5572.
70*7a7e01caSKevin LoThe RT3053 chip operates in the 2GHz and 5GHz spectra and supports up to
71*7a7e01caSKevin Lo3 transmit paths and 3 receiver paths (3T3R).
72*7a7e01caSKevin LoThe RT5370 chip operates in the 2GHz spectrum and supports 1 transmit path
73*7a7e01caSKevin Loand 1 receiver path (1T1R).
74*7a7e01caSKevin LoThe RT5372 chip operates in the 2GHz spectrum and supports up to 2 transmit
75*7a7e01caSKevin Lopaths and 2 receiver paths (2T2R).
76*7a7e01caSKevin LoThe RT5572 chip operates in the 2GHz and 5GHz spectra and supports up to
77*7a7e01caSKevin Lo2 transmit paths and 2 receiver paths (2T2R).
78bd4c283dSKevin Lo.Pp
79069f1a80SAndrew ThompsonThese are the modes the
80069f1a80SAndrew Thompson.Nm
81069f1a80SAndrew Thompsondriver can operate in:
82069f1a80SAndrew Thompson.Bl -tag -width "IBSS-masterXX"
83069f1a80SAndrew Thompson.It BSS mode
84069f1a80SAndrew ThompsonAlso known as
85069f1a80SAndrew Thompson.Em infrastructure
86069f1a80SAndrew Thompsonmode, this is used when associating with an access point, through
87069f1a80SAndrew Thompsonwhich all traffic passes.
88069f1a80SAndrew ThompsonThis mode is the default.
8902d09fbbSAndrew Thompson.It Host AP mode
9002d09fbbSAndrew ThompsonIn this mode the driver acts as an access point (base station)
9102d09fbbSAndrew Thompsonfor other cards.
92069f1a80SAndrew Thompson.It monitor mode
93069f1a80SAndrew ThompsonIn this mode the driver is able to receive packets without
94069f1a80SAndrew Thompsonassociating with an access point.
95069f1a80SAndrew ThompsonThis disables the internal receive filter and enables the card to
96069f1a80SAndrew Thompsoncapture packets from networks which it wouldn't normally have access to,
97069f1a80SAndrew Thompsonor to scan for access points.
98069f1a80SAndrew Thompson.El
99069f1a80SAndrew Thompson.Pp
100069f1a80SAndrew ThompsonThe
101069f1a80SAndrew Thompson.Nm
102069f1a80SAndrew Thompsondriver can be configured to use
103069f1a80SAndrew ThompsonWired Equivalent Privacy (WEP) or
104069f1a80SAndrew ThompsonWi-Fi Protected Access (WPA-PSK and WPA2-PSK).
105069f1a80SAndrew ThompsonWPA is the de facto encryption standard for wireless networks.
106069f1a80SAndrew ThompsonIt is strongly recommended that WEP
107069f1a80SAndrew Thompsonnot be used as the sole mechanism
108069f1a80SAndrew Thompsonto secure wireless communication,
109069f1a80SAndrew Thompsondue to serious weaknesses in it.
110069f1a80SAndrew ThompsonThe
111069f1a80SAndrew Thompson.Nm
112069f1a80SAndrew Thompsondriver offloads both encryption and decryption of data frames to the
113069f1a80SAndrew Thompsonhardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
114069f1a80SAndrew Thompson.Pp
115069f1a80SAndrew ThompsonThe
116069f1a80SAndrew Thompson.Nm
117069f1a80SAndrew Thompsondriver can be configured at runtime with
11802d09fbbSAndrew Thompson.Xr ifconfig 8 .
119069f1a80SAndrew Thompson.Sh HARDWARE
1208680e929SChristian BruefferThe
1218680e929SChristian Brueffer.Nm
1228680e929SChristian Bruefferdriver supports the following wireless adapters:
123069f1a80SAndrew Thompson.Pp
124069f1a80SAndrew Thompson.Bl -tag -width Ds -offset indent -compact
125069f1a80SAndrew Thompson.It Airlink101 AWLL6090
126069f1a80SAndrew Thompson.It ASUS USB-N11
127de27bf32SWarren Block.It ASUS USB-N13 ver. A1
128*7a7e01caSKevin Lo.It ASUS USB-N66
129069f1a80SAndrew Thompson.It ASUS WL-160N
130069f1a80SAndrew Thompson.It Belkin F5D8051 ver 3000
131069f1a80SAndrew Thompson.It Belkin F5D8053
132069f1a80SAndrew Thompson.It Belkin F5D8055
133069f1a80SAndrew Thompson.It Belkin F6D4050 ver 1
134*7a7e01caSKevin Lo.It Belkin F9L1103
135069f1a80SAndrew Thompson.It Buffalo WLI-UC-AG300N
136069f1a80SAndrew Thompson.It Buffalo WLI-UC-G300N
137f1168f99SDaichi GOTO.It Buffalo WLI-UC-G301N
138069f1a80SAndrew Thompson.It Buffalo WLI-UC-GN
139be503393SHiroki Sato.It Buffalo WLI-UC-GNM
140be503393SHiroki Sato.It Buffalo WLI-UC-GNM2
141069f1a80SAndrew Thompson.It Corega CG-WLUSB2GNL
142069f1a80SAndrew Thompson.It Corega CG-WLUSB2GNR
143069f1a80SAndrew Thompson.It Corega CG-WLUSB300AGN
144069f1a80SAndrew Thompson.It Corega CG-WLUSB300GNM
145069f1a80SAndrew Thompson.It D-Link DWA-130 rev B1
146959af347SKevin Lo.It D-Link DWA-140 rev B1, B2, B3, D1
147242dbae3SKevin Lo.It D-Link DWA-160 rev B2
148*7a7e01caSKevin Lo.It D-Link DWA-162
149069f1a80SAndrew Thompson.It DrayTek Vigor N61
150069f1a80SAndrew Thompson.It Edimax EW-7711UAn
151069f1a80SAndrew Thompson.It Edimax EW-7711UTn
152069f1a80SAndrew Thompson.It Edimax EW-7717Un
153069f1a80SAndrew Thompson.It Edimax EW-7718Un
154*7a7e01caSKevin Lo.It Edimax EW-7733UnD
155069f1a80SAndrew Thompson.It Gigabyte GN-WB30N
156069f1a80SAndrew Thompson.It Gigabyte GN-WB31N
157069f1a80SAndrew Thompson.It Gigabyte GN-WB32L
158069f1a80SAndrew Thompson.It Hawking HWDN1
159069f1a80SAndrew Thompson.It Hawking HWUN1
160069f1a80SAndrew Thompson.It Hawking HWUN2
161069f1a80SAndrew Thompson.It Hercules HWNU-300
162069f1a80SAndrew Thompson.It Linksys WUSB54GC v3
163069f1a80SAndrew Thompson.It Linksys WUSB600N
164be503393SHiroki Sato.It Logitec LAN-W150N/U2
165069f1a80SAndrew Thompson.It Mvix Nubbin MS-811N
166069f1a80SAndrew Thompson.It Planex GW-USMicroN
167069f1a80SAndrew Thompson.It Planex GW-US300MiniS
168069f1a80SAndrew Thompson.It Sitecom WL-182
169069f1a80SAndrew Thompson.It Sitecom WL-188
170069f1a80SAndrew Thompson.It Sitecom WL-301
171069f1a80SAndrew Thompson.It Sitecom WL-302
172069f1a80SAndrew Thompson.It Sitecom WL-315
173069f1a80SAndrew Thompson.It SMC SMCWUSBS-N2
174069f1a80SAndrew Thompson.It Sweex LW303
175069f1a80SAndrew Thompson.It Sweex LW313
176242dbae3SKevin Lo.It TP-LINK TL-WDN3200
177bd4c283dSKevin Lo.It TP-LINK TL-WN727N v3
178069f1a80SAndrew Thompson.It Unex DNUR-81
179069f1a80SAndrew Thompson.It Unex DNUR-82
180*7a7e01caSKevin Lo.It ZyXEL NWD2705
181069f1a80SAndrew Thompson.It ZyXEL NWD210N
182069f1a80SAndrew Thompson.It ZyXEL NWD270N
183069f1a80SAndrew Thompson.El
184069f1a80SAndrew Thompson.Sh EXAMPLES
185069f1a80SAndrew ThompsonJoin an existing BSS network (i.e., connect to an access point):
186069f1a80SAndrew Thompson.Bd -literal -offset indent
187069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 inet 192.168.0.20 \e
188069f1a80SAndrew Thompson    netmask 0xffffff00
189069f1a80SAndrew Thompson.Ed
190069f1a80SAndrew Thompson.Pp
191069f1a80SAndrew ThompsonJoin a specific BSS network with network name
192069f1a80SAndrew Thompson.Dq Li my_net :
193069f1a80SAndrew Thompson.Pp
194069f1a80SAndrew Thompson.Dl "ifconfig wlan create wlandev run0 ssid my_net up"
195069f1a80SAndrew Thompson.Pp
196069f1a80SAndrew ThompsonJoin a specific BSS network with 64-bit WEP encryption:
197069f1a80SAndrew Thompson.Bd -literal -offset indent
198069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 ssid my_net \e
199069f1a80SAndrew Thompson	wepmode on wepkey 0x1234567890 weptxkey 1 up
200069f1a80SAndrew Thompson.Ed
201069f1a80SAndrew Thompson.Pp
202069f1a80SAndrew ThompsonJoin a specific BSS network with 128-bit WEP encryption:
203069f1a80SAndrew Thompson.Bd -literal -offset indent
204069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
205069f1a80SAndrew Thompson    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
206069f1a80SAndrew Thompson.Ed
207069f1a80SAndrew Thompson.Sh DIAGNOSTICS
208069f1a80SAndrew Thompson.Bl -diag
20902d09fbbSAndrew Thompson.It "run%d: faild load firmware of file runfw"
210069f1a80SAndrew ThompsonFor some reason, the driver was unable to read the microcode file from the
211069f1a80SAndrew Thompsonfilesystem.
212069f1a80SAndrew ThompsonThe file might be missing or corrupted.
213069f1a80SAndrew Thompson.It "run%d: could not load 8051 microcode"
214069f1a80SAndrew ThompsonAn error occurred while attempting to upload the microcode to the onboard 8051
215069f1a80SAndrew Thompsonmicrocontroller unit.
216069f1a80SAndrew Thompson.It "run%d: device timeout"
217069f1a80SAndrew ThompsonA frame dispatched to the hardware for transmission did not complete in time.
218069f1a80SAndrew ThompsonThe driver will reset the hardware.
219069f1a80SAndrew ThompsonThis should not happen.
220069f1a80SAndrew Thompson.El
221069f1a80SAndrew Thompson.Sh SEE ALSO
22202d09fbbSAndrew Thompson.Xr runfw 4 ,
223069f1a80SAndrew Thompson.Xr intro 4 ,
224069f1a80SAndrew Thompson.Xr netintro 4 ,
225069f1a80SAndrew Thompson.Xr usb 4 ,
226069f1a80SAndrew Thompson.Xr wlan 4 ,
227069f1a80SAndrew Thompson.Xr wlan_amrr 4 ,
228069f1a80SAndrew Thompson.Xr wlan_ccmp 4 ,
229069f1a80SAndrew Thompson.Xr wlan_tkip 4 ,
230069f1a80SAndrew Thompson.Xr wlan_wep 4 ,
231069f1a80SAndrew Thompson.Xr wlan_xauth 4 ,
232069f1a80SAndrew Thompson.Xr ifconfig 8 ,
233069f1a80SAndrew Thompson.Xr hostapd 8 ,
23450d922a0SGlen Barber.Xr wpa_supplicant 8
235069f1a80SAndrew Thompson.Pp
236069f1a80SAndrew ThompsonRalink Technology:
237069f1a80SAndrew Thompson.Pa http://www.ralinktech.com/
238069f1a80SAndrew Thompson.Sh HISTORY
239069f1a80SAndrew ThompsonThe
240069f1a80SAndrew Thompson.Nm
241069f1a80SAndrew Thompsondriver first appeared in
242069f1a80SAndrew Thompson.Ox 4.5 .
243069f1a80SAndrew Thompson.Sh AUTHORS
244069f1a80SAndrew ThompsonThe
245069f1a80SAndrew Thompson.Nm
246069f1a80SAndrew Thompsondriver was written by
247069f1a80SAndrew Thompson.An Damien Bergamini Aq damien@openbsd.org .
248069f1a80SAndrew Thompson.Sh CAVEATS
249069f1a80SAndrew ThompsonThe
250069f1a80SAndrew Thompson.Nm
251069f1a80SAndrew Thompsondriver does not support any of the 802.11n capabilities offered by the
252*7a7e01caSKevin LoRT2800, RT3000 and RT3900 chipsets.
253