sys/net80211/ieee80211_radiotap.h

   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  *
  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 #ifndef _NET80211_IEEE80211_RADIOTAP_H_
  30 #define _NET80211_IEEE80211_RADIOTAP_H_
  31
  32 /* A generic radio capture format is desirable. It must be
  33  * rigidly defined (e.g., units for fields should be given),
  34  * and easily extensible.
  35  *
  36  * The following is an extensible radio capture format. It is
  37  * based on a bitmap indicating which fields are present.
  38  *
  39  * I am trying to describe precisely what the application programmer
  40  * should expect in the following, and for that reason I tell the
  41  * units and origin of each measurement (where it applies), or else I
  42  * use sufficiently weaselly language ("is a monotonically nondecreasing
  43  * function of...") that I cannot set false expectations for lawyerly
  44  * readers.
  45  */
  46 #if defined(__KERNEL__) || defined(_KERNEL)
  47 #ifndef DLT_IEEE802_11_RADIO
  48 #define DLT_IEEE802_11_RADIO    127     /* 802.11 plus WLAN header */
  49 #endif
  50 #endif /* defined(__KERNEL__) || defined(_KERNEL) */
  51
  52 /* XXX tcpdump/libpcap do not tolerate variable-length headers,
  53  * yet, so we pad every radiotap header to 64 bytes. Ugh.
  54  */
  55 #define IEEE80211_RADIOTAP_HDRLEN       64
  56
  57 /*
  58  * The radio capture header precedes the 802.11 header.
  59  *
  60  * Note well: all radiotap fields are little-endian.
  61  */
  62 struct ieee80211_radiotap_header {
  63         u_int8_t        it_version;     /* Version 0. Only increases
  64                                          * for drastic changes,
  65                                          * introduction of compatible
  66                                          * new fields does not count.
  67                                          */
  68         u_int8_t        it_pad;
  69         u_int16_t       it_len;         /* length of the whole
  70                                          * header in bytes, including
  71                                          * it_version, it_pad,
  72                                          * it_len, and data fields.
  73                                          */
  74         u_int32_t       it_present;     /* A bitmap telling which
  75                                          * fields are present. Set bit 31
  76                                          * (0x80000000) to extend the
  77                                          * bitmap by another 32 bits.
  78                                          * Additional extensions are made
  79                                          * by setting bit 31.
  80                                          */
  81 } __packed __aligned(8);
  82
  83 /*
  84  * Name                                 Data type       Units
  85  * ----                                 ---------       -----
  86  *
  87  * IEEE80211_RADIOTAP_TSFT              u_int64_t       microseconds
  88  *
  89  *      Value in microseconds of the MAC's 64-bit 802.11 Time
  90  *      Synchronization Function timer when the first bit of the
  91  *      MPDU arrived at the MAC. For received frames, only.
  92  *
  93  * IEEE80211_RADIOTAP_CHANNEL           2 x u_int16_t   MHz, bitmap
  94  *
  95  *      Tx/Rx frequency in MHz, followed by flags (see below).
  96  *
  97  * IEEE80211_RADIOTAP_FHSS              u_int16_t       see below
  98  *
  99  *      For frequency-hopping radios, the hop set (first byte)
 100  *      and pattern (second byte).
 101  *
 102  * IEEE80211_RADIOTAP_RATE              u_int8_t        500kb/s
 103  *
 104  *      Tx/Rx data rate
 105  *
 106  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     int8_t          decibels from
 107  *                                                      one milliwatt (dBm)
 108  *
 109  *      RF signal power at the antenna, decibel difference from
 110  *      one milliwatt.
 111  *
 112  * IEEE80211_RADIOTAP_DBM_ANTNOISE      int8_t          decibels from
 113  *                                                      one milliwatt (dBm)
 114  *
 115  *      RF noise power at the antenna, decibel difference from one
 116  *      milliwatt.
 117  *
 118  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      u_int8_t        decibel (dB)
 119  *
 120  *      RF signal power at the antenna, decibel difference from an
 121  *      arbitrary, fixed reference.
 122  *
 123  * IEEE80211_RADIOTAP_DB_ANTNOISE       u_int8_t        decibel (dB)
 124  *
 125  *      RF noise power at the antenna, decibel difference from an
 126  *      arbitrary, fixed reference point.
 127  *
 128  * IEEE80211_RADIOTAP_LOCK_QUALITY      u_int16_t       unitless
 129  *
 130  *      Quality of Barker code lock. Unitless. Monotonically
 131  *      nondecreasing with "better" lock strength. Called "Signal
 132  *      Quality" in datasheets.  (Is there a standard way to measure
 133  *      this?)
 134  *
 135  * IEEE80211_RADIOTAP_TX_ATTENUATION    u_int16_t       unitless
 136  *
 137  *      Transmit power expressed as unitless distance from max
 138  *      power set at factory calibration.  0 is max power.
 139  *      Monotonically nondecreasing with lower power levels.
 140  *
 141  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t       decibels (dB)
 142  *
 143  *      Transmit power expressed as decibel distance from max power
 144  *      set at factory calibration.  0 is max power.  Monotonically
 145  *      nondecreasing with lower power levels.
 146  *
 147  * IEEE80211_RADIOTAP_DBM_TX_POWER      int8_t          decibels from
 148  *                                                      one milliwatt (dBm)
 149  *
 150  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
 151  *      reference). This is the absolute power level measured at
 152  *      the antenna port.
 153  *
 154  * IEEE80211_RADIOTAP_FLAGS             u_int8_t        bitmap
 155  *
 156  *      Properties of transmitted and received frames. See flags
 157  *      defined below.
 158  *
 159  * IEEE80211_RADIOTAP_ANTENNA           u_int8_t        antenna index
 160  *
 161  *      Unitless indication of the Rx/Tx antenna for this packet.
 162  *      The first antenna is antenna 0.
 163  *
 164  * IEEE80211_RADIOTAP_RX_FLAGS          u_int16_t       bitmap
 165  *
 166  *     Properties of received frames. See flags defined below.
 167  *
 168  * IEEE80211_RADIOTAP_TX_FLAGS          u_int16_t       bitmap
 169  *
 170  *     Properties of transmitted frames. See flags defined below.
 171  *
 172  * IEEE80211_RADIOTAP_RTS_RETRIES       u_int8_t        data
 173  *
 174  *     Number of rts retries a transmitted frame used.
 175  *
 176  * IEEE80211_RADIOTAP_DATA_RETRIES      u_int8_t        data
 177  *
 178  *     Number of unicast retries a transmitted frame used.
 179  */
 180 enum ieee80211_radiotap_type {
 181         IEEE80211_RADIOTAP_TSFT = 0,
 182         IEEE80211_RADIOTAP_FLAGS = 1,
 183         IEEE80211_RADIOTAP_RATE = 2,
 184         IEEE80211_RADIOTAP_CHANNEL = 3,
 185         IEEE80211_RADIOTAP_FHSS = 4,
 186         IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
 187         IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
 188         IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
 189         IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
 190         IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
 191         IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
 192         IEEE80211_RADIOTAP_ANTENNA = 11,
 193         IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
 194         IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
 195         IEEE80211_RADIOTAP_RX_FLAGS = 14,
 196         IEEE80211_RADIOTAP_TX_FLAGS = 15,
 197         IEEE80211_RADIOTAP_RTS_RETRIES = 16,
 198         IEEE80211_RADIOTAP_DATA_RETRIES = 17,
 199         IEEE80211_RADIOTAP_EXT = 31
 200 };
 201
 202 #ifndef _KERNEL
 203 /* Channel flags. */
 204 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
 205 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
 206 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
 207 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
 208 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
 209 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
 210 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
 211 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
 212 #endif /* !_KERNEL */
 213
 214 /* For IEEE80211_RADIOTAP_FLAGS */
 215 #define IEEE80211_RADIOTAP_F_CFP        0x01    /* sent/received
 216                                                  * during CFP
 217                                                  */
 218 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
 219                                                  * with short
 220                                                  * preamble
 221                                                  */
 222 #define IEEE80211_RADIOTAP_F_WEP        0x04    /* sent/received
 223                                                  * with WEP encryption
 224                                                  */
 225 #define IEEE80211_RADIOTAP_F_FRAG       0x08    /* sent/received
 226                                                  * with fragmentation
 227                                                  */
 228 #define IEEE80211_RADIOTAP_F_FCS        0x10    /* frame includes FCS */
 229 #define IEEE80211_RADIOTAP_F_DATAPAD    0x20    /* frame has padding between
 230                                                  * 802.11 header and payload
 231                                                  * (to 32-bit boundary)
 232                                                  */
 233 #define IEEE80211_RADIOTAP_F_BADFCS     0x40    /* does not pass FCS check */
 234
 235 /* For IEEE80211_RADIOTAP_RX_FLAGS */
 236 #define IEEE80211_RADIOTAP_F_RX_BADFCS 0x0001  /* Frame failed CRC check.
 237                                                 *
 238                                                 * Deprecated: use the flag
 239                                                 * IEEE80211_RADIOTAP_F_BADFCS in
 240                                                 * the IEEE80211_RADIOTAP_FLAGS
 241                                                 * field, instead.
 242                                                 */
 243
 244 /* For IEEE80211_RADIOTAP_TX_FLAGS */
 245 #define IEEE80211_RADIOTAP_F_TX_FAIL   0x0001  /* failed due to excessive
 246                                                 * retries
 247                                                 */
 248 #define IEEE80211_RADIOTAP_F_TX_CTS    0x0002  /* used cts 'protection' */
 249 #define IEEE80211_RADIOTAP_F_TX_RTS    0x0004  /* used rts/cts handshake */
 250
 251 #endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */