Add manpage for runfw, the Ralink RT2700U, RT2800U and RT3000U firmware

module. Also fix a few nits in run.4.

Submitted by:	Akinori Furukoshi
This commit is contained in:
Andrew Thompson 2011-01-11 21:51:46 +00:00
parent 639016b852
commit 02d09fbb52
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=217289
3 changed files with 65 additions and 6 deletions

View File

@ -344,6 +344,7 @@ MAN= aac.4 \
rue.4 \
rum.4 \
run.4 \
runfw.4 \
sa.4 \
safe.4 \
sbp.4 \

View File

@ -16,7 +16,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd January 29, 2010
.Dd January 12, 2011
.Dt RUN 4
.Os
.Sh NAME
@ -36,11 +36,17 @@ kernel configuration file:
.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 line in
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
@ -68,6 +74,9 @@ Also known as
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.
@ -94,9 +103,7 @@ hardware for the WEP40, WEP104, TKIP(+MIC) and CCMP ciphers.
The
.Nm
driver can be configured at runtime with
.Xr ifconfig 8
or on boot with
.Xr hostname.if 5 .
.Xr ifconfig 8 .
.Sh HARDWARE
The
.Nm
@ -175,7 +182,7 @@ ifconfig wlan create wlandev run0 wlanmode adhoc ssid my_net \e
.Ed
.Sh DIAGNOSTICS
.Bl -diag
.It "run%d: error %d, could not read firmware %s"
.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.
@ -188,6 +195,7 @@ 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 ,

50
share/man/man4/runfw.4 Normal file
View File

@ -0,0 +1,50 @@
.\" Copyright (c) 2010 Akinori Furukoshi <moonlightakkiy@yahoo.ca>
.\" Copyright (c) 2010 Warren Block <wblock@wonkity.com>
.\"
.\" 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