1 /*- 2 * Copyright (c) 2003, 2004 David Young. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. The name of David Young may not be used to endorse or promote 13 * products derived from this software without specific prior 14 * written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY 17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 18 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 19 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID 20 * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 21 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 22 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 27 * OF SUCH DAMAGE. 28 */ 29 30 /* 31 * Modifications to fit into the linux IEEE 802.11 stack, 32 * Mike Kershaw (dragorn@kismetwireless.net) 33 */ 34 35 #ifndef IEEE80211RADIOTAP_H 36 #define IEEE80211RADIOTAP_H 37 38 #include <stdint.h> 39 40 /* Base version of the radiotap packet header data */ 41 #define PKTHDR_RADIOTAP_VERSION 0 42 43 /* A generic radio capture format is desirable. There is one for 44 * Linux, but it is neither rigidly defined (there were not even 45 * units given for some fields) nor easily extensible. 46 * 47 * I suggest the following extensible radio capture format. It is 48 * based on a bitmap indicating which fields are present. 49 * 50 * I am trying to describe precisely what the application programmer 51 * should expect in the following, and for that reason I tell the 52 * units and origin of each measurement (where it applies), or else I 53 * use sufficiently weaselly language ("is a monotonically nondecreasing 54 * function of...") that I cannot set false expectations for lawyerly 55 * readers. 56 */ 57 58 /* The radio capture header precedes the 802.11 header. 59 * All data in the header is little endian on all platforms. 60 */ 61 struct ieee80211_radiotap_header { 62 uint8_t it_version; /* Version 0. Only increases 63 * for drastic changes, 64 * introduction of compatible 65 * new fields does not count. 66 */ 67 uint8_t it_pad; 68 le16 it_len; /* length of the whole 69 * header in bytes, including 70 * it_version, it_pad, 71 * it_len, and data fields. 72 */ 73 le32 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 }; 81 82 /* Name Data type Units 83 * ---- --------- ----- 84 * 85 * IEEE80211_RADIOTAP_TSFT __le64 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 uint16_t MHz, bitmap 92 * 93 * Tx/Rx frequency in MHz, followed by flags (see below). 94 * 95 * IEEE80211_RADIOTAP_FHSS uint16_t see below 96 * 97 * For frequency-hopping radios, the hop set (first byte) 98 * and pattern (second byte). 99 * 100 * IEEE80211_RADIOTAP_RATE u8 500kb/s 101 * 102 * Tx/Rx data rate 103 * 104 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL s8 decibels from 105 * one milliwatt (dBm) 106 * 107 * RF signal power at the antenna, decibel difference from 108 * one milliwatt. 109 * 110 * IEEE80211_RADIOTAP_DBM_ANTNOISE s8 decibels from 111 * one milliwatt (dBm) 112 * 113 * RF noise power at the antenna, decibel difference from one 114 * milliwatt. 115 * 116 * IEEE80211_RADIOTAP_DB_ANTSIGNAL u8 decibel (dB) 117 * 118 * RF signal power at the antenna, decibel difference from an 119 * arbitrary, fixed reference. 120 * 121 * IEEE80211_RADIOTAP_DB_ANTNOISE u8 decibel (dB) 122 * 123 * RF noise power at the antenna, decibel difference from an 124 * arbitrary, fixed reference point. 125 * 126 * IEEE80211_RADIOTAP_LOCK_QUALITY uint16_t unitless 127 * 128 * Quality of Barker code lock. Unitless. Monotonically 129 * nondecreasing with "better" lock strength. Called "Signal 130 * Quality" in datasheets. (Is there a standard way to measure 131 * this?) 132 * 133 * IEEE80211_RADIOTAP_TX_ATTENUATION uint16_t unitless 134 * 135 * Transmit power expressed as unitless distance from max 136 * power set at factory calibration. 0 is max power. 137 * Monotonically nondecreasing with lower power levels. 138 * 139 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t decibels (dB) 140 * 141 * Transmit power expressed as decibel distance from max power 142 * set at factory calibration. 0 is max power. Monotonically 143 * nondecreasing with lower power levels. 144 * 145 * IEEE80211_RADIOTAP_DBM_TX_POWER s8 decibels from 146 * one milliwatt (dBm) 147 * 148 * Transmit power expressed as dBm (decibels from a 1 milliwatt 149 * reference). This is the absolute power level measured at 150 * the antenna port. 151 * 152 * IEEE80211_RADIOTAP_FLAGS u8 bitmap 153 * 154 * Properties of transmitted and received frames. See flags 155 * defined below. 156 * 157 * IEEE80211_RADIOTAP_ANTENNA u8 antenna index 158 * 159 * Unitless indication of the Rx/Tx antenna for this packet. 160 * The first antenna is antenna 0. 161 * 162 * IEEE80211_RADIOTAP_RX_FLAGS uint16_t bitmap 163 * 164 * Properties of received frames. See flags defined below. 165 * 166 * IEEE80211_RADIOTAP_TX_FLAGS uint16_t bitmap 167 * 168 * Properties of transmitted frames. See flags defined below. 169 * 170 * IEEE80211_RADIOTAP_RTS_RETRIES u8 data 171 * 172 * Number of rts retries a transmitted frame used. 173 * 174 * IEEE80211_RADIOTAP_DATA_RETRIES u8 data 175 * 176 * Number of unicast retries a transmitted frame used. 177 * 178 * IEEE80211_RADIOTAP_MCS u8, u8, u8 unitless 179 * 180 * Contains a bitmap of known fields/flags, the flags, and 181 * the MCS index. 182 * 183 * IEEE80211_RADIOTAP_AMPDU_STATUS u32, u16, u8, u8 unitlesss 184 * 185 * Contains the AMPDU information for the subframe. 186 */ 187 enum ieee80211_radiotap_type { 188 IEEE80211_RADIOTAP_TSFT = 0, 189 IEEE80211_RADIOTAP_FLAGS = 1, 190 IEEE80211_RADIOTAP_RATE = 2, 191 IEEE80211_RADIOTAP_CHANNEL = 3, 192 IEEE80211_RADIOTAP_FHSS = 4, 193 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 194 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 195 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 196 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 197 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 198 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 199 IEEE80211_RADIOTAP_ANTENNA = 11, 200 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 201 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 202 IEEE80211_RADIOTAP_RX_FLAGS = 14, 203 IEEE80211_RADIOTAP_TX_FLAGS = 15, 204 IEEE80211_RADIOTAP_RTS_RETRIES = 16, 205 IEEE80211_RADIOTAP_DATA_RETRIES = 17, 206 207 IEEE80211_RADIOTAP_MCS = 19, 208 IEEE80211_RADIOTAP_AMPDU_STATUS = 20, 209 210 /* valid in every it_present bitmap, even vendor namespaces */ 211 IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29, 212 IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30, 213 IEEE80211_RADIOTAP_EXT = 31 214 }; 215 216 /* Channel flags. */ 217 #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */ 218 #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */ 219 #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */ 220 #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */ 221 #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */ 222 #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */ 223 #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */ 224 #define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */ 225 226 /* For IEEE80211_RADIOTAP_FLAGS */ 227 #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 228 * during CFP 229 */ 230 #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 231 * with short 232 * preamble 233 */ 234 #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 235 * with WEP encryption 236 */ 237 #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 238 * with fragmentation 239 */ 240 #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 241 #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 242 * 802.11 header and payload 243 * (to 32-bit boundary) 244 */ 245 #define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* frame failed FCS check */ 246 247 /* For IEEE80211_RADIOTAP_RX_FLAGS */ 248 #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002 /* bad PLCP */ 249 250 /* For IEEE80211_RADIOTAP_TX_FLAGS */ 251 #define IEEE80211_RADIOTAP_F_TX_FAIL 0x0001 /* failed due to excessive 252 * retries */ 253 #define IEEE80211_RADIOTAP_F_TX_CTS 0x0002 /* used cts 'protection' */ 254 #define IEEE80211_RADIOTAP_F_TX_RTS 0x0004 /* used rts/cts handshake */ 255 #define IEEE80211_RADIOTAP_F_TX_NOACK 0x0008 /* don't expect an ACK */ 256 257 /* For IEEE80211_RADIOTAP_AMPDU_STATUS */ 258 #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001 259 #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002 260 #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004 261 #define IEEE80211_RADIOTAP_AMPDU_IS_LAST 0x0008 262 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR 0x0010 263 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020 264 265 /* For IEEE80211_RADIOTAP_MCS */ 266 #define IEEE80211_RADIOTAP_MCS_HAVE_BW 0x01 267 #define IEEE80211_RADIOTAP_MCS_HAVE_MCS 0x02 268 #define IEEE80211_RADIOTAP_MCS_HAVE_GI 0x04 269 #define IEEE80211_RADIOTAP_MCS_HAVE_FMT 0x08 270 #define IEEE80211_RADIOTAP_MCS_HAVE_FEC 0x10 271 #define IEEE80211_RADIOTAP_MCS_HAVE_STBC 0x20 272 #define IEEE80211_RADIOTAP_MCS_HAVE_NESS 0x40 273 #define IEEE80211_RADIOTAP_MCS_NESS_BIT1 0x80 274 275 276 #define IEEE80211_RADIOTAP_MCS_BW_MASK 0x03 277 #define IEEE80211_RADIOTAP_MCS_BW_20 0 278 #define IEEE80211_RADIOTAP_MCS_BW_40 1 279 #define IEEE80211_RADIOTAP_MCS_BW_20L 2 280 #define IEEE80211_RADIOTAP_MCS_BW_20U 3 281 #define IEEE80211_RADIOTAP_MCS_SGI 0x04 282 #define IEEE80211_RADIOTAP_MCS_FMT_GF 0x08 283 #define IEEE80211_RADIOTAP_MCS_FEC_LDPC 0x10 284 #define IEEE80211_RADIOTAP_MCS_STBC_MASK 0x60 285 #define IEEE80211_RADIOTAP_MCS_STBC_SHIFT 5 286 #define IEEE80211_RADIOTAP_MCS_STBC_1 1 287 #define IEEE80211_RADIOTAP_MCS_STBC_2 2 288 #define IEEE80211_RADIOTAP_MCS_STBC_3 3 289 #define IEEE80211_RADIOTAP_MCS_NESS_BIT0 0x80 290 291 #endif /* IEEE80211_RADIOTAP_H */ 292