xref: /freebsd/share/man/man4/run.4 (revision 069f1a80566458f62d3fee070b54a98623b9bde0)
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.\"
19069f1a80SAndrew Thompson.Dd January 29, 2010
20069f1a80SAndrew Thompson.Os
21069f1a80SAndrew Thompson.Dt RUN 4
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
39069f1a80SAndrew ThompsonAlternatively, to load the driver as a
40069f1a80SAndrew Thompsonmodule at boot time, place the following line in
41069f1a80SAndrew Thompson.Xr loader.conf 5 :
42069f1a80SAndrew Thompson.Bd -literal -offset indent
43069f1a80SAndrew Thompsonif_run_load="YES"
44069f1a80SAndrew Thompson.Ed
45069f1a80SAndrew Thompson.Sh DESCRIPTION
46069f1a80SAndrew ThompsonThe
47069f1a80SAndrew Thompson.Nm
48069f1a80SAndrew Thompsondriver supports USB 2.0 wireless adapters based on the Ralink RT2700U,
49069f1a80SAndrew ThompsonRT2800U and RT3000U chipsets.
50069f1a80SAndrew Thompson.Pp
51069f1a80SAndrew ThompsonThe RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and
52069f1a80SAndrew Thompsonan RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver.
53069f1a80SAndrew Thompson.Pp
54069f1a80SAndrew ThompsonThe RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and
55069f1a80SAndrew Thompsonan RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver.
56069f1a80SAndrew Thompson.Pp
57069f1a80SAndrew ThompsonThe RT3000U is a single-chip solution based on an RT3070 MAC/BBP and
58069f1a80SAndrew Thompsonan RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio
59069f1a80SAndrew Thompsontransceiver.
60069f1a80SAndrew Thompson.Pp
61069f1a80SAndrew ThompsonThese are the modes the
62069f1a80SAndrew Thompson.Nm
63069f1a80SAndrew Thompsondriver can operate in:
64069f1a80SAndrew Thompson.Bl -tag -width "IBSS-masterXX"
65069f1a80SAndrew Thompson.It BSS mode
66069f1a80SAndrew ThompsonAlso known as
67069f1a80SAndrew Thompson.Em infrastructure
68069f1a80SAndrew Thompsonmode, this is used when associating with an access point, through
69069f1a80SAndrew Thompsonwhich all traffic passes.
70069f1a80SAndrew ThompsonThis mode is the default.
71069f1a80SAndrew Thompson.It monitor mode
72069f1a80SAndrew ThompsonIn this mode the driver is able to receive packets without
73069f1a80SAndrew Thompsonassociating with an access point.
74069f1a80SAndrew ThompsonThis disables the internal receive filter and enables the card to
75069f1a80SAndrew Thompsoncapture packets from networks which it wouldn't normally have access to,
76069f1a80SAndrew Thompsonor to scan for access points.
77069f1a80SAndrew Thompson.El
78069f1a80SAndrew Thompson.Pp
79069f1a80SAndrew ThompsonThe
80069f1a80SAndrew Thompson.Nm
81069f1a80SAndrew Thompsondriver can be configured to use
82069f1a80SAndrew ThompsonWired Equivalent Privacy (WEP) or
83069f1a80SAndrew ThompsonWi-Fi Protected Access (WPA-PSK and WPA2-PSK).
84069f1a80SAndrew ThompsonWPA is the de facto encryption standard for wireless networks.
85069f1a80SAndrew ThompsonIt is strongly recommended that WEP
86069f1a80SAndrew Thompsonnot be used as the sole mechanism
87069f1a80SAndrew Thompsonto secure wireless communication,
88069f1a80SAndrew Thompsondue to serious weaknesses in it.
89069f1a80SAndrew ThompsonThe
90069f1a80SAndrew Thompson.Nm
91069f1a80SAndrew Thompsondriver offloads both encryption and decryption of data frames to the
92069f1a80SAndrew Thompsonhardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
93069f1a80SAndrew Thompson.Pp
94069f1a80SAndrew ThompsonThe
95069f1a80SAndrew Thompson.Nm
96069f1a80SAndrew Thompsondriver can be configured at runtime with
97069f1a80SAndrew Thompson.Xr ifconfig 8
98069f1a80SAndrew Thompsonor on boot with
99069f1a80SAndrew Thompson.Xr hostname.if 5 .
100069f1a80SAndrew Thompson.Sh HARDWARE
101069f1a80SAndrew ThompsonThe following adapters should work:
102069f1a80SAndrew Thompson.Pp
103069f1a80SAndrew Thompson.Bl -tag -width Ds -offset indent -compact
104069f1a80SAndrew Thompson.It Airlink101 AWLL6090
105069f1a80SAndrew Thompson.It ASUS USB-N11
106069f1a80SAndrew Thompson.It ASUS USB-N13
107069f1a80SAndrew Thompson.It ASUS WL-160N
108069f1a80SAndrew Thompson.It Belkin F5D8051 ver 3000
109069f1a80SAndrew Thompson.It Belkin F5D8053
110069f1a80SAndrew Thompson.It Belkin F5D8055
111069f1a80SAndrew Thompson.It Belkin F6D4050 ver 1
112069f1a80SAndrew Thompson.It Buffalo WLI-UC-AG300N
113069f1a80SAndrew Thompson.It Buffalo WLI-UC-G300N
114069f1a80SAndrew Thompson.It Buffalo WLI-UC-GN
115069f1a80SAndrew Thompson.It Corega CG-WLUSB2GNL
116069f1a80SAndrew Thompson.It Corega CG-WLUSB2GNR
117069f1a80SAndrew Thompson.It Corega CG-WLUSB300AGN
118069f1a80SAndrew Thompson.It Corega CG-WLUSB300GNM
119069f1a80SAndrew Thompson.It D-Link DWA-130 rev B1
120069f1a80SAndrew Thompson.It D-Link DWA-140
121069f1a80SAndrew Thompson.It DrayTek Vigor N61
122069f1a80SAndrew Thompson.It Edimax EW-7711UAn
123069f1a80SAndrew Thompson.It Edimax EW-7711UTn
124069f1a80SAndrew Thompson.It Edimax EW-7717Un
125069f1a80SAndrew Thompson.It Edimax EW-7718Un
126069f1a80SAndrew Thompson.It Gigabyte GN-WB30N
127069f1a80SAndrew Thompson.It Gigabyte GN-WB31N
128069f1a80SAndrew Thompson.It Gigabyte GN-WB32L
129069f1a80SAndrew Thompson.It Hawking HWDN1
130069f1a80SAndrew Thompson.It Hawking HWUN1
131069f1a80SAndrew Thompson.It Hawking HWUN2
132069f1a80SAndrew Thompson.It Hercules HWNU-300
133069f1a80SAndrew Thompson.It Linksys WUSB54GC v3
134069f1a80SAndrew Thompson.It Linksys WUSB600N
135069f1a80SAndrew Thompson.It Mvix Nubbin MS-811N
136069f1a80SAndrew Thompson.It Planex GW-USMicroN
137069f1a80SAndrew Thompson.It Planex GW-US300MiniS
138069f1a80SAndrew Thompson.It Sitecom WL-182
139069f1a80SAndrew Thompson.It Sitecom WL-188
140069f1a80SAndrew Thompson.It Sitecom WL-301
141069f1a80SAndrew Thompson.It Sitecom WL-302
142069f1a80SAndrew Thompson.It Sitecom WL-315
143069f1a80SAndrew Thompson.It SMC SMCWUSBS-N2
144069f1a80SAndrew Thompson.It Sweex LW303
145069f1a80SAndrew Thompson.It Sweex LW313
146069f1a80SAndrew Thompson.It Unex DNUR-81
147069f1a80SAndrew Thompson.It Unex DNUR-82
148069f1a80SAndrew Thompson.It ZyXEL NWD210N
149069f1a80SAndrew Thompson.It ZyXEL NWD270N
150069f1a80SAndrew Thompson.El
151069f1a80SAndrew Thompson.Sh EXAMPLES
152069f1a80SAndrew ThompsonJoin an existing BSS network (i.e., connect to an access point):
153069f1a80SAndrew Thompson.Pp
154069f1a80SAndrew Thompson.Bd -literal -offset indent
155069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 inet 192.168.0.20 \e
156069f1a80SAndrew Thompson    netmask 0xffffff00
157069f1a80SAndrew Thompson.Ed
158069f1a80SAndrew Thompson.Pp
159069f1a80SAndrew ThompsonJoin a specific BSS network with network name
160069f1a80SAndrew Thompson.Dq Li my_net :
161069f1a80SAndrew Thompson.Pp
162069f1a80SAndrew Thompson.Dl "ifconfig wlan create wlandev run0 ssid my_net up"
163069f1a80SAndrew Thompson.Pp
164069f1a80SAndrew ThompsonJoin a specific BSS network with 64-bit WEP encryption:
165069f1a80SAndrew Thompson.Bd -literal -offset indent
166069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 ssid my_net \e
167069f1a80SAndrew Thompson	wepmode on wepkey 0x1234567890 weptxkey 1 up
168069f1a80SAndrew Thompson.Ed
169069f1a80SAndrew Thompson.Pp
170069f1a80SAndrew ThompsonJoin a specific BSS network with 128-bit WEP encryption:
171069f1a80SAndrew Thompson.Bd -literal -offset indent
172069f1a80SAndrew Thompsonifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
173069f1a80SAndrew Thompson    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
174069f1a80SAndrew Thompson.Ed
175069f1a80SAndrew Thompson.Sh DIAGNOSTICS
176069f1a80SAndrew Thompson.Bl -diag
177069f1a80SAndrew Thompson.It "run%d: error %d, could not read firmware %s"
178069f1a80SAndrew ThompsonFor some reason, the driver was unable to read the microcode file from the
179069f1a80SAndrew Thompsonfilesystem.
180069f1a80SAndrew ThompsonThe file might be missing or corrupted.
181069f1a80SAndrew Thompson.It "run%d: could not load 8051 microcode"
182069f1a80SAndrew ThompsonAn error occurred while attempting to upload the microcode to the onboard 8051
183069f1a80SAndrew Thompsonmicrocontroller unit.
184069f1a80SAndrew Thompson.It "run%d: device timeout"
185069f1a80SAndrew ThompsonA frame dispatched to the hardware for transmission did not complete in time.
186069f1a80SAndrew ThompsonThe driver will reset the hardware.
187069f1a80SAndrew ThompsonThis should not happen.
188069f1a80SAndrew Thompson.El
189069f1a80SAndrew Thompson.Sh SEE ALSO
190069f1a80SAndrew Thompson.Xr intro 4 ,
191069f1a80SAndrew Thompson.Xr netintro 4 ,
192069f1a80SAndrew Thompson.Xr usb 4 ,
193069f1a80SAndrew Thompson.Xr wlan 4 ,
194069f1a80SAndrew Thompson.Xr wlan_amrr 4 ,
195069f1a80SAndrew Thompson.Xr wlan_ccmp 4 ,
196069f1a80SAndrew Thompson.Xr wlan_tkip 4 ,
197069f1a80SAndrew Thompson.Xr wlan_wep 4 ,
198069f1a80SAndrew Thompson.Xr wlan_xauth 4 ,
199069f1a80SAndrew Thompson.Xr ifconfig 8 ,
200069f1a80SAndrew Thompson.Xr hostapd 8 ,
201069f1a80SAndrew Thompson.Xr wpa_supplicant 8 .
202069f1a80SAndrew Thompson.Pp
203069f1a80SAndrew ThompsonRalink Technology:
204069f1a80SAndrew Thompson.Pa http://www.ralinktech.com/
205069f1a80SAndrew Thompson.Sh HISTORY
206069f1a80SAndrew ThompsonThe
207069f1a80SAndrew Thompson.Nm
208069f1a80SAndrew Thompsondriver first appeared in
209069f1a80SAndrew Thompson.Ox 4.5 .
210069f1a80SAndrew Thompson.Sh AUTHORS
211069f1a80SAndrew ThompsonThe
212069f1a80SAndrew Thompson.Nm
213069f1a80SAndrew Thompsondriver was written by
214069f1a80SAndrew Thompson.An Damien Bergamini Aq damien@openbsd.org .
215069f1a80SAndrew Thompson.Sh CAVEATS
216069f1a80SAndrew ThompsonThe
217069f1a80SAndrew Thompson.Nm
218069f1a80SAndrew Thompsondriver does not support any of the 802.11n capabilities offered by the
219069f1a80SAndrew ThompsonRT2800 and RT3000 chipsets.
220