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#ifndef _NET80211_IEEE80211_RADIOTAP_H_ 34#define _NET80211_IEEE80211_RADIOTAP_H_ 35 36/* A generic radio capture format is desirable. It must be 37 * rigidly defined (e.g., units for fields should be given), 38 * and easily extensible. 39 * 40 * The following is an 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#define IEEE80211_RADIOTAP_HDRLEN 64 57 58/* 59 * The radio capture header precedes the 802.11 header. 60 * 61 * Note well: all radiotap fields are little-endian. 62 */ 63struct ieee80211_radiotap_header { 64 uint8_t it_version; /* Version 0. Only increases 65 * for drastic changes, 66 * introduction of compatible 67 * new fields does not count. 68 */ 69 uint8_t it_pad; 70 uint16_t it_len; /* length of the whole 71 * header in bytes, including 72 * it_version, it_pad, 73 * it_len, and data fields. 74 */ 75 uint32_t 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/* 85 * Name Data type Units 86 * ---- --------- ----- 87 * 88 * IEEE80211_RADIOTAP_TSFT uint64_t microseconds 89 * 90 * Value in microseconds of the MAC's 64-bit 802.11 Time 91 * Synchronization Function timer when the first bit of the 92 * MPDU arrived at the MAC. For received frames, only. 93 * 94 * IEEE80211_RADIOTAP_CHANNEL 2 x uint16_t MHz, bitmap 95 * 96 * Tx/Rx frequency in MHz, followed by flags (see below). 97 * 98 * IEEE80211_RADIOTAP_FHSS uint16_t see below 99 * 100 * For frequency-hopping radios, the hop set (first byte) 101 * and pattern (second byte). 102 * 103 * IEEE80211_RADIOTAP_RATE uint8_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 uint8_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 uint8_t decibel (dB) 126 * 127 * RF noise power at the antenna, decibel difference from an 128 * arbitrary, fixed reference point. 129 * 130 * IEEE80211_RADIOTAP_TXFLAGS uint16_t txflags 131 * Properties of Transmitted frames 132 * 133 * IEEE80211_RADIOTAP_RETRIES uint8_t retries 134 * Number of retries 135 * 136 * IEEE80211_RADIOTAP_LOCK_QUALITY uint16_t unitless 137 * 138 * Quality of Barker code lock. Unitless. Monotonically 139 * nondecreasing with "better" lock strength. Called "Signal 140 * Quality" in datasheets. (Is there a standard way to measure 141 * this?) 142 * 143 * IEEE80211_RADIOTAP_TX_ATTENUATION uint16_t unitless 144 * 145 * Transmit power expressed as unitless distance from max 146 * power set at factory calibration. 0 is max power. 147 * Monotonically nondecreasing with lower power levels. 148 * 149 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t decibels (dB) 150 * 151 * Transmit power expressed as decibel distance from max power 152 * set at factory calibration. 0 is max power. Monotonically 153 * nondecreasing with lower power levels. 154 * 155 * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from 156 * one milliwatt (dBm) 157 * 158 * Transmit power expressed as dBm (decibels from a 1 milliwatt 159 * reference). This is the absolute power level measured at 160 * the antenna port. 161 * 162 * IEEE80211_RADIOTAP_FLAGS uint8_t bitmap 163 * 164 * Properties of transmitted and received frames. See flags 165 * defined below. 166 * 167 * IEEE80211_RADIOTAP_ANTENNA uint8_t antenna index 168 * 169 * Unitless indication of the Rx/Tx antenna for this packet. 170 * The first antenna is antenna 0. 171 * 172 * IEEE80211_RADIOTAP_XCHANNEL uint32_t bitmap 173 * uint16_t MHz 174 * uint8_t channel number 175 * int8_t .5 dBm 176 * 177 * Extended channel specification: flags (see below) followed by 178 * frequency in MHz, the corresponding IEEE channel number, and 179 * finally the maximum regulatory transmit power cap in .5 dBm 180 * units. This property supersedes IEEE80211_RADIOTAP_CHANNEL 181 * and only one of the two should be present. 182 * 183 * IEEE80211_RADIOTAP_MCS u8, u8, u8 unitless 184 * 185 * Contains a bitmap of known fields/flags, the flags, and 186 * the MCS index. 187 * 188 */ 189enum ieee80211_radiotap_type { 190 IEEE80211_RADIOTAP_TSFT = 0, 191 IEEE80211_RADIOTAP_FLAGS = 1, 192 IEEE80211_RADIOTAP_RATE = 2, 193 IEEE80211_RADIOTAP_CHANNEL = 3, 194 IEEE80211_RADIOTAP_FHSS = 4, 195 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 196 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 197 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 198 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 199 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 200 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 201 IEEE80211_RADIOTAP_ANTENNA = 11, 202 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 203 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 204 /* NB: gap for netbsd definitions */ 205 IEEE80211_RADIOTAP_TXFLAGS = 15, 206 IEEE80211_RADIOTAP_RETRIES = 17, 207 IEEE80211_RADIOTAP_XCHANNEL = 18, 208 IEEE80211_RADIOTAP_MCS = 19, 209 IEEE80211_RADIOTAP_AMPDU = 20, 210 IEEE80211_RADIOTAP_VHT = 21, 211 IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29, 212 IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30, 213 IEEE80211_RADIOTAP_EXT = 31, 214 }; 215 216#ifndef _KERNEL 217/* channel attributes */ 218#define IEEE80211_CHAN_TURBO 0x00000010 /* Turbo channel */ 219#define IEEE80211_CHAN_CCK 0x00000020 /* CCK channel */ 220#define IEEE80211_CHAN_OFDM 0x00000040 /* OFDM channel */ 221#define IEEE80211_CHAN_2GHZ 0x00000080 /* 2 GHz spectrum channel. */ 222#define IEEE80211_CHAN_5GHZ 0x00000100 /* 5 GHz spectrum channel */ 223#define IEEE80211_CHAN_PASSIVE 0x00000200 /* Only passive scan allowed */ 224#define IEEE80211_CHAN_DYN 0x00000400 /* Dynamic CCK-OFDM channel */ 225#define IEEE80211_CHAN_GFSK 0x00000800 /* GFSK channel (FHSS PHY) */ 226#define IEEE80211_CHAN_GSM 0x00001000 /* 900 MHz spectrum channel */ 227#define IEEE80211_CHAN_STURBO 0x00002000 /* 11a static turbo channel only */ 228#define IEEE80211_CHAN_HALF 0x00004000 /* Half rate channel */ 229#define IEEE80211_CHAN_QUARTER 0x00008000 /* Quarter rate channel */ 230#define IEEE80211_CHAN_HT20 0x00010000 /* HT 20 channel */ 231#define IEEE80211_CHAN_HT40U 0x00020000 /* HT 40 channel w/ ext above */ 232#define IEEE80211_CHAN_HT40D 0x00040000 /* HT 40 channel w/ ext below */ 233#endif /* !_KERNEL */ 234 235/* For IEEE80211_RADIOTAP_FLAGS */ 236#define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 237 * during CFP 238 */ 239#define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 240 * with short 241 * preamble 242 */ 243#define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 244 * with WEP encryption 245 */ 246#define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 247 * with fragmentation 248 */ 249#define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 250#define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 251 * 802.11 header and payload 252 * (to 32-bit boundary) 253 */ 254#define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* does not pass FCS check */ 255 256/* For IEEE80211_RADIOTAP_MCS */ 257#define IEEE80211_RADIOTAP_MCS_HAVE_BW 0x01 258#define IEEE80211_RADIOTAP_MCS_HAVE_MCS 0x02 259#define IEEE80211_RADIOTAP_MCS_HAVE_GI 0x04 260#define IEEE80211_RADIOTAP_MCS_HAVE_FMT 0x08 261#define IEEE80211_RADIOTAP_MCS_HAVE_FEC 0x10 262 263#define IEEE80211_RADIOTAP_MCS_BW_MASK 0x03 264#define IEEE80211_RADIOTAP_MCS_BW_20 0 265#define IEEE80211_RADIOTAP_MCS_BW_40 1 266#define IEEE80211_RADIOTAP_MCS_BW_20L 2 267#define IEEE80211_RADIOTAP_MCS_BW_20U 3 268#define IEEE80211_RADIOTAP_MCS_SGI 0x04 269#define IEEE80211_RADIOTAP_MCS_FMT_GF 0x08 270#define IEEE80211_RADIOTAP_MCS_FEC_LDPC 0x10 271 272#define IEEE80211_RADIOTAP_MCS_BW_80 0x20 273#define IEEE80211_RADIOTAP_MCS_BW_20LL 0x40 274#define IEEE80211_RADIOTAP_MCS_BW_20LU 0x60 275#define IEEE80211_RADIOTAP_MCS_BW_20UL 0x80 276#define IEEE80211_RADIOTAP_MCS_BW_20UU 0xa0 277#define IEEE80211_RADIOTAP_MCS_BW_40L 0xc0 278#define IEEE80211_RADIOTAP_MCS_BW_40U 0xe0 279 280/* For IEEE80211_RADIOTAP_VHT */ 281#define IEEE80211_RADIOTAP_VHT_HAVE_STBC 0x0001 282#define IEEE80211_RADIOTAP_VHT_HAVE_TXOP_PS 0x0002 283#define IEEE80211_RADIOTAP_VHT_HAVE_GI 0x0004 284#define IEEE80211_RADIOTAP_VHT_HAVE_SGI_NSYM_DA 0x0008 285#define IEEE80211_RADIOTAP_VHT_HAVE_LDPC_EXTRA 0x0010 286#define IEEE80211_RADIOTAP_VHT_HAVE_BF 0x0020 287#define IEEE80211_RADIOTAP_VHT_HAVE_BW 0x0040 288#define IEEE80211_RADIOTAP_VHT_HAVE_GID 0x0080 289#define IEEE80211_RADIOTAP_VHT_HAVE_PAID 0x0100 290 291#define IEEE80211_RADIOTAP_VHT_STBC 0x01 292#define IEEE80211_RADIOTAP_VHT_TXOP_PS 0x02 293#define IEEE80211_RADIOTAP_VHT_SGI 0x04 294#define IEEE80211_RADIOTAP_VHT_SGI_NSYM_DA 0x08 295#define IEEE80211_RADIOTAP_VHT_LDPC_EXTRA 0x10 296#define IEEE80211_RADIOTAP_VHT_BF 0x20 297 298#define IEEE80211_RADIOTAP_VHT_NSS 0x0f 299#define IEEE80211_RADIOTAP_VHT_MCS 0xf0 300 301#define IEEE80211_RADIOTAP_VHT_CODING_LDPC 0x01 302 303#define IEEE80211_RADIOTAP_VHT_BW_20 IEEE80211_RADIOTAP_MCS_BW_20 304#define IEEE80211_RADIOTAP_VHT_BW_40 IEEE80211_RADIOTAP_MCS_BW_40 305#define IEEE80211_RADIOTAP_VHT_BW_20L IEEE80211_RADIOTAP_MCS_BW_20L 306#define IEEE80211_RADIOTAP_VHT_BW_20U IEEE80211_RADIOTAP_MCS_BW_20U 307#define IEEE80211_RADIOTAP_VHT_BW_80 4 308#define IEEE80211_RADIOTAP_VHT_BW_40L 5 309#define IEEE80211_RADIOTAP_VHT_BW_40U 6 310#define IEEE80211_RADIOTAP_VHT_BW_20LL 7 311#define IEEE80211_RADIOTAP_VHT_BW_20LU 8 312#define IEEE80211_RADIOTAP_VHT_BW_20UL 9 313#define IEEE80211_RADIOTAP_VHT_BW_20UU 10 314#define IEEE80211_RADIOTAP_VHT_BW_160 11 315#define IEEE80211_RADIOTAP_VHT_BW_80L 12 316#define IEEE80211_RADIOTAP_VHT_BW_80U 13 317#define IEEE80211_RADIOTAP_VHT_BW_40LL 14 318#define IEEE80211_RADIOTAP_VHT_BW_40LU 15 319#define IEEE80211_RADIOTAP_VHT_BW_40UL 16 320#define IEEE80211_RADIOTAP_VHT_BW_40UU 17 321#define IEEE80211_RADIOTAP_VHT_BW_20LLL 18 322#define IEEE80211_RADIOTAP_VHT_BW_20LLU 19 323#define IEEE80211_RADIOTAP_VHT_BW_20LUL 20 324#define IEEE80211_RADIOTAP_VHT_BW_20LUU 21 325#define IEEE80211_RADIOTAP_VHT_BW_20ULL 22 326#define IEEE80211_RADIOTAP_VHT_BW_20ULU 23 327#define IEEE80211_RADIOTAP_VHT_BW_20UUL 24 328#define IEEE80211_RADIOTAP_VHT_BW_20UUU 25 329 330/* For IEEE80211_RADIOTAP_TXFLAGS */ 331#define IEEE80211_RADIOTAP_TXF_FAIL 0x0001 /* TX failed due to excessive retries */ 332#define IEEE80211_RADIOTAP_TXF_CTS 0x0002 /* TX used CTS-to-self protection */ 333#define IEEE80211_RADIOTAP_TXF_RTSCTS 0x0004 /* TX used RTS/CTS */ 334#define IEEE80211_RADIOTAP_TXF_NOACK 0x0008 /* For injected TX: don't expect ACK */ 335#define IEEE80211_RADIOTAP_TXF_SEQOVR 0x0010 /* For injected TX: use pre-configured seq */ 336 337 338/* For IEEE80211_RADIOTAP_AMPDU_STATUS */ 339#define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001 340#define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002 341#define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004 342#define IEEE80211_RADIOTAP_AMPDU_IS_LAST 0x0008 343#define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR 0x0010 344#define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020 345#define IEEE80211_RADIOTAP_AMPDU_MPDU_ONLY 0x8000 346 347 348#endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */ 349