share/man/man4/wlan_ratectl.4

   1 .\"
   2 .\" Copyright (c) 2007
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $DragonFly: src/share/man/man4/wlan_ratectl.4,v 1.2 2007/10/14 09:43:20 swildner Exp $
  33 .\"
  34 .Dd June 16, 2007
  35 .Dt WLAN_RATECTL 4
  36 .Os
  37 .Sh NAME
  38 .Nm wlan_ratectl_amrr ,
  39 .Nm wlan_ratectl_onoe ,
  40 .Nm wlan_ratectl_sample
  41 .Nd rate adaptation support for 802.11 devices
  42 .Sh SYNOPSIS
  43 .Cd "device wlan_ratectl_amrr"
  44 .Cd "device wlan_ratectl_onoe"
  45 .Cd "device wlan_ratectl_sample"
  46 .Sh DESCRIPTION
  47 .Dx
  48 supports several TX rate control algorithms for use with 802.11 devices via the
  49 .Nm wlan_ratectl
  50 modules:
  51 .Bl -tag -width ".Sy sample" -offset indent
  52 .It Sy amrr
  53 Adaptive Multi Rate Retry
  54 .It Sy onoe
  55 Atsushi Onoe's algorithm
  56 .It Sy sample
  57 John C. Bicket's SampleRate algorithm
  58 .El
  59 .Pp
  60 The following devices support TX rate control:
  61 .Xr acx 4 ,
  62 .Xr bwi 4 ,
  63 .Xr ral 4 ,
  64 .Xr rtw 4 ,
  65 .Xr rum 4
  66 and
  67 .Xr ural 4 .
  68 See the individual drivers' manual pages for more information on which
  69 algorithms are supported.
  70 .Pp
  71 To select a TX rate control algorithm, use the
  72 .Cm ratectl
  73 parameter of
  74 .Xr ifconfig 8 .
  75 .Sh SEE ALSO
  76 .Xr acx 4 ,
  77 .Xr bwi 4 ,
  78 .Xr ral 4 ,
  79 .Xr rtw 4 ,
  80 .Xr rum 4 ,
  81 .Xr ural 4 ,
  82 .Xr wlan 4 ,
  83 .Xr ifconfig 8
  84 .Sh STANDARDS
  85 The following papers have more information on the algorithms:
  86 .Bl -tag -width "SampleRate"
  87 .It AMRR
  88 .Pa http://hal.inria.fr/inria-00070784/en/
  89 .It SampleRate
  90 .Pa http://www.pdos.lcs.mit.edu/papers/jbicket-ms.pdf
  91 .El
  92 .Sh HISTORY
  93 The
  94 .Nm wlan_ratectl_amrr
  95 and
  96 .Nm wlan_ratectl_onoe
  97 modules first appeared in
  98 .Dx 1.7 .
  99 The
 100 .Nm wlan_ratectl_sample
 101 module first appeared in
 102 .Dx 1.9 .