ieee80211.h revision 120098
1116742Ssam/*- 2116904Ssam * Copyright (c) 2001 Atsushi Onoe 3116742Ssam * Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting 4116742Ssam * All rights reserved. 5116742Ssam * 6116742Ssam * Redistribution and use in source and binary forms, with or without 7116742Ssam * modification, are permitted provided that the following conditions 8116742Ssam * are met: 9116742Ssam * 1. Redistributions of source code must retain the above copyright 10116742Ssam * notice, this list of conditions and the following disclaimer. 11116742Ssam * 2. Redistributions in binary form must reproduce the above copyright 12116742Ssam * notice, this list of conditions and the following disclaimer in the 13116742Ssam * documentation and/or other materials provided with the distribution. 14116904Ssam * 3. The name of the author may not be used to endorse or promote products 15116904Ssam * derived from this software without specific prior written permission. 16116742Ssam * 17116904Ssam * Alternatively, this software may be distributed under the terms of the 18116904Ssam * GNU General Public License ("GPL") version 2 as published by the Free 19116904Ssam * Software Foundation. 20116742Ssam * 21116904Ssam * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22116904Ssam * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23116904Ssam * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24116904Ssam * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25116904Ssam * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26116904Ssam * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27116904Ssam * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28116904Ssam * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29116904Ssam * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30116904Ssam * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31116904Ssam * 32116742Ssam * $FreeBSD: head/sys/net80211/ieee80211.h 120098 2003-09-15 19:36:34Z sam $ 33116742Ssam */ 34116742Ssam#ifndef _NET80211_IEEE80211_H_ 35116742Ssam#define _NET80211_IEEE80211_H_ 36116742Ssam 37116742Ssam/* 38116742Ssam * 802.11 protocol definitions. 39116742Ssam */ 40116742Ssam 41116742Ssam#define IEEE80211_ADDR_LEN 6 /* size of 802.11 address */ 42116742Ssam/* is 802.11 address multicast/broadcast? */ 43116742Ssam#define IEEE80211_IS_MULTICAST(_a) (*(_a) & 0x01) 44116742Ssam 45116742Ssam/* IEEE 802.11 PLCP header */ 46116742Ssamstruct ieee80211_plcp_hdr { 47116742Ssam u_int16_t i_sfd; 48116742Ssam u_int8_t i_signal; 49116742Ssam u_int8_t i_service; 50116742Ssam u_int16_t i_length; 51116742Ssam u_int16_t i_crc; 52116742Ssam} __attribute__((__packed__)); 53116742Ssam 54116742Ssam/* 55116742Ssam * generic definitions for IEEE 802.11 frames 56116742Ssam */ 57116742Ssamstruct ieee80211_frame { 58116742Ssam u_int8_t i_fc[2]; 59116742Ssam u_int8_t i_dur[2]; 60116742Ssam u_int8_t i_addr1[IEEE80211_ADDR_LEN]; 61116742Ssam u_int8_t i_addr2[IEEE80211_ADDR_LEN]; 62116742Ssam u_int8_t i_addr3[IEEE80211_ADDR_LEN]; 63116742Ssam u_int8_t i_seq[2]; 64116742Ssam /* possibly followed by addr4[IEEE80211_ADDR_LEN]; */ 65116742Ssam /* see below */ 66116742Ssam} __attribute__((__packed__)); 67116742Ssam 68116742Ssamstruct ieee80211_frame_addr4 { 69116742Ssam u_int8_t i_fc[2]; 70116742Ssam u_int8_t i_dur[2]; 71116742Ssam u_int8_t i_addr1[IEEE80211_ADDR_LEN]; 72116742Ssam u_int8_t i_addr2[IEEE80211_ADDR_LEN]; 73116742Ssam u_int8_t i_addr3[IEEE80211_ADDR_LEN]; 74116742Ssam u_int8_t i_seq[2]; 75116742Ssam u_int8_t i_addr4[IEEE80211_ADDR_LEN]; 76116742Ssam} __attribute__((__packed__)); 77116742Ssam 78116742Ssam#define IEEE80211_FC0_VERSION_MASK 0x03 79116742Ssam#define IEEE80211_FC0_VERSION_SHIFT 0 80116742Ssam#define IEEE80211_FC0_VERSION_0 0x00 81116742Ssam#define IEEE80211_FC0_TYPE_MASK 0x0c 82116742Ssam#define IEEE80211_FC0_TYPE_SHIFT 2 83116742Ssam#define IEEE80211_FC0_TYPE_MGT 0x00 84116742Ssam#define IEEE80211_FC0_TYPE_CTL 0x04 85116742Ssam#define IEEE80211_FC0_TYPE_DATA 0x08 86116742Ssam 87116742Ssam#define IEEE80211_FC0_SUBTYPE_MASK 0xf0 88116742Ssam#define IEEE80211_FC0_SUBTYPE_SHIFT 4 89116742Ssam/* for TYPE_MGT */ 90116742Ssam#define IEEE80211_FC0_SUBTYPE_ASSOC_REQ 0x00 91116742Ssam#define IEEE80211_FC0_SUBTYPE_ASSOC_RESP 0x10 92116742Ssam#define IEEE80211_FC0_SUBTYPE_REASSOC_REQ 0x20 93116742Ssam#define IEEE80211_FC0_SUBTYPE_REASSOC_RESP 0x30 94116742Ssam#define IEEE80211_FC0_SUBTYPE_PROBE_REQ 0x40 95116742Ssam#define IEEE80211_FC0_SUBTYPE_PROBE_RESP 0x50 96116742Ssam#define IEEE80211_FC0_SUBTYPE_BEACON 0x80 97116742Ssam#define IEEE80211_FC0_SUBTYPE_ATIM 0x90 98116742Ssam#define IEEE80211_FC0_SUBTYPE_DISASSOC 0xa0 99116742Ssam#define IEEE80211_FC0_SUBTYPE_AUTH 0xb0 100116742Ssam#define IEEE80211_FC0_SUBTYPE_DEAUTH 0xc0 101116742Ssam/* for TYPE_CTL */ 102116742Ssam#define IEEE80211_FC0_SUBTYPE_PS_POLL 0xa0 103116742Ssam#define IEEE80211_FC0_SUBTYPE_RTS 0xb0 104116742Ssam#define IEEE80211_FC0_SUBTYPE_CTS 0xc0 105116742Ssam#define IEEE80211_FC0_SUBTYPE_ACK 0xd0 106116742Ssam#define IEEE80211_FC0_SUBTYPE_CF_END 0xe0 107116742Ssam#define IEEE80211_FC0_SUBTYPE_CF_END_ACK 0xf0 108116742Ssam/* for TYPE_DATA (bit combination) */ 109116742Ssam#define IEEE80211_FC0_SUBTYPE_DATA 0x00 110116742Ssam#define IEEE80211_FC0_SUBTYPE_CF_ACK 0x10 111116742Ssam#define IEEE80211_FC0_SUBTYPE_CF_POLL 0x20 112116742Ssam#define IEEE80211_FC0_SUBTYPE_CF_ACPL 0x30 113116742Ssam#define IEEE80211_FC0_SUBTYPE_NODATA 0x40 114116742Ssam#define IEEE80211_FC0_SUBTYPE_CFACK 0x50 115116742Ssam#define IEEE80211_FC0_SUBTYPE_CFPOLL 0x60 116116742Ssam#define IEEE80211_FC0_SUBTYPE_CF_ACK_CF_ACK 0x70 117116742Ssam 118116742Ssam#define IEEE80211_FC1_DIR_MASK 0x03 119116742Ssam#define IEEE80211_FC1_DIR_NODS 0x00 /* STA->STA */ 120116742Ssam#define IEEE80211_FC1_DIR_TODS 0x01 /* STA->AP */ 121116742Ssam#define IEEE80211_FC1_DIR_FROMDS 0x02 /* AP ->STA */ 122116742Ssam#define IEEE80211_FC1_DIR_DSTODS 0x03 /* AP ->AP */ 123116742Ssam 124116742Ssam#define IEEE80211_FC1_MORE_FRAG 0x04 125116742Ssam#define IEEE80211_FC1_RETRY 0x08 126116742Ssam#define IEEE80211_FC1_PWR_MGT 0x10 127116742Ssam#define IEEE80211_FC1_MORE_DATA 0x20 128116742Ssam#define IEEE80211_FC1_WEP 0x40 129116742Ssam#define IEEE80211_FC1_ORDER 0x80 130116742Ssam 131116742Ssam#define IEEE80211_SEQ_FRAG_MASK 0x000f 132116742Ssam#define IEEE80211_SEQ_FRAG_SHIFT 0 133116742Ssam#define IEEE80211_SEQ_SEQ_MASK 0xfff0 134116742Ssam#define IEEE80211_SEQ_SEQ_SHIFT 4 135116742Ssam 136116742Ssam#define IEEE80211_NWID_LEN 32 137116742Ssam 138116742Ssam/* 139120098Ssam * Control frames. 140120098Ssam */ 141120098Ssamstruct ieee80211_frame_min { 142120098Ssam u_int8_t i_fc[2]; 143120098Ssam u_int8_t i_dur[2]; 144120098Ssam u_int8_t i_addr1[IEEE80211_ADDR_LEN]; 145120098Ssam u_int8_t i_addr2[IEEE80211_ADDR_LEN]; 146120098Ssam /* FCS */ 147120098Ssam} __attribute__((__packed__)); 148120098Ssam 149120098Ssamstruct ieee80211_frame_rts { 150120098Ssam u_int8_t i_fc[2]; 151120098Ssam u_int8_t i_dur[2]; 152120098Ssam u_int8_t i_ra[IEEE80211_ADDR_LEN]; 153120098Ssam u_int8_t i_ta[IEEE80211_ADDR_LEN]; 154120098Ssam /* FCS */ 155120098Ssam} __attribute__((__packed__)); 156120098Ssam 157120098Ssamstruct ieee80211_frame_cts { 158120098Ssam u_int8_t i_fc[2]; 159120098Ssam u_int8_t i_dur[2]; 160120098Ssam u_int8_t i_ra[IEEE80211_ADDR_LEN]; 161120098Ssam /* FCS */ 162120098Ssam} __attribute__((__packed__)); 163120098Ssam 164120098Ssamstruct ieee80211_frame_ack { 165120098Ssam u_int8_t i_fc[2]; 166120098Ssam u_int8_t i_dur[2]; 167120098Ssam u_int8_t i_ra[IEEE80211_ADDR_LEN]; 168120098Ssam /* FCS */ 169120098Ssam} __attribute__((__packed__)); 170120098Ssam 171120098Ssamstruct ieee80211_frame_pspoll { 172120098Ssam u_int8_t i_fc[2]; 173120098Ssam u_int8_t i_aid[2]; 174120098Ssam u_int8_t i_bssid[IEEE80211_ADDR_LEN]; 175120098Ssam u_int8_t i_ta[IEEE80211_ADDR_LEN]; 176120098Ssam /* FCS */ 177120098Ssam} __attribute__((__packed__)); 178120098Ssam 179120098Ssamstruct ieee80211_frame_cfend { /* NB: also CF-End+CF-Ack */ 180120098Ssam u_int8_t i_fc[2]; 181120098Ssam u_int8_t i_dur[2]; /* should be zero */ 182120098Ssam u_int8_t i_ra[IEEE80211_ADDR_LEN]; 183120098Ssam u_int8_t i_bssid[IEEE80211_ADDR_LEN]; 184120098Ssam /* FCS */ 185120098Ssam} __attribute__((__packed__)); 186120098Ssam 187120098Ssam/* 188116742Ssam * BEACON management packets 189116742Ssam * 190116742Ssam * octet timestamp[8] 191116742Ssam * octet beacon interval[2] 192116742Ssam * octet capability information[2] 193116742Ssam * information element 194116742Ssam * octet elemid 195116742Ssam * octet length 196116742Ssam * octet information[length] 197116742Ssam */ 198116742Ssam 199116742Ssamtypedef uint8_t *ieee80211_mgt_beacon_t; 200116742Ssam 201116742Ssam#define IEEE80211_BEACON_INTERVAL(beacon) \ 202116742Ssam ((beacon)[8] | ((beacon)[9] << 8)) 203116742Ssam#define IEEE80211_BEACON_CAPABILITY(beacon) \ 204116742Ssam ((beacon)[10] | ((beacon)[11] << 8)) 205116742Ssam 206116742Ssam#define IEEE80211_CAPINFO_ESS 0x0001 207116742Ssam#define IEEE80211_CAPINFO_IBSS 0x0002 208116742Ssam#define IEEE80211_CAPINFO_CF_POLLABLE 0x0004 209116742Ssam#define IEEE80211_CAPINFO_CF_POLLREQ 0x0008 210116742Ssam#define IEEE80211_CAPINFO_PRIVACY 0x0010 211116742Ssam#define IEEE80211_CAPINFO_SHORT_PREAMBLE 0x0020 212116742Ssam#define IEEE80211_CAPINFO_PBCC 0x0040 213116742Ssam#define IEEE80211_CAPINFO_CHNL_AGILITY 0x0080 214116742Ssam/* bits 8-9 are reserved */ 215116742Ssam#define IEEE80211_CAPINFO_SHORT_SLOTTIME 0x0400 216116742Ssam/* bits 11-12 are reserved */ 217116742Ssam#define IEEE80211_CAPINFO_DSSSOFDM 0x2000 218116742Ssam/* bits 14-15 are reserved */ 219116742Ssam 220116742Ssam/* 221116742Ssam * Management information elements 222116742Ssam */ 223116742Ssamstruct ieee80211_information { 224116742Ssam char ssid[IEEE80211_NWID_LEN+1]; 225116742Ssam struct rates { 226116742Ssam u_int8_t *p; 227116742Ssam } rates; 228116742Ssam struct fh { 229116742Ssam u_int16_t dwell; 230116742Ssam u_int8_t set; 231116742Ssam u_int8_t pattern; 232116742Ssam u_int8_t index; 233116742Ssam } fh; 234116742Ssam struct ds { 235116742Ssam u_int8_t channel; 236116742Ssam } ds; 237116742Ssam struct cf { 238116742Ssam u_int8_t count; 239116742Ssam u_int8_t period; 240116742Ssam u_int8_t maxdur[2]; 241116742Ssam u_int8_t dur[2]; 242116742Ssam } cf; 243116742Ssam struct tim { 244116742Ssam u_int8_t count; 245116742Ssam u_int8_t period; 246116742Ssam u_int8_t bitctl; 247116742Ssam /* u_int8_t pvt[251]; The driver needs to use this. */ 248116742Ssam } tim; 249116742Ssam struct ibss { 250116742Ssam u_int16_t atim; 251116742Ssam } ibss; 252116742Ssam struct challenge { 253116742Ssam u_int8_t *p; 254116742Ssam u_int8_t len; 255116742Ssam } challenge; 256116742Ssam struct erp { 257116742Ssam u_int8_t flags; 258116742Ssam } erp; 259116742Ssam}; 260116742Ssam 261116742Ssamenum { 262116742Ssam IEEE80211_ELEMID_SSID = 0, 263116742Ssam IEEE80211_ELEMID_RATES = 1, 264116742Ssam IEEE80211_ELEMID_FHPARMS = 2, 265116742Ssam IEEE80211_ELEMID_DSPARMS = 3, 266116742Ssam IEEE80211_ELEMID_CFPARMS = 4, 267116742Ssam IEEE80211_ELEMID_TIM = 5, 268116742Ssam IEEE80211_ELEMID_IBSSPARMS = 6, 269116742Ssam IEEE80211_ELEMID_COUNTRY = 7, 270116742Ssam IEEE80211_ELEMID_CHALLENGE = 16, 271116742Ssam IEEE80211_ELEMID_ERP = 42, 272116742Ssam IEEE80211_ELEMID_XRATES = 50, 273116742Ssam}; 274116742Ssam 275116742Ssam#define IEEE80211_RATE_BASIC 0x80 276116742Ssam#define IEEE80211_RATE_VAL 0x7f 277116742Ssam 278116742Ssam/* EPR information element flags */ 279116742Ssam#define IEEE80211_ERP_NON_ERP_PRESENT 0x01 280116742Ssam#define IEEE80211_ERP_USE_PROTECTION 0x02 281116742Ssam#define IEEE80211_ERP_BARKER_MODE 0x04 282116742Ssam 283116742Ssam/* 284116742Ssam * AUTH management packets 285116742Ssam * 286116742Ssam * octet algo[2] 287116742Ssam * octet seq[2] 288116742Ssam * octet status[2] 289116742Ssam * octet chal.id 290116742Ssam * octet chal.length 291116742Ssam * octet chal.text[253] 292116742Ssam */ 293116742Ssam 294116742Ssamtypedef u_int8_t *ieee80211_mgt_auth_t; 295116742Ssam 296116742Ssam#define IEEE80211_AUTH_ALGORITHM(auth) \ 297116742Ssam ((auth)[0] | ((auth)[1] << 8)) 298116742Ssam#define IEEE80211_AUTH_TRANSACTION(auth) \ 299116742Ssam ((auth)[2] | ((auth)[3] << 8)) 300116742Ssam#define IEEE80211_AUTH_STATUS(auth) \ 301116742Ssam ((auth)[4] | ((auth)[5] << 8)) 302116742Ssam 303116742Ssam#define IEEE80211_AUTH_ALG_OPEN 0x0000 304116742Ssam#define IEEE80211_AUTH_ALG_SHARED 0x0001 305116742Ssam 306116742Ssamenum { 307116742Ssam IEEE80211_AUTH_OPEN_REQUEST = 1, 308116742Ssam IEEE80211_AUTH_OPEN_RESPONSE = 2, 309116742Ssam}; 310116742Ssam 311116742Ssamenum { 312116742Ssam IEEE80211_AUTH_SHARED_REQUEST = 1, 313116742Ssam IEEE80211_AUTH_SHARED_CHALLENGE = 2, 314116742Ssam IEEE80211_AUTH_SHARED_RESPONSE = 3, 315116742Ssam IEEE80211_AUTH_SHARED_PASS = 4, 316116742Ssam}; 317116742Ssam 318116742Ssam/* 319116742Ssam * Reason codes 320116742Ssam * 321116742Ssam * Unlisted codes are reserved 322116742Ssam */ 323116742Ssam 324116742Ssamenum { 325116742Ssam IEEE80211_REASON_UNSPECIFIED = 1, 326116742Ssam IEEE80211_REASON_AUTH_EXPIRE = 2, 327116742Ssam IEEE80211_REASON_AUTH_LEAVE = 3, 328116742Ssam IEEE80211_REASON_ASSOC_EXPIRE = 4, 329116742Ssam IEEE80211_REASON_ASSOC_TOOMANY = 5, 330116742Ssam IEEE80211_REASON_NOT_AUTHED = 6, 331116742Ssam IEEE80211_REASON_NOT_ASSOCED = 7, 332116742Ssam IEEE80211_REASON_ASSOC_LEAVE = 8, 333116742Ssam IEEE80211_REASON_ASSOC_NOT_AUTHED = 9, 334116742Ssam 335116742Ssam IEEE80211_STATUS_SUCCESS = 0, 336116742Ssam IEEE80211_STATUS_UNSPECIFIED = 1, 337116742Ssam IEEE80211_STATUS_CAPINFO = 10, 338116742Ssam IEEE80211_STATUS_NOT_ASSOCED = 11, 339116742Ssam IEEE80211_STATUS_OTHER = 12, 340116742Ssam IEEE80211_STATUS_ALG = 13, 341116742Ssam IEEE80211_STATUS_SEQUENCE = 14, 342116742Ssam IEEE80211_STATUS_CHALLENGE = 15, 343116742Ssam IEEE80211_STATUS_TIMEOUT = 16, 344116742Ssam IEEE80211_STATUS_TOOMANY = 17, 345116742Ssam IEEE80211_STATUS_BASIC_RATE = 18, 346116742Ssam IEEE80211_STATUS_SP_REQUIRED = 19, 347116742Ssam IEEE80211_STATUS_PBCC_REQUIRED = 20, 348116742Ssam IEEE80211_STATUS_CA_REQUIRED = 21, 349116742Ssam IEEE80211_STATUS_TOO_MANY_STATIONS = 22, 350116742Ssam IEEE80211_STATUS_RATES = 23, 351116742Ssam IEEE80211_STATUS_SHORTSLOT_REQUIRED = 25, 352116742Ssam IEEE80211_STATUS_DSSSOFDM_REQUIRED = 26, 353116742Ssam}; 354116742Ssam 355116742Ssam#define IEEE80211_WEP_KEYLEN 5 /* 40bit */ 356116742Ssam#define IEEE80211_WEP_IVLEN 3 /* 24bit */ 357116742Ssam#define IEEE80211_WEP_KIDLEN 1 /* 1 octet */ 358116742Ssam#define IEEE80211_WEP_CRCLEN 4 /* CRC-32 */ 359116742Ssam#define IEEE80211_WEP_NKID 4 /* number of key ids */ 360116742Ssam 361116742Ssam#define IEEE80211_CRC_LEN 4 362116742Ssam 363116742Ssam#define IEEE80211_MTU 1500 364116742Ssam#define IEEE80211_MAX_LEN (2300 + IEEE80211_CRC_LEN + \ 365116742Ssam (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN + IEEE80211_WEP_CRCLEN)) 366120098Ssam#define IEEE80211_MIN_LEN \ 367120098Ssam (sizeof(struct ieee80211_frame_min) + IEEE80211_CRC_LEN) 368116742Ssam 369116742Ssam/* 370116742Ssam * RTS frame length parameters. The default is specified in 371116742Ssam * the 802.11 spec. The max may be wrong for jumbo frames. 372116742Ssam */ 373116742Ssam#define IEEE80211_RTS_DEFAULT 512 374116742Ssam#define IEEE80211_RTS_MIN 1 375116742Ssam#define IEEE80211_RTS_MAX IEEE80211_MAX_LEN 376116742Ssam 377116742Ssamenum { 378116742Ssam IEEE80211_AUTH_NONE = 0, 379116742Ssam IEEE80211_AUTH_OPEN = 1, 380116742Ssam IEEE80211_AUTH_SHARED = 2, 381116742Ssam}; 382116742Ssam 383116742Ssam#endif /* _NET80211_IEEE80211_H_ */ 384