xref: /dragonfly/share/man/man4/wlan.4 (revision 9b5ae8ee)
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.5 2007/09/16 18:55:16 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
38The
39.Nm
40module provides generic code to support 802.11 drivers.
41Where a device does not directly support 802.11 functionality
42this layer fills in.
43The
44.Nm
45is required for the
46.Xr acx 4 ,
47.Xr ath 4 ,
48.Xr bwi 4 ,
49.Xr ipw 4 ,
50.Xr iwi 4 ,
51.Xr ndis 4 ,
52.Xr ral 4 ,
53.Xr rtw 4 ,
54.Xr rum 4 ,
55.Xr ural 4 ,
56and
57.Xr wi 4
58drivers, with other drivers to follow.
59.Pp
60The
61.Nm
62module supports multi-mode devices capable of
63operating in both 2.4GHz and 5GHz bands and supports numerous
64802.11 protocols: 802.11a, 802.11b, and 802.11g.
65The WPA, 802.11i, and 802.1x security protocols are supported
66through a combination of in-kernel code and user-mode applications.
67The WME and WMM multi-media protocols are supported entirely within
68the
69.Nm
70module but require a suitably capable hardware device.
71.Pp
72The
73.Nm
74module defines several mechanisms by which plugin modules may
75be used to extend functionality.
76Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
77as modules that are loaded on demand (if not statically configured
78into a system).
79Similarly there is an authenticator framework for defining 802.11
80authentication services and a framework for integrating access
81control mechanisms specific to the 802.11 protocol.
82.Sh DEBUGGING
83If the associated interface is marked for debugging with, for example,
84.Pp
85.Dl "ifconfig wi0 debug"
86.Pp
87then messages describing the operation of the 802.11 protocol will
88be sent to the console.
89Complete debugging controls are available using:
90.Pp
91.Dl "sysctl net.wlan.X.debug=mask"
92.Pp
93where
94.Ar X
95is the number of the
96.Nm
97instance and mask is a bit-or of control bits that determine which
98debugging messages to enable.
99For example,
100.Pp
101.Dl "sysctl net.wlan.0.debug=0x00200000"
102.Pp
103enables debugging messages related to scanning for an access point,
104adhoc 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
109Many drivers will also display the contents of each 802.11 frame
110sent and received when the interface is marked with
111both debugging and
112.Cm link2 ;
113e.g.,
114.Pp
115.Dl "ifconfig wi0 debug link2"
116.Pp
117Beware however that some management frames may be processed entirely within
118the device and not be received by the host.
119.Sh COMPATIBILITY
120The module name of
121.Nm
122was used to be compatible with
123.Nx .
124.Sh SEE ALSO
125.Xr acx 4 ,
126.Xr ath 4 ,
127.Xr bwi 4 ,
128.Xr ipw 4 ,
129.Xr iwi 4 ,
130.Xr ndis 4 ,
131.Xr netintro 4 ,
132.Xr ral 4 ,
133.Xr rtw 4 ,
134.Xr rum 4 ,
135.Xr ural 4 ,
136.Xr wi 4 ,
137.Xr wlan_acl 4 ,
138.Xr wlan_ccmp 4 ,
139.Xr wlan_ratectl 4 ,
140.Xr wlan_tkip 4 ,
141.Xr wlan_wep 4 ,
142.Xr wlan_xauth 4
143.Sh STANDARDS
144More information can be found in the IEEE 802.11 Standard.
145.Sh HISTORY
146The
147.Nm
148driver first appeared in
149.Fx 5.0 .
150.Sh AUTHORS
151Atsushi Onoe is the author of original
152.Nx
153software from which this work began.
154.An -nosplit
155.An Sam Leffler
156brought the code into
157.Fx
158and then rewrote it to support multi-mode devices,
159802.11g, WPA/802.11i, WME, and add the extensible frameworks
160for cryptographic, authentication, and access control plugins.
161This manual page was written by
162.An Tom Rhodes Aq trhodes@FreeBSD.org .
163