blob: a0c2b41a24d7d2174cd7ca9d7f8c98d8ca1ea56c [file] [log] [blame]
James Ketrenos3905ec42005-09-21 11:56:42 -05001/* $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 $ */
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
33/*
34 * Modifications to fit into the linux IEEE 802.11 stack,
35 * Mike Kershaw (dragorn@kismetwireless.net)
36 */
37
38#ifndef IEEE80211RADIOTAP_H
39#define IEEE80211RADIOTAP_H
40
41#include <linux/if_ether.h>
42#include <linux/kernel.h>
43
44/* Radiotap header version (from official NetBSD feed) */
45#define IEEE80211RADIOTAP_VERSION "1.5"
46/* Base version of the radiotap packet header data */
47#define PKTHDR_RADIOTAP_VERSION 0
48
49/* A generic radio capture format is desirable. There is one for
50 * Linux, but it is neither rigidly defined (there were not even
51 * units given for some fields) nor easily extensible.
52 *
53 * I suggest the following extensible radio capture format. It is
54 * based on a bitmap indicating which fields are present.
55 *
56 * I am trying to describe precisely what the application programmer
57 * should expect in the following, and for that reason I tell the
58 * units and origin of each measurement (where it applies), or else I
59 * use sufficiently weaselly language ("is a monotonically nondecreasing
60 * function of...") that I cannot set false expectations for lawyerly
61 * readers.
62 */
63
64/* XXX tcpdump/libpcap do not tolerate variable-length headers,
65 * yet, so we pad every radiotap header to 64 bytes. Ugh.
66 */
67#define IEEE80211_RADIOTAP_HDRLEN 64
68
Pavel Roskina0d69f22007-03-10 22:54:22 -050069/* The radio capture header precedes the 802.11 header.
70 * All data in the header is little endian on all platforms.
71 */
James Ketrenos3905ec42005-09-21 11:56:42 -050072struct ieee80211_radiotap_header {
73 u8 it_version; /* Version 0. Only increases
74 * for drastic changes,
75 * introduction of compatible
76 * new fields does not count.
77 */
78 u8 it_pad;
Pavel Roskina0d69f22007-03-10 22:54:22 -050079 __le16 it_len; /* length of the whole
James Ketrenos3905ec42005-09-21 11:56:42 -050080 * header in bytes, including
81 * it_version, it_pad,
82 * it_len, and data fields.
83 */
Pavel Roskina0d69f22007-03-10 22:54:22 -050084 __le32 it_present; /* A bitmap telling which
James Ketrenos3905ec42005-09-21 11:56:42 -050085 * fields are present. Set bit 31
86 * (0x80000000) to extend the
87 * bitmap by another 32 bits.
88 * Additional extensions are made
89 * by setting bit 31.
90 */
91};
92
Pavel Roskina0d69f22007-03-10 22:54:22 -050093/* Name Data type Units
94 * ---- --------- -----
James Ketrenos3905ec42005-09-21 11:56:42 -050095 *
Pavel Roskina0d69f22007-03-10 22:54:22 -050096 * IEEE80211_RADIOTAP_TSFT __le64 microseconds
James Ketrenos3905ec42005-09-21 11:56:42 -050097 *
98 * Value in microseconds of the MAC's 64-bit 802.11 Time
99 * Synchronization Function timer when the first bit of the
100 * MPDU arrived at the MAC. For received frames, only.
101 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500102 * IEEE80211_RADIOTAP_CHANNEL 2 x __le16 MHz, bitmap
James Ketrenos3905ec42005-09-21 11:56:42 -0500103 *
104 * Tx/Rx frequency in MHz, followed by flags (see below).
105 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500106 * IEEE80211_RADIOTAP_FHSS __le16 see below
James Ketrenos3905ec42005-09-21 11:56:42 -0500107 *
108 * For frequency-hopping radios, the hop set (first byte)
109 * and pattern (second byte).
110 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500111 * IEEE80211_RADIOTAP_RATE u8 500kb/s
James Ketrenos3905ec42005-09-21 11:56:42 -0500112 *
113 * Tx/Rx data rate
114 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500115 * IEEE80211_RADIOTAP_DBM_ANTSIGNAL s8 decibels from
116 * one milliwatt (dBm)
James Ketrenos3905ec42005-09-21 11:56:42 -0500117 *
118 * RF signal power at the antenna, decibel difference from
119 * one milliwatt.
120 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500121 * IEEE80211_RADIOTAP_DBM_ANTNOISE s8 decibels from
122 * one milliwatt (dBm)
James Ketrenos3905ec42005-09-21 11:56:42 -0500123 *
124 * RF noise power at the antenna, decibel difference from one
125 * milliwatt.
126 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500127 * IEEE80211_RADIOTAP_DB_ANTSIGNAL u8 decibel (dB)
James Ketrenos3905ec42005-09-21 11:56:42 -0500128 *
129 * RF signal power at the antenna, decibel difference from an
130 * arbitrary, fixed reference.
131 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500132 * IEEE80211_RADIOTAP_DB_ANTNOISE u8 decibel (dB)
James Ketrenos3905ec42005-09-21 11:56:42 -0500133 *
134 * RF noise power at the antenna, decibel difference from an
135 * arbitrary, fixed reference point.
136 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500137 * IEEE80211_RADIOTAP_LOCK_QUALITY __le16 unitless
James Ketrenos3905ec42005-09-21 11:56:42 -0500138 *
139 * Quality of Barker code lock. Unitless. Monotonically
140 * nondecreasing with "better" lock strength. Called "Signal
141 * Quality" in datasheets. (Is there a standard way to measure
142 * this?)
143 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500144 * IEEE80211_RADIOTAP_TX_ATTENUATION __le16 unitless
James Ketrenos3905ec42005-09-21 11:56:42 -0500145 *
146 * Transmit power expressed as unitless distance from max
147 * power set at factory calibration. 0 is max power.
148 * Monotonically nondecreasing with lower power levels.
149 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500150 * IEEE80211_RADIOTAP_DB_TX_ATTENUATION __le16 decibels (dB)
James Ketrenos3905ec42005-09-21 11:56:42 -0500151 *
152 * Transmit power expressed as decibel distance from max power
153 * set at factory calibration. 0 is max power. Monotonically
154 * nondecreasing with lower power levels.
155 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500156 * IEEE80211_RADIOTAP_DBM_TX_POWER s8 decibels from
157 * one milliwatt (dBm)
James Ketrenos3905ec42005-09-21 11:56:42 -0500158 *
159 * Transmit power expressed as dBm (decibels from a 1 milliwatt
160 * reference). This is the absolute power level measured at
161 * the antenna port.
162 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500163 * IEEE80211_RADIOTAP_FLAGS u8 bitmap
James Ketrenos3905ec42005-09-21 11:56:42 -0500164 *
165 * Properties of transmitted and received frames. See flags
166 * defined below.
167 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500168 * IEEE80211_RADIOTAP_ANTENNA u8 antenna index
James Ketrenos3905ec42005-09-21 11:56:42 -0500169 *
170 * Unitless indication of the Rx/Tx antenna for this packet.
171 * The first antenna is antenna 0.
172 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500173 * IEEE80211_RADIOTAP_RX_FLAGS __le16 bitmap
Marcelo Tosatti876c9d32007-02-10 12:25:27 -0200174 *
175 * Properties of received frames. See flags defined below.
176 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500177 * IEEE80211_RADIOTAP_TX_FLAGS __le16 bitmap
Marcelo Tosatti876c9d32007-02-10 12:25:27 -0200178 *
179 * Properties of transmitted frames. See flags defined below.
180 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500181 * IEEE80211_RADIOTAP_RTS_RETRIES u8 data
Marcelo Tosatti876c9d32007-02-10 12:25:27 -0200182 *
183 * Number of rts retries a transmitted frame used.
184 *
Pavel Roskina0d69f22007-03-10 22:54:22 -0500185 * IEEE80211_RADIOTAP_DATA_RETRIES u8 data
Marcelo Tosatti876c9d32007-02-10 12:25:27 -0200186 *
187 * Number of unicast retries a transmitted frame used.
188 *
James Ketrenos3905ec42005-09-21 11:56:42 -0500189 */
190enum ieee80211_radiotap_type {
191 IEEE80211_RADIOTAP_TSFT = 0,
192 IEEE80211_RADIOTAP_FLAGS = 1,
193 IEEE80211_RADIOTAP_RATE = 2,
194 IEEE80211_RADIOTAP_CHANNEL = 3,
195 IEEE80211_RADIOTAP_FHSS = 4,
196 IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
197 IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
198 IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
199 IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
200 IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
201 IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
202 IEEE80211_RADIOTAP_ANTENNA = 11,
203 IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
204 IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
Marcelo Tosatti876c9d32007-02-10 12:25:27 -0200205 IEEE80211_RADIOTAP_RX_FLAGS = 14,
206 IEEE80211_RADIOTAP_TX_FLAGS = 15,
207 IEEE80211_RADIOTAP_RTS_RETRIES = 16,
208 IEEE80211_RADIOTAP_DATA_RETRIES = 17,
209 IEEE80211_RADIOTAP_EXT = 31
James Ketrenos3905ec42005-09-21 11:56:42 -0500210};
211
212/* Channel flags. */
213#define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */
214#define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */
215#define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */
216#define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */
217#define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */
218#define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */
219#define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */
220#define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */
221
222/* For IEEE80211_RADIOTAP_FLAGS */
223#define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received
224 * during CFP
225 */
226#define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received
227 * with short
228 * preamble
229 */
230#define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received
231 * with WEP encryption
232 */
233#define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received
234 * with fragmentation
235 */
236#define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */
237#define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between
238 * 802.11 header and payload
239 * (to 32-bit boundary)
240 */
Marcelo Tosatti876c9d32007-02-10 12:25:27 -0200241/* For IEEE80211_RADIOTAP_RX_FLAGS */
242#define IEEE80211_RADIOTAP_F_RX_BADFCS 0x0001 /* frame failed crc check */
243
244/* For IEEE80211_RADIOTAP_TX_FLAGS */
245#define IEEE80211_RADIOTAP_F_TX_FAIL 0x0001 /* failed due to excessive
246 * retries */
247#define IEEE80211_RADIOTAP_F_TX_CTS 0x0002 /* used cts 'protection' */
248#define IEEE80211_RADIOTAP_F_TX_RTS 0x0004 /* used rts/cts handshake */
James Ketrenos3905ec42005-09-21 11:56:42 -0500249
250/* Ugly macro to convert literal channel numbers into their mhz equivalents
251 * There are certianly some conditions that will break this (like feeding it '30')
252 * but they shouldn't arise since nothing talks on channel 30. */
253#define ieee80211chan2mhz(x) \
254 (((x) <= 14) ? \
255 (((x) == 14) ? 2484 : ((x) * 5) + 2407) : \
256 ((x) + 1000) * 5)
257
258#endif /* IEEE80211_RADIOTAP_H */