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