"Fossies" - the Fresh Open Source Software Archive

Member "tcpflow-1.6.1/src/wifipcap/ieee802_11_radio.h" (19 Feb 2021, 9988 Bytes) of package /linux/misc/tcpflow-1.6.1.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "ieee802_11_radio.h" see the Fossies "Dox" file reference documentation.

    1 /*-
    2  * Copyright (c) 2003, 2004 David Young.  All rights reserved.
    3  *
    4  * Redistribution and use in source and binary forms, with or without
    5  * modification, are permitted provided that the following conditions
    6  * are met:
    7  * 1. Redistributions of source code must retain the above copyright
    8  *    notice, this list of conditions and the following disclaimer.
    9  * 2. Redistributions in binary form must reproduce the above copyright
   10  *    notice, this list of conditions and the following disclaimer in the
   11  *    documentation and/or other materials provided with the distribution.
   12  * 3. The name of David Young may not be used to endorse or promote
   13  *    products derived from this software without specific prior
   14  *    written permission.
   15  *
   16  * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY
   17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
   18  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   19  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DAVID
   20  * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
   22  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
   27  * OF SUCH DAMAGE.
   28  */
   29 
   30 /* Copyright 2013 Simson L. Garfinkel
   31  * Cleaned up.
   32  */
   33 
   34 #ifndef _NET_IF_IEEE80211RADIOTAP_H_
   35 #define _NET_IF_IEEE80211RADIOTAP_H_
   36 
   37 #include "os.h"
   38 
   39 /* A generic radio capture format is desirable. There is one for
   40  * Linux, but it is neither rigidly defined (there were not even
   41  * units given for some fields) nor easily extensible.
   42  *
   43  * I suggest the following extensible radio capture format. It is
   44  * based on a bitmap indicating which fields are present.
   45  *
   46  * I am trying to describe precisely what the application programmer
   47  * should expect in the following, and for that reason I tell the
   48  * units and origin of each measurement (where it applies), or else I
   49  * use sufficiently weaselly language ("is a monotonically nondecreasing
   50  * function of...") that I cannot set false expectations for lawyerly
   51  * readers.
   52  */
   53 #ifndef DLT_IEEE802_11_RADIO
   54 #define DLT_IEEE802_11_RADIO    127 /* 802.11 plus WLAN header */
   55 #endif
   56 
   57 #ifdef _WIN32
   58 #pragma pack(push, 1)
   59 #endif
   60 /* The radio capture header precedes the 802.11 header. */
   61 struct ieee80211_radiotap_header {
   62     u_int8_t    it_version; /* Version 0. Only increases
   63                      * for drastic changes,
   64                      * introduction of compatible
   65                      * new fields does not count.
   66                      */
   67     u_int8_t    it_pad;
   68     u_int16_t       it_len;         /* length of the whole
   69                      * header in bytes, including
   70                      * it_version, it_pad,
   71                      * it_len, and data fields.
   72                      */
   73     u_int32_t       it_present;     /* A bitmap telling which
   74                      * fields are present. Set bit 31
   75                      * (0x80000000) to extend the
   76                      * bitmap by another 32 bits.
   77                      * Additional extensions are made
   78                      * by setting bit 31.
   79                      */
   80 } _PACKED_;
   81 #ifdef _WIN32
   82 #pragma pack(pop)
   83 #endif
   84 
   85 /* Name                                 Data type       Units
   86  * ----                                 ---------       -----
   87  *
   88  * IEEE80211_RADIOTAP_TSFT              u_int64_t       microseconds
   89  *
   90  *      Value in microseconds of the MAC's 64-bit 802.11 Time
   91  *      Synchronization Function timer when the first bit of the
   92  *      MPDU arrived at the MAC. For received frames, only.
   93  *
   94  * IEEE80211_RADIOTAP_CHANNEL           2 x u_int16_t   MHz, bitmap
   95  *
   96  *      Tx/Rx frequency in MHz, followed by flags (see below).
   97  *
   98  * IEEE80211_RADIOTAP_FHSS              u_int16_t       see below
   99  *
  100  *      For frequency-hopping radios, the hop set (first byte)
  101  *      and pattern (second byte).
  102  *
  103  * IEEE80211_RADIOTAP_RATE              u_int8_t        500kb/s
  104  *
  105  *      Tx/Rx data rate
  106  *
  107  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     int8_t          decibels from
  108  *                                                      one milliwatt (dBm)
  109  *
  110  *      RF signal power at the antenna, decibel difference from
  111  *      one milliwatt.
  112  *
  113  * IEEE80211_RADIOTAP_DBM_ANTNOISE      int8_t          decibels from
  114  *                                                      one milliwatt (dBm)
  115  *
  116  *      RF noise power at the antenna, decibel difference from one
  117  *      milliwatt.
  118  *
  119  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      u_int8_t        decibel (dB)
  120  *
  121  *      RF signal power at the antenna, decibel difference from an
  122  *      arbitrary, fixed reference.
  123  *
  124  * IEEE80211_RADIOTAP_DB_ANTNOISE       u_int8_t        decibel (dB)
  125  *
  126  *      RF noise power at the antenna, decibel difference from an
  127  *      arbitrary, fixed reference point.
  128  *
  129  * IEEE80211_RADIOTAP_LOCK_QUALITY      u_int16_t       unitless
  130  *
  131  *      Quality of Barker code lock. Unitless. Monotonically
  132  *      nondecreasing with "better" lock strength. Called "Signal
  133  *      Quality" in datasheets.  (Is there a standard way to measure
  134  *      this?)
  135  *
  136  * IEEE80211_RADIOTAP_TX_ATTENUATION    u_int16_t       unitless
  137  *
  138  *      Transmit power expressed as unitless distance from max
  139  *      power set at factory calibration.  0 is max power.
  140  *      Monotonically nondecreasing with lower power levels.
  141  *
  142  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t       decibels (dB)
  143  *
  144  *      Transmit power expressed as decibel distance from max power
  145  *      set at factory calibration.  0 is max power.  Monotonically
  146  *      nondecreasing with lower power levels.
  147  *
  148  * IEEE80211_RADIOTAP_DBM_TX_POWER      int8_t          decibels from
  149  *                                                      one milliwatt (dBm)
  150  *
  151  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
  152  *      reference). This is the absolute power level measured at
  153  *      the antenna port.
  154  *
  155  * IEEE80211_RADIOTAP_FLAGS             u_int8_t        bitmap
  156  *
  157  *      Properties of transmitted and received frames. See flags
  158  *      defined below.
  159  *
  160  * IEEE80211_RADIOTAP_ANTENNA           u_int8_t        antenna index
  161  *
  162  *      Unitless indication of the Rx/Tx antenna for this packet.
  163  *      The first antenna is antenna 0.
  164  *
  165  * IEEE80211_RADIOTAP_FCS               u_int32_t       data
  166  *
  167  *  FCS from frame in network byte order.
  168  */
  169 enum ieee80211_radiotap_type {
  170     IEEE80211_RADIOTAP_TSFT = 0,
  171     IEEE80211_RADIOTAP_FLAGS = 1,
  172     IEEE80211_RADIOTAP_RATE = 2,
  173     IEEE80211_RADIOTAP_CHANNEL = 3,
  174     IEEE80211_RADIOTAP_FHSS = 4,
  175     IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
  176     IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
  177     IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
  178     IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
  179     IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
  180     IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
  181     IEEE80211_RADIOTAP_ANTENNA = 11,
  182     IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
  183     IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
  184     IEEE80211_RADIOTAP_RX_FLAGS = 14,
  185         IEEE80211_RADIOTAP_TX_FLAGS = 15,
  186     IEEE80211_RADIOTAP_RTS_RETRIES = 16,
  187         IEEE80211_RADIOTAP_DATA_RETRIES = 17,
  188         IEEE80211_RADIOTAP_XCHANNEL = 18, /* Unofficial, used by FreeBSD */
  189     IEEE80211_RADIOTAP_MCS = 19,
  190     IEEE80211_RADIOTAP_AMPDU_STATUS = 20,
  191     /* valid in every it_present bitmap, even vendor namespaces */
  192     IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29,
  193     IEEE80211_RADIOTAP_EXT = 31
  194 };
  195 
  196 /* Channel flags. */
  197 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
  198 #define IEEE80211_CHAN_CCK  0x0020  /* CCK channel */
  199 #define IEEE80211_CHAN_OFDM 0x0040  /* OFDM channel */
  200 #define IEEE80211_CHAN_2GHZ 0x0080  /* 2 GHz spectrum channel. */
  201 #define IEEE80211_CHAN_5GHZ 0x0100  /* 5 GHz spectrum channel */
  202 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
  203 #define IEEE80211_CHAN_DYN  0x0400  /* Dynamic CCK-OFDM channel */
  204 #define IEEE80211_CHAN_GFSK 0x0800  /* GFSK channel (FHSS PHY) */
  205 
  206 /* For IEEE80211_RADIOTAP_FLAGS */
  207 #define IEEE80211_RADIOTAP_F_CFP    0x01    /* sent/received
  208                          * during CFP
  209                          */
  210 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
  211                          * with short
  212                          * preamble
  213                          */
  214 #define IEEE80211_RADIOTAP_F_WEP    0x04    /* sent/received
  215                          * with WEP encryption
  216                          */
  217 #define IEEE80211_RADIOTAP_F_FRAG   0x08    /* sent/received
  218                          * with fragmentation
  219                          */
  220 #define IEEE80211_RADIOTAP_F_FCS    0x10    /* frame includes FCS */
  221 #define IEEE80211_RADIOTAP_F_DATAPAD    0x20    /* frame has padding between
  222                          * 802.11 header and payload
  223                          * (to 32-bit boundary)
  224                          */
  225 #define IEEE80211_RADIOTAP_F_BADFCS 0x40    /* does not pass FCS check */
  226 
  227 /* For IEEE80211_RADIOTAP_RX_FLAGS */
  228 #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002 /* bad PLCP */
  229 
  230 /* For IEEE80211_RADIOTAP_TX_FLAGS */
  231 #define IEEE80211_RADIOTAP_F_TX_FAIL    0x0001  /* failed due to excessive
  232                          * retries */
  233 #define IEEE80211_RADIOTAP_F_TX_CTS 0x0002  /* used cts 'protection' */
  234 #define IEEE80211_RADIOTAP_F_TX_RTS 0x0004  /* used rts/cts handshake */
  235 
  236 /* For IEEE80211_RADIOTAP_AMPDU_STATUS */
  237 #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001
  238 #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002
  239 #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004
  240 #define IEEE80211_RADIOTAP_AMPDU_IS_LAST    0x0008
  241 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR  0x0010
  242 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020
  243 
  244 
  245 /* For IEEE80211_RADIOTAP_MCS */
  246 #define IEEE80211_RADIOTAP_MCS_HAVE_BW      0x01
  247 #define IEEE80211_RADIOTAP_MCS_HAVE_MCS     0x02
  248 #define IEEE80211_RADIOTAP_MCS_HAVE_GI      0x04
  249 #define IEEE80211_RADIOTAP_MCS_HAVE_FMT     0x08
  250 #define IEEE80211_RADIOTAP_MCS_HAVE_FEC     0x10
  251 
  252 #define IEEE80211_RADIOTAP_MCS_BW_MASK      0x03
  253 #define IEEE80211_RADIOTAP_MCS_BW_20               0
  254 #define IEEE80211_RADIOTAP_MCS_BW_40               1
  255 #define IEEE80211_RADIOTAP_MCS_BW_20L              2
  256 #define IEEE80211_RADIOTAP_MCS_BW_20U              3
  257 #define IEEE80211_RADIOTAP_MCS_SGI      0x04
  258 #define IEEE80211_RADIOTAP_MCS_FMT_GF       0x08
  259 #define IEEE80211_RADIOTAP_MCS_FEC_LDPC     0x10
  260 
  261 
  262 #endif /* _NET_IF_IEEE80211RADIOTAP_H_ */