1/* $FreeBSD$ */ 2/* $NetBSD: ieee80211_radiotap.h,v 1.16 2007/01/06 05:51:15 dyoung 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 * 3. The name of David Young may not be used to endorse or promote 16 * products derived from this software without specific prior 17 * written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY 20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 22 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID 23 * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 25 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 */ 32#ifndef _NET80211_IEEE80211_RADIOTAP_H_ 33#define _NET80211_IEEE80211_RADIOTAP_H_ 34 35/* A generic radio capture format is desirable. It must be 36 * rigidly defined (e.g., units for fields should be given), 37 * and easily extensible. 38 * 39 * The following is an extensible radio capture format. It is 40 * based on a bitmap indicating which fields are present. 41 * 42 * I am trying to describe precisely what the application programmer 43 * should expect in the following, and for that reason I tell the 44 * units and origin of each measurement (where it applies), or else I 45 * use sufficiently weaselly language ("is a monotonically nondecreasing 46 * function of...") that I cannot set false expectations for lawyerly 47 * readers. 48 */ 49#if defined(__KERNEL__) || defined(_KERNEL) 50#ifndef DLT_IEEE802_11_RADIO 51#define DLT_IEEE802_11_RADIO 127 /* 802.11 plus WLAN header */ 52#endif 53#endif /* defined(__KERNEL__) || defined(_KERNEL) */ 54 55#define IEEE80211_RADIOTAP_HDRLEN 64 /* XXX deprecated */ 56 57struct ieee80211_radiotap_vendor_header { 58 uint8_t vh_oui[3]; /* 3 byte vendor OUI */ 59 uint8_t vh_sub_ns; /* Sub namespace of this section */ 60 uint16_t vh_skip_len; /* Length of this vendor section */ 61} __packed; 62 63/* 64 * The radio capture header precedes the 802.11 header. 65 * 66 * Note well: all radiotap fields are little-endian. 67 */ 68struct ieee80211_radiotap_header { 69 uint8_t it_version; /* Version 0. Only increases 70 * for drastic changes, 71 * introduction of compatible 72 * new fields does not count. 73 */ 74 uint8_t it_pad; 75 uint16_t it_len; /* length of the whole 76 * header in bytes, including 77 * it_version, it_pad, 78 * it_len, and data fields. 79 */ 80 uint32_t it_present; /* A bitmap telling which 81 * fields are present. Set bit 31 82 * (0x80000000) to extend the 83 * bitmap by another 32 bits. 84 * Additional extensions are made 85 * by setting bit 31. 86 */ 87} __packed; 88 89/* 90 * Name Data type Units 91 * ---- --------- ----- 92 * 93 * IEEE80211_RADIOTAP_TSFT uint64_t microseconds 94 * 95 * Value in microseconds of the MAC's 64-bit 802.11 Time 96 * Synchronization Function timer when the first bit of the 97 * MPDU arrived at the MAC. For received frames, only. 98 * 99 * IEEE80211_RADIOTAP_CHANNEL 2 x uint16_t MHz, bitmap 100 * 101 * Tx/Rx frequency in MHz, followed by flags (see below). 102 * 103 * IEEE80211_RADIOTAP_FHSS uint16_t see below 104 * 105 * For frequency-hopping radios, the hop set (first byte) 106 * and pattern (second byte). 107 * 108 * IEEE80211_RADIOTAP_RATE uint8_t 500kb/s or index 109 * 110 * Tx/Rx data rate. If bit 0x80 is set then it represents an 111 * an MCS index and not an IEEE rate. 112 * 113 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from 114 * one milliwatt (dBm) 115 * 116 * RF signal power at the antenna, decibel difference from 117 * one milliwatt. 118 * 119 * IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from 120 * one milliwatt (dBm) 121 * 122 * RF noise power at the antenna, decibel difference from one 123 * milliwatt. 124 * 125 * IEEE80211_RADIOTAP_DB_ANTSIGNAL uint8_t decibel (dB) 126 * 127 * RF signal power at the antenna, decibel difference from an 128 * arbitrary, fixed reference. 129 * 130 * IEEE80211_RADIOTAP_DB_ANTNOISE uint8_t decibel (dB) 131 * 132 * RF noise power at the antenna, decibel difference from an 133 * arbitrary, fixed reference point. 134 * 135 * IEEE80211_RADIOTAP_LOCK_QUALITY uint16_t unitless 136 * 137 * Quality of Barker code lock. Unitless. Monotonically 138 * nondecreasing with "better" lock strength. Called "Signal 139 * Quality" in datasheets. (Is there a standard way to measure 140 * this?) 141 * 142 * IEEE80211_RADIOTAP_TX_ATTENUATION uint16_t unitless 143 * 144 * Transmit power expressed as unitless distance from max 145 * power set at factory calibration. 0 is max power. 146 * Monotonically nondecreasing with lower power levels. 147 * 148 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t decibels (dB) 149 * 150 * Transmit power expressed as decibel distance from max power 151 * set at factory calibration. 0 is max power. Monotonically 152 * nondecreasing with lower power levels. 153 * 154 * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from 155 * one milliwatt (dBm) 156 * 157 * Transmit power expressed as dBm (decibels from a 1 milliwatt 158 * reference). This is the absolute power level measured at 159 * the antenna port. 160 * 161 * IEEE80211_RADIOTAP_FLAGS uint8_t bitmap 162 * 163 * Properties of transmitted and received frames. See flags 164 * defined below. 165 * 166 * IEEE80211_RADIOTAP_ANTENNA uint8_t antenna index 167 * 168 * Unitless indication of the Rx/Tx antenna for this packet. 169 * The first antenna is antenna 0. 170 * 171 * IEEE80211_RADIOTAP_XCHANNEL uint32_t bitmap 172 * uint16_t MHz 173 * uint8_t channel number 174 * int8_t .5 dBm 175 * 176 * Extended channel specification: flags (see below) followed by 177 * frequency in MHz, the corresponding IEEE channel number, and 178 * finally the maximum regulatory transmit power cap in .5 dBm 179 * units. This property supersedes IEEE80211_RADIOTAP_CHANNEL 180 * and only one of the two should be present. 181 */ 182enum ieee80211_radiotap_type { 183 IEEE80211_RADIOTAP_TSFT = 0, 184 IEEE80211_RADIOTAP_FLAGS = 1, 185 IEEE80211_RADIOTAP_RATE = 2, 186 IEEE80211_RADIOTAP_CHANNEL = 3, 187 IEEE80211_RADIOTAP_FHSS = 4, 188 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 189 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 190 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 191 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 192 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 193 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 194 IEEE80211_RADIOTAP_ANTENNA = 11, 195 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 196 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 197 /* 198 * 14-17 are from Linux, they overlap the netbsd-specific 199 * fields. 200 */ 201 IEEE80211_RADIOTAP_RX_FLAGS = 14, 202 IEEE80211_RADIOTAP_TX_FLAGS = 15, 203 IEEE80211_RADIOTAP_RTS_RETRIES = 16, 204 IEEE80211_RADIOTAP_DATA_RETRIES = 17, 205 206 IEEE80211_RADIOTAP_XCHANNEL = 18, 207 IEEE80211_RADIOTAP_MCS = 19, 208 IEEE80211_RADIOTAP_AMPDU_STATUS = 20, 209 210 IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29, 211 IEEE80211_RADIOTAP_VENDOREXT = 30, 212 IEEE80211_RADIOTAP_EXT = 31, 213}; 214 215#ifndef _KERNEL 216/* channel attributes */ 217#define IEEE80211_CHAN_TURBO 0x00000010 /* Turbo channel */ 218#define IEEE80211_CHAN_CCK 0x00000020 /* CCK channel */ 219#define IEEE80211_CHAN_OFDM 0x00000040 /* OFDM channel */ 220#define IEEE80211_CHAN_2GHZ 0x00000080 /* 2 GHz spectrum channel. */ 221#define IEEE80211_CHAN_5GHZ 0x00000100 /* 5 GHz spectrum channel */ 222#define IEEE80211_CHAN_PASSIVE 0x00000200 /* Only passive scan allowed */ 223#define IEEE80211_CHAN_DYN 0x00000400 /* Dynamic CCK-OFDM channel */ 224#define IEEE80211_CHAN_GFSK 0x00000800 /* GFSK channel (FHSS PHY) */ 225#define IEEE80211_CHAN_GSM 0x00001000 /* 900 MHz spectrum channel */ 226#define IEEE80211_CHAN_STURBO 0x00002000 /* 11a static turbo channel only */ 227#define IEEE80211_CHAN_HALF 0x00004000 /* Half rate channel */ 228#define IEEE80211_CHAN_QUARTER 0x00008000 /* Quarter rate channel */ 229#endif /* !_KERNEL */ 230 231/* For IEEE80211_RADIOTAP_FLAGS */ 232#define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 233 * during CFP 234 */ 235#define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 236 * with short 237 * preamble 238 */ 239#define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 240 * with WEP encryption 241 */ 242#define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 243 * with fragmentation 244 */ 245#define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 246#define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 247 * 802.11 header and payload 248 * (to 32-bit boundary) 249 */ 250#define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* does not pass FCS check */ 251#define IEEE80211_RADIOTAP_F_SHORTGI 0x80 /* HT short GI */ 252 253#endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */ 254