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: stable/10/share/man/man4/run.4 259453 2013-12-16 08:10:38Z hselasky $
18.\"
19.Dd November 11, 2013
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 solution based on an RT5390 MAC/BBP and
68an RT5370 (1T1R) or RT5372 (2T2R) single-band radio transceiver.
69.Pp
70These are the modes the
71.Nm
72driver can operate in:
73.Bl -tag -width "IBSS-masterXX"
74.It BSS mode
75Also known as
76.Em infrastructure
77mode, this is used when associating with an access point, through
78which all traffic passes.
79This mode is the default.
80.It Host AP mode
81In this mode the driver acts as an access point (base station)
82for other cards.
83.It monitor mode
84In this mode the driver is able to receive packets without
85associating with an access point.
86This disables the internal receive filter and enables the card to
87capture packets from networks which it wouldn't normally have access to,
88or to scan for access points.
89.El
90.Pp
91The
92.Nm
93driver can be configured to use
94Wired Equivalent Privacy (WEP) or
95Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
96WPA is the de facto encryption standard for wireless networks.
97It is strongly recommended that WEP
98not be used as the sole mechanism
99to secure wireless communication,
100due to serious weaknesses in it.
101The
102.Nm
103driver offloads both encryption and decryption of data frames to the
104hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
105.Pp
106The
107.Nm
108driver can be configured at runtime with
109.Xr ifconfig 8 .
110.Sh HARDWARE
111The
112.Nm
113driver supports the following wireless adapters:
114.Pp
115.Bl -tag -width Ds -offset indent -compact
116.It Airlink101 AWLL6090
117.It ASUS USB-N11
118.It ASUS USB-N13 ver. A1
119.It ASUS WL-160N
120.It Belkin F5D8051 ver 3000
121.It Belkin F5D8053
122.It Belkin F5D8055
123.It Belkin F6D4050 ver 1
124.It Buffalo WLI-UC-AG300N
125.It Buffalo WLI-UC-G300N
126.It Buffalo WLI-UC-G301N
127.It Buffalo WLI-UC-GN
128.It Buffalo WLI-UC-GNM
129.It Buffalo WLI-UC-GNM2
130.It Corega CG-WLUSB2GNL
131.It Corega CG-WLUSB2GNR
132.It Corega CG-WLUSB300AGN
133.It Corega CG-WLUSB300GNM
134.It D-Link DWA-130 rev B1
135.It D-Link DWA-140 rev B1, B2, B3
136.It D-Link DWA-160 rev B2
137.It DrayTek Vigor N61
138.It Edimax EW-7711UAn
139.It Edimax EW-7711UTn
140.It Edimax EW-7717Un
141.It Edimax EW-7718Un
142.It Gigabyte GN-WB30N
143.It Gigabyte GN-WB31N
144.It Gigabyte GN-WB32L
145.It Hawking HWDN1
146.It Hawking HWUN1
147.It Hawking HWUN2
148.It Hercules HWNU-300
149.It Linksys WUSB54GC v3
150.It Linksys WUSB600N
151.It Logitec LAN-W150N/U2
152.It Mvix Nubbin MS-811N
153.It Planex GW-USMicroN
154.It Planex GW-US300MiniS
155.It Sitecom WL-182
156.It Sitecom WL-188
157.It Sitecom WL-301
158.It Sitecom WL-302
159.It Sitecom WL-315
160.It SMC SMCWUSBS-N2
161.It Sweex LW303
162.It Sweex LW313
163.It TP-LINK TL-WDN3200
164.It TP-LINK TL-WN727N v3
165.It Unex DNUR-81
166.It Unex DNUR-82
167.It ZyXEL NWD210N
168.It ZyXEL NWD270N
169.El
170.Sh EXAMPLES
171Join an existing BSS network (i.e., connect to an access point):
172.Bd -literal -offset indent
173ifconfig wlan create wlandev run0 inet 192.168.0.20 \e
174 netmask 0xffffff00
175.Ed
176.Pp
177Join a specific BSS network with network name
178.Dq Li my_net :
179.Pp
180.Dl "ifconfig wlan create wlandev run0 ssid my_net up"
181.Pp
182Join a specific BSS network with 64-bit WEP encryption:
183.Bd -literal -offset indent
184ifconfig wlan create wlandev run0 ssid my_net \e
185 wepmode on wepkey 0x1234567890 weptxkey 1 up
186.Ed
187.Pp
188Join a specific BSS network with 128-bit WEP encryption:
189.Bd -literal -offset indent
190ifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
191 wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
192.Ed
193.Sh DIAGNOSTICS
194.Bl -diag
195.It "run%d: faild load firmware of file runfw"
196For some reason, the driver was unable to read the microcode file from the
197filesystem.
198The file might be missing or corrupted.
199.It "run%d: could not load 8051 microcode"
200An error occurred while attempting to upload the microcode to the onboard 8051
201microcontroller unit.
202.It "run%d: device timeout"
203A frame dispatched to the hardware for transmission did not complete in time.
204The driver will reset the hardware.
205This should not happen.
206.El
207.Sh SEE ALSO
208.Xr runfw 4 ,
209.Xr intro 4 ,
210.Xr netintro 4 ,
211.Xr usb 4 ,
212.Xr wlan 4 ,
213.Xr wlan_amrr 4 ,
214.Xr wlan_ccmp 4 ,
215.Xr wlan_tkip 4 ,
216.Xr wlan_wep 4 ,
217.Xr wlan_xauth 4 ,
218.Xr ifconfig 8 ,
219.Xr hostapd 8 ,
220.Xr wpa_supplicant 8
221.Pp
222Ralink Technology:
223.Pa http://www.ralinktech.com/
224.Sh HISTORY
225The
226.Nm
227driver first appeared in
228.Ox 4.5 .
229.Sh AUTHORS
230The
231.Nm
232driver was written by
233.An Damien Bergamini Aq damien@openbsd.org .
234.Sh CAVEATS
235The
236.Nm
237driver does not support any of the 802.11n capabilities offered by the
238RT2800 and RT3000 chipsets.
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: stable/10/share/man/man4/run.4 259453 2013-12-16 08:10:38Z hselasky $
18.\"
19.Dd November 11, 2013
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 solution based on an RT5390 MAC/BBP and
68an RT5370 (1T1R) or RT5372 (2T2R) single-band radio transceiver.
69.Pp
70These are the modes the
71.Nm
72driver can operate in:
73.Bl -tag -width "IBSS-masterXX"
74.It BSS mode
75Also known as
76.Em infrastructure
77mode, this is used when associating with an access point, through
78which all traffic passes.
79This mode is the default.
80.It Host AP mode
81In this mode the driver acts as an access point (base station)
82for other cards.
83.It monitor mode
84In this mode the driver is able to receive packets without
85associating with an access point.
86This disables the internal receive filter and enables the card to
87capture packets from networks which it wouldn't normally have access to,
88or to scan for access points.
89.El
90.Pp
91The
92.Nm
93driver can be configured to use
94Wired Equivalent Privacy (WEP) or
95Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
96WPA is the de facto encryption standard for wireless networks.
97It is strongly recommended that WEP
98not be used as the sole mechanism
99to secure wireless communication,
100due to serious weaknesses in it.
101The
102.Nm
103driver offloads both encryption and decryption of data frames to the
104hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
105.Pp
106The
107.Nm
108driver can be configured at runtime with
109.Xr ifconfig 8 .
110.Sh HARDWARE
111The
112.Nm
113driver supports the following wireless adapters:
114.Pp
115.Bl -tag -width Ds -offset indent -compact
116.It Airlink101 AWLL6090
117.It ASUS USB-N11
118.It ASUS USB-N13 ver. A1
119.It ASUS WL-160N
120.It Belkin F5D8051 ver 3000
121.It Belkin F5D8053
122.It Belkin F5D8055
123.It Belkin F6D4050 ver 1
124.It Buffalo WLI-UC-AG300N
125.It Buffalo WLI-UC-G300N
126.It Buffalo WLI-UC-G301N
127.It Buffalo WLI-UC-GN
128.It Buffalo WLI-UC-GNM
129.It Buffalo WLI-UC-GNM2
130.It Corega CG-WLUSB2GNL
131.It Corega CG-WLUSB2GNR
132.It Corega CG-WLUSB300AGN
133.It Corega CG-WLUSB300GNM
134.It D-Link DWA-130 rev B1
135.It D-Link DWA-140 rev B1, B2, B3
136.It D-Link DWA-160 rev B2
137.It DrayTek Vigor N61
138.It Edimax EW-7711UAn
139.It Edimax EW-7711UTn
140.It Edimax EW-7717Un
141.It Edimax EW-7718Un
142.It Gigabyte GN-WB30N
143.It Gigabyte GN-WB31N
144.It Gigabyte GN-WB32L
145.It Hawking HWDN1
146.It Hawking HWUN1
147.It Hawking HWUN2
148.It Hercules HWNU-300
149.It Linksys WUSB54GC v3
150.It Linksys WUSB600N
151.It Logitec LAN-W150N/U2
152.It Mvix Nubbin MS-811N
153.It Planex GW-USMicroN
154.It Planex GW-US300MiniS
155.It Sitecom WL-182
156.It Sitecom WL-188
157.It Sitecom WL-301
158.It Sitecom WL-302
159.It Sitecom WL-315
160.It SMC SMCWUSBS-N2
161.It Sweex LW303
162.It Sweex LW313
163.It TP-LINK TL-WDN3200
164.It TP-LINK TL-WN727N v3
165.It Unex DNUR-81
166.It Unex DNUR-82
167.It ZyXEL NWD210N
168.It ZyXEL NWD270N
169.El
170.Sh EXAMPLES
171Join an existing BSS network (i.e., connect to an access point):
172.Bd -literal -offset indent
173ifconfig wlan create wlandev run0 inet 192.168.0.20 \e
174 netmask 0xffffff00
175.Ed
176.Pp
177Join a specific BSS network with network name
178.Dq Li my_net :
179.Pp
180.Dl "ifconfig wlan create wlandev run0 ssid my_net up"
181.Pp
182Join a specific BSS network with 64-bit WEP encryption:
183.Bd -literal -offset indent
184ifconfig wlan create wlandev run0 ssid my_net \e
185 wepmode on wepkey 0x1234567890 weptxkey 1 up
186.Ed
187.Pp
188Join a specific BSS network with 128-bit WEP encryption:
189.Bd -literal -offset indent
190ifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
191 wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
192.Ed
193.Sh DIAGNOSTICS
194.Bl -diag
195.It "run%d: faild load firmware of file runfw"
196For some reason, the driver was unable to read the microcode file from the
197filesystem.
198The file might be missing or corrupted.
199.It "run%d: could not load 8051 microcode"
200An error occurred while attempting to upload the microcode to the onboard 8051
201microcontroller unit.
202.It "run%d: device timeout"
203A frame dispatched to the hardware for transmission did not complete in time.
204The driver will reset the hardware.
205This should not happen.
206.El
207.Sh SEE ALSO
208.Xr runfw 4 ,
209.Xr intro 4 ,
210.Xr netintro 4 ,
211.Xr usb 4 ,
212.Xr wlan 4 ,
213.Xr wlan_amrr 4 ,
214.Xr wlan_ccmp 4 ,
215.Xr wlan_tkip 4 ,
216.Xr wlan_wep 4 ,
217.Xr wlan_xauth 4 ,
218.Xr ifconfig 8 ,
219.Xr hostapd 8 ,
220.Xr wpa_supplicant 8
221.Pp
222Ralink Technology:
223.Pa http://www.ralinktech.com/
224.Sh HISTORY
225The
226.Nm
227driver first appeared in
228.Ox 4.5 .
229.Sh AUTHORS
230The
231.Nm
232driver was written by
233.An Damien Bergamini Aq damien@openbsd.org .
234.Sh CAVEATS
235The
236.Nm
237driver does not support any of the 802.11n capabilities offered by the
238RT2800 and RT3000 chipsets.