sys/netproto/802_11/wlan/ieee80211_radiotap.h

   1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.3 2004/04/05 22:13:21 sam Exp $ */
   2 /* $NetBSD: ieee80211_radiotap.h,v 1.3 2003/11/16 09:02:42 dyoung Exp $ */
   3 /* $DragonFly: src/sys/netproto/802_11/wlan/Attic/ieee80211_radiotap.h,v 1.1 2004/07/26 16:30:17 joerg 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
  34 #ifndef _NETPROTO_802_11_IEEE80211RADIOTAP_H_
  35 #define _NETPROTO_802_11_IEEE80211RADIOTAP_H_
  36
  37 /* A generic radio capture format is desirable. There is one for
  38  * Linux, but it is neither rigidly defined (there were not even
  39  * units given for some fields) nor easily extensible.
  40  *
  41  * I suggest the following extensible radio capture format. It is
  42  * based on a bitmap indicating which fields are present.
  43  *
  44  * I am trying to describe precisely what the application programmer
  45  * should expect in the following, and for that reason I tell the
  46  * units and origin of each measurement (where it applies), or else I
  47  * use sufficiently weaselly language ("is a monotonically nondecreasing
  48  * function of...") that I cannot set false expectations for lawyerly
  49  * readers.
  50  */
  51 #ifdef _KERNEL
  52 #ifndef DLT_IEEE802_11_RADIO
  53 #define DLT_IEEE802_11_RADIO    127     /* 802.11 plus WLAN header */
  54 #endif
  55 #endif /* _KERNEL */
  56
  57 /* The radio capture header precedes the 802.11 header. */
  58 struct ieee80211_radiotap_header {
  59         uint8_t         it_version;     /* Version 0. Only increases
  60                                          * for drastic changes,
  61                                          * introduction of compatible
  62                                          * new fields does not count.
  63                                          */
  64         uint8_t         it_pad;
  65         uint16_t        it_len;         /* length of the whole
  66                                          * header in bytes, including
  67                                          * it_version, it_pad,
  68                                          * it_len, and data fields.
  69                                          */
  70         uint32_t        it_present;     /* A bitmap telling which
  71                                          * fields are present. Set bit 31
  72                                          * (0x80000000) to extend the
  73                                          * bitmap by another 32 bits.
  74                                          * Additional extensions are made
  75                                          * by setting bit 31.
  76                                          */
  77 } __attribute__((__packed__));
  78
  79 /* Name                                 Data type       Units
  80  * ----                                 ---------       -----
  81  *
  82  * IEEE80211_RADIOTAP_TSFT              uint64_t        microseconds
  83  *
  84  *      Value in microseconds of the MAC's 64-bit 802.11 Time
  85  *      Synchronization Function timer when the first bit of the
  86  *      MPDU arrived at the MAC. For received frames, only.
  87  *
  88  * IEEE80211_RADIOTAP_CHANNEL           2 x uint16_t    MHz, bitmap
  89  *
  90  *      Tx/Rx frequency in MHz, followed by flags (see below).
  91  *
  92  * IEEE80211_RADIOTAP_FHSS              uint16_t        see below
  93  *
  94  *      For frequency-hopping radios, the hop set (first byte)
  95  *      and pattern (second byte).
  96  *
  97  * IEEE80211_RADIOTAP_RATE              uint8_t         500kb/s
  98  *
  99  *      Tx/Rx data rate
 100  *
 101  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     int8_t          decibels from
 102  *                                                      one milliwatt (dBm)
 103  *
 104  *      RF signal power at the antenna, decibel difference from
 105  *      one milliwatt.
 106  *
 107  * IEEE80211_RADIOTAP_DBM_ANTNOISE      int8_t          decibels from
 108  *                                                      one milliwatt (dBm)
 109  *
 110  *      RF noise power at the antenna, decibel difference from one
 111  *      milliwatt.
 112  *
 113  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      uint8_t         decibel (dB)
 114  *
 115  *      RF signal power at the antenna, decibel difference from an
 116  *      arbitrary, fixed reference.
 117  *
 118  * IEEE80211_RADIOTAP_DB_ANTNOISE       uint8_t         decibel (dB)
 119  *
 120  *      RF noise power at the antenna, decibel difference from an
 121  *      arbitrary, fixed reference point.
 122  *
 123  * IEEE80211_RADIOTAP_BARKER_CODE_LOCK  uint16_t        unitless
 124  *
 125  *      Quality of Barker code lock. Unitless. Monotonically
 126  *      nondecreasing with "better" lock strength. Called "Signal
 127  *      Quality" in datasheets.  (Is there a standard way to measure
 128  *      this?)
 129  *
 130  * IEEE80211_RADIOTAP_TX_ATTENUATION    uint16_t        unitless
 131  *
 132  *      Transmit power expressed as unitless distance from max
 133  *      power set at factory calibration.  0 is max power.
 134  *      Monotonically nondecreasing with lower power levels.
 135  *
 136  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t        decibels (dB)
 137  *
 138  *      Transmit power expressed as decibel distance from max power
 139  *      set at factory calibration.  0 is max power.  Monotonically
 140  *      nondecreasing with lower power levels.
 141  *
 142  * IEEE80211_RADIOTAP_DBM_TX_POWER      int8_t          decibels from
 143  *                                                      one milliwatt (dBm)
 144  *
 145  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
 146  *      reference). This is the absolute power level measured at
 147  *      the antenna port.
 148  *
 149  * IEEE80211_RADIOTAP_FLAGS             uint8_t         bitmap
 150  *
 151  *      Properties of transmitted and received frames. See flags
 152  *      defined below.
 153  *
 154  * IEEE80211_RADIOTAP_ANTENNA           uint8_t         antenna index
 155  *
 156  *      Unitless indication of the Rx/Tx antenna for this packet.
 157  *      The first antenna is antenna 0.
 158  *
 159  * IEEE80211_RADIOTAP_FCS               uint32_t        data
 160  *
 161  *      FCS from frame in network byte order.
 162  */
 163 enum ieee80211_radiotap_type {
 164         IEEE80211_RADIOTAP_TSFT = 0,
 165         IEEE80211_RADIOTAP_FLAGS = 1,
 166         IEEE80211_RADIOTAP_RATE = 2,
 167         IEEE80211_RADIOTAP_CHANNEL = 3,
 168         IEEE80211_RADIOTAP_FHSS = 4,
 169         IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
 170         IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
 171         IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
 172         IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
 173         IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
 174         IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
 175         IEEE80211_RADIOTAP_ANTENNA = 11,
 176         IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
 177         IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
 178         IEEE80211_RADIOTAP_FCS = 14,
 179         IEEE80211_RADIOTAP_EXT = 31,
 180 };
 181
 182 #ifndef _KERNEL
 183 /* Channel flags. */
 184 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
 185 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
 186 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
 187 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
 188 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
 189 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
 190 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
 191 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
 192 #endif /* !_KERNEL */
 193
 194 /* For IEEE80211_RADIOTAP_FLAGS */
 195 #define IEEE80211_RADIOTAP_F_CFP        0x01    /* sent/received
 196                                                  * during CFP
 197                                                  */
 198 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
 199                                                  * with short
 200                                                  * preamble
 201                                                  */
 202 #define IEEE80211_RADIOTAP_F_WEP        0x04    /* sent/received
 203                                                  * with WEP encryption
 204                                                  */
 205 #define IEEE80211_RADIOTAP_F_FRAG       0x08    /* sent/received
 206                                                  * with fragmentation
 207                                                  */
 208
 209 #endif /* _NETPROTO_802_11_IEEE80211RADIOTAP_H_ */