ieee80211_radiotap.h

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
    1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.5 2005/01/22 20:12:05 sam Exp $ */
    2 /* $NetBSD: ieee80211_radiotap.h,v 1.20 2008/09/08 23:36:55 gmcgarry Exp $ */
    3 
    4 /*-
    5  * Copyright (c) 2003, 2004 David Young.  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  * 3. The name of David Young may not be used to endorse or promote
   16  *    products derived from this software without specific prior
   17  *    written permission.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY
   20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
   21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   22  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DAVID
   23  * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
   25  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
   30  * OF SUCH DAMAGE.
   31  */
   32 #ifndef _NET80211_IEEE80211_RADIOTAP_H_
   33 #define _NET80211_IEEE80211_RADIOTAP_H_
   34 
   35 /* A generic radio capture format is desirable. It must be
   36  * rigidly defined (e.g., units for fields should be given),
   37  * and easily extensible.
   38  *
   39  * The following is an extensible radio capture format. It is
   40  * based on a bitmap indicating which fields are present.
   41  *
   42  * I am trying to describe precisely what the application programmer
   43  * should expect in the following, and for that reason I tell the
   44  * units and origin of each measurement (where it applies), or else I
   45  * use sufficiently weaselly language ("is a monotonically nondecreasing
   46  * function of...") that I cannot set false expectations for lawyerly
   47  * readers.
   48  */
   49 #if defined(__KERNEL__) || defined(_KERNEL)
   50 #ifndef DLT_IEEE802_11_RADIO
   51 #define DLT_IEEE802_11_RADIO    127     /* 802.11 plus WLAN header */
   52 #endif
   53 #endif /* defined(__KERNEL__) || defined(_KERNEL) */
   54 
   55 /* XXX tcpdump/libpcap do not tolerate variable-length headers,
   56  * yet, so we pad every radiotap header to 64 bytes. Ugh.
   57  */
   58 #define IEEE80211_RADIOTAP_HDRLEN       64
   59 
   60 /*
   61  * The radio capture header precedes the 802.11 header.
   62  *
   63  * Note well: all radiotap fields are little-endian.
   64  */
   65 struct ieee80211_radiotap_header {
   66         u_int8_t        it_version;     /* Version 0. Only increases
   67                                          * for drastic changes,
   68                                          * introduction of compatible
   69                                          * new fields does not count.
   70                                          */
   71         u_int8_t        it_pad;
   72         u_int16_t       it_len;         /* length of the whole
   73                                          * header in bytes, including
   74                                          * it_version, it_pad,
   75                                          * it_len, and data fields.
   76                                          */
   77         u_int32_t       it_present;     /* A bitmap telling which
   78                                          * fields are present. Set bit 31
   79                                          * (0x80000000) to extend the
   80                                          * bitmap by another 32 bits.
   81                                          * Additional extensions are made
   82                                          * by setting bit 31.
   83                                          */
   84 } __packed __aligned(8);
   85 
   86 /*
   87  * Name                                 Data type       Units
   88  * ----                                 ---------       -----
   89  *
   90  * IEEE80211_RADIOTAP_TSFT              u_int64_t       microseconds
   91  *
   92  *      Value in microseconds of the MAC's 64-bit 802.11 Time
   93  *      Synchronization Function timer when the first bit of the
   94  *      MPDU arrived at the MAC. For received frames, only.
   95  *
   96  * IEEE80211_RADIOTAP_CHANNEL           2 x u_int16_t   MHz, bitmap
   97  *
   98  *      Tx/Rx frequency in MHz, followed by flags (see below).
   99  *
  100  * IEEE80211_RADIOTAP_FHSS              u_int16_t       see below
  101  *
  102  *      For frequency-hopping radios, the hop set (first byte)
  103  *      and pattern (second byte).
  104  *
  105  * IEEE80211_RADIOTAP_RATE              u_int8_t        500kb/s
  106  *
  107  *      Tx/Rx data rate
  108  *
  109  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     int8_t          decibels from
  110  *                                                      one milliwatt (dBm)
  111  *
  112  *      RF signal power at the antenna, decibel difference from
  113  *      one milliwatt.
  114  *
  115  * IEEE80211_RADIOTAP_DBM_ANTNOISE      int8_t          decibels from
  116  *                                                      one milliwatt (dBm)
  117  *
  118  *      RF noise power at the antenna, decibel difference from one
  119  *      milliwatt.
  120  *
  121  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      u_int8_t        decibel (dB)
  122  *
  123  *      RF signal power at the antenna, decibel difference from an
  124  *      arbitrary, fixed reference.
  125  *
  126  * IEEE80211_RADIOTAP_DB_ANTNOISE       u_int8_t        decibel (dB)
  127  *
  128  *      RF noise power at the antenna, decibel difference from an
  129  *      arbitrary, fixed reference point.
  130  *
  131  * IEEE80211_RADIOTAP_LOCK_QUALITY      u_int16_t       unitless
  132  *
  133  *      Quality of Barker code lock. Unitless. Monotonically
  134  *      nondecreasing with "better" lock strength. Called "Signal
  135  *      Quality" in datasheets.  (Is there a standard way to measure
  136  *      this?)
  137  *
  138  * IEEE80211_RADIOTAP_TX_ATTENUATION    u_int16_t       unitless
  139  *
  140  *      Transmit power expressed as unitless distance from max
  141  *      power set at factory calibration.  0 is max power.
  142  *      Monotonically nondecreasing with lower power levels.
  143  *
  144  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t       decibels (dB)
  145  *
  146  *      Transmit power expressed as decibel distance from max power
  147  *      set at factory calibration.  0 is max power.  Monotonically
  148  *      nondecreasing with lower power levels.
  149  *
  150  * IEEE80211_RADIOTAP_DBM_TX_POWER      int8_t          decibels from
  151  *                                                      one milliwatt (dBm)
  152  *
  153  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
  154  *      reference). This is the absolute power level measured at
  155  *      the antenna port.
  156  *
  157  * IEEE80211_RADIOTAP_FLAGS             u_int8_t        bitmap
  158  *
  159  *      Properties of transmitted and received frames. See flags
  160  *      defined below.
  161  *
  162  * IEEE80211_RADIOTAP_ANTENNA           u_int8_t        antenna index
  163  *
  164  *      Unitless indication of the Rx/Tx antenna for this packet.
  165  *      The first antenna is antenna 0.
  166  *
  167  * IEEE80211_RADIOTAP_RX_FLAGS          u_int16_t       bitmap
  168  *
  169  *     Properties of received frames. See flags defined below.
  170  *
  171  * IEEE80211_RADIOTAP_TX_FLAGS          u_int16_t       bitmap
  172  *
  173  *     Properties of transmitted frames. See flags defined below.
  174  *
  175  * IEEE80211_RADIOTAP_RTS_RETRIES       u_int8_t        data
  176  *
  177  *     Number of rts retries a transmitted frame used.
  178  *
  179  * IEEE80211_RADIOTAP_DATA_RETRIES      u_int8_t        data
  180  *
  181  *     Number of unicast retries a transmitted frame used.
  182  */
  183 enum ieee80211_radiotap_type {
  184         IEEE80211_RADIOTAP_TSFT = 0,
  185         IEEE80211_RADIOTAP_FLAGS = 1,
  186         IEEE80211_RADIOTAP_RATE = 2,
  187         IEEE80211_RADIOTAP_CHANNEL = 3,
  188         IEEE80211_RADIOTAP_FHSS = 4,
  189         IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
  190         IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
  191         IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
  192         IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
  193         IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
  194         IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
  195         IEEE80211_RADIOTAP_ANTENNA = 11,
  196         IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
  197         IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
  198         IEEE80211_RADIOTAP_RX_FLAGS = 14,
  199         IEEE80211_RADIOTAP_TX_FLAGS = 15,
  200         IEEE80211_RADIOTAP_RTS_RETRIES = 16,
  201         IEEE80211_RADIOTAP_DATA_RETRIES = 17,
  202         IEEE80211_RADIOTAP_EXT = 31
  203 };
  204 
  205 #ifndef _KERNEL
  206 /* Channel flags. */
  207 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
  208 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
  209 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
  210 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
  211 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
  212 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
  213 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
  214 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
  215 #endif /* !_KERNEL */
  216 
  217 /* For IEEE80211_RADIOTAP_FLAGS */
  218 #define IEEE80211_RADIOTAP_F_CFP        0x01    /* sent/received
  219                                                  * during CFP
  220                                                  */
  221 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
  222                                                  * with short
  223                                                  * preamble
  224                                                  */
  225 #define IEEE80211_RADIOTAP_F_WEP        0x04    /* sent/received
  226                                                  * with WEP encryption
  227                                                  */
  228 #define IEEE80211_RADIOTAP_F_FRAG       0x08    /* sent/received
  229                                                  * with fragmentation
  230                                                  */
  231 #define IEEE80211_RADIOTAP_F_FCS        0x10    /* frame includes FCS */
  232 #define IEEE80211_RADIOTAP_F_DATAPAD    0x20    /* frame has padding between
  233                                                  * 802.11 header and payload
  234                                                  * (to 32-bit boundary)
  235                                                  */
  236 #define IEEE80211_RADIOTAP_F_BADFCS     0x40    /* does not pass FCS check */
  237 
  238 /* For IEEE80211_RADIOTAP_RX_FLAGS */
  239 #define IEEE80211_RADIOTAP_F_RX_BADFCS 0x0001  /* Frame failed CRC check.
  240                                                 *
  241                                                 * Deprecated: use the flag
  242                                                 * IEEE80211_RADIOTAP_F_BADFCS in
  243                                                 * the IEEE80211_RADIOTAP_FLAGS
  244                                                 * field, instead.
  245                                                 */
  246 
  247 /* For IEEE80211_RADIOTAP_TX_FLAGS */
  248 #define IEEE80211_RADIOTAP_F_TX_FAIL   0x0001  /* failed due to excessive
  249                                                 * retries
  250                                                 */
  251 #define IEEE80211_RADIOTAP_F_TX_CTS    0x0002  /* used cts 'protection' */
  252 #define IEEE80211_RADIOTAP_F_TX_RTS    0x0004  /* used rts/cts handshake */
  253 
  254 #endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */
Cache object: 917e52cc2aa0aa8b041a9d44b33e441b
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.
FreeBSD/Linux Kernel Cross Reference sys/net80211/ieee80211_radiotap.h

FreeBSD/Linux Kernel Cross Reference
sys/net80211/ieee80211_radiotap.h
