xref: /freebsd/share/man/man9/ieee80211_input.9 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
1.\"
2.\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
3.\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\" $Id: ieee80211_input.9,v 1.6 2004/03/04 12:33:27 bruce Exp $
29.\"
30.Dd March 2, 2004
31.Dt ieee80211 9
32.Os
33.Sh NAME
34.Nm ieee80211
35.Nd core 802.11 network stack functions
36.Sh SYNOPSIS
37.In net80211/ieee80211_var.h
38.In net80211/ieee80211_proto.h
39.Ft void
40.Fn ieee80211_input "struct ifnet *ifp" "struct mbuf *m" "struct ieee80211_node *ni" "int rssi" "u_int32_t rstamp"
41.Ft struct mbuf *
42.Fn ieee80211_decap "struct ifnet *ifp" "struct mbuf *m"
43.Ft void
44.Fn ieee80211_recv_mgmt "struct ieee80211com *ic" "struct mbuf *m0" "struct ieee80211_node *ni" "int subtype" "int rssi" "u_int32_t rstamp"
45.Sh DESCRIPTION
46The
47.Nm
48functions process received 802.11 frames.
49.Pp
50.\"
51The
52.Fn ieee80211_input
53function takes an mbuf chain
54.Fa m
55containing a complete 802.11 frame from the driver
56.Fa ifp
57and passes it to the software 802.11 stack for input processing.
58The
59.Fa ni
60argument specifies an instance of
61.Vt struct ieee80211_node
62(which may be driver-specific) representing the node from which the
63frame was received.
64The arguments
65.Fa rssi
66and
67.Fa stamp
68are typically derived from on-card data structures; they are used for
69recording the signal strength and time received of the frame respectively.
70.Pp
71.\"
72The
73.Fn ieee80211_decap
74function performs decapsulation of the 802.11 frame in the mbuf chain
75.Fa m
76received by the device
77.Fa ifp ,
78taking the form of the 802.11 address fields into account;
79the structure of 802.11 addresses vary according to the intended
80source and destination of the frame.
81It is typically called from within
82.Fn ieee80211_input .
83.Pp
84.\"
85The
86.Fn ieee80211_recv_mgmt
87performs input processing for 802.11 management frames.
88It is typically called from within
89.Fn ieee80211_input .
90.Pp
91.\"
92.Sh SEE ALSO
93.Xr ieee80211 9 ,
94.Xr ifnet 9
95.Sh HISTORY
96The
97.Nm
98series of functions first appeared in
99.Nx 1.5 ,
100and were later ported to
101.Fx 4.6 .
102.Sh AUTHORS
103This man page was written by
104.An Bruce M. Simpson Aq bms@FreeBSD.org
105and
106.An Darron Broad Aq darron@kewl.org .
107.Sh BUGS
108There is no netisr queue specifically for the software 802.11 stack yet.
109