ieee80211_radiotap.h revision 167443
1/* $FreeBSD: head/sys/net80211/ieee80211_radiotap.h 167443 2007-03-11 07:42:02Z sam $ */ 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 57/* 58 * The radio capture header precedes the 802.11 header. 59 * 60 * Note well: all radiotap fields are little-endian. 61 */ 62struct ieee80211_radiotap_header { 63 u_int8_t it_version; /* Version 0. Only increases 64 * for drastic changes, 65 * introduction of compatible 66 * new fields does not count. 67 */ 68 u_int8_t it_pad; 69 u_int16_t it_len; /* length of the whole 70 * header in bytes, including 71 * it_version, it_pad, 72 * it_len, and data fields. 73 */ 74 u_int32_t it_present; /* A bitmap telling which 75 * fields are present. Set bit 31 76 * (0x80000000) to extend the 77 * bitmap by another 32 bits. 78 * Additional extensions are made 79 * by setting bit 31. 80 */ 81} __attribute__((__packed__)); 82 83/* 84 * Name Data type Units 85 * ---- --------- ----- 86 * 87 * IEEE80211_RADIOTAP_TSFT u_int64_t microseconds 88 * 89 * Value in microseconds of the MAC's 64-bit 802.11 Time 90 * Synchronization Function timer when the first bit of the 91 * MPDU arrived at the MAC. For received frames, only. 92 * 93 * IEEE80211_RADIOTAP_CHANNEL 2 x u_int16_t MHz, bitmap 94 * 95 * Tx/Rx frequency in MHz, followed by flags (see below). 96 * 97 * IEEE80211_RADIOTAP_FHSS u_int16_t see below 98 * 99 * For frequency-hopping radios, the hop set (first byte) 100 * and pattern (second byte). 101 * 102 * IEEE80211_RADIOTAP_RATE u_int8_t 500kb/s 103 * 104 * Tx/Rx data rate 105 * 106 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from 107 * one milliwatt (dBm) 108 * 109 * RF signal power at the antenna, decibel difference from 110 * one milliwatt. 111 * 112 * IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from 113 * one milliwatt (dBm) 114 * 115 * RF noise power at the antenna, decibel difference from one 116 * milliwatt. 117 * 118 * IEEE80211_RADIOTAP_DB_ANTSIGNAL u_int8_t decibel (dB) 119 * 120 * RF signal power at the antenna, decibel difference from an 121 * arbitrary, fixed reference. 122 * 123 * IEEE80211_RADIOTAP_DB_ANTNOISE u_int8_t decibel (dB) 124 * 125 * RF noise power at the antenna, decibel difference from an 126 * arbitrary, fixed reference point. 127 * 128 * IEEE80211_RADIOTAP_LOCK_QUALITY u_int16_t unitless 129 * 130 * Quality of Barker code lock. Unitless. Monotonically 131 * nondecreasing with "better" lock strength. Called "Signal 132 * Quality" in datasheets. (Is there a standard way to measure 133 * this?) 134 * 135 * IEEE80211_RADIOTAP_TX_ATTENUATION u_int16_t unitless 136 * 137 * Transmit power expressed as unitless distance from max 138 * power set at factory calibration. 0 is max power. 139 * Monotonically nondecreasing with lower power levels. 140 * 141 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t decibels (dB) 142 * 143 * Transmit power expressed as decibel distance from max power 144 * set at factory calibration. 0 is max power. Monotonically 145 * nondecreasing with lower power levels. 146 * 147 * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from 148 * one milliwatt (dBm) 149 * 150 * Transmit power expressed as dBm (decibels from a 1 milliwatt 151 * reference). This is the absolute power level measured at 152 * the antenna port. 153 * 154 * IEEE80211_RADIOTAP_FLAGS u_int8_t bitmap 155 * 156 * Properties of transmitted and received frames. See flags 157 * defined below. 158 * 159 * IEEE80211_RADIOTAP_ANTENNA u_int8_t antenna index 160 * 161 * Unitless indication of the Rx/Tx antenna for this packet. 162 * The first antenna is antenna 0. 163 */ 164enum ieee80211_radiotap_type { 165 IEEE80211_RADIOTAP_TSFT = 0, 166 IEEE80211_RADIOTAP_FLAGS = 1, 167 IEEE80211_RADIOTAP_RATE = 2, 168 IEEE80211_RADIOTAP_CHANNEL = 3, 169 IEEE80211_RADIOTAP_FHSS = 4, 170 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, 171 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, 172 IEEE80211_RADIOTAP_LOCK_QUALITY = 7, 173 IEEE80211_RADIOTAP_TX_ATTENUATION = 8, 174 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, 175 IEEE80211_RADIOTAP_DBM_TX_POWER = 10, 176 IEEE80211_RADIOTAP_ANTENNA = 11, 177 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, 178 IEEE80211_RADIOTAP_DB_ANTNOISE = 13, 179 IEEE80211_RADIOTAP_EXT = 31, 180}; 181 182#ifndef _KERNEL 183/* Channel flags. */ 184#define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */ 185#define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */ 186#define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */ 187#define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */ 188#define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */ 189#define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */ 190#define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */ 191#define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */ 192#endif /* !_KERNEL */ 193 194/* For IEEE80211_RADIOTAP_FLAGS */ 195#define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received 196 * during CFP 197 */ 198#define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received 199 * with short 200 * preamble 201 */ 202#define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received 203 * with WEP encryption 204 */ 205#define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received 206 * with fragmentation 207 */ 208#define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ 209#define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between 210 * 802.11 header and payload 211 * (to 32-bit boundary) 212 */ 213#define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* does not pass FCS check */ 214 215#endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */ 216