1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.11 2007/12/13 01:23:40 sam Exp $ */ 2 /* $NetBSD: ieee80211_radiotap.h,v 1.16 2007/01/06 05:51:15 dyoung Exp $ */ 3 /* FILE-CSTYLED */ 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 /* 35 * <<Broadcom-WL-IPTag/Open:>> 36 */ 37 38 #ifndef _NET80211_IEEE80211_RADIOTAP_H_ 39 #define _NET80211_IEEE80211_RADIOTAP_H_ 40 41 /* A generic radio capture format is desirable. It must be 42 * rigidly defined (e.g., units for fields should be given), 43 * and easily extensible. 44 * 45 * The following is an extensible radio capture format. It is 46 * based on a bitmap indicating which fields are present. 47 * 48 * I am trying to describe precisely what the application programmer 49 * should expect in the following, and for that reason I tell the 50 * units and origin of each measurement (where it applies), or else I 51 * use sufficiently weaselly language ("is a monotonically nondecreasing 52 * function of...") that I cannot set false expectations for lawyerly 53 * readers. 54 */ 55 #if defined(__KERNEL__) || defined(_KERNEL) 56 #ifndef DLT_IEEE802_11_RADIO 57 #define DLT_IEEE802_11_RADIO 127 /* 802.11 plus WLAN header */ 58 #endif 59 #endif /* defined(__KERNEL__) || defined(_KERNEL) */ 60 61 #define IEEE80211_RADIOTAP_HDRLEN 64 /* deprecated */ 62 63 /* This marks the start of a packed structure section. */ 64 #include <packed_section_start.h> 65 66 /* 67 * The radio capture header precedes the 802.11 header. 68 * 69 * Note well: all radiotap fields are little-endian. 70 */ 71 BWL_PRE_PACKED_STRUCT struct ieee80211_radiotap_header { 72 uint8 it_version; /* Version 0. Only increases 73 * for drastic changes, 74 * introduction of compatible 75 * new fields does not count. 76 */ 77 uint8 it_pad; 78 uint16 it_len; /* length of the whole 79 * header in bytes, including 80 * it_version, it_pad, 81 * it_len, and data fields. 82 */ 83 uint32 it_present; /* A bitmap telling which 84 * fields are present. Set bit 31 85 * (0x80000000) to extend the 86 * bitmap by another 32 bits. 87 * Additional extensions are made 88 * by setting bit 31. 89 */ 90 } BWL_POST_PACKED_STRUCT; 91 92 /* This marks the end of a packed structure section. */ 93 #include <packed_section_end.h> 94 95 /* 96 * Name Data type Units 97 * ---- --------- ----- 98 * 99 * IEEE80211_RADIOTAP_TSFT uint64_t microseconds 100 * 101 * Value in microseconds of the MAC's 64-bit 802.11 Time 102 * Synchronization Function timer when the first bit of the 103 * MPDU arrived at the MAC. For received frames, only. 104 * 105 * IEEE80211_RADIOTAP_CHANNEL 2 x uint16_t MHz, bitmap 106 * 107 * Tx/Rx frequency in MHz, followed by flags (see below). 108 * 109 * IEEE80211_RADIOTAP_FHSS uint16_t see below 110 * 111 * For frequency-hopping radios, the hop set (first byte) 112 * and pattern (second byte). 113 * 114 * IEEE80211_RADIOTAP_RATE uint8_t 500kb/s or index 115 * 116 * Tx/Rx data rate. If bit 0x80 is set then it represents an 117 * an MCS index and not an IEEE rate. 118 * 119 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from 120 * one milliwatt (dBm) 121 * 122 * RF signal power at the antenna, decibel difference from 123 * one milliwatt. 124 * 125 * IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from 126 * one milliwatt (dBm) 127 * 128 * RF noise power at the antenna, decibel difference from one 129 * milliwatt. 130 * 131 * IEEE80211_RADIOTAP_DB_ANTSIGNAL uint8_t decibel (dB) 132 * 133 * RF signal power at the antenna, decibel difference from an 134 * arbitrary, fixed reference. 135 * 136 * IEEE80211_RADIOTAP_DB_ANTNOISE uint8_t decibel (dB) 137 * 138 * RF noise power at the antenna, decibel difference from an 139 * arbitrary, fixed reference point. 140 * 141 * IEEE80211_RADIOTAP_TXFLAGS uint16_t txflags 142 * Properties of Transmitted frames 143 * 144 * IEEE80211_RADIOTAP_RETRIES uint8_t retries 145 * Number of retries 146 * 147 * IEEE80211_RADIOTAP_LOCK_QUALITY uint16_t unitless 148 * 149 * Quality of Barker code lock. Unitless. Monotonically 150 * nondecreasing with "better" lock strength. Called "Signal 151 * Quality" in datasheets. (Is there a standard way to measure 152 * this?) 153 * 154 * IEEE80211_RADIOTAP_TX_ATTENUATION uint16_t unitless 155 * 156 * Transmit power expressed as unitless distance from max 157 * power set at factory calibration. 0 is max power. 158 * Monotonically nondecreasing with lower power levels. 159 * 160 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t decibels (dB) 161 * 162 * Transmit power expressed as decibel distance from max power 163 * set at factory calibration. 0 is max power. Monotonically 164 * nondecreasing with lower power levels. 165 * 166 * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from 167 * one milliwatt (dBm) 168 * 169 * Transmit power expressed as dBm (decibels from a 1 milliwatt 170 * reference). This is the absolute power level measured at 171 * the antenna port. 172 * 173 * IEEE80211_RADIOTAP_FLAGS uint8_t bitmap 174 * 175 * Properties of transmitted and received frames. See flags 176 * defined below. 177 * 178 * IEEE80211_RADIOTAP_ANTENNA uint8_t antenna index 179 * 180 * Unitless indication of the Rx/Tx antenna for this packet. 181 * The first antenna is antenna 0. 182 * 183 * IEEE80211_RADIOTAP_XCHANNEL uint32_t bitmap 184 * uint16_t MHz 185 * uint8_t channel number 186 * int8_t .5 dBm 187 * 188 * Extended channel specification: flags (see below) followed by 189 * frequency in MHz, the corresponding IEEE channel number, and 190 * finally the maximum regulatory transmit power cap in .5 dBm 191 * units. This property supersedes IEEE80211_RADIOTAP_CHANNEL 192 * and only one of the two should be present. 193 * 194 * IEEE80211_RADIOTAP_MCS u8, u8, u8 unitless 195 * 196 * Contains a bitmap of known fields/flags, the flags, and 197 * the MCS index. 198 * 199 */ 200 enum ieee80211_radiotap_type { 201 IEEE80211_RADIOTAP_TSFT = 0, 202 IEEE80211_RADIOTAP_FLAGS = 1, 203 IEEE80211_RADIOTAP_RATE = 2, 204 IEEE80211_RADIOTAP_CHANNEL = 3, 205 IEEE80211_RADIOTAP_FHSS = 4, 206 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 207 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 208 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 209 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 210 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 211 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 212 IEEE80211_RADIOTAP_ANTENNA = 11, 213 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 214 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 215 /* NB: gap for netbsd definitions */ 216 IEEE80211_RADIOTAP_TXFLAGS = 15, 217 IEEE80211_RADIOTAP_RETRIES = 17, 218 IEEE80211_RADIOTAP_XCHANNEL = 18, 219 IEEE80211_RADIOTAP_MCS = 19, 220 IEEE80211_RADIOTAP_AMPDU = 20, 221 IEEE80211_RADIOTAP_VHT = 21, 222 IEEE80211_RADIOTAP_HE = 23, 223 IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29, 224 IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30, 225 IEEE80211_RADIOTAP_EXT = 31, 226 227 }; 228 229 #ifndef _KERNEL 230 /* channel attributes */ 231 #define IEEE80211_CHAN_TURBO 0x00000010 /* Turbo channel */ 232 #define IEEE80211_CHAN_CCK 0x00000020 /* CCK channel */ 233 #define IEEE80211_CHAN_OFDM 0x00000040 /* OFDM channel */ 234 #define IEEE80211_CHAN_2GHZ 0x00000080 /* 2 GHz spectrum channel. */ 235 #define IEEE80211_CHAN_5GHZ 0x00000100 /* 5 GHz spectrum channel */ 236 #define IEEE80211_CHAN_PASSIVE 0x00000200 /* Only passive scan allowed */ 237 #define IEEE80211_CHAN_DYN 0x00000400 /* Dynamic CCK-OFDM channel */ 238 #define IEEE80211_CHAN_GFSK 0x00000800 /* GFSK channel (FHSS PHY) */ 239 #define IEEE80211_CHAN_GSM 0x00001000 /* 900 MHz spectrum channel */ 240 #define IEEE80211_CHAN_STURBO 0x00002000 /* 11a static turbo channel only */ 241 #define IEEE80211_CHAN_HALF 0x00004000 /* Half rate channel */ 242 #define IEEE80211_CHAN_QUARTER 0x00008000 /* Quarter rate channel */ 243 #define IEEE80211_CHAN_HT20 0x00010000 /* HT 20 channel */ 244 #define IEEE80211_CHAN_HT40U 0x00020000 /* HT 40 channel w/ ext above */ 245 #define IEEE80211_CHAN_HT40D 0x00040000 /* HT 40 channel w/ ext below */ 246 #endif /* !_KERNEL */ 247 248 /* For IEEE80211_RADIOTAP_FLAGS */ 249 #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 250 * during CFP 251 */ 252 #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 253 * with short 254 * preamble 255 */ 256 #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 257 * with WEP encryption 258 */ 259 #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 260 * with fragmentation 261 */ 262 #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 263 #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 264 * 802.11 header and payload 265 * (to 32-bit boundary) 266 */ 267 #define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* does not pass FCS check */ 268 269 /* For IEEE80211_RADIOTAP_MCS */ 270 #define IEEE80211_RADIOTAP_MCS_HAVE_BW 0x01 271 #define IEEE80211_RADIOTAP_MCS_HAVE_MCS 0x02 272 #define IEEE80211_RADIOTAP_MCS_HAVE_GI 0x04 273 #define IEEE80211_RADIOTAP_MCS_HAVE_FMT 0x08 274 #define IEEE80211_RADIOTAP_MCS_HAVE_FEC 0x10 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 285 /* remove, only used on macos */ 286 #define IEEE80211_RADIOTAP_MCS_BW_80 0x20 287 #define IEEE80211_RADIOTAP_MCS_BW_20LL 0x40 288 #define IEEE80211_RADIOTAP_MCS_BW_20LU 0x60 289 #define IEEE80211_RADIOTAP_MCS_BW_20UL 0x80 290 #define IEEE80211_RADIOTAP_MCS_BW_20UU 0xa0 291 #define IEEE80211_RADIOTAP_MCS_BW_40L 0xc0 292 #define IEEE80211_RADIOTAP_MCS_BW_40U 0xe0 293 294 /* For IEEE80211_RADIOTAP_VHT */ 295 #define IEEE80211_RADIOTAP_VHT_HAVE_STBC 0x0001 296 #define IEEE80211_RADIOTAP_VHT_HAVE_TXOP_PS 0x0002 297 #define IEEE80211_RADIOTAP_VHT_HAVE_GI 0x0004 298 #define IEEE80211_RADIOTAP_VHT_HAVE_SGI_NSYM_DA 0x0008 299 #define IEEE80211_RADIOTAP_VHT_HAVE_LDPC_EXTRA 0x0010 300 #define IEEE80211_RADIOTAP_VHT_HAVE_BF 0x0020 301 #define IEEE80211_RADIOTAP_VHT_HAVE_BW 0x0040 302 #define IEEE80211_RADIOTAP_VHT_HAVE_GID 0x0080 303 #define IEEE80211_RADIOTAP_VHT_HAVE_PAID 0x0100 304 305 #define IEEE80211_RADIOTAP_VHT_STBC 0x01 306 #define IEEE80211_RADIOTAP_VHT_TXOP_PS 0x02 307 #define IEEE80211_RADIOTAP_VHT_SGI 0x04 308 #define IEEE80211_RADIOTAP_VHT_SGI_NSYM_DA 0x08 309 #define IEEE80211_RADIOTAP_VHT_LDPC_EXTRA 0x10 310 #define IEEE80211_RADIOTAP_VHT_BF 0x20 311 312 #define IEEE80211_RADIOTAP_VHT_NSS 0x0f 313 #define IEEE80211_RADIOTAP_VHT_MCS 0xf0 314 315 #define IEEE80211_RADIOTAP_VHT_CODING_LDPC 0x01 316 317 #define IEEE80211_RADIOTAP_VHT_BW_20 IEEE80211_RADIOTAP_MCS_BW_20 318 #define IEEE80211_RADIOTAP_VHT_BW_40 IEEE80211_RADIOTAP_MCS_BW_40 319 #define IEEE80211_RADIOTAP_VHT_BW_20L IEEE80211_RADIOTAP_MCS_BW_20L 320 #define IEEE80211_RADIOTAP_VHT_BW_20U IEEE80211_RADIOTAP_MCS_BW_20U 321 #define IEEE80211_RADIOTAP_VHT_BW_80 4 322 #define IEEE80211_RADIOTAP_VHT_BW_40L 5 323 #define IEEE80211_RADIOTAP_VHT_BW_40U 6 324 #define IEEE80211_RADIOTAP_VHT_BW_20LL 7 325 #define IEEE80211_RADIOTAP_VHT_BW_20LU 8 326 #define IEEE80211_RADIOTAP_VHT_BW_20UL 9 327 #define IEEE80211_RADIOTAP_VHT_BW_20UU 10 328 #define IEEE80211_RADIOTAP_VHT_BW_160 11 329 #define IEEE80211_RADIOTAP_VHT_BW_80L 12 330 #define IEEE80211_RADIOTAP_VHT_BW_80U 13 331 #define IEEE80211_RADIOTAP_VHT_BW_40LL 14 332 #define IEEE80211_RADIOTAP_VHT_BW_40LU 15 333 #define IEEE80211_RADIOTAP_VHT_BW_40UL 16 334 #define IEEE80211_RADIOTAP_VHT_BW_40UU 17 335 #define IEEE80211_RADIOTAP_VHT_BW_20LLL 18 336 #define IEEE80211_RADIOTAP_VHT_BW_20LLU 19 337 #define IEEE80211_RADIOTAP_VHT_BW_20LUL 20 338 #define IEEE80211_RADIOTAP_VHT_BW_20LUU 21 339 #define IEEE80211_RADIOTAP_VHT_BW_20ULL 22 340 #define IEEE80211_RADIOTAP_VHT_BW_20ULU 23 341 #define IEEE80211_RADIOTAP_VHT_BW_20UUL 24 342 #define IEEE80211_RADIOTAP_VHT_BW_20UUU 25 343 344 /* For IEEE80211_RADIOTAP_HE */ 345 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_FORMAT 0x0003 346 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_BSS_COLOR 0x0004 347 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_BEAM_CHANGE 0x0008 348 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_DL_UL 0x0010 349 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_MCS 0x0020 350 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_DCM 0x0040 351 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_CODING 0x0080 352 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_LDPC 0x0100 353 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_STBC 0x0200 354 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_SR 0x0400 355 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_BW 0x4000 356 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_DOPPLER 0x8000 357 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_LTF 0x0004 358 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_TXBF 0x0010 359 #define IEEE80211_RADIOTAP_HE_SIGA_HAVE_TXOP 0x0040 360 361 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_FORMAT 0x0001 362 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_BEAM_CHANGE 0x0002 363 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_DL_UL 0x0004 364 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_MCS 0x0008 365 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_DCM 0x0010 366 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_BSS_COLOR 0x0020 367 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_B14 0x0040 368 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_SR 0x0080 369 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_BW 0x0100 370 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_LTF 0x0200 371 #define IEEE80211_RADIOTAP_HE_SIGA1_HAVE_NSTS 0x0400 372 373 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_TXOP 0x0001 374 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_CODING 0x0002 375 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_LDPC 0x0004 376 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_STBC 0x0008 377 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_TXBF 0x0010 378 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_FEC 0x0020 379 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_PED 0x0040 380 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_DOPPLER 0x0100 381 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_CRC 0x0400 382 #define IEEE80211_RADIOTAP_HE_SIGA2_HAVE_TAIL 0x0800 383 384 /* For IEEE80211_RADIOTAP_TXFLAGS */ 385 #define IEEE80211_RADIOTAP_TXF_FAIL 0x0001 /* TX failed due to excessive retries */ 386 #define IEEE80211_RADIOTAP_TXF_CTS 0x0002 /* TX used CTS-to-self protection */ 387 #define IEEE80211_RADIOTAP_TXF_RTSCTS 0x0004 /* TX used RTS/CTS */ 388 #define IEEE80211_RADIOTAP_TXF_NOACK 0x0008 /* For injected TX: don't expect ACK */ 389 #define IEEE80211_RADIOTAP_TXF_SEQOVR 0x0010 /* For injected TX: use pre-configured seq */ 390 391 /* For IEEE80211_RADIOTAP_AMPDU_STATUS */ 392 #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001 393 #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002 394 #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004 395 #define IEEE80211_RADIOTAP_AMPDU_IS_LAST 0x0008 396 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR 0x0010 397 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020 398 #define IEEE80211_RADIOTAP_AMPDU_MPDU_ONLY 0x8000 399 400 #endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */ 401