Moep Library  2.0-nc
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
ieee80211_radiotap.h
1 /*
2  * Copyright (c) 2003, 2004 David Young. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * 3. The name of David Young may not be used to endorse or promote
13  * products derived from this software without specific prior
14  * written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
18  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
19  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID
20  * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
22  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
27  * OF SUCH DAMAGE.
28  */
29 
30 /*
31  * Modifications to fit into the linux IEEE 802.11 stack,
32  * Mike Kershaw (dragorn@kismetwireless.net)
33  *
34  * 2013 - Modifications to fit user space
35  * Maurice Leclaire <leclaire@in.tum.de>
36  *
37  * 2013 - VHT
38  * Maurice Leclaire <leclaire@in.tum.de>
39  */
40 
41 #ifndef __MOEP80211_IEEE80211_RADIOTAP_H
42 #define __MOEP80211_IEEE80211_RADIOTAP_H
43 
44 #include <moep/types.h>
45 
46 
47 /* Base version of the radiotap packet header data */
48 #define PKTHDR_RADIOTAP_VERSION 0
49 
50 /* A generic radio capture format is desirable. There is one for
51  * Linux, but it is neither rigidly defined (there were not even
52  * units given for some fields) nor easily extensible.
53  *
54  * I suggest the following extensible radio capture format. It is
55  * based on a bitmap indicating which fields are present.
56  *
57  * I am trying to describe precisely what the application programmer
58  * should expect in the following, and for that reason I tell the
59  * units and origin of each measurement (where it applies), or else I
60  * use sufficiently weaselly language ("is a monotonically nondecreasing
61  * function of...") that I cannot set false expectations for lawyerly
62  * readers.
63  */
64 
65 /*
66  * The radio capture header precedes the 802.11 header.
67  * All data in the header is little endian on all platforms.
68  */
70  u8 it_version; /* Version 0. Only increases
71  * for drastic changes,
72  * introduction of compatible
73  * new fields does not count.
74  */
75  u8 it_pad;
76  u16 it_len; /* length of the whole
77  * header in bytes, including
78  * it_version, it_pad,
79  * it_len, and data fields.
80  */
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
86  * by setting bit 31.
87  */
88 } __attribute__((packed));
89 
90 /* Name Data type Units
91  * ---- --------- -----
92  *
93  * IEEE80211_RADIOTAP_TSFT __le64 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 __le16 MHz, bitmap
100  *
101  * Tx/Rx frequency in MHz, followed by flags (see below).
102  *
103  * IEEE80211_RADIOTAP_FHSS __le16 see below
104  *
105  * For frequency-hopping radios, the hop set (first byte)
106  * and pattern (second byte).
107  *
108  * IEEE80211_RADIOTAP_RATE u8 500kb/s
109  *
110  * Tx/Rx data rate
111  *
112  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL s8 decibels from
113  * one milliwatt (dBm)
114  *
115  * RF signal power at the antenna, decibel difference from
116  * one milliwatt.
117  *
118  * IEEE80211_RADIOTAP_DBM_ANTNOISE s8 decibels from
119  * one milliwatt (dBm)
120  *
121  * RF noise power at the antenna, decibel difference from one
122  * milliwatt.
123  *
124  * IEEE80211_RADIOTAP_DB_ANTSIGNAL u8 decibel (dB)
125  *
126  * RF signal power at the antenna, decibel difference from an
127  * arbitrary, fixed reference.
128  *
129  * IEEE80211_RADIOTAP_DB_ANTNOISE u8 decibel (dB)
130  *
131  * RF noise power at the antenna, decibel difference from an
132  * arbitrary, fixed reference point.
133  *
134  * IEEE80211_RADIOTAP_LOCK_QUALITY __le16 unitless
135  *
136  * Quality of Barker code lock. Unitless. Monotonically
137  * nondecreasing with "better" lock strength. Called "Signal
138  * Quality" in datasheets. (Is there a standard way to measure
139  * this?)
140  *
141  * IEEE80211_RADIOTAP_TX_ATTENUATION __le16 unitless
142  *
143  * Transmit power expressed as unitless distance from max
144  * power set at factory calibration. 0 is max power.
145  * Monotonically nondecreasing with lower power levels.
146  *
147  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION __le16 decibels (dB)
148  *
149  * Transmit power expressed as decibel distance from max power
150  * set at factory calibration. 0 is max power. Monotonically
151  * nondecreasing with lower power levels.
152  *
153  * IEEE80211_RADIOTAP_DBM_TX_POWER s8 decibels from
154  * one milliwatt (dBm)
155  *
156  * Transmit power expressed as dBm (decibels from a 1 milliwatt
157  * reference). This is the absolute power level measured at
158  * the antenna port.
159  *
160  * IEEE80211_RADIOTAP_FLAGS u8 bitmap
161  *
162  * Properties of transmitted and received frames. See flags
163  * defined below.
164  *
165  * IEEE80211_RADIOTAP_ANTENNA u8 antenna index
166  *
167  * Unitless indication of the Rx/Tx antenna for this packet.
168  * The first antenna is antenna 0.
169  *
170  * IEEE80211_RADIOTAP_RX_FLAGS __le16 bitmap
171  *
172  * Properties of received frames. See flags defined below.
173  *
174  * IEEE80211_RADIOTAP_TX_FLAGS __le16 bitmap
175  *
176  * Properties of transmitted frames. See flags defined below.
177  *
178  * IEEE80211_RADIOTAP_RTS_RETRIES u8 data
179  *
180  * Number of rts retries a transmitted frame used.
181  *
182  * IEEE80211_RADIOTAP_DATA_RETRIES u8 data
183  *
184  * Number of unicast retries a transmitted frame used.
185  *
186  * IEEE80211_RADIOTAP_MCS u8, u8, u8 unitless
187  *
188  * Contains a bitmap of known fields/flags, the flags, and
189  * the MCS index.
190  *
191  * IEEE80211_RADIOTAP_AMPDU_STATUS u32, u16, u8, u8 unitless
192  *
193  * Contains the AMPDU information for the subframe.
194  *
195  * IEEE80211_RADIOTAP_VHT u16, u8, u8, u8[4], u8, u8, u16 unitless
196  *
197  * Contains known, flags, bandwidth, mcs_nss, coding, group_id, and
198  * partial_aid.
199  */
200 enum ieee80211_radiotap_type {
201  IEEE80211_RADIOTAP_TSFT = 0,
202  IEEE80211_RADIOTAP_FLAGS = 1,
203  IEEE80211_RADIOTAP_RATE = 2,
204  IEEE80211_RADIOTAP_CHANNEL = 3,
205  IEEE80211_RADIOTAP_FHSS = 4,
206  IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
207  IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
208  IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
209  IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
210  IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
211  IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
212  IEEE80211_RADIOTAP_ANTENNA = 11,
213  IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
214  IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
215  IEEE80211_RADIOTAP_RX_FLAGS = 14,
216  IEEE80211_RADIOTAP_TX_FLAGS = 15,
217  IEEE80211_RADIOTAP_RTS_RETRIES = 16,
218  IEEE80211_RADIOTAP_DATA_RETRIES = 17,
219  IEEE80211_RADIOTAP_XCHANNEL = 18,
220  IEEE80211_RADIOTAP_MCS = 19,
221  IEEE80211_RADIOTAP_AMPDU_STATUS = 20,
222  IEEE80211_RADIOTAP_VHT = 21,
223 
224  /* valid in every it_present bitmap, even vendor namespaces */
225  IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29,
226  IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30,
227  IEEE80211_RADIOTAP_EXT = 31
228 };
229 
230 /* Channel flags. */
231 #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */
232 #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */
233 #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */
234 #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */
235 #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */
236 #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */
237 #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */
238 #define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */
239 
240 /* For IEEE80211_RADIOTAP_FLAGS */
241 #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received
242  * during CFP
243  */
244 #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received
245  * with short
246  * preamble
247  */
248 #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received
249  * with WEP encryption
250  */
251 #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received
252  * with fragmentation
253  */
254 #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */
255 #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between
256  * 802.11 header and payload
257  * (to 32-bit boundary)
258  */
259 #define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* bad FCS */
260 
261 /* For IEEE80211_RADIOTAP_RX_FLAGS */
262 #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002 /* frame has bad PLCP */
263 
264 /* For IEEE80211_RADIOTAP_TX_FLAGS */
265 #define IEEE80211_RADIOTAP_F_TX_FAIL 0x0001 /* failed due to excessive
266  * retries */
267 #define IEEE80211_RADIOTAP_F_TX_CTS 0x0002 /* used cts 'protection' */
268 #define IEEE80211_RADIOTAP_F_TX_RTS 0x0004 /* used rts/cts handshake */
269 #define IEEE80211_RADIOTAP_F_TX_NOACK 0x0008 /* don't expect an ack */
270 
271 
272 /* For IEEE80211_RADIOTAP_MCS */
273 #define IEEE80211_RADIOTAP_MCS_HAVE_BW 0x01
274 #define IEEE80211_RADIOTAP_MCS_HAVE_MCS 0x02
275 #define IEEE80211_RADIOTAP_MCS_HAVE_GI 0x04
276 #define IEEE80211_RADIOTAP_MCS_HAVE_FMT 0x08
277 #define IEEE80211_RADIOTAP_MCS_HAVE_FEC 0x10
278 
279 #define IEEE80211_RADIOTAP_MCS_BW_MASK 0x03
280 #define IEEE80211_RADIOTAP_MCS_BW_20 0
281 #define IEEE80211_RADIOTAP_MCS_BW_40 1
282 #define IEEE80211_RADIOTAP_MCS_BW_20L 2
283 #define IEEE80211_RADIOTAP_MCS_BW_20U 3
284 #define IEEE80211_RADIOTAP_MCS_SGI 0x04
285 #define IEEE80211_RADIOTAP_MCS_FMT_GF 0x08
286 #define IEEE80211_RADIOTAP_MCS_FEC_LDPC 0x10
287 
288 /* For IEEE80211_RADIOTAP_AMPDU_STATUS */
289 #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001
290 #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002
291 #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004
292 #define IEEE80211_RADIOTAP_AMPDU_IS_LAST 0x0008
293 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR 0x0010
294 #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020
295 
296 /* For IEEE80211_RADIOTAP_VHT */
297 #define IEEE80211_RADIOTAP_VHT_KNOWN_STBC 0x0001
298 #define IEEE80211_RADIOTAP_VHT_KNOWN_TXOP_PS_NA 0x0002
299 #define IEEE80211_RADIOTAP_VHT_KNOWN_GI 0x0004
300 #define IEEE80211_RADIOTAP_VHT_KNOWN_SGI_NSYM_DIS 0x0008
301 #define IEEE80211_RADIOTAP_VHT_KNOWN_LDPC_EXTRA_OFDM_SYM 0x0010
302 #define IEEE80211_RADIOTAP_VHT_KNOWN_BEAMFORMED 0x0020
303 #define IEEE80211_RADIOTAP_VHT_KNOWN_BANDWIDTH 0x0040
304 #define IEEE80211_RADIOTAP_VHT_KNOWN_GROUP_ID 0x0080
305 #define IEEE80211_RADIOTAP_VHT_KNOWN_PARTIAL_AID 0x0100
306 
307 #define IEEE80211_RADIOTAP_VHT_FLAG_STBC 0x01
308 #define IEEE80211_RADIOTAP_VHT_FLAG_TXOP_PS_NA 0x02
309 #define IEEE80211_RADIOTAP_VHT_FLAG_SGI 0x04
310 #define IEEE80211_RADIOTAP_VHT_FLAG_SGI_NSYM_M10_9 0x08
311 #define IEEE80211_RADIOTAP_VHT_FLAG_LDPC_EXTRA_OFDM_SYM 0x10
312 #define IEEE80211_RADIOTAP_VHT_FLAG_BEAMFORMED 0x20
313 
314 #define IEEE80211_RADIOTAP_VHT_BW_MASK 0x1f
315 #define IEEE80211_RADIOTAP_VHT_BW_20 0
316 #define IEEE80211_RADIOTAP_VHT_BW_40 1
317 #define IEEE80211_RADIOTAP_VHT_BW_20L 2
318 #define IEEE80211_RADIOTAP_VHT_BW_20U 3
319 #define IEEE80211_RADIOTAP_VHT_BW_80 4
320 #define IEEE80211_RADIOTAP_VHT_BW_40L 5
321 #define IEEE80211_RADIOTAP_VHT_BW_40U 6
322 #define IEEE80211_RADIOTAP_VHT_BW_20LL 7
323 #define IEEE80211_RADIOTAP_VHT_BW_20LU 8
324 #define IEEE80211_RADIOTAP_VHT_BW_20UL 9
325 #define IEEE80211_RADIOTAP_VHT_BW_20UU 10
326 #define IEEE80211_RADIOTAP_VHT_BW_160 11
327 #define IEEE80211_RADIOTAP_VHT_BW_80L 12
328 #define IEEE80211_RADIOTAP_VHT_BW_80U 13
329 #define IEEE80211_RADIOTAP_VHT_BW_40LL 14
330 #define IEEE80211_RADIOTAP_VHT_BW_40LU 15
331 #define IEEE80211_RADIOTAP_VHT_BW_40UL 16
332 #define IEEE80211_RADIOTAP_VHT_BW_40UU 17
333 #define IEEE80211_RADIOTAP_VHT_BW_20LLL 18
334 #define IEEE80211_RADIOTAP_VHT_BW_20LLU 19
335 #define IEEE80211_RADIOTAP_VHT_BW_20LUL 20
336 #define IEEE80211_RADIOTAP_VHT_BW_20LUU 21
337 #define IEEE80211_RADIOTAP_VHT_BW_20ULL 22
338 #define IEEE80211_RADIOTAP_VHT_BW_20ULU 23
339 #define IEEE80211_RADIOTAP_VHT_BW_20UUL 24
340 #define IEEE80211_RADIOTAP_VHT_BW_20UUU 25
341 
342 #define IEEE80211_RADIOTAP_VHT_NSS_MASK 0x0f
343 #define IEEE80211_RADIOTAP_VHT_MCS_MASK 0xf0
344 
345 #define IEEE80211_RADIOTAP_VHT_COD_0 0x01
346 #define IEEE80211_RADIOTAP_VHT_COD_1 0x02
347 #define IEEE80211_RADIOTAP_VHT_COD_2 0x04
348 #define IEEE80211_RADIOTAP_VHT_COD_3 0x08
349 
350 #endif /* __MOEP80211_IEEE80211_RADIOTAP_H */
Definition: ieee80211_radiotap.h:69