1 /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.5 2005/01/22 20:12:05 sam Exp $ */
2 /* $NetBSD: ieee80211_radiotap.h,v 1.11 2005/06/22 06:16:02 dyoung Exp $ */
5 * Copyright (c) 2003, 2004 David Young. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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
34 * Modifications to fit into the linux IEEE 802.11 stack,
35 * Mike Kershaw (dragorn@kismetwireless.net)
38 #ifndef IEEE80211RADIOTAP_H
39 #define IEEE80211RADIOTAP_H
41 /* Radiotap header version (from official NetBSD feed) */
42 #define IEEE80211RADIOTAP_VERSION "1.5"
43 /* Base version of the radiotap packet header data */
44 #define PKTHDR_RADIOTAP_VERSION 0
46 /* A generic radio capture format is desirable. There is one for
47 * Linux, but it is neither rigidly defined (there were not even
48 * units given for some fields) nor easily extensible.
50 * I suggest the following extensible radio capture format. It is
51 * based on a bitmap indicating which fields are present.
53 * I am trying to describe precisely what the application programmer
54 * should expect in the following, and for that reason I tell the
55 * units and origin of each measurement (where it applies), or else I
56 * use sufficiently weaselly language ("is a monotonically nondecreasing
57 * function of...") that I cannot set false expectations for lawyerly
61 /* XXX tcpdump/libpcap do not tolerate variable-length headers,
62 * yet, so we pad every radiotap header to 64 bytes. Ugh.
64 #define IEEE80211_RADIOTAP_HDRLEN 64
66 /* The radio capture header precedes the 802.11 header.
67 * All data in the header is little endian on all platforms.
69 struct ieee80211_radiotap_header {
70 u8 it_version; /* Version 0. Only increases
71 * for drastic changes,
72 * introduction of compatible
73 * new fields does not count.
76 u16 it_len; /* length of the whole
77 * header in bytes, including
79 * it_len, and data fields.
81 u32 it_present; /* A bitmap telling which
82 * fields are present. Set bit 31
83 * (0x80000000) to extend the
84 * bitmap by another 32 bits.
85 * Additional extensions are made
90 #define IEEE80211_RADIOTAP_PRESENT_EXTEND_MASK 0x80000000
92 /* Name Data type Units
93 * ---- --------- -----
95 * IEEE80211_RADIOTAP_TSFT __le64 microseconds
97 * Value in microseconds of the MAC's 64-bit 802.11 Time
98 * Synchronization Function timer when the first bit of the
99 * MPDU arrived at the MAC. For received frames, only.
101 * IEEE80211_RADIOTAP_CHANNEL 2 x __le16 MHz, bitmap
103 * Tx/Rx frequency in MHz, followed by flags (see below).
105 * IEEE80211_RADIOTAP_FHSS __le16 see below
107 * For frequency-hopping radios, the hop set (first byte)
108 * and pattern (second byte).
110 * IEEE80211_RADIOTAP_RATE u8 500kb/s
114 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL s8 decibels from
115 * one milliwatt (dBm)
117 * RF signal power at the antenna, decibel difference from
120 * IEEE80211_RADIOTAP_DBM_ANTNOISE s8 decibels from
121 * one milliwatt (dBm)
123 * RF noise power at the antenna, decibel difference from one
126 * IEEE80211_RADIOTAP_DB_ANTSIGNAL u8 decibel (dB)
128 * RF signal power at the antenna, decibel difference from an
129 * arbitrary, fixed reference.
131 * IEEE80211_RADIOTAP_DB_ANTNOISE u8 decibel (dB)
133 * RF noise power at the antenna, decibel difference from an
134 * arbitrary, fixed reference point.
136 * IEEE80211_RADIOTAP_LOCK_QUALITY __le16 unitless
138 * Quality of Barker code lock. Unitless. Monotonically
139 * nondecreasing with "better" lock strength. Called "Signal
140 * Quality" in datasheets. (Is there a standard way to measure
143 * IEEE80211_RADIOTAP_TX_ATTENUATION __le16 unitless
145 * Transmit power expressed as unitless distance from max
146 * power set at factory calibration. 0 is max power.
147 * Monotonically nondecreasing with lower power levels.
149 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION __le16 decibels (dB)
151 * Transmit power expressed as decibel distance from max power
152 * set at factory calibration. 0 is max power. Monotonically
153 * nondecreasing with lower power levels.
155 * IEEE80211_RADIOTAP_DBM_TX_POWER s8 decibels from
156 * one milliwatt (dBm)
158 * Transmit power expressed as dBm (decibels from a 1 milliwatt
159 * reference). This is the absolute power level measured at
162 * IEEE80211_RADIOTAP_FLAGS u8 bitmap
164 * Properties of transmitted and received frames. See flags
167 * IEEE80211_RADIOTAP_ANTENNA u8 antenna index
169 * Unitless indication of the Rx/Tx antenna for this packet.
170 * The first antenna is antenna 0.
172 * IEEE80211_RADIOTAP_RX_FLAGS __le16 bitmap
174 * Properties of received frames. See flags defined below.
176 * IEEE80211_RADIOTAP_TX_FLAGS __le16 bitmap
178 * Properties of transmitted frames. See flags defined below.
180 * IEEE80211_RADIOTAP_RTS_RETRIES u8 data
182 * Number of rts retries a transmitted frame used.
184 * IEEE80211_RADIOTAP_DATA_RETRIES u8 data
186 * Number of unicast retries a transmitted frame used.
189 enum ieee80211_radiotap_type {
190 IEEE80211_RADIOTAP_TSFT = 0,
191 IEEE80211_RADIOTAP_FLAGS = 1,
192 IEEE80211_RADIOTAP_RATE = 2,
193 IEEE80211_RADIOTAP_CHANNEL = 3,
194 IEEE80211_RADIOTAP_FHSS = 4,
195 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
196 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
197 IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
198 IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
199 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
200 IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
201 IEEE80211_RADIOTAP_ANTENNA = 11,
202 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
203 IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
204 IEEE80211_RADIOTAP_RX_FLAGS = 14,
205 IEEE80211_RADIOTAP_TX_FLAGS = 15,
206 IEEE80211_RADIOTAP_RTS_RETRIES = 16,
207 IEEE80211_RADIOTAP_DATA_RETRIES = 17,
208 IEEE80211_RADIOTAP_EXT = 31
212 #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */
213 #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */
214 #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */
215 #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */
216 #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */
217 #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */
218 #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */
219 #define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */
221 /* For IEEE80211_RADIOTAP_FLAGS */
222 #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received
225 #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received
229 #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received
230 * with WEP encryption
232 #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received
235 #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */
236 #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between
237 * 802.11 header and payload
238 * (to 32-bit boundary)
240 /* For IEEE80211_RADIOTAP_RX_FLAGS */
241 #define IEEE80211_RADIOTAP_F_RX_BADFCS 0x0001 /* frame failed crc check */
243 /* For IEEE80211_RADIOTAP_TX_FLAGS */
244 #define IEEE80211_RADIOTAP_F_TX_FAIL 0x0001 /* failed due to excessive
246 #define IEEE80211_RADIOTAP_F_TX_CTS 0x0002 /* used cts 'protection' */
247 #define IEEE80211_RADIOTAP_F_TX_RTS 0x0004 /* used rts/cts handshake */
248 #define IEEE80211_RADIOTAP_F_TX_NOACK 0x0008 /* frame should not be ACKed */
249 #define IEEE80211_RADIOTAP_F_TX_NOSEQ 0x0010 /* sequence number handled
252 /* Ugly macro to convert literal channel numbers into their mhz equivalents
253 * There are certianly some conditions that will break this (like feeding it '30')
254 * but they shouldn't arise since nothing talks on channel 30. */
255 #define ieee80211chan2mhz(x) \
257 (((x) == 14) ? 2484 : ((x) * 5) + 2407) : \
260 #endif /* IEEE80211_RADIOTAP_H */