xref: /freebsd/share/man/man4/run.4 (revision bd4c283d3f03fe5e8e43d33f6129c3ac5a0b03f6)
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*bd4c283dSKevin Lo.Dd November 11, 2013
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,
55*bd4c283dSKevin 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*bd4c283dSKevin LoThe RT3900E is a single-chip solution based on an RT5390 MAC/BBP and
68*bd4c283dSKevin Loan RT5370 (1T1R) or RT5372 (2T2R) single-band radio transceiver.
69*bd4c283dSKevin Lo.Pp
70069f1a80SAndrew ThompsonThese are the modes the
71069f1a80SAndrew Thompson.Nm
72069f1a80SAndrew Thompsondriver can operate in:
73069f1a80SAndrew Thompson.Bl -tag -width "IBSS-masterXX"
74069f1a80SAndrew Thompson.It BSS mode
75069f1a80SAndrew ThompsonAlso known as
76069f1a80SAndrew Thompson.Em infrastructure
77069f1a80SAndrew Thompsonmode, this is used when associating with an access point, through
78069f1a80SAndrew Thompsonwhich all traffic passes.
79069f1a80SAndrew ThompsonThis mode is the default.
8002d09fbbSAndrew Thompson.It Host AP mode
8102d09fbbSAndrew ThompsonIn this mode the driver acts as an access point (base station)
8202d09fbbSAndrew Thompsonfor other cards.
83069f1a80SAndrew Thompson.It monitor mode
84069f1a80SAndrew ThompsonIn this mode the driver is able to receive packets without
85069f1a80SAndrew Thompsonassociating with an access point.
86069f1a80SAndrew ThompsonThis disables the internal receive filter and enables the card to
87069f1a80SAndrew Thompsoncapture packets from networks which it wouldn't normally have access to,
88069f1a80SAndrew Thompsonor to scan for access points.
89069f1a80SAndrew Thompson.El
90069f1a80SAndrew Thompson.Pp
91069f1a80SAndrew ThompsonThe
92069f1a80SAndrew Thompson.Nm
93069f1a80SAndrew Thompsondriver can be configured to use
94069f1a80SAndrew ThompsonWired Equivalent Privacy (WEP) or
95069f1a80SAndrew ThompsonWi-Fi Protected Access (WPA-PSK and WPA2-PSK).
96069f1a80SAndrew ThompsonWPA is the de facto encryption standard for wireless networks.
97069f1a80SAndrew ThompsonIt is strongly recommended that WEP
98069f1a80SAndrew Thompsonnot be used as the sole mechanism
99069f1a80SAndrew Thompsonto secure wireless communication,
100069f1a80SAndrew Thompsondue to serious weaknesses in it.
101069f1a80SAndrew ThompsonThe
102069f1a80SAndrew Thompson.Nm
103069f1a80SAndrew Thompsondriver offloads both encryption and decryption of data frames to the
104069f1a80SAndrew Thompsonhardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
105069f1a80SAndrew Thompson.Pp
106069f1a80SAndrew ThompsonThe
107069f1a80SAndrew Thompson.Nm
108069f1a80SAndrew Thompsondriver can be configured at runtime with
10902d09fbbSAndrew Thompson.Xr ifconfig 8 .
110069f1a80SAndrew Thompson.Sh HARDWARE
1118680e929SChristian BruefferThe
1128680e929SChristian Brueffer.Nm
1138680e929SChristian Bruefferdriver supports the following wireless adapters:
114069f1a80SAndrew Thompson.Pp
115069f1a80SAndrew Thompson.Bl -tag -width Ds -offset indent -compact
116069f1a80SAndrew Thompson.It Airlink101 AWLL6090
117069f1a80SAndrew Thompson.It ASUS USB-N11
118de27bf32SWarren Block.It ASUS USB-N13 ver. A1
119069f1a80SAndrew Thompson.It ASUS WL-160N
120069f1a80SAndrew Thompson.It Belkin F5D8051 ver 3000
121069f1a80SAndrew Thompson.It Belkin F5D8053
122069f1a80SAndrew Thompson.It Belkin F5D8055
123069f1a80SAndrew Thompson.It Belkin F6D4050 ver 1
124069f1a80SAndrew Thompson.It Buffalo WLI-UC-AG300N
125069f1a80SAndrew Thompson.It Buffalo WLI-UC-G300N
126f1168f99SDaichi GOTO.It Buffalo WLI-UC-G301N
127069f1a80SAndrew Thompson.It Buffalo WLI-UC-GN
128be503393SHiroki Sato.It Buffalo WLI-UC-GNM
129be503393SHiroki Sato.It Buffalo WLI-UC-GNM2
130069f1a80SAndrew Thompson.It Corega CG-WLUSB2GNL
131069f1a80SAndrew Thompson.It Corega CG-WLUSB2GNR
132069f1a80SAndrew Thompson.It Corega CG-WLUSB300AGN
133069f1a80SAndrew Thompson.It Corega CG-WLUSB300GNM
134069f1a80SAndrew Thompson.It D-Link DWA-130 rev B1
135*bd4c283dSKevin Lo.It D-Link DWA-140 rev B1, B2, B3
136069f1a80SAndrew Thompson.It DrayTek Vigor N61
137069f1a80SAndrew Thompson.It Edimax EW-7711UAn
138069f1a80SAndrew Thompson.It Edimax EW-7711UTn
139069f1a80SAndrew Thompson.It Edimax EW-7717Un
140069f1a80SAndrew Thompson.It Edimax EW-7718Un
141069f1a80SAndrew Thompson.It Gigabyte GN-WB30N
142069f1a80SAndrew Thompson.It Gigabyte GN-WB31N
143069f1a80SAndrew Thompson.It Gigabyte GN-WB32L
144069f1a80SAndrew Thompson.It Hawking HWDN1
145069f1a80SAndrew Thompson.It Hawking HWUN1
146069f1a80SAndrew Thompson.It Hawking HWUN2
147069f1a80SAndrew Thompson.It Hercules HWNU-300
148069f1a80SAndrew Thompson.It Linksys WUSB54GC v3
149069f1a80SAndrew Thompson.It Linksys WUSB600N
150be503393SHiroki Sato.It Logitec LAN-W150N/U2
151069f1a80SAndrew Thompson.It Mvix Nubbin MS-811N
152069f1a80SAndrew Thompson.It Planex GW-USMicroN
153069f1a80SAndrew Thompson.It Planex GW-US300MiniS
154069f1a80SAndrew Thompson.It Sitecom WL-182
155069f1a80SAndrew Thompson.It Sitecom WL-188
156069f1a80SAndrew Thompson.It Sitecom WL-301
157069f1a80SAndrew Thompson.It Sitecom WL-302
158069f1a80SAndrew Thompson.It Sitecom WL-315
159069f1a80SAndrew Thompson.It SMC SMCWUSBS-N2
160069f1a80SAndrew Thompson.It Sweex LW303
161069f1a80SAndrew Thompson.It Sweex LW313
162*bd4c283dSKevin Lo.It TP-LINK TL-WN727N v3
163069f1a80SAndrew Thompson.It Unex DNUR-81
164069f1a80SAndrew Thompson.It Unex DNUR-82
165069f1a80SAndrew Thompson.It ZyXEL NWD210N
166069f1a80SAndrew Thompson.It ZyXEL NWD270N
167069f1a80SAndrew Thompson.El
168069f1a80SAndrew Thompson.Sh EXAMPLES
169069f1a80SAndrew ThompsonJoin an existing BSS network (i.e., connect to an access point):
170069f1a80SAndrew Thompson.Bd -literal -offset indent
171069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 inet 192.168.0.20 \e
172069f1a80SAndrew Thompson    netmask 0xffffff00
173069f1a80SAndrew Thompson.Ed
174069f1a80SAndrew Thompson.Pp
175069f1a80SAndrew ThompsonJoin a specific BSS network with network name
176069f1a80SAndrew Thompson.Dq Li my_net :
177069f1a80SAndrew Thompson.Pp
178069f1a80SAndrew Thompson.Dl "ifconfig wlan create wlandev run0 ssid my_net up"
179069f1a80SAndrew Thompson.Pp
180069f1a80SAndrew ThompsonJoin a specific BSS network with 64-bit WEP encryption:
181069f1a80SAndrew Thompson.Bd -literal -offset indent
182069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 ssid my_net \e
183069f1a80SAndrew Thompson	wepmode on wepkey 0x1234567890 weptxkey 1 up
184069f1a80SAndrew Thompson.Ed
185069f1a80SAndrew Thompson.Pp
186069f1a80SAndrew ThompsonJoin a specific BSS network with 128-bit WEP encryption:
187069f1a80SAndrew Thompson.Bd -literal -offset indent
188069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
189069f1a80SAndrew Thompson    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
190069f1a80SAndrew Thompson.Ed
191069f1a80SAndrew Thompson.Sh DIAGNOSTICS
192069f1a80SAndrew Thompson.Bl -diag
19302d09fbbSAndrew Thompson.It "run%d: faild load firmware of file runfw"
194069f1a80SAndrew ThompsonFor some reason, the driver was unable to read the microcode file from the
195069f1a80SAndrew Thompsonfilesystem.
196069f1a80SAndrew ThompsonThe file might be missing or corrupted.
197069f1a80SAndrew Thompson.It "run%d: could not load 8051 microcode"
198069f1a80SAndrew ThompsonAn error occurred while attempting to upload the microcode to the onboard 8051
199069f1a80SAndrew Thompsonmicrocontroller unit.
200069f1a80SAndrew Thompson.It "run%d: device timeout"
201069f1a80SAndrew ThompsonA frame dispatched to the hardware for transmission did not complete in time.
202069f1a80SAndrew ThompsonThe driver will reset the hardware.
203069f1a80SAndrew ThompsonThis should not happen.
204069f1a80SAndrew Thompson.El
205069f1a80SAndrew Thompson.Sh SEE ALSO
20602d09fbbSAndrew Thompson.Xr runfw 4 ,
207069f1a80SAndrew Thompson.Xr intro 4 ,
208069f1a80SAndrew Thompson.Xr netintro 4 ,
209069f1a80SAndrew Thompson.Xr usb 4 ,
210069f1a80SAndrew Thompson.Xr wlan 4 ,
211069f1a80SAndrew Thompson.Xr wlan_amrr 4 ,
212069f1a80SAndrew Thompson.Xr wlan_ccmp 4 ,
213069f1a80SAndrew Thompson.Xr wlan_tkip 4 ,
214069f1a80SAndrew Thompson.Xr wlan_wep 4 ,
215069f1a80SAndrew Thompson.Xr wlan_xauth 4 ,
216069f1a80SAndrew Thompson.Xr ifconfig 8 ,
217069f1a80SAndrew Thompson.Xr hostapd 8 ,
21850d922a0SGlen Barber.Xr wpa_supplicant 8
219069f1a80SAndrew Thompson.Pp
220069f1a80SAndrew ThompsonRalink Technology:
221069f1a80SAndrew Thompson.Pa http://www.ralinktech.com/
222069f1a80SAndrew Thompson.Sh HISTORY
223069f1a80SAndrew ThompsonThe
224069f1a80SAndrew Thompson.Nm
225069f1a80SAndrew Thompsondriver first appeared in
226069f1a80SAndrew Thompson.Ox 4.5 .
227069f1a80SAndrew Thompson.Sh AUTHORS
228069f1a80SAndrew ThompsonThe
229069f1a80SAndrew Thompson.Nm
230069f1a80SAndrew Thompsondriver was written by
231069f1a80SAndrew Thompson.An Damien Bergamini Aq damien@openbsd.org .
232069f1a80SAndrew Thompson.Sh CAVEATS
233069f1a80SAndrew ThompsonThe
234069f1a80SAndrew Thompson.Nm
235069f1a80SAndrew Thompsondriver does not support any of the 802.11n capabilities offered by the
236069f1a80SAndrew ThompsonRT2800 and RT3000 chipsets.
237