diff options
| -rw-r--r-- | share/man/man4/Makefile | 4 | ||||
| -rw-r--r-- | share/man/man4/rum.4 | 313 | ||||
| -rw-r--r-- | share/man/man4/usb.4 | 4 |
3 files changed, 318 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 825d432a4dd..c82c10b4d46 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.371 2006/07/29 15:34:18 dlg Exp $ +# $OpenBSD: Makefile,v 1.372 2006/07/31 10:04:04 jsg Exp $ MAN= aac.4 ac97.4 acphy.4 acpi.4 acpihpet.4 acpitimer.4 \ adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \ @@ -34,7 +34,7 @@ MAN= aac.4 ac97.4 acphy.4 acpi.4 acpihpet.4 acpitimer.4 \ pf.4 pflog.4 pfsync.4 piixpm.4 pim.4 \ pms.4 ppb.4 ppp.4 pppoe.4 pty.4 puc.4 qsphy.4 radio.4 raid.4 ral.4 \ random.4 ray.4 rd.4 re.4 rgephy.4 ricohrtc.4 \ - rl.4 rln.4 rlphy.4 route.4 rt.4 \ + rl.4 rln.4 rlphy.4 route.4 rt.4 rum.4 \ rtfps.4 rtii.4 rtw.4 safe.4 safte.4 san.4 sbus.4 scsi.4 sd.4 \ sdmmc.4 sdhc.4 ses.4 \ sequencer.4 sf.4 sf2r.4 sfr.4 siop.4 sis.4 sk.4 sl.4 sm.4 \ diff --git a/share/man/man4/rum.4 b/share/man/man4/rum.4 new file mode 100644 index 00000000000..843c266851c --- /dev/null +++ b/share/man/man4/rum.4 @@ -0,0 +1,313 @@ +.\" $OpenBSD: rum.4,v 1.1 2006/07/31 10:04:04 jsg 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 19, 2006 +.Os +.Dt RUM 4 +.Sh NAME +.Nm rum +.Nd Ralink Technology USB MIMO IEEE 802.11a/b/g wireless network driver +.Sh SYNOPSIS +.Cd "rum* at uhub? port ?" +.Sh DESCRIPTION +The +.Nm +driver supports USB wireless adapters based on the Ralink RT2501USB +chipset. +.Pp +The RT2501USB chipset is the second generation of 802.11b/g adapters from Ralink. +It consists of two integrated chips, an RT2571W MAC/BBP and an RT2528 radio +transceiver. +This chipset provides support for the IEEE 802.11e standard with multiple +hardware transmission queues. +.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. +.Pp +.Sh CONFIGURATION +The +.Nm +driver can be configured at runtime with +.Xr ifconfig 8 +or on boot with +.Xr hostname.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 files are potentially loaded when an interface is +brought up: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It /etc/firmware/ral-rt2573 +.El +.Sh HARDWARE +The following adapters should work: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It Belkin F5D7050A +.It CNet CWD-854 ver F +.It Conceptronic C54RU ver 2 +.It Linksys WUSB54G rev C +.It D-Link DWL-G122 rev C1 +.It D-Link WUA-1340 +.It Gigabyte GN-WB01GS +.El +.Pp +.Sh EXAMPLES +The following +.Xr hostname.if 5 +example configures rum0 to join whatever network is available on boot, +using WEP key +.Dq 0x1deadbeef1 , +channel 11, obtaining an IP address using DHCP: +.Bd -literal -offset indent +dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11 +.Ed +.Pp +The following +.Xr hostname.if 5 +example creates a host-based access point on boot: +.Bd -literal -offset indent +inet 192.168.1.1 255.255.255.0 NONE 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: timeout waiting for MCU to initialize" +The onboard 8051 microcontroller unit failed to initialize in time. +.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 intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr hostname.if 5 , +.Xr hostapd 8 , +.Xr ifconfig 8 +.Pp +Ralink Technology: +.Pa http://www.ralinktech.com +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 4.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Niall O'Higgins Aq niallo@openbsd.org +based on the +.Xr ural 4 +driver by +.An Damien Bergamini Aq damien@openbsd.org . +.Sh CAVEATS +.Pp +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. diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4 index f00a5317858..bca3803d4b8 100644 --- a/share/man/man4/usb.4 +++ b/share/man/man4/usb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: usb.4,v 1.60 2006/06/22 08:42:39 jmc Exp $ +.\" $OpenBSD: usb.4,v 1.61 2006/07/31 10:04:04 jsg Exp $ .\" $NetBSD: usb.4,v 1.15 1999/07/29 14:20:32 augustss Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -138,6 +138,8 @@ Communication Device Class (CDC) and Ethernet subclass. CATC USB-EL1201A-based Ethernet interfaces. .It Xr kue 4 Kawasaki LSI KL5KUSB101B-based Ethernet interfaces. +.It Xr rum 4 +Ralink USB MIMO IEEE 802.11a/b/g wireless network adapters. .It Xr ubt 4 Bluetooth adapters. .It Xr udav 4 |