fdd4d5d9f1dfc7be7d5239f67e92d3e8c4089bef
[dragonfly.git] / sys / netproto / 802_11 / ieee80211.h
1 /*-
2  * Copyright (c) 2001 Atsushi Onoe
3  * Copyright (c) 2002-2009 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: head/sys/net80211/ieee80211.h 197413 2009-09-22 18:18:14Z rpaulo $
27  * $DragonFly$
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 typedef uint16_t ieee80211_seq;
41
42 /* IEEE 802.11 PLCP header */
43 struct ieee80211_plcp_hdr {
44         uint16_t        i_sfd;
45         uint8_t         i_signal;
46         uint8_t         i_service;
47         uint16_t        i_length;
48         uint16_t        i_crc;
49 } __packed;
50
51 #define IEEE80211_PLCP_SFD      0xF3A0 
52 #define IEEE80211_PLCP_SERVICE  0x00
53 #define IEEE80211_PLCP_SERVICE_LOCKED   0x04
54 #define IEEE80211_PLCL_SERVICE_PBCC     0x08
55 #define IEEE80211_PLCP_SERVICE_LENEXT5  0x20
56 #define IEEE80211_PLCP_SERVICE_LENEXT6  0x40
57 #define IEEE80211_PLCP_SERVICE_LENEXT7  0x80
58
59 /*
60  * generic definitions for IEEE 802.11 frames
61  */
62 struct ieee80211_frame {
63         uint8_t         i_fc[2];
64         uint8_t         i_dur[2];
65         uint8_t         i_addr1[IEEE80211_ADDR_LEN];
66         uint8_t         i_addr2[IEEE80211_ADDR_LEN];
67         uint8_t         i_addr3[IEEE80211_ADDR_LEN];
68         uint8_t         i_seq[2];
69         /* possibly followed by addr4[IEEE80211_ADDR_LEN]; */
70         /* see below */
71 } __packed;
72
73 struct ieee80211_qosframe {
74         uint8_t         i_fc[2];
75         uint8_t         i_dur[2];
76         uint8_t         i_addr1[IEEE80211_ADDR_LEN];
77         uint8_t         i_addr2[IEEE80211_ADDR_LEN];
78         uint8_t         i_addr3[IEEE80211_ADDR_LEN];
79         uint8_t         i_seq[2];
80         uint8_t         i_qos[2];
81         /* possibly followed by addr4[IEEE80211_ADDR_LEN]; */
82         /* see below */
83 } __packed;
84
85 struct ieee80211_qoscntl {
86         uint8_t         i_qos[2];
87 };
88
89 struct ieee80211_frame_addr4 {
90         uint8_t         i_fc[2];
91         uint8_t         i_dur[2];
92         uint8_t         i_addr1[IEEE80211_ADDR_LEN];
93         uint8_t         i_addr2[IEEE80211_ADDR_LEN];
94         uint8_t         i_addr3[IEEE80211_ADDR_LEN];
95         uint8_t         i_seq[2];
96         uint8_t         i_addr4[IEEE80211_ADDR_LEN];
97 } __packed;
98
99
100 struct ieee80211_qosframe_addr4 {
101         uint8_t         i_fc[2];
102         uint8_t         i_dur[2];
103         uint8_t         i_addr1[IEEE80211_ADDR_LEN];
104         uint8_t         i_addr2[IEEE80211_ADDR_LEN];
105         uint8_t         i_addr3[IEEE80211_ADDR_LEN];
106         uint8_t         i_seq[2];
107         uint8_t         i_addr4[IEEE80211_ADDR_LEN];
108         uint8_t         i_qos[2];
109 } __packed;
110
111 #define IEEE80211_FC0_VERSION_MASK              0x03
112 #define IEEE80211_FC0_VERSION_SHIFT             0
113 #define IEEE80211_FC0_VERSION_0                 0x00
114 #define IEEE80211_FC0_TYPE_MASK                 0x0c
115 #define IEEE80211_FC0_TYPE_SHIFT                2
116 #define IEEE80211_FC0_TYPE_MGT                  0x00
117 #define IEEE80211_FC0_TYPE_CTL                  0x04
118 #define IEEE80211_FC0_TYPE_DATA                 0x08
119
120 #define IEEE80211_FC0_SUBTYPE_MASK              0xf0
121 #define IEEE80211_FC0_SUBTYPE_SHIFT             4
122 /* for TYPE_MGT */
123 #define IEEE80211_FC0_SUBTYPE_ASSOC_REQ         0x00
124 #define IEEE80211_FC0_SUBTYPE_ASSOC_RESP        0x10
125 #define IEEE80211_FC0_SUBTYPE_REASSOC_REQ       0x20
126 #define IEEE80211_FC0_SUBTYPE_REASSOC_RESP      0x30
127 #define IEEE80211_FC0_SUBTYPE_PROBE_REQ         0x40
128 #define IEEE80211_FC0_SUBTYPE_PROBE_RESP        0x50
129 #define IEEE80211_FC0_SUBTYPE_BEACON            0x80
130 #define IEEE80211_FC0_SUBTYPE_ATIM              0x90
131 #define IEEE80211_FC0_SUBTYPE_DISASSOC          0xa0
132 #define IEEE80211_FC0_SUBTYPE_AUTH              0xb0
133 #define IEEE80211_FC0_SUBTYPE_DEAUTH            0xc0
134 #define IEEE80211_FC0_SUBTYPE_ACTION            0xd0
135 /* for TYPE_CTL */
136 #define IEEE80211_FC0_SUBTYPE_BAR               0x80
137 #define IEEE80211_FC0_SUBTYPE_BA                0x90
138 #define IEEE80211_FC0_SUBTYPE_PS_POLL           0xa0
139 #define IEEE80211_FC0_SUBTYPE_RTS               0xb0
140 #define IEEE80211_FC0_SUBTYPE_CTS               0xc0
141 #define IEEE80211_FC0_SUBTYPE_ACK               0xd0
142 #define IEEE80211_FC0_SUBTYPE_CF_END            0xe0
143 #define IEEE80211_FC0_SUBTYPE_CF_END_ACK        0xf0
144 /* for TYPE_DATA (bit combination) */
145 #define IEEE80211_FC0_SUBTYPE_DATA              0x00
146 #define IEEE80211_FC0_SUBTYPE_CF_ACK            0x10
147 #define IEEE80211_FC0_SUBTYPE_CF_POLL           0x20
148 #define IEEE80211_FC0_SUBTYPE_CF_ACPL           0x30
149 #define IEEE80211_FC0_SUBTYPE_NODATA            0x40
150 #define IEEE80211_FC0_SUBTYPE_CFACK             0x50
151 #define IEEE80211_FC0_SUBTYPE_CFPOLL            0x60
152 #define IEEE80211_FC0_SUBTYPE_CF_ACK_CF_ACK     0x70
153 #define IEEE80211_FC0_SUBTYPE_QOS               0x80
154 #define IEEE80211_FC0_SUBTYPE_QOS_NULL          0xc0
155
156 #define IEEE80211_FC1_DIR_MASK                  0x03
157 #define IEEE80211_FC1_DIR_NODS                  0x00    /* STA->STA */
158 #define IEEE80211_FC1_DIR_TODS                  0x01    /* STA->AP  */
159 #define IEEE80211_FC1_DIR_FROMDS                0x02    /* AP ->STA */
160 #define IEEE80211_FC1_DIR_DSTODS                0x03    /* AP ->AP  */
161
162 #define IEEE80211_IS_DSTODS(wh) \
163         (((wh)->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
164
165 #define IEEE80211_FC1_MORE_FRAG                 0x04
166 #define IEEE80211_FC1_RETRY                     0x08
167 #define IEEE80211_FC1_PWR_MGT                   0x10
168 #define IEEE80211_FC1_MORE_DATA                 0x20
169 #define IEEE80211_FC1_WEP                       0x40
170 #define IEEE80211_FC1_ORDER                     0x80
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 #define IEEE80211_SEQ_RANGE                     4096
177
178 #define IEEE80211_SEQ_ADD(seq, incr) \
179         (((seq) + (incr)) & (IEEE80211_SEQ_RANGE-1))
180 #define IEEE80211_SEQ_INC(seq)  IEEE80211_SEQ_ADD(seq,1)
181 #define IEEE80211_SEQ_SUB(a, b) \
182         (((a) + IEEE80211_SEQ_RANGE - (b)) & (IEEE80211_SEQ_RANGE-1))
183
184 #define IEEE80211_SEQ_BA_RANGE                  2048    /* 2^11 */
185 #define IEEE80211_SEQ_BA_BEFORE(a, b) \
186         (IEEE80211_SEQ_SUB(b, a+1) < IEEE80211_SEQ_BA_RANGE-1)
187
188 #define IEEE80211_NWID_LEN                      32
189 #define IEEE80211_MESHID_LEN                    32
190
191 #define IEEE80211_QOS_TXOP                      0x00ff
192 /* bit 8 is reserved */
193 #define IEEE80211_QOS_AMSDU                     0x80
194 #define IEEE80211_QOS_AMSDU_S                   7
195 #define IEEE80211_QOS_ACKPOLICY                 0x60
196 #define IEEE80211_QOS_ACKPOLICY_S               5
197 #define IEEE80211_QOS_ACKPOLICY_NOACK           0x20    /* No ACK required */
198 #define IEEE80211_QOS_ACKPOLICY_BA              0x60    /* Block ACK */
199 #define IEEE80211_QOS_EOSP                      0x10    /* EndOfService Period*/
200 #define IEEE80211_QOS_EOSP_S                    4
201 #define IEEE80211_QOS_TID                       0x0f
202
203 /* does frame have QoS sequence control data */
204 #define IEEE80211_QOS_HAS_SEQ(wh) \
205         (((wh)->i_fc[0] & \
206           (IEEE80211_FC0_TYPE_MASK | IEEE80211_FC0_SUBTYPE_QOS)) == \
207           (IEEE80211_FC0_TYPE_DATA | IEEE80211_FC0_SUBTYPE_QOS))
208
209 /*
210  * WME/802.11e information element.
211  */
212 struct ieee80211_wme_info {
213         uint8_t         wme_id;         /* IEEE80211_ELEMID_VENDOR */
214         uint8_t         wme_len;        /* length in bytes */
215         uint8_t         wme_oui[3];     /* 0x00, 0x50, 0xf2 */
216         uint8_t         wme_type;       /* OUI type */
217         uint8_t         wme_subtype;    /* OUI subtype */
218         uint8_t         wme_version;    /* spec revision */
219         uint8_t         wme_info;       /* QoS info */
220 } __packed;
221
222 /*
223  * WME/802.11e Tspec Element
224  */
225 struct ieee80211_wme_tspec {
226         uint8_t         ts_id;
227         uint8_t         ts_len;
228         uint8_t         ts_oui[3];
229         uint8_t         ts_oui_type;
230         uint8_t         ts_oui_subtype;
231         uint8_t         ts_version;
232         uint8_t         ts_tsinfo[3];
233         uint8_t         ts_nom_msdu[2];
234         uint8_t         ts_max_msdu[2];
235         uint8_t         ts_min_svc[4];
236         uint8_t         ts_max_svc[4];
237         uint8_t         ts_inactv_intv[4];
238         uint8_t         ts_susp_intv[4];
239         uint8_t         ts_start_svc[4];
240         uint8_t         ts_min_rate[4];
241         uint8_t         ts_mean_rate[4];
242         uint8_t         ts_max_burst[4];
243         uint8_t         ts_min_phy[4];
244         uint8_t         ts_peak_rate[4];
245         uint8_t         ts_delay[4];
246         uint8_t         ts_surplus[2];
247         uint8_t         ts_medium_time[2];
248 } __packed;
249
250 /*
251  * WME AC parameter field
252  */
253 struct ieee80211_wme_acparams {
254         uint8_t         acp_aci_aifsn;
255         uint8_t         acp_logcwminmax;
256         uint16_t        acp_txop;
257 } __packed;
258
259 #define WME_NUM_AC              4       /* 4 AC categories */
260 #define WME_NUM_TID             16      /* 16 tids */
261
262 #define WME_PARAM_ACI           0x60    /* Mask for ACI field */
263 #define WME_PARAM_ACI_S         5       /* Shift for ACI field */
264 #define WME_PARAM_ACM           0x10    /* Mask for ACM bit */
265 #define WME_PARAM_ACM_S         4       /* Shift for ACM bit */
266 #define WME_PARAM_AIFSN         0x0f    /* Mask for aifsn field */
267 #define WME_PARAM_AIFSN_S       0       /* Shift for aifsn field */
268 #define WME_PARAM_LOGCWMIN      0x0f    /* Mask for CwMin field (in log) */
269 #define WME_PARAM_LOGCWMIN_S    0       /* Shift for CwMin field */
270 #define WME_PARAM_LOGCWMAX      0xf0    /* Mask for CwMax field (in log) */
271 #define WME_PARAM_LOGCWMAX_S    4       /* Shift for CwMax field */
272
273 #define WME_AC_TO_TID(_ac) (       \
274         ((_ac) == WME_AC_VO) ? 6 : \
275         ((_ac) == WME_AC_VI) ? 5 : \
276         ((_ac) == WME_AC_BK) ? 1 : \
277         0)
278
279 #define TID_TO_WME_AC(_tid) (      \
280         ((_tid) == 0 || (_tid) == 3) ? WME_AC_BE : \
281         ((_tid) < 3) ? WME_AC_BK : \
282         ((_tid) < 6) ? WME_AC_VI : \
283         WME_AC_VO)
284
285 /*
286  * WME Parameter Element
287  */
288 struct ieee80211_wme_param {
289         uint8_t         param_id;
290         uint8_t         param_len;
291         uint8_t         param_oui[3];
292         uint8_t         param_oui_type;
293         uint8_t         param_oui_subtype;
294         uint8_t         param_version;
295         uint8_t         param_qosInfo;
296 #define WME_QOSINFO_COUNT       0x0f    /* Mask for param count field */
297         uint8_t         param_reserved;
298         struct ieee80211_wme_acparams   params_acParams[WME_NUM_AC];
299 } __packed;
300
301 /*
302  * Management Notification Frame
303  */
304 struct ieee80211_mnf {
305         uint8_t         mnf_category;
306         uint8_t         mnf_action;
307         uint8_t         mnf_dialog;
308         uint8_t         mnf_status;
309 } __packed;
310 #define MNF_SETUP_REQ   0
311 #define MNF_SETUP_RESP  1
312 #define MNF_TEARDOWN    2
313
314 /* 
315  * 802.11n Management Action Frames 
316  */
317 /* generic frame format */
318 struct ieee80211_action {
319         uint8_t         ia_category;
320         uint8_t         ia_action;
321 } __packed;
322
323 #define IEEE80211_ACTION_CAT_SM         0       /* Spectrum Management */
324 #define IEEE80211_ACTION_CAT_QOS        1       /* QoS */
325 #define IEEE80211_ACTION_CAT_DLS        2       /* DLS */
326 #define IEEE80211_ACTION_CAT_BA         3       /* BA */
327 #define IEEE80211_ACTION_CAT_HT         7       /* HT */
328 #define IEEE80211_ACTION_CAT_VENDOR     127     /* Vendor Specific */
329
330 #define IEEE80211_ACTION_HT_TXCHWIDTH   0       /* recommended xmit chan width*/
331 #define IEEE80211_ACTION_HT_MIMOPWRSAVE 1       /* MIMO power save */
332
333 /* HT - recommended transmission channel width */
334 struct ieee80211_action_ht_txchwidth {
335         struct ieee80211_action at_header;
336         uint8_t         at_chwidth;     
337 } __packed;
338
339 #define IEEE80211_A_HT_TXCHWIDTH_20     0
340 #define IEEE80211_A_HT_TXCHWIDTH_2040   1
341
342 /* HT - MIMO Power Save (NB: D2.04) */
343 struct ieee80211_action_ht_mimopowersave {
344         struct ieee80211_action am_header;
345         uint8_t         am_control;
346 } __packed;
347
348 #define IEEE80211_A_HT_MIMOPWRSAVE_ENA          0x01    /* PS enabled */
349 #define IEEE80211_A_HT_MIMOPWRSAVE_MODE         0x02
350 #define IEEE80211_A_HT_MIMOPWRSAVE_MODE_S       1
351 #define IEEE80211_A_HT_MIMOPWRSAVE_DYNAMIC      0x02    /* Dynamic Mode */
352 #define IEEE80211_A_HT_MIMOPWRSAVE_STATIC       0x00    /* no SM packets */
353 /* bits 2-7 reserved */
354
355 /* Block Ack actions */
356 #define IEEE80211_ACTION_BA_ADDBA_REQUEST       0   /* ADDBA request */
357 #define IEEE80211_ACTION_BA_ADDBA_RESPONSE      1   /* ADDBA response */
358 #define IEEE80211_ACTION_BA_DELBA               2   /* DELBA */
359
360 /* Block Ack Parameter Set */
361 #define IEEE80211_BAPS_BUFSIZ   0xffc0          /* buffer size */
362 #define IEEE80211_BAPS_BUFSIZ_S 6
363 #define IEEE80211_BAPS_TID      0x003c          /* TID */
364 #define IEEE80211_BAPS_TID_S    2
365 #define IEEE80211_BAPS_POLICY   0x0002          /* block ack policy */
366 #define IEEE80211_BAPS_POLICY_S 1
367
368 #define IEEE80211_BAPS_POLICY_DELAYED   (0<<IEEE80211_BAPS_POLICY_S)
369 #define IEEE80211_BAPS_POLICY_IMMEDIATE (1<<IEEE80211_BAPS_POLICY_S)
370
371 /* Block Ack Sequence Control */
372 #define IEEE80211_BASEQ_START   0xfff0          /* starting seqnum */
373 #define IEEE80211_BASEQ_START_S 4
374 #define IEEE80211_BASEQ_FRAG    0x000f          /* fragment number */
375 #define IEEE80211_BASEQ_FRAG_S  0
376
377 /* Delayed Block Ack Parameter Set */
378 #define IEEE80211_DELBAPS_TID   0xf000          /* TID */
379 #define IEEE80211_DELBAPS_TID_S 12
380 #define IEEE80211_DELBAPS_INIT  0x0800          /* initiator */
381 #define IEEE80211_DELBAPS_INIT_S 11
382
383 /* BA - ADDBA request */
384 struct ieee80211_action_ba_addbarequest {
385         struct ieee80211_action rq_header;
386         uint8_t         rq_dialogtoken;
387         uint16_t        rq_baparamset;
388         uint16_t        rq_batimeout;           /* in TUs */
389         uint16_t        rq_baseqctl;
390 } __packed;
391
392 /* BA - ADDBA response */
393 struct ieee80211_action_ba_addbaresponse {
394         struct ieee80211_action rs_header;
395         uint8_t         rs_dialogtoken;
396         uint16_t        rs_statuscode;
397         uint16_t        rs_baparamset; 
398         uint16_t        rs_batimeout;           /* in TUs */
399 } __packed;
400
401 /* BA - DELBA */
402 struct ieee80211_action_ba_delba {
403         struct ieee80211_action dl_header;
404         uint16_t        dl_baparamset;
405         uint16_t        dl_reasoncode;
406 } __packed;
407
408 /* BAR Control */
409 #define IEEE80211_BAR_TID       0xf000          /* TID */
410 #define IEEE80211_BAR_TID_S     12
411 #define IEEE80211_BAR_COMP      0x0004          /* Compressed Bitmap */
412 #define IEEE80211_BAR_MTID      0x0002          /* Multi-TID */
413 #define IEEE80211_BAR_NOACK     0x0001          /* No-Ack policy */
414
415 /* BAR Starting Sequence Control */
416 #define IEEE80211_BAR_SEQ_START 0xfff0          /* starting seqnum */
417 #define IEEE80211_BAR_SEQ_START_S       4
418
419 struct ieee80211_ba_request {
420         uint16_t        rq_barctl;
421         uint16_t        rq_barseqctl;
422 } __packed;
423
424 /*
425  * Control frames.
426  */
427 struct ieee80211_frame_min {
428         uint8_t         i_fc[2];
429         uint8_t         i_dur[2];
430         uint8_t         i_addr1[IEEE80211_ADDR_LEN];
431         uint8_t         i_addr2[IEEE80211_ADDR_LEN];
432         /* FCS */
433 } __packed;
434
435 struct ieee80211_frame_rts {
436         uint8_t         i_fc[2];
437         uint8_t         i_dur[2];
438         uint8_t         i_ra[IEEE80211_ADDR_LEN];
439         uint8_t         i_ta[IEEE80211_ADDR_LEN];
440         /* FCS */
441 } __packed;
442
443 struct ieee80211_frame_cts {
444         uint8_t         i_fc[2];
445         uint8_t         i_dur[2];
446         uint8_t         i_ra[IEEE80211_ADDR_LEN];
447         /* FCS */
448 } __packed;
449
450 struct ieee80211_frame_ack {
451         uint8_t         i_fc[2];
452         uint8_t         i_dur[2];
453         uint8_t         i_ra[IEEE80211_ADDR_LEN];
454         /* FCS */
455 } __packed;
456
457 struct ieee80211_frame_pspoll {
458         uint8_t         i_fc[2];
459         uint8_t         i_aid[2];
460         uint8_t         i_bssid[IEEE80211_ADDR_LEN];
461         uint8_t         i_ta[IEEE80211_ADDR_LEN];
462         /* FCS */
463 } __packed;
464
465 struct ieee80211_frame_cfend {          /* NB: also CF-End+CF-Ack */
466         uint8_t         i_fc[2];
467         uint8_t         i_dur[2];       /* should be zero */
468         uint8_t         i_ra[IEEE80211_ADDR_LEN];
469         uint8_t         i_bssid[IEEE80211_ADDR_LEN];
470         /* FCS */
471 } __packed;
472
473 struct ieee80211_frame_bar {
474         uint8_t         i_fc[2];
475         uint8_t         i_dur[2];
476         uint8_t         i_ra[IEEE80211_ADDR_LEN];
477         uint8_t         i_ta[IEEE80211_ADDR_LEN];
478         uint16_t        i_ctl;
479         uint16_t        i_seq;
480         /* FCS */
481 } __packed;
482
483 /*
484  * BEACON management packets
485  *
486  *      octet timestamp[8]
487  *      octet beacon interval[2]
488  *      octet capability information[2]
489  *      information element
490  *              octet elemid
491  *              octet length
492  *              octet information[length]
493  */
494
495 #define IEEE80211_BEACON_INTERVAL(beacon) \
496         ((beacon)[8] | ((beacon)[9] << 8))
497 #define IEEE80211_BEACON_CAPABILITY(beacon) \
498         ((beacon)[10] | ((beacon)[11] << 8))
499
500 #define IEEE80211_CAPINFO_ESS                   0x0001
501 #define IEEE80211_CAPINFO_IBSS                  0x0002
502 #define IEEE80211_CAPINFO_CF_POLLABLE           0x0004
503 #define IEEE80211_CAPINFO_CF_POLLREQ            0x0008
504 #define IEEE80211_CAPINFO_PRIVACY               0x0010
505 #define IEEE80211_CAPINFO_SHORT_PREAMBLE        0x0020
506 #define IEEE80211_CAPINFO_PBCC                  0x0040
507 #define IEEE80211_CAPINFO_CHNL_AGILITY          0x0080
508 #define IEEE80211_CAPINFO_SPECTRUM_MGMT         0x0100
509 /* bit 9 is reserved */
510 #define IEEE80211_CAPINFO_SHORT_SLOTTIME        0x0400
511 #define IEEE80211_CAPINFO_RSN                   0x0800
512 /* bit 12 is reserved */
513 #define IEEE80211_CAPINFO_DSSSOFDM              0x2000
514 /* bits 14-15 are reserved */
515
516 #define IEEE80211_CAPINFO_BITS \
517         "\20\1ESS\2IBSS\3CF_POLLABLE\4CF_POLLREQ\5PRIVACY\6SHORT_PREAMBLE" \
518         "\7PBCC\10CHNL_AGILITY\11SPECTRUM_MGMT\13SHORT_SLOTTIME\14RSN" \
519         "\16DSSOFDM"
520
521 /*
522  * 802.11i/WPA information element (maximally sized).
523  */
524 struct ieee80211_ie_wpa {
525         uint8_t         wpa_id;         /* IEEE80211_ELEMID_VENDOR */
526         uint8_t         wpa_len;        /* length in bytes */
527         uint8_t         wpa_oui[3];     /* 0x00, 0x50, 0xf2 */
528         uint8_t         wpa_type;       /* OUI type */
529         uint16_t        wpa_version;    /* spec revision */
530         uint32_t        wpa_mcipher[1]; /* multicast/group key cipher */
531         uint16_t        wpa_uciphercnt; /* # pairwise key ciphers */
532         uint32_t        wpa_uciphers[8];/* ciphers */
533         uint16_t        wpa_authselcnt; /* authentication selector cnt*/
534         uint32_t        wpa_authsels[8];/* selectors */
535         uint16_t        wpa_caps;       /* 802.11i capabilities */
536         uint16_t        wpa_pmkidcnt;   /* 802.11i pmkid count */
537         uint16_t        wpa_pmkids[8];  /* 802.11i pmkids */
538 } __packed;
539
540 /*
541  * 802.11n HT Capability IE
542  * NB: these reflect D1.10 
543  */
544 struct ieee80211_ie_htcap {
545         uint8_t         hc_id;                  /* element ID */
546         uint8_t         hc_len;                 /* length in bytes */
547         uint16_t        hc_cap;                 /* HT caps (see below) */
548         uint8_t         hc_param;               /* HT params (see below) */
549         uint8_t         hc_mcsset[16];          /* supported MCS set */
550         uint16_t        hc_extcap;              /* extended HT capabilities */
551         uint32_t        hc_txbf;                /* txbf capabilities */
552         uint8_t         hc_antenna;             /* antenna capabilities */
553 } __packed;
554
555 /* HT capability flags (ht_cap) */
556 #define IEEE80211_HTCAP_LDPC            0x0001  /* LDPC supported */
557 #define IEEE80211_HTCAP_CHWIDTH40       0x0002  /* 20/40 supported */
558 #define IEEE80211_HTCAP_SMPS            0x000c  /* SM Power Save mode */
559 #define IEEE80211_HTCAP_SMPS_OFF        0x000c  /* disabled */
560 #define IEEE80211_HTCAP_SMPS_DYNAMIC    0x0004  /* send RTS first */
561 /* NB: SMPS value 2 is reserved */
562 #define IEEE80211_HTCAP_SMPS_ENA        0x0000  /* enabled (static mode) */
563 #define IEEE80211_HTCAP_GREENFIELD      0x0010  /* Greenfield supported */
564 #define IEEE80211_HTCAP_SHORTGI20       0x0020  /* Short GI in 20MHz */
565 #define IEEE80211_HTCAP_SHORTGI40       0x0040  /* Short GI in 40MHz */
566 #define IEEE80211_HTCAP_TXSTBC          0x0080  /* STBC tx ok */
567 #define IEEE80211_HTCAP_RXSTBC          0x0300  /* STBC rx support */
568 #define IEEE80211_HTCAP_RXSTBC_S        8
569 #define IEEE80211_HTCAP_RXSTBC_1STREAM  0x0100  /* 1 spatial stream */
570 #define IEEE80211_HTCAP_RXSTBC_2STREAM  0x0200  /* 1-2 spatial streams*/
571 #define IEEE80211_HTCAP_RXSTBC_3STREAM  0x0300  /* 1-3 spatial streams*/
572 #define IEEE80211_HTCAP_DELBA           0x0400  /* HT DELBA supported */
573 #define IEEE80211_HTCAP_MAXAMSDU        0x0800  /* max A-MSDU length */
574 #define IEEE80211_HTCAP_MAXAMSDU_7935   0x0800  /* 7935 octets */
575 #define IEEE80211_HTCAP_MAXAMSDU_3839   0x0000  /* 3839 octets */
576 #define IEEE80211_HTCAP_DSSSCCK40       0x1000  /* DSSS/CCK in 40MHz */
577 #define IEEE80211_HTCAP_PSMP            0x2000  /* PSMP supported */
578 #define IEEE80211_HTCAP_40INTOLERANT    0x4000  /* 40MHz intolerant */
579 #define IEEE80211_HTCAP_LSIGTXOPPROT    0x8000  /* L-SIG TXOP prot */
580
581 #define IEEE80211_HTCAP_BITS \
582         "\20\1LDPC\2CHWIDTH40\5GREENFIELD\6SHORTGI20\7SHORTGI40\10TXSTBC" \
583         "\13DELBA\14AMSDU(7935)\15DSSSCCK40\16PSMP\1740INTOLERANT" \
584         "\20LSIGTXOPPROT"
585
586 /* HT parameters (hc_param) */
587 #define IEEE80211_HTCAP_MAXRXAMPDU      0x03    /* max rx A-MPDU factor */
588 #define IEEE80211_HTCAP_MAXRXAMPDU_S    0
589 #define IEEE80211_HTCAP_MAXRXAMPDU_8K   0
590 #define IEEE80211_HTCAP_MAXRXAMPDU_16K  1
591 #define IEEE80211_HTCAP_MAXRXAMPDU_32K  2
592 #define IEEE80211_HTCAP_MAXRXAMPDU_64K  3
593 #define IEEE80211_HTCAP_MPDUDENSITY     0x1c    /* min MPDU start spacing */
594 #define IEEE80211_HTCAP_MPDUDENSITY_S   2
595 #define IEEE80211_HTCAP_MPDUDENSITY_NA  0       /* no time restriction */
596 #define IEEE80211_HTCAP_MPDUDENSITY_025 1       /* 1/4 us */
597 #define IEEE80211_HTCAP_MPDUDENSITY_05  2       /* 1/2 us */
598 #define IEEE80211_HTCAP_MPDUDENSITY_1   3       /* 1 us */
599 #define IEEE80211_HTCAP_MPDUDENSITY_2   4       /* 2 us */
600 #define IEEE80211_HTCAP_MPDUDENSITY_4   5       /* 4 us */
601 #define IEEE80211_HTCAP_MPDUDENSITY_8   6       /* 8 us */
602 #define IEEE80211_HTCAP_MPDUDENSITY_16  7       /* 16 us */
603
604 /* HT extended capabilities (hc_extcap) */
605 #define IEEE80211_HTCAP_PCO             0x0001  /* PCO capable */
606 #define IEEE80211_HTCAP_PCOTRANS        0x0006  /* PCO transition time */
607 #define IEEE80211_HTCAP_PCOTRANS_S      1
608 #define IEEE80211_HTCAP_PCOTRANS_04     0x0002  /* 400 us */
609 #define IEEE80211_HTCAP_PCOTRANS_15     0x0004  /* 1.5 ms */
610 #define IEEE80211_HTCAP_PCOTRANS_5      0x0006  /* 5 ms */
611 /* bits 3-7 reserved */
612 #define IEEE80211_HTCAP_MCSFBACK        0x0300  /* MCS feedback */
613 #define IEEE80211_HTCAP_MCSFBACK_S      8
614 #define IEEE80211_HTCAP_MCSFBACK_NONE   0x0000  /* nothing provided */
615 #define IEEE80211_HTCAP_MCSFBACK_UNSOL  0x0200  /* unsolicited feedback */
616 #define IEEE80211_HTCAP_MCSFBACK_MRQ    0x0300  /* " "+respond to MRQ */
617 #define IEEE80211_HTCAP_HTC             0x0400  /* +HTC support */
618 #define IEEE80211_HTCAP_RDR             0x0800  /* reverse direction responder*/
619 /* bits 12-15 reserved */
620
621 /*
622  * 802.11n HT Information IE
623  */
624 struct ieee80211_ie_htinfo {
625         uint8_t         hi_id;                  /* element ID */
626         uint8_t         hi_len;                 /* length in bytes */
627         uint8_t         hi_ctrlchannel;         /* primary channel */
628         uint8_t         hi_byte1;               /* ht ie byte 1 */
629         uint8_t         hi_byte2;               /* ht ie byte 2 */
630         uint8_t         hi_byte3;               /* ht ie byte 3 */
631         uint16_t        hi_byte45;              /* ht ie bytes 4+5 */
632         uint8_t         hi_basicmcsset[16];     /* basic MCS set */
633 } __packed;
634
635 /* byte1 */
636 #define IEEE80211_HTINFO_2NDCHAN        0x03    /* secondary/ext chan offset */
637 #define IEEE80211_HTINFO_2NDCHAN_S      0
638 #define IEEE80211_HTINFO_2NDCHAN_NONE   0x00    /* no secondary/ext channel */
639 #define IEEE80211_HTINFO_2NDCHAN_ABOVE  0x01    /* above private channel */
640 /* NB: 2 is reserved */
641 #define IEEE80211_HTINFO_2NDCHAN_BELOW  0x03    /* below primary channel */ 
642 #define IEEE80211_HTINFO_TXWIDTH        0x04    /* tx channel width */
643 #define IEEE80211_HTINFO_TXWIDTH_20     0x00    /* 20MHz width */
644 #define IEEE80211_HTINFO_TXWIDTH_2040   0x04    /* any supported width */
645 #define IEEE80211_HTINFO_RIFSMODE       0x08    /* Reduced IFS (RIFS) use */
646 #define IEEE80211_HTINFO_RIFSMODE_PROH  0x00    /* RIFS use prohibited */
647 #define IEEE80211_HTINFO_RIFSMODE_PERM  0x08    /* RIFS use permitted */
648 #define IEEE80211_HTINFO_PMSPONLY       0x10    /* PSMP required to associate */
649 #define IEEE80211_HTINFO_SIGRAN         0xe0    /* shortest Service Interval */
650 #define IEEE80211_HTINFO_SIGRAN_S       5
651 #define IEEE80211_HTINFO_SIGRAN_5       0x00    /* 5 ms */
652 /* XXX add rest */
653
654 /* bytes 2+3 */
655 #define IEEE80211_HTINFO_OPMODE         0x03    /* operating mode */
656 #define IEEE80211_HTINFO_OPMODE_S       0
657 #define IEEE80211_HTINFO_OPMODE_PURE    0x00    /* no protection */
658 #define IEEE80211_HTINFO_OPMODE_PROTOPT 0x01    /* protection optional */
659 #define IEEE80211_HTINFO_OPMODE_HT20PR  0x02    /* protection for HT20 sta's */
660 #define IEEE80211_HTINFO_OPMODE_MIXED   0x03    /* protection for legacy sta's*/
661 #define IEEE80211_HTINFO_NONGF_PRESENT  0x04    /* non-GF sta's present */
662 #define IEEE80211_HTINFO_TXBL           0x08    /* transmit burst limit */
663 #define IEEE80211_HTINFO_NONHT_PRESENT  0x10    /* non-HT sta's present */
664 /* bits 5-15 reserved */
665
666 /* bytes 4+5 */
667 #define IEEE80211_HTINFO_2NDARYBEACON   0x01
668 #define IEEE80211_HTINFO_LSIGTXOPPROT   0x02
669 #define IEEE80211_HTINFO_PCO_ACTIVE     0x04
670 #define IEEE80211_HTINFO_40MHZPHASE     0x08
671
672 /* byte5 */
673 #define IEEE80211_HTINFO_BASIC_STBCMCS  0x7f
674 #define IEEE80211_HTINFO_BASIC_STBCMCS_S 0
675 #define IEEE80211_HTINFO_DUALPROTECTED  0x80
676
677 /*
678  * Management information element payloads.
679  */
680
681 enum {
682         IEEE80211_ELEMID_SSID           = 0,
683         IEEE80211_ELEMID_RATES          = 1,
684         IEEE80211_ELEMID_FHPARMS        = 2,
685         IEEE80211_ELEMID_DSPARMS        = 3,
686         IEEE80211_ELEMID_CFPARMS        = 4,
687         IEEE80211_ELEMID_TIM            = 5,
688         IEEE80211_ELEMID_IBSSPARMS      = 6,
689         IEEE80211_ELEMID_COUNTRY        = 7,
690         IEEE80211_ELEMID_CHALLENGE      = 16,
691         /* 17-31 reserved for challenge text extension */
692         IEEE80211_ELEMID_PWRCNSTR       = 32,
693         IEEE80211_ELEMID_PWRCAP         = 33,
694         IEEE80211_ELEMID_TPCREQ         = 34,
695         IEEE80211_ELEMID_TPCREP         = 35,
696         IEEE80211_ELEMID_SUPPCHAN       = 36,
697         IEEE80211_ELEMID_CSA            = 37,
698         IEEE80211_ELEMID_MEASREQ        = 38,
699         IEEE80211_ELEMID_MEASREP        = 39,
700         IEEE80211_ELEMID_QUIET          = 40,
701         IEEE80211_ELEMID_IBSSDFS        = 41,
702         IEEE80211_ELEMID_ERP            = 42,
703         IEEE80211_ELEMID_HTCAP          = 45,
704         IEEE80211_ELEMID_RSN            = 48,
705         IEEE80211_ELEMID_XRATES         = 50,
706         IEEE80211_ELEMID_HTINFO         = 61,
707         IEEE80211_ELEMID_TPC            = 150,
708         IEEE80211_ELEMID_CCKM           = 156,
709         IEEE80211_ELEMID_VENDOR         = 221,  /* vendor private */
710
711         /*
712          * 802.11s IEs based on D3.03 spec and were not assigned by
713          * ANA. Beware changing them because some of them are being
714          * kept compatible with Linux.
715          */
716         IEEE80211_ELEMID_MESHCONF       = 51,
717         IEEE80211_ELEMID_MESHID         = 52,
718         IEEE80211_ELEMID_MESHLINK       = 35,
719         IEEE80211_ELEMID_MESHCNGST      = 36,
720         IEEE80211_ELEMID_MESHPEER       = 55,
721         IEEE80211_ELEMID_MESHCSA        = 38,
722         IEEE80211_ELEMID_MESHTIM        = 39,
723         IEEE80211_ELEMID_MESHAWAKEW     = 40,
724         IEEE80211_ELEMID_MESHBEACONT    = 41,
725         IEEE80211_ELEMID_MESHPANN       = 48,
726         IEEE80211_ELEMID_MESHRANN       = 49,
727         IEEE80211_ELEMID_MESHPREQ       = 68,
728         IEEE80211_ELEMID_MESHPREP       = 69,
729         IEEE80211_ELEMID_MESHPERR       = 70,
730         IEEE80211_ELEMID_MESHPXU        = 53,
731         IEEE80211_ELEMID_MESHPXUC       = 54,
732         IEEE80211_ELEMID_MESHAH         = 60, /* Abbreviated Handshake */
733 };
734
735 struct ieee80211_tim_ie {
736         uint8_t         tim_ie;                 /* IEEE80211_ELEMID_TIM */
737         uint8_t         tim_len;
738         uint8_t         tim_count;              /* DTIM count */
739         uint8_t         tim_period;             /* DTIM period */
740         uint8_t         tim_bitctl;             /* bitmap control */
741         uint8_t         tim_bitmap[1];          /* variable-length bitmap */
742 } __packed;
743
744 struct ieee80211_country_ie {
745         uint8_t         ie;                     /* IEEE80211_ELEMID_COUNTRY */
746         uint8_t         len;
747         uint8_t         cc[3];                  /* ISO CC+(I)ndoor/(O)utdoor */
748         struct {
749                 uint8_t schan;                  /* starting channel */
750                 uint8_t nchan;                  /* number channels */
751                 uint8_t maxtxpwr;               /* tx power cap */
752         } __packed band[1];                     /* sub bands (NB: var size) */
753 } __packed;
754
755 #define IEEE80211_COUNTRY_MAX_BANDS     84      /* max possible bands */
756 #define IEEE80211_COUNTRY_MAX_SIZE \
757         (sizeof(struct ieee80211_country_ie) + 3*(IEEE80211_COUNTRY_MAX_BANDS-1))
758
759 /*
760  * 802.11h Channel Switch Announcement (CSA).
761  */
762 struct ieee80211_csa_ie {
763         uint8_t         csa_ie;         /* IEEE80211_ELEMID_CHANSWITCHANN */
764         uint8_t         csa_len;
765         uint8_t         csa_mode;               /* Channel Switch Mode */
766         uint8_t         csa_newchan;            /* New Channel Number */
767         uint8_t         csa_count;              /* Channel Switch Count */
768 } __packed;
769
770 /*
771  * Note the min acceptable CSA count is used to guard against
772  * malicious CSA injection in station mode.  Defining this value
773  * as other than 0 violates the 11h spec.
774  */
775 #define IEEE80211_CSA_COUNT_MIN 2
776 #define IEEE80211_CSA_COUNT_MAX 255
777
778 /* rate set entries are in .5 Mb/s units, and potentially marked as basic */
779 #define IEEE80211_RATE_BASIC            0x80
780 #define IEEE80211_RATE_VAL              0x7f
781
782 /* EPR information element flags */
783 #define IEEE80211_ERP_NON_ERP_PRESENT   0x01
784 #define IEEE80211_ERP_USE_PROTECTION    0x02
785 #define IEEE80211_ERP_LONG_PREAMBLE     0x04
786
787 #define IEEE80211_ERP_BITS \
788         "\20\1NON_ERP_PRESENT\2USE_PROTECTION\3LONG_PREAMBLE"
789
790 #define ATH_OUI                 0x7f0300        /* Atheros OUI */
791 #define ATH_OUI_TYPE            0x01            /* Atheros protocol ie */
792
793 /* NB: Atheros allocated the OUI for this purpose ~2005 but beware ... */
794 #define TDMA_OUI                ATH_OUI
795 #define TDMA_OUI_TYPE           0x02            /* TDMA protocol ie */
796
797 #define BCM_OUI                 0x4c9000        /* Broadcom OUI */
798 #define BCM_OUI_HTCAP           51              /* pre-draft HTCAP ie */
799 #define BCM_OUI_HTINFO          52              /* pre-draft HTINFO ie */
800
801 #define WPA_OUI                 0xf25000
802 #define WPA_OUI_TYPE            0x01
803 #define WPA_VERSION             1               /* current supported version */
804
805 #define WPA_CSE_NULL            0x00
806 #define WPA_CSE_WEP40           0x01
807 #define WPA_CSE_TKIP            0x02
808 #define WPA_CSE_CCMP            0x04
809 #define WPA_CSE_WEP104          0x05
810
811 #define WPA_ASE_NONE            0x00
812 #define WPA_ASE_8021X_UNSPEC    0x01
813 #define WPA_ASE_8021X_PSK       0x02
814
815 #define WPS_OUI_TYPE            0x04
816
817 #define RSN_OUI                 0xac0f00
818 #define RSN_VERSION             1               /* current supported version */
819
820 #define RSN_CSE_NULL            0x00
821 #define RSN_CSE_WEP40           0x01
822 #define RSN_CSE_TKIP            0x02
823 #define RSN_CSE_WRAP            0x03
824 #define RSN_CSE_CCMP            0x04
825 #define RSN_CSE_WEP104          0x05
826
827 #define RSN_ASE_NONE            0x00
828 #define RSN_ASE_8021X_UNSPEC    0x01
829 #define RSN_ASE_8021X_PSK       0x02
830
831 #define RSN_CAP_PREAUTH         0x01
832
833 #define WME_OUI                 0xf25000
834 #define WME_OUI_TYPE            0x02
835 #define WME_INFO_OUI_SUBTYPE    0x00
836 #define WME_PARAM_OUI_SUBTYPE   0x01
837 #define WME_VERSION             1
838
839 /* WME stream classes */
840 #define WME_AC_BE       0               /* best effort */
841 #define WME_AC_BK       1               /* background */
842 #define WME_AC_VI       2               /* video */
843 #define WME_AC_VO       3               /* voice */
844
845 /*
846  * AUTH management packets
847  *
848  *      octet algo[2]
849  *      octet seq[2]
850  *      octet status[2]
851  *      octet chal.id
852  *      octet chal.length
853  *      octet chal.text[253]            NB: 1-253 bytes
854  */
855
856 /* challenge length for shared key auth */
857 #define IEEE80211_CHALLENGE_LEN         128
858
859 #define IEEE80211_AUTH_ALG_OPEN         0x0000
860 #define IEEE80211_AUTH_ALG_SHARED       0x0001
861 #define IEEE80211_AUTH_ALG_LEAP         0x0080
862
863 enum {
864         IEEE80211_AUTH_OPEN_REQUEST             = 1,
865         IEEE80211_AUTH_OPEN_RESPONSE            = 2,
866 };
867
868 enum {
869         IEEE80211_AUTH_SHARED_REQUEST           = 1,
870         IEEE80211_AUTH_SHARED_CHALLENGE         = 2,
871         IEEE80211_AUTH_SHARED_RESPONSE          = 3,
872         IEEE80211_AUTH_SHARED_PASS              = 4,
873 };
874
875 /*
876  * Reason and status codes.
877  *
878  * Reason codes are used in management frames to indicate why an
879  * action took place (e.g. on disassociation).  Status codes are
880  * used in management frames to indicate the result of an operation.
881  *
882  * Unlisted codes are reserved
883  */
884
885 enum {
886         IEEE80211_REASON_UNSPECIFIED            = 1,
887         IEEE80211_REASON_AUTH_EXPIRE            = 2,
888         IEEE80211_REASON_AUTH_LEAVE             = 3,
889         IEEE80211_REASON_ASSOC_EXPIRE           = 4,
890         IEEE80211_REASON_ASSOC_TOOMANY          = 5,
891         IEEE80211_REASON_NOT_AUTHED             = 6,
892         IEEE80211_REASON_NOT_ASSOCED            = 7,
893         IEEE80211_REASON_ASSOC_LEAVE            = 8,
894         IEEE80211_REASON_ASSOC_NOT_AUTHED       = 9,
895         IEEE80211_REASON_DISASSOC_PWRCAP_BAD    = 10,   /* 11h */
896         IEEE80211_REASON_DISASSOC_SUPCHAN_BAD   = 11,   /* 11h */
897         IEEE80211_REASON_IE_INVALID             = 13,   /* 11i */
898         IEEE80211_REASON_MIC_FAILURE            = 14,   /* 11i */
899         IEEE80211_REASON_4WAY_HANDSHAKE_TIMEOUT = 15,   /* 11i */
900         IEEE80211_REASON_GROUP_KEY_UPDATE_TIMEOUT = 16, /* 11i */
901         IEEE80211_REASON_IE_IN_4WAY_DIFFERS     = 17,   /* 11i */
902         IEEE80211_REASON_GROUP_CIPHER_INVALID   = 18,   /* 11i */
903         IEEE80211_REASON_PAIRWISE_CIPHER_INVALID= 19,   /* 11i */
904         IEEE80211_REASON_AKMP_INVALID           = 20,   /* 11i */
905         IEEE80211_REASON_UNSUPP_RSN_IE_VERSION  = 21,   /* 11i */
906         IEEE80211_REASON_INVALID_RSN_IE_CAP     = 22,   /* 11i */
907         IEEE80211_REASON_802_1X_AUTH_FAILED     = 23,   /* 11i */
908         IEEE80211_REASON_CIPHER_SUITE_REJECTED  = 24,   /* 11i */
909         IEEE80211_REASON_UNSPECIFIED_QOS        = 32,   /* 11e */
910         IEEE80211_REASON_INSUFFICIENT_BW        = 33,   /* 11e */
911         IEEE80211_REASON_TOOMANY_FRAMES         = 34,   /* 11e */
912         IEEE80211_REASON_OUTSIDE_TXOP           = 35,   /* 11e */
913         IEEE80211_REASON_LEAVING_QBSS           = 36,   /* 11e */
914         IEEE80211_REASON_BAD_MECHANISM          = 37,   /* 11e */
915         IEEE80211_REASON_SETUP_NEEDED           = 38,   /* 11e */
916         IEEE80211_REASON_TIMEOUT                = 39,   /* 11e */
917
918         /* values not yet allocated by ANA */
919         IEEE80211_REASON_PEER_LINK_CANCELED     = 2,    /* 11s */
920         IEEE80211_REASON_MESH_MAX_PEERS         = 3,    /* 11s */
921         IEEE80211_REASON_MESH_CPVIOLATION       = 4,    /* 11s */
922         IEEE80211_REASON_MESH_CLOSE_RCVD        = 5,    /* 11s */
923         IEEE80211_REASON_MESH_MAX_RETRIES       = 6,    /* 11s */
924         IEEE80211_REASON_MESH_CONFIRM_TIMEOUT   = 7,    /* 11s */
925         IEEE80211_REASON_MESH_INVALID_GTK       = 8,    /* 11s */
926         IEEE80211_REASON_MESH_INCONS_PARAMS     = 9,    /* 11s */
927         IEEE80211_REASON_MESH_INVALID_SECURITY  = 10,   /* 11s */
928         IEEE80211_REASON_MESH_PERR_UNSPEC       = 11,   /* 11s */
929         IEEE80211_REASON_MESH_PERR_NO_FI        = 12,   /* 11s */
930         IEEE80211_REASON_MESH_PERR_DEST_UNREACH = 13,   /* 11s */
931
932         IEEE80211_STATUS_SUCCESS                = 0,
933         IEEE80211_STATUS_UNSPECIFIED            = 1,
934         IEEE80211_STATUS_CAPINFO                = 10,
935         IEEE80211_STATUS_NOT_ASSOCED            = 11,
936         IEEE80211_STATUS_OTHER                  = 12,
937         IEEE80211_STATUS_ALG                    = 13,
938         IEEE80211_STATUS_SEQUENCE               = 14,
939         IEEE80211_STATUS_CHALLENGE              = 15,
940         IEEE80211_STATUS_TIMEOUT                = 16,
941         IEEE80211_STATUS_TOOMANY                = 17,
942         IEEE80211_STATUS_BASIC_RATE             = 18,
943         IEEE80211_STATUS_SP_REQUIRED            = 19,   /* 11b */
944         IEEE80211_STATUS_PBCC_REQUIRED          = 20,   /* 11b */
945         IEEE80211_STATUS_CA_REQUIRED            = 21,   /* 11b */
946         IEEE80211_STATUS_SPECMGMT_REQUIRED      = 22,   /* 11h */
947         IEEE80211_STATUS_PWRCAP_REQUIRED        = 23,   /* 11h */
948         IEEE80211_STATUS_SUPCHAN_REQUIRED       = 24,   /* 11h */
949         IEEE80211_STATUS_SHORTSLOT_REQUIRED     = 25,   /* 11g */
950         IEEE80211_STATUS_DSSSOFDM_REQUIRED      = 26,   /* 11g */
951         IEEE80211_STATUS_MISSING_HT_CAPS        = 27,   /* 11n D3.0 */
952         IEEE80211_STATUS_INVALID_IE             = 40,   /* 11i */
953         IEEE80211_STATUS_GROUP_CIPHER_INVALID   = 41,   /* 11i */
954         IEEE80211_STATUS_PAIRWISE_CIPHER_INVALID = 42,  /* 11i */
955         IEEE80211_STATUS_AKMP_INVALID           = 43,   /* 11i */
956         IEEE80211_STATUS_UNSUPP_RSN_IE_VERSION  = 44,   /* 11i */
957         IEEE80211_STATUS_INVALID_RSN_IE_CAP     = 45,   /* 11i */
958         IEEE80211_STATUS_CIPHER_SUITE_REJECTED  = 46,   /* 11i */
959 };
960
961 #define IEEE80211_WEP_KEYLEN            5       /* 40bit */
962 #define IEEE80211_WEP_IVLEN             3       /* 24bit */
963 #define IEEE80211_WEP_KIDLEN            1       /* 1 octet */
964 #define IEEE80211_WEP_CRCLEN            4       /* CRC-32 */
965 #define IEEE80211_WEP_TOTLEN            (IEEE80211_WEP_IVLEN + \
966                                          IEEE80211_WEP_KIDLEN + \
967                                          IEEE80211_WEP_CRCLEN)
968 #define IEEE80211_WEP_NKID              4       /* number of key ids */
969
970 /*
971  * 802.11i defines an extended IV for use with non-WEP ciphers.
972  * When the EXTIV bit is set in the key id byte an additional
973  * 4 bytes immediately follow the IV for TKIP.  For CCMP the
974  * EXTIV bit is likewise set but the 8 bytes represent the
975  * CCMP header rather than IV+extended-IV.
976  */
977 #define IEEE80211_WEP_EXTIV             0x20
978 #define IEEE80211_WEP_EXTIVLEN          4       /* extended IV length */
979 #define IEEE80211_WEP_MICLEN            8       /* trailing MIC */
980
981 #define IEEE80211_CRC_LEN               4
982
983 /*
984  * Maximum acceptable MTU is:
985  *      IEEE80211_MAX_LEN - WEP overhead - CRC -
986  *              QoS overhead - RSN/WPA overhead
987  * Min is arbitrarily chosen > IEEE80211_MIN_LEN.  The default
988  * mtu is Ethernet-compatible; it's set by ether_ifattach.
989  */
990 #define IEEE80211_MTU_MAX               2290
991 #define IEEE80211_MTU_MIN               32
992
993 #define IEEE80211_MAX_LEN               (2300 + IEEE80211_CRC_LEN + \
994     (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN + IEEE80211_WEP_CRCLEN))
995 #define IEEE80211_ACK_LEN \
996         (sizeof(struct ieee80211_frame_ack) + IEEE80211_CRC_LEN)
997 #define IEEE80211_MIN_LEN \
998         (sizeof(struct ieee80211_frame_min) + IEEE80211_CRC_LEN)
999
1000 /*
1001  * The 802.11 spec says at most 2007 stations may be
1002  * associated at once.  For most AP's this is way more
1003  * than is feasible so we use a default of IEEE80211_AID_DEF.
1004  * This number may be overridden by the driver and/or by
1005  * user configuration but may not be less than IEEE80211_AID_MIN
1006  * (see _ieee80211.h for implementation-specific settings).
1007  */
1008 #define IEEE80211_AID_MAX               2007
1009
1010 #define IEEE80211_AID(b)        ((b) &~ 0xc000)
1011
1012 /* 
1013  * RTS frame length parameters.  The default is specified in
1014  * the 802.11 spec as 512; we treat it as implementation-dependent
1015  * so it's defined in ieee80211_var.h.  The max may be wrong
1016  * for jumbo frames.
1017  */
1018 #define IEEE80211_RTS_MIN               1
1019 #define IEEE80211_RTS_MAX               2346
1020
1021 /* 
1022  * TX fragmentation parameters.  As above for RTS, we treat
1023  * default as implementation-dependent so define it elsewhere.
1024  */
1025 #define IEEE80211_FRAG_MIN              256
1026 #define IEEE80211_FRAG_MAX              2346
1027
1028 /*
1029  * Beacon interval (TU's).  Min+max come from WiFi requirements.
1030  * As above, we treat default as implementation-dependent so
1031  * define it elsewhere.
1032  */
1033 #define IEEE80211_BINTVAL_MAX   1000    /* max beacon interval (TU's) */
1034 #define IEEE80211_BINTVAL_MIN   25      /* min beacon interval (TU's) */
1035
1036 /*
1037  * DTIM period (beacons).  Min+max are not really defined
1038  * by the protocol but we want them publicly visible so
1039  * define them here.
1040  */
1041 #define IEEE80211_DTIM_MAX      15      /* max DTIM period */
1042 #define IEEE80211_DTIM_MIN      1       /* min DTIM period */
1043
1044 /*
1045  * Beacon miss threshold (beacons).  As for DTIM, we define
1046  * them here to be publicly visible.  Note the max may be
1047  * clamped depending on device capabilities.
1048  */
1049 #define IEEE80211_HWBMISS_MIN   1
1050 #define IEEE80211_HWBMISS_MAX   255
1051
1052 /*
1053  * 802.11 frame duration definitions.
1054  */
1055
1056 struct ieee80211_duration {
1057         uint16_t        d_rts_dur;
1058         uint16_t        d_data_dur;
1059         uint16_t        d_plcp_len;
1060         uint8_t         d_residue;      /* unused octets in time slot */
1061 };
1062
1063 /* One Time Unit (TU) is 1Kus = 1024 microseconds. */
1064 #define IEEE80211_DUR_TU                1024
1065
1066 /* IEEE 802.11b durations for DSSS PHY in microseconds */
1067 #define IEEE80211_DUR_DS_LONG_PREAMBLE  144
1068 #define IEEE80211_DUR_DS_SHORT_PREAMBLE 72
1069
1070 #define IEEE80211_DUR_DS_SLOW_PLCPHDR   48
1071 #define IEEE80211_DUR_DS_FAST_PLCPHDR   24
1072 #define IEEE80211_DUR_DS_SLOW_ACK       112
1073 #define IEEE80211_DUR_DS_FAST_ACK       56
1074 #define IEEE80211_DUR_DS_SLOW_CTS       112
1075 #define IEEE80211_DUR_DS_FAST_CTS       56
1076
1077 #define IEEE80211_DUR_DS_SLOT           20
1078 #define IEEE80211_DUR_DS_SIFS           10
1079 #define IEEE80211_DUR_DS_PIFS   (IEEE80211_DUR_DS_SIFS + IEEE80211_DUR_DS_SLOT)
1080 #define IEEE80211_DUR_DS_DIFS   (IEEE80211_DUR_DS_SIFS + \
1081                                  2 * IEEE80211_DUR_DS_SLOT)
1082 #define IEEE80211_DUR_DS_EIFS   (IEEE80211_DUR_DS_SIFS + \
1083                                  IEEE80211_DUR_DS_SLOW_ACK + \
1084                                  IEEE80211_DUR_DS_LONG_PREAMBLE + \
1085                                  IEEE80211_DUR_DS_SLOW_PLCPHDR + \
1086                                  IEEE80211_DUR_DIFS)
1087
1088 extern lwkt_token wlan_token;
1089
1090 #endif /* _NET80211_IEEE80211_H_ */