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