epan/dissectors/packet-ieee80211-radiotap-defs.h

   1 /*-
   2  * Copyright (c) 2003, 2004 David Young.  All rights reserved.
   3  *
   4  * $Id$
   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  * 3. The name of David Young may not be used to endorse or promote
  15  *    products derived from this software without specific prior
  16  *    written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  21  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DAVID
  22  * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  24  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  29  * OF SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * Modifications to fit into the linux IEEE 802.11 stack,
  34  * Mike Kershaw (dragorn@kismetwireless.net)
  35  */
  36
  37 #ifndef IEEE80211RADIOTAP_H
  38 #define IEEE80211RADIOTAP_H
  39
  40 #include <glib.h>
  41
  42 /* Base version of the radiotap packet header data */
  43 #define PKTHDR_RADIOTAP_VERSION         0
  44
  45 /* A generic radio capture format is desirable. There is one for
  46  * Linux, but it is neither rigidly defined (there were not even
  47  * units given for some fields) nor easily extensible.
  48  *
  49  * I suggest the following extensible radio capture format. It is
  50  * based on a bitmap indicating which fields are present.
  51  *
  52  * I am trying to describe precisely what the application programmer
  53  * should expect in the following, and for that reason I tell the
  54  * units and origin of each measurement (where it applies), or else I
  55  * use sufficiently weaselly language ("is a monotonically nondecreasing
  56  * function of...") that I cannot set false expectations for lawyerly
  57  * readers.
  58  */
  59
  60 /* The radio capture header precedes the 802.11 header.
  61  * All data in the header is little endian on all platforms.
  62  */
  63 struct ieee80211_radiotap_header {
  64         guint8 it_version;      /* Version 0. Only increases
  65                                  * for drastic changes,
  66                                  * introduction of compatible
  67                                  * new fields does not count.
  68                                  */
  69         guint8 it_pad;
  70         guint16 it_len;         /* length of the whole
  71                                  * header in bytes, including
  72                                  * it_version, it_pad,
  73                                  * it_len, and data fields.
  74                                  */
  75         guint32 it_present;     /* A bitmap telling which
  76                                  * fields are present. Set bit 31
  77                                  * (0x80000000) to extend the
  78                                  * bitmap by another 32 bits.
  79                                  * Additional extensions are made
  80                                  * by setting bit 31.
  81                                  */
  82 };
  83
  84 /* Name                                 Data type    Units
  85  * ----                                 ---------    -----
  86  *
  87  * IEEE80211_RADIOTAP_TSFT              __le64       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 guint16   MHz, bitmap
  94  *
  95  *      Tx/Rx frequency in MHz, followed by flags (see below).
  96  *
  97  * IEEE80211_RADIOTAP_FHSS              guint16       see below
  98  *
  99  *      For frequency-hopping radios, the hop set (first byte)
 100  *      and pattern (second byte).
 101  *
 102  * IEEE80211_RADIOTAP_RATE              u8           500kb/s
 103  *
 104  *      Tx/Rx data rate
 105  *
 106  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     s8           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      s8           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      u8           decibel (dB)
 119  *
 120  *      RF signal power at the antenna, decibel difference from an
 121  *      arbitrary, fixed reference.
 122  *
 123  * IEEE80211_RADIOTAP_DB_ANTNOISE       u8           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      guint16       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    guint16       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 guint16       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      s8           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             u8           bitmap
 155  *
 156  *      Properties of transmitted and received frames. See flags
 157  *      defined below.
 158  *
 159  * IEEE80211_RADIOTAP_ANTENNA           u8           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          guint16       bitmap
 165  *
 166  *     Properties of received frames. See flags defined below.
 167  *
 168  * IEEE80211_RADIOTAP_TX_FLAGS          guint16       bitmap
 169  *
 170  *     Properties of transmitted frames. See flags defined below.
 171  *
 172  * IEEE80211_RADIOTAP_RTS_RETRIES       u8           data
 173  *
 174  *     Number of rts retries a transmitted frame used.
 175  *
 176  * IEEE80211_RADIOTAP_DATA_RETRIES      u8           data
 177  *
 178  *     Number of unicast retries a transmitted frame used.
 179  *
 180  * IEEE80211_RADIOTAP_MCS       u8, u8, u8              unitless
 181  *
 182  *     Contains a bitmap of known fields/flags, the flags, and
 183  *     the MCS index.
 184  *
 185  * IEEE80211_RADIOTAP_AMPDU_STATUS      u32, u16, u8, u8        unitlesss
 186  *
 187  *      Contains the AMPDU information for the subframe.
 188  */
 189 enum ieee80211_radiotap_type {
 190         IEEE80211_RADIOTAP_TSFT = 0,
 191         IEEE80211_RADIOTAP_FLAGS = 1,
 192         IEEE80211_RADIOTAP_RATE = 2,
 193         IEEE80211_RADIOTAP_CHANNEL = 3,
 194         IEEE80211_RADIOTAP_FHSS = 4,
 195         IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
 196         IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
 197         IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
 198         IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
 199         IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
 200         IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
 201         IEEE80211_RADIOTAP_ANTENNA = 11,
 202         IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
 203         IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
 204         IEEE80211_RADIOTAP_RX_FLAGS = 14,
 205         IEEE80211_RADIOTAP_TX_FLAGS = 15,
 206         IEEE80211_RADIOTAP_RTS_RETRIES = 16,
 207         IEEE80211_RADIOTAP_DATA_RETRIES = 17,
 208         IEEE80211_RADIOTAP_XCHANNEL = 18, /* Unofficial, used by FreeBSD */
 209         IEEE80211_RADIOTAP_MCS = 19,
 210         IEEE80211_RADIOTAP_AMPDU_STATUS = 20,
 211         IEEE80211_RADIOTAP_VHT = 21,
 212
 213         /* valid in every it_present bitmap, even vendor namespaces */
 214         IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29,
 215         IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30,
 216         IEEE80211_RADIOTAP_EXT = 31
 217 };
 218
 219 /* not (yet) defined Radiotap present flag */
 220 /* Bit 22 to 28 are not defined (in binary : 0001 1111 1100 0000 0000 0000 0000 0000 */
 221 #define IEEE80211_RADIOTAP_NOTDEFINED 0x1FC00000
 222
 223 /* Channel flags. */
 224 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
 225 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
 226 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
 227 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
 228 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
 229 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
 230 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
 231 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
 232
 233 /* For IEEE80211_RADIOTAP_FLAGS */
 234 #define IEEE80211_RADIOTAP_F_CFP        0x01    /* sent/received
 235                                                  * during CFP
 236                                                  */
 237 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
 238                                                  * with short
 239                                                  * preamble
 240                                                  */
 241 #define IEEE80211_RADIOTAP_F_WEP        0x04    /* sent/received
 242                                                  * with WEP encryption
 243                                                  */
 244 #define IEEE80211_RADIOTAP_F_FRAG       0x08    /* sent/received
 245                                                  * with fragmentation
 246                                                  */
 247 #define IEEE80211_RADIOTAP_F_FCS        0x10    /* frame includes FCS */
 248 #define IEEE80211_RADIOTAP_F_DATAPAD    0x20    /* frame has padding between
 249                                                  * 802.11 header and payload
 250                                                  * (to 32-bit boundary)
 251                                                  */
 252 #define IEEE80211_RADIOTAP_F_BADFCS     0x40    /* frame failed FCS check */
 253
 254 /* For IEEE80211_RADIOTAP_RX_FLAGS */
 255 #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002 /* bad PLCP */
 256
 257 /* For IEEE80211_RADIOTAP_TX_FLAGS */
 258 #define IEEE80211_RADIOTAP_F_TX_FAIL    0x0001  /* failed due to excessive
 259                                                  * retries */
 260 #define IEEE80211_RADIOTAP_F_TX_CTS     0x0002  /* used cts 'protection' */
 261 #define IEEE80211_RADIOTAP_F_TX_RTS     0x0004  /* used rts/cts handshake */
 262
 263
 264 /* For IEEE80211_RADIOTAP_MCS */
 265 #define IEEE80211_RADIOTAP_MCS_HAVE_BW          0x01
 266 #define IEEE80211_RADIOTAP_MCS_HAVE_MCS         0x02
 267 #define IEEE80211_RADIOTAP_MCS_HAVE_GI          0x04
 268 #define IEEE80211_RADIOTAP_MCS_HAVE_FMT         0x08
 269 #define IEEE80211_RADIOTAP_MCS_HAVE_FEC         0x10
 270 #define IEEE80211_RADIOTAP_MCS_HAVE_STBC        0x20
 271
 272 #define IEEE80211_RADIOTAP_MCS_BW_MASK          0x03
 273 #define         IEEE80211_RADIOTAP_MCS_BW_20    0
 274 #define         IEEE80211_RADIOTAP_MCS_BW_40    1
 275 #define         IEEE80211_RADIOTAP_MCS_BW_20L   2
 276 #define         IEEE80211_RADIOTAP_MCS_BW_20U   3
 277 #define IEEE80211_RADIOTAP_MCS_SGI              0x04
 278 #define IEEE80211_RADIOTAP_MCS_FMT_GF           0x08
 279 #define IEEE80211_RADIOTAP_MCS_FEC_LDPC         0x10
 280 #define IEEE80211_RADIOTAP_MCS_STBC             0x20
 281
 282
 283 /* For IEEE80211_RADIOTAP_AMPDU_STATUS */
 284 #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN         0x0001
 285 #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN             0x0002
 286 #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN             0x0004
 287 #define IEEE80211_RADIOTAP_AMPDU_IS_LAST                0x0008
 288 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR          0x0010
 289 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN        0x0020
 290
 291
 292 /* For IEEE80211_RADIOTAP_VHT */
 293 #define IEEE80211_RADIOTAP_VHT_HAVE_STBC        0x0001
 294 #define IEEE80211_RADIOTAP_VHT_HAVE_TXOP_PS     0x0002
 295 #define IEEE80211_RADIOTAP_VHT_HAVE_GI          0x0004
 296 #define IEEE80211_RADIOTAP_VHT_HAVE_SGI_NSYM_DA 0x0008
 297 #define IEEE80211_RADIOTAP_VHT_HAVE_LDPC_EXTRA  0x0010
 298 #define IEEE80211_RADIOTAP_VHT_HAVE_BF          0x0020
 299 #define IEEE80211_RADIOTAP_VHT_HAVE_BW          0x0040
 300 #define IEEE80211_RADIOTAP_VHT_HAVE_GID         0x0080
 301 #define IEEE80211_RADIOTAP_VHT_HAVE_PAID        0x0100
 302 #define IEEE80211_RADIOTAP_VHT_STBC             0x01
 303 #define IEEE80211_RADIOTAP_VHT_TXOP_PS          0x02
 304 #define IEEE80211_RADIOTAP_VHT_SGI              0x04
 305 #define IEEE80211_RADIOTAP_VHT_SGI_NSYM_DA      0x08
 306 #define IEEE80211_RADIOTAP_VHT_LDPC_EXTRA       0x10
 307 #define IEEE80211_RADIOTAP_VHT_BF               0x20
 308 #define IEEE80211_RADIOTAP_VHT_NSS              0x0f
 309 #define IEEE80211_RADIOTAP_VHT_MCS              0xf0
 310 #define IEEE80211_RADIOTAP_VHT_CODING_LDPC      0x01
 311
 312 #define IEEE80211_RADIOTAP_VHT_BW_20            IEEE80211_RADIOTAP_MCS_BW_20
 313 #define IEEE80211_RADIOTAP_VHT_BW_40            IEEE80211_RADIOTAP_MCS_BW_40
 314 #define IEEE80211_RADIOTAP_VHT_BW_20L           IEEE80211_RADIOTAP_MCS_BW_20L
 315 #define IEEE80211_RADIOTAP_VHT_BW_20U           IEEE80211_RADIOTAP_MCS_BW_20U
 316 #define IEEE80211_RADIOTAP_VHT_BW_80            4
 317 #define IEEE80211_RADIOTAP_VHT_BW_40L           5
 318 #define IEEE80211_RADIOTAP_VHT_BW_40U           6
 319 #define IEEE80211_RADIOTAP_VHT_BW_20LL          7
 320 #define IEEE80211_RADIOTAP_VHT_BW_20LU          8
 321 #define IEEE80211_RADIOTAP_VHT_BW_20UL          9
 322 #define IEEE80211_RADIOTAP_VHT_BW_20UU          10
 323 #define IEEE80211_RADIOTAP_VHT_BW_160           11
 324 #define IEEE80211_RADIOTAP_VHT_BW_80L           12
 325 #define IEEE80211_RADIOTAP_VHT_BW_80U           13
 326 #define IEEE80211_RADIOTAP_VHT_BW_40LL          14
 327 #define IEEE80211_RADIOTAP_VHT_BW_40LU          15
 328 #define IEEE80211_RADIOTAP_VHT_BW_40UL          16
 329 #define IEEE80211_RADIOTAP_VHT_BW_40UU          17
 330 #define IEEE80211_RADIOTAP_VHT_BW_20LLL         18
 331 #define IEEE80211_RADIOTAP_VHT_BW_20LLU         19
 332 #define IEEE80211_RADIOTAP_VHT_BW_20LUL         20
 333 #define IEEE80211_RADIOTAP_VHT_BW_20LUU         21
 334 #define IEEE80211_RADIOTAP_VHT_BW_20ULL         22
 335 #define IEEE80211_RADIOTAP_VHT_BW_20ULU         23
 336 #define IEEE80211_RADIOTAP_VHT_BW_20UUL         24
 337 #define IEEE80211_RADIOTAP_VHT_BW_20UUU         25
 338
 339
 340 #endif                          /* IEEE80211_RADIOTAP_H */