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