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