From 3eb4a844d849a9fc04346024368a97badf9ed09d Mon Sep 17 00:00:00 2001 From: thompsa Date: Tue, 25 Jan 2011 22:35:35 +0000 Subject: [PATCH] MFC r203134,r207990,r217289,r203135 Add manpages for run(4) and runfw(4). Approved by: re (kib) git-svn-id: svn://svn.freebsd.org/base/releng/8.2@217861 ccf9f872-aa2e-dd11-9fc8-001c23d0bc1f --- share/man/man4/Makefile | 2 + share/man/man4/run.4 | 229 ++++++++++++++++++++++++++++++++++++++++ share/man/man4/runfw.4 | 50 +++++++++ 3 files changed, 281 insertions(+) create mode 100644 share/man/man4/run.4 create mode 100644 share/man/man4/runfw.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index fb5811d8..d0328e3b 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -338,6 +338,8 @@ MAN= aac.4 \ rp.4 \ rue.4 \ rum.4 \ + run.4 \ + runfw.4 \ sa.4 \ safe.4 \ sbp.4 \ diff --git a/share/man/man4/run.4 b/share/man/man4/run.4 new file mode 100644 index 00000000..08e9bfad --- /dev/null +++ b/share/man/man4/run.4 @@ -0,0 +1,229 @@ +.\" $OpenBSD: run.4,v 1.22 2009/11/23 06:16:32 jmc Exp $ +.\" +.\" Copyright (c) 2008 Damien Bergamini +.\" +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.Dd January 12, 2011 +.Os +.Dt RUN 4 +.Sh NAME +.Nm run +.Nd Ralink Technology USB IEEE 802.11a/g/n wireless network device +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device ehci" +.Cd "device uhci" +.Cd "device ohci" +.Cd "device usb" +.Cd "device run" +.Cd "device wlan" +.Cd "device wlan_amrr" +.Ed +.Pp +Firmware is also needed, and provided by: +.Bd -ragged -offset indent +.Cd "device runfw" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following lines in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_run_load="YES" +runfw_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver supports USB 2.0 wireless adapters based on the Ralink RT2700U, +RT2800U and RT3000U chipsets. +.Pp +The RT2700U chipset consists of two integrated chips, an RT2770 MAC/BBP and +an RT2720 (1T2R) or RT2750 (dual-band 1T2R) radio transceiver. +.Pp +The RT2800U chipset consists of two integrated chips, an RT2870 MAC/BBP and +an RT2820 (2T3R) or RT2850 (dual-band 2T3R) radio transceiver. +.Pp +The RT3000U is a single-chip solution based on an RT3070 MAC/BBP and +an RT3020 (1T1R), RT3021 (1T2R) or RT3022 (2T2R) single-band radio +transceiver. +.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 Host AP mode +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 +The +.Nm +driver can be configured to use +Wired Equivalent Privacy (WEP) or +Wi-Fi Protected Access (WPA-PSK and WPA2-PSK). +WPA is the de facto encryption standard for wireless networks. +It is strongly recommended that WEP +not be used as the sole mechanism +to secure wireless communication, +due to serious weaknesses in it. +The +.Nm +driver offloads both encryption and decryption of data frames to the +hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers. +.Pp +The +.Nm +driver can be configured at runtime with +.Xr ifconfig 8 . +.Sh HARDWARE +The +.Nm +driver supports the following wireless adapters: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It Airlink101 AWLL6090 +.It ASUS USB-N11 +.It ASUS USB-N13 +.It ASUS WL-160N +.It Belkin F5D8051 ver 3000 +.It Belkin F5D8053 +.It Belkin F5D8055 +.It Belkin F6D4050 ver 1 +.It Buffalo WLI-UC-AG300N +.It Buffalo WLI-UC-G300N +.It Buffalo WLI-UC-GN +.It Corega CG-WLUSB2GNL +.It Corega CG-WLUSB2GNR +.It Corega CG-WLUSB300AGN +.It Corega CG-WLUSB300GNM +.It D-Link DWA-130 rev B1 +.It D-Link DWA-140 +.It DrayTek Vigor N61 +.It Edimax EW-7711UAn +.It Edimax EW-7711UTn +.It Edimax EW-7717Un +.It Edimax EW-7718Un +.It Gigabyte GN-WB30N +.It Gigabyte GN-WB31N +.It Gigabyte GN-WB32L +.It Hawking HWDN1 +.It Hawking HWUN1 +.It Hawking HWUN2 +.It Hercules HWNU-300 +.It Linksys WUSB54GC v3 +.It Linksys WUSB600N +.It Mvix Nubbin MS-811N +.It Planex GW-USMicroN +.It Planex GW-US300MiniS +.It Sitecom WL-182 +.It Sitecom WL-188 +.It Sitecom WL-301 +.It Sitecom WL-302 +.It Sitecom WL-315 +.It SMC SMCWUSBS-N2 +.It Sweex LW303 +.It Sweex LW313 +.It Unex DNUR-81 +.It Unex DNUR-82 +.It ZyXEL NWD210N +.It ZyXEL NWD270N +.El +.Sh EXAMPLES +Join an existing BSS network (i.e., connect to an access point): +.Pp +.Bd -literal -offset indent +ifconfig wlan create wlandev run0 inet 192.168.0.20 \e + netmask 0xffffff00 +.Ed +.Pp +Join a specific BSS network with network name +.Dq Li my_net : +.Pp +.Dl "ifconfig wlan create wlandev run0 ssid my_net up" +.Pp +Join a specific BSS network with 64-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan create wlandev run0 ssid my_net \e + wepmode on wepkey 0x1234567890 weptxkey 1 up +.Ed +.Pp +Join a specific BSS network with 128-bit WEP encryption: +.Bd -literal -offset indent +ifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 +.Ed +.Sh DIAGNOSTICS +.Bl -diag +.It "run%d: faild load firmware of file runfw" +For some reason, the driver was unable to read the microcode file from the +filesystem. +The file might be missing or corrupted. +.It "run%d: could not load 8051 microcode" +An error occurred while attempting to upload the microcode to the onboard 8051 +microcontroller unit. +.It "run%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 runfw 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr wlan 4 , +.Xr wlan_amrr 4 , +.Xr wlan_ccmp 4 , +.Xr wlan_tkip 4 , +.Xr wlan_wep 4 , +.Xr wlan_xauth 4 , +.Xr ifconfig 8 , +.Xr hostapd 8 , +.Xr wpa_supplicant 8 . +.Pp +Ralink Technology: +.Pa http://www.ralinktech.com/ +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 4.5 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Damien Bergamini Aq damien@openbsd.org . +.Sh CAVEATS +The +.Nm +driver does not support any of the 802.11n capabilities offered by the +RT2800 and RT3000 chipsets. diff --git a/share/man/man4/runfw.4 b/share/man/man4/runfw.4 new file mode 100644 index 00000000..ddaf169e --- /dev/null +++ b/share/man/man4/runfw.4 @@ -0,0 +1,50 @@ +.\" Copyright (c) 2010 Akinori Furukoshi +.\" Copyright (c) 2010 Warren Block +.\" +.\" 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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd January 12, 2011 +.Dt RUNFW 4 +.Os +.Sh NAME +.Nm runfw +.Nd "Firmware Module for Ralink driver" +.Sh SYNOPSIS +To compile this module into the kernel, place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device runfw" +.Ed +.Pp +This will include two firmware images, RT2870 and RT3071, inside the kernel. +.Xr run 4 +will load the appropriate image into the chip. +.Pp +Alternatively, to load the firmware images as a module at boot time, place +the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +runfw_load="YES" +.Ed +.Sh DESCRIPTION +This module provides firmware sets for the Ralink RT2700U, +RT2800U and RT3000U chip based USB WiFi adapters. +Please read Ralink's license, src/sys/contrib/dev/run/LICENSE. +.Sh SEE ALSO +.Xr run 4 , +.Xr firmware 9 -- 2.42.0