share/man/man9/ieee80211_input.9

   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_INPUT 9
  32 .Os
  33 .Sh NAME
  34 .Nm ieee80211_input , ieee80211_decap , ieee80211_recv_mgmt
  35 .Nd software 802.11 stack input functions
  36 .Sh SYNOPSIS
  37 .In net80211/ieee80211_var.h
  38 .In net80211/ieee80211_proto.h
  39 .Ft void
  40 .Fo ieee80211_input
  41 .Fa "struct ifnet *ifp" "struct mbuf *m" "struct ieee80211_node *ni"
  42 .Fa "int rssi" "u_int32_t rstamp"
  43 .Fc
  44 .Ft struct mbuf *
  45 .Fn ieee80211_decap "struct ifnet *ifp" "struct mbuf *m"
  46 .Ft void
  47 .Fo ieee80211_recv_mgmt
  48 .Fa "struct ieee80211com *ic" "struct mbuf *m0" "struct ieee80211_node *ni"
  49 .Fa "int subtype" "int rssi" "u_int32_t rstamp"
  50 .Fc
  51 .Sh DESCRIPTION
  52 These
  53 functions process received 802.11 frames.
  54 .Pp
  55 .\"
  56 The
  57 .Fn ieee80211_input
  58 function takes an mbuf chain
  59 .Fa m
  60 containing a complete 802.11 frame from the driver
  61 .Fa ifp
  62 and passes it to the software 802.11 stack for input processing.
  63 The
  64 .Fa ni
  65 argument specifies an instance of
  66 .Vt struct ieee80211_node
  67 (which may be driver-specific) representing the node from which the
  68 frame was received.
  69 The arguments
  70 .Fa rssi
  71 and
  72 .Fa stamp
  73 are typically derived from on-card data structures; they are used for
  74 recording the signal strength and time received of the frame respectively.
  75 .Pp
  76 .\"
  77 The
  78 .Fn ieee80211_decap
  79 function performs decapsulation of the 802.11 frame in the mbuf chain
  80 .Fa m
  81 received by the device
  82 .Fa ifp ,
  83 taking the form of the 802.11 address fields into account;
  84 the structure of 802.11 addresses vary according to the intended
  85 source and destination of the frame.
  86 It is typically called from within
  87 .Fn ieee80211_input .
  88 .Pp
  89 .\"
  90 The
  91 .Fn ieee80211_recv_mgmt
  92 performs input processing for 802.11 management frames.
  93 It is typically called from within
  94 .Fn ieee80211_input .
  95 .\"
  96 .Sh SEE ALSO
  97 .Xr ieee80211 9 ,
  98 .Xr ifnet 9
  99 .Sh HISTORY
 100 The
 101 .Nm ieee80211
 102 series of functions first appeared in
 103 .Nx 1.5 ,
 104 and were later ported to
 105 .Fx 4.6 .
 106 .Sh AUTHORS
 107 .An -nosplit
 108 This manual page was written by
 109 .An Bruce M. Simpson Aq bms@FreeBSD.org
 110 and
 111 .An Darron Broad Aq darron@kewl.org .
 112 .Sh BUGS
 113 There is no netisr queue specifically for the software 802.11 stack yet.