share/man/man4/wlan.4

   1 .\"
   2 .\" Copyright (c) 2003 Tom Rhodes
   3 .\" 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 .\" 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 the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/wlan.4,v 1.8.2.1 2005/12/02 16:45:03 brueffer Exp $
  27 .\" $DragonFly: src/share/man/man4/wlan.4,v 1.3 2007/06/17 06:39:54 swildner Exp $
  28 .\"
  29 .Dd May 14, 2006
  30 .Dt WLAN 4
  31 .Os
  32 .Sh NAME
  33 .Nm wlan
  34 .Nd generic 802.11 link-layer support
  35 .Sh SYNOPSIS
  36 .Cd "device wlan"
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 module provides generic code to support 802.11 drivers.
  41 Where a device does not directly support 802.11 functionality
  42 this layer fills in.
  43 The
  44 .Nm
  45 is required for the
  46 .Xr acx 4 ,
  47 .Xr ath 4 ,
  48 .Xr ipw 4 ,
  49 .Xr iwi 4 ,
  50 .Xr ndis 4 ,
  51 .Xr ral 4 ,
  52 .Xr rtw 4 ,
  53 .Xr rum 4 ,
  54 .Xr ural 4 ,
  55 and
  56 .Xr wi 4
  57 drivers, with other drivers to follow.
  58 .Pp
  59 The
  60 .Nm
  61 module supports multi-mode devices capable of
  62 operating in both 2.4GHz and 5GHz bands and supports numerous
  63 802.11 protocols: 802.11a, 802.11b, and 802.11g.
  64 The WPA, 802.11i, and 802.1x security protocols are supported
  65 through a combination of in-kernel code and user-mode applications.
  66 The WME and WMM multi-media protocols are supported entirely within
  67 the
  68 .Nm
  69 module but require a suitably capable hardware device.
  70 .Pp
  71 The
  72 .Nm
  73 module defines several mechanisms by which plugin modules may
  74 be used to extend functionality.
  75 Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
  76 as modules that are loaded on demand (if not statically configured
  77 into a system).
  78 Similarly there is an authenticator framework for defining 802.11
  79 authentication services and a framework for integrating access
  80 control mechanisms specific to the 802.11 protocol.
  81 .Sh DEBUGGING
  82 If the associated interface is marked for debugging with, for example,
  83 .Pp
  84 .Dl "ifconfig wi0 debug"
  85 .Pp
  86 then messages describing the operation of the 802.11 protocol will
  87 be sent to the console.
  88 Complete debugging controls are available using:
  89 .Pp
  90 .Dl "sysctl net.wlan.X.debug=mask"
  91 .Pp
  92 where
  93 .Ar X
  94 is the number of the
  95 .Nm
  96 instance and mask is a bit-or of control bits that determine which
  97 debugging messages to enable.
  98 For example,
  99 .Pp
 100 .Dl "sysctl net.wlan.0.debug=0x00200000"
 101 .Pp
 102 enables debugging messages related to scanning for an access point,
 103 adhoc neighbor, or an unoccupied channel when operation as an access point.
 104 .\"The
 105 .\".Xr 80211debug
 106 .\"tool provides a more user-friendly mechanism for doing the same thing.
 107 .Pp
 108 Many drivers will also display the contents of each 802.11 frame
 109 sent and received when the interface is marked with
 110 both debugging and
 111 .Cm link2 ;
 112 e.g.,
 113 .Pp
 114 .Dl "ifconfig wi0 debug link2"
 115 .Pp
 116 Beware however that some management frames may be processed entirely within
 117 the device and not be received by the host.
 118 .Sh COMPATIBILITY
 119 The module name of
 120 .Nm
 121 was used to be compatible with
 122 .Nx .
 123 .Sh SEE ALSO
 124 .Xr acx 4 ,
 125 .Xr ath 4 ,
 126 .Xr ipw 4 ,
 127 .Xr iwi 4 ,
 128 .Xr ndis 4 ,
 129 .Xr netintro 4 ,
 130 .Xr ral 4 ,
 131 .Xr rtw 4 ,
 132 .Xr rum 4 ,
 133 .Xr ural 4 ,
 134 .Xr wi 4 ,
 135 .Xr wlan_acl 4 ,
 136 .Xr wlan_ccmp 4 ,
 137 .Xr wlan_ratectl 4 ,
 138 .Xr wlan_tkip 4 ,
 139 .Xr wlan_wep 4 ,
 140 .Xr wlan_xauth 4
 141 .Sh STANDARDS
 142 More information can be found in the IEEE 802.11 Standard.
 143 .Sh HISTORY
 144 The
 145 .Nm
 146 driver first appeared in
 147 .Fx 5.0 .
 148 .Sh AUTHORS
 149 Atsushi Onoe is the author of original
 150 .Nx
 151 software from which this work began.
 152 .An -nosplit
 153 .An Sam Leffler
 154 brought the code into
 155 .Fx
 156 and then rewrote it to support multi-mode devices,
 157 802.11g, WPA/802.11i, WME, and add the extensible frameworks
 158 for cryptographic, authentication, and access control plugins.
 159 This manual page was written by
 160 .An Tom Rhodes Aq trhodes@FreeBSD.org .