_ieee80211.h revision 1.10.38.2 1 /* $NetBSD: _ieee80211.h,v 1.10.38.2 2018/06/28 21:23:01 phil Exp $ */
2
3 /*-
4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 *
6 * Copyright (c) 2001 Atsushi Onoe
7 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32 #ifndef _NET80211__IEEE80211_H_
33 #define _NET80211__IEEE80211_H_
34
35 /*
36 * 802.11 implementation definitions.
37 *
38 * NB: this file is used by applications.
39 */
40
41 /*
42 * PHY type; mostly used to identify FH phys.
43 */
44 enum ieee80211_phytype {
45 IEEE80211_T_DS, /* direct sequence spread spectrum */
46 IEEE80211_T_FH, /* frequency hopping */
47 IEEE80211_T_OFDM, /* frequency division multiplexing */
48 IEEE80211_T_TURBO, /* high rate OFDM, aka turbo mode */
49 IEEE80211_T_HT, /* high throughput */
50 IEEE80211_T_OFDM_HALF, /* 1/2 rate OFDM */
51 IEEE80211_T_OFDM_QUARTER, /* 1/4 rate OFDM */
52 IEEE80211_T_VHT, /* VHT PHY */
53 };
54 #define IEEE80211_T_CCK IEEE80211_T_DS /* more common nomenclature */
55
56 /*
57 * PHY mode; this is not really a mode as multi-mode devices
58 * have multiple PHY's. Mode is mostly used as a shorthand
59 * for constraining which channels to consider in setting up
60 * operation. Modes used to be used more extensively when
61 * channels were identified as IEEE channel numbers.
62 */
63 enum ieee80211_phymode {
64 IEEE80211_MODE_AUTO = 0, /* autoselect */
65 IEEE80211_MODE_11A = 1, /* 5GHz, OFDM */
66 IEEE80211_MODE_11B = 2, /* 2GHz, CCK */
67 IEEE80211_MODE_11G = 3, /* 2GHz, OFDM */
68 IEEE80211_MODE_FH = 4, /* 2GHz, GFSK */
69 IEEE80211_MODE_TURBO_A = 5, /* 5GHz, OFDM, 2x clock */
70 IEEE80211_MODE_TURBO_G = 6, /* 2GHz, OFDM, 2x clock */
71 IEEE80211_MODE_STURBO_A = 7, /* 5GHz, OFDM, 2x clock, static */
72 IEEE80211_MODE_11NA = 8, /* 5GHz, w/ HT */
73 IEEE80211_MODE_11NG = 9, /* 2GHz, w/ HT */
74 IEEE80211_MODE_HALF = 10, /* OFDM, 1/2x clock */
75 IEEE80211_MODE_QUARTER = 11, /* OFDM, 1/4x clock */
76 IEEE80211_MODE_VHT_2GHZ = 12, /* 2GHz, VHT */
77 IEEE80211_MODE_VHT_5GHZ = 13, /* 5GHz, VHT */
78 };
79 #define IEEE80211_MODE_MAX (IEEE80211_MODE_VHT_5GHZ+1)
80 #define IEEE80211_MODE_BYTES howmany(IEEE80211_MODE_MAX, NBBY)
81
82 /*
83 * Operating mode. Devices do not necessarily support
84 * all modes; they indicate which are supported in their
85 * capabilities.
86 */
87 enum ieee80211_opmode {
88 IEEE80211_M_IBSS = 0, /* IBSS (adhoc) station */
89 IEEE80211_M_STA = 1, /* infrastructure station */
90 IEEE80211_M_WDS = 2, /* WDS link */
91 IEEE80211_M_AHDEMO = 3, /* Old lucent compatible adhoc demo */
92 IEEE80211_M_HOSTAP = 4, /* Software Access Point */
93 IEEE80211_M_MONITOR = 5, /* Monitor mode */
94 IEEE80211_M_MBSS = 6, /* MBSS (Mesh Point) link */
95 };
96 #define IEEE80211_OPMODE_MAX (IEEE80211_M_MBSS+1)
97
98 /*
99 * 802.11g/802.11n protection mode.
100 */
101 enum ieee80211_protmode {
102 IEEE80211_PROT_NONE = 0, /* no protection */
103 IEEE80211_PROT_CTSONLY = 1, /* CTS to self */
104 IEEE80211_PROT_RTSCTS = 2, /* RTS-CTS */
105 };
106
107 /*
108 * Authentication mode. The open and shared key authentication
109 * modes are implemented within the 802.11 layer. 802.1x and
110 * WPA/802.11i are implemented in user mode by setting the
111 * 802.11 layer into IEEE80211_AUTH_8021X and deferring
112 * authentication to user space programs.
113 */
114 enum ieee80211_authmode {
115 IEEE80211_AUTH_NONE = 0,
116 IEEE80211_AUTH_OPEN = 1, /* open */
117 IEEE80211_AUTH_SHARED = 2, /* shared-key */
118 IEEE80211_AUTH_8021X = 3, /* 802.1x */
119 IEEE80211_AUTH_AUTO = 4, /* auto-select/accept */
120 /* NB: these are used only for ioctls */
121 IEEE80211_AUTH_WPA = 5, /* WPA/RSN w/ 802.1x/PSK */
122 };
123
124 /*
125 * Roaming mode is effectively who controls the operation
126 * of the 802.11 state machine when operating as a station.
127 * State transitions are controlled either by the driver
128 * (typically when management frames are processed by the
129 * hardware/firmware), the host (auto/normal operation of
130 * the 802.11 layer), or explicitly through ioctl requests
131 * when applications like wpa_supplicant want control.
132 */
133 enum ieee80211_roamingmode {
134 IEEE80211_ROAMING_DEVICE= 0, /* driver/hardware control */
135 IEEE80211_ROAMING_AUTO = 1, /* 802.11 layer control */
136 IEEE80211_ROAMING_MANUAL= 2, /* application control */
137 };
138
139 /*
140 * Channels are specified by frequency and attributes.
141 */
142 struct ieee80211_channel {
143 uint32_t ic_flags; /* see below */
144 uint16_t ic_freq; /* primary centre frequency in MHz */
145 uint8_t ic_ieee; /* IEEE channel number */
146 int8_t ic_maxregpower; /* maximum regulatory tx power in dBm */
147 int8_t ic_maxpower; /* maximum tx power in .5 dBm */
148 int8_t ic_minpower; /* minimum tx power in .5 dBm */
149 uint8_t ic_state; /* dynamic state */
150 uint8_t ic_extieee; /* HT40 extension channel number */
151 int8_t ic_maxantgain; /* maximum antenna gain in .5 dBm */
152 uint8_t ic_pad;
153 uint16_t ic_devdata; /* opaque device/driver data */
154 uint8_t ic_vht_ch_freq1; /* VHT primary freq1 IEEE value */
155 uint8_t ic_vht_ch_freq2; /* VHT secondary 80MHz freq2 IEEE value */
156 uint16_t ic_freq2; /* VHT secondary 80MHz freq2 MHz */
157 };
158
159 /*
160 * Note: for VHT operation we will need significantly more than
161 * IEEE80211_CHAN_MAX channels because of the combinations of
162 * VHT20, VHT40, VHT80, VHT80+80 and VHT160.
163 */
164 #define IEEE80211_CHAN_MAX 1024
165 #define IEEE80211_CHAN_BYTES howmany(IEEE80211_CHAN_MAX, NBBY)
166 #define IEEE80211_CHAN_ANY 0xffff /* token for ``any channel'' */
167 #define IEEE80211_CHAN_ANYC \
168 ((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
169
170 /* channel attributes */
171 #define IEEE80211_CHAN_PRIV0 0x00000001 /* driver private bit 0 */
172 #define IEEE80211_CHAN_PRIV1 0x00000002 /* driver private bit 1 */
173 #define IEEE80211_CHAN_PRIV2 0x00000004 /* driver private bit 2 */
174 #define IEEE80211_CHAN_PRIV3 0x00000008 /* driver private bit 3 */
175 #define IEEE80211_CHAN_TURBO 0x00000010 /* Turbo channel */
176 #define IEEE80211_CHAN_CCK 0x00000020 /* CCK channel */
177 #define IEEE80211_CHAN_OFDM 0x00000040 /* OFDM channel */
178 #define IEEE80211_CHAN_2GHZ 0x00000080 /* 2 GHz spectrum channel. */
179 #define IEEE80211_CHAN_5GHZ 0x00000100 /* 5 GHz spectrum channel */
180 #define IEEE80211_CHAN_PASSIVE 0x00000200 /* Only passive scan allowed */
181 #define IEEE80211_CHAN_DYN 0x00000400 /* Dynamic CCK-OFDM channel */
182 #define IEEE80211_CHAN_GFSK 0x00000800 /* GFSK channel (FHSS PHY) */
183 #define IEEE80211_CHAN_GSM 0x00001000 /* 900 MHz spectrum channel */
184 #define IEEE80211_CHAN_STURBO 0x00002000 /* 11a static turbo channel only */
185 #define IEEE80211_CHAN_HALF 0x00004000 /* Half rate channel */
186 #define IEEE80211_CHAN_QUARTER 0x00008000 /* Quarter rate channel */
187 #define IEEE80211_CHAN_HT20 0x00010000 /* HT 20 channel */
188 #define IEEE80211_CHAN_HT40U 0x00020000 /* HT 40 channel w/ ext above */
189 #define IEEE80211_CHAN_HT40D 0x00040000 /* HT 40 channel w/ ext below */
190 #define IEEE80211_CHAN_DFS 0x00080000 /* DFS required */
191 #define IEEE80211_CHAN_4MSXMIT 0x00100000 /* 4ms limit on frame length */
192 #define IEEE80211_CHAN_NOADHOC 0x00200000 /* adhoc mode not allowed */
193 #define IEEE80211_CHAN_NOHOSTAP 0x00400000 /* hostap mode not allowed */
194 #define IEEE80211_CHAN_11D 0x00800000 /* 802.11d required */
195 #define IEEE80211_CHAN_VHT20 0x01000000 /* VHT20 channel */
196 #define IEEE80211_CHAN_VHT40U 0x02000000 /* VHT40 channel, ext above */
197 #define IEEE80211_CHAN_VHT40D 0x04000000 /* VHT40 channel, ext below */
198 #define IEEE80211_CHAN_VHT80 0x08000000 /* VHT80 channel */
199 #define IEEE80211_CHAN_VHT80_80 0x10000000 /* VHT80+80 channel */
200 #define IEEE80211_CHAN_VHT160 0x20000000 /* VHT160 channel */
201 /* XXX note: 0x80000000 is used in src/sbin/ifconfig/ifieee80211.c :( */
202
203 #define IEEE80211_CHAN_HT40 (IEEE80211_CHAN_HT40U | IEEE80211_CHAN_HT40D)
204 #define IEEE80211_CHAN_HT (IEEE80211_CHAN_HT20 | IEEE80211_CHAN_HT40)
205
206 #define IEEE80211_CHAN_VHT40 (IEEE80211_CHAN_VHT40U | IEEE80211_CHAN_VHT40D)
207 #define IEEE80211_CHAN_VHT (IEEE80211_CHAN_VHT20 | IEEE80211_CHAN_VHT40 \
208 | IEEE80211_CHAN_VHT80 | IEEE80211_CHAN_VHT80_80 \
209 | IEEE80211_CHAN_VHT160)
210
211 #define IEEE80211_CHAN_BITS \
212 "\20\1PRIV0\2PRIV2\3PRIV3\4PRIV4\5TURBO\6CCK\7OFDM\0102GHZ\0115GHZ" \
213 "\12PASSIVE\13DYN\14GFSK\15GSM\16STURBO\17HALF\20QUARTER\21HT20" \
214 "\22HT40U\23HT40D\24DFS\0254MSXMIT\26NOADHOC\27NOHOSTAP\03011D" \
215 "\031VHT20\032VHT40U\033VHT40D\034VHT80\035VHT80_80\036VHT160"
216
217 /*
218 * Useful combinations of channel characteristics.
219 */
220 #define IEEE80211_CHAN_FHSS \
221 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
222 #define IEEE80211_CHAN_A \
223 (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
224 #define IEEE80211_CHAN_B \
225 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
226 #define IEEE80211_CHAN_PUREG \
227 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
228 #define IEEE80211_CHAN_G \
229 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
230 #define IEEE80211_CHAN_108A \
231 (IEEE80211_CHAN_A | IEEE80211_CHAN_TURBO)
232 #define IEEE80211_CHAN_108G \
233 (IEEE80211_CHAN_PUREG | IEEE80211_CHAN_TURBO)
234 #define IEEE80211_CHAN_ST \
235 (IEEE80211_CHAN_108A | IEEE80211_CHAN_STURBO)
236
237 #define IEEE80211_CHAN_ALL \
238 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_GFSK | \
239 IEEE80211_CHAN_CCK | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_DYN | \
240 IEEE80211_CHAN_HALF | IEEE80211_CHAN_QUARTER | \
241 IEEE80211_CHAN_HT | IEEE80211_CHAN_VHT)
242 #define IEEE80211_CHAN_ALLTURBO \
243 (IEEE80211_CHAN_ALL | IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO)
244
245 #define IEEE80211_IS_CHAN_FHSS(_c) \
246 (((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
247 #define IEEE80211_IS_CHAN_A(_c) \
248 (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
249 #define IEEE80211_IS_CHAN_B(_c) \
250 (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
251 #define IEEE80211_IS_CHAN_PUREG(_c) \
252 (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
253 #define IEEE80211_IS_CHAN_G(_c) \
254 (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
255 #define IEEE80211_IS_CHAN_ANYG(_c) \
256 (IEEE80211_IS_CHAN_PUREG(_c) || IEEE80211_IS_CHAN_G(_c))
257 #define IEEE80211_IS_CHAN_ST(_c) \
258 (((_c)->ic_flags & IEEE80211_CHAN_ST) == IEEE80211_CHAN_ST)
259 #define IEEE80211_IS_CHAN_108A(_c) \
260 (((_c)->ic_flags & IEEE80211_CHAN_108A) == IEEE80211_CHAN_108A)
261 #define IEEE80211_IS_CHAN_108G(_c) \
262 (((_c)->ic_flags & IEEE80211_CHAN_108G) == IEEE80211_CHAN_108G)
263
264 #define IEEE80211_IS_CHAN_2GHZ(_c) \
265 (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
266 #define IEEE80211_IS_CHAN_5GHZ(_c) \
267 (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
268 #define IEEE80211_IS_CHAN_PASSIVE(_c) \
269 (((_c)->ic_flags & IEEE80211_CHAN_PASSIVE) != 0)
270 #define IEEE80211_IS_CHAN_OFDM(_c) \
271 (((_c)->ic_flags & (IEEE80211_CHAN_OFDM | IEEE80211_CHAN_DYN)) != 0)
272 #define IEEE80211_IS_CHAN_CCK(_c) \
273 (((_c)->ic_flags & (IEEE80211_CHAN_CCK | IEEE80211_CHAN_DYN)) != 0)
274 #define IEEE80211_IS_CHAN_DYN(_c) \
275 (((_c)->ic_flags & IEEE80211_CHAN_DYN) == IEEE80211_CHAN_DYN)
276 #define IEEE80211_IS_CHAN_GFSK(_c) \
277 (((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
278 #define IEEE80211_IS_CHAN_TURBO(_c) \
279 (((_c)->ic_flags & IEEE80211_CHAN_TURBO) != 0)
280 #define IEEE80211_IS_CHAN_STURBO(_c) \
281 (((_c)->ic_flags & IEEE80211_CHAN_STURBO) != 0)
282 #define IEEE80211_IS_CHAN_DTURBO(_c) \
283 (((_c)->ic_flags & \
284 (IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO)) == IEEE80211_CHAN_TURBO)
285 #define IEEE80211_IS_CHAN_HALF(_c) \
286 (((_c)->ic_flags & IEEE80211_CHAN_HALF) != 0)
287 #define IEEE80211_IS_CHAN_QUARTER(_c) \
288 (((_c)->ic_flags & IEEE80211_CHAN_QUARTER) != 0)
289 #define IEEE80211_IS_CHAN_FULL(_c) \
290 (((_c)->ic_flags & (IEEE80211_CHAN_QUARTER | IEEE80211_CHAN_HALF)) == 0)
291 #define IEEE80211_IS_CHAN_GSM(_c) \
292 (((_c)->ic_flags & IEEE80211_CHAN_GSM) != 0)
293 #define IEEE80211_IS_CHAN_HT(_c) \
294 (((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
295 #define IEEE80211_IS_CHAN_HT20(_c) \
296 (((_c)->ic_flags & IEEE80211_CHAN_HT20) != 0)
297 #define IEEE80211_IS_CHAN_HT40(_c) \
298 (((_c)->ic_flags & IEEE80211_CHAN_HT40) != 0)
299 #define IEEE80211_IS_CHAN_HT40U(_c) \
300 (((_c)->ic_flags & IEEE80211_CHAN_HT40U) != 0)
301 #define IEEE80211_IS_CHAN_HT40D(_c) \
302 (((_c)->ic_flags & IEEE80211_CHAN_HT40D) != 0)
303 #define IEEE80211_IS_CHAN_HTA(_c) \
304 (IEEE80211_IS_CHAN_5GHZ(_c) && \
305 ((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
306 #define IEEE80211_IS_CHAN_HTG(_c) \
307 (IEEE80211_IS_CHAN_2GHZ(_c) && \
308 ((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
309 #define IEEE80211_IS_CHAN_DFS(_c) \
310 (((_c)->ic_flags & IEEE80211_CHAN_DFS) != 0)
311 #define IEEE80211_IS_CHAN_NOADHOC(_c) \
312 (((_c)->ic_flags & IEEE80211_CHAN_NOADHOC) != 0)
313 #define IEEE80211_IS_CHAN_NOHOSTAP(_c) \
314 (((_c)->ic_flags & IEEE80211_CHAN_NOHOSTAP) != 0)
315 #define IEEE80211_IS_CHAN_11D(_c) \
316 (((_c)->ic_flags & IEEE80211_CHAN_11D) != 0)
317
318 #define IEEE80211_IS_CHAN_VHT(_c) \
319 (((_c)->ic_flags & IEEE80211_CHAN_VHT) != 0)
320 #define IEEE80211_IS_CHAN_VHT_2GHZ(_c) \
321 (IEEE80211_IS_CHAN_2GHZ(_c) && \
322 ((_c)->ic_flags & IEEE80211_CHAN_VHT) != 0)
323 #define IEEE80211_IS_CHAN_VHT_5GHZ(_c) \
324 (IEEE80211_IS_CHAN_5GHZ(_c) && \
325 ((_c)->ic_flags & IEEE80211_CHAN_VHT) != 0)
326 #define IEEE80211_IS_CHAN_VHT20(_c) \
327 (((_c)->ic_flags & IEEE80211_CHAN_VHT20) != 0)
328 #define IEEE80211_IS_CHAN_VHT40(_c) \
329 (((_c)->ic_flags & IEEE80211_CHAN_VHT40) != 0)
330 #define IEEE80211_IS_CHAN_VHT40U(_c) \
331 (((_c)->ic_flags & IEEE80211_CHAN_VHT40U) != 0)
332 #define IEEE80211_IS_CHAN_VHT40D(_c) \
333 (((_c)->ic_flags & IEEE80211_CHAN_VHT40D) != 0)
334 #define IEEE80211_IS_CHAN_VHTA(_c) \
335 (IEEE80211_IS_CHAN_5GHZ(_c) && \
336 ((_c)->ic_flags & IEEE80211_CHAN_VHT) != 0)
337 #define IEEE80211_IS_CHAN_VHTG(_c) \
338 (IEEE80211_IS_CHAN_2GHZ(_c) && \
339 ((_c)->ic_flags & IEEE80211_CHAN_VHT) != 0)
340 #define IEEE80211_IS_CHAN_VHT80(_c) \
341 (((_c)->ic_flags & IEEE80211_CHAN_VHT80) != 0)
342 #define IEEE80211_IS_CHAN_VHT80_80(_c) \
343 (((_c)->ic_flags & IEEE80211_CHAN_VHT80_80) != 0)
344 #define IEEE80211_IS_CHAN_VHT160(_c) \
345 (((_c)->ic_flags & IEEE80211_CHAN_VHT160) != 0)
346
347 #define IEEE80211_CHAN2IEEE(_c) (_c)->ic_ieee
348
349 /* dynamic state */
350 #define IEEE80211_CHANSTATE_RADAR 0x01 /* radar detected */
351 #define IEEE80211_CHANSTATE_CACDONE 0x02 /* CAC completed */
352 #define IEEE80211_CHANSTATE_CWINT 0x04 /* interference detected */
353 #define IEEE80211_CHANSTATE_NORADAR 0x10 /* post notify on radar clear */
354
355 #define IEEE80211_IS_CHAN_RADAR(_c) \
356 (((_c)->ic_state & IEEE80211_CHANSTATE_RADAR) != 0)
357 #define IEEE80211_IS_CHAN_CACDONE(_c) \
358 (((_c)->ic_state & IEEE80211_CHANSTATE_CACDONE) != 0)
359 #define IEEE80211_IS_CHAN_CWINT(_c) \
360 (((_c)->ic_state & IEEE80211_CHANSTATE_CWINT) != 0)
361
362 /* ni_chan encoding for FH phy */
363 #define IEEE80211_FH_CHANMOD 80
364 #define IEEE80211_FH_CHAN(set,pat) (((set)-1)*IEEE80211_FH_CHANMOD+(pat))
365 #define IEEE80211_FH_CHANSET(chan) ((chan)/IEEE80211_FH_CHANMOD+1)
366 #define IEEE80211_FH_CHANPAT(chan) ((chan)%IEEE80211_FH_CHANMOD)
367
368 #define IEEE80211_TID_SIZE (WME_NUM_TID+1) /* WME TID's +1 for non-QoS */
369 #define IEEE80211_NONQOS_TID WME_NUM_TID /* index for non-QoS sta */
370
371 /*
372 * The 802.11 spec says at most 2007 stations may be
373 * associated at once. For most AP's this is way more
374 * than is feasible so we use a default of 128. This
375 * number may be overridden by the driver and/or by
376 * user configuration but may not be less than IEEE80211_AID_MIN.
377 */
378 #define IEEE80211_AID_DEF 128
379 #define IEEE80211_AID_MIN 16
380
381 /*
382 * 802.11 rate set.
383 */
384 #define IEEE80211_RATE_SIZE 8 /* 802.11 standard */
385 #define IEEE80211_RATE_MAXSIZE 15 /* max rates we'll handle */
386
387 struct ieee80211_rateset {
388 uint8_t rs_nrates;
389 uint8_t rs_rates[IEEE80211_RATE_MAXSIZE];
390 };
391
392 /*
393 * 802.11n variant of ieee80211_rateset. Instead of
394 * legacy rates the entries are MCS rates. We define
395 * the structure such that it can be used interchangeably
396 * with an ieee80211_rateset (modulo structure size).
397 */
398 #define IEEE80211_HTRATE_MAXSIZE 77
399
400 struct ieee80211_htrateset {
401 uint8_t rs_nrates;
402 uint8_t rs_rates[IEEE80211_HTRATE_MAXSIZE];
403 };
404
405 #define IEEE80211_RATE_MCS 0x80
406
407 /*
408 * Per-mode transmit parameters/controls visible to user space.
409 * These can be used to set fixed transmit rate for all operating
410 * modes or on a per-client basis according to the capabilities
411 * of the client (e.g. an 11b client associated to an 11g ap).
412 *
413 * MCS are distinguished from legacy rates by or'ing in 0x80.
414 */
415 struct ieee80211_txparam {
416 uint8_t ucastrate; /* ucast data rate (legacy/MCS|0x80) */
417 uint8_t mgmtrate; /* mgmt frame rate (legacy/MCS|0x80) */
418 uint8_t mcastrate; /* multicast rate (legacy/MCS|0x80) */
419 uint8_t maxretry; /* max unicast data retry count */
420 };
421
422 /*
423 * Per-mode roaming state visible to user space. There are two
424 * thresholds that control whether roaming is considered; when
425 * either is exceeded the 802.11 layer will check the scan cache
426 * for another AP. If the cache is stale then a scan may be
427 * triggered.
428 */
429 struct ieee80211_roamparam {
430 int8_t rssi; /* rssi thresh (.5 dBm) */
431 uint8_t rate; /* tx rate thresh (.5 Mb/s or MCS) */
432 uint16_t pad; /* reserve */
433 };
434
435 /*
436 * Regulatory Information.
437 */
438 struct ieee80211_regdomain {
439 uint16_t regdomain; /* SKU */
440 uint16_t country; /* ISO country code */
441 uint8_t location; /* I (indoor), O (outdoor), other */
442 uint8_t ecm; /* Extended Channel Mode */
443 char isocc[2]; /* country code string */
444 short pad[2];
445 };
446
447 /*
448 * MIMO antenna/radio state.
449 */
450 #define IEEE80211_MAX_CHAINS 4
451 /*
452 * This is the number of sub-channels for a channel.
453 * 0 - pri20
454 * 1 - sec20 (HT40, VHT40)
455 * 2 - sec40 (VHT80)
456 * 3 - sec80 (VHT80+80, VHT160)
457 */
458 #define IEEE80211_MAX_CHAIN_PRISEC 4
459 #define IEEE80211_MAX_EVM_DWORDS 16 /* 16 pilots, 4 chains */
460 #define IEEE80211_MAX_EVM_PILOTS 16 /* 468 subcarriers, 16 pilots */
461
462 struct ieee80211_mimo_chan_info {
463 int8_t rssi[IEEE80211_MAX_CHAIN_PRISEC];
464 int8_t noise[IEEE80211_MAX_CHAIN_PRISEC];
465 };
466
467 struct ieee80211_mimo_info {
468 struct ieee80211_mimo_chan_info ch[IEEE80211_MAX_CHAINS];
469 uint32_t evm[IEEE80211_MAX_EVM_DWORDS];
470 };
471
472 /*
473 * ic_caps/iv_caps: device driver capabilities
474 */
475 /* 0x2e available */
476 #define IEEE80211_C_STA 0x00000001 /* CAPABILITY: STA available */
477 #define IEEE80211_C_8023ENCAP 0x00000002 /* CAPABILITY: 802.3 encap */
478 #define IEEE80211_C_FF 0x00000040 /* CAPABILITY: ATH FF avail */
479 #define IEEE80211_C_TURBOP 0x00000080 /* CAPABILITY: ATH Turbo avail*/
480 #define IEEE80211_C_IBSS 0x00000100 /* CAPABILITY: IBSS available */
481 #define IEEE80211_C_PMGT 0x00000200 /* CAPABILITY: Power mgmt */
482 #define IEEE80211_C_HOSTAP 0x00000400 /* CAPABILITY: HOSTAP avail */
483 #define IEEE80211_C_AHDEMO 0x00000800 /* CAPABILITY: Old Adhoc Demo */
484 #define IEEE80211_C_SWRETRY 0x00001000 /* CAPABILITY: sw tx retry */
485 #define IEEE80211_C_TXPMGT 0x00002000 /* CAPABILITY: tx power mgmt */
486 #define IEEE80211_C_SHSLOT 0x00004000 /* CAPABILITY: short slottime */
487 #define IEEE80211_C_SHPREAMBLE 0x00008000 /* CAPABILITY: short preamble */
488 #define IEEE80211_C_MONITOR 0x00010000 /* CAPABILITY: monitor mode */
489 #define IEEE80211_C_DFS 0x00020000 /* CAPABILITY: DFS/radar avail*/
490 #define IEEE80211_C_MBSS 0x00040000 /* CAPABILITY: MBSS available */
491 #define IEEE80211_C_SWSLEEP 0x00080000 /* CAPABILITY: do sleep here */
492 #define IEEE80211_C_SWAMSDUTX 0x00100000 /* CAPABILITY: software A-MSDU TX */
493 /* 0x7c0000 available */
494 #define IEEE80211_C_WPA1 0x00800000 /* CAPABILITY: WPA1 avail */
495 #define IEEE80211_C_WPA2 0x01000000 /* CAPABILITY: WPA2 avail */
496 #define IEEE80211_C_WPA 0x01800000 /* CAPABILITY: WPA1+WPA2 avail*/
497 #define IEEE80211_C_BURST 0x02000000 /* CAPABILITY: frame bursting */
498 #define IEEE80211_C_WME 0x04000000 /* CAPABILITY: WME avail */
499 #define IEEE80211_C_WDS 0x08000000 /* CAPABILITY: 4-addr support */
500 /* 0x10000000 reserved */
501 #define IEEE80211_C_BGSCAN 0x20000000 /* CAPABILITY: bg scanning */
502 #define IEEE80211_C_TXFRAG 0x40000000 /* CAPABILITY: tx fragments */
503 #define IEEE80211_C_TDMA 0x80000000 /* CAPABILITY: TDMA avail */
504 /* XXX protection/barker? */
505
506 #define IEEE80211_C_OPMODE \
507 (IEEE80211_C_STA | IEEE80211_C_IBSS | IEEE80211_C_HOSTAP | \
508 IEEE80211_C_AHDEMO | IEEE80211_C_MONITOR | IEEE80211_C_WDS | \
509 IEEE80211_C_TDMA | IEEE80211_C_MBSS)
510
511 #define IEEE80211_C_BITS \
512 "\20\1STA\002803ENCAP\7FF\10TURBOP\11IBSS\12PMGT" \
513 "\13HOSTAP\14AHDEMO\15SWRETRY\16TXPMGT\17SHSLOT\20SHPREAMBLE" \
514 "\21MONITOR\22DFS\23MBSS\30WPA1\31WPA2\32BURST\33WME\34WDS\36BGSCAN" \
515 "\37TXFRAG\40TDMA"
516
517 /*
518 * ic_htcaps/iv_htcaps: HT-specific device/driver capabilities
519 *
520 * NB: the low 16-bits are the 802.11 definitions, the upper
521 * 16-bits are used to define s/w/driver capabilities.
522 */
523 #define IEEE80211_HTC_AMPDU 0x00010000 /* CAPABILITY: A-MPDU tx */
524 #define IEEE80211_HTC_AMSDU 0x00020000 /* CAPABILITY: A-MSDU tx */
525 /* NB: HT40 is implied by IEEE80211_HTCAP_CHWIDTH40 */
526 #define IEEE80211_HTC_HT 0x00040000 /* CAPABILITY: HT operation */
527 #define IEEE80211_HTC_SMPS 0x00080000 /* CAPABILITY: MIMO power save*/
528 #define IEEE80211_HTC_RIFS 0x00100000 /* CAPABILITY: RIFS support */
529 #define IEEE80211_HTC_RXUNEQUAL 0x00200000 /* CAPABILITY: RX unequal MCS */
530 #define IEEE80211_HTC_RXMCS32 0x00400000 /* CAPABILITY: MCS32 support */
531 #define IEEE80211_HTC_TXUNEQUAL 0x00800000 /* CAPABILITY: TX unequal MCS */
532 #define IEEE80211_HTC_TXMCS32 0x01000000 /* CAPABILITY: MCS32 support */
533 #define IEEE80211_HTC_TXLDPC 0x02000000 /* CAPABILITY: TX using LDPC */
534
535 #define IEEE80211_C_HTCAP_BITS \
536 "\20\1LDPC\2CHWIDTH40\5GREENFIELD\6SHORTGI20\7SHORTGI40\10TXSTBC" \
537 "\21AMPDU\22AMSDU\23HT\24SMPS\25RIFS\32TXLDPC"
538
539 /*
540 * RX status notification - which fields are valid.
541 */
542 #define IEEE80211_R_NF 0x00000001 /* global NF value valid */
543 #define IEEE80211_R_RSSI 0x00000002 /* global RSSI value valid */
544 #define IEEE80211_R_C_CHAIN 0x00000004 /* RX chain count valid */
545 #define IEEE80211_R_C_NF 0x00000008 /* per-chain NF value valid */
546 #define IEEE80211_R_C_RSSI 0x00000010 /* per-chain RSSI value valid */
547 #define IEEE80211_R_C_EVM 0x00000020 /* per-chain EVM valid */
548 #define IEEE80211_R_C_HT40 0x00000040 /* RX'ed packet is 40mhz, pilots 4,5 valid */
549 #define IEEE80211_R_FREQ 0x00000080 /* Freq value populated, MHz */
550 #define IEEE80211_R_IEEE 0x00000100 /* IEEE value populated */
551 #define IEEE80211_R_BAND 0x00000200 /* Frequency band populated */
552 #define IEEE80211_R_TSF32 0x00004000 /* 32 bit TSF */
553 #define IEEE80211_R_TSF64 0x00008000 /* 64 bit TSF */
554 #define IEEE80211_R_TSF_START 0x00010000 /* TSF is sampled at start of frame */
555 #define IEEE80211_R_TSF_END 0x00020000 /* TSF is sampled at end of frame */
556
557 /*
558 * RX status notification - describe the packet.
559 */
560 #define IEEE80211_RX_F_STBC 0x00000001
561 #define IEEE80211_RX_F_LDPC 0x00000002
562 #define IEEE80211_RX_F_AMSDU 0x00000004 /* This is the start of an decap AMSDU list */
563 #define IEEE80211_RX_F_AMSDU_MORE 0x00000008 /* This is another decap AMSDU frame in the batch */
564 #define IEEE80211_RX_F_AMPDU 0x00000010 /* This is the start of an decap AMPDU list */
565 #define IEEE80211_RX_F_AMPDU_MORE 0x00000020 /* This is another decap AMPDU frame in the batch */
566 #define IEEE80211_RX_F_FAIL_FCSCRC 0x00000040 /* Failed CRC/FCS */
567 #define IEEE80211_RX_F_FAIL_MIC 0x00000080 /* Failed MIC check */
568 #define IEEE80211_RX_F_DECRYPTED 0x00000100 /* Hardware decrypted */
569 #define IEEE80211_RX_F_IV_STRIP 0x00000200 /* Decrypted; IV stripped */
570 #define IEEE80211_RX_F_MMIC_STRIP 0x00000400 /* Decrypted; MMIC stripped */
571 #define IEEE80211_RX_F_SHORTGI 0x00000800 /* This is a short-GI frame */
572 #define IEEE80211_RX_F_CCK 0x00001000
573 #define IEEE80211_RX_F_OFDM 0x00002000
574 #define IEEE80211_RX_F_HT 0x00004000
575 #define IEEE80211_RX_F_VHT 0x00008000
576
577 /* Channel width */
578 #define IEEE80211_RX_FW_20MHZ 1
579 #define IEEE80211_RX_FW_40MHZ 2
580 #define IEEE80211_RX_FW_80MHZ 3
581
582 /* PHY type */
583 #define IEEE80211_RX_FP_11B 1
584 #define IEEE80211_RX_FP_11G 2
585 #define IEEE80211_RX_FP_11A 3
586 #define IEEE80211_RX_FP_11NA 4
587 #define IEEE80211_RX_FP_11NG 5
588
589 struct ieee80211_rx_stats {
590 uint32_t r_flags; /* IEEE80211_R_* flags */
591 uint32_t c_pktflags; /* IEEE80211_RX_F_* flags */
592
593 uint64_t c_rx_tsf; /* 32 or 64 bit TSF */
594
595 /* All DWORD aligned */
596 int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */
597 int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */
598 int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */
599 int16_t c_rssi_ext[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */
600
601 /* 32 bits */
602 uint8_t c_nf; /* global NF */
603 uint8_t c_rssi; /* global RSSI */
604 uint8_t c_chain; /* number of RX chains involved */
605 uint8_t c_rate; /* legacy; 11n rate code; VHT MCS */
606
607 /* 32 bits */
608 uint16_t c_freq; /* Frequency, MHz */
609 uint8_t c_ieee; /* Channel */
610 uint8_t c_width; /* channel width, FW flags above */
611
612 /* Force alignment to DWORD */
613 union {
614 uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS];
615 /* per-chain, per-pilot EVM values */
616 uint32_t __aln[8];
617 } evm;
618
619 /* 32 bits */
620 uint8_t c_phytype; /* PHY type, FW flags above */
621 uint8_t c_vhtnss; /* VHT - number of spatial streams */
622 uint8_t c_pad2[2];
623 };
624
625 struct ieee80211_rx_params {
626 struct ieee80211_rx_stats params;
627 };
628
629 #endif /* _NET80211__IEEE80211_H_ */
630