xref: /freebsd/sys/net80211/ieee80211_radiotap.h (revision 195ebc7e9e4b129de810833791a19dfb4349d6a9)
1 /* $FreeBSD$ */
2 /* $NetBSD: ieee80211_radiotap.h,v 1.16 2007/01/06 05:51:15 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 #ifndef _NET80211_IEEE80211_RADIOTAP_H_
33 #define _NET80211_IEEE80211_RADIOTAP_H_
34 
35 /* A generic radio capture format is desirable. It must be
36  * rigidly defined (e.g., units for fields should be given),
37  * and easily extensible.
38  *
39  * The following is an extensible radio capture format. It is
40  * based on a bitmap indicating which fields are present.
41  *
42  * I am trying to describe precisely what the application programmer
43  * should expect in the following, and for that reason I tell the
44  * units and origin of each measurement (where it applies), or else I
45  * use sufficiently weaselly language ("is a monotonically nondecreasing
46  * function of...") that I cannot set false expectations for lawyerly
47  * readers.
48  */
49 #if defined(__KERNEL__) || defined(_KERNEL)
50 #ifndef DLT_IEEE802_11_RADIO
51 #define	DLT_IEEE802_11_RADIO	127	/* 802.11 plus WLAN header */
52 #endif
53 #endif /* defined(__KERNEL__) || defined(_KERNEL) */
54 
55 #define	IEEE80211_RADIOTAP_HDRLEN	64	/* XXX deprecated */
56 
57 /*
58  * The radio capture header precedes the 802.11 header.
59  *
60  * Note well: all radiotap fields are little-endian.
61  */
62 struct ieee80211_radiotap_header {
63 	uint8_t		it_version;	/* Version 0. Only increases
64 					 * for drastic changes,
65 					 * introduction of compatible
66 					 * new fields does not count.
67 					 */
68 	uint8_t		it_pad;
69 	uint16_t	it_len;		/* length of the whole
70 					 * header in bytes, including
71 					 * it_version, it_pad,
72 					 * it_len, and data fields.
73 					 */
74 	uint32_t	it_present;	/* A bitmap telling which
75 					 * fields are present. Set bit 31
76 					 * (0x80000000) to extend the
77 					 * bitmap by another 32 bits.
78 					 * Additional extensions are made
79 					 * by setting bit 31.
80 					 */
81 } __packed;
82 
83 /*
84  * Name                                 Data type       Units
85  * ----                                 ---------       -----
86  *
87  * IEEE80211_RADIOTAP_TSFT              uint64_t        microseconds
88  *
89  *      Value in microseconds of the MAC's 64-bit 802.11 Time
90  *      Synchronization Function timer when the first bit of the
91  *      MPDU arrived at the MAC. For received frames, only.
92  *
93  * IEEE80211_RADIOTAP_CHANNEL           2 x uint16_t    MHz, bitmap
94  *
95  *      Tx/Rx frequency in MHz, followed by flags (see below).
96  *
97  * IEEE80211_RADIOTAP_FHSS              uint16_t        see below
98  *
99  *      For frequency-hopping radios, the hop set (first byte)
100  *      and pattern (second byte).
101  *
102  * IEEE80211_RADIOTAP_RATE              uint8_t         500kb/s or index
103  *
104  *      Tx/Rx data rate.  If bit 0x80 is set then it represents an
105  *	an MCS index and not an IEEE rate.
106  *
107  * IEEE80211_RADIOTAP_DBM_ANTSIGNAL     int8_t          decibels from
108  *                                                      one milliwatt (dBm)
109  *
110  *      RF signal power at the antenna, decibel difference from
111  *      one milliwatt.
112  *
113  * IEEE80211_RADIOTAP_DBM_ANTNOISE      int8_t          decibels from
114  *                                                      one milliwatt (dBm)
115  *
116  *      RF noise power at the antenna, decibel difference from one
117  *      milliwatt.
118  *
119  * IEEE80211_RADIOTAP_DB_ANTSIGNAL      uint8_t         decibel (dB)
120  *
121  *      RF signal power at the antenna, decibel difference from an
122  *      arbitrary, fixed reference.
123  *
124  * IEEE80211_RADIOTAP_DB_ANTNOISE       uint8_t         decibel (dB)
125  *
126  *      RF noise power at the antenna, decibel difference from an
127  *      arbitrary, fixed reference point.
128  *
129  * IEEE80211_RADIOTAP_LOCK_QUALITY      uint16_t        unitless
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  *
136  * IEEE80211_RADIOTAP_TX_ATTENUATION    uint16_t        unitless
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  *
142  * IEEE80211_RADIOTAP_DB_TX_ATTENUATION uint16_t        decibels (dB)
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  *
148  * IEEE80211_RADIOTAP_DBM_TX_POWER      int8_t          decibels from
149  *                                                      one milliwatt (dBm)
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  *
155  * IEEE80211_RADIOTAP_FLAGS             uint8_t         bitmap
156  *
157  *      Properties of transmitted and received frames. See flags
158  *      defined below.
159  *
160  * IEEE80211_RADIOTAP_ANTENNA           uint8_t         antenna index
161  *
162  *      Unitless indication of the Rx/Tx antenna for this packet.
163  *      The first antenna is antenna 0.
164  *
165  * IEEE80211_RADIOTAP_XCHANNEL          uint32_t        bitmap
166  *                                      uint16_t        MHz
167  *                                      uint8_t         channel number
168  *                                      int8_t          .5 dBm
169  *
170  *      Extended channel specification: flags (see below) followed by
171  *      frequency in MHz, the corresponding IEEE channel number, and
172  *      finally the maximum regulatory transmit power cap in .5 dBm
173  *      units.  This property supersedes IEEE80211_RADIOTAP_CHANNEL
174  *      and only one of the two should be present.
175  */
176 enum ieee80211_radiotap_type {
177 	IEEE80211_RADIOTAP_TSFT = 0,
178 	IEEE80211_RADIOTAP_FLAGS = 1,
179 	IEEE80211_RADIOTAP_RATE = 2,
180 	IEEE80211_RADIOTAP_CHANNEL = 3,
181 	IEEE80211_RADIOTAP_FHSS = 4,
182 	IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
183 	IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
184 	IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
185 	IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
186 	IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
187 	IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
188 	IEEE80211_RADIOTAP_ANTENNA = 11,
189 	IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
190 	IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
191 	/* NB: gap for netbsd definitions */
192 	IEEE80211_RADIOTAP_XCHANNEL = 18,
193 	IEEE80211_RADIOTAP_EXT = 31,
194 };
195 
196 #ifndef _KERNEL
197 /* channel attributes */
198 #define	IEEE80211_CHAN_TURBO	0x00000010 /* Turbo channel */
199 #define	IEEE80211_CHAN_CCK	0x00000020 /* CCK channel */
200 #define	IEEE80211_CHAN_OFDM	0x00000040 /* OFDM channel */
201 #define	IEEE80211_CHAN_2GHZ	0x00000080 /* 2 GHz spectrum channel. */
202 #define	IEEE80211_CHAN_5GHZ	0x00000100 /* 5 GHz spectrum channel */
203 #define	IEEE80211_CHAN_PASSIVE	0x00000200 /* Only passive scan allowed */
204 #define	IEEE80211_CHAN_DYN	0x00000400 /* Dynamic CCK-OFDM channel */
205 #define	IEEE80211_CHAN_GFSK	0x00000800 /* GFSK channel (FHSS PHY) */
206 #define	IEEE80211_CHAN_GSM	0x00001000 /* 900 MHz spectrum channel */
207 #define	IEEE80211_CHAN_STURBO	0x00002000 /* 11a static turbo channel only */
208 #define	IEEE80211_CHAN_HALF	0x00004000 /* Half rate channel */
209 #define	IEEE80211_CHAN_QUARTER	0x00008000 /* Quarter rate channel */
210 #endif /* !_KERNEL */
211 
212 /* For IEEE80211_RADIOTAP_FLAGS */
213 #define	IEEE80211_RADIOTAP_F_CFP	0x01	/* sent/received
214 						 * during CFP
215 						 */
216 #define	IEEE80211_RADIOTAP_F_SHORTPRE	0x02	/* sent/received
217 						 * with short
218 						 * preamble
219 						 */
220 #define	IEEE80211_RADIOTAP_F_WEP	0x04	/* sent/received
221 						 * with WEP encryption
222 						 */
223 #define	IEEE80211_RADIOTAP_F_FRAG	0x08	/* sent/received
224 						 * with fragmentation
225 						 */
226 #define	IEEE80211_RADIOTAP_F_FCS	0x10	/* frame includes FCS */
227 #define	IEEE80211_RADIOTAP_F_DATAPAD	0x20	/* frame has padding between
228 						 * 802.11 header and payload
229 						 * (to 32-bit boundary)
230 						 */
231 #define	IEEE80211_RADIOTAP_F_BADFCS	0x40	/* does not pass FCS check */
232 #define	IEEE80211_RADIOTAP_F_SHORTGI	0x80	/* HT short GI */
233 
234 #endif /* !_NET80211_IEEE80211_RADIOTAP_H_ */
235