man/man4/wlan.4

.\"
.\" Copyright (c) 2003 Tom Rhodes
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/man/man4/wlan.4,v 1.8.2.1 2005/12/02 16:45:03 brueffer Exp $
.\" $DragonFly: src/share/man/man4/wlan.4,v 1.8 2008/07/26 16:25:41 swildner Exp $
.\"
.Dd May 14, 2006
.Dt WLAN 4
.Os
.Sh NAME
.Nm wlan
.Nd generic 802.11 link-layer support
.Sh SYNOPSIS
.Cd "device wlan"
.Sh DESCRIPTION
The
.Nm
module provides generic code to support 802.11 drivers.
Where a device does not directly support 802.11 functionality
this layer fills in.
The
.Nm
is required for the
.Xr acx 4 ,
.Xr ath 4 ,
.Xr bwi 4 ,
.Xr iwi 4 ,
.Xr iwl 4 ,
.Xr ndis 4 ,
.Xr ral 4 ,
.Xr rtw 4 ,
.Xr rum 4 ,
.Xr ural 4 ,
and
.Xr wi 4
drivers, with other drivers to follow.
.Pp
The
.Nm
module supports multi-mode devices capable of
operating in both 2.4GHz and 5GHz bands and supports numerous
802.11 protocols: 802.11a, 802.11b, and 802.11g.
The WPA, 802.11i, and 802.1x security protocols are supported
through a combination of in-kernel code and user-mode applications.
The WME and WMM multi-media protocols are supported entirely within
the
.Nm
module but require a suitably capable hardware device.
.Pp
The
.Nm
module defines several mechanisms by which plugin modules may
be used to extend functionality.
Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
as modules that are loaded on demand (if not statically configured
into a system).
Similarly there is an authenticator framework for defining 802.11
authentication services and a framework for integrating access
control mechanisms specific to the 802.11 protocol.
.Sh DEBUGGING
If the associated interface is marked for debugging with, for example,
.Pp
.Dl "ifconfig wi0 debug"
.Pp
then messages describing the operation of the 802.11 protocol will
be sent to the console.
Complete debugging controls are available using:
.Pp
.Dl "sysctl net.wlan.X.debug=mask"
.Pp
where
.Ar X
is the number of the
.Nm
instance and mask is a bit-or of control bits that determine which
debugging messages to enable.
For example,
.Pp
.Dl "sysctl net.wlan.0.debug=0x00200000"
.Pp
enables debugging messages related to scanning for an access point,
adhoc neighbor, or an unoccupied channel when operation as an access point.
.\"The
.\".Xr 80211debug
.\"tool provides a more user-friendly mechanism for doing the same thing.
.Pp
Many drivers will also display the contents of each 802.11 frame
sent and received when the interface is marked with
both debugging and
.Cm link2 ;
e.g.,
.Pp
.Dl "ifconfig wi0 debug link2"
.Pp
Beware however that some management frames may be processed entirely within
the device and not be received by the host.
.Sh EXAMPLES
Join an existing BSS network (i.e., connect to an access point):
.Pp
.Dl "ifconfig iface 192.168.0.20/24"
.Pp
Join a specific BSS network with network name
.Dq Li my_net :
.Pp
.Dl "ifconfig iface 192.168.0.20/24 ssid my_net"
.Pp
Join a specific BSS network with 64 bit WEP encryption:
.Bd -literal -offset indent
ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
        wepkey 0x1234567890 weptxkey 1
.Ed
.Pp
Join a specific BSS network with 128 bit WEP encryption:
.Bd -literal -offset indent
ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
        wepkey 0x01020304050607080910111213 weptxkey 1
.Ed
.Pp
Join/create an 802.11b IBSS network:
.Bd -literal -offset indent
ifconfig iface 192.168.0.20/24 ssid my_net mediaopt adhoc
.Ed
.Pp
To debug a network setup, you may wish to enable interface debugging:
.Bd -literal -offset indent
ifconfig iface down debug up
.Ed
.Pp
To disable debugging, you may simply use:
.Bd -literal -offset indent
ifconfig iface down -debug up
.Ed
.\".Pp
.\"Create an 802.11g host-based access point:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net mode 11g mediaopt hostap
.\".Ed
.\".Pp
.\"Create an 802.11a host-based access point with WEP enabled:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
.\"	wepkey 0x1234567890 weptxkey 1 mode 11a mediaopt hostap
.\".Ed
.\".Pp
.\"Create a host-based wireless bridge to fxp0:
.\".Bd -literal -offset indent
.\"ifconfig iface up ssid my_net media DS/11Mbps mediaopt hostap
.\"sysctl net.inet.ip.check_interface=0
.\"ifconfig bridge0 create
.\"ifconfig bridge0 addm iface1 addm iface2 up
.\".Ed
.\".Pp
.\"This will give you the same functionality as an access point.
.Sh COMPATIBILITY
The module name of
.Nm
was used to be compatible with
.Nx .
.Sh SEE ALSO
.Xr acx 4 ,
.Xr ath 4 ,
.Xr bwi 4 ,
.Xr iwi 4 ,
.Xr iwl 4 ,
.Xr ndis 4 ,
.Xr netintro 4 ,
.Xr ral 4 ,
.Xr rtw 4 ,
.Xr rum 4 ,
.Xr ural 4 ,
.Xr wi 4 ,
.Xr wlan_acl 4 ,
.Xr wlan_ccmp 4 ,
.Xr wlan_ratectl 4 ,
.Xr wlan_tkip 4 ,
.Xr wlan_wep 4 ,
.Xr wlan_xauth 4
.Sh STANDARDS
More information can be found in the IEEE 802.11 Standard.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.0 .
.Sh AUTHORS
Atsushi Onoe is the author of original
.Nx
software from which this work began.
.An -nosplit
.An Sam Leffler
brought the code into
.Fx
and then rewrote it to support multi-mode devices,
802.11g, WPA/802.11i, WME, and add the extensible frameworks
for cryptographic, authentication, and access control plugins.
This manual page was written by
.An Tom Rhodes Aq trhodes@FreeBSD.org .