ieee802_11_radio.h revision 190207
1/* $FreeBSD: head/contrib/tcpdump/ieee802_11_radio.h 190207 2009-03-21 18:30:25Z rpaulo $ */ 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. There is one for 37 * Linux, but it is neither rigidly defined (there were not even 38 * units given for some fields) nor easily extensible. 39 * 40 * I suggest the following 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#if defined(__KERNEL__) || defined(_KERNEL) 51#ifndef DLT_IEEE802_11_RADIO 52#define DLT_IEEE802_11_RADIO 127 /* 802.11 plus WLAN header */ 53#endif 54#endif /* defined(__KERNEL__) || defined(_KERNEL) */ 55 56/* 57 * The radio capture header precedes the 802.11 header. 58 * 59 * Note well: all radiotap fields are little-endian. 60 */ 61struct ieee80211_radiotap_header { 62 u_int8_t it_version; /* Version 0. Only increases 63 * for drastic changes, 64 * introduction of compatible 65 * new fields does not count. 66 */ 67 u_int8_t it_pad; 68 u_int16_t it_len; /* length of the whole 69 * header in bytes, including 70 * it_version, it_pad, 71 * it_len, and data fields. 72 */ 73 u_int32_t it_present; /* A bitmap telling which 74 * fields are present. Set bit 31 75 * (0x80000000) to extend the 76 * bitmap by another 32 bits. 77 * Additional extensions are made 78 * by setting bit 31. 79 */ 80} __attribute__((__packed__)); 81 82/* Name Data type Units 83 * ---- --------- ----- 84 * 85 * IEEE80211_RADIOTAP_TSFT u_int64_t microseconds 86 * 87 * Value in microseconds of the MAC's 64-bit 802.11 Time 88 * Synchronization Function timer when the first bit of the 89 * MPDU arrived at the MAC. For received frames, only. 90 * 91 * IEEE80211_RADIOTAP_CHANNEL 2 x u_int16_t MHz, bitmap 92 * 93 * Tx/Rx frequency in MHz, followed by flags (see below). 94 * Note that IEEE80211_RADIOTAP_XCHANNEL must be used to 95 * represent an HT channel as there is not enough room in 96 * the flags word. 97 * 98 * IEEE80211_RADIOTAP_FHSS u_int16_t see below 99 * 100 * For frequency-hopping radios, the hop set (first byte) 101 * and pattern (second byte). 102 * 103 * IEEE80211_RADIOTAP_RATE u_int8_t 500kb/s or index 104 * 105 * Tx/Rx data rate. If bit 0x80 is set then it represents an 106 * an MCS index and not an IEEE rate. 107 * 108 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from 109 * one milliwatt (dBm) 110 * 111 * RF signal power at the antenna, decibel difference from 112 * one milliwatt. 113 * 114 * IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from 115 * one milliwatt (dBm) 116 * 117 * RF noise power at the antenna, decibel difference from one 118 * milliwatt. 119 * 120 * IEEE80211_RADIOTAP_DB_ANTSIGNAL u_int8_t decibel (dB) 121 * 122 * RF signal power at the antenna, decibel difference from an 123 * arbitrary, fixed reference. 124 * 125 * IEEE80211_RADIOTAP_DB_ANTNOISE u_int8_t decibel (dB) 126 * 127 * RF noise power at the antenna, decibel difference from an 128 * arbitrary, fixed reference point. 129 * 130 * IEEE80211_RADIOTAP_LOCK_QUALITY u_int16_t unitless 131 * 132 * Quality of Barker code lock. Unitless. Monotonically 133 * nondecreasing with "better" lock strength. Called "Signal 134 * Quality" in datasheets. (Is there a standard way to measure 135 * this?) 136 * 137 * IEEE80211_RADIOTAP_TX_ATTENUATION u_int16_t unitless 138 * 139 * Transmit power expressed as unitless distance from max 140 * power set at factory calibration. 0 is max power. 141 * Monotonically nondecreasing with lower power levels. 142 * 143 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t decibels (dB) 144 * 145 * Transmit power expressed as decibel distance from max power 146 * set at factory calibration. 0 is max power. Monotonically 147 * nondecreasing with lower power levels. 148 * 149 * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from 150 * one milliwatt (dBm) 151 * 152 * Transmit power expressed as dBm (decibels from a 1 milliwatt 153 * reference). This is the absolute power level measured at 154 * the antenna port. 155 * 156 * IEEE80211_RADIOTAP_FLAGS u_int8_t bitmap 157 * 158 * Properties of transmitted and received frames. See flags 159 * defined below. 160 * 161 * IEEE80211_RADIOTAP_ANTENNA u_int8_t antenna index 162 * 163 * Unitless indication of the Rx/Tx antenna for this packet. 164 * The first antenna is antenna 0. 165 * 166 * IEEE80211_RADIOTAP_XCHANNEL u_int32_t bitmap 167 * u_int16_t MHz 168 * u_int8_t channel number 169 * u_int8_t .5 dBm 170 * 171 * Extended channel specification: flags (see below) followed by 172 * frequency in MHz, the corresponding IEEE channel number, and 173 * finally the maximum regulatory transmit power cap in .5 dBm 174 * units. This property supersedes IEEE80211_RADIOTAP_CHANNEL 175 * and only one of the two should be present. 176 * 177 * IEEE80211_RADIOTAP_FCS u_int32_t data 178 * 179 * FCS from frame in network byte order. 180 */ 181enum ieee80211_radiotap_type { 182 IEEE80211_RADIOTAP_TSFT = 0, 183 IEEE80211_RADIOTAP_FLAGS = 1, 184 IEEE80211_RADIOTAP_RATE = 2, 185 IEEE80211_RADIOTAP_CHANNEL = 3, 186 IEEE80211_RADIOTAP_FHSS = 4, 187 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 188 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 189 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 190 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 191 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 192 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 193 IEEE80211_RADIOTAP_ANTENNA = 11, 194 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 195 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 196 IEEE80211_RADIOTAP_XCHANNEL = 14, 197 IEEE80211_RADIOTAP_EXT = 31 198}; 199 200#ifndef _KERNEL 201/* Channel flags; some are used only with XCHANNEL */ 202#define IEEE80211_CHAN_TURBO 0x00010 /* Turbo channel */ 203#define IEEE80211_CHAN_CCK 0x00020 /* CCK channel */ 204#define IEEE80211_CHAN_OFDM 0x00040 /* OFDM channel */ 205#define IEEE80211_CHAN_2GHZ 0x00080 /* 2 GHz spectrum channel. */ 206#define IEEE80211_CHAN_5GHZ 0x00100 /* 5 GHz spectrum channel */ 207#define IEEE80211_CHAN_PASSIVE 0x00200 /* Only passive scan allowed */ 208#define IEEE80211_CHAN_DYN 0x00400 /* Dynamic CCK-OFDM channel */ 209#define IEEE80211_CHAN_GFSK 0x00800 /* GFSK channel (FHSS PHY) */ 210#define IEEE80211_CHAN_GSM 0x01000 /* 900 MHz spectrum channel */ 211#define IEEE80211_CHAN_STURBO 0x02000 /* 11a static turbo channel only */ 212#define IEEE80211_CHAN_HALF 0x04000 /* Half rate channel */ 213#define IEEE80211_CHAN_QUARTER 0x08000 /* Quarter rate channel */ 214#define IEEE80211_CHAN_HT20 0x10000 /* HT 20 channel */ 215#define IEEE80211_CHAN_HT40U 0x20000 /* HT 40 channel w/ ext above */ 216#define IEEE80211_CHAN_HT40D 0x40000 /* HT 40 channel w/ ext below */ 217#endif /* !_KERNEL */ 218 219/* For IEEE80211_RADIOTAP_FLAGS */ 220#define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 221 * during CFP 222 */ 223#define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 224 * with short 225 * preamble 226 */ 227#define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 228 * with WEP encryption 229 */ 230#define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 231 * with fragmentation 232 */ 233#define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 234#define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 235 * 802.11 header and payload 236 * (to 32-bit boundary) 237 */ 238#define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* does not pass FCS check */ 239 240#endif /* _NET_IF_IEEE80211RADIOTAP_H_ */ 241