1 /* $DragonFly$ */ 2 /* $FreeBSD: head/sys/net80211/ieee80211_radiotap.h 174568 2007-12-13 01:23:40Z sam $ */ 3 /* $NetBSD: ieee80211_radiotap.h,v 1.16 2007/01/06 05:51:15 dyoung Exp $ */ 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 /* XXX deprecated */ 57 58 /* 59 * The radio capture header precedes the 802.11 header. 60 * 61 * Note well: all radiotap fields are little-endian. 62 */ 63 struct 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 } __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_LOCK_QUALITY uint16_t unitless 131 * 132 * Quality of Barker code lock. Unitless. Monotonically 133 * nondecreasing with "better" lock strength. Called "Signal 134 * Quality" in datasheets. (Is there a standard way to measure 135 * this?) 136 * 137 * IEEE80211_RADIOTAP_TX_ATTENUATION uint16_t unitless 138 * 139 * Transmit power expressed as unitless distance from max 140 * power set at factory calibration. 0 is max power. 141 * Monotonically nondecreasing with lower power levels. 142 * 143 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t decibels (dB) 144 * 145 * Transmit power expressed as decibel distance from max power 146 * set at factory calibration. 0 is max power. Monotonically 147 * nondecreasing with lower power levels. 148 * 149 * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from 150 * one milliwatt (dBm) 151 * 152 * Transmit power expressed as dBm (decibels from a 1 milliwatt 153 * reference). This is the absolute power level measured at 154 * the antenna port. 155 * 156 * IEEE80211_RADIOTAP_FLAGS uint8_t bitmap 157 * 158 * Properties of transmitted and received frames. See flags 159 * defined below. 160 * 161 * IEEE80211_RADIOTAP_ANTENNA uint8_t antenna index 162 * 163 * Unitless indication of the Rx/Tx antenna for this packet. 164 * The first antenna is antenna 0. 165 * 166 * IEEE80211_RADIOTAP_XCHANNEL uint32_t bitmap 167 * uint16_t MHz 168 * uint8_t channel number 169 * int8_t .5 dBm 170 * 171 * Extended channel specification: flags (see below) followed by 172 * frequency in MHz, the corresponding IEEE channel number, and 173 * finally the maximum regulatory transmit power cap in .5 dBm 174 * units. This property supersedes IEEE80211_RADIOTAP_CHANNEL 175 * and only one of the two should be present. 176 */ 177 enum ieee80211_radiotap_type { 178 IEEE80211_RADIOTAP_TSFT = 0, 179 IEEE80211_RADIOTAP_FLAGS = 1, 180 IEEE80211_RADIOTAP_RATE = 2, 181 IEEE80211_RADIOTAP_CHANNEL = 3, 182 IEEE80211_RADIOTAP_FHSS = 4, 183 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 184 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 185 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 186 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 187 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 188 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 189 IEEE80211_RADIOTAP_ANTENNA = 11, 190 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 191 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 192 /* NB: gap for netbsd definitions */ 193 IEEE80211_RADIOTAP_XCHANNEL = 18, 194 IEEE80211_RADIOTAP_EXT = 31, 195 }; 196 197 #ifndef _KERNEL 198 /* channel attributes */ 199 #define IEEE80211_CHAN_TURBO 0x00000010 /* Turbo channel */ 200 #define IEEE80211_CHAN_CCK 0x00000020 /* CCK channel */ 201 #define IEEE80211_CHAN_OFDM 0x00000040 /* OFDM channel */ 202 #define IEEE80211_CHAN_2GHZ 0x00000080 /* 2 GHz spectrum channel. */ 203 #define IEEE80211_CHAN_5GHZ 0x00000100 /* 5 GHz spectrum channel */ 204 #define IEEE80211_CHAN_PASSIVE 0x00000200 /* Only passive scan allowed */ 205 #define IEEE80211_CHAN_DYN 0x00000400 /* Dynamic CCK-OFDM channel */ 206 #define IEEE80211_CHAN_GFSK 0x00000800 /* GFSK channel (FHSS PHY) */ 207 #define IEEE80211_CHAN_GSM 0x00001000 /* 900 MHz spectrum channel */ 208 #define IEEE80211_CHAN_STURBO 0x00002000 /* 11a static turbo channel only */ 209 #define IEEE80211_CHAN_HALF 0x00004000 /* Half rate channel */ 210 #define IEEE80211_CHAN_QUARTER 0x00008000 /* Quarter rate channel */ 211 #endif /* !_KERNEL */ 212 213 /* For IEEE80211_RADIOTAP_FLAGS */ 214 #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 215 * during CFP 216 */ 217 #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 218 * with short 219 * preamble 220 */ 221 #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 222 * with WEP encryption 223 */ 224 #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 225 * with fragmentation 226 */ 227 #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 228 #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 229 * 802.11 header and payload 230 * (to 32-bit boundary) 231 */ 232 #define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* does not pass FCS check */ 233 #define IEEE80211_RADIOTAP_F_SHORTGI 0x80 /* HT short GI */ 234 235 #endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */ 236