use enum GNUNET_ATS_Network_Type instead of uint32_t where appropriate
[oweals/gnunet.git] / src / transport / 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
35 #ifndef IEEE80211RADIOTAP_H
36 #define IEEE80211RADIOTAP_H
37
38 #include <linux/if_ether.h>
39 #include <linux/kernel.h>
40 // #include <asm/unaligned.h>
41
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
60 /*
61  * The radio capture header precedes the 802.11 header.
62  * All data in the header is little endian on all platforms.
63  */
64 struct ieee80211_radiotap_header
65 {
66   u8 it_version;                /* Version 0. Only increases
67                                  * for drastic changes,
68                                  * introduction of compatible
69                                  * new fields does not count.
70                                  */
71   u8 it_pad;
72   __le16 it_len;                /* length of the whole
73                                  * header in bytes, including
74                                  * it_version, it_pad,
75                                  * it_len, and data fields.
76                                  */
77   __le32 it_present;            /* A bitmap telling which
78                                  * fields are present. Set bit 31
79                                  * (0x80000000) to extend the
80                                  * bitmap by another 32 bits.
81                                  * Additional extensions are made
82                                  * by setting bit 31.
83                                  */
84 } __packed;
85
86 /* Name                                 Data type    Units
87  * ----                                 ---------    -----
88  *
89  * IEEE80211_RADIOTAP_TSFT              __le64       microseconds
90  *
91  *      Value in microseconds of the MAC's 64-bit 802.11 Time
92  *      Synchronization Function timer when the first bit of the
93  *      MPDU arrived at the MAC. For received frames, only.
94  *
95  * IEEE80211_RADIOTAP_CHANNEL           2 x __le16   MHz, bitmap
96  *
97  *      Tx/Rx frequency in MHz, followed by flags (see below).
98  *
99  * IEEE80211_RADIOTAP_FHSS              __le16       see below
100  *
101  *      For frequency-hopping radios, the hop set (first byte)
102  *      and pattern (second byte).
103  *
104  * IEEE80211_RADIOTAP_RATE              u8           500kb/s
105  *
106  *      Tx/Rx data rate
107  *
108  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     s8           decibels from
109  *                                                   one milliwatt (dBm)
110  *
111  *      RF signal power at the antenna, decibel difference from
112  *      one milliwatt.
113  *
114  * IEEE80211_RADIOTAP_DBM_ANTNOISE      s8           decibels from
115  *                                                   one milliwatt (dBm)
116  *
117  *      RF noise power at the antenna, decibel difference from one
118  *      milliwatt.
119  *
120  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      u8           decibel (dB)
121  *
122  *      RF signal power at the antenna, decibel difference from an
123  *      arbitrary, fixed reference.
124  *
125  * IEEE80211_RADIOTAP_DB_ANTNOISE       u8           decibel (dB)
126  *
127  *      RF noise power at the antenna, decibel difference from an
128  *      arbitrary, fixed reference point.
129  *
130  * IEEE80211_RADIOTAP_LOCK_QUALITY      __le16       unitless
131  *
132  *      Quality of Barker code lock. Unitless. Monotonically
133  *      nondecreasing with "better" lock strength. Called "Signal
134  *      Quality" in datasheets.  (Is there a standard way to measure
135  *      this?)
136  *
137  * IEEE80211_RADIOTAP_TX_ATTENUATION    __le16       unitless
138  *
139  *      Transmit power expressed as unitless distance from max
140  *      power set at factory calibration.  0 is max power.
141  *      Monotonically nondecreasing with lower power levels.
142  *
143  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION __le16       decibels (dB)
144  *
145  *      Transmit power expressed as decibel distance from max power
146  *      set at factory calibration.  0 is max power.  Monotonically
147  *      nondecreasing with lower power levels.
148  *
149  * IEEE80211_RADIOTAP_DBM_TX_POWER      s8           decibels from
150  *                                                   one milliwatt (dBm)
151  *
152  *      Transmit power expressed as dBm (decibels from a 1 milliwatt
153  *      reference). This is the absolute power level measured at
154  *      the antenna port.
155  *
156  * IEEE80211_RADIOTAP_FLAGS             u8           bitmap
157  *
158  *      Properties of transmitted and received frames. See flags
159  *      defined below.
160  *
161  * IEEE80211_RADIOTAP_ANTENNA           u8           antenna index
162  *
163  *      Unitless indication of the Rx/Tx antenna for this packet.
164  *      The first antenna is antenna 0.
165  *
166  * IEEE80211_RADIOTAP_RX_FLAGS          __le16       bitmap
167  *
168  *     Properties of received frames. See flags defined below.
169  *
170  * IEEE80211_RADIOTAP_TX_FLAGS          __le16       bitmap
171  *
172  *     Properties of transmitted frames. See flags defined below.
173  *
174  * IEEE80211_RADIOTAP_RTS_RETRIES       u8           data
175  *
176  *     Number of rts retries a transmitted frame used.
177  *
178  * IEEE80211_RADIOTAP_DATA_RETRIES      u8           data
179  *
180  *     Number of unicast retries a transmitted frame used.
181  *
182  */
183 enum ieee80211_radiotap_type
184 {
185   IEEE80211_RADIOTAP_TSFT = 0,
186   IEEE80211_RADIOTAP_FLAGS = 1,
187   IEEE80211_RADIOTAP_RATE = 2,
188   IEEE80211_RADIOTAP_CHANNEL = 3,
189   IEEE80211_RADIOTAP_FHSS = 4,
190   IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
191   IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
192   IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
193   IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
194   IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
195   IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
196   IEEE80211_RADIOTAP_ANTENNA = 11,
197   IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
198   IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
199   IEEE80211_RADIOTAP_RX_FLAGS = 14,
200   IEEE80211_RADIOTAP_TX_FLAGS = 15,
201   IEEE80211_RADIOTAP_RTS_RETRIES = 16,
202   IEEE80211_RADIOTAP_DATA_RETRIES = 17,
203
204   /* valid in every it_present bitmap, even vendor namespaces */
205   IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29,
206   IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30,
207   IEEE80211_RADIOTAP_EXT = 31
208 };
209
210 /* Channel flags. */
211 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
212 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
213 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
214 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
215 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
216 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
217 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
218 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
219
220 /* For IEEE80211_RADIOTAP_FLAGS */
221 #define IEEE80211_RADIOTAP_F_CFP        0x01    /* sent/received
222                                                  * during CFP
223                                                  */
224 #define IEEE80211_RADIOTAP_F_SHORTPRE   0x02    /* sent/received
225                                                  * with short
226                                                  * preamble
227                                                  */
228 #define IEEE80211_RADIOTAP_F_WEP        0x04    /* sent/received
229                                                  * with WEP encryption
230                                                  */
231 #define IEEE80211_RADIOTAP_F_FRAG       0x08    /* sent/received
232                                                  * with fragmentation
233                                                  */
234 #define IEEE80211_RADIOTAP_F_FCS        0x10    /* frame includes FCS */
235 #define IEEE80211_RADIOTAP_F_DATAPAD    0x20    /* frame has padding between
236                                                  * 802.11 header and payload
237                                                  * (to 32-bit boundary)
238                                                  */
239 #define IEEE80211_RADIOTAP_F_BADFCS     0x40    /* bad FCS */
240
241 /* For IEEE80211_RADIOTAP_RX_FLAGS */
242 #define IEEE80211_RADIOTAP_F_RX_BADPLCP 0x0002  /* frame has bad PLCP */
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 */
249
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 /* helpers */
259 static inline u16
260 get_unaligned_le16 (const u8 *p)
261 {
262   return p[0] | p[1] << 8;
263 }
264
265
266 static inline int
267 ieee80211_get_radiotap_len (unsigned char *data)
268 {
269   struct ieee80211_radiotap_header *hdr =
270       (struct ieee80211_radiotap_header *) data;
271
272   return get_unaligned_le16 ((const u8 *) &hdr->it_len);
273 }
274
275 #endif /* IEEE80211_RADIOTAP_H */