ieee80211_var.h revision 127648
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_var.h 127648 2004-03-30 22:57:57Z sam $ 33116742Ssam */ 34116742Ssam#ifndef _NET80211_IEEE80211_VAR_H_ 35116742Ssam#define _NET80211_IEEE80211_VAR_H_ 36116742Ssam 37116742Ssam/* 38116742Ssam * Definitions for IEEE 802.11 drivers. 39116742Ssam */ 40116742Ssam 41116742Ssam#include <net80211/ieee80211.h> 42116742Ssam#include <net80211/ieee80211_crypto.h> 43121180Ssam#include <net80211/ieee80211_ioctl.h> /* for ieee80211_stats */ 44116742Ssam#include <net80211/ieee80211_node.h> 45116742Ssam#include <net80211/ieee80211_proto.h> 46116742Ssam 47116742Ssam#define IEEE80211_CHAN_MAX 255 48116742Ssam#define IEEE80211_CHAN_ANY 0xffff /* token for ``any channel'' */ 49116742Ssam#define IEEE80211_CHAN_ANYC \ 50116742Ssam ((struct ieee80211_channel *) IEEE80211_CHAN_ANY) 51116742Ssam 52127648Ssam#define IEEE80211_TXPOWER_MAX 100 /* max power */ 53127648Ssam#define IEEE80211_TXPOWER_MIN 0 /* kill radio (if possible) */ 54127648Ssam 55116742Ssamenum ieee80211_phytype { 56116742Ssam IEEE80211_T_DS, /* direct sequence spread spectrum */ 57116742Ssam IEEE80211_T_FH, /* frequency hopping */ 58116742Ssam IEEE80211_T_OFDM, /* frequency division multiplexing */ 59116742Ssam IEEE80211_T_TURBO, /* high rate OFDM, aka turbo mode */ 60116742Ssam}; 61116742Ssam#define IEEE80211_T_CCK IEEE80211_T_DS /* more common nomenclature */ 62116742Ssam 63116742Ssam/* XXX not really a mode; there are really multiple PHY's */ 64116742Ssamenum ieee80211_phymode { 65116742Ssam IEEE80211_MODE_AUTO = 0, /* autoselect */ 66116742Ssam IEEE80211_MODE_11A = 1, /* 5GHz, OFDM */ 67116742Ssam IEEE80211_MODE_11B = 2, /* 2GHz, CCK */ 68116742Ssam IEEE80211_MODE_11G = 3, /* 2GHz, OFDM */ 69124543Sonoe IEEE80211_MODE_FH = 4, /* 2GHz, GFSK */ 70124543Sonoe IEEE80211_MODE_TURBO = 5, /* 5GHz, OFDM, 2x clock */ 71116742Ssam}; 72116742Ssam#define IEEE80211_MODE_MAX (IEEE80211_MODE_TURBO+1) 73116742Ssam 74116742Ssamenum ieee80211_opmode { 75116742Ssam IEEE80211_M_STA = 1, /* infrastructure station */ 76116742Ssam IEEE80211_M_IBSS = 0, /* IBSS (adhoc) station */ 77116742Ssam IEEE80211_M_AHDEMO = 3, /* Old lucent compatible adhoc demo */ 78117817Ssam IEEE80211_M_HOSTAP = 6, /* Software Access Point */ 79117817Ssam IEEE80211_M_MONITOR = 8 /* Monitor mode */ 80116742Ssam}; 81116742Ssam 82116742Ssam/* 83127648Ssam * 802.11g protection mode. 84127648Ssam */ 85127648Ssamenum ieee80211_protmode { 86127648Ssam IEEE80211_PROT_NONE = 0, /* no protection */ 87127648Ssam IEEE80211_PROT_CTSONLY = 1, /* CTS to self */ 88127648Ssam IEEE80211_PROT_RTSCTS = 2, /* RTS-CTS */ 89127648Ssam}; 90127648Ssam 91127648Ssam/* 92116742Ssam * Channels are specified by frequency and attributes. 93116742Ssam */ 94116742Ssamstruct ieee80211_channel { 95116742Ssam u_int16_t ic_freq; /* setting in Mhz */ 96116742Ssam u_int16_t ic_flags; /* see below */ 97116742Ssam}; 98116742Ssam 99116742Ssam/* bits 0-3 are for private use by drivers */ 100116742Ssam/* channel attributes */ 101116742Ssam#define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */ 102116742Ssam#define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */ 103116742Ssam#define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */ 104116742Ssam#define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */ 105116742Ssam#define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */ 106116742Ssam#define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */ 107116742Ssam#define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */ 108124543Sonoe#define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */ 109116742Ssam 110116742Ssam/* 111116742Ssam * Useful combinations of channel characteristics. 112116742Ssam */ 113124543Sonoe#define IEEE80211_CHAN_FHSS \ 114124543Sonoe (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK) 115116742Ssam#define IEEE80211_CHAN_A \ 116116742Ssam (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM) 117116742Ssam#define IEEE80211_CHAN_B \ 118116742Ssam (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK) 119116742Ssam#define IEEE80211_CHAN_PUREG \ 120116742Ssam (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM) 121116742Ssam#define IEEE80211_CHAN_G \ 122116742Ssam (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN) 123116742Ssam#define IEEE80211_CHAN_T \ 124116742Ssam (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO) 125116742Ssam 126124543Sonoe#define IEEE80211_IS_CHAN_FHSS(_c) \ 127124543Sonoe (((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS) 128116742Ssam#define IEEE80211_IS_CHAN_A(_c) \ 129116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A) 130116742Ssam#define IEEE80211_IS_CHAN_B(_c) \ 131116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B) 132116742Ssam#define IEEE80211_IS_CHAN_PUREG(_c) \ 133116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG) 134116742Ssam#define IEEE80211_IS_CHAN_G(_c) \ 135116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G) 136116742Ssam#define IEEE80211_IS_CHAN_T(_c) \ 137116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_T) == IEEE80211_CHAN_T) 138116742Ssam 139116742Ssam#define IEEE80211_IS_CHAN_2GHZ(_c) \ 140116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0) 141116742Ssam#define IEEE80211_IS_CHAN_5GHZ(_c) \ 142116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0) 143116742Ssam#define IEEE80211_IS_CHAN_OFDM(_c) \ 144116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0) 145116742Ssam#define IEEE80211_IS_CHAN_CCK(_c) \ 146116742Ssam (((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0) 147124543Sonoe#define IEEE80211_IS_CHAN_GFSK(_c) \ 148124543Sonoe (((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0) 149116742Ssam 150116742Ssam/* ni_chan encoding for FH phy */ 151116742Ssam#define IEEE80211_FH_CHANMOD 80 152116742Ssam#define IEEE80211_FH_CHAN(set,pat) (((set)-1)*IEEE80211_FH_CHANMOD+(pat)) 153116742Ssam#define IEEE80211_FH_CHANSET(chan) ((chan)/IEEE80211_FH_CHANMOD+1) 154116742Ssam#define IEEE80211_FH_CHANPAT(chan) ((chan)%IEEE80211_FH_CHANMOD) 155116742Ssam 156116742Ssamstruct ieee80211com { 157116742Ssam struct arpcom ic_ac; 158116742Ssam void (*ic_recv_mgmt)(struct ieee80211com *, 159119150Ssam struct mbuf *, struct ieee80211_node *, 160119150Ssam int, int, u_int32_t); 161116742Ssam int (*ic_send_mgmt)(struct ieee80211com *, 162116742Ssam struct ieee80211_node *, int, int); 163117811Ssam int (*ic_newstate)(struct ieee80211com *, 164117811Ssam enum ieee80211_state, int); 165116742Ssam void (*ic_newassoc)(struct ieee80211com *, 166116742Ssam struct ieee80211_node *, int); 167116742Ssam u_int8_t ic_myaddr[IEEE80211_ADDR_LEN]; 168116742Ssam struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX]; 169116742Ssam struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1]; 170116742Ssam u_char ic_chan_avail[roundup(IEEE80211_CHAN_MAX,NBBY)]; 171116742Ssam u_char ic_chan_active[roundup(IEEE80211_CHAN_MAX, NBBY)]; 172116742Ssam u_char ic_chan_scan[roundup(IEEE80211_CHAN_MAX,NBBY)]; 173116742Ssam struct ifqueue ic_mgtq; 174116742Ssam u_int32_t ic_flags; /* state flags */ 175116742Ssam u_int32_t ic_caps; /* capabilities */ 176116742Ssam u_int16_t ic_modecaps; /* set of mode capabilities */ 177116742Ssam u_int16_t ic_curmode; /* current mode */ 178116742Ssam enum ieee80211_phytype ic_phytype; /* XXX wrong for multi-mode */ 179116742Ssam enum ieee80211_opmode ic_opmode; /* operation mode */ 180116742Ssam enum ieee80211_state ic_state; /* 802.11 state */ 181127648Ssam enum ieee80211_protmode ic_protmode; /* 802.11g protection mode */ 182116742Ssam struct ifmedia ic_media; /* interface media config */ 183116742Ssam struct bpf_if *ic_rawbpf; /* packet filter structure */ 184116742Ssam struct ieee80211_node *ic_bss; /* information for this node */ 185116742Ssam struct ieee80211_channel *ic_ibss_chan; 186116742Ssam int ic_fixed_rate; /* index to ic_sup_rates[] */ 187116742Ssam u_int16_t ic_rtsthreshold; 188116742Ssam u_int16_t ic_fragthreshold; 189116742Ssam struct mtx ic_nodelock; /* on node table */ 190120483Ssam u_int ic_scangen; /* gen# for timeout scan */ 191116742Ssam struct ieee80211_node *(*ic_node_alloc)(struct ieee80211com *); 192116742Ssam void (*ic_node_free)(struct ieee80211com *, 193116742Ssam struct ieee80211_node *); 194116742Ssam void (*ic_node_copy)(struct ieee80211com *, 195116742Ssam struct ieee80211_node *, 196116742Ssam const struct ieee80211_node *); 197120104Ssam u_int8_t (*ic_node_getrssi)(struct ieee80211com *, 198120104Ssam struct ieee80211_node *); 199116742Ssam TAILQ_HEAD(, ieee80211_node) ic_node; /* information of all nodes */ 200116742Ssam LIST_HEAD(, ieee80211_node) ic_hash[IEEE80211_NODE_HASHSIZE]; 201116742Ssam u_int16_t ic_lintval; /* listen interval */ 202116742Ssam u_int16_t ic_holdover; /* PM hold over duration */ 203116742Ssam u_int16_t ic_txmin; /* min tx retry count */ 204116742Ssam u_int16_t ic_txmax; /* max tx retry count */ 205116742Ssam u_int16_t ic_txlifetime; /* tx lifetime */ 206116742Ssam u_int16_t ic_txpower; /* tx power setting (dbM) */ 207116742Ssam u_int16_t ic_bmisstimeout;/* beacon miss threshold (ms) */ 208116742Ssam int ic_mgt_timer; /* mgmt timeout */ 209116742Ssam int ic_inact_timer; /* inactivity timer wait */ 210116742Ssam int ic_des_esslen; 211116742Ssam u_int8_t ic_des_essid[IEEE80211_NWID_LEN]; 212116742Ssam struct ieee80211_channel *ic_des_chan; /* desired channel */ 213116742Ssam u_int8_t ic_des_bssid[IEEE80211_ADDR_LEN]; 214116742Ssam struct ieee80211_wepkey ic_nw_keys[IEEE80211_WEP_NKID]; 215116742Ssam int ic_wep_txkey; /* default tx key index */ 216116742Ssam void *ic_wep_ctx; /* wep crypt context */ 217116742Ssam u_int32_t ic_iv; /* initial vector for wep */ 218121180Ssam struct ieee80211_stats ic_stats; /* statistics */ 219116742Ssam}; 220116742Ssam#define ic_if ic_ac.ac_if 221116742Ssam#define ic_softc ic_if.if_softc 222116742Ssam 223116742Ssam#define IEEE80211_ADDR_EQ(a1,a2) (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0) 224116742Ssam#define IEEE80211_ADDR_COPY(dst,src) memcpy(dst,src,IEEE80211_ADDR_LEN) 225116742Ssam 226116742Ssam/* ic_flags */ 227116742Ssam#define IEEE80211_F_ASCAN 0x00000001 /* STATUS: active scan */ 228116742Ssam#define IEEE80211_F_SIBSS 0x00000002 /* STATUS: start IBSS */ 229116742Ssam#define IEEE80211_F_WEPON 0x00000100 /* CONF: WEP enabled */ 230116742Ssam#define IEEE80211_F_IBSSON 0x00000200 /* CONF: IBSS creation enable */ 231116742Ssam#define IEEE80211_F_PMGTON 0x00000400 /* CONF: Power mgmt enable */ 232116742Ssam#define IEEE80211_F_DESBSSID 0x00000800 /* CONF: des_bssid is set */ 233116742Ssam#define IEEE80211_F_SCANAP 0x00001000 /* CONF: Scanning AP */ 234116742Ssam#define IEEE80211_F_ROAMING 0x00002000 /* CONF: roaming enabled */ 235116742Ssam#define IEEE80211_F_SWRETRY 0x00004000 /* CONF: sw tx retry enabled */ 236116742Ssam#define IEEE80211_F_TXPMGT 0x00018000 /* STATUS: tx power */ 237116742Ssam#define IEEE80211_F_TXPOW_OFF 0x00000000 /* TX Power: radio disabled */ 238116742Ssam#define IEEE80211_F_TXPOW_FIXED 0x00008000 /* TX Power: fixed rate */ 239116742Ssam#define IEEE80211_F_TXPOW_AUTO 0x00010000 /* TX Power: undefined */ 240116742Ssam#define IEEE80211_F_SHSLOT 0x00020000 /* CONF: short slot time */ 241116742Ssam#define IEEE80211_F_SHPREAMBLE 0x00040000 /* CONF: short preamble */ 242127648Ssam#define IEEE80211_F_USEPROT 0x00100000 /* STATUS: protection enabled */ 243127648Ssam#define IEEE80211_F_USEBARKER 0x00200000 /* STATUS: use barker preamble*/ 244116742Ssam 245121176Ssam/* ic_caps */ 246116742Ssam#define IEEE80211_C_WEP 0x00000001 /* CAPABILITY: WEP available */ 247116742Ssam#define IEEE80211_C_IBSS 0x00000002 /* CAPABILITY: IBSS available */ 248116742Ssam#define IEEE80211_C_PMGT 0x00000004 /* CAPABILITY: Power mgmt */ 249116742Ssam#define IEEE80211_C_HOSTAP 0x00000008 /* CAPABILITY: HOSTAP avail */ 250116742Ssam#define IEEE80211_C_AHDEMO 0x00000010 /* CAPABILITY: Old Adhoc Demo */ 251116742Ssam#define IEEE80211_C_SWRETRY 0x00000020 /* CAPABILITY: sw tx retry */ 252116742Ssam#define IEEE80211_C_TXPMGT 0x00000040 /* CAPABILITY: tx power mgmt */ 253116742Ssam#define IEEE80211_C_SHSLOT 0x00000080 /* CAPABILITY: short slottime */ 254116742Ssam#define IEEE80211_C_SHPREAMBLE 0x00000100 /* CAPABILITY: short preamble */ 255117817Ssam#define IEEE80211_C_MONITOR 0x00000200 /* CAPABILITY: monitor mode */ 256121174Ssam#define IEEE80211_C_RCVMGT 0x00000400 /* CAPABILITY: rcv mgt frames */ 257116742Ssam 258116742Ssam/* flags for ieee80211_fix_rate() */ 259116742Ssam#define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 260116742Ssam#define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */ 261116742Ssam#define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 262116742Ssam#define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 263116742Ssam 264116742Ssamvoid ieee80211_ifattach(struct ifnet *); 265116742Ssamvoid ieee80211_ifdetach(struct ifnet *); 266116742Ssamvoid ieee80211_media_init(struct ifnet *, ifm_change_cb_t, ifm_stat_cb_t); 267116742Ssamint ieee80211_media_change(struct ifnet *); 268116742Ssamvoid ieee80211_media_status(struct ifnet *, struct ifmediareq *); 269116742Ssamint ieee80211_ioctl(struct ifnet *, u_long, caddr_t); 270116742Ssamint ieee80211_cfgget(struct ifnet *, u_long, caddr_t); 271116742Ssamint ieee80211_cfgset(struct ifnet *, u_long, caddr_t); 272116742Ssamvoid ieee80211_watchdog(struct ifnet *); 273116742Ssamint ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int); 274116742Ssamint ieee80211_rate2media(struct ieee80211com *, int, 275116742Ssam enum ieee80211_phymode); 276116742Ssamint ieee80211_media2rate(int); 277116742Ssamu_int ieee80211_mhz2ieee(u_int, u_int); 278116742Ssamu_int ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *); 279116742Ssamu_int ieee80211_ieee2mhz(u_int, u_int); 280116742Ssamint ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode); 281116742Ssamenum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *, 282116742Ssam struct ieee80211_channel *); 283116742Ssam 284116742Ssam#define IEEE80211_DEBUG 285116742Ssam#ifdef IEEE80211_DEBUG 286116742Ssamextern int ieee80211_debug; 287116742Ssam#define IEEE80211_DPRINTF(X) if (ieee80211_debug) printf X 288116742Ssam#define IEEE80211_DPRINTF2(X) if (ieee80211_debug>1) printf X 289116742Ssam#else 290116742Ssam#define IEEE80211_DPRINTF(X) 291116742Ssam#define IEEE80211_DPRINTF2(X) 292116742Ssam#endif 293116742Ssam 294116742Ssam#endif /* _NET80211_IEEE80211_VAR_H_ */ 295