xref: /freebsd/contrib/wpa/src/utils/radiotap.h (revision 02e9120893770924227138ba49df1edb3896112a)
1 /*
2  * Copyright (c) 2017		Intel Deutschland GmbH
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 #ifndef __RADIOTAP_H
17 #define __RADIOTAP_H
18 
19 /**
20  * struct ieee82011_radiotap_header - base radiotap header
21  */
22 struct ieee80211_radiotap_header {
23 	/**
24 	 * @it_version: radiotap version, always 0
25 	 */
26 	uint8_t it_version;
27 
28 	/**
29 	 * @it_pad: padding (or alignment)
30 	 */
31 	uint8_t it_pad;
32 
33 	/**
34 	 * @it_len: overall radiotap header length
35 	 */
36 	le16 it_len;
37 
38 	/**
39 	 * @it_present: (first) present word
40 	 */
41 	le32 it_present;
42 } STRUCT_PACKED;
43 
44 /* version is always 0 */
45 #define PKTHDR_RADIOTAP_VERSION	0
46 
47 /* see the radiotap website for the descriptions */
48 enum ieee80211_radiotap_presence {
49 	IEEE80211_RADIOTAP_TSFT = 0,
50 	IEEE80211_RADIOTAP_FLAGS = 1,
51 	IEEE80211_RADIOTAP_RATE = 2,
52 	IEEE80211_RADIOTAP_CHANNEL = 3,
53 	IEEE80211_RADIOTAP_FHSS = 4,
54 	IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
55 	IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
56 	IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
57 	IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
58 	IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
59 	IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
60 	IEEE80211_RADIOTAP_ANTENNA = 11,
61 	IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
62 	IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
63 	IEEE80211_RADIOTAP_RX_FLAGS = 14,
64 	IEEE80211_RADIOTAP_TX_FLAGS = 15,
65 	IEEE80211_RADIOTAP_RTS_RETRIES = 16,
66 	IEEE80211_RADIOTAP_DATA_RETRIES = 17,
67 	/* 18 is XChannel, but it's not defined yet */
68 	IEEE80211_RADIOTAP_MCS = 19,
69 	IEEE80211_RADIOTAP_AMPDU_STATUS = 20,
70 	IEEE80211_RADIOTAP_VHT = 21,
71 	IEEE80211_RADIOTAP_TIMESTAMP = 22,
72 
73 	/* valid in every it_present bitmap, even vendor namespaces */
74 	IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29,
75 	IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30,
76 	IEEE80211_RADIOTAP_EXT = 31
77 };
78 
79 /* for IEEE80211_RADIOTAP_FLAGS */
80 enum ieee80211_radiotap_flags {
81 	IEEE80211_RADIOTAP_F_CFP = 0x01,
82 	IEEE80211_RADIOTAP_F_SHORTPRE = 0x02,
83 	IEEE80211_RADIOTAP_F_WEP = 0x04,
84 	IEEE80211_RADIOTAP_F_FRAG = 0x08,
85 	IEEE80211_RADIOTAP_F_FCS = 0x10,
86 	IEEE80211_RADIOTAP_F_DATAPAD = 0x20,
87 	IEEE80211_RADIOTAP_F_BADFCS = 0x40,
88 };
89 
90 /* for IEEE80211_RADIOTAP_CHANNEL */
91 enum ieee80211_radiotap_channel_flags {
92 	IEEE80211_CHAN_CCK = 0x0020,
93 	IEEE80211_CHAN_OFDM = 0x0040,
94 	IEEE80211_CHAN_2GHZ = 0x0080,
95 	IEEE80211_CHAN_5GHZ = 0x0100,
96 	IEEE80211_CHAN_DYN = 0x0400,
97 	IEEE80211_CHAN_HALF = 0x4000,
98 	IEEE80211_CHAN_QUARTER = 0x8000,
99 };
100 
101 /* for IEEE80211_RADIOTAP_RX_FLAGS */
102 enum ieee80211_radiotap_rx_flags {
103 	IEEE80211_RADIOTAP_F_RX_BADPLCP = 0x0002,
104 };
105 
106 /* for IEEE80211_RADIOTAP_TX_FLAGS */
107 enum ieee80211_radiotap_tx_flags {
108 	IEEE80211_RADIOTAP_F_TX_FAIL = 0x0001,
109 	IEEE80211_RADIOTAP_F_TX_CTS = 0x0002,
110 	IEEE80211_RADIOTAP_F_TX_RTS = 0x0004,
111 	IEEE80211_RADIOTAP_F_TX_NOACK = 0x0008,
112 };
113 
114 /* for IEEE80211_RADIOTAP_MCS "have" flags */
115 enum ieee80211_radiotap_mcs_have {
116 	IEEE80211_RADIOTAP_MCS_HAVE_BW = 0x01,
117 	IEEE80211_RADIOTAP_MCS_HAVE_MCS = 0x02,
118 	IEEE80211_RADIOTAP_MCS_HAVE_GI = 0x04,
119 	IEEE80211_RADIOTAP_MCS_HAVE_FMT = 0x08,
120 	IEEE80211_RADIOTAP_MCS_HAVE_FEC = 0x10,
121 	IEEE80211_RADIOTAP_MCS_HAVE_STBC = 0x20,
122 };
123 
124 enum ieee80211_radiotap_mcs_flags {
125 	IEEE80211_RADIOTAP_MCS_BW_MASK = 0x03,
126 	IEEE80211_RADIOTAP_MCS_BW_20 = 0,
127 	IEEE80211_RADIOTAP_MCS_BW_40 = 1,
128 	IEEE80211_RADIOTAP_MCS_BW_20L = 2,
129 	IEEE80211_RADIOTAP_MCS_BW_20U = 3,
130 
131 	IEEE80211_RADIOTAP_MCS_SGI = 0x04,
132 	IEEE80211_RADIOTAP_MCS_FMT_GF = 0x08,
133 	IEEE80211_RADIOTAP_MCS_FEC_LDPC = 0x10,
134 	IEEE80211_RADIOTAP_MCS_STBC_MASK = 0x60,
135 	IEEE80211_RADIOTAP_MCS_STBC_1 = 1,
136 	IEEE80211_RADIOTAP_MCS_STBC_2 = 2,
137 	IEEE80211_RADIOTAP_MCS_STBC_3 = 3,
138 	IEEE80211_RADIOTAP_MCS_STBC_SHIFT = 5,
139 };
140 
141 /* for IEEE80211_RADIOTAP_AMPDU_STATUS */
142 enum ieee80211_radiotap_ampdu_flags {
143 	IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN = 0x0001,
144 	IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN = 0x0002,
145 	IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN = 0x0004,
146 	IEEE80211_RADIOTAP_AMPDU_IS_LAST = 0x0008,
147 	IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR = 0x0010,
148 	IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN = 0x0020,
149 };
150 
151 /* for IEEE80211_RADIOTAP_VHT */
152 enum ieee80211_radiotap_vht_known {
153 	IEEE80211_RADIOTAP_VHT_KNOWN_STBC = 0x0001,
154 	IEEE80211_RADIOTAP_VHT_KNOWN_TXOP_PS_NA = 0x0002,
155 	IEEE80211_RADIOTAP_VHT_KNOWN_GI = 0x0004,
156 	IEEE80211_RADIOTAP_VHT_KNOWN_SGI_NSYM_DIS = 0x0008,
157 	IEEE80211_RADIOTAP_VHT_KNOWN_LDPC_EXTRA_OFDM_SYM = 0x0010,
158 	IEEE80211_RADIOTAP_VHT_KNOWN_BEAMFORMED = 0x0020,
159 	IEEE80211_RADIOTAP_VHT_KNOWN_BANDWIDTH = 0x0040,
160 	IEEE80211_RADIOTAP_VHT_KNOWN_GROUP_ID = 0x0080,
161 	IEEE80211_RADIOTAP_VHT_KNOWN_PARTIAL_AID = 0x0100,
162 };
163 
164 enum ieee80211_radiotap_vht_flags {
165 	IEEE80211_RADIOTAP_VHT_FLAG_STBC = 0x01,
166 	IEEE80211_RADIOTAP_VHT_FLAG_TXOP_PS_NA = 0x02,
167 	IEEE80211_RADIOTAP_VHT_FLAG_SGI = 0x04,
168 	IEEE80211_RADIOTAP_VHT_FLAG_SGI_NSYM_M10_9 = 0x08,
169 	IEEE80211_RADIOTAP_VHT_FLAG_LDPC_EXTRA_OFDM_SYM = 0x10,
170 	IEEE80211_RADIOTAP_VHT_FLAG_BEAMFORMED = 0x20,
171 };
172 
173 enum ieee80211_radiotap_vht_coding {
174 	IEEE80211_RADIOTAP_CODING_LDPC_USER0 = 0x01,
175 	IEEE80211_RADIOTAP_CODING_LDPC_USER1 = 0x02,
176 	IEEE80211_RADIOTAP_CODING_LDPC_USER2 = 0x04,
177 	IEEE80211_RADIOTAP_CODING_LDPC_USER3 = 0x08,
178 };
179 
180 /* for IEEE80211_RADIOTAP_TIMESTAMP */
181 enum ieee80211_radiotap_timestamp_unit_spos {
182 	IEEE80211_RADIOTAP_TIMESTAMP_UNIT_MASK = 0x000F,
183 	IEEE80211_RADIOTAP_TIMESTAMP_UNIT_MS = 0x0000,
184 	IEEE80211_RADIOTAP_TIMESTAMP_UNIT_US = 0x0001,
185 	IEEE80211_RADIOTAP_TIMESTAMP_UNIT_NS = 0x0003,
186 	IEEE80211_RADIOTAP_TIMESTAMP_SPOS_MASK = 0x00F0,
187 	IEEE80211_RADIOTAP_TIMESTAMP_SPOS_BEGIN_MDPU = 0x0000,
188 	IEEE80211_RADIOTAP_TIMESTAMP_SPOS_PLCP_SIG_ACQ = 0x0010,
189 	IEEE80211_RADIOTAP_TIMESTAMP_SPOS_EO_PPDU = 0x0020,
190 	IEEE80211_RADIOTAP_TIMESTAMP_SPOS_EO_MPDU = 0x0030,
191 	IEEE80211_RADIOTAP_TIMESTAMP_SPOS_UNKNOWN = 0x00F0,
192 };
193 
194 enum ieee80211_radiotap_timestamp_flags {
195 	IEEE80211_RADIOTAP_TIMESTAMP_FLAG_64BIT = 0x00,
196 	IEEE80211_RADIOTAP_TIMESTAMP_FLAG_32BIT = 0x01,
197 	IEEE80211_RADIOTAP_TIMESTAMP_FLAG_ACCURACY = 0x02,
198 };
199 
200 #endif /* __RADIOTAP_H */
201