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