contrib/tcpdump/ieee802_11_radio.h

   1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.5 2005/01/22 20:12:05 sam Exp $ */
   2 /* NetBSD: ieee802_11_radio.h,v 1.2 2006/02/26 03:04:03 dyoung Exp  */
   3 /* $Header: /tcpdump/master/tcpdump/ieee802_11_radio.h,v 1.3 2007-08-29 02:31:44 mcr Exp $ */
   4
   5 /*-
   6  * Copyright (c) 2003, 2004 David Young.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. The name of David Young may not be used to endorse or promote
  17  *    products derived from this software without specific prior
  18  *    written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY
  21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DAVID
  24  * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  26  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  31  * OF SUCH DAMAGE.
  32  */
  33 #ifndef _NET_IF_IEEE80211RADIOTAP_H_
  34 #define _NET_IF_IEEE80211RADIOTAP_H_
  35
  36 /* A generic radio capture format is desirable. It must be
  37  * rigidly defined (e.g., units for fields should be given),
  38  * and easily extensible.
  39  *
  40  * The following is an extensible radio capture format. It is
  41  * based on a bitmap indicating which fields are present.
  42  *
  43  * I am trying to describe precisely what the application programmer
  44  * should expect in the following, and for that reason I tell the
  45  * units and origin of each measurement (where it applies), or else I
  46  * use sufficiently weaselly language ("is a monotonically nondecreasing
  47  * function of...") that I cannot set false expectations for lawyerly
  48  * readers.
  49  */
  50
  51 /*
  52  * The radio capture header precedes the 802.11 header.
  53  *
  54  * Note well: all radiotap fields are little-endian.
  55  */
  56 struct ieee80211_radiotap_header {
  57         u_int8_t        it_version;     /* Version 0. Only increases
  58                                          * for drastic changes,
  59                                          * introduction of compatible
  60                                          * new fields does not count.
  61                                          */
  62         u_int8_t        it_pad;
  63         u_int16_t       it_len;         /* length of the whole
  64                                          * header in bytes, including
  65                                          * it_version, it_pad,
  66                                          * it_len, and data fields.
  67                                          */
  68         u_int32_t       it_present;     /* A bitmap telling which
  69                                          * fields are present. Set bit 31
  70                                          * (0x80000000) to extend the
  71                                          * bitmap by another 32 bits.
  72                                          * Additional extensions are made
  73                                          * by setting bit 31.
  74                                          */
  75 };
  76
  77 /* Name                                 Data type       Units
  78  * ----                                 ---------       -----
  79  *
  80  * IEEE80211_RADIOTAP_TSFT              u_int64_t       microseconds
  81  *
  82  *      Value in microseconds of the MAC's 64-bit 802.11 Time
  83  *      Synchronization Function timer when the first bit of the
  84  *      MPDU arrived at the MAC. For received frames, only.
  85  *
  86  * IEEE80211_RADIOTAP_CHANNEL           2 x u_int16_t   MHz, bitmap
  87  *
  88  *      Tx/Rx frequency in MHz, followed by flags (see below).
  89  *      Note that IEEE80211_RADIOTAP_XCHANNEL must be used to
  90  *      represent an HT channel as there is not enough room in
  91  *      the flags word.
  92  *
  93  * IEEE80211_RADIOTAP_FHSS              u_int16_t       see below
  94  *
  95  *      For frequency-hopping radios, the hop set (first byte)
  96  *      and pattern (second byte).
  97  *
  98  * IEEE80211_RADIOTAP_RATE              u_int8_t        500kb/s or index
  99  *
 100  *      Tx/Rx data rate.  If bit 0x80 is set then it represents an
 101  *      an MCS index and not an IEEE rate.
 102  *
 103  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     int8_t          decibels from
 104  *                                                      one milliwatt (dBm)
 105  *
 106  *      RF signal power at the antenna, decibel difference from
 107  *      one milliwatt.
 108  *
 109  * IEEE80211_RADIOTAP_DBM_ANTNOISE      int8_t          decibels from
 110  *                                                      one milliwatt (dBm)
 111  *
 112  *      RF noise power at the antenna, decibel difference from one
 113  *      milliwatt.
 114  *
 115  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      u_int8_t        decibel (dB)
 116  *
 117  *      RF signal power at the antenna, decibel difference from an
 118  *      arbitrary, fixed reference.
 119  *
 120  * IEEE80211_RADIOTAP_DB_ANTNOISE       u_int8_t        decibel (dB)
 121  *
 122  *      RF noise power at the antenna, decibel difference from an
 123  *      arbitrary, fixed reference point.
 124  *
 125  * IEEE80211_RADIOTAP_LOCK_QUALITY      u_int16_t       unitless
 126  *
 127  *      Quality of Barker code lock. Unitless. Monotonically
 128  *      nondecreasing with "better" lock strength. Called "Signal
 129  *      Quality" in datasheets.  (Is there a standard way to measure
 130  *      this?)
 131  *
 132  * IEEE80211_RADIOTAP_TX_ATTENUATION    u_int16_t       unitless
 133  *
 134  *      Transmit power expressed as unitless distance from max
 135  *      power set at factory calibration.  0 is max power.
 136  *      Monotonically nondecreasing with lower power levels.
 137  *
 138  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t       decibels (dB)
 139  *
 140  *      Transmit power expressed as decibel distance from max power
 141  *      set at factory calibration.  0 is max power.  Monotonically
 142  *      nondecreasing with lower power levels.
 143  *
 144  * IEEE80211_RADIOTAP_DBM_TX_POWER      int8_t          decibels from
 145  *                                                      one milliwatt (dBm)
 146  *
 147  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
 148  *      reference). This is the absolute power level measured at
 149  *      the antenna port.
 150  *
 151  * IEEE80211_RADIOTAP_FLAGS             u_int8_t        bitmap
 152  *
 153  *      Properties of transmitted and received frames. See flags
 154  *      defined below.
 155  *
 156  * IEEE80211_RADIOTAP_ANTENNA           u_int8_t        antenna index
 157  *
 158  *      Unitless indication of the Rx/Tx antenna for this packet.
 159  *      The first antenna is antenna 0.
 160  *
 161  * IEEE80211_RADIOTAP_RX_FLAGS          u_int16_t       bitmap
 162  *
 163  *     Properties of received frames. See flags defined below.
 164  *
 165  * IEEE80211_RADIOTAP_XCHANNEL          u_int32_t       bitmap
 166  *                                      u_int16_t       MHz
 167  *                                      u_int8_t        channel number
 168  *                                      u_int8_t        .5 dBm
 169  *
 170  *      Extended channel specification: flags (see below) followed by
 171  *      frequency in MHz, the corresponding IEEE channel number, and
 172  *      finally the maximum regulatory transmit power cap in .5 dBm
 173  *      units.  This property supersedes IEEE80211_RADIOTAP_CHANNEL
 174  *      and only one of the two should be present.
 175  *
 176  * IEEE80211_RADIOTAP_MCS               u_int8_t        known
 177  *                                      u_int8_t        flags
 178  *                                      u_int8_t        mcs
 179  *
 180  *      Bitset indicating which fields have known values, followed
 181  *      by bitset of flag values, followed by the MCS rate index as
 182  *      in IEEE 802.11n.
 183  *
 184  * IEEE80211_RADIOTAP_VENDOR_NAMESPACE
 185  *                                      u_int8_t  OUI[3]
 186  *                                   u_int8_t  subspace
 187  *                                   u_int16_t length
 188  *
 189  *     The Vendor Namespace Field contains three sub-fields. The first
 190  *     sub-field is 3 bytes long. It contains the vendor's IEEE 802
 191  *     Organizationally Unique Identifier (OUI). The fourth byte is a
 192  *     vendor-specific "namespace selector."
 193  *
 194  */
 195 enum ieee80211_radiotap_type {
 196         IEEE80211_RADIOTAP_TSFT = 0,
 197         IEEE80211_RADIOTAP_FLAGS = 1,
 198         IEEE80211_RADIOTAP_RATE = 2,
 199         IEEE80211_RADIOTAP_CHANNEL = 3,
 200         IEEE80211_RADIOTAP_FHSS = 4,
 201         IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
 202         IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
 203         IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
 204         IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
 205         IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
 206         IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
 207         IEEE80211_RADIOTAP_ANTENNA = 11,
 208         IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
 209         IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
 210         IEEE80211_RADIOTAP_RX_FLAGS = 14,
 211         /* NB: gap for netbsd definitions */
 212         IEEE80211_RADIOTAP_XCHANNEL = 18,
 213         IEEE80211_RADIOTAP_MCS = 19,
 214         IEEE80211_RADIOTAP_NAMESPACE = 29,
 215         IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30,
 216         IEEE80211_RADIOTAP_EXT = 31
 217 };
 218
 219 /* channel attributes */
 220 #define IEEE80211_CHAN_TURBO    0x00010 /* Turbo channel */
 221 #define IEEE80211_CHAN_CCK      0x00020 /* CCK channel */
 222 #define IEEE80211_CHAN_OFDM     0x00040 /* OFDM channel */
 223 #define IEEE80211_CHAN_2GHZ     0x00080 /* 2 GHz spectrum channel. */
 224 #define IEEE80211_CHAN_5GHZ     0x00100 /* 5 GHz spectrum channel */
 225 #define IEEE80211_CHAN_PASSIVE  0x00200 /* Only passive scan allowed */
 226 #define IEEE80211_CHAN_DYN      0x00400 /* Dynamic CCK-OFDM channel */
 227 #define IEEE80211_CHAN_GFSK     0x00800 /* GFSK channel (FHSS PHY) */
 228 #define IEEE80211_CHAN_GSM      0x01000 /* 900 MHz spectrum channel */
 229 #define IEEE80211_CHAN_STURBO   0x02000 /* 11a static turbo channel only */
 230 #define IEEE80211_CHAN_HALF     0x04000 /* Half rate channel */
 231 #define IEEE80211_CHAN_QUARTER  0x08000 /* Quarter rate channel */
 232 #define IEEE80211_CHAN_HT20     0x10000 /* HT 20 channel */
 233 #define IEEE80211_CHAN_HT40U    0x20000 /* HT 40 channel w/ ext above */
 234 #define IEEE80211_CHAN_HT40D    0x40000 /* HT 40 channel w/ ext below */
 235
 236 /* Useful combinations of channel characteristics, borrowed from Ethereal */
 237 #define IEEE80211_CHAN_A \
 238         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
 239 #define IEEE80211_CHAN_B \
 240         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
 241 #define IEEE80211_CHAN_G \
 242         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
 243 #define IEEE80211_CHAN_TA \
 244         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
 245 #define IEEE80211_CHAN_TG \
 246         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN  | IEEE80211_CHAN_TURBO)
 247
 248
 249 /* For IEEE80211_RADIOTAP_FLAGS */
 250 #define IEEE80211_RADIOTAP_F_CFP        0x01    /* sent/received
 251                                                  * during CFP
 252                                                  */
 253 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
 254                                                  * with short
 255                                                  * preamble
 256                                                  */
 257 #define IEEE80211_RADIOTAP_F_WEP        0x04    /* sent/received
 258                                                  * with WEP encryption
 259                                                  */
 260 #define IEEE80211_RADIOTAP_F_FRAG       0x08    /* sent/received
 261                                                  * with fragmentation
 262                                                  */
 263 #define IEEE80211_RADIOTAP_F_FCS        0x10    /* frame includes FCS */
 264 #define IEEE80211_RADIOTAP_F_DATAPAD    0x20    /* frame has padding between
 265                                                  * 802.11 header and payload
 266                                                  * (to 32-bit boundary)
 267                                                  */
 268 #define IEEE80211_RADIOTAP_F_BADFCS     0x40    /* does not pass FCS check */
 269
 270 /* For IEEE80211_RADIOTAP_RX_FLAGS */
 271 #define IEEE80211_RADIOTAP_F_RX_BADFCS  0x0001  /* frame failed crc check */
 272 #define IEEE80211_RADIOTAP_F_RX_PLCP_CRC        0x0002  /* frame failed PLCP CRC check */
 273
 274 /* For IEEE80211_RADIOTAP_MCS known */
 275 #define IEEE80211_RADIOTAP_MCS_BANDWIDTH_KNOWN          0x01
 276 #define IEEE80211_RADIOTAP_MCS_MCS_INDEX_KNOWN          0x02    /* MCS index field */
 277 #define IEEE80211_RADIOTAP_MCS_GUARD_INTERVAL_KNOWN     0x04
 278 #define IEEE80211_RADIOTAP_MCS_HT_FORMAT_KNOWN          0x08
 279 #define IEEE80211_RADIOTAP_MCS_FEC_TYPE_KNOWN           0x10
 280
 281 /* For IEEE80211_RADIOTAP_MCS flags */
 282 #define IEEE80211_RADIOTAP_MCS_BANDWIDTH_MASK   0x03
 283 #define IEEE80211_RADIOTAP_MCS_BANDWIDTH_20     0
 284 #define IEEE80211_RADIOTAP_MCS_BANDWIDTH_40     1
 285 #define IEEE80211_RADIOTAP_MCS_BANDWIDTH_20L    2
 286 #define IEEE80211_RADIOTAP_MCS_BANDWIDTH_20U    3
 287 #define IEEE80211_RADIOTAP_MCS_SHORT_GI         0x04 /* short guard interval */
 288 #define IEEE80211_RADIOTAP_MCS_HT_GREENFIELD    0x08
 289 #define IEEE80211_RADIOTAP_MCS_FEC_LDPC         0x10
 290
 291 #endif /* _NET_IF_IEEE80211RADIOTAP_H_ */