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 ([email protected]) 33 */ 34 35 #ifndef IEEE80211RADIOTAP_H 36 #define IEEE80211RADIOTAP_H 37 38 #include <linux/if_ether.h> 39 #include <linux/kernel.h> 40 41 /* Base version of the radiotap packet header data */ 42 #define PKTHDR_RADIOTAP_VERSION 0 43 44 /* A generic radio capture format is desirable. There is one for 45 * Linux, but it is neither rigidly defined (there were not even 46 * units given for some fields) nor easily extensible. 47 * 48 * I suggest the following extensible radio capture format. It is 49 * based on a bitmap indicating which fields are present. 50 * 51 * I am trying to describe precisely what the application programmer 52 * should expect in the following, and for that reason I tell the 53 * units and origin of each measurement (where it applies), or else I 54 * use sufficiently weaselly language ("is a monotonically nondecreasing 55 * function of...") that I cannot set false expectations for lawyerly 56 * readers. 57 */ 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 u8 it_version; /* Version 0. Only increases 65 * for drastic changes, 66 * introduction of compatible 67 * new fields does not count. 68 */ 69 u8 it_pad; 70 __le16 it_len; /* length of the whole 71 * header in bytes, including 72 * it_version, it_pad, 73 * it_len, and data fields. 74 */ 75 __le32 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 } __attribute__((packed)); 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 __le16 MHz, bitmap 94 * 95 * Tx/Rx frequency in MHz, followed by flags (see below). 96 * 97 * IEEE80211_RADIOTAP_FHSS __le16 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 __le16 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 __le16 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 __le16 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 __le16 bitmap 165 * 166 * Properties of received frames. See flags defined below. 167 * 168 * IEEE80211_RADIOTAP_TX_FLAGS __le16 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 unitless 186 * 187 * Contains the AMPDU information for the subframe. 188 * 189 * IEEE80211_RADIOTAP_VHT u16, u8, u8, u8[4], u8, u8, u16 190 * 191 * Contains VHT information about this frame. 192 */ 193 enum ieee80211_radiotap_type { 194 IEEE80211_RADIOTAP_TSFT = 0, 195 IEEE80211_RADIOTAP_FLAGS = 1, 196 IEEE80211_RADIOTAP_RATE = 2, 197 IEEE80211_RADIOTAP_CHANNEL = 3, 198 IEEE80211_RADIOTAP_FHSS = 4, 199 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 200 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 201 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 202 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 203 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 204 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 205 IEEE80211_RADIOTAP_ANTENNA = 11, 206 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 207 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 208 IEEE80211_RADIOTAP_RX_FLAGS = 14, 209 IEEE80211_RADIOTAP_TX_FLAGS = 15, 210 IEEE80211_RADIOTAP_RTS_RETRIES = 16, 211 IEEE80211_RADIOTAP_DATA_RETRIES = 17, 212 213 IEEE80211_RADIOTAP_MCS = 19, 214 IEEE80211_RADIOTAP_AMPDU_STATUS = 20, 215 IEEE80211_RADIOTAP_VHT = 21, 216 217 /* valid in every it_present bitmap, even vendor namespaces */ 218 IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29, 219 IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30, 220 IEEE80211_RADIOTAP_EXT = 31 221 }; 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 /* bad FCS */ 253 254 /* For IEEE80211_RADIOTAP_RX_FLAGS */ 255 #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002 /* frame has 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 #define IEEE80211_RADIOTAP_F_TX_NOACK 0x0008 /* don't expect an ack */ 263 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 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 281 /* For IEEE80211_RADIOTAP_AMPDU_STATUS */ 282 #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001 283 #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002 284 #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004 285 #define IEEE80211_RADIOTAP_AMPDU_IS_LAST 0x0008 286 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR 0x0010 287 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020 288 289 /* For IEEE80211_RADIOTAP_VHT */ 290 #define IEEE80211_RADIOTAP_VHT_KNOWN_STBC 0x0001 291 #define IEEE80211_RADIOTAP_VHT_KNOWN_TXOP_PS_NA 0x0002 292 #define IEEE80211_RADIOTAP_VHT_KNOWN_GI 0x0004 293 #define IEEE80211_RADIOTAP_VHT_KNOWN_SGI_NSYM_DIS 0x0008 294 #define IEEE80211_RADIOTAP_VHT_KNOWN_LDPC_EXTRA_OFDM_SYM 0x0010 295 #define IEEE80211_RADIOTAP_VHT_KNOWN_BEAMFORMED 0x0020 296 #define IEEE80211_RADIOTAP_VHT_KNOWN_BANDWIDTH 0x0040 297 #define IEEE80211_RADIOTAP_VHT_KNOWN_GROUP_ID 0x0080 298 #define IEEE80211_RADIOTAP_VHT_KNOWN_PARTIAL_AID 0x0100 299 300 #define IEEE80211_RADIOTAP_VHT_FLAG_STBC 0x01 301 #define IEEE80211_RADIOTAP_VHT_FLAG_TXOP_PS_NA 0x02 302 #define IEEE80211_RADIOTAP_VHT_FLAG_SGI 0x04 303 #define IEEE80211_RADIOTAP_VHT_FLAG_SGI_NSYM_M10_9 0x08 304 #define IEEE80211_RADIOTAP_VHT_FLAG_LDPC_EXTRA_OFDM_SYM 0x10 305 #define IEEE80211_RADIOTAP_VHT_FLAG_BEAMFORMED 0x20 306 307 #endif /* IEEE80211_RADIOTAP_H */ 308