share/man/man4/acx.4

   1 .\"
   2 .\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\"
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in
  12 .\"    the documentation and/or other materials provided with the
  13 .\"    distribution.
  14 .\" 3. Neither the name of The DragonFly Project nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific, prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $DragonFly: src/share/man/man4/acx.4,v 1.2 2006/12/10 05:15:59 sephe Exp $
  32 .\"
  33 .Dd March 24, 2006
  34 .Dt ACX 4
  35 .Os
  36 .Sh NAME
  37 .Nm acx
  38 .Nd Texas Instruments ACX100/TNETW1130(ACX111) IEEE 802.11 driver
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel, place the following lines in
  41 your kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device acx"
  44 .Cd "device wlan"
  45 .Cd "device wlan_ratectl_onoe"
  46 .Cd "device wlan_ratectl_amrr"
  47 .Ed
  48 .Pp
  49 Alternatively, to load the driver as a module at boot time, place the
  50 following line in
  51 .Pa /boot/loader.conf :
  52 .Bd -literal -offset indent
  53 if_acx_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for Texas Instruments ACX100 or
  59 TNETW1130 (aka ACX111) based PCI and Cardbus network adapters.
  60 .Pp
  61 By default, the
  62 .Nm
  63 driver configures the adapter for BSS operation (infrastructure mode).
  64 This mode requires the use of an access point. In addition, IBSS
  65 operation (adhoc mode) is also supported.
  66 For more
  67 information on configuring this device, see
  68 .Xr ifconfig 8 .
  69 .Ss MIB Variables
  70 A number of per-interface variables are implemented in the
  71 .Va hw.acx Ns Em X
  72 branch of the
  73 .Xr sysctl 3
  74 MIB.
  75 .Bl -tag -width ".Va txrate_sample_threshold"
  76 .It Va txrate_upd_intvl_min
  77 Minumum number of seconds to wait before raising the TX rate.
  78 .It Va txrate_upd_intvl_max
  79 Maximum number of seconds to wait before raising the TX rate.
  80 .It Va txrate_sample_threshold
  81 Number of packets to be sampled before raising the TX rate.
  82 .It Va long_retry_limit
  83 Maximum number of retries for RTS packets.
  84 .It Va short_retry_limit
  85 Maximum number of retries for non-RTS packets.
  86 .It Va msdu_lifetime
  87 MSDU life time.
  88 .El
  89 .Sh HARDWARE
  90 The following cards are known to work with the
  91 .Nm
  92 driver:
  93 .Pp
  94 .Bl -bullet -compact
  95 .It
  96 D-Link DWL-520+
  97 .It
  98 D-Link DWL-650+
  99 .It
 100 D-Link DWL-G520+
 101 .It
 102 D-Link DWL-G650+
 103 .El
 104 .Sh FILES
 105 The firmware for the adapter is not shipped with
 106 .Dx
 107 and must be obtained seperately.
 108 Check the disk/CD shipped with the adapter or
 109 .Pp
 110 .Pa ftp://ftp.dlink.co.uk/wireless
 111 .Pp
 112 See
 113 .Xr acxcontrol 8
 114 for more information on loading firmware.
 115 .\" XXX .Sh DIAGNOSTICS
 116 .Sh SEE ALSO
 117 .Xr acxcontrol 8 ,
 118 .Xr ifconfig 8 ,
 119 .Xr sysctl 8
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 driver first appeared in
 124 .Dx 1.5 .
 125 .Sh AUTHORS
 126 .An -nosplit
 127 The
 128 .Nm
 129 driver was written by
 130 .An Sepherosa Ziehau .
 131 The manual page was written by
 132 .An Sascha Wildner .
 133 Both are based on the
 134 .Pa http://wlan.kewl.org
 135 project team's original code.
 136 .Pp
 137 The hardware specification was reverse engineered by the good folks at
 138 .Pa http://acx100.sourceforge.net .
 139 Without them this driver would not have been possible.