1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.5 2005/01/22 20:12:05 sam Exp $ */ 2 /* $NetBSD: radiotap.h,v 1.3 2014/01/03 02:08:17 christos Exp $ */ 3 4 /*- 5 * Copyright (c) 2003, 2004 David Young. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 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 uint16_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 uint32_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 }; 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 */ 179 enum ieee80211_radiotap_type { 180 IEEE80211_RADIOTAP_TSFT = 0, 181 IEEE80211_RADIOTAP_FLAGS = 1, 182 IEEE80211_RADIOTAP_RATE = 2, 183 IEEE80211_RADIOTAP_CHANNEL = 3, 184 IEEE80211_RADIOTAP_FHSS = 4, 185 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 186 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 187 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 188 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 189 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 190 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 191 IEEE80211_RADIOTAP_ANTENNA = 11, 192 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 193 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 194 IEEE80211_RADIOTAP_RX_FLAGS = 14, 195 IEEE80211_RADIOTAP_TX_FLAGS = 15, 196 IEEE80211_RADIOTAP_RTS_RETRIES = 16, 197 IEEE80211_RADIOTAP_DATA_RETRIES = 17, 198 IEEE80211_RADIOTAP_EXT = 31 199 }; 200 201 /* Channel flags. */ 202 #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */ 203 #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */ 204 #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */ 205 #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */ 206 #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */ 207 #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */ 208 #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */ 209 #define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */ 210 211 /* For IEEE80211_RADIOTAP_FLAGS */ 212 #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 213 * during CFP 214 */ 215 #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 216 * with short 217 * preamble 218 */ 219 #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 220 * with WEP encryption 221 */ 222 #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 223 * with fragmentation 224 */ 225 #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 226 #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 227 * 802.11 header and payload 228 * (to 32-bit boundary) 229 */ 230 /* For IEEE80211_RADIOTAP_RX_FLAGS */ 231 #define IEEE80211_RADIOTAP_F_RX_BADFCS 0x0001 /* frame failed crc check */ 232 233 /* For IEEE80211_RADIOTAP_TX_FLAGS */ 234 #define IEEE80211_RADIOTAP_F_TX_FAIL 0x0001 /* failed due to excessive 235 * retries */ 236 #define IEEE80211_RADIOTAP_F_TX_CTS 0x0002 /* used cts 'protection' */ 237 #define IEEE80211_RADIOTAP_F_TX_RTS 0x0004 /* used rts/cts handshake */ 238 #define IEEE80211_RADIOTAP_F_TX_NOACK 0x0008 /* don't expect an ACK */ 239 240 #endif /* IEEE80211_RADIOTAP_H */ 241