xref: /freebsd/share/man/man4/run.4 (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
1.\" $OpenBSD: run.4,v 1.22 2009/11/23 06:16:32 jmc 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.\" $FreeBSD$
18.\"
19.Dd April 19, 2015
20.Dt RUN 4
21.Os
22.Sh NAME
23.Nm run
24.Nd Ralink Technology USB IEEE 802.11a/g/n wireless network device
25.Sh SYNOPSIS
26To compile this driver into the kernel,
27place the following lines in your
28kernel configuration file:
29.Bd -ragged -offset indent
30.Cd "device ehci"
31.Cd "device uhci"
32.Cd "device ohci"
33.Cd "device usb"
34.Cd "device run"
35.Cd "device wlan"
36.Cd "device wlan_amrr"
37.Ed
38.Pp
39Firmware is also needed, and provided by:
40.Bd -ragged -offset indent
41.Cd "device runfw"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following lines in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48if_run_load="YES"
49runfw_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver supports USB 2.0 wireless adapters based on the Ralink RT2700U,
55RT2800U, RT3000U and RT3900E chipsets.
56.Pp
57The RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and
58an RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver.
59.Pp
60The RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and
61an RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver.
62.Pp
63The RT3000U is a single-chip solution based on an RT3070 MAC/BBP and
64an RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio
65transceiver.
66.Pp
67The RT3900E is a single-chip USB 2.0 802.11n solution.
68The MAC/Baseband Processor can be an RT3593, RT5390, RT5392 or an RT5592.
69The radio can be an RT3053, RT5370, RT5372 or an RT5572.
70The RT3053 chip operates in the 2GHz and 5GHz spectra and supports up to
713 transmit paths and 3 receiver paths (3T3R).
72The RT5370 chip operates in the 2GHz spectrum and supports 1 transmit path
73and 1 receiver path (1T1R).
74The RT5372 chip operates in the 2GHz spectrum and supports up to 2 transmit
75paths and 2 receiver paths (2T2R).
76The RT5572 chip operates in the 2GHz and 5GHz spectra and supports up to
772 transmit paths and 2 receiver paths (2T2R).
78.Pp
79These are the modes the
80.Nm
81driver can operate in:
82.Bl -tag -width "IBSS-masterXX"
83.It BSS mode
84Also known as
85.Em infrastructure
86mode, this is used when associating with an access point, through
87which all traffic passes.
88This mode is the default.
89.It Host AP mode
90In this mode the driver acts as an access point (base station)
91for other cards.
92.It monitor mode
93In this mode the driver is able to receive packets without
94associating with an access point.
95This disables the internal receive filter and enables the card to
96capture packets from networks which it wouldn't normally have access to,
97or to scan for access points.
98.El
99.Pp
100The
101.Nm
102driver can be configured to use
103Wired Equivalent Privacy (WEP) or
104Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
105WPA is the de facto encryption standard for wireless networks.
106It is strongly recommended that WEP
107not be used as the sole mechanism
108to secure wireless communication,
109due to serious weaknesses in it.
110The
111.Nm
112driver offloads both encryption and decryption of data frames to the
113hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
114.Pp
115The
116.Nm
117driver can be configured at runtime with
118.Xr ifconfig 8 .
119.Sh HARDWARE
120The
121.Nm
122driver supports the following wireless adapters:
123.Pp
124.Bl -tag -width Ds -offset indent -compact
125.It Airlink101 AWLL6090
126.It ASUS USB-N11
127.It ASUS USB-N13 ver. A1
128.It ASUS USB-N66
129.It ASUS WL-160N
130.It Belkin F5D8051 ver 3000
131.It Belkin F5D8053
132.It Belkin F5D8055
133.It Belkin F6D4050 ver 1
134.It Belkin F9L1103
135.It Buffalo WLI-UC-AG300N
136.It Buffalo WLI-UC-G300HP
137.It Buffalo WLI-UC-G300N
138.It Buffalo WLI-UC-G301N
139.It Buffalo WLI-UC-GN
140.It Buffalo WLI-UC-GNM
141.It Buffalo WLI-UC-GNM2
142.It Corega CG-WLUSB2GNL
143.It Corega CG-WLUSB2GNR
144.It Corega CG-WLUSB300AGN
145.It Corega CG-WLUSB300GNM
146.It D-Link DWA-130 rev B1
147.It D-Link DWA-140 rev B1, B2, B3, \&D1
148.It D-Link DWA-160 rev B2
149.It D-Link DWA-162
150.It DrayTek Vigor N61
151.It Edimax EW-7711UAn
152.It Edimax EW-7711UTn
153.It Edimax EW-7717Un
154.It Edimax EW-7718Un
155.It Edimax EW-7733UnD
156.It Gigabyte GN-WB30N
157.It Gigabyte GN-WB31N
158.It Gigabyte GN-WB32L
159.It Hawking HWDN1
160.It Hawking HWUN1
161.It Hawking HWUN2
162.It Hercules HWNU-300
163.It Linksys WUSB54GC v3
164.It Linksys WUSB600N
165.It Logitec LAN-W150N/U2
166.It Mvix Nubbin MS-811N
167.It Planex GW-USMicroN
168.It Planex GW-US300MiniS
169.It Sitecom WL-182
170.It Sitecom WL-188
171.It Sitecom WL-301
172.It Sitecom WL-302
173.It Sitecom WL-315
174.It SMC SMCWUSBS-N2
175.It Sweex LW303
176.It Sweex LW313
177.It TP-LINK TL-WDN3200
178.It TP-LINK TL-WN727N v3
179.It Unex DNUR-81
180.It Unex DNUR-82
181.It ZyXEL NWD2705
182.It ZyXEL NWD210N
183.It ZyXEL NWD270N
184.El
185.Sh EXAMPLES
186Join an existing BSS network (i.e., connect to an access point):
187.Bd -literal -offset indent
188ifconfig wlan create wlandev run0 inet 192.168.0.20 \e
189    netmask 0xffffff00
190.Ed
191.Pp
192Join a specific BSS network with network name
193.Dq Li my_net :
194.Pp
195.Dl "ifconfig wlan create wlandev run0 ssid my_net up"
196.Pp
197Join a specific BSS network with 64-bit WEP encryption:
198.Bd -literal -offset indent
199ifconfig wlan create wlandev run0 ssid my_net \e
200	wepmode on wepkey 0x1234567890 weptxkey 1 up
201.Ed
202.Pp
203Join a specific BSS network with 128-bit WEP encryption:
204.Bd -literal -offset indent
205ifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
206    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
207.Ed
208.Sh DIAGNOSTICS
209.Bl -diag
210.It "run%d: faild load firmware of file runfw"
211For some reason, the driver was unable to read the microcode file from the
212filesystem.
213The file might be missing or corrupted.
214.It "run%d: could not load 8051 microcode"
215An error occurred while attempting to upload the microcode to the onboard 8051
216microcontroller unit.
217.It "run%d: device timeout"
218A frame dispatched to the hardware for transmission did not complete in time.
219The driver will reset the hardware.
220This should not happen.
221.El
222.Sh SEE ALSO
223.Xr intro 4 ,
224.Xr netintro 4 ,
225.Xr runfw 4 ,
226.Xr usb 4 ,
227.Xr wlan 4 ,
228.Xr wlan_amrr 4 ,
229.Xr wlan_ccmp 4 ,
230.Xr wlan_tkip 4 ,
231.Xr wlan_wep 4 ,
232.Xr wlan_xauth 4 ,
233.Xr hostapd 8 ,
234.Xr ifconfig 8 ,
235.Xr wpa_supplicant 8
236.Pp
237Ralink Technology:
238.Pa http://www.ralinktech.com/
239.Sh HISTORY
240The
241.Nm
242driver first appeared in
243.Ox 4.5 .
244.Sh AUTHORS
245The
246.Nm
247driver was written by
248.An Damien Bergamini Aq Mt damien@openbsd.org .
249.Sh CAVEATS
250The
251.Nm
252driver does not support any of the 802.11n capabilities offered by the
253RT2800, RT3000 and RT3900 chipsets.
254