Commit | Line | Data |
---|---|---|
007e5ddd | 1 | /* |
3905ec45 JK |
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 | ||
35 | #ifndef IEEE80211RADIOTAP_H | |
36 | #define IEEE80211RADIOTAP_H | |
37 | ||
38 | #include <linux/if_ether.h> | |
39 | #include <linux/kernel.h> | |
dfe6e81d | 40 | #include <asm/unaligned.h> |
3905ec45 | 41 | |
3905ec45 JK |
42 | /* Base version of the radiotap packet header data */ |
43 | #define PKTHDR_RADIOTAP_VERSION 0 | |
44 | ||
45 | /* A generic radio capture format is desirable. There is one for | |
46 | * Linux, but it is neither rigidly defined (there were not even | |
47 | * units given for some fields) nor easily extensible. | |
48 | * | |
49 | * I suggest the following extensible radio capture format. It is | |
50 | * based on a bitmap indicating which fields are present. | |
51 | * | |
52 | * I am trying to describe precisely what the application programmer | |
53 | * should expect in the following, and for that reason I tell the | |
54 | * units and origin of each measurement (where it applies), or else I | |
55 | * use sufficiently weaselly language ("is a monotonically nondecreasing | |
56 | * function of...") that I cannot set false expectations for lawyerly | |
57 | * readers. | |
58 | */ | |
59 | ||
007e5ddd JB |
60 | /* |
61 | * The radio capture header precedes the 802.11 header. | |
a0d69f22 PR |
62 | * All data in the header is little endian on all platforms. |
63 | */ | |
3905ec45 JK |
64 | struct ieee80211_radiotap_header { |
65 | u8 it_version; /* Version 0. Only increases | |
66 | * for drastic changes, | |
67 | * introduction of compatible | |
68 | * new fields does not count. | |
69 | */ | |
70 | u8 it_pad; | |
a0d69f22 | 71 | __le16 it_len; /* length of the whole |
3905ec45 JK |
72 | * header in bytes, including |
73 | * it_version, it_pad, | |
74 | * it_len, and data fields. | |
75 | */ | |
a0d69f22 | 76 | __le32 it_present; /* A bitmap telling which |
3905ec45 JK |
77 | * fields are present. Set bit 31 |
78 | * (0x80000000) to extend the | |
79 | * bitmap by another 32 bits. | |
80 | * Additional extensions are made | |
81 | * by setting bit 31. | |
82 | */ | |
6a86b9c7 | 83 | } __packed; |
3905ec45 | 84 | |
a0d69f22 PR |
85 | /* Name Data type Units |
86 | * ---- --------- ----- | |
3905ec45 | 87 | * |
a0d69f22 | 88 | * IEEE80211_RADIOTAP_TSFT __le64 microseconds |
3905ec45 JK |
89 | * |
90 | * Value in microseconds of the MAC's 64-bit 802.11 Time | |
91 | * Synchronization Function timer when the first bit of the | |
92 | * MPDU arrived at the MAC. For received frames, only. | |
93 | * | |
a0d69f22 | 94 | * IEEE80211_RADIOTAP_CHANNEL 2 x __le16 MHz, bitmap |
3905ec45 JK |
95 | * |
96 | * Tx/Rx frequency in MHz, followed by flags (see below). | |
97 | * | |
a0d69f22 | 98 | * IEEE80211_RADIOTAP_FHSS __le16 see below |
3905ec45 JK |
99 | * |
100 | * For frequency-hopping radios, the hop set (first byte) | |
101 | * and pattern (second byte). | |
102 | * | |
a0d69f22 | 103 | * IEEE80211_RADIOTAP_RATE u8 500kb/s |
3905ec45 JK |
104 | * |
105 | * Tx/Rx data rate | |
106 | * | |
a0d69f22 PR |
107 | * IEEE80211_RADIOTAP_DBM_ANTSIGNAL s8 decibels from |
108 | * one milliwatt (dBm) | |
3905ec45 JK |
109 | * |
110 | * RF signal power at the antenna, decibel difference from | |
111 | * one milliwatt. | |
112 | * | |
a0d69f22 PR |
113 | * IEEE80211_RADIOTAP_DBM_ANTNOISE s8 decibels from |
114 | * one milliwatt (dBm) | |
3905ec45 JK |
115 | * |
116 | * RF noise power at the antenna, decibel difference from one | |
117 | * milliwatt. | |
118 | * | |
a0d69f22 | 119 | * IEEE80211_RADIOTAP_DB_ANTSIGNAL u8 decibel (dB) |
3905ec45 JK |
120 | * |
121 | * RF signal power at the antenna, decibel difference from an | |
122 | * arbitrary, fixed reference. | |
123 | * | |
a0d69f22 | 124 | * IEEE80211_RADIOTAP_DB_ANTNOISE u8 decibel (dB) |
3905ec45 JK |
125 | * |
126 | * RF noise power at the antenna, decibel difference from an | |
127 | * arbitrary, fixed reference point. | |
128 | * | |
a0d69f22 | 129 | * IEEE80211_RADIOTAP_LOCK_QUALITY __le16 unitless |
3905ec45 JK |
130 | * |
131 | * Quality of Barker code lock. Unitless. Monotonically | |
132 | * nondecreasing with "better" lock strength. Called "Signal | |
133 | * Quality" in datasheets. (Is there a standard way to measure | |
134 | * this?) | |
135 | * | |
a0d69f22 | 136 | * IEEE80211_RADIOTAP_TX_ATTENUATION __le16 unitless |
3905ec45 JK |
137 | * |
138 | * Transmit power expressed as unitless distance from max | |
139 | * power set at factory calibration. 0 is max power. | |
140 | * Monotonically nondecreasing with lower power levels. | |
141 | * | |
a0d69f22 | 142 | * IEEE80211_RADIOTAP_DB_TX_ATTENUATION __le16 decibels (dB) |
3905ec45 JK |
143 | * |
144 | * Transmit power expressed as decibel distance from max power | |
145 | * set at factory calibration. 0 is max power. Monotonically | |
146 | * nondecreasing with lower power levels. | |
147 | * | |
a0d69f22 PR |
148 | * IEEE80211_RADIOTAP_DBM_TX_POWER s8 decibels from |
149 | * one milliwatt (dBm) | |
3905ec45 JK |
150 | * |
151 | * Transmit power expressed as dBm (decibels from a 1 milliwatt | |
152 | * reference). This is the absolute power level measured at | |
153 | * the antenna port. | |
154 | * | |
a0d69f22 | 155 | * IEEE80211_RADIOTAP_FLAGS u8 bitmap |
3905ec45 JK |
156 | * |
157 | * Properties of transmitted and received frames. See flags | |
158 | * defined below. | |
159 | * | |
a0d69f22 | 160 | * IEEE80211_RADIOTAP_ANTENNA u8 antenna index |
3905ec45 JK |
161 | * |
162 | * Unitless indication of the Rx/Tx antenna for this packet. | |
163 | * The first antenna is antenna 0. | |
164 | * | |
a0d69f22 | 165 | * IEEE80211_RADIOTAP_RX_FLAGS __le16 bitmap |
876c9d3a MT |
166 | * |
167 | * Properties of received frames. See flags defined below. | |
168 | * | |
a0d69f22 | 169 | * IEEE80211_RADIOTAP_TX_FLAGS __le16 bitmap |
876c9d3a MT |
170 | * |
171 | * Properties of transmitted frames. See flags defined below. | |
172 | * | |
a0d69f22 | 173 | * IEEE80211_RADIOTAP_RTS_RETRIES u8 data |
876c9d3a MT |
174 | * |
175 | * Number of rts retries a transmitted frame used. | |
176 | * | |
a0d69f22 | 177 | * IEEE80211_RADIOTAP_DATA_RETRIES u8 data |
876c9d3a MT |
178 | * |
179 | * Number of unicast retries a transmitted frame used. | |
180 | * | |
6d744bac JB |
181 | * IEEE80211_RADIOTAP_MCS u8, u8, u8 unitless |
182 | * | |
183 | * Contains a bitmap of known fields/flags, the flags, and | |
184 | * the MCS index. | |
185 | * | |
48613ece JB |
186 | * IEEE80211_RADIOTAP_AMPDU_STATUS u32, u16, u8, u8 unitless |
187 | * | |
188 | * Contains the AMPDU information for the subframe. | |
51648921 JB |
189 | * |
190 | * IEEE80211_RADIOTAP_VHT u16, u8, u8, u8[4], u8, u8, u16 | |
191 | * | |
192 | * Contains VHT information about this frame. | |
3905ec45 JK |
193 | */ |
194 | enum ieee80211_radiotap_type { | |
195 | IEEE80211_RADIOTAP_TSFT = 0, | |
196 | IEEE80211_RADIOTAP_FLAGS = 1, | |
197 | IEEE80211_RADIOTAP_RATE = 2, | |
198 | IEEE80211_RADIOTAP_CHANNEL = 3, | |
199 | IEEE80211_RADIOTAP_FHSS = 4, | |
200 | IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5, | |
201 | IEEE80211_RADIOTAP_DBM_ANTNOISE = 6, | |
202 | IEEE80211_RADIOTAP_LOCK_QUALITY = 7, | |
203 | IEEE80211_RADIOTAP_TX_ATTENUATION = 8, | |
204 | IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9, | |
205 | IEEE80211_RADIOTAP_DBM_TX_POWER = 10, | |
206 | IEEE80211_RADIOTAP_ANTENNA = 11, | |
207 | IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12, | |
208 | IEEE80211_RADIOTAP_DB_ANTNOISE = 13, | |
876c9d3a MT |
209 | IEEE80211_RADIOTAP_RX_FLAGS = 14, |
210 | IEEE80211_RADIOTAP_TX_FLAGS = 15, | |
211 | IEEE80211_RADIOTAP_RTS_RETRIES = 16, | |
212 | IEEE80211_RADIOTAP_DATA_RETRIES = 17, | |
33e5a2f7 | 213 | |
6d744bac | 214 | IEEE80211_RADIOTAP_MCS = 19, |
48613ece | 215 | IEEE80211_RADIOTAP_AMPDU_STATUS = 20, |
51648921 | 216 | IEEE80211_RADIOTAP_VHT = 21, |
6d744bac | 217 | |
33e5a2f7 JB |
218 | /* valid in every it_present bitmap, even vendor namespaces */ |
219 | IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29, | |
220 | IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30, | |
876c9d3a | 221 | IEEE80211_RADIOTAP_EXT = 31 |
3905ec45 JK |
222 | }; |
223 | ||
224 | /* Channel flags. */ | |
225 | #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */ | |
226 | #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */ | |
227 | #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */ | |
228 | #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */ | |
229 | #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */ | |
230 | #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */ | |
231 | #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */ | |
232 | #define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */ | |
a5e70697 SW |
233 | #define IEEE80211_CHAN_GSM 0x1000 /* GSM (900 MHz) */ |
234 | #define IEEE80211_CHAN_STURBO 0x2000 /* Static Turbo */ | |
235 | #define IEEE80211_CHAN_HALF 0x4000 /* Half channel (10 MHz wide) */ | |
236 | #define IEEE80211_CHAN_QUARTER 0x8000 /* Quarter channel (5 MHz wide) */ | |
3905ec45 JK |
237 | |
238 | /* For IEEE80211_RADIOTAP_FLAGS */ | |
239 | #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received | |
240 | * during CFP | |
241 | */ | |
242 | #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received | |
243 | * with short | |
244 | * preamble | |
245 | */ | |
246 | #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received | |
247 | * with WEP encryption | |
248 | */ | |
249 | #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received | |
250 | * with fragmentation | |
251 | */ | |
252 | #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */ | |
253 | #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between | |
254 | * 802.11 header and payload | |
255 | * (to 32-bit boundary) | |
256 | */ | |
aae89831 JB |
257 | #define IEEE80211_RADIOTAP_F_BADFCS 0x40 /* bad FCS */ |
258 | ||
876c9d3a | 259 | /* For IEEE80211_RADIOTAP_RX_FLAGS */ |
aae89831 | 260 | #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002 /* frame has bad PLCP */ |
876c9d3a MT |
261 | |
262 | /* For IEEE80211_RADIOTAP_TX_FLAGS */ | |
263 | #define IEEE80211_RADIOTAP_F_TX_FAIL 0x0001 /* failed due to excessive | |
264 | * retries */ | |
265 | #define IEEE80211_RADIOTAP_F_TX_CTS 0x0002 /* used cts 'protection' */ | |
266 | #define IEEE80211_RADIOTAP_F_TX_RTS 0x0004 /* used rts/cts handshake */ | |
893d73f4 | 267 | #define IEEE80211_RADIOTAP_F_TX_NOACK 0x0008 /* don't expect an ack */ |
3905ec45 | 268 | |
6d744bac JB |
269 | |
270 | /* For IEEE80211_RADIOTAP_MCS */ | |
271 | #define IEEE80211_RADIOTAP_MCS_HAVE_BW 0x01 | |
272 | #define IEEE80211_RADIOTAP_MCS_HAVE_MCS 0x02 | |
273 | #define IEEE80211_RADIOTAP_MCS_HAVE_GI 0x04 | |
274 | #define IEEE80211_RADIOTAP_MCS_HAVE_FMT 0x08 | |
275 | #define IEEE80211_RADIOTAP_MCS_HAVE_FEC 0x10 | |
786677d1 | 276 | #define IEEE80211_RADIOTAP_MCS_HAVE_STBC 0x20 |
6d744bac JB |
277 | |
278 | #define IEEE80211_RADIOTAP_MCS_BW_MASK 0x03 | |
279 | #define IEEE80211_RADIOTAP_MCS_BW_20 0 | |
280 | #define IEEE80211_RADIOTAP_MCS_BW_40 1 | |
281 | #define IEEE80211_RADIOTAP_MCS_BW_20L 2 | |
282 | #define IEEE80211_RADIOTAP_MCS_BW_20U 3 | |
283 | #define IEEE80211_RADIOTAP_MCS_SGI 0x04 | |
284 | #define IEEE80211_RADIOTAP_MCS_FMT_GF 0x08 | |
285 | #define IEEE80211_RADIOTAP_MCS_FEC_LDPC 0x10 | |
786677d1 OR |
286 | #define IEEE80211_RADIOTAP_MCS_STBC_MASK 0x60 |
287 | #define IEEE80211_RADIOTAP_MCS_STBC_1 1 | |
288 | #define IEEE80211_RADIOTAP_MCS_STBC_2 2 | |
289 | #define IEEE80211_RADIOTAP_MCS_STBC_3 3 | |
290 | ||
291 | #define IEEE80211_RADIOTAP_MCS_STBC_SHIFT 5 | |
6d744bac | 292 | |
48613ece JB |
293 | /* For IEEE80211_RADIOTAP_AMPDU_STATUS */ |
294 | #define IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN 0x0001 | |
295 | #define IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN 0x0002 | |
296 | #define IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN 0x0004 | |
297 | #define IEEE80211_RADIOTAP_AMPDU_IS_LAST 0x0008 | |
298 | #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR 0x0010 | |
299 | #define IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN 0x0020 | |
6d744bac | 300 | |
51648921 JB |
301 | /* For IEEE80211_RADIOTAP_VHT */ |
302 | #define IEEE80211_RADIOTAP_VHT_KNOWN_STBC 0x0001 | |
303 | #define IEEE80211_RADIOTAP_VHT_KNOWN_TXOP_PS_NA 0x0002 | |
304 | #define IEEE80211_RADIOTAP_VHT_KNOWN_GI 0x0004 | |
305 | #define IEEE80211_RADIOTAP_VHT_KNOWN_SGI_NSYM_DIS 0x0008 | |
306 | #define IEEE80211_RADIOTAP_VHT_KNOWN_LDPC_EXTRA_OFDM_SYM 0x0010 | |
307 | #define IEEE80211_RADIOTAP_VHT_KNOWN_BEAMFORMED 0x0020 | |
308 | #define IEEE80211_RADIOTAP_VHT_KNOWN_BANDWIDTH 0x0040 | |
309 | #define IEEE80211_RADIOTAP_VHT_KNOWN_GROUP_ID 0x0080 | |
310 | #define IEEE80211_RADIOTAP_VHT_KNOWN_PARTIAL_AID 0x0100 | |
311 | ||
312 | #define IEEE80211_RADIOTAP_VHT_FLAG_STBC 0x01 | |
313 | #define IEEE80211_RADIOTAP_VHT_FLAG_TXOP_PS_NA 0x02 | |
314 | #define IEEE80211_RADIOTAP_VHT_FLAG_SGI 0x04 | |
315 | #define IEEE80211_RADIOTAP_VHT_FLAG_SGI_NSYM_M10_9 0x08 | |
316 | #define IEEE80211_RADIOTAP_VHT_FLAG_LDPC_EXTRA_OFDM_SYM 0x10 | |
317 | #define IEEE80211_RADIOTAP_VHT_FLAG_BEAMFORMED 0x20 | |
318 | ||
63c361f5 EG |
319 | #define IEEE80211_RADIOTAP_CODING_LDPC_USER0 0x01 |
320 | #define IEEE80211_RADIOTAP_CODING_LDPC_USER1 0x02 | |
321 | #define IEEE80211_RADIOTAP_CODING_LDPC_USER2 0x04 | |
322 | #define IEEE80211_RADIOTAP_CODING_LDPC_USER3 0x08 | |
51648921 | 323 | |
571ecf67 JB |
324 | /* helpers */ |
325 | static inline int ieee80211_get_radiotap_len(unsigned char *data) | |
326 | { | |
327 | struct ieee80211_radiotap_header *hdr = | |
328 | (struct ieee80211_radiotap_header *)data; | |
329 | ||
8b5ac31e | 330 | return get_unaligned_le16(&hdr->it_len); |
571ecf67 JB |
331 | } |
332 | ||
3905ec45 | 333 | #endif /* IEEE80211_RADIOTAP_H */ |