mirror of
https://github.com/freebsd/freebsd-src.git
synced 2024-12-04 16:49:40 +00:00
Fixed document title (should be in all uppercase).
List all functions in the NAME section so they appear in whatis(1). Assorted fixes (mostly markup).
This commit is contained in:
Ruslan Ermilov
parent
3b579c6e63
commit
2e77778053
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=131738
@ -28,10 +28,15 @@
|
||||
.\" $Id: ieee80211.9,v 1.5 2004/03/04 12:33:27 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211 9
|
||||
.Dt IEEE80211 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211
|
||||
.Nm ieee80211_ifattach , ieee80211_ifdetach ,
|
||||
.Nm ieee80211_mhz2ieee , ieee80211_chan2ieee , ieee80211_ieee2mhz ,
|
||||
.Nm ieee80211_media_init , ieee80211_media_change , ieee80211_media_status ,
|
||||
.Nm ieee80211_watchdog ,
|
||||
.Nm ieee80211_setmode , ieee80211_chan2mode ,
|
||||
.Nm ieee80211_rate2media , ieee80211_media2rate
|
||||
.Nd core 802.11 network stack functions
|
||||
.Sh SYNOPSIS
|
||||
.In net80211/ieee80211_var.h
|
||||
@ -46,6 +51,11 @@
|
||||
.Fn ieee80211_chan2ieee "struct ieee80211com *ic" "struct ieee80211_channel *c"
|
||||
.Ft u_int
|
||||
.Fn ieee80211_ieee2mhz "u_int chan" "u_int flags"
|
||||
.Ft void
|
||||
.Fo ieee80211_media_init
|
||||
.Fa "struct ifnet *ifp" "ifm_change_cb_t media_change"
|
||||
.Fa "ifm_stat_cb_t media_stat"
|
||||
.Fc
|
||||
.Fa int
|
||||
.Fn ieee80211_media_change "struct ifnet *ifp"
|
||||
.Fa void
|
||||
@ -55,14 +65,18 @@
|
||||
.Ft int
|
||||
.Fn ieee80211_setmode "struct ieee80211com *ic" "enum ieee80211_phymode mode"
|
||||
.Ft enum ieee80211_phymode
|
||||
.Fn ieee80211_chan2mode "struct ieee80211com *ic" "struct ieee80211_channel *chan"
|
||||
.Fo ieee80211_chan2mode
|
||||
.Fa "struct ieee80211com *ic" "struct ieee80211_channel *chan"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fn ieee80211_rate2media "struct ieee80211com *ic" "int rate" "enum ieee80211_phymode mode"
|
||||
.Fo ieee80211_rate2media
|
||||
.Fa "struct ieee80211com *ic" "int rate" "enum ieee80211_phymode mode"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fn ieee80211_media2rate "int mword"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
collection of functions are used to manage wireless network interfaces in the
|
||||
system which use the system's software 802.11 network stack.
|
||||
Most of these functions require that attachment to the stack is performed
|
||||
@ -77,7 +91,7 @@ function attaches the network interface
|
||||
.Fa ifp
|
||||
to the 802.11 network stack layer.
|
||||
This function must be called before using any of the
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
functions which need to store driver state across invocations;
|
||||
The
|
||||
.Vt struct ifnet
|
||||
@ -86,7 +100,7 @@ instance pointed to by
|
||||
MUST be an instance of
|
||||
.Vt struct ieee80211com ,
|
||||
with various fields initialized to tell
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
about its capabilities.
|
||||
This function performs Ethernet and BPF attachment (by calling
|
||||
.Fn ether_ifattach
|
||||
@ -101,7 +115,7 @@ interface.
|
||||
The
|
||||
.Fn ieee80211_ifdetach
|
||||
function frees any
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
structures associated with the driver, and performs Ethernet and BPF
|
||||
detachment on behalf of the caller.
|
||||
.Pp
|
||||
@ -114,10 +128,10 @@ utility function converts the frequency
|
||||
The
|
||||
.Fa flags
|
||||
argument is a hint which specifies whether the frequency is in
|
||||
the 2GHz ISM band (
|
||||
.Vt IEEE80211_CHAN_2GHZ )
|
||||
or the 5GHz band (
|
||||
.Vt IEEE80211_CHAN_5GHZ ) ;
|
||||
the 2GHz ISM band
|
||||
.Pq Vt IEEE80211_CHAN_2GHZ
|
||||
or the 5GHz band
|
||||
.Pq Vt IEEE80211_CHAN_5GHZ ;
|
||||
appropriate clipping of the result is then performed.
|
||||
.Pp
|
||||
.\"
|
||||
@ -130,7 +144,7 @@ to an IEEE channel number for the driver
|
||||
If the conversion would be invalid, an error message is printed to the
|
||||
system console.
|
||||
This function REQUIRES that the driver is hooked up to the
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
subsystem.
|
||||
.Pp
|
||||
.\"
|
||||
@ -142,10 +156,10 @@ to a frequency (in MHz).
|
||||
The
|
||||
.Fa flags
|
||||
argument is a hint which specifies whether the frequency is in
|
||||
the 2GHz ISM band (
|
||||
.Vt IEEE80211_CHAN_2GHZ )
|
||||
or the 5GHz band (
|
||||
.Vt IEEE80211_CHAN_5GHZ ) ;
|
||||
the 2GHz ISM band
|
||||
.Pq Vt IEEE80211_CHAN_2GHZ
|
||||
or the 5GHz band
|
||||
.Pq Vt IEEE80211_CHAN_5GHZ ;
|
||||
appropriate clipping of the result is then performed.
|
||||
.Pp
|
||||
.\"
|
||||
@ -158,7 +172,7 @@ interface, for the driver
|
||||
It must be called by the driver after calling
|
||||
.Fn ieee80211_attach
|
||||
and before calling most
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
functions.
|
||||
The
|
||||
.Fa media_change
|
||||
@ -183,7 +197,7 @@ commands and are not intended to be called directly.
|
||||
The
|
||||
.Fn ieee80211_watchdog
|
||||
function is intended to be called from a driver's
|
||||
.Vt if_watchdog
|
||||
.Va if_watchdog
|
||||
routine.
|
||||
It is used to perform periodic cleanup of state within the software 802.11
|
||||
stack, as well as timing out scans.
|
||||
@ -208,8 +222,8 @@ beacons, for example.
|
||||
The
|
||||
.Fn ieee80211_rate2media
|
||||
function converts the bit rate
|
||||
.Fa rate (
|
||||
measured in units of 0.5Mbps) to an
|
||||
.Fa rate
|
||||
(measured in units of 0.5Mbps) to an
|
||||
.Vt ifmedia
|
||||
sub-type, for the device
|
||||
.Fa ic
|
||||
@ -221,7 +235,6 @@ performs the reverse of this conversion, returning the bit rate (in 0.5Mbps
|
||||
units) corresponding to an
|
||||
.Vt ifmedia
|
||||
sub-type.
|
||||
.Pp
|
||||
.\"
|
||||
.Sh SEE ALSO
|
||||
.Xr ieee80211_crypto 9 ,
|
||||
@ -234,12 +247,13 @@ sub-type.
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -28,10 +28,10 @@
|
||||
.\" $Id: ieee80211_crypto.9,v 1.3 2004/03/04 10:42:56 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211_crypto 9
|
||||
.Dt IEEE80211_CRYPTO 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211_crypto
|
||||
.Nm ieee80211_crypto_attach , ieee80211_crypto_detach , ieee80211_wep_crypt
|
||||
.Nd 802.11 WEP encryption functions
|
||||
.Sh SYNOPSIS
|
||||
.Ft void
|
||||
@ -41,9 +41,7 @@
|
||||
.Ft struct mbuf *
|
||||
.Fn ieee80211_wep_crypt "struct ifnet *ifp" "struct mbuf *m0" "int txflag"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
collection of functions provide software encryption support
|
||||
These functions provide software encryption support
|
||||
for 802.11 device drivers.
|
||||
.Pp
|
||||
.\"
|
||||
@ -74,6 +72,7 @@ The
|
||||
argument specifies whether the frame is being received or transmitted.
|
||||
A value of 0 indicates that the frame is being received and should
|
||||
therefore be decrypted; a non-zero value indicates that the frame
|
||||
is being transmitted
|
||||
and should be encrypted.
|
||||
.\"
|
||||
.Sh IMPLEMENTATION NOTES
|
||||
@ -90,12 +89,13 @@ instance.
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -28,23 +28,28 @@
|
||||
.\" $Id: ieee80211_input.9,v 1.6 2004/03/04 12:33:27 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211 9
|
||||
.Dt IEEE80211_INPUT 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211
|
||||
.Nd core 802.11 network stack functions
|
||||
.Nm ieee80211_input , ieee80211_decap , ieee80211_recv_mgmt
|
||||
.Nd software 802.11 stack input functions
|
||||
.Sh SYNOPSIS
|
||||
.In net80211/ieee80211_var.h
|
||||
.In net80211/ieee80211_proto.h
|
||||
.Ft void
|
||||
.Fn ieee80211_input "struct ifnet *ifp" "struct mbuf *m" "struct ieee80211_node *ni" "int rssi" "u_int32_t rstamp"
|
||||
.Fo ieee80211_input
|
||||
.Fa "struct ifnet *ifp" "struct mbuf *m" "struct ieee80211_node *ni"
|
||||
.Fa "int rssi" "u_int32_t rstamp"
|
||||
.Fc
|
||||
.Ft struct mbuf *
|
||||
.Fn ieee80211_decap "struct ifnet *ifp" "struct mbuf *m"
|
||||
.Ft void
|
||||
.Fn ieee80211_recv_mgmt "struct ieee80211com *ic" "struct mbuf *m0" "struct ieee80211_node *ni" "int subtype" "int rssi" "u_int32_t rstamp"
|
||||
.Fo ieee80211_recv_mgmt
|
||||
.Fa "struct ieee80211com *ic" "struct mbuf *m0" "struct ieee80211_node *ni"
|
||||
.Fa "int subtype" "int rssi" "u_int32_t rstamp"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
These
|
||||
functions process received 802.11 frames.
|
||||
.Pp
|
||||
.\"
|
||||
@ -87,19 +92,19 @@ The
|
||||
performs input processing for 802.11 management frames.
|
||||
It is typically called from within
|
||||
.Fn ieee80211_input .
|
||||
.Pp
|
||||
.\"
|
||||
.Sh SEE ALSO
|
||||
.Xr ieee80211 9 ,
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -28,10 +28,10 @@
|
||||
.\" $Id: ieee80211_ioctl.9,v 1.5 2004/03/04 12:33:27 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211_ioctl 9
|
||||
.Dt IEEE80211_IOCTL 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211_ioctl
|
||||
.Nm ieee80211_cfgget , ieee80211_cfgset , ieee80211_ioctl
|
||||
.Nd 802.11 interface ioctl commands
|
||||
.Sh SYNOPSIS
|
||||
.In net80211/ieee80211_var.h
|
||||
@ -44,8 +44,7 @@
|
||||
.Ft int
|
||||
.Fn ieee80211_ioctl "struct ifnet *ifp" "u_long cmd" "caddr_t data"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
These
|
||||
functions are typically invoked by drivers in response to requests
|
||||
for information or to change settings from the userland.
|
||||
.Pp
|
||||
@ -66,19 +65,18 @@ utility.
|
||||
The
|
||||
.Fn ieee80211_ioctl
|
||||
function provides a default implementation of the
|
||||
.Vt SIOCS80211
|
||||
.Dv SIOCS80211
|
||||
and
|
||||
.Vt SIOCG80211
|
||||
.Dv SIOCG80211
|
||||
ifioctls commands for 802.11 drivers.
|
||||
The call signature is identical to that of the
|
||||
.Vt if_ioctl
|
||||
.Va if_ioctl
|
||||
member found in
|
||||
.Vt struct ifnet ,
|
||||
however, many drivers store attributes such as
|
||||
.Vt IEEE80211_IOC_STATIONNAME
|
||||
.Dv IEEE80211_IOC_STATIONNAME
|
||||
in the driver's private soft state structure, so driver writers may prefer
|
||||
to use this as the catch-all in a switch statement to avoid code duplication.
|
||||
.Pp
|
||||
.\"
|
||||
.Sh SEE ALSO
|
||||
.Xr owi 4 ,
|
||||
@ -88,12 +86,13 @@ to use this as the catch-all in a switch statement to avoid code duplication.
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -28,10 +28,24 @@
|
||||
.\" $Id: ieee80211_node.9,v 1.6 2004/03/04 12:33:27 bruce Exp $
|
||||
.\"
|
||||
.Dd July 4, 2004
|
||||
.Dt ieee80211_node 9
|
||||
.Dt IEEE80211_NODE 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211_node
|
||||
.Nm ieee80211_node_attach ,
|
||||
.Nm ieee80211_node_lateattach ,
|
||||
.Nm ieee80211_node_detach ,
|
||||
.Nm ieee80211_begin_scan ,
|
||||
.Nm ieee80211_next_scan ,
|
||||
.Nm ieee80211_create_ibss ,
|
||||
.Nm ieee80211_end_scan ,
|
||||
.Nm ieee80211_alloc_node ,
|
||||
.Nm ieee80211_dup_bss ,
|
||||
.Nm ieee80211_find_node ,
|
||||
.Nm ieee80211_lookup_node ,
|
||||
.Nm ieee80211_free_node ,
|
||||
.Nm ieee80211_free_allnodes ,
|
||||
.Nm ieee80211_timeout_nodes ,
|
||||
.Nm ieee80211_iterate_nodes
|
||||
.Nd software 802.11 stack node management functions
|
||||
.Sh SYNOPSIS
|
||||
.In net80211/ieee80211_var.h
|
||||
@ -48,7 +62,9 @@
|
||||
.Ft void
|
||||
.Fn ieee80211_next_scan "struct ifnet *ifp"
|
||||
.Ft void
|
||||
.Fn ieee80211_create_ibss "struct ieee80211com *ic" "struct ieee80211_channel *chan"
|
||||
.Fo ieee80211_create_ibss
|
||||
.Fa "struct ieee80211com *ic" "struct ieee80211_channel *chan"
|
||||
.Fc
|
||||
.Ft void
|
||||
.Fn ieee80211_end_scan "struct ifnet *ifp"
|
||||
.Ft struct ieee80211_node *
|
||||
@ -58,7 +74,10 @@
|
||||
.Ft struct ieee80211_node *
|
||||
.Fn ieee80211_find_node "struct ieee80211com *ic" "u_int8_t *macaddr"
|
||||
.Ft struct ieee80211_node *
|
||||
.Fn ieee80211_lookup_node "struct ieee80211com *ic" "u_int8_t *macaddr" "struct ieee80211_channel *chan"
|
||||
.Fo ieee80211_lookup_node
|
||||
.Fa "struct ieee80211com *ic" "u_int8_t *macaddr"
|
||||
.Fa "struct ieee80211_channel *chan"
|
||||
.Fc
|
||||
.Ft void
|
||||
.Fn ieee80211_free_node "struct ieee80211com *ic" "struct ieee80211_node *ni"
|
||||
.Ft void
|
||||
@ -66,11 +85,11 @@
|
||||
.Ft void
|
||||
.Fn ieee80211_timeout_nodes "struct ieee80211com *ic"
|
||||
.Ft void
|
||||
.Fn ieee80211_iterate_nodes "struct ieee80211com *ic" "ieee80211_iter_func *f" "void *arg"
|
||||
.Fo ieee80211_iterate_nodes
|
||||
.Fa "struct ieee80211com *ic" "ieee80211_iter_func *f" "void *arg"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
collection of functions are used to manage node lists within the software
|
||||
These functions are used to manage node lists within the software
|
||||
802.11 stack.
|
||||
These lists are typically used for implementing host-mode AP functionality,
|
||||
or providing signal quality information about neighbouring nodes.
|
||||
@ -93,13 +112,13 @@ and prior to any other call which may allocate a node.
|
||||
The
|
||||
.Fn ieee80211_node_lateattach
|
||||
function initialises the
|
||||
.Dv ic_bss
|
||||
.Va ic_bss
|
||||
node element of the interface
|
||||
.Fa ifp
|
||||
during
|
||||
.Xr ieee80211_media_init 9 .
|
||||
This late attachment is to account for certain special cases described under
|
||||
.Xr ieee80211_node_attach 9 .
|
||||
.Fn ieee80211_node_attach .
|
||||
.Pp
|
||||
.\"
|
||||
The
|
||||
@ -166,14 +185,16 @@ requested from userland.
|
||||
The
|
||||
.Fn ieee80211_alloc_node
|
||||
function allocates an instance of
|
||||
.Dv struct ieee80211_node
|
||||
.Vt "struct ieee80211_node"
|
||||
for a node having the MAC address
|
||||
.Fa macaddr ,
|
||||
and associates it with the interface
|
||||
.Fa ic .
|
||||
If the allocation is successful, the node structure is initialised by
|
||||
.Fn ieee80211_setup_node ;
|
||||
otherwise, NULL is returned.
|
||||
otherwise,
|
||||
.Dv NULL
|
||||
is returned.
|
||||
.Pp
|
||||
.\"
|
||||
The
|
||||
@ -186,7 +207,9 @@ associated with the interface
|
||||
.Fa ic .
|
||||
If the allocation is successful, the node structure is initialised by
|
||||
.Fn ieee80211_setup_node ;
|
||||
otherwise, NULL is returned.
|
||||
otherwise,
|
||||
.Dv NULL
|
||||
is returned.
|
||||
.Pp
|
||||
.\"
|
||||
The
|
||||
@ -196,7 +219,9 @@ function will iterate through the node list associated with the interface
|
||||
searching for a node entry which matches
|
||||
.Fa macaddr .
|
||||
If the entry is found, its reference count is incremented, and
|
||||
a pointer to the node is returned; otherwise, NULL will be returned.
|
||||
a pointer to the node is returned; otherwise,
|
||||
.Dv NULL
|
||||
will be returned.
|
||||
.Pp
|
||||
.\"
|
||||
The
|
||||
@ -207,7 +232,9 @@ with an additional argument
|
||||
.Fa chan
|
||||
which is used to specify a channel for the match.
|
||||
If the entry is found, its reference count is incremented, and
|
||||
a pointer to the node is returned; otherwise, NULL will be returned.
|
||||
a pointer to the node is returned; otherwise,
|
||||
.Dv NULL
|
||||
will be returned.
|
||||
.Pp
|
||||
.\"
|
||||
The
|
||||
@ -217,7 +244,8 @@ function will remove the node
|
||||
from the node database entries associated with the interface
|
||||
.Fa ic ,
|
||||
and free any memory associated with the node.
|
||||
This private method can be overridden in ieee80211_node_attach.
|
||||
This private method can be overridden in
|
||||
.Fn ieee80211_node_attach .
|
||||
.\"
|
||||
.Pp
|
||||
The
|
||||
@ -246,19 +274,19 @@ for all nodes in the node database associated with the interface
|
||||
The callback is invoked with the with the user-supplied value
|
||||
.Fa arg
|
||||
and a pointer to the current node.
|
||||
.Pp
|
||||
.\"
|
||||
.Sh SEE ALSO
|
||||
.Xr ieee80211 9 ,
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -28,26 +28,29 @@
|
||||
.\" $Id: ieee80211_output.9,v 1.5 2004/03/04 12:31:18 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211_output 9
|
||||
.Dt IEEE80211_OUTPUT 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211_output
|
||||
.Nm ieee80211_encap , ieee80211_add_rates ,
|
||||
.Nm ieee80211_add_xrates , ieee80211_send_mgmt
|
||||
.Nd software 802.11 stack output functions
|
||||
.Sh SYNOPSIS
|
||||
.In net80211/ieee80211_var.h
|
||||
.In net80211/ieee80211_proto.h
|
||||
.Ft struct mbuf *
|
||||
.Fn ieee80211_encap "struct ifnet *ifp" "struct mbuf *m" "struct ieee80211_node **pni"
|
||||
.Fo ieee80211_encap
|
||||
.Fa "struct ifnet *ifp" "struct mbuf *m" "struct ieee80211_node **pni"
|
||||
.Fc
|
||||
.Ft u_int8_t *
|
||||
.Fn ieee80211_add_rates "u_int8_t *frm" "const struct ieee80211_rateset *rs"
|
||||
.Ft u_int8_t *
|
||||
.Fn ieee80211_add_xrates "u_int8_t *frm" "const struct ieee80211_rateset *rs"
|
||||
.Ft int
|
||||
.Fn ieee80211_send_mgmt "struct ieee80211com *ic" "struct ieee80211_node *ni" "int type" "int arg"
|
||||
.Fo ieee80211_send_mgmt
|
||||
.Fa "struct ieee80211com *ic" "struct ieee80211_node *ni" "int type" "int arg"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
series of functions handle the encapsulation and transmission of 802.11 frames
|
||||
These functions handle the encapsulation and transmission of 802.11 frames
|
||||
within the software 802.11 stack.
|
||||
.Pp
|
||||
The
|
||||
@ -64,14 +67,19 @@ is a reference to the destination node.
|
||||
If the function is successful, the mbuf chain is updated with the
|
||||
802.11 frame header prepended, and a pointer to the head of the chain
|
||||
is returned.
|
||||
If an error occurs, NULL will be returned, and
|
||||
If an error occurs,
|
||||
.Dv NULL
|
||||
will be returned, and
|
||||
.Fa *pni
|
||||
is also set to NULL.
|
||||
is also set to
|
||||
.Dv NULL .
|
||||
The caller is responsible for freeing the node reference if
|
||||
.Fa *pni
|
||||
is non-NULL on return.
|
||||
is
|
||||
.Pf non- Dv NULL
|
||||
on return.
|
||||
The convention is that
|
||||
.Vt ic_bss
|
||||
.Va ic_bss
|
||||
is not reference counted; the caller is responsible for maintaining this
|
||||
reference count.
|
||||
.Pp
|
||||
@ -116,7 +124,7 @@ a status code for [re]association operations,
|
||||
or a reason for deauthentication and deassociation operations.
|
||||
.Pp
|
||||
Nodes other than
|
||||
.Vt ic_bss
|
||||
.Va ic_bss
|
||||
have their reference count incremented to reflect their use for an
|
||||
indeterminate amount of time.
|
||||
This reference is freed when the function returns.
|
||||
@ -130,12 +138,13 @@ available, the function returns
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -28,9 +28,14 @@
|
||||
.\" $Id: ieee80211_proto.9,v 1.5 2004/03/04 12:33:27 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211_proto 9
|
||||
.Dt IEEE80211_PROTO 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211_proto_attach ,
|
||||
.Nm ieee80211_proto_detach ,
|
||||
.Nm ieee80211_print_essid ,
|
||||
.Nm ieee80211_dump_pkt ,
|
||||
.Nm ieee80211_fix_rate ,
|
||||
.Nm ieee80211_proto
|
||||
.Nd software 802.11 stack protocol helper functions
|
||||
.Sh SYNOPSIS
|
||||
@ -45,10 +50,11 @@
|
||||
.Ft void
|
||||
.Fn ieee80211_dump_pkt "u_int8_t *buf" "int len" "int rate" "int rssi"
|
||||
.Ft int
|
||||
.Fn ieee80211_fix_rate "struct ieee80211com *ic" "struct ieee80211_node *ni" "int flags"
|
||||
.Fo ieee80211_fix_rate
|
||||
.Fa "struct ieee80211com *ic" "struct ieee80211_node *ni" "int flags"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
These
|
||||
functions are helper functions used throughout the software 802.11 protocol
|
||||
stack.
|
||||
.Sh SEE ALSO
|
||||
@ -56,12 +62,13 @@ stack.
|
||||
.Xr ifnet 9
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Nm ieee80211
|
||||
series of functions first appeared in
|
||||
.Nx 1.5 ,
|
||||
and were later ported to
|
||||
.Fx 4.6 .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
This man page was written by
|
||||
.An Bruce M. Simpson Aq bms@FreeBSD.org
|
||||
and
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
.\" $Id: ieee80211_radiotap.9,v 1.3 2004/03/04 11:38:52 bruce Exp $
|
||||
.\"
|
||||
.Dd March 2, 2004
|
||||
.Dt ieee80211_radiotap 9
|
||||
.Dt IEEE80211_RADIOTAP 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ieee80211_radiotap
|
||||
@ -53,7 +53,7 @@ Radiotap was designed to balance the desire for a capture format
|
||||
that conserved CPU and memory bandwidth on embedded systems,
|
||||
with the desire for a hardware-independent, extensible format
|
||||
that would support the diverse capabilities of virtually all
|
||||
.Vt 802.11
|
||||
802.11
|
||||
radios.
|
||||
.Pp
|
||||
These considerations led radiotap to settle on a format consisting of
|
||||
@ -72,7 +72,7 @@ This information may be used by a variety of user agents, including
|
||||
It is requested by using the
|
||||
.Xr bpf 4
|
||||
data-link type
|
||||
.Vt DLT_IEEE_80211_RADIO .
|
||||
.Dv DLT_IEEE_80211_RADIO .
|
||||
.Pp
|
||||
.\"
|
||||
Each frame using this attachment has the following header prepended to it:
|
||||
@ -89,21 +89,21 @@ struct ieee80211_radiotap_header {
|
||||
A device driver implementing
|
||||
.Vt radiotap
|
||||
typically defines a packed structure embedding an instance of
|
||||
.Vt struct ieee80211_radiotap_header
|
||||
.Vt "struct ieee80211_radiotap_header"
|
||||
at the beginning,
|
||||
with subsequent fields in the appropriate order,
|
||||
and a macro to set the bits of the
|
||||
.Vt it_present
|
||||
.Va it_present
|
||||
bitmap to indicate which fields exist and are filled in by the driver.
|
||||
.\"
|
||||
.Pp
|
||||
Radiotap headers are copied to the userland via a separate bpf attachment.
|
||||
It is necessary for the driver to create this attachment after calling
|
||||
.Fn ieee80211_ifattach
|
||||
.Xr ieee80211_ifattach 9
|
||||
by calling
|
||||
.Fn bpfattach2
|
||||
with the data-link type set to
|
||||
.Vt DLT_IEEE_80211_RADIO .
|
||||
.Dv DLT_IEEE_80211_RADIO .
|
||||
.Pp
|
||||
.\"
|
||||
When the the information is available,
|
||||
@ -116,7 +116,7 @@ function.
|
||||
The following extension fields are defined for
|
||||
.Vt radiotap ,
|
||||
in the order in which they should appear in the buffer copied to userland:
|
||||
.Bl -tag -width ".Dv IEEE80211_RADIOTAP_DB_TX_ATTENUATION"
|
||||
.Bl -tag -width indent
|
||||
.It Dv IEEE80211_RADIOTAP_TSFT
|
||||
This field contains the unsigned 64-bit value, in microseconds,
|
||||
of the MAC's 802.11 Time Synchronization Function timer,
|
||||
@ -152,7 +152,9 @@ This field contains a single unsigned 16-bit value, indicating the
|
||||
quality of the Barker Code lock.
|
||||
No unit is specified for this field.
|
||||
There does not appear to be a standard way of measuring this at this time;
|
||||
this quantity is often referred to as 'Signal Quality' in some datasheets.
|
||||
this quantity is often referred to as
|
||||
.Dq "Signal Quality"
|
||||
in some datasheets.
|
||||
.It Dv IEEE80211_RADIOTAP_TX_ATTENUATION
|
||||
This field contains a single unsigned 16-bit value, expressing transmit
|
||||
power as unitless distance from maximum power set at factory calibration.
|
||||
@ -186,7 +188,7 @@ This bit is reserved for any future extensions to the
|
||||
structure.
|
||||
It should not be used at this time.
|
||||
.El
|
||||
.Sh EXAMPLE
|
||||
.Sh EXAMPLES
|
||||
Radiotap header for the Cisco Aironet driver:
|
||||
.Bd -literal -offset indent
|
||||
struct an_rx_radiotap_header {
|
||||
@ -221,6 +223,7 @@ and were later ported to
|
||||
.Fx 4.6 .
|
||||
.\"
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
The
|
||||
.Nm
|
||||
interface was designed and implemented by
|
||||
|
||||
Loading…
Reference in New Issue
Block a user