xref: /openbsd-src/share/man/man4/run.4 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\" $OpenBSD: run.4,v 1.10 2009/03/28 12:32:40 jsg Exp $
2.\"
3.\" Copyright (c) 2008 Damien Bergamini <damien.bergamini@free.fr>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 28 2009 $
18.Os
19.Dt RUN 4
20.Sh NAME
21.Nm run
22.Nd Ralink Technology USB IEEE 802.11a/b/g/Draft-N wireless network device
23.Sh SYNOPSIS
24.Cd "run* at uhub? port ?"
25.Sh DESCRIPTION
26The
27.Nm
28driver supports USB 2.0 wireless adapters based on the Ralink RT2700U,
29RT2800U and RT3000U chipsets.
30.Pp
31The RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and
32an RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver.
33.Pp
34The RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and
35an RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver.
36.Pp
37The RT3000U is a single-chip solution based on an RT3070 MAC/BBP and
38an RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio
39transceiver.
40.Pp
41These are the modes the
42.Nm
43driver can operate in:
44.Bl -tag -width "IBSS-masterXX"
45.It BSS mode
46Also known as
47.Em infrastructure
48mode, this is used when associating with an access point, through
49which all traffic passes.
50This mode is the default.
51.It monitor mode
52In this mode the driver is able to receive packets without
53associating with an access point.
54This disables the internal receive filter and enables the card to
55capture packets from networks which it wouldn't normally have access to,
56or to scan for access points.
57.El
58.Pp
59The
60.Nm
61driver can be configured to use
62Wireless Equivalent Privacy (WEP) or
63Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
64WPA is the de facto encryption standard for wireless networks.
65It is strongly recommended that WEP
66not be used as the sole mechanism
67to secure wireless communication,
68due to serious weaknesses in it.
69The
70.Nm
71driver offloads both encryption and decryption of unicast data frames to the
72hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
73.Pp
74The
75.Nm
76driver can be configured at runtime with
77.Xr ifconfig 8
78or on boot with
79.Xr hostname.if 5 .
80.Sh FILES
81The driver needs at least version 1.0 of the following firmware file,
82which is loaded when an interface is brought up:
83.Pp
84.Bl -tag -width Ds -offset indent -compact
85.It /etc/firmware/run-rt2870
86.El
87.Sh HARDWARE
88The following adapters should work:
89.Pp
90.Bl -tag -width Ds -offset indent -compact
91.It Airlink101 AWLL6090
92.It ASUS USB-N11
93.It ASUS WL-160N
94.It Belkin F5D8051 ver 3000
95.It Belkin F5D8053
96.It Belkin F5D8055
97.It Buffalo WLI-UC-AG300N
98.It Buffalo WLI-UC-G300N
99.It Buffalo WLI-UC-GN
100.It Corega CG-WLUSB2GNL
101.It Corega CG-WLUSB2GNR
102.It Corega CG-WLUSB300AGN
103.It Corega CG-WLUSB300GNM
104.It D-Link DWA-130
105.It D-Link DWA-140
106.It DrayTek Vigor N61
107.It Edimax EW-7711UAn
108.It Edimax EW-7717Un
109.It Edimax EW-7718Un
110.It Gigabyte GN-WB30N
111.It Gigabyte GN-WB31N
112.It Gigabyte GN-WB32L
113.It Hawking HWDN1
114.It Hawking HWUN1
115.It Hawking HWUN2
116.It Linksys WUSB600N
117.It Planex GW-USMicroN
118.It Planex GW-US300MiniS
119.It Sitecom WL-182
120.It Sitecom WL-188
121.It Sitecom WL-301
122.It Sitecom WL-302
123.It Sitecom WL-315
124.It SMC SMCWUSBS-N2
125.It Sweex LW303
126.It Sweex LW313
127.It ZyXEL NWD210N
128.El
129.Sh EXAMPLES
130The following
131.Xr hostname.if 5
132example configures run0 to join whatever network is available on boot,
133using WEP key
134.Dq 0x1deadbeef1 ,
135channel 11, obtaining an IP address using DHCP:
136.Bd -literal -offset indent
137dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
138.Ed
139.Pp
140Configure run0 to join network
141.Dq my_net
142using WPA-PSK with passphrase
143.Dq my_passphrase :
144.Bd -literal -offset indent
145# ifconfig run0 nwid my_net wpa wpapsk \e
146	`wpa-psk my_net my_passphrase`
147.Ed
148.Pp
149Return run0 to its default settings:
150.Bd -literal -offset indent
151# ifconfig run0 -bssid -chan media autoselect \e
152	nwid "" -nwkey -wpa -wpapsk
153.Ed
154.Pp
155Join an existing BSS network,
156.Dq my_net :
157.Bd -literal -offset indent
158# ifconfig run0 192.168.1.1 netmask 0xffffff00 nwid my_net
159.Ed
160.Sh DIAGNOSTICS
161.Bl -diag
162.It "run%d: error %d, could not read firmware %s"
163For some reason, the driver was unable to read the microcode file from the
164filesystem.
165The file might be missing or corrupted.
166.It "run%d: could not load 8051 microcode"
167An error occurred while attempting to upload the microcode to the onboard 8051
168microcontroller unit.
169.It "run%d: device timeout"
170A frame dispatched to the hardware for transmission did not complete in time.
171The driver will reset the hardware.
172This should not happen.
173.El
174.Sh SEE ALSO
175.Xr arp 4 ,
176.Xr ifmedia 4 ,
177.Xr intro 4 ,
178.Xr netintro 4 ,
179.Xr usb 4 ,
180.Xr hostname.if 5 ,
181.Xr ifconfig 8 ,
182.Xr wpa-psk 8
183.Pp
184Ralink Technology:
185.Pa http://www.ralinktech.com/
186.Sh HISTORY
187The
188.Nm
189driver first appeared in
190.Ox 4.5 .
191.Sh AUTHORS
192The
193.Nm
194driver was written by
195.An Damien Bergamini Aq damien@openbsd.org .
196.Sh CAVEATS
197The
198.Nm
199driver does not support any of the 802.11n capabilities offered by the
200RT2800 and RT3000 chipsets.
201Additional work is required in
202.Xr ieee80211 9
203before those features can be supported.
204