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.8 2008/07/26 16:25:41 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 bwi 4 ,
  49 .Xr iwi 4 ,
  50 .Xr iwl 4 ,
  51 .Xr ndis 4 ,
  52 .Xr ral 4 ,
  53 .Xr rtw 4 ,
  54 .Xr rum 4 ,
  55 .Xr ural 4 ,
  56 and
  57 .Xr wi 4
  58 drivers, with other drivers to follow.
  59 .Pp
  60 The
  61 .Nm
  62 module supports multi-mode devices capable of
  63 operating in both 2.4GHz and 5GHz bands and supports numerous
  64 802.11 protocols: 802.11a, 802.11b, and 802.11g.
  65 The WPA, 802.11i, and 802.1x security protocols are supported
  66 through a combination of in-kernel code and user-mode applications.
  67 The WME and WMM multi-media protocols are supported entirely within
  68 the
  69 .Nm
  70 module but require a suitably capable hardware device.
  71 .Pp
  72 The
  73 .Nm
  74 module defines several mechanisms by which plugin modules may
  75 be used to extend functionality.
  76 Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
  77 as modules that are loaded on demand (if not statically configured
  78 into a system).
  79 Similarly there is an authenticator framework for defining 802.11
  80 authentication services and a framework for integrating access
  81 control mechanisms specific to the 802.11 protocol.
  82 .Sh DEBUGGING
  83 If the associated interface is marked for debugging with, for example,
  84 .Pp
  85 .Dl "ifconfig wi0 debug"
  86 .Pp
  87 then messages describing the operation of the 802.11 protocol will
  88 be sent to the console.
  89 Complete debugging controls are available using:
  90 .Pp
  91 .Dl "sysctl net.wlan.X.debug=mask"
  92 .Pp
  93 where
  94 .Ar X
  95 is the number of the
  96 .Nm
  97 instance and mask is a bit-or of control bits that determine which
  98 debugging messages to enable.
  99 For example,
 100 .Pp
 101 .Dl "sysctl net.wlan.0.debug=0x00200000"
 102 .Pp
 103 enables debugging messages related to scanning for an access point,
 104 adhoc neighbor, or an unoccupied channel when operation as an access point.
 105 .\"The
 106 .\".Xr 80211debug
 107 .\"tool provides a more user-friendly mechanism for doing the same thing.
 108 .Pp
 109 Many drivers will also display the contents of each 802.11 frame
 110 sent and received when the interface is marked with
 111 both debugging and
 112 .Cm link2 ;
 113 e.g.,
 114 .Pp
 115 .Dl "ifconfig wi0 debug link2"
 116 .Pp
 117 Beware however that some management frames may be processed entirely within
 118 the device and not be received by the host.
 119 .Sh EXAMPLES
 120 Join an existing BSS network (i.e., connect to an access point):
 121 .Pp
 122 .Dl "ifconfig iface 192.168.0.20/24"
 123 .Pp
 124 Join a specific BSS network with network name
 125 .Dq Li my_net :
 126 .Pp
 127 .Dl "ifconfig iface 192.168.0.20/24 ssid my_net"
 128 .Pp
 129 Join a specific BSS network with 64 bit WEP encryption:
 130 .Bd -literal -offset indent
 131 ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
 132         wepkey 0x1234567890 weptxkey 1
 133 .Ed
 134 .Pp
 135 Join a specific BSS network with 128 bit WEP encryption:
 136 .Bd -literal -offset indent
 137 ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
 138         wepkey 0x01020304050607080910111213 weptxkey 1
 139 .Ed
 140 .Pp
 141 Join/create an 802.11b IBSS network:
 142 .Bd -literal -offset indent
 143 ifconfig iface 192.168.0.20/24 ssid my_net mediaopt adhoc
 144 .Ed
 145 .Pp
 146 To debug a network setup, you may wish to enable interface debugging:
 147 .Bd -literal -offset indent
 148 ifconfig iface down debug up
 149 .Ed
 150 .Pp
 151 To disable debugging, you may simply use:
 152 .Bd -literal -offset indent
 153 ifconfig iface down -debug up
 154 .Ed
 155 .\".Pp
 156 .\"Create an 802.11g host-based access point:
 157 .\".Bd -literal -offset indent
 158 .\"ifconfig iface 192.168.0.20/24 ssid my_net mode 11g mediaopt hostap
 159 .\".Ed
 160 .\".Pp
 161 .\"Create an 802.11a host-based access point with WEP enabled:
 162 .\".Bd -literal -offset indent
 163 .\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
 164 .\"     wepkey 0x1234567890 weptxkey 1 mode 11a mediaopt hostap
 165 .\".Ed
 166 .\".Pp
 167 .\"Create a host-based wireless bridge to fxp0:
 168 .\".Bd -literal -offset indent
 169 .\"ifconfig iface up ssid my_net media DS/11Mbps mediaopt hostap
 170 .\"sysctl net.inet.ip.check_interface=0
 171 .\"ifconfig bridge0 create
 172 .\"ifconfig bridge0 addm iface1 addm iface2 up
 173 .\".Ed
 174 .\".Pp
 175 .\"This will give you the same functionality as an access point.
 176 .Sh COMPATIBILITY
 177 The module name of
 178 .Nm
 179 was used to be compatible with
 180 .Nx .
 181 .Sh SEE ALSO
 182 .Xr acx 4 ,
 183 .Xr ath 4 ,
 184 .Xr bwi 4 ,
 185 .Xr iwi 4 ,
 186 .Xr iwl 4 ,
 187 .Xr ndis 4 ,
 188 .Xr netintro 4 ,
 189 .Xr ral 4 ,
 190 .Xr rtw 4 ,
 191 .Xr rum 4 ,
 192 .Xr ural 4 ,
 193 .Xr wi 4 ,
 194 .Xr wlan_acl 4 ,
 195 .Xr wlan_ccmp 4 ,
 196 .Xr wlan_ratectl 4 ,
 197 .Xr wlan_tkip 4 ,
 198 .Xr wlan_wep 4 ,
 199 .Xr wlan_xauth 4
 200 .Sh STANDARDS
 201 More information can be found in the IEEE 802.11 Standard.
 202 .Sh HISTORY
 203 The
 204 .Nm
 205 driver first appeared in
 206 .Fx 5.0 .
 207 .Sh AUTHORS
 208 Atsushi Onoe is the author of original
 209 .Nx
 210 software from which this work began.
 211 .An -nosplit
 212 .An Sam Leffler
 213 brought the code into
 214 .Fx
 215 and then rewrote it to support multi-mode devices,
 216 802.11g, WPA/802.11i, WME, and add the extensible frameworks
 217 for cryptographic, authentication, and access control plugins.
 218 This manual page was written by
 219 .An Tom Rhodes Aq trhodes@FreeBSD.org .