329 lines
8.6 KiB
Groff
329 lines
8.6 KiB
Groff
.\" $OpenBSD: rum.4,v 1.17 2006/10/22 08:29:01 damien Exp $
|
|
.\" $NetBSD: rum.4,v 1.5 2009/03/09 19:24:28 joerg Exp $
|
|
.\"
|
|
.\" Copyright (c) 2005, 2006
|
|
.\" Damien Bergamini <damien.bergamini@free.fr>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.Dd February 7, 2007
|
|
.Dt RUM 4
|
|
.Os
|
|
.Sh NAME
|
|
.Nm rum
|
|
.Nd Ralink Technology USB IEEE 802.11a/b/g wireless network device
|
|
.Sh SYNOPSIS
|
|
.Cd "rum* at uhub? port ?"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
driver supports USB 2.0 wireless adapters based on the Ralink RT2501USB
|
|
and RT2601USB chipsets.
|
|
.Pp
|
|
The RT2501USB chipset is the second generation of 802.11a/b/g adapters from
|
|
Ralink.
|
|
It consists of two integrated chips, an RT2571W MAC/BBP and an RT2528 or
|
|
RT5226 radio transceiver.
|
|
.Pp
|
|
The RT2601USB chipset consists of two integrated chips, an RT2671 MAC/BBP and
|
|
an RT2527 or RT5225 radio transceiver.
|
|
This chipset uses the MIMO (multiple-input multiple-output) technology with
|
|
multiple antennas to extend the operating range of the adapter and to achieve
|
|
higher throughput.
|
|
MIMO is the basis of the forthcoming IEEE 802.11n standard.
|
|
.Pp
|
|
These are the modes the
|
|
.Nm
|
|
driver can operate in:
|
|
.Bl -tag -width "IBSS-masterXX"
|
|
.It BSS mode
|
|
Also known as
|
|
.Em infrastructure
|
|
mode, this is used when associating with an access point, through
|
|
which all traffic passes.
|
|
This mode is the default.
|
|
.It IBSS mode
|
|
Also known as
|
|
.Em IEEE ad-hoc
|
|
mode or
|
|
.Em peer-to-peer
|
|
mode.
|
|
This is the standardized method of operating without an access point.
|
|
Stations associate with a service set.
|
|
However, actual connections between stations are peer-to-peer.
|
|
.It Host AP
|
|
In this mode the driver acts as an access point (base station)
|
|
for other cards.
|
|
.It monitor mode
|
|
In this mode the driver is able to receive packets without
|
|
associating with an access point.
|
|
This disables the internal receive filter and enables the card to
|
|
capture packets from networks which it wouldn't normally have access to,
|
|
or to scan for access points.
|
|
.El
|
|
.Pp
|
|
.Nm
|
|
supports software WEP.
|
|
Wired Equivalent Privacy (WEP) is the de facto encryption standard
|
|
for wireless networks.
|
|
It can be typically configured in one of three modes:
|
|
no encryption; 40-bit encryption; or 104-bit encryption.
|
|
Unfortunately, due to serious weaknesses in WEP protocol
|
|
it is strongly recommended that it not be used as the
|
|
sole mechanism to secure wireless communication.
|
|
WEP is not enabled by default.
|
|
.Sh CONFIGURATION
|
|
The
|
|
.Nm
|
|
driver can be configured at runtime with
|
|
.Xr ifconfig 8
|
|
or on boot with
|
|
.Xr ifconfig.if 5
|
|
using the following parameters:
|
|
.Bl -tag -width Ds
|
|
.It Cm bssid Ar bssid
|
|
Set the desired BSSID.
|
|
.It Fl bssid
|
|
Unset the desired BSSID.
|
|
The interface will automatically select a BSSID in this mode, which is
|
|
the default.
|
|
.It Cm chan Ar n
|
|
Set the channel (radio frequency) to be used by the driver based on
|
|
the given channel ID
|
|
.Ar n .
|
|
.It Fl chan
|
|
Unset the desired channel to be used by the driver.
|
|
The driver will automatically select a channel in this mode, which is
|
|
the default.
|
|
.It Cm media Ar media
|
|
The
|
|
.Nm
|
|
driver supports the following
|
|
.Ar media
|
|
types:
|
|
.Pp
|
|
.Bl -tag -width autoselect -compact
|
|
.It Cm autoselect
|
|
Enable autoselection of the media type and options.
|
|
.It Cm DS1
|
|
Set 802.11b DS 1Mbps operation.
|
|
.It Cm DS2
|
|
Set 802.11b DS 2Mbps operation.
|
|
.It Cm DS5
|
|
Set 802.11b DS 5.5Mbps operation.
|
|
.It Cm DS11
|
|
Set 802.11b DS 11Mbps operation.
|
|
.It Cm OFDM6
|
|
Set 802.11a/g OFDM 6Mbps operation.
|
|
.It Cm OFDM9
|
|
Set 802.11a/g OFDM 9Mbps operation.
|
|
.It Cm OFDM12
|
|
Set 802.11a/g OFDM 12Mbps operation.
|
|
.It Cm OFDM18
|
|
Set 802.11a/g OFDM 18Mbps operation.
|
|
.It Cm OFDM24
|
|
Set 802.11a/g OFDM 24Mbps operation.
|
|
.It Cm OFDM36
|
|
Set 802.11a/g OFDM 36Mbps operation.
|
|
.It Cm OFDM48
|
|
Set 802.11a/g OFDM 48Mbps operation.
|
|
.It Cm OFDM54
|
|
Set 802.11a/g OFDM 54Mbps operation.
|
|
.El
|
|
.It Cm mediaopt Ar opts
|
|
The
|
|
.Nm
|
|
driver supports the following media options:
|
|
.Pp
|
|
.Bl -tag -width monitor -compact
|
|
.It Cm hostap
|
|
Select Host AP operation.
|
|
.It Cm ibss
|
|
Select IBSS operation.
|
|
.It Cm monitor
|
|
Select monitor mode.
|
|
.El
|
|
.It Fl mediaopt Ar opts
|
|
Disable the specified media options on the driver and return it to the
|
|
default mode of operation (BSS).
|
|
.It Cm mode Ar mode
|
|
The
|
|
.Nm
|
|
driver supports the following modes:
|
|
.Pp
|
|
.Bl -tag -width 11b -compact
|
|
.It Cm 11a
|
|
Force 802.11a operation.
|
|
.It Cm 11b
|
|
Force 802.11b operation.
|
|
.It Cm 11g
|
|
Force 802.11g operation.
|
|
.El
|
|
.It Cm nwid Ar id
|
|
Set the network ID.
|
|
The
|
|
.Ar id
|
|
can either be any text string up to 32 characters in length,
|
|
or a series of hexadecimal digits up to 64 digits.
|
|
An empty
|
|
.Ar id
|
|
string allows the interface to connect to any available access points.
|
|
By default the
|
|
.Nm
|
|
driver uses an empty string.
|
|
Note that network ID is synonymous with Extended Service Set ID (ESSID).
|
|
.It Cm nwkey Ar key
|
|
Enable WEP encryption using the specified
|
|
.Ar key .
|
|
The
|
|
.Ar key
|
|
can either be a string, a series of hexadecimal digits (preceded by
|
|
.Sq 0x ) ,
|
|
or a set of keys of the form
|
|
.Dq n:k1,k2,k3,k4 ,
|
|
where
|
|
.Sq n
|
|
specifies which of the keys will be used for transmitted packets,
|
|
and the four keys,
|
|
.Dq k1
|
|
through
|
|
.Dq k4 ,
|
|
are configured as WEP keys.
|
|
If a set of keys is specified, a comma
|
|
.Pq Sq \&,
|
|
within the key must be escaped with a backslash.
|
|
Note that if multiple keys are used, their order must be the same within
|
|
the network.
|
|
.Nm
|
|
is capable of using both 40-bit (5 characters or 10 hexadecimal digits)
|
|
or 104-bit (13 characters or 26 hexadecimal digits) keys.
|
|
.It Fl nwkey
|
|
Disable WEP encryption.
|
|
This is the default mode of operation.
|
|
.El
|
|
.Sh FILES
|
|
The following firmware file is loaded when an interface is brought up:
|
|
.Pp
|
|
.Bl -tag -width Ds -offset indent -compact
|
|
.It /libdata/firmware/rum/rum-rt2573
|
|
.El
|
|
See
|
|
.Xr firmload 9
|
|
for how to change this.
|
|
.Sh HARDWARE
|
|
The following adapters should work:
|
|
.Pp
|
|
.Bl -tag -width Ds -offset indent -compact
|
|
.It Airlink101 AWLL5025
|
|
.It ASUS WL-167g ver 2
|
|
.It Belkin F5D7050 ver 3
|
|
.It Belkin F5D9050 ver 3
|
|
.It CNet CWD-854 ver F
|
|
.It Conceptronic C54RU ver 2
|
|
.It D-Link DWL-G122 rev C1
|
|
.It D-Link WUA-1340
|
|
.It Edimax EW-7318USG
|
|
.It Gigabyte GN-WB01GS
|
|
.It Hawking HWUG1
|
|
.It LevelOne WNC-0301USB
|
|
.It Linksys WUSB54G rev C
|
|
.It Planex GW-USMM
|
|
.It Senao NUB-3701
|
|
.It Sitecom WL-113 ver 2
|
|
.It Sitecom WL-172
|
|
.It TP-LINK TL-WN321G
|
|
.El
|
|
.Sh EXAMPLES
|
|
The following
|
|
.Xr ifconfig.if 5
|
|
example configures rum0 to join whatever network is available on boot,
|
|
using WEP key
|
|
.Dq 0x1deadbeef1 ,
|
|
channel 11:
|
|
.Bd -literal -offset indent
|
|
inet 192.168.1.1 netmask 255.255.255.0 nwkey 0x1deadbeef1 chan 11
|
|
.Ed
|
|
.Pp
|
|
The following
|
|
.Xr ifconfig.if 5
|
|
example creates a host-based access point on boot:
|
|
.Bd -literal -offset indent
|
|
inet 192.168.1.1 netmask 255.255.255.0 media autoselect \e
|
|
mediaopt hostap nwid my_net chan 11
|
|
.Ed
|
|
.Pp
|
|
Configure rum0 for WEP, using hex key
|
|
.Dq 0x1deadbeef1 :
|
|
.Bd -literal -offset indent
|
|
# ifconfig rum0 nwkey 0x1deadbeef1
|
|
.Ed
|
|
.Pp
|
|
Return rum0 to its default settings:
|
|
.Bd -literal -offset indent
|
|
# ifconfig rum0 -bssid -chan media autoselect \e
|
|
nwid "" -nwkey
|
|
.Ed
|
|
.Pp
|
|
Join an existing BSS network,
|
|
.Dq my_net :
|
|
.Bd -literal -offset indent
|
|
# ifconfig rum0 192.168.1.1 netmask 0xffffff00 nwid my_net
|
|
.Ed
|
|
.Sh DIAGNOSTICS
|
|
.Bl -diag
|
|
.It "rum%d: failed loadfirmware of file %s"
|
|
For some reason, the driver was unable to read the microcode file from the
|
|
filesystem.
|
|
The file might be missing or corrupted.
|
|
.It "rum%d: could not load 8051 microcode"
|
|
An error occurred while attempting to upload the microcode to the onboard 8051
|
|
microcontroller unit.
|
|
.It "rum%d: device timeout"
|
|
A frame dispatched to the hardware for transmission did not complete in time.
|
|
The driver will reset the hardware.
|
|
This should not happen.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr arp 4 ,
|
|
.Xr ifmedia 4 ,
|
|
.Xr netintro 4 ,
|
|
.Xr usb 4 ,
|
|
.Xr ifconfig.if 5 ,
|
|
.Xr hostapd 8 ,
|
|
.Xr ifconfig 8 ,
|
|
.Xr firmload 9
|
|
.Pp
|
|
Ralink Technology:
|
|
.Pa http://www.ralinktech.com
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
driver first appeared in
|
|
.Nx 4.0
|
|
and
|
|
.Ox 4.0 .
|
|
.Sh AUTHORS
|
|
The
|
|
.Nm
|
|
driver was written by
|
|
.An Niall O'Higgins Aq niallo@openbsd.org
|
|
and
|
|
.An Damien Bergamini Aq damien@openbsd.org .
|
|
.Sh CAVEATS
|
|
The
|
|
.Nm
|
|
driver supports automatic control of the transmit speed in BSS mode only.
|
|
Therefore the use of a
|
|
.Nm
|
|
adapter in Host AP mode is discouraged.
|