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.12 2008/02/06 08:21:22 sephe Exp $
  32 .\"
  33 .Dd February 6, 2008
  34 .Dt ACX 4
  35 .Os
  36 .Sh NAME
  37 .Nm acx
  38 .Nd Texas Instruments ACX100/ACX111 IEEE 802.11a/b/g wireless network 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 TNETW1100/TNETW1100B (ACX100)
  59 and TNETW1130 (ACX111) based PCI/CardBus network adapters.
  60 .Pp
  61 The ACX100A and ACX100B are first generation 802.11b devices
  62 from TI.
  63 The ACX111 is a second generation device which supports 802.11b/g
  64 and in some cases 802.11a.
  65 .Pp
  66 By default, the
  67 .Nm
  68 driver configures the adapter for BSS operation (infrastructure mode).
  69 This mode requires the use of an access point.
  70 In addition, IBSS operation (adhoc mode) is also supported.
  71 For more information on configuring this device, see
  72 .Xr ifconfig 8 .
  73 .Ss MIB Variables
  74 The following per-interface variables are implemented in the
  75 .Va hw.acx Ns Em X
  76 branch of the
  77 .Xr sysctl 3
  78 MIB.
  79 .Bl -tag -width ".Va combined_radio_fw"
  80 .It Va msdu_lifetime
  81 MSDU life time.
  82 .It Va long_retry_limit
  83 Long retry limit.
  84 .It Va scan_dwell
  85 Channel dwell time during scanning (unit: milliseconds)
  86 .It Va combined_radio_fw
  87 The base and radio firmwares are combined in one image file.
  88 By default,
  89 it is set to 1 for ACX111 parts and 0 for ACX100A and ACX100B parts.
  90 .It Va free_fw
  91 Set to non-zero value to free the loaded firmwares.
  92 This does not affect a running device.
  93 Firmwares will be reloaded from
  94 .Pa /etc/firmware/acx
  95 when device is brought up next time.
  96 .El
  97 .Sh HARDWARE
  98 The following cards are among those supported by the
  99 .Nm
 100 driver:
 101 .Pp
 102 .Bl -column -compact "WESTELL A90-200WG-01" "ACX111" "CardBus" "a/b/g" -offset 6n
 103 .Em "Card       Chip    Bus     Standard"
 104 D-Link DWL-520+ ACX100  PCI     b
 105 D-Link DWL-650+ ACX100  CardBus b
 106 D-Link DWL-G520+        ACX111  PCI     b/g
 107 D-Link DWL-G630+        ACX111  CardBus b/g
 108 D-Link DWL-G650+        ACX111  CardBus b/g
 109 Ergenic ERG WL-003      ACX100  CardBus b
 110 Hamlet HNWP254  ACX111  CardBus b/g
 111 Hawking HWP54G  ACX111  PCI     b/g
 112 Linksys WPC54Gv2        ACX111  CardBus b/g
 113 Microcom Travelcard     ACX111  CardBus b/g
 114 Netgear WG311v2 ACX111  PCI     b/g
 115 Sceptre SC254W+ ACX111  CardBus b/g
 116 Tornado/ADT 211g        ACX111  PCI     b/g
 117 USR USR5410     ACX111  CardBus b/g
 118 USR USR5416     ACX111  PCI     b/g
 119 WESTELL A90-200WG-01    ACX111  CardBus b/g
 120 ZyXEL G-160     ACX111  CardBus b/g
 121 ZyXEL G-360 EE  ACX111  PCI     b/g
 122 .El
 123 .Sh FILES
 124 The firmware for the adapter is not shipped with
 125 .Dx
 126 and must be obtained separately.
 127 An archive with firmware files that are known to work can be found at:
 128 .Bd -literal -offset indent
 129 http://leaf.dragonflybsd.org/~sephe/acx/acx_fw.tbz
 130 .Ed
 131 .Pp
 132 The firmware files have to reside in
 133 .Pa /etc/firmware/acx
 134 and will be loaded when the interface is brought up.
 135 .Sh SEE ALSO
 136 .Xr arp 4 ,
 137 .Xr cardbus 4 ,
 138 .Xr ifmedia 4 ,
 139 .Xr pci 4 ,
 140 .Xr wlan_ratectl 4 ,
 141 .Xr hostapd 8 ,
 142 .Xr ifconfig 8 ,
 143 .Xr sysctl 8 ,
 144 .Xr wpa_supplicant 8
 145 .Sh HISTORY
 146 The
 147 .Nm
 148 driver first appeared in
 149 .Dx 1.5 .
 150 .Sh AUTHORS
 151 .An -nosplit
 152 The
 153 .Nm
 154 driver was written by
 155 .An Sepherosa Ziehau .
 156 The manual page was written by
 157 .An Sascha Wildner .
 158 Both are based on the
 159 .Pa http://wlan.kewl.org
 160 project team's original code.
 161 .Pp
 162 The hardware specification was reverse engineered by the good folks at
 163 .Pa http://acx100.sourceforge.net .
 164 Without them this driver would not have been possible.