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