xref: /dragonfly/share/man/man9/ieee80211_input.9 (revision 19fe1c42)
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.\" $DragonFly: src/share/man/man9/ieee80211_input.9,v 1.4 2006/06/28 19:41:59 swildner Exp $
29.\" $Id: ieee80211_input.9,v 1.2 2004/07/07 12:59:39 ru Exp $
30.\"
31.Dd June 28, 2006
32.Dt IEEE80211_INPUT 9
33.Os
34.Sh NAME
35.Nm ieee80211_input ,
36.Nm ieee80211_recv_mgmt
37.Nd software 802.11 stack input functions
38.Sh SYNOPSIS
39.In netproto/802_11/ieee80211_var.h
40.Ft void
41.Fo ieee80211_input
42.Fa "struct ieee80211com *ic" "struct mbuf *m" "struct ieee80211_node *ni"
43.Fa "int rssi" "uint32_t rstamp"
44.Fc
45.Ft void
46.Fo ieee80211_recv_mgmt
47.Fa "struct ieee80211com *ic" "struct mbuf *m" "struct ieee80211_node *ni"
48.Fa "int subtype" "int rssi" "uint32_t rstamp"
49.Fc
50.Sh DESCRIPTION
51These functions process received 802.11 frames.
52.Pp
53.\"
54The
55.Fn ieee80211_input
56function takes an mbuf chain
57.Fa m
58containing a complete 802.11 frame from the interface
59.Fa ic
60and passes it to the software 802.11 stack for input processing.
61The
62.Fa ni
63argument specifies an instance of
64.Vt struct ieee80211_node
65(which may be driver-specific) representing the node from which the
66frame was received, and must not be
67.Dv NULL .
68Typically,
69.Fa ni
70is the return value of
71.Xr ieee80211_find_rxnode 9 .
72The arguments
73.Fa rssi
74and
75.Fa rstamp
76are typically derived from on-card data structures; they are used for
77recording the signal strength and time received of the frame respectively.
78.Pp
79.\"
80The
81.Fn ieee80211_recv_mgmt
82performs input processing for 802.11 management frames.
83It is typically called from within
84.Fn ieee80211_input
85through
86.Va ic_recv_mgmt .
87If the driver wants to intercept the 802.11 management frames' processing,
88it will save
89.Va ic_recv_mgmt
90for later use and assign its own
91.Fn recv_mgmt
92to
93.Va ic_recv_mgmt .
94The saved function,
95i.e.
96.Fn ieee80211_recv_mgmt ,
97must be called within the driver's own
98.Fn recv_mgmt .
99.\"
100.Sh SEE ALSO
101.Xr ieee80211 9 ,
102.Xr ifnet 9
103.Sh HISTORY
104The
105.Nm ieee80211
106series of functions first appeared in
107.Nx 1.5 ,
108and were later ported to
109.Fx 4.6 .
110.Sh AUTHORS
111.An -nosplit
112This man page was written by
113.An Bruce M. Simpson Aq bms@FreeBSD.org
114and
115.An Darron Broad Aq darron@kewl.org .
116