share/man/man4/rum.4

   1 .\" $OpenBSD: rum.4,v 1.16 2006/10/19 16:53:48 jsg Exp $
   2 .\" $DragonFly: src/share/man/man4/rum.4,v 1.6 2007/06/16 13:47:44 swildner Exp $
   3 .\"
   4 .\" Copyright (c) 2005, 2006
   5 .\"     Damien Bergamini <damien.bergamini@free.fr>
   6 .\"
   7 .\" Permission to use, copy, modify, and distribute this software for any
   8 .\" purpose with or without fee is hereby granted, provided that the above
   9 .\" copyright notice and this permission notice appear in all copies.
  10 .\"
  11 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18 .\"
  19 .Dd November 26, 2006
  20 .Os
  21 .Dt RUM 4
  22 .Sh NAME
  23 .Nm rum
  24 .Nd "Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver"
  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_ratectl_onoe"
  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 and PCI Express Mini Card wireless adapters based on
  49 the Ralink RT2501USB and RT2601USB chipsets.
  50 .Pp
  51 Ralink PCI Express Mini Card adapters show up as normal USB 2.0 devices and
  52 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
  57 from Ralink.
  58 It consists of two integrated chips,
  59 an RT2571W MAC/BBP and an RT2528 or RT5226 radio transceiver.
  60 .Pp
  61 The RT2601USB chipset consists of two integrated chips,
  62 an RT2671 MAC/BBP and an RT2527 or RT5225 radio transceiver.
  63 This chipset uses the MIMO (multiple-input multiple-output) technology with
  64 multiple antennas to extend the operating range of the adapter and to achieve
  65 higher throughput.
  66 MIMO is the basis of the forthcoming IEEE 802.11n standard.
  67 .Sh HARDWARE
  68 The
  69 .Nm
  70 driver supports the following adapters:
  71 .Pp
  72 .Bl -bullet -compact
  73 .It
  74 3Com Aolynk WUB320g
  75 .It
  76 Abocom WUG2700
  77 .It
  78 Airlink101 AWLL5025
  79 .It
  80 ASUS WL-167g ver 2
  81 .It
  82 Belkin F5D7050 ver 3
  83 .It
  84 Belkin F5D9050 ver 3
  85 .It
  86 Buffalo WLI-U2-SG54HP
  87 .It
  88 Buffalo WLI-U2-G54HP
  89 .It
  90 CNet CWD-854 ver F
  91 .It
  92 Conceptronic C54RU ver 2
  93 .It
  94 Corega CG-WLUSB2GO
  95 .It
  96 D-Link DWL-G122 rev C1
  97 .It
  98 D-Link WUA-1340
  99 .It
 100 Digitus DN-7003GR
 101 .It
 102 Edimax EW-7318USG
 103 .It
 104 Gigabyte GN-WB01GS
 105 .It
 106 Gigabyte GN-WI05GS
 107 .It
 108 Hawking HWUG1
 109 .It
 110 Hawking HWU54DM
 111 .It
 112 Hercules HWGUSB2-54-LB
 113 .It
 114 Hercules HWGUSB2-54V2-AP
 115 .It
 116 LevelOne WNC-0301USB v3
 117 .It
 118 Linksys WUSB54G rev C
 119 .It
 120 Linksys WUSB54GR
 121 .It
 122 Planex GW-US54HP
 123 .It
 124 Planex GW-US54Mini2
 125 .It
 126 Planex GW-USMM
 127 .It
 128 Senao NUB-3701
 129 .It
 130 Sitecom WL-113 ver 2
 131 .It
 132 Sitecom WL-172
 133 .It
 134 Sweex LW053
 135 .It
 136 TP-LINK TL-WN321G
 137 .El
 138 .Sh EXAMPLES
 139 Join an existing BSS network (i.e., connect to an access point):
 140 .Pp
 141 .Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00"
 142 .Pp
 143 Join a specific BSS network with network name
 144 .Dq Li my_net :
 145 .Pp
 146 .Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 147 .Pp
 148 Join a specific BSS network with 40-bit WEP encryption:
 149 .Bd -literal -offset indent
 150 ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 151     wepmode on wepkey 0x1234567890 weptxkey 1
 152 .Ed
 153 .Pp
 154 Join a specific BSS network with 104-bit WEP encryption:
 155 .Bd -literal -offset indent
 156 ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 157     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 158 .Ed
 159 .Sh DIAGNOSTICS
 160 .Bl -diag
 161 .It "rum%d: could not load 8051 microcode"
 162 An error occurred while attempting to upload the microcode to the onboard 8051
 163 microcontroller unit.
 164 .It "rum%d: device timeout"
 165 The driver will reset the hardware.
 166 This should not happen.
 167 .El
 168 .Sh SEE ALSO
 169 .Xr arp 4 ,
 170 .Xr ifmedia 4 ,
 171 .Xr netintro 4 ,
 172 .Xr usb 4 ,
 173 .Xr wlan 4 ,
 174 .Xr wlan_ratectl 4 ,
 175 .Xr ifconfig 8
 176 .Rs
 177 .%T "Ralink Technology"
 178 .%O http://www.ralinktech.com/
 179 .Re
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 driver first appeared in
 184 .Ox 4.0 .
 185 .Sh CAVEATS
 186 The
 187 .Nm
 188 driver supports automatic adaptation of the transmit speed in IBSS
 189 and HostAP operating modes,
 190 but it does not work well if there are more than one peer node.
 191 .Sh AUTHORS
 192 .An -nosplit
 193 The
 194 .Nm
 195 driver was written by
 196 .An Niall O'Higgins Aq niallo@openbsd.org
 197 and
 198 .An Damien Bergamini Aq damien@openbsd.org .