Home | History | Annotate | Line # | Download | only in net80211
ieee80211_radiotap.h revision 1.3
      1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.1 2003/09/05 22:19:32 sam Exp $ */
      2 /* $NetBSD: ieee80211_radiotap.h,v 1.3 2003/11/16 09:02:42 dyoung 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 _NET_IF_IEEE80211RADIOTAP_H_
     33 #define _NET_IF_IEEE80211RADIOTAP_H_
     34 
     35 /* A generic radio capture format is desirable. There is one for
     36  * Linux, but it is neither rigidly defined (there were not even
     37  * units given for some fields) nor easily extensible.
     38  *
     39  * I suggest the following 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 #ifndef DLT_IEEE802_11_RADIO
     50 #define	DLT_IEEE802_11_RADIO	127	/* 802.11 plus WLAN header */
     51 #endif
     52 
     53 /* The radio capture header precedes the 802.11 header. */
     54 struct ieee80211_radiotap_header {
     55 	u_int8_t	it_version;	/* Version 0. Only increases
     56 					 * for drastic changes,
     57 					 * introduction of compatible
     58 					 * new fields does not count.
     59 					 */
     60 	u_int8_t	it_pad;
     61 	u_int16_t       it_len;         /* length of the whole
     62 					 * header in bytes, including
     63 					 * it_version, it_pad,
     64 					 * it_len, and data fields.
     65 					 */
     66 	u_int32_t       it_present;     /* A bitmap telling which
     67 					 * fields are present. Set bit 31
     68 					 * (0x80000000) to extend the
     69 					 * bitmap by another 32 bits.
     70 					 * Additional extensions are made
     71 					 * by setting bit 31.
     72 					 */
     73 } __attribute__((__packed__));
     74 
     75 /* Name                                 Data type       Units
     76  * ----                                 ---------       -----
     77  *
     78  * IEEE80211_RADIOTAP_TSFT              u_int64_t       microseconds
     79  *
     80  *      Value in microseconds of the MAC's 64-bit 802.11 Time
     81  *      Synchronization Function timer when the first bit of the
     82  *      MPDU arrived at the MAC. For received frames, only.
     83  *
     84  * IEEE80211_RADIOTAP_CHANNEL           2 x u_int16_t   MHz, bitmap
     85  *
     86  *      Tx/Rx frequency in MHz, followed by flags (see below).
     87  *
     88  * IEEE80211_RADIOTAP_FHSS              u_int16_t       see below
     89  *
     90  *      For frequency-hopping radios, the hop set (first byte)
     91  *      and pattern (second byte).
     92  *
     93  * IEEE80211_RADIOTAP_RATE              u_int16_t       500kb/s
     94  *
     95  *      Tx/Rx data rate
     96  *
     97  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      int8_t          decibel (dB)
     98  *
     99  *      RF signal power at the antenna, measured from a fixed,
    100  *      arbitrary reference point.
    101  *
    102  * IEEE80211_RADIOTAP_DB_ANTNOISE       int8_t          decibel (dB)
    103  *
    104  *      RF noise power at the antenna in decibels from an arbitrary,
    105  *      fixed reference point.
    106  *
    107  * IEEE80211_RADIOTAP_BARKER_CODE_LOCK  u_int16_t       unitless
    108  *
    109  *      Quality of Barker code lock. Unitless. Monotonically
    110  *      nondecreasing with "better" lock strength. Called "Signal
    111  *      Quality" in datasheets.  (Is there a standard way to measure
    112  *      this?)
    113  *
    114  * IEEE80211_RADIOTAP_TX_ATTENUATION    u_int16_t       unitless
    115  *
    116  *      Transmit power expressed as unitless distance from max
    117  *      power set at factory calibration.  0 is max power.
    118  *      Monotonically nondecreasing with lower power levels.
    119  *
    120  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t       decibels (dB)
    121  *
    122  *      Transmit power expressed as decibel distance from max power
    123  *      set at factory calibration.  0 is max power.  Monotonically
    124  *      nondecreasing with lower power levels.
    125  *
    126  * IEEE80211_RADIOTAP_DBM_TX_POWER      u_int16_t       decibels from
    127  *                                                      milliwatt (dBm)
    128  *
    129  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
    130  *      reference). This is the absolute power level measured at
    131  *      the antenna port.
    132  *
    133  * IEEE80211_RADIOTAP_FLAGS             u_int8_t        bitmap
    134  *
    135  *      Properties of transmitted and received frames. See flags
    136  *      defined below.
    137  *
    138  * IEEE80211_RADIOTAP_ANTENNA           u_int8_t        antenna index
    139  *
    140  *      Unitless indication of the Rx/Tx antenna for this packet.
    141  *      The first antenna is antenna 0.
    142  */
    143 enum ieee80211_radiotap_type {
    144 	IEEE80211_RADIOTAP_TSFT = 0,
    145 	IEEE80211_RADIOTAP_FLAGS = 1,
    146 	IEEE80211_RADIOTAP_RATE = 2,
    147 	IEEE80211_RADIOTAP_CHANNEL = 3,
    148 	IEEE80211_RADIOTAP_FHSS = 4,
    149 	IEEE80211_RADIOTAP_DB_ANTSIGNAL = 5,
    150 	IEEE80211_RADIOTAP_DB_ANTNOISE = 6,
    151 	IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
    152 	IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
    153 	IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
    154 	IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
    155 	IEEE80211_RADIOTAP_ANTENNA = 11,
    156 	IEEE80211_RADIOTAP_EXT = 31
    157 };
    158 
    159 /* For IEEE80211_RADIOTAP_FLAGS */
    160 #define	IEEE80211_RADIOTAP_F_CFP	0x01	/* sent/received
    161 						 * during CFP
    162 						 */
    163 #define	IEEE80211_RADIOTAP_F_SHORTPRE	0x02	/* sent/received
    164 						 * with short
    165 						 * preamble
    166 						 */
    167 #define	IEEE80211_RADIOTAP_F_WEP	0x04	/* sent/received
    168 						 * with WEP encryption
    169 						 */
    170 #define	IEEE80211_RADIOTAP_F_FRAG	0x08	/* sent/received
    171 						 * with fragmentation
    172 						 */
    173 
    174 #endif /* _NET_IF_IEEE80211RADIOTAP_H_ */
    175