d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates for revised ath and net80211 support; the new man pages are

Browse Source 
placeholders for real material.
This commit is contained in:
Sam Leffler 2004-12-08 17:47:32 +00:00
parent 2efe996b98
commit 014be7fb7e
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=138579
8 changed files with 385 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
share/man/man4/Makefile
View File

@ -341,6 +341,11 @@ MAN= aac.4 \
wi.4 \
witness.4 \
wlan.4 \
wlan_acl.4 \
wlan_ccmp.4 \
wlan_tkip.4 \
wlan_wep.4 \
wlan_xauth.4 \
worm.4 \
xe.4 \
xl.4 \

21
share/man/man4/ath.4
View File

@ -1,5 +1,5 @@
.\"-
.\" Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting
.\" Copyright (c) 2002-2004 Sam Leffler, Errno Consulting
.\" All rights reserved.
.\""
.\" Redistribution and use in source and binary forms, with or without
@ -31,7 +31,7 @@
.\"
.\" $FreeBSD$
.\"/
.Dd August 26, 2004
.Dd December 7, 2004
.Dt ATH 4
.Os
.Sh NAME
@ -40,6 +40,7 @@
.Sh SYNOPSIS
.Cd "device ath"
.Cd "device ath_hal"
.Cd "device ath_rate_onoe"
.Cd "device wlan"
.Sh DESCRIPTION
The
@ -67,14 +68,15 @@ speeds as above for 802.11a operation and
AR5212-based devices support 802.11a, 802.11b, and 802.11g operation
with transmit speeds appropriate to each.
All chips also support an Atheros Turbo Mode (TM) that operates in
the 802.11a frequency range with 2x the transmit speeds.
(This mode is, however, only interoperable with other Atheros-based devices.)
the 5Ghz frequency range with 2x the transmit speeds.
Some chips also support Turbo mode in the 2.4Ghz range with 802.11g.
(These modes are, however, only interoperable with other Atheros-based devices.)
The actual transmit speed used is dependent on signal quality and the
.Dq "rate control"
algorithm employed by the driver.
All chips support WEP encryption.
AR5211 and AR5212 support the AES, TKIP, and Michael cryptographic
operations required for WPA but at this time the driver does not support them.
The AR5212 has hardware support for the AES-CCM, TKIP, and Michael cryptographic
operations required for WPA.
To enable encryption, use
.Xr ifconfig 8
as shown below.
@ -258,13 +260,6 @@ the set of available channels.
A problem occurred while querying the HAL to find the set of available
channels for the device.
This should not happen.
.It "ath%d: %s: %dM -> %dM (%d ok, %d err, %d retr)"
The driver's rate control algorithm changed the current rate for transmitting
frames.
This message is temporarily enabled for normal use to help in diagnosing
and improving the rate control algorithm.
The message indicates the new and old transmit rates and the statistics
it used to decide on this change.
.It "ath%d: failed to enable memory mapping"
The driver was unable to enable memory-mapped I/O to the PCI device registers.
This should not happen.

75
share/man/man4/wlan.4
View File

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd September 25, 2003
.Dd December 7, 2004
.Dt WLAN 4
.Os
.Sh NAME
@ -36,26 +36,64 @@
.Sh DESCRIPTION
The
.Nm
device provides generic code to support 802.11
drivers, including host AP mode.
Currently it is required for the
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 wi 4 ,
.Xr an 4
and
.Xr ath 4
drivers but will eventually be required by all 802.11 drivers.
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.
With the interface marked for debugging, doing:
Complete debugging controls are available using:
.Pp
.Dl "sysctl debug.ieee80211=1"
.Dl "sysctl net.wlan.X.debug=mask"
.Pp
where 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,
.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
causes additional messages to be generated.
Many drivers will also display the contents of each 802.11 frame
sent and received when the interface is marked with
both debugging and
@ -76,7 +114,12 @@ was used to be compatible with
.Xr ath 4 ,
.Xr awi 4 ,
.Xr netintro 4 ,
.Xr wi 4
.Xr wi 4 ,
.Xr wlan_wep 4 ,
.Xr wlan_tkip 4 ,
.Xr wlan_ccmp 4 ,
.Xr wlan_xauth 4 ,
.Xr wlan_acl 4
.Sh STANDARDS
More information can be found in the IEEE 802.11 Standard.
.Sh HISTORY
@ -85,13 +128,15 @@ The
driver first appeared in
.Fx 5.0 .
.Sh AUTHORS
Atsushi Onoe is the original author of this software.
The
Atsushi Onoe is the author of original
.Nx
support was adapted to
.Fx
by
software from which this work began.
.An -nosplit
.An Sam Leffler .
.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 .

57
share/man/man4/wlan_acl.4 Normal file
View File

@ -0,0 +1,57 @@
.\"
.\" Copyright (c) 2004 Sam Leffler
.\" 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$
.\"
.Dd December 7, 2004
.Dt WLAN_ACL 4
.Os
.Sh NAME
.Nm wlan_acl
.Nd MAC-based ACL support for 802.11 devices
.Sh SYNOPSIS
.Cd "device wlan_acl"
.Sh DESCRIPTION
The
.Nm
module implements a MAC-based access control plugin for use
with 802.11 devices operating as an access point.
.Nm
is an 802.11 access control plugin module for use with the
.Xr wlan 4
module.
This module is automatically loaded if an applications configures
an access control policy for an 802.11 device operating as an access
point.
.Sh SEE ALSO
.Xr wlan 4 ,
.Xr ifconfig 8
.Sh STANDARDS
More information can be found in the IEEE 802.11 Standard.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 6.0 .

65
share/man/man4/wlan_ccmp.4 Normal file
View File

@ -0,0 +1,65 @@
.\"
.\" Copyright (c) 2004 Sam Leffler
.\" 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$
.\"
.Dd December 7, 2004
.Dt WLAN_CCMP 4
.Os
.Sh NAME
.Nm wlan_ccmp
.Nd AES-CCMP crypto support for 802.11 devices
.Sh SYNOPSIS
.Cd "device wlan_ccmp"
.Sh DESCRIPTION
The
.Nm
module handles the AES-CCMP cryptographic requirements of the
WPA and 802.11i protocols.
.Nm
does encapsulation and decapsulation of CCMP-encoded 802.11 frames
and optionally calculates the AES-CCMP cipher.
.Nm
is an 802.11 cryptographic plugin module for use by the
.Xr wlan 4
module.
This module is automatically loaded if an AES-CCMP key is configured;
typically by a WPA supplicant program such as wpa_suplicant,
or a WPA authenticator program such as hostapd.
Should the underlying network device not be capable of doing the AES-CCMP
calculations in hardware, the
.Nm
module will do the work.
.Sh SEE ALSO
.Xr wlan 4 ,
.Xr wlan_wep 4 ,
.Xr wlan_tkip 4
.Sh STANDARDS
More information can be found in the IEEE 802.11, WPA, and 802.11i Standards.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 6.0 .

65
share/man/man4/wlan_tkip.4 Normal file
View File

@ -0,0 +1,65 @@
.\"
.\" Copyright (c) 2004 Sam Leffler
.\" 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$
.\"
.Dd December 7, 2004
.Dt WLAN_TKIP 4
.Os
.Sh NAME
.Nm wlan_tkip
.Nd TKIP and Michael crypto support for 802.11 devices
.Sh SYNOPSIS
.Cd "device wlan_tkip"
.Sh DESCRIPTION
The
.Nm
module handles the TKIP and Michael cryptographic requirements of the
WPA and 802.11i protocols.
.Nm
does encapsulation and decapsulation of TKIP-encoded 802.11 frames
and optionally calculates the TKIP cipher and Michale MIC.
.Nm
is an 802.11 cryptographic plugin module for use by the
.Xr wlan 4
module.
This module is automatically loaded if a TKIP key is configured;
typically by a WPA supplicant program such as wpa_suplicant,
or a WPA authenticator program such as hostapd.
Should the underlying network device not be capable of doing the TKIP
and/or Michael calculations in hardware, the
.Nm
module will do the work.
.Sh SEE ALSO
.Xr wlan 4 ,
.Xr wlan_wep 4 ,
.Xr wlan_ccmp 4
.Sh STANDARDS
More information can be found in the IEEE 802.11, WPA, and 802.11i Standards.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 6.0 .

63
share/man/man4/wlan_wep.4 Normal file
View File

@ -0,0 +1,63 @@
.\"
.\" Copyright (c) 2004 Sam Leffler
.\" 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$
.\"
.Dd December 7, 2004
.Dt WLAN_WEP 4
.Os
.Sh NAME
.Nm wlan_wep
.Nd WEP crypto support for 802.11 devices
.Sh SYNOPSIS
.Cd "device wlan_wep"
.Sh DESCRIPTION
The
.Nm
module handles the WEP cryptographic requirements of the 802.11 protocol.
.Nm
does encapsulation and decapsulation of WEP-encoded 802.11 frames
and optionally calculates the WEP cipher.
.Nm
is an 802.11 cryptographic plugin module for use by the
.Xr wlan 4
module.
This module is automatically loaded if a WEP key is configured with
.Xr ifconfig 8 .
Should the underlying network device not be capable of doing the WEP
calculations in hardware, the
.Nm
module will do the work.
.Sh SEE ALSO
.Xr wlan 4 ,
.Xr wlan_tkip 4 ,
.Xr wlan_ccmp 4
.Sh STANDARDS
More information can be found in the IEEE 802.11 Standard.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 6.0 .

62
share/man/man4/wlan_xauth.4 Normal file
View File

@ -0,0 +1,62 @@
.\"
.\" Copyright (c) 2004 Sam Leffler
.\" 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$
.\"
.Dd December 7, 2004
.Dt WLAN_XAUTH 4
.Os
.Sh NAME
.Nm wlan_xauth
.Nd External authenticator support for 802.11 devices
.Sh SYNOPSIS
.Cd "device wlan_xauth"
.Sh DESCRIPTION
The
.Nm
module implements an authenticator plugin that is intended
for use with user-mode authentication implementations such
as hostapd.
The
.Nm
hooks into the 802.11 layer and does nothing.
As a result, 802.11 stations that associate are not authorized to
send or receive frames until they are authorized by an external agent;
typically using a protocol such as WPA, 802.1x, or 802.11i.
.Nm
is an 802.11 authenticator plugin module for use by the
.Xr wlan 4
module.
This module is automatically loaded if an applications configures
an 802.11 device for operation as an AP with WPA or 802.1x authentication.
.Sh SEE ALSO
.Xr wlan 4
.Sh STANDARDS
More information can be found in the IEEE 802.11, WPA, and 802.11i Standards.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 6.0 .