share/man/man4/atw.4

   1 .\"     $NetBSD: atw.4,v 1.10 2005/06/23 12:47:38 peter Exp $
   2 .\"
   3 .\" Copyright (c) 2003
   4 .\"     David Young <dyoung@NetBSD.org>. All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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 the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY David Young AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL David Young
  19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  25 .\" THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\"     $Id: atw.4,v 1.11 2009/10/19 23:19:38 rmind Exp $
  28 .\"
  29 .Dd June 5, 2004
  30 .Dt ATW 4
  31 .Os
  32 .Sh NAME
  33 .Nm atw
  34 .Nd ADMtek ADM8211 802.11 wireless network driver
  35 .Sh SYNOPSIS
  36 .Cd "atw* at cardbus? function ?"
  37 .Cd "atw* at pci? dev ? function ?"
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver supports PCI/CardBus 802.11b wireless adapters based on the
  42 ADMtek ADM8211.
  43 .Pp
  44 The ADM8211 is a bus-mastering 802.11 Media Access Controller (MAC)
  45 which is derived from ADMtek's Tulip clones (see
  46 .Xr tlp 4 ) .
  47 It supports contention-free traffic (with an 802.11 Point Coordinator),
  48 64/128-bit WEP encryption, and 802.11 power-saving.
  49 The ADM8211 integrates an RF3000 baseband processor (BBP) by RF
  50 Microdevices.
  51 .Pp
  52 In a typical application, the ADM8211 is coupled with an RF front-end
  53 by RFMD and a Silicon Laboratories Si4126 RF/IF synthesizer.
  54 .Pp
  55 With the ADM8211, the division of labor between the host and NIC
  56 is different than with firmware-based NICs such as
  57 .Xr an 4 ,
  58 .Xr awi 4 ,
  59 and
  60 .Xr wi 4 .
  61 The ADM8211 is still responsible for real-time 802.11 functions
  62 such as sending ACK/RTS/CTS/ATIM frames, sending beacons, and
  63 answering CF polls from the access point, but the host takes
  64 responsibility for providing 802.11 functions such as scanning,
  65 association, and authentication.
  66 The host is also responsible for programming both the BBP and the
  67 RF/IF synthesizer.
  68 .Pp
  69 .Nm
  70 contains incomplete support for the ADM8211's WEP encryption/decryption
  71 engine.
  72 .Nm
  73 does not yet support hardware WEP decryption, however, it will use
  74 the ADM8211's crypto engine to encrypt transmitted frames.
  75 Documentation from ADMtek claims that, in addition to the 4 128-bit
  76 shared WEP keys, the ADM8211 will store WEP key pairs for up to 20
  77 peers.
  78 The documentation provides no details, hence
  79 .Nm
  80 does not support the 20 key-pairs.
  81 .Pp
  82 The ADM8211 operates in 802.11 infrastructure mode (with an access
  83 point) and in 802.11 ad hoc mode (without an access point) at 1,
  84 2, 5.5, and 11Mbps.
  85 ADMtek says that the ADM8211 cannot operate as an access point.
  86 .Pp
  87 The operating mode is selected using the
  88 .Xr ifconfig 8
  89 utility.
  90 For more information on configuring this device, see
  91 .Xr ifconfig 8
  92 and
  93 .Xr ifmedia 4 .
  94 .Sh HARDWARE
  95 Cards supported by the
  96 .Nm
  97 driver include:
  98 .Pp
  99 .Bl -item -offset indent -compact
 100 .It
 101 D-Link DWL-650 Rev. ?? CardBus card
 102 .It
 103 D-Link DWL-520 Rev. C1 PCI card
 104 .It
 105 LanReady WP2000 PCI card
 106 .It
 107 TrendNet TEW-221PC CardBus card
 108 .It
 109 Xterasys XN2511B PCI card
 110 .It
 111 .El
 112 .Sh DIAGNOSTICS
 113 .Bl -diag
 114 .It "atw0: failed to tune channel %d"
 115 The driver failed to tune the radio to a new channel.
 116 The radio remains tuned to the old channel.
 117 .It "atw0: atw_si4136_write wrote %08x, SYNCTL still busy"
 118 The driver waited 100ms without seeing an indication that the
 119 ADM8211 had finished writing a register on the Si4126 RF/IF
 120 synthesizer.
 121 .It "atw0: device timeout"
 122 The ADM8211 failed to generate an interrupt to acknowledge a transmit
 123 command.
 124 .El
 125 .Sh SEE ALSO
 126 .Xr arp 4 ,
 127 .Xr cardbus 4 ,
 128 .Xr ifmedia 4 ,
 129 .Xr netintro 4 ,
 130 .Xr pci 4 ,
 131 .Xr ifconfig 8
 132 .Rs
 133 .%T ADMtek
 134 .%O http://www.admtek.com.tw
 135 .Re
 136 .Rs
 137 .%T Silicon Laboratories
 138 .%O http://www.silabs.com
 139 .Re
 140 .Rs
 141 .%T RF Microdevicdes
 142 .%O http://www.rfmd.com
 143 .Re
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 device driver first appeared in
 148 .Nx 2.0 .
 149 .Sh AUTHORS
 150 .An -nosplit
 151 The
 152 .Nm
 153 driver was written by
 154 .An David Young
 155 .Aq dyoung@NetBSD.org .
 156 For features which the ADM8211 has in common with the DECchip 21x4x,
 157 code was liberally borrowed from
 158 .Xr tlp 4
 159 by
 160 .An Jason Thorpe
 161 .Aq thorpej@NetBSD.org .
 162 .Sh BUGS
 163 The author does not fully understand what processing the duration
 164 fields for the PLCP header and the 802.11 header undergo before
 165 they are applied to a transmitted frame.
 166 If the duration fields in transmitted frames are incorrect, the
 167 performance of your network may suffer.
 168 .Pp
 169 The driver does not provide rate control when the media type is
 170 set to autoselect.
 171 .Pp
 172 The driver lets you change to hostap mode, but it does not work
 173 and it probably never will.
 174 .Pp
 175 The driver will sometimes complain that it cannot re-tune the radio
 176 because the transmit process has not gone idle.
 177 The author is investigating.
 178 .Pp
 179 Many features are still missing, especially WEP decryption and
 180 802.11 power-saving.
 181 .Pp
 182 The ad hoc mode has not been rigorously tested.
 183 IBSSs with the same SSID may not coalesce, but this should not
 184 matter for most applications.
 185 .Pp
 186 The driver is untested in the ad-hoc demo mode of Lucent WaveLAN
 187 cards.
 188 .Pp
 189 The ADM8211 supports 802.11 power-saving, however,
 190 .Nm
 191 does not support it yet.
 192 For time-bounded service, the ADM8211 will interoperate with an
 193 access point which implements the 802.11 Point Coordination Function,
 194 however, this is also not supported.
 195 .Pp
 196 Combinations of an ADM8211 with either an Intersil or a Marvell RF
 197 front-end are not supported.