xref: /openbsd-src/sys/net80211/ieee80211.h (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1 /*	$OpenBSD: ieee80211.h,v 1.50 2013/01/17 02:51:56 claudio Exp $	*/
2 /*	$NetBSD: ieee80211.h,v 1.6 2004/04/30 23:51:53 dyoung Exp $	*/
3 
4 /*-
5  * Copyright (c) 2001 Atsushi Onoe
6  * Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef _NET80211_IEEE80211_H_
30 #define _NET80211_IEEE80211_H_
31 
32 /*
33  * 802.11 protocol definitions.
34  */
35 
36 #define IEEE80211_ADDR_LEN	6	/* size of 802.11 address */
37 /* is 802.11 address multicast/broadcast? */
38 #define IEEE80211_IS_MULTICAST(_a)	(*(_a) & 0x01)
39 
40 /*
41  * Generic definitions for IEEE 802.11 frames.
42  */
43 struct ieee80211_frame {
44 	u_int8_t	i_fc[2];
45 	u_int8_t	i_dur[2];
46 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
47 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
48 	u_int8_t	i_addr3[IEEE80211_ADDR_LEN];
49 	u_int8_t	i_seq[2];
50 } __packed;
51 
52 struct ieee80211_qosframe {
53 	u_int8_t	i_fc[2];
54 	u_int8_t	i_dur[2];
55 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
56 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
57 	u_int8_t	i_addr3[IEEE80211_ADDR_LEN];
58 	u_int8_t	i_seq[2];
59 	u_int8_t	i_qos[2];
60 } __packed;
61 
62 struct ieee80211_htframe {		/* 11n */
63 	u_int8_t	i_fc[2];
64 	u_int8_t	i_dur[2];
65 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
66 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
67 	u_int8_t	i_addr3[IEEE80211_ADDR_LEN];
68 	u_int8_t	i_seq[2];
69 	u_int8_t	i_qos[2];
70 	u_int8_t	i_ht[4];
71 } __packed;
72 
73 struct ieee80211_frame_addr4 {
74 	u_int8_t	i_fc[2];
75 	u_int8_t	i_dur[2];
76 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
77 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
78 	u_int8_t	i_addr3[IEEE80211_ADDR_LEN];
79 	u_int8_t	i_seq[2];
80 	u_int8_t	i_addr4[IEEE80211_ADDR_LEN];
81 } __packed;
82 
83 struct ieee80211_qosframe_addr4 {
84 	u_int8_t	i_fc[2];
85 	u_int8_t	i_dur[2];
86 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
87 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
88 	u_int8_t	i_addr3[IEEE80211_ADDR_LEN];
89 	u_int8_t	i_seq[2];
90 	u_int8_t	i_addr4[IEEE80211_ADDR_LEN];
91 	u_int8_t	i_qos[2];
92 } __packed;
93 
94 struct ieee80211_htframe_addr4 {	/* 11n */
95 	u_int8_t	i_fc[2];
96 	u_int8_t	i_dur[2];
97 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
98 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
99 	u_int8_t	i_addr3[IEEE80211_ADDR_LEN];
100 	u_int8_t	i_seq[2];
101 	u_int8_t	i_addr4[IEEE80211_ADDR_LEN];
102 	u_int8_t	i_qos[2];
103 	u_int8_t	i_ht[4];
104 } __packed;
105 
106 #define	IEEE80211_FC0_VERSION_MASK		0x03
107 #define	IEEE80211_FC0_VERSION_SHIFT		0
108 #define	IEEE80211_FC0_VERSION_0			0x00
109 #define	IEEE80211_FC0_TYPE_MASK			0x0c
110 #define	IEEE80211_FC0_TYPE_SHIFT		2
111 #define	IEEE80211_FC0_TYPE_MGT			0x00
112 #define	IEEE80211_FC0_TYPE_CTL			0x04
113 #define	IEEE80211_FC0_TYPE_DATA			0x08
114 
115 #define	IEEE80211_FC0_SUBTYPE_MASK		0xf0
116 #define	IEEE80211_FC0_SUBTYPE_SHIFT		4
117 /* for TYPE_MGT */
118 #define	IEEE80211_FC0_SUBTYPE_ASSOC_REQ		0x00
119 #define	IEEE80211_FC0_SUBTYPE_ASSOC_RESP	0x10
120 #define	IEEE80211_FC0_SUBTYPE_REASSOC_REQ	0x20
121 #define	IEEE80211_FC0_SUBTYPE_REASSOC_RESP	0x30
122 #define	IEEE80211_FC0_SUBTYPE_PROBE_REQ		0x40
123 #define	IEEE80211_FC0_SUBTYPE_PROBE_RESP	0x50
124 #define	IEEE80211_FC0_SUBTYPE_BEACON		0x80
125 #define	IEEE80211_FC0_SUBTYPE_ATIM		0x90
126 #define	IEEE80211_FC0_SUBTYPE_DISASSOC		0xa0
127 #define	IEEE80211_FC0_SUBTYPE_AUTH		0xb0
128 #define	IEEE80211_FC0_SUBTYPE_DEAUTH		0xc0
129 #define IEEE80211_FC0_SUBTYPE_ACTION		0xd0
130 #define IEEE80211_FC0_SUBTYPE_ACTION_NOACK	0xe0	/* 11n */
131 /* for TYPE_CTL */
132 #define IEEE80211_FC0_SUBTYPE_WRAPPER		0x70	/* 11n */
133 #define IEEE80211_FC0_SUBTYPE_BAR		0x80
134 #define IEEE80211_FC0_SUBTYPE_BA		0x90
135 #define	IEEE80211_FC0_SUBTYPE_PS_POLL		0xa0
136 #define	IEEE80211_FC0_SUBTYPE_RTS		0xb0
137 #define	IEEE80211_FC0_SUBTYPE_CTS		0xc0
138 #define	IEEE80211_FC0_SUBTYPE_ACK		0xd0
139 #define	IEEE80211_FC0_SUBTYPE_CF_END		0xe0
140 #define	IEEE80211_FC0_SUBTYPE_CF_END_ACK	0xf0
141 /* for TYPE_DATA (bit combination) */
142 #define	IEEE80211_FC0_SUBTYPE_DATA		0x00
143 #define	IEEE80211_FC0_SUBTYPE_CF_ACK		0x10
144 #define	IEEE80211_FC0_SUBTYPE_CF_POLL		0x20
145 #define	IEEE80211_FC0_SUBTYPE_CF_ACPL		0x30
146 #define	IEEE80211_FC0_SUBTYPE_NODATA		0x40
147 #define	IEEE80211_FC0_SUBTYPE_CFACK		0x50
148 #define	IEEE80211_FC0_SUBTYPE_CFPOLL		0x60
149 #define	IEEE80211_FC0_SUBTYPE_CF_ACK_CF_ACK	0x70
150 #define	IEEE80211_FC0_SUBTYPE_QOS		0x80
151 
152 #define	IEEE80211_FC1_DIR_MASK			0x03
153 #define	IEEE80211_FC1_DIR_NODS			0x00	/* STA->STA */
154 #define	IEEE80211_FC1_DIR_TODS			0x01	/* STA->AP  */
155 #define	IEEE80211_FC1_DIR_FROMDS		0x02	/* AP ->STA */
156 #define	IEEE80211_FC1_DIR_DSTODS		0x03	/* AP ->AP  */
157 
158 #define	IEEE80211_FC1_MORE_FRAG			0x04
159 #define	IEEE80211_FC1_RETRY			0x08
160 #define	IEEE80211_FC1_PWR_MGT			0x10
161 #define	IEEE80211_FC1_MORE_DATA			0x20
162 #define	IEEE80211_FC1_PROTECTED			0x40
163 #define	IEEE80211_FC1_WEP			0x40	/* pre-RSNA compat */
164 #define	IEEE80211_FC1_ORDER			0x80
165 #define IEEE80211_FC1_BITS					\
166 	"\20\03MORE_FRAG\04RETRY\05PWR_MGT\06MORE_DATA"		\
167 	"\07PROTECTED\08ORDER"
168 
169 /*
170  * Sequence Control field (see 7.1.3.4).
171  */
172 #define	IEEE80211_SEQ_FRAG_MASK			0x000f
173 #define	IEEE80211_SEQ_FRAG_SHIFT		0
174 #define	IEEE80211_SEQ_SEQ_MASK			0xfff0
175 #define	IEEE80211_SEQ_SEQ_SHIFT			4
176 
177 #define	IEEE80211_NWID_LEN			32
178 #define IEEE80211_MMIE_LEN			18	/* 11w */
179 
180 /*
181  * QoS Control field (see 7.1.3.5).
182  */
183 #define IEEE80211_QOS_TXOP			0xff00
184 #define IEEE80211_QOS_AMSDU			0x0080	/* 11n */
185 #define IEEE80211_QOS_ACK_POLICY_NORMAL		0x0000
186 #define IEEE80211_QOS_ACK_POLICY_NOACK		0x0020
187 #define IEEE80211_QOS_ACK_POLICY_NOEXPLACK	0x0040
188 #define IEEE80211_QOS_ACK_POLICY_BA		0x0060
189 #define IEEE80211_QOS_ACK_POLICY_MASK		0x0060
190 #define IEEE80211_QOS_ACK_POLICY_SHIFT		5
191 #define IEEE80211_QOS_EOSP			0x0010
192 #define IEEE80211_QOS_TID			0x000f
193 
194 /*
195  * Control frames.
196  */
197 struct ieee80211_frame_min {
198 	u_int8_t	i_fc[2];
199 	u_int8_t	i_dur[2];
200 	u_int8_t	i_addr1[IEEE80211_ADDR_LEN];
201 	u_int8_t	i_addr2[IEEE80211_ADDR_LEN];
202 	/* FCS */
203 } __packed;
204 
205 struct ieee80211_frame_rts {
206 	u_int8_t	i_fc[2];
207 	u_int8_t	i_dur[2];
208 	u_int8_t	i_ra[IEEE80211_ADDR_LEN];
209 	u_int8_t	i_ta[IEEE80211_ADDR_LEN];
210 	/* FCS */
211 } __packed;
212 
213 struct ieee80211_frame_cts {
214 	u_int8_t	i_fc[2];
215 	u_int8_t	i_dur[2];
216 	u_int8_t	i_ra[IEEE80211_ADDR_LEN];
217 	/* FCS */
218 } __packed;
219 
220 struct ieee80211_frame_ack {
221 	u_int8_t	i_fc[2];
222 	u_int8_t	i_dur[2];
223 	u_int8_t	i_ra[IEEE80211_ADDR_LEN];
224 	/* FCS */
225 } __packed;
226 
227 struct ieee80211_frame_pspoll {
228 	u_int8_t	i_fc[2];
229 	u_int8_t	i_aid[2];
230 	u_int8_t	i_bssid[IEEE80211_ADDR_LEN];
231 	u_int8_t	i_ta[IEEE80211_ADDR_LEN];
232 	/* FCS */
233 } __packed;
234 
235 struct ieee80211_frame_cfend {		/* NB: also CF-End+CF-Ack */
236 	u_int8_t	i_fc[2];
237 	u_int8_t	i_dur[2];	/* should be zero */
238 	u_int8_t	i_ra[IEEE80211_ADDR_LEN];
239 	u_int8_t	i_bssid[IEEE80211_ADDR_LEN];
240 	/* FCS */
241 } __packed;
242 
243 #ifdef _KERNEL
244 static __inline int
245 ieee80211_has_seq(const struct ieee80211_frame *wh)
246 {
247 	return (wh->i_fc[0] & IEEE80211_FC0_TYPE_MASK) !=
248 	    IEEE80211_FC0_TYPE_CTL;
249 }
250 
251 static __inline int
252 ieee80211_has_addr4(const struct ieee80211_frame *wh)
253 {
254 	return (wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) ==
255 	    IEEE80211_FC1_DIR_DSTODS;
256 }
257 
258 static __inline int
259 ieee80211_has_qos(const struct ieee80211_frame *wh)
260 {
261 	return (wh->i_fc[0] &
262 	    (IEEE80211_FC0_TYPE_MASK | IEEE80211_FC0_SUBTYPE_QOS)) ==
263 	    (IEEE80211_FC0_TYPE_DATA | IEEE80211_FC0_SUBTYPE_QOS);
264 }
265 
266 static __inline int
267 ieee80211_has_htc(const struct ieee80211_frame *wh)
268 {
269 	return (wh->i_fc[1] & IEEE80211_FC1_ORDER) &&
270 	    (ieee80211_has_qos(wh) ||
271 	     (wh->i_fc[0] & IEEE80211_FC0_TYPE_MASK) ==
272 	     IEEE80211_FC0_TYPE_MGT);
273 }
274 
275 static __inline u_int16_t
276 ieee80211_get_qos(const struct ieee80211_frame *wh)
277 {
278 	const u_int8_t *frm;
279 
280 	if (ieee80211_has_addr4(wh))
281 		frm = ((const struct ieee80211_qosframe_addr4 *)wh)->i_qos;
282 	else
283 		frm = ((const struct ieee80211_qosframe *)wh)->i_qos;
284 
285 	return letoh16(*(const u_int16_t *)frm);
286 }
287 #endif	/* _KERNEL */
288 
289 /*
290  * Capability Information field (see 7.3.1.4).
291  */
292 #define	IEEE80211_CAPINFO_ESS			0x0001
293 #define	IEEE80211_CAPINFO_IBSS			0x0002
294 #define	IEEE80211_CAPINFO_CF_POLLABLE		0x0004
295 #define	IEEE80211_CAPINFO_CF_POLLREQ		0x0008
296 #define	IEEE80211_CAPINFO_PRIVACY		0x0010
297 #define	IEEE80211_CAPINFO_SHORT_PREAMBLE	0x0020
298 #define	IEEE80211_CAPINFO_PBCC			0x0040
299 #define	IEEE80211_CAPINFO_CHNL_AGILITY		0x0080
300 #define IEEE80211_CAPINFO_SPECTRUM_MGMT		0x0100
301 #define IEEE80211_CAPINFO_QOS			0x0200
302 #define	IEEE80211_CAPINFO_SHORT_SLOTTIME	0x0400
303 #define	IEEE80211_CAPINFO_APSD			0x0800
304 /* bit 12 is reserved */
305 #define	IEEE80211_CAPINFO_DSSSOFDM		0x2000
306 #define IEEE80211_CAPINFO_DELAYED_B_ACK		0x4000
307 #define IEEE80211_CAPINFO_IMMEDIATE_B_ACK	0x8000
308 #define IEEE80211_CAPINFO_BITS					\
309 	"\10\01ESS\02IBSS\03CF_POLLABLE\04CF_POLLREQ"		\
310 	"\05PRIVACY\06SHORT_PREAMBLE\07PBCC\10CHNL_AGILITY"	\
311 	"\11SPECTRUM_MGMT\12QOS\13SHORT_SLOTTIME\14APSD"	\
312 	"\16DSSSOFDM\17DELAYED_B_ACK\20IMMEDIATE_B_ACK"
313 
314 /*
315  * Information elements (see Table 7-26).
316  */
317 enum {
318 	IEEE80211_ELEMID_SSID			= 0,
319 	IEEE80211_ELEMID_RATES			= 1,
320 	IEEE80211_ELEMID_FHPARMS		= 2,
321 	IEEE80211_ELEMID_DSPARMS		= 3,
322 	IEEE80211_ELEMID_CFPARMS		= 4,
323 	IEEE80211_ELEMID_TIM			= 5,
324 	IEEE80211_ELEMID_IBSSPARMS		= 6,
325 	IEEE80211_ELEMID_COUNTRY		= 7,
326 	IEEE80211_ELEMID_QBSS_LOAD		= 11,
327 	IEEE80211_ELEMID_EDCAPARMS		= 12,
328 	IEEE80211_ELEMID_CHALLENGE		= 16,
329 	/* 17-31 reserved for challenge text extension */
330 	IEEE80211_ELEMID_ERP			= 42,
331 	IEEE80211_ELEMID_HTCAPS			= 45,	/* 11n */
332 	IEEE80211_ELEMID_QOS_CAP		= 46,
333 	IEEE80211_ELEMID_RSN			= 48,
334 	IEEE80211_ELEMID_XRATES			= 50,
335 	IEEE80211_ELEMID_TIE			= 56,	/* 11r */
336 	IEEE80211_ELEMID_HTOP			= 61,	/* 11n */
337 	IEEE80211_ELEMID_MMIE			= 76,	/* 11w */
338 	IEEE80211_ELEMID_TPC			= 150,
339 	IEEE80211_ELEMID_CCKM			= 156,
340 	IEEE80211_ELEMID_VENDOR			= 221	/* vendor private */
341 };
342 
343 /*
344  * Action field category values (see Table 7-24).
345  */
346 enum {
347 	IEEE80211_CATEG_SPECTRUM	= 0,
348 	IEEE80211_CATEG_QOS		= 1,
349 	IEEE80211_CATEG_DLS		= 2,
350 	IEEE80211_CATEG_BA		= 3,
351 	IEEE80211_CATEG_HT		= 7,	/* 11n */
352 	IEEE80211_CATEG_SA_QUERY	= 8	/* 11w */
353 };
354 
355 /*
356  * Block Ack Action field values (see Table 7-54).
357  */
358 #define IEEE80211_ACTION_ADDBA_REQ	0
359 #define IEEE80211_ACTION_ADDBA_RESP	1
360 #define IEEE80211_ACTION_DELBA		2
361 
362 /*
363  * SA Query Action field values (see Table 7-57l).
364  */
365 #define IEEE80211_ACTION_SA_QUERY_REQ	0
366 #define IEEE80211_ACTION_SA_QUERY_RESP	1
367 
368 /*
369  * HT Action field values (see Table 7-57m).
370  */
371 #define IEEE80211_ACTION_NOTIFYCW	0
372 
373 #define	IEEE80211_RATE_BASIC			0x80
374 #define	IEEE80211_RATE_VAL			0x7f
375 #define	IEEE80211_RATE_SIZE			8	/* 802.11 standard */
376 #define	IEEE80211_RATE_MAXSIZE			15	/* max rates we'll handle */
377 
378 /*
379  * BlockAck/BlockAckReq Control field (see Figure 7-13).
380  */
381 #define IEEE80211_BA_ACK_POLICY		0x0001
382 #define IEEE80211_BA_MULTI_TID		0x0002
383 #define IEEE80211_BA_COMPRESSED		0x0004
384 #define IEEE80211_BA_TID_INFO_MASK	0xf000
385 #define IEEE80211_BA_TID_INFO_SHIFT	12
386 
387 /*
388  * DELBA Parameter Set field (see Figure 7-34).
389  */
390 #define IEEE80211_DELBA_INITIATOR	0x0800
391 
392 /*
393  * ERP information element (see 7.3.2.13).
394  */
395 #define	IEEE80211_ERP_NON_ERP_PRESENT		0x01
396 #define	IEEE80211_ERP_USE_PROTECTION		0x02
397 #define	IEEE80211_ERP_BARKER_MODE		0x04
398 
399 /*
400  * RSN capabilities (see 7.3.2.25.3).
401  */
402 #define IEEE80211_RSNCAP_PREAUTH		0x0001
403 #define IEEE80211_RSNCAP_NOPAIRWISE		0x0002
404 #define IEEE80211_RSNCAP_PTKSA_RCNT_MASK	0x000c
405 #define IEEE80211_RSNCAP_PTKSA_RCNT_SHIFT	2
406 #define IEEE80211_RSNCAP_GTKSA_RCNT_MASK	0x0030
407 #define IEEE80211_RSNCAP_GTKSA_RCNT_SHIFT	4
408 #define IEEE80211_RSNCAP_RCNT1			0
409 #define IEEE80211_RSNCAP_RCNT2			1
410 #define IEEE80211_RSNCAP_RCNT4			2
411 #define IEEE80211_RSNCAP_RCNT16			3
412 #define IEEE80211_RSNCAP_MFPR			0x0040	/* 11w */
413 #define IEEE80211_RSNCAP_MFPC			0x0080	/* 11w */
414 #define IEEE80211_RSNCAP_PEERKEYENA		0x0200
415 #define IEEE80211_RSNCAP_SPPAMSDUC		0x0400	/* 11n */
416 #define IEEE80211_RSNCAP_SPPAMSDUR		0x0800	/* 11n */
417 #define IEEE80211_RSNCAP_PBAC			0x1000	/* 11n */
418 
419 /*
420  * HT Capabilities Info (see 7.3.2.57.2).
421  */
422 #define IEEE80211_HTCAP_LDPC		0x00000001
423 #define IEEE80211_HTCAP_CBW20_40	0x00000002
424 #define IEEE80211_HTCAP_SMPS_MASK	0x0000000c
425 #define IEEE80211_HTCAP_SMPS_SHIFT	2
426 #define IEEE80211_HTCAP_SMPS_STA	0
427 #define IEEE80211_HTCAP_SMPS_DYN	1
428 #define IEEE80211_HTCAP_SMPS_DIS	3
429 #define IEEE80211_HTCAP_GF		0x00000010
430 #define IEEE80211_HTCAP_SGI20		0x00000020
431 #define IEEE80211_HTCAP_SGI40		0x00000040
432 #define IEEE80211_HTCAP_TXSTBC		0x00000080
433 #define IEEE80211_HTCAP_RXSTBC_MASK	0x00000300
434 #define IEEE80211_HTCAP_RXSTBC_SHIFT	8
435 #define IEEE80211_HTCAP_DELAYEDBA	0x00000400
436 #define IEEE80211_HTCAP_AMSDU7935	0x00000800
437 #define IEEE80211_HTCAP_DSSSCCK40	0x00001000
438 #define IEEE80211_HTCAP_PSMP		0x00002000
439 #define IEEE80211_HTCAP_40INTOLERANT	0x00004000
440 #define IEEE80211_HTCAP_LSIGTXOPPROT	0x00008000
441 
442 /*
443  * HT Extended Capabilities (see 7.3.2.57.5).
444  */
445 #define IEEE80211_HTXCAP_PCO		0x0001
446 #define IEEE80211_HTXCAP_PCOTT_MASK	0x0006
447 #define IEEE80211_HTXCAP_PCOTT_SHIFT	1
448 #define IEEE80211_HTXCAP_PCOTT_400	1
449 #define IEEE80211_HTXCAP_PCOTT_1500	2
450 #define IEEE80211_HTXCAP_PCOTT_5000	3
451 /* Bits 3-7 are reserved. */
452 #define IEEE80211_HTXCAP_MFB_MASK	0x0300
453 #define IEEE80211_HTXCAP_MFB_SHIFT	8
454 #define IEEE80211_HTXCAP_MFB_NONE	0
455 #define IEEE80211_HTXCAP_MFB_UNSOL	2
456 #define IEEE80211_HTXCAP_MFB_BOTH	3
457 #define IEEE80211_HTXCAP_HTC		0x0400
458 #define IEEE80211_HTXCAP_RDRESP		0x0800
459 /* Bits 12-15 are reserved. */
460 
461 /*
462  * Transmit Beamforming (TxBF) Capabilities (see 7.3.2.57.6).
463  */
464 #define IEEE80211_TXBFCAP_IMPLICIT_RX	0x00000001
465 #define IEEE80211_TXBFCAP_RSSC		0x00000002
466 #define IEEE80211_TXBFCAP_TSSC		0x00000004
467 #define IEEE80211_TXBFCAP_RNDP		0x00000008
468 #define IEEE80211_TXBFCAP_TNDP		0x00000010
469 #define IEEE80211_TXBFCAP_IMPLICIT_TX	0x00000020
470 #define IEEE80211_TXBFCAP_CALIB_MASK	0x000000c0
471 #define IEEE80211_TXBFCAP_CALIB_SHIFT	6
472 #define IEEE80211_TXBFCAP_TX_CSI	0x00000100
473 
474 /*
475  * Antenna Selection (ASEL) Capability (see 7.3.2.57.7).
476  */
477 #define IEEE80211_ASELCAP_ASEL		0x01
478 #define IEEE80211_ASELCAP_CSIFB		0x02
479 /* Bit 7 is reserved. */
480 
481 /*
482  * HT Operation element (see 7.3.2.58).
483  */
484 /* Byte 1. */
485 #define IEEE80211_HTOP0_SCO_MASK	0x03
486 #define IEEE80211_HTOP0_SCO_SHIFT	0
487 #define IEEE80211_HTOP0_SCO_SCN		0
488 #define IEEE80211_HTOP0_SCO_SCA		1
489 #define IEEE80211_HTOP0_SCO_SCB		3
490 #define IEEE80211_HTOP0_CHW		0x04
491 #define IEEE80211_HTOP0_RIFS		0x08
492 #define IEEE80211_HTOP0_SPSMP		0x10
493 #define IEEE80211_HTOP0_SIG_MASK	0xe0
494 #define IEEE80211_HTOP0_SIG_SHIFT	5
495 /* Bytes 2-3. */
496 #define IEEE80211_HTOP1_PROT_MASK	0x0003
497 #define IEEE80211_HTOP1_PROT_SHIFT	0
498 #define IEEE80211_HTOP1_NONGTSTA	0x0004
499 /* Bit 3 is reserved. */
500 #define IEEE80211_HTOP1_OBSS_NONHTSTA	0x0010
501 /* Bits 5-15 are reserved. */
502 /* Bytes 4-5. */
503 /* Bits 0-5 are reserved. */
504 #define IEEE80211_HTOP2_DUALBEACON	0x0040
505 #define IEEE80211_HTOP2_DUALCTSPROT	0x0080
506 #define IEEE80211_HTOP2_STBCBEACON	0x0100
507 #define IEEE80211_HTOP2_LSIGTXOP	0x0200
508 #define IEEE80211_HTOP2_PCOACTIVE	0x0400
509 #define IEEE80211_HTOP2_PCOPHASE40	0x0800
510 /* Bits 12-15 are reserved. */
511 
512 /*
513  * EDCA Access Categories.
514  */
515 enum ieee80211_edca_ac {
516 	EDCA_AC_BK  = 1,	/* Background */
517 	EDCA_AC_BE  = 0,	/* Best Effort */
518 	EDCA_AC_VI  = 2,	/* Video */
519 	EDCA_AC_VO  = 3		/* Voice */
520 };
521 #define EDCA_NUM_AC	4
522 
523 /* number of TID values (traffic identifier) */
524 #define IEEE80211_NUM_TID	16
525 
526 /* Atheros private advanced capabilities info */
527 #define	ATHEROS_CAP_TURBO_PRIME			0x01
528 #define	ATHEROS_CAP_COMPRESSION			0x02
529 #define	ATHEROS_CAP_FAST_FRAME			0x04
530 /* bits 3-6 reserved */
531 #define	ATHEROS_CAP_BOOST			0x80
532 
533 /*-
534  * Organizationally Unique Identifiers.
535  * See http://standards.ieee.org/regauth/oui/oui.txt for a list.
536  */
537 #define ATHEROS_OUI	((const u_int8_t[]){ 0x00, 0x03, 0x7f })
538 #define BROADCOM_OUI	((const u_int8_t[]){ 0x00, 0x90, 0x4c })
539 #define IEEE80211_OUI	((const u_int8_t[]){ 0x00, 0x0f, 0xac })
540 #define MICROSOFT_OUI	((const u_int8_t[]){ 0x00, 0x50, 0xf2 })
541 
542 #define	IEEE80211_AUTH_ALGORITHM(auth) \
543 	((auth)[0] | ((auth)[1] << 8))
544 #define	IEEE80211_AUTH_TRANSACTION(auth) \
545 	((auth)[2] | ((auth)[3] << 8))
546 #define	IEEE80211_AUTH_STATUS(auth) \
547 	((auth)[4] | ((auth)[5] << 8))
548 
549 /*
550  * Authentication Algorithm Number field (see 7.3.1.1).
551  */
552 #define IEEE80211_AUTH_ALG_OPEN			0x0000
553 #define IEEE80211_AUTH_ALG_SHARED		0x0001
554 #define IEEE80211_AUTH_ALG_LEAP			0x0080
555 
556 /*
557  * Authentication Transaction Sequence Number field (see 7.3.1.2).
558  */
559 enum {
560 	IEEE80211_AUTH_OPEN_REQUEST		= 1,
561 	IEEE80211_AUTH_OPEN_RESPONSE		= 2
562 };
563 enum {
564 	IEEE80211_AUTH_SHARED_REQUEST		= 1,
565 	IEEE80211_AUTH_SHARED_CHALLENGE		= 2,
566 	IEEE80211_AUTH_SHARED_RESPONSE		= 3,
567 	IEEE80211_AUTH_SHARED_PASS		= 4
568 };
569 
570 /*
571  * Reason codes (see Table 22).
572  */
573 enum {
574 	IEEE80211_REASON_UNSPECIFIED		= 1,
575 	IEEE80211_REASON_AUTH_EXPIRE		= 2,
576 	IEEE80211_REASON_AUTH_LEAVE		= 3,
577 	IEEE80211_REASON_ASSOC_EXPIRE		= 4,
578 	IEEE80211_REASON_ASSOC_TOOMANY		= 5,
579 	IEEE80211_REASON_NOT_AUTHED		= 6,
580 	IEEE80211_REASON_NOT_ASSOCED		= 7,
581 	IEEE80211_REASON_ASSOC_LEAVE		= 8,
582 	IEEE80211_REASON_ASSOC_NOT_AUTHED	= 9,
583 
584 	/* XXX the following two reason codes are not correct */
585 	IEEE80211_REASON_RSN_REQUIRED		= 11,
586 	IEEE80211_REASON_RSN_INCONSISTENT	= 12,
587 
588 	IEEE80211_REASON_IE_INVALID		= 13,
589 	IEEE80211_REASON_MIC_FAILURE		= 14,
590 	IEEE80211_REASON_4WAY_TIMEOUT		= 15,
591 	IEEE80211_REASON_GROUP_TIMEOUT		= 16,
592 	IEEE80211_REASON_RSN_DIFFERENT_IE	= 17,
593 	IEEE80211_REASON_BAD_GROUP_CIPHER	= 18,
594 	IEEE80211_REASON_BAD_PAIRWISE_CIPHER	= 19,
595 	IEEE80211_REASON_BAD_AKMP		= 20,
596 	IEEE80211_REASON_RSN_IE_VER_UNSUP	= 21,
597 	IEEE80211_REASON_RSN_IE_BAD_CAP		= 22,
598 
599 	IEEE80211_REASON_CIPHER_REJ_POLICY	= 24,
600 
601 	IEEE80211_REASON_SETUP_REQUIRED		= 38,
602 	IEEE80211_REASON_TIMEOUT		= 39
603 };
604 
605 /*
606  * Status codes (see Table 23).
607  */
608 enum {
609 	IEEE80211_STATUS_SUCCESS		= 0,
610 	IEEE80211_STATUS_UNSPECIFIED		= 1,
611 	IEEE80211_STATUS_CAPINFO		= 10,
612 	IEEE80211_STATUS_NOT_ASSOCED		= 11,
613 	IEEE80211_STATUS_OTHER			= 12,
614 	IEEE80211_STATUS_ALG			= 13,
615 	IEEE80211_STATUS_SEQUENCE		= 14,
616 	IEEE80211_STATUS_CHALLENGE		= 15,
617 	IEEE80211_STATUS_TIMEOUT		= 16,
618 	IEEE80211_STATUS_TOOMANY		= 17,
619 	IEEE80211_STATUS_BASIC_RATE		= 18,
620 	IEEE80211_STATUS_SP_REQUIRED		= 19,
621 	IEEE80211_STATUS_PBCC_REQUIRED		= 20,
622 	IEEE80211_STATUS_CA_REQUIRED		= 21,
623 	IEEE80211_STATUS_TOO_MANY_STATIONS	= 22,
624 	IEEE80211_STATUS_RATES			= 23,
625 	IEEE80211_STATUS_SHORTSLOT_REQUIRED	= 25,
626 	IEEE80211_STATUS_DSSSOFDM_REQUIRED	= 26,
627 
628 	IEEE80211_STATUS_TRY_AGAIN_LATER	= 30,
629 	IEEE80211_STATUS_MFP_POLICY		= 31,
630 
631 	IEEE80211_STATUS_REFUSED		= 37,
632 	IEEE80211_STATUS_INVALID_PARAM		= 38,
633 
634 	IEEE80211_STATUS_IE_INVALID		= 40,
635 	IEEE80211_STATUS_BAD_GROUP_CIPHER	= 41,
636 	IEEE80211_STATUS_BAD_PAIRWISE_CIPHER	= 42,
637 	IEEE80211_STATUS_BAD_AKMP		= 43,
638 	IEEE80211_STATUS_RSN_IE_VER_UNSUP	= 44,
639 
640 	IEEE80211_STATUS_CIPHER_REJ_POLICY	= 46,
641 };
642 
643 #define	IEEE80211_WEP_KEYLEN			5	/* 40bit */
644 #define	IEEE80211_WEP_NKID			4	/* number of key ids */
645 #define IEEE80211_CHALLENGE_LEN			128
646 
647 /* WEP header constants */
648 #define	IEEE80211_WEP_IVLEN			3	/* 24bit */
649 #define	IEEE80211_WEP_KIDLEN			1	/* 1 octet */
650 #define	IEEE80211_WEP_CRCLEN			4	/* CRC-32 */
651 #define	IEEE80211_CRC_LEN			4
652 #define	IEEE80211_WEP_TOTLEN		(IEEE80211_WEP_IVLEN + \
653 					 IEEE80211_WEP_KIDLEN + \
654 					 IEEE80211_WEP_CRCLEN)
655 
656 /*
657  * 802.11i defines an extended IV for use with non-WEP ciphers.
658  * When the EXTIV bit is set in the key id byte an additional
659  * 4 bytes immediately follow the IV for TKIP.  For CCMP the
660  * EXTIV bit is likewise set but the 8 bytes represent the
661  * CCMP header rather than IV+extended-IV.
662  */
663 #define	IEEE80211_WEP_EXTIV		0x20
664 #define	IEEE80211_WEP_EXTIVLEN		4	/* extended IV length */
665 #define	IEEE80211_WEP_MICLEN		8	/* trailing MIC */
666 
667 /*
668  * Maximum acceptable MTU is:
669  *	IEEE80211_MAX_LEN - WEP overhead - CRC -
670  *		QoS overhead - RSN/WPA overhead
671  * Min is arbitrarily chosen > IEEE80211_MIN_LEN.  The default
672  * mtu is Ethernet-compatible; it's set by ether_ifattach.
673  */
674 #define	IEEE80211_MTU_MAX			2290
675 #define	IEEE80211_MTU_MIN			32
676 
677 #define	IEEE80211_MAX_LEN			(2300 + IEEE80211_CRC_LEN + \
678     (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN + IEEE80211_WEP_CRCLEN))
679 #define	IEEE80211_ACK_LEN \
680 	(sizeof(struct ieee80211_frame_ack) + IEEE80211_CRC_LEN)
681 #define	IEEE80211_MIN_LEN \
682 	(sizeof(struct ieee80211_frame_min) + IEEE80211_CRC_LEN)
683 
684 /*
685  * The 802.11 spec says at most 2007 stations may be
686  * associated at once.  For most AP's this is way more
687  * than is feasible so we use a default of 1800. This
688  * number may be overridden by the driver and/or by
689  * user configuration.
690  */
691 #define	IEEE80211_AID_MAX	2007
692 #define	IEEE80211_AID_DEF	1800
693 #define IEEE80211_AID(b)	((b) &~ 0xc000)
694 
695 /*
696  * RTS frame length parameters.  The default is specified in
697  * the 802.11 spec.  The max may be wrong for jumbo frames.
698  */
699 #define	IEEE80211_RTS_DEFAULT			512
700 #define	IEEE80211_RTS_MIN			1
701 #define	IEEE80211_RTS_MAX			IEEE80211_MAX_LEN
702 
703 #define IEEE80211_PLCP_SERVICE		0x00
704 #define IEEE80211_PLCP_SERVICE_PBCC	0x08	/* PBCC encoded */
705 #define IEEE80211_PLCP_SERVICE_LENEXT	0x80	/* length extension bit */
706 
707 /* One Time Unit (TU) is 1Kus = 1024 microseconds. */
708 #define IEEE80211_DUR_TU		1024
709 
710 /* IEEE 802.11b durations for DSSS PHY in microseconds */
711 #define IEEE80211_DUR_DS_LONG_PREAMBLE	144
712 #define IEEE80211_DUR_DS_SHORT_PREAMBLE	72
713 #define	IEEE80211_DUR_DS_PREAMBLE_DIFFERENCE	\
714     (IEEE80211_DUR_DS_LONG_PREAMBLE - IEEE80211_DUR_DS_SHORT_PREAMBLE)
715 #define IEEE80211_DUR_DS_FAST_PLCPHDR	24
716 #define IEEE80211_DUR_DS_SLOW_PLCPHDR	48
717 #define	IEEE80211_DUR_DS_PLCPHDR_DIFFERENCE	\
718     (IEEE80211_DUR_DS_SLOW_PLCPHDR - IEEE80211_DUR_DS_FAST_PLCPHDR)
719 #define IEEE80211_DUR_DS_SLOW_ACK	112
720 #define IEEE80211_DUR_DS_FAST_ACK	56
721 #define IEEE80211_DUR_DS_SLOW_CTS	112
722 #define IEEE80211_DUR_DS_FAST_CTS	56
723 #define IEEE80211_DUR_DS_SLOT		20
724 #define IEEE80211_DUR_DS_SIFS		10
725 #define IEEE80211_DUR_DS_PIFS	(IEEE80211_DUR_DS_SIFS + IEEE80211_DUR_DS_SLOT)
726 #define IEEE80211_DUR_DS_DIFS	(IEEE80211_DUR_DS_SIFS + \
727 				 2 * IEEE80211_DUR_DS_SLOT)
728 #define IEEE80211_DUR_DS_EIFS	(IEEE80211_DUR_DS_SIFS + \
729 				 IEEE80211_DUR_DS_SLOW_ACK + \
730 				 IEEE80211_DUR_DS_LONG_PREAMBLE + \
731 				 IEEE80211_DUR_DS_SLOW_PLCPHDR + \
732 				 IEEE80211_DUR_DIFS)
733 
734 /*
735  * The RSNA key descriptor used by IEEE 802.11 does not use the IEEE 802.1X
736  * key descriptor.  Instead, it uses the key descriptor described in 8.5.2.
737  */
738 #define EAPOL_KEY_NONCE_LEN	32
739 #define EAPOL_KEY_IV_LEN	16
740 #define EAPOL_KEY_MIC_LEN	16
741 
742 struct ieee80211_eapol_key {
743 	u_int8_t	version;
744 #define EAPOL_VERSION	1
745 
746 	u_int8_t	type;
747 /* IEEE Std 802.1X-2004, 7.5.4 (only type EAPOL-Key is used here) */
748 #define EAP_PACKET	0
749 #define EAPOL_START	1
750 #define EAPOL_LOGOFF	2
751 #define EAPOL_KEY	3
752 #define EAPOL_ASF_ALERT	4
753 
754 	u_int8_t	len[2];
755 	u_int8_t	desc;
756 /* IEEE Std 802.1X-2004, 7.6.1 */
757 #define EAPOL_KEY_DESC_RC4		  1	/* deprecated */
758 #define EAPOL_KEY_DESC_IEEE80211	  2
759 #define EAPOL_KEY_DESC_WPA		254	/* non-standard WPA */
760 
761 	u_int8_t	info[2];
762 #define EAPOL_KEY_VERSION_MASK	0x7
763 #define EAPOL_KEY_DESC_V1	1
764 #define EAPOL_KEY_DESC_V2	2
765 #define EAPOL_KEY_DESC_V3	3		/* 11r */
766 #define EAPOL_KEY_PAIRWISE	(1 <<  3)
767 #define EAPOL_KEY_INSTALL	(1 <<  6)	/* I */
768 #define EAPOL_KEY_KEYACK	(1 <<  7)	/* A */
769 #define EAPOL_KEY_KEYMIC	(1 <<  8)	/* M */
770 #define EAPOL_KEY_SECURE	(1 <<  9)	/* S */
771 #define EAPOL_KEY_ERROR		(1 << 10)
772 #define EAPOL_KEY_REQUEST	(1 << 11)
773 #define EAPOL_KEY_ENCRYPTED	(1 << 12)
774 #define EAPOL_KEY_SMK		(1 << 13)
775 /* WPA compatibility */
776 #define EAPOL_KEY_WPA_KID_MASK	0x3
777 #define EAPOL_KEY_WPA_KID_SHIFT	4
778 #define EAPOL_KEY_WPA_TX	EAPOL_KEY_INSTALL
779 
780 	u_int8_t	keylen[2];
781 	u_int8_t	replaycnt[8];
782 	u_int8_t	nonce[EAPOL_KEY_NONCE_LEN];
783 	u_int8_t	iv[EAPOL_KEY_IV_LEN];
784 	u_int8_t	rsc[8];
785 	u_int8_t	reserved[8];
786 	u_int8_t	mic[EAPOL_KEY_MIC_LEN];
787 	u_int8_t	paylen[2];
788 } __packed;
789 
790 /* Pairwise Transient Key (see 8.5.1.2) */
791 struct ieee80211_ptk {
792 	u_int8_t	kck[16];	/* Key Confirmation Key */
793 	u_int8_t	kek[16];	/* Key Encryption Key */
794 	u_int8_t	tk[32];		/* Temporal Key */
795 } __packed;
796 
797 #define IEEE80211_PMKID_LEN	16
798 #define IEEE80211_SMKID_LEN	16
799 
800 /*
801  * Key Data Encapsulation (see Table 62).
802  */
803 enum {
804 	IEEE80211_KDE_GTK	= 1,
805 	IEEE80211_KDE_MACADDR	= 3,
806 	IEEE80211_KDE_PMKID	= 4,
807 	IEEE80211_KDE_SMK	= 5,
808 	IEEE80211_KDE_NONCE	= 6,
809 	IEEE80211_KDE_LIFETIME	= 7,
810 	IEEE80211_KDE_ERROR	= 8,
811 	IEEE80211_KDE_IGTK	= 9	/* 11w */
812 };
813 
814 #endif /* _NET80211_IEEE80211_H_ */
815