From d41721146455e61f7d781c185b54219b33907f9b Mon Sep 17 00:00:00 2001 From: Sascha Wildner Date: Sat, 16 Jun 2007 13:47:44 +0000 Subject: [PATCH] Add a wlan_ratectl(4) manual page and reference it from drivers that support rate control. Loosely-based-on: wlan_amrr(4) from FreeBSD Helped-by: sephe --- share/man/man4/Makefile | 6 ++- share/man/man4/acx.4 | 3 +- share/man/man4/ral.4 | 3 +- share/man/man4/rtw.4 | 3 +- share/man/man4/rum.4 | 3 +- share/man/man4/ural.4 | 3 +- share/man/man4/wlan_ratectl.4 | 100 ++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 115 insertions(+), 6 deletions(-) create mode 100644 share/man/man4/wlan_ratectl.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index e8b7cb0b2f..a0577dc4b8 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,6 +1,6 @@ # @(#)Makefile 8.1 (Berkeley) 6/18/93 # $FreeBSD: src/share/man/man4/Makefile,v 1.83.2.66 2003/06/04 17:10:30 sam Exp $ -# $DragonFly: src/share/man/man4/Makefile,v 1.54 2007/06/14 23:00:36 swildner Exp $ +# $DragonFly: src/share/man/man4/Makefile,v 1.55 2007/06/16 13:47:44 swildner Exp $ MAN= aac.4 \ acpi.4 \ @@ -295,6 +295,7 @@ MAN= aac.4 \ wlan.4 \ wlan_acl.4 \ wlan_ccmp.4 \ + wlan_ratectl.4 \ wlan_tkip.4 \ wlan_wep.4 \ wlan_xauth.4 \ @@ -330,6 +331,9 @@ MLINKS+=smp.4 SMP.4 MLINKS+=splash.4 screensaver.4 MLINKS+=syscons.4 sc.4 MLINKS+=vpo.4 imm.4 +MLINKS+=wlan_ratectl.4 wlan_ratectl_amrr.4 \ + wlan_ratectl.4 wlan_ratectl_onoe.4 \ + wlan_ratectl.4 wlan_ratectl_sample.4 # XXX NOT IMPORTED: man4.hp300 man4.sparc man4.tahoe man4.vax SUBDIR= man4.i386 diff --git a/share/man/man4/acx.4 b/share/man/man4/acx.4 index 1762463523..fe4604a8cd 100644 --- a/share/man/man4/acx.4 +++ b/share/man/man4/acx.4 @@ -28,7 +28,7 @@ .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $DragonFly: src/share/man/man4/acx.4,v 1.5 2007/05/13 20:29:48 hasso Exp $ +.\" $DragonFly: src/share/man/man4/acx.4,v 1.6 2007/06/16 13:47:44 swildner Exp $ .\" .Dd March 24, 2006 .Dt ACX 4 @@ -105,6 +105,7 @@ for more information on loading firmware. .\" XXX .Sh DIAGNOSTICS .Sh SEE ALSO .Xr ifmedia 4 , +.Xr wlan_ratectl 4 , .Xr acxcontrol 8 , .Xr ifconfig 8 , .Xr sysctl 8 diff --git a/share/man/man4/ral.4 b/share/man/man4/ral.4 index fd34f3a16f..81b113d39c 100644 --- a/share/man/man4/ral.4 +++ b/share/man/man4/ral.4 @@ -14,7 +14,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .\" $FreeBSD: src/share/man/man4/ral.4,v 1.10 2006/03/13 21:24:28 damien Exp $ -.\" $DragonFly: src/share/man/man4/ral.4,v 1.3 2007/04/23 13:15:57 sephe Exp $ +.\" $DragonFly: src/share/man/man4/ral.4,v 1.4 2007/06/16 13:47:44 swildner Exp $ .\" .Dd May 20, 2006 .Os @@ -202,6 +202,7 @@ This should not happen. .Xr netintro 4 , .Xr pci 4 , .Xr wlan 4 , +.Xr wlan_ratectl 4 , .Xr ifconfig 8 .Rs .%T "Ralink Technology" diff --git a/share/man/man4/rtw.4 b/share/man/man4/rtw.4 index 8bd4677b3d..c6d959f54c 100644 --- a/share/man/man4/rtw.4 +++ b/share/man/man4/rtw.4 @@ -1,6 +1,6 @@ .\" $NetBSD: rtw.4,v 1.3 2005/09/09 14:11:39 drochner Exp $ .\" $OpenBSD: rtw.4,v 1.18 2005/06/09 09:03:38 jmc Exp $ -.\" $DragonFly: src/share/man/man4/rtw.4,v 1.4 2007/05/13 18:33:56 swildner Exp $ +.\" $DragonFly: src/share/man/man4/rtw.4,v 1.5 2007/06/16 13:47:44 swildner Exp $ .\" .\" Copyright (c) 2004 Jonathan Gray .\" @@ -244,6 +244,7 @@ Join an existing BSS network, .Xr intro 4 , .Xr netintro 4 , .Xr pci 4 , +.Xr wlan_ratectl 4 , .Xr ifconfig 8 .Rs .%T Realtek diff --git a/share/man/man4/rum.4 b/share/man/man4/rum.4 index f896f448ea..e8cd9f4014 100644 --- a/share/man/man4/rum.4 +++ b/share/man/man4/rum.4 @@ -1,5 +1,5 @@ .\" $OpenBSD: rum.4,v 1.16 2006/10/19 16:53:48 jsg Exp $ -.\" $DragonFly: src/share/man/man4/rum.4,v 1.5 2007/02/25 12:03:07 swildner Exp $ +.\" $DragonFly: src/share/man/man4/rum.4,v 1.6 2007/06/16 13:47:44 swildner Exp $ .\" .\" Copyright (c) 2005, 2006 .\" Damien Bergamini @@ -171,6 +171,7 @@ This should not happen. .Xr netintro 4 , .Xr usb 4 , .Xr wlan 4 , +.Xr wlan_ratectl 4 , .Xr ifconfig 8 .Rs .%T "Ralink Technology" diff --git a/share/man/man4/ural.4 b/share/man/man4/ural.4 index 968d880fc9..3ad41807aa 100644 --- a/share/man/man4/ural.4 +++ b/share/man/man4/ural.4 @@ -14,7 +14,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .\" $FreeBSD: src/share/man/man4/ural.4,v 1.11 2006/10/07 18:18:40 flz Exp $ -.\" $DragonFly: src/share/man/man4/ural.4,v 1.4 2007/02/25 12:03:07 swildner Exp $ +.\" $DragonFly: src/share/man/man4/ural.4,v 1.5 2007/06/16 13:47:44 swildner Exp $ .\" .Dd November 26, 2006 .Os @@ -166,6 +166,7 @@ This should not happen. .Xr netintro 4 , .Xr usb 4 , .Xr wlan 4 , +.Xr wlan_ratectl 4 , .Xr ifconfig 8 .Rs .%T "Ralink Technology" diff --git a/share/man/man4/wlan_ratectl.4 b/share/man/man4/wlan_ratectl.4 new file mode 100644 index 0000000000..2c78d38208 --- /dev/null +++ b/share/man/man4/wlan_ratectl.4 @@ -0,0 +1,100 @@ +.\" +.\" Copyright (c) 2007 +.\" The DragonFly Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" 3. Neither the name of The DragonFly Project nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific, prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" ``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 +.\" COPYRIGHT HOLDERS OR CONTRIBUTORS 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. +.\" +.\" $DragonFly: src/share/man/man4/wlan_ratectl.4,v 1.1 2007/06/16 13:47:44 swildner Exp $ +.\" +.Dd June 16, 2007 +.Dt WLAN_RATECTL 4 +.Os +.Sh NAME +.Nm wlan_ratectl_amrr , +.Nm wlan_ratectl_onoe , +.Nm wlan_ratectl_sample +.Nd rate adaptation support for 802.11 devices +.Sh SYNOPSIS +.Cd "device wlan_ratectl_amrr" +.Cd "device wlan_ratectl_onoe" +.Cd "device wlan_ratectl_sample" +.Sh DESCRIPTION +.Dx +supports several TX rate control algorithms for use with 802.11 devices via the +.Nm wlan_ratectl +modules: +.Bl -tag -width ".Sy sample" -offset indent +.It Sy amrr +Adaptive Multi Rate Retry +.It Sy onoe +Atsushi Onoe's algorithm +.It Sy sample +John C. Bicket's SampleRate algorithm +.El +.Pp +The following devices support TX rate control: +.Xr acx 4 , +.Xr ral 4 , +.Xr rtw 4 , +.Xr rum 4 +and +.Xr ural 4 . +See the individual drivers' manual pages for more information on which +algorithms are supported. +.Pp +To select a TX rate control algorithm, use the +.Cm ratectl +parameter of +.Xr ifconfig 8 . +.Sh SEE ALSO +.Xr acx 4 , +.Xr ral 4 , +.Xr rtw 4 , +.Xr rum 4 , +.Xr ural 4 , +.Xr wlan 4 , +.Xr ifconfig 8 +.Sh STANDARDS +The following papers have more information on the algorithms: +.Bl -tag -width "SampleRate" +.It AMRR +.Pa http://hal.inria.fr/inria-00070784/en/ +.It SampleRate +.Pa http://www.pdos.lcs.mit.edu/papers/jbicket-ms.pdf +.El +.Sh HISTORY +The +.Nm wlan_ratectl_amrr +and +.Nm wlan_ratectl_onoe +modules first appeared in +.Dx 1.7 . +The +.Nm wlan_ratectl_sample +module first appeared in +.Dx 1.9 . -- 2.11.4.GIT