share/man/man4/run.4

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