share/man/man4/rum.4

   1 .\"
   2 .\" Copyright (c) 2005-2007
   3 .\"     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 13, 2008
  20 .Os
  21 .Dt RUM 4
  22 .Sh NAME
  23 .Nm rum
  24 .Nd Ralink Technology USB IEEE 802.11a/b/g 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 rum"
  35 .Cd "device wlan"
  36 .Cd "device wlan_amrr"
  37 .Ed
  38 .Pp
  39 Alternatively, to load the driver as a
  40 module at boot time, place the following line in
  41 .Xr loader.conf 5 :
  42 .Bd -literal -offset indent
  43 if_rum_load="YES"
  44 .Ed
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 driver supports USB 2.0 and PCI Express Mini Card wireless adapters
  49 based on the Ralink RT2501USB and RT2601USB chipsets.
  50 .Pp
  51 Ralink PCI Express Mini Card adapters show up as normal USB 2.0
  52 devices and are thus handled by the
  53 .Nm
  54 driver.
  55 .Pp
  56 The RT2501USB chipset is the second generation of 802.11a/b/g adapters from
  57 Ralink.
  58 It consists of two integrated chips, an RT2571W MAC/BBP and an RT2528 or
  59 RT5226 radio transceiver.
  60 .Pp
  61 The RT2601USB chipset consists of two integrated chips, an RT2671
  62 MAC/BBP and an RT2527 or RT5225 radio transceiver.
  63 This chipset uses the MIMO (multiple-input multiple-output) technology
  64 with multiple antennas to extend the operating range of the adapter
  65 and to achieve higher throughput.
  66 .Pp
  67 .Nm
  68 supports
  69 .Cm station ,
  70 .Cm adhoc ,
  71 .Cm hostap ,
  72 and
  73 .Cm monitor
  74 mode operation.
  75 Only one virtual interface may be configured at any time.
  76 For more information on configuring this device, see
  77 .Xr ifconfig 8 .
  78 .Sh HARDWARE
  79 The
  80 .Nm
  81 driver supports USB 2.0 wireless
  82 adapters based on the Ralink RT2501USB and RT2601USB chipsets,
  83 including:
  84 .Pp
  85 .Bl -column -compact "Atlantis Land A02-PCM-W54" "Bus"
  86 .It Em Card Ta Em Bus
  87 .It "3Com Aolynk WUB320g" Ta USB
  88 .It "Abocom WUG2700 Ta" Ta USB
  89 .It "Airlink101 AWLL5025" Ta USB
  90 .It "ASUS WL-167g ver 2" Ta USB
  91 .It "Belkin F5D7050 ver 3" Ta USB
  92 .It "Belkin F5D9050 ver 3" Ta USB
  93 .It "Buffalo WLI-U2-SG54HP" Ta USB
  94 .It "Buffalo WLI-U2-G54HP" Ta USB
  95 .It "CNet CWD-854 ver F" Ta USB
  96 .It "Conceptronic C54RU ver 2" Ta USB
  97 .It "Corega CG-WLUSB2GO" Ta USB
  98 .It "D-Link DWA-110" Ta USB
  99 .It "D-Link DWA-111" Ta USB
 100 .It "D-Link DWL-G122 rev C1" Ta USB
 101 .It "D-Link WUA-1340" Ta USB
 102 .It "Digitus DN-7003GR" Ta USB
 103 .It "Edimax EW-7318USG" Ta USB
 104 .It "Gigabyte GN-WB01GS" Ta USB
 105 .It "Gigabyte GN-WI05GS" Ta USB
 106 .It "Hawking HWUG1" Ta USB
 107 .It "Hawking HWU54DM" Ta USB
 108 .It "Hercules HWGUSB2-54-LB" Ta USB
 109 .It "Hercules HWGUSB2-54V2-AP" Ta USB
 110 .It "LevelOne WNC-0301USB v3" Ta USB
 111 .It "Linksys WUSB54G rev C" Ta USB
 112 .It "Linksys WUSB54GR" Ta USB
 113 .It "Planex GW-US54HP" Ta USB
 114 .It "Planex GW-US54Mini2" Ta USB
 115 .It "Planex GW-USMM" Ta USB
 116 .It "Senao NUB-3701" Ta USB
 117 .It "Sitecom WL-113 ver 2" Ta USB
 118 .It "Sitecom WL-172" Ta USB
 119 .It "Sweex LW053" Ta USB
 120 .It "TP-LINK TL-WN321G" Ta USB
 121 .El
 122 .Sh EXAMPLES
 123 Join an existing BSS network (i.e., connect to an access point):
 124 .Pp
 125 .Bd -literal -offset indent
 126 ifconfig wlan create wlandev rum0 inet 192.168.0.20 \e
 127     netmask 0xffffff00
 128 .Ed
 129 .Pp
 130 Join a specific BSS network with network name
 131 .Dq Li my_net :
 132 .Pp
 133 .Dl "ifconfig wlan create wlandev rum0 ssid my_net up"
 134 .Pp
 135 Join a specific BSS network with 64-bit WEP encryption:
 136 .Bd -literal -offset indent
 137 ifconfig wlan create wlandev rum0 ssid my_net \e
 138         wepmode on wepkey 0x1234567890 weptxkey 1 up
 139 .Ed
 140 .Pp
 141 Join a specific BSS network with 128-bit WEP encryption:
 142 .Bd -literal -offset indent
 143 ifconfig wlan create wlandev rum0 wlanmode adhoc ssid my_net \e
 144     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 145 .Ed
 146 .Sh DIAGNOSTICS
 147 .Bl -diag
 148 .It "rum%d: could not load 8051 microcode"
 149 An error occurred while attempting to upload the microcode to the onboard 8051
 150 microcontroller unit.
 151 The driver will reset the hardware.
 152 This should not happen.
 153 .El
 154 .Sh SEE ALSO
 155 .Xr intro 4 ,
 156 .Xr netintro 4 ,
 157 .Xr usb 4 ,
 158 .Xr wlan 4 ,
 159 .Xr wlan_amrr 4 ,
 160 .Xr wlan_ccmp 4 ,
 161 .Xr wlan_tkip 4 ,
 162 .Xr wlan_wep 4 ,
 163 .Xr wlan_xauth 4 ,
 164 .Xr ifconfig 8 ,
 165 .Xr hostapd 8 ,
 166 .Xr wpa_supplicant 8 .
 167 .Rs
 168 .%T "Ralink Technology"
 169 .%O http://www.ralinktech.com/
 170 .Re
 171 .Sh HISTORY
 172 The
 173 .Nm
 174 driver first appeared in
 175 .Ox 4.0 .
 176 .Sh AUTHORS
 177 The original
 178 .Nm
 179 driver was written by
 180 .An Niall O'Higgins Aq niallo@openbsd.org
 181 and
 182 .An Damien Bergamini Aq damien@openbsd.org .