1 /* $OpenBSD: ieee80211_var.h,v 1.72 2016/05/21 09:07:11 stsp Exp $ */ 2 /* $NetBSD: ieee80211_var.h,v 1.7 2004/05/06 03:07:10 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 * 3. The name of the author may not be used to endorse or promote products 18 * derived from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 * 31 * $FreeBSD: src/sys/net80211/ieee80211_var.h,v 1.15 2004/04/05 22:10:26 sam Exp $ 32 */ 33 #ifndef _NET80211_IEEE80211_VAR_H_ 34 #define _NET80211_IEEE80211_VAR_H_ 35 36 /* 37 * Definitions for IEEE 802.11 drivers. 38 */ 39 40 #ifdef SMALL_KERNEL 41 #define IEEE80211_STA_ONLY 1 42 #endif 43 44 #include <sys/timeout.h> 45 46 #include <net80211/ieee80211.h> 47 #include <net80211/ieee80211_crypto.h> 48 #include <net80211/ieee80211_ioctl.h> /* for ieee80211_stats */ 49 #include <net80211/ieee80211_node.h> 50 #include <net80211/ieee80211_proto.h> 51 52 #define IEEE80211_CHAN_MAX 255 53 #define IEEE80211_CHAN_ANY 0xffff /* token for ``any channel'' */ 54 #define IEEE80211_CHAN_ANYC \ 55 ((struct ieee80211_channel *) IEEE80211_CHAN_ANY) 56 57 #define IEEE80211_TXPOWER_MAX 100 /* max power */ 58 #define IEEE80211_TXPOWER_MIN -50 /* kill radio (if possible) */ 59 60 enum ieee80211_phytype { 61 IEEE80211_T_DS, /* direct sequence spread spectrum */ 62 IEEE80211_T_OFDM, /* frequency division multiplexing */ 63 IEEE80211_T_XR /* extended range mode */ 64 }; 65 #define IEEE80211_T_CCK IEEE80211_T_DS /* more common nomenclature */ 66 67 /* XXX not really a mode; there are really multiple PHY's */ 68 enum ieee80211_phymode { 69 IEEE80211_MODE_AUTO = 0, /* autoselect */ 70 IEEE80211_MODE_11A = 1, /* 5GHz, OFDM */ 71 IEEE80211_MODE_11B = 2, /* 2GHz, CCK */ 72 IEEE80211_MODE_11G = 3, /* 2GHz, OFDM */ 73 IEEE80211_MODE_11N = 4, /* 11n, 2GHz/5GHz */ 74 }; 75 #define IEEE80211_MODE_MAX (IEEE80211_MODE_11N+1) 76 77 enum ieee80211_opmode { 78 IEEE80211_M_STA = 1, /* infrastructure station */ 79 #ifndef IEEE80211_STA_ONLY 80 IEEE80211_M_IBSS = 0, /* IBSS (adhoc) station */ 81 IEEE80211_M_AHDEMO = 3, /* Old lucent compatible adhoc demo */ 82 IEEE80211_M_HOSTAP = 6, /* Software Access Point */ 83 #endif 84 IEEE80211_M_MONITOR = 8 /* Monitor mode */ 85 }; 86 87 /* 88 * 802.11g protection mode. 89 */ 90 enum ieee80211_protmode { 91 IEEE80211_PROT_NONE = 0, /* no protection */ 92 IEEE80211_PROT_CTSONLY = 1, /* CTS to self */ 93 IEEE80211_PROT_RTSCTS = 2 /* RTS-CTS */ 94 }; 95 96 /* 97 * Channels are specified by frequency and attributes. 98 */ 99 struct ieee80211_channel { 100 u_int16_t ic_freq; /* setting in MHz */ 101 u_int16_t ic_flags; /* see below */ 102 }; 103 104 /* 105 * Channel attributes (XXX must keep in sync with radiotap flags). 106 */ 107 #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */ 108 #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */ 109 #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel */ 110 #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */ 111 #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */ 112 #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */ 113 #define IEEE80211_CHAN_XR 0x1000 /* Extended range OFDM channel */ 114 #define IEEE80211_CHAN_HT 0x2000 /* 11n/HT channel */ 115 116 /* 117 * Useful combinations of channel characteristics. 118 */ 119 #define IEEE80211_CHAN_A \ 120 (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM) 121 #define IEEE80211_CHAN_B \ 122 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK) 123 #define IEEE80211_CHAN_PUREG \ 124 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM) 125 #define IEEE80211_CHAN_G \ 126 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN) 127 128 #define IEEE80211_IS_CHAN_A(_c) \ 129 (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A) 130 #define IEEE80211_IS_CHAN_B(_c) \ 131 (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B) 132 #define IEEE80211_IS_CHAN_PUREG(_c) \ 133 (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG) 134 #define IEEE80211_IS_CHAN_G(_c) \ 135 (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G) 136 #define IEEE80211_IS_CHAN_N(_c) \ 137 (((_c)->ic_flags & IEEE80211_CHAN_HT) == IEEE80211_CHAN_HT) 138 139 #define IEEE80211_IS_CHAN_2GHZ(_c) \ 140 (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0) 141 #define IEEE80211_IS_CHAN_5GHZ(_c) \ 142 (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0) 143 #define IEEE80211_IS_CHAN_OFDM(_c) \ 144 (((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0) 145 #define IEEE80211_IS_CHAN_CCK(_c) \ 146 (((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0) 147 #define IEEE80211_IS_CHAN_XR(_c) \ 148 (((_c)->ic_flags & IEEE80211_CHAN_XR) != 0) 149 150 /* 151 * EDCA AC parameters. 152 */ 153 struct ieee80211_edca_ac_params { 154 u_int8_t ac_ecwmin; /* CWmin = 2^ECWmin - 1 */ 155 u_int8_t ac_ecwmax; /* CWmax = 2^ECWmax - 1 */ 156 u_int8_t ac_aifsn; 157 u_int16_t ac_txoplimit; /* 32TU */ 158 #define IEEE80211_TXOP_TO_US(txop) ((txop) * 32) 159 160 u_int8_t ac_acm; 161 }; 162 163 #define IEEE80211_DEFRAG_SIZE 3 /* must be >= 3 according to spec */ 164 /* 165 * Entry in the fragment cache. 166 */ 167 struct ieee80211_defrag { 168 struct timeout df_to; 169 struct mbuf *df_m; 170 u_int16_t df_seq; 171 u_int8_t df_frag; 172 }; 173 174 #define IEEE80211_PROTO_NONE 0 175 #define IEEE80211_PROTO_RSN (1 << 0) 176 #define IEEE80211_PROTO_WPA (1 << 1) 177 178 #define IEEE80211_SCAN_UNLOCKED 0x0 179 #define IEEE80211_SCAN_LOCKED 0x1 180 #define IEEE80211_SCAN_REQUEST 0x2 181 #define IEEE80211_SCAN_RESUME 0x4 182 183 #define IEEE80211_GROUP_NKID 6 184 185 struct ieee80211com { 186 struct arpcom ic_ac; 187 LIST_ENTRY(ieee80211com) ic_list; /* chain of all ieee80211com */ 188 void (*ic_recv_mgmt)(struct ieee80211com *, 189 struct mbuf *, struct ieee80211_node *, 190 struct ieee80211_rxinfo *, int); 191 int (*ic_send_mgmt)(struct ieee80211com *, 192 struct ieee80211_node *, int, int, int); 193 int (*ic_newstate)(struct ieee80211com *, 194 enum ieee80211_state, int); 195 void (*ic_newassoc)(struct ieee80211com *, 196 struct ieee80211_node *, int); 197 void (*ic_node_leave)(struct ieee80211com *, 198 struct ieee80211_node *); 199 void (*ic_updateslot)(struct ieee80211com *); 200 void (*ic_updateedca)(struct ieee80211com *); 201 void (*ic_set_tim)(struct ieee80211com *, int, int); 202 int (*ic_set_key)(struct ieee80211com *, 203 struct ieee80211_node *, 204 struct ieee80211_key *); 205 void (*ic_delete_key)(struct ieee80211com *, 206 struct ieee80211_node *, 207 struct ieee80211_key *); 208 int (*ic_ampdu_tx_start)(struct ieee80211com *, 209 struct ieee80211_node *, u_int8_t); 210 void (*ic_ampdu_tx_stop)(struct ieee80211com *, 211 struct ieee80211_node *, u_int8_t); 212 int (*ic_ampdu_rx_start)(struct ieee80211com *, 213 struct ieee80211_node *, u_int8_t); 214 void (*ic_ampdu_rx_stop)(struct ieee80211com *, 215 struct ieee80211_node *, u_int8_t); 216 void (*ic_update_htprot)(struct ieee80211com *, 217 struct ieee80211_node *); 218 u_int8_t ic_myaddr[IEEE80211_ADDR_LEN]; 219 struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX]; 220 struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1]; 221 u_char ic_chan_avail[howmany(IEEE80211_CHAN_MAX,NBBY)]; 222 u_char ic_chan_active[howmany(IEEE80211_CHAN_MAX, NBBY)]; 223 u_char ic_chan_scan[howmany(IEEE80211_CHAN_MAX,NBBY)]; 224 struct mbuf_queue ic_mgtq; 225 struct mbuf_queue ic_pwrsaveq; 226 u_int ic_scan_lock; /* user-initiated scan */ 227 u_int8_t ic_scan_count; /* count scans */ 228 u_int32_t ic_flags; /* state flags */ 229 u_int32_t ic_caps; /* capabilities */ 230 u_int16_t ic_modecaps; /* set of mode capabilities */ 231 u_int16_t ic_curmode; /* current mode */ 232 enum ieee80211_phytype ic_phytype; /* XXX wrong for multi-mode */ 233 enum ieee80211_opmode ic_opmode; /* operation mode */ 234 enum ieee80211_state ic_state; /* 802.11 state */ 235 u_int32_t *ic_aid_bitmap; 236 u_int16_t ic_max_aid; 237 enum ieee80211_protmode ic_protmode; /* 802.11g protection mode */ 238 struct ifmedia ic_media; /* interface media config */ 239 caddr_t ic_rawbpf; /* packet filter structure */ 240 struct ieee80211_node *ic_bss; /* information for this node */ 241 struct ieee80211_channel *ic_ibss_chan; 242 int ic_fixed_rate; /* index to ic_sup_rates[] */ 243 u_int16_t ic_rtsthreshold; 244 u_int16_t ic_fragthreshold; 245 u_int ic_scangen; /* gen# for timeout scan */ 246 struct ieee80211_node *(*ic_node_alloc)(struct ieee80211com *); 247 void (*ic_node_free)(struct ieee80211com *, 248 struct ieee80211_node *); 249 void (*ic_node_copy)(struct ieee80211com *, 250 struct ieee80211_node *, 251 const struct ieee80211_node *); 252 u_int8_t (*ic_node_getrssi)(struct ieee80211com *, 253 const struct ieee80211_node *); 254 u_int8_t ic_max_rssi; 255 struct ieee80211_tree ic_tree; 256 int ic_nnodes; /* length of ic_nnodes */ 257 int ic_max_nnodes; /* max length of ic_nnodes */ 258 u_int16_t ic_lintval; /* listen interval */ 259 int16_t ic_txpower; /* tx power setting (dBm) */ 260 u_int16_t ic_bmisstimeout;/* beacon miss threshold (ms) */ 261 u_int16_t ic_nonerpsta; /* # non-ERP stations */ 262 u_int16_t ic_longslotsta; /* # long slot time stations */ 263 u_int16_t ic_rsnsta; /* # RSN stations */ 264 u_int16_t ic_pssta; /* # ps mode stations */ 265 int ic_mgt_timer; /* mgmt timeout */ 266 #ifndef IEEE80211_STA_ONLY 267 struct timeout ic_inact_timeout; /* node inactivity timeout */ 268 struct timeout ic_node_cache_timeout; 269 #endif 270 int ic_des_esslen; 271 u_int8_t ic_des_essid[IEEE80211_NWID_LEN]; 272 struct ieee80211_channel *ic_des_chan; /* desired channel */ 273 u_int8_t ic_des_bssid[IEEE80211_ADDR_LEN]; 274 struct ieee80211_key ic_nw_keys[IEEE80211_GROUP_NKID]; 275 int ic_def_txkey; /* group data key index */ 276 #define ic_wep_txkey ic_def_txkey 277 int ic_igtk_kid; /* IGTK key index */ 278 u_int32_t ic_iv; /* initial vector for wep */ 279 struct ieee80211_stats ic_stats; /* statistics */ 280 struct timeval ic_last_merge_print; /* for rate-limiting 281 * IBSS merge print-outs 282 */ 283 struct ieee80211_edca_ac_params ic_edca_ac[EDCA_NUM_AC]; 284 u_int ic_edca_updtcount; 285 u_int16_t ic_tid_noack; 286 u_int8_t ic_globalcnt[EAPOL_KEY_NONCE_LEN]; 287 u_int8_t ic_nonce[EAPOL_KEY_NONCE_LEN]; 288 u_int8_t ic_psk[IEEE80211_PMK_LEN]; 289 struct timeout ic_rsn_timeout; 290 u_int16_t ic_rsn_keydonesta; 291 int ic_tkip_micfail; 292 u_int64_t ic_tkip_micfail_last_tsc; 293 294 TAILQ_HEAD(, ieee80211_pmk) ic_pmksa; /* PMKSA cache */ 295 u_int ic_rsnprotos; 296 u_int ic_rsnakms; 297 u_int ic_rsnciphers; 298 enum ieee80211_cipher ic_rsngroupcipher; 299 enum ieee80211_cipher ic_rsngroupmgmtcipher; 300 301 struct ieee80211_defrag ic_defrag[IEEE80211_DEFRAG_SIZE]; 302 int ic_defrag_cur; 303 304 u_int8_t *ic_tim_bitmap; 305 u_int ic_tim_len; 306 u_int ic_tim_mcast_pending; 307 u_int ic_dtim_period; 308 u_int ic_dtim_count; 309 310 u_int32_t ic_txbfcaps; 311 u_int16_t ic_htcaps; 312 u_int8_t ic_ampdu_params; 313 u_int8_t ic_sup_mcs[howmany(80, NBBY)]; 314 u_int16_t ic_max_rxrate; /* in Mb/s, 0 <= rate <= 1023 */ 315 u_int8_t ic_tx_mcs_set; 316 u_int16_t ic_htxcaps; 317 u_int8_t ic_aselcaps; 318 u_int8_t ic_dialog_token; 319 int ic_fixed_mcs; 320 321 LIST_HEAD(, ieee80211_vap) ic_vaps; 322 }; 323 #define ic_if ic_ac.ac_if 324 #define ic_softc ic_if.if_softc 325 326 LIST_HEAD(ieee80211com_head, ieee80211com); 327 extern struct ieee80211com_head ieee80211com_head; 328 329 #define IEEE80211_ADDR_EQ(a1,a2) (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0) 330 #define IEEE80211_ADDR_COPY(dst,src) memcpy(dst,src,IEEE80211_ADDR_LEN) 331 332 /* ic_flags */ 333 #define IEEE80211_F_ASCAN 0x00000001 /* STATUS: active scan */ 334 #define IEEE80211_F_SIBSS 0x00000002 /* STATUS: start IBSS */ 335 #define IEEE80211_F_WEPON 0x00000100 /* CONF: WEP enabled */ 336 #define IEEE80211_F_IBSSON 0x00000200 /* CONF: IBSS creation enable */ 337 #define IEEE80211_F_PMGTON 0x00000400 /* CONF: Power mgmt enable */ 338 #define IEEE80211_F_DESBSSID 0x00000800 /* CONF: des_bssid is set */ 339 #define IEEE80211_F_ROAMING 0x00002000 /* CONF: roaming enabled */ 340 #define IEEE80211_F_TXPMGT 0x00018000 /* STATUS: tx power */ 341 #define IEEE80211_F_TXPOW_OFF 0x00000000 /* TX Power: radio disabled */ 342 #define IEEE80211_F_TXPOW_FIXED 0x00008000 /* TX Power: fixed rate */ 343 #define IEEE80211_F_TXPOW_AUTO 0x00010000 /* TX Power: undefined */ 344 #define IEEE80211_F_SHSLOT 0x00020000 /* STATUS: short slot time */ 345 #define IEEE80211_F_SHPREAMBLE 0x00040000 /* STATUS: short preamble */ 346 #define IEEE80211_F_QOS 0x00080000 /* CONF: QoS enabled */ 347 #define IEEE80211_F_USEPROT 0x00100000 /* STATUS: protection enabled */ 348 #define IEEE80211_F_RSNON 0x00200000 /* CONF: RSN enabled */ 349 #define IEEE80211_F_PSK 0x00400000 /* CONF: pre-shared key set */ 350 #define IEEE80211_F_COUNTERM 0x00800000 /* STATUS: countermeasures */ 351 #define IEEE80211_F_MFPR 0x01000000 /* CONF: MFP required */ 352 #define IEEE80211_F_HTON 0x02000000 /* CONF: HT enabled */ 353 #define IEEE80211_F_PBAR 0x04000000 /* CONF: PBAC required */ 354 #define IEEE80211_F_USERMASK 0xf0000000 /* CONF: ioctl flag mask */ 355 356 /* ic_caps */ 357 #define IEEE80211_C_WEP 0x00000001 /* CAPABILITY: WEP available */ 358 #define IEEE80211_C_IBSS 0x00000002 /* CAPABILITY: IBSS available */ 359 #define IEEE80211_C_PMGT 0x00000004 /* CAPABILITY: Power mgmt */ 360 #define IEEE80211_C_HOSTAP 0x00000008 /* CAPABILITY: HOSTAP avail */ 361 #define IEEE80211_C_AHDEMO 0x00000010 /* CAPABILITY: Old Adhoc Demo */ 362 #define IEEE80211_C_APPMGT 0x00000020 /* CAPABILITY: AP power mgmt */ 363 #define IEEE80211_C_TXPMGT 0x00000040 /* CAPABILITY: tx power mgmt */ 364 #define IEEE80211_C_SHSLOT 0x00000080 /* CAPABILITY: short slottime */ 365 #define IEEE80211_C_SHPREAMBLE 0x00000100 /* CAPABILITY: short preamble */ 366 #define IEEE80211_C_MONITOR 0x00000200 /* CAPABILITY: monitor mode */ 367 #define IEEE80211_C_SCANALL 0x00000400 /* CAPABILITY: scan all chan */ 368 #define IEEE80211_C_QOS 0x00000800 /* CAPABILITY: QoS avail */ 369 #define IEEE80211_C_RSN 0x00001000 /* CAPABILITY: RSN avail */ 370 #define IEEE80211_C_MFP 0x00002000 /* CAPABILITY: MFP avail */ 371 #define IEEE80211_C_RAWCTL 0x00004000 /* CAPABILITY: raw ctl */ 372 #define IEEE80211_C_SCANALLBAND 0x00008000 /* CAPABILITY: scan all bands */ 373 374 /* flags for ieee80211_fix_rate() */ 375 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 376 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */ 377 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 378 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 379 380 void ieee80211_ifattach(struct ifnet *); 381 void ieee80211_ifdetach(struct ifnet *); 382 void ieee80211_channel_init(struct ifnet *); 383 void ieee80211_media_init(struct ifnet *, ifm_change_cb_t, ifm_stat_cb_t); 384 int ieee80211_media_change(struct ifnet *); 385 void ieee80211_media_status(struct ifnet *, struct ifmediareq *); 386 int ieee80211_ioctl(struct ifnet *, u_long, caddr_t); 387 int ieee80211_get_rate(struct ieee80211com *); 388 void ieee80211_watchdog(struct ifnet *); 389 int ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int); 390 uint64_t ieee80211_rate2media(struct ieee80211com *, int, 391 enum ieee80211_phymode); 392 int ieee80211_media2rate(uint64_t); 393 uint64_t ieee80211_mcs2media(struct ieee80211com *, int, 394 enum ieee80211_phymode); 395 int ieee80211_media2mcs(uint64_t); 396 u_int8_t ieee80211_rate2plcp(u_int8_t, enum ieee80211_phymode); 397 u_int8_t ieee80211_plcp2rate(u_int8_t, enum ieee80211_phymode); 398 u_int ieee80211_mhz2ieee(u_int, u_int); 399 u_int ieee80211_chan2ieee(struct ieee80211com *, 400 const struct ieee80211_channel *); 401 u_int ieee80211_ieee2mhz(u_int, u_int); 402 int ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode); 403 enum ieee80211_phymode ieee80211_next_mode(struct ifnet *); 404 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *, 405 const struct ieee80211_channel *); 406 407 extern int ieee80211_cache_size; 408 409 #endif /* _NET80211_IEEE80211_VAR_H_ */ 410