1138568Ssam/*- 2178354Ssam * Copyright (c) 2003-2008 Sam Leffler, Errno Consulting 3138568Ssam * All rights reserved. 4138568Ssam * 5138568Ssam * Redistribution and use in source and binary forms, with or without 6138568Ssam * modification, are permitted provided that the following conditions 7138568Ssam * are met: 8138568Ssam * 1. Redistributions of source code must retain the above copyright 9138568Ssam * notice, this list of conditions and the following disclaimer. 10138568Ssam * 2. Redistributions in binary form must reproduce the above copyright 11138568Ssam * notice, this list of conditions and the following disclaimer in the 12138568Ssam * documentation and/or other materials provided with the distribution. 13138568Ssam * 14138568Ssam * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15138568Ssam * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16138568Ssam * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17138568Ssam * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 18138568Ssam * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 19138568Ssam * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 20138568Ssam * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 21138568Ssam * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22138568Ssam * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 23138568Ssam * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24138568Ssam * 25138568Ssam * $FreeBSD: stable/11/sys/net80211/ieee80211_freebsd.h 343489 2019-01-27 13:03:48Z avos $ 26138568Ssam */ 27138568Ssam#ifndef _NET80211_IEEE80211_FREEBSD_H_ 28138568Ssam#define _NET80211_IEEE80211_FREEBSD_H_ 29138568Ssam 30165911Ssam#ifdef _KERNEL 31298899Savos#include <sys/param.h> 32283614Sglebius#include <sys/systm.h> 33283614Sglebius#include <sys/counter.h> 34178354Ssam#include <sys/lock.h> 35178354Ssam#include <sys/mutex.h> 36178354Ssam#include <sys/rwlock.h> 37192473Ssam#include <sys/sysctl.h> 38191746Sthompsa#include <sys/taskqueue.h> 39178354Ssam 40138568Ssam/* 41170530Ssam * Common state locking definitions. 42170530Ssam */ 43179388Ssamtypedef struct { 44179388Ssam char name[16]; /* e.g. "ath0_com_lock" */ 45179388Ssam struct mtx mtx; 46179388Ssam} ieee80211_com_lock_t; 47179388Ssam#define IEEE80211_LOCK_INIT(_ic, _name) do { \ 48179388Ssam ieee80211_com_lock_t *cl = &(_ic)->ic_comlock; \ 49179388Ssam snprintf(cl->name, sizeof(cl->name), "%s_com_lock", _name); \ 50179388Ssam mtx_init(&cl->mtx, cl->name, NULL, MTX_DEF | MTX_RECURSE); \ 51179388Ssam} while (0) 52179388Ssam#define IEEE80211_LOCK_OBJ(_ic) (&(_ic)->ic_comlock.mtx) 53179388Ssam#define IEEE80211_LOCK_DESTROY(_ic) mtx_destroy(IEEE80211_LOCK_OBJ(_ic)) 54179388Ssam#define IEEE80211_LOCK(_ic) mtx_lock(IEEE80211_LOCK_OBJ(_ic)) 55179388Ssam#define IEEE80211_UNLOCK(_ic) mtx_unlock(IEEE80211_LOCK_OBJ(_ic)) 56170530Ssam#define IEEE80211_LOCK_ASSERT(_ic) \ 57179388Ssam mtx_assert(IEEE80211_LOCK_OBJ(_ic), MA_OWNED) 58243532Sadrian#define IEEE80211_UNLOCK_ASSERT(_ic) \ 59243532Sadrian mtx_assert(IEEE80211_LOCK_OBJ(_ic), MA_NOTOWNED) 60170530Ssam 61170530Ssam/* 62248069Sadrian * Transmit lock. 63248069Sadrian * 64248069Sadrian * This is a (mostly) temporary lock designed to serialise all of the 65248069Sadrian * transmission operations throughout the stack. 66248069Sadrian */ 67248069Sadriantypedef struct { 68296171Savos char name[16]; /* e.g. "ath0_tx_lock" */ 69248069Sadrian struct mtx mtx; 70248069Sadrian} ieee80211_tx_lock_t; 71248069Sadrian#define IEEE80211_TX_LOCK_INIT(_ic, _name) do { \ 72248069Sadrian ieee80211_tx_lock_t *cl = &(_ic)->ic_txlock; \ 73248069Sadrian snprintf(cl->name, sizeof(cl->name), "%s_tx_lock", _name); \ 74248069Sadrian mtx_init(&cl->mtx, cl->name, NULL, MTX_DEF); \ 75248069Sadrian} while (0) 76248069Sadrian#define IEEE80211_TX_LOCK_OBJ(_ic) (&(_ic)->ic_txlock.mtx) 77248069Sadrian#define IEEE80211_TX_LOCK_DESTROY(_ic) mtx_destroy(IEEE80211_TX_LOCK_OBJ(_ic)) 78248069Sadrian#define IEEE80211_TX_LOCK(_ic) mtx_lock(IEEE80211_TX_LOCK_OBJ(_ic)) 79248069Sadrian#define IEEE80211_TX_UNLOCK(_ic) mtx_unlock(IEEE80211_TX_LOCK_OBJ(_ic)) 80248069Sadrian#define IEEE80211_TX_LOCK_ASSERT(_ic) \ 81248069Sadrian mtx_assert(IEEE80211_TX_LOCK_OBJ(_ic), MA_OWNED) 82248069Sadrian#define IEEE80211_TX_UNLOCK_ASSERT(_ic) \ 83248069Sadrian mtx_assert(IEEE80211_TX_LOCK_OBJ(_ic), MA_NOTOWNED) 84248069Sadrian 85248069Sadrian/* 86302283Savos * Stageq / ni_tx_superg lock 87302283Savos */ 88302283Savostypedef struct { 89302283Savos char name[16]; /* e.g. "ath0_ff_lock" */ 90302283Savos struct mtx mtx; 91302283Savos} ieee80211_ff_lock_t; 92302283Savos#define IEEE80211_FF_LOCK_INIT(_ic, _name) do { \ 93302283Savos ieee80211_ff_lock_t *fl = &(_ic)->ic_fflock; \ 94302283Savos snprintf(fl->name, sizeof(fl->name), "%s_ff_lock", _name); \ 95302283Savos mtx_init(&fl->mtx, fl->name, NULL, MTX_DEF); \ 96302283Savos} while (0) 97302283Savos#define IEEE80211_FF_LOCK_OBJ(_ic) (&(_ic)->ic_fflock.mtx) 98302283Savos#define IEEE80211_FF_LOCK_DESTROY(_ic) mtx_destroy(IEEE80211_FF_LOCK_OBJ(_ic)) 99302283Savos#define IEEE80211_FF_LOCK(_ic) mtx_lock(IEEE80211_FF_LOCK_OBJ(_ic)) 100302283Savos#define IEEE80211_FF_UNLOCK(_ic) mtx_unlock(IEEE80211_FF_LOCK_OBJ(_ic)) 101302283Savos#define IEEE80211_FF_LOCK_ASSERT(_ic) \ 102302283Savos mtx_assert(IEEE80211_FF_LOCK_OBJ(_ic), MA_OWNED) 103302283Savos 104302283Savos/* 105138568Ssam * Node locking definitions. 106138568Ssam */ 107178354Ssamtypedef struct { 108178354Ssam char name[16]; /* e.g. "ath0_node_lock" */ 109178354Ssam struct mtx mtx; 110178354Ssam} ieee80211_node_lock_t; 111178354Ssam#define IEEE80211_NODE_LOCK_INIT(_nt, _name) do { \ 112178354Ssam ieee80211_node_lock_t *nl = &(_nt)->nt_nodelock; \ 113178354Ssam snprintf(nl->name, sizeof(nl->name), "%s_node_lock", _name); \ 114179388Ssam mtx_init(&nl->mtx, nl->name, NULL, MTX_DEF | MTX_RECURSE); \ 115178354Ssam} while (0) 116179388Ssam#define IEEE80211_NODE_LOCK_OBJ(_nt) (&(_nt)->nt_nodelock.mtx) 117178354Ssam#define IEEE80211_NODE_LOCK_DESTROY(_nt) \ 118179388Ssam mtx_destroy(IEEE80211_NODE_LOCK_OBJ(_nt)) 119178354Ssam#define IEEE80211_NODE_LOCK(_nt) \ 120179388Ssam mtx_lock(IEEE80211_NODE_LOCK_OBJ(_nt)) 121178354Ssam#define IEEE80211_NODE_IS_LOCKED(_nt) \ 122179388Ssam mtx_owned(IEEE80211_NODE_LOCK_OBJ(_nt)) 123178354Ssam#define IEEE80211_NODE_UNLOCK(_nt) \ 124179388Ssam mtx_unlock(IEEE80211_NODE_LOCK_OBJ(_nt)) 125178354Ssam#define IEEE80211_NODE_LOCK_ASSERT(_nt) \ 126179388Ssam mtx_assert(IEEE80211_NODE_LOCK_OBJ(_nt), MA_OWNED) 127138568Ssam 128138568Ssam/* 129184288Ssam * Power-save queue definitions. 130138568Ssam */ 131184288Ssamtypedef struct mtx ieee80211_psq_lock_t; 132184288Ssam#define IEEE80211_PSQ_INIT(_psq, _name) \ 133195379Ssam mtx_init(&(_psq)->psq_lock, _name, "802.11 ps q", MTX_DEF) 134184288Ssam#define IEEE80211_PSQ_DESTROY(_psq) mtx_destroy(&(_psq)->psq_lock) 135184288Ssam#define IEEE80211_PSQ_LOCK(_psq) mtx_lock(&(_psq)->psq_lock) 136184288Ssam#define IEEE80211_PSQ_UNLOCK(_psq) mtx_unlock(&(_psq)->psq_lock) 137138568Ssam 138167284Ssam#ifndef IF_PREPEND_LIST 139167284Ssam#define _IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do { \ 140167284Ssam (mtail)->m_nextpkt = (ifq)->ifq_head; \ 141167284Ssam if ((ifq)->ifq_tail == NULL) \ 142167284Ssam (ifq)->ifq_tail = (mtail); \ 143167284Ssam (ifq)->ifq_head = (mhead); \ 144167284Ssam (ifq)->ifq_len += (mcount); \ 145167284Ssam} while (0) 146167284Ssam#define IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do { \ 147167284Ssam IF_LOCK(ifq); \ 148167284Ssam _IF_PREPEND_LIST(ifq, mhead, mtail, mcount); \ 149167284Ssam IF_UNLOCK(ifq); \ 150167284Ssam} while (0) 151167284Ssam#endif /* IF_PREPEND_LIST */ 152195379Ssam 153195379Ssam/* 154195379Ssam * Age queue definitions. 155195379Ssam */ 156195379Ssamtypedef struct mtx ieee80211_ageq_lock_t; 157195379Ssam#define IEEE80211_AGEQ_INIT(_aq, _name) \ 158195379Ssam mtx_init(&(_aq)->aq_lock, _name, "802.11 age q", MTX_DEF) 159195379Ssam#define IEEE80211_AGEQ_DESTROY(_aq) mtx_destroy(&(_aq)->aq_lock) 160195379Ssam#define IEEE80211_AGEQ_LOCK(_aq) mtx_lock(&(_aq)->aq_lock) 161195379Ssam#define IEEE80211_AGEQ_UNLOCK(_aq) mtx_unlock(&(_aq)->aq_lock) 162167284Ssam 163138568Ssam/* 164138568Ssam * 802.1x MAC ACL database locking definitions. 165138568Ssam */ 166138568Ssamtypedef struct mtx acl_lock_t; 167138568Ssam#define ACL_LOCK_INIT(_as, _name) \ 168138568Ssam mtx_init(&(_as)->as_lock, _name, "802.11 ACL", MTX_DEF) 169138568Ssam#define ACL_LOCK_DESTROY(_as) mtx_destroy(&(_as)->as_lock) 170138568Ssam#define ACL_LOCK(_as) mtx_lock(&(_as)->as_lock) 171138568Ssam#define ACL_UNLOCK(_as) mtx_unlock(&(_as)->as_lock) 172138568Ssam#define ACL_LOCK_ASSERT(_as) \ 173138568Ssam mtx_assert((&(_as)->as_lock), MA_OWNED) 174138568Ssam 175138568Ssam/* 176206617Srpaulo * Scan table definitions. 177206617Srpaulo */ 178206617Srpaulotypedef struct mtx ieee80211_scan_table_lock_t; 179206617Srpaulo#define IEEE80211_SCAN_TABLE_LOCK_INIT(_st, _name) \ 180206617Srpaulo mtx_init(&(_st)->st_lock, _name, "802.11 scan table", MTX_DEF) 181206617Srpaulo#define IEEE80211_SCAN_TABLE_LOCK_DESTROY(_st) mtx_destroy(&(_st)->st_lock) 182206617Srpaulo#define IEEE80211_SCAN_TABLE_LOCK(_st) mtx_lock(&(_st)->st_lock) 183206617Srpaulo#define IEEE80211_SCAN_TABLE_UNLOCK(_st) mtx_unlock(&(_st)->st_lock) 184206617Srpaulo 185283556Sadriantypedef struct mtx ieee80211_scan_iter_lock_t; 186283556Sadrian#define IEEE80211_SCAN_ITER_LOCK_INIT(_st, _name) \ 187283556Sadrian mtx_init(&(_st)->st_scanlock, _name, "802.11 scangen", MTX_DEF) 188283556Sadrian#define IEEE80211_SCAN_ITER_LOCK_DESTROY(_st) mtx_destroy(&(_st)->st_scanlock) 189283556Sadrian#define IEEE80211_SCAN_ITER_LOCK(_st) mtx_lock(&(_st)->st_scanlock) 190283556Sadrian#define IEEE80211_SCAN_ITER_UNLOCK(_st) mtx_unlock(&(_st)->st_scanlock) 191283556Sadrian 192206617Srpaulo/* 193283555Sadrian * Mesh node/routing definitions. 194283555Sadrian */ 195283555Sadriantypedef struct mtx ieee80211_rte_lock_t; 196283555Sadrian#define MESH_RT_ENTRY_LOCK_INIT(_rt, _name) \ 197283555Sadrian mtx_init(&(rt)->rt_lock, _name, "802.11s route entry", MTX_DEF) 198283555Sadrian#define MESH_RT_ENTRY_LOCK_DESTROY(_rt) \ 199283555Sadrian mtx_destroy(&(_rt)->rt_lock) 200283555Sadrian#define MESH_RT_ENTRY_LOCK(rt) mtx_lock(&(rt)->rt_lock) 201283555Sadrian#define MESH_RT_ENTRY_LOCK_ASSERT(rt) mtx_assert(&(rt)->rt_lock, MA_OWNED) 202283555Sadrian#define MESH_RT_ENTRY_UNLOCK(rt) mtx_unlock(&(rt)->rt_lock) 203283555Sadrian 204283555Sadriantypedef struct mtx ieee80211_rt_lock_t; 205283555Sadrian#define MESH_RT_LOCK(ms) mtx_lock(&(ms)->ms_rt_lock) 206283555Sadrian#define MESH_RT_LOCK_ASSERT(ms) mtx_assert(&(ms)->ms_rt_lock, MA_OWNED) 207283555Sadrian#define MESH_RT_UNLOCK(ms) mtx_unlock(&(ms)->ms_rt_lock) 208283555Sadrian#define MESH_RT_LOCK_INIT(ms, name) \ 209283555Sadrian mtx_init(&(ms)->ms_rt_lock, name, "802.11s routing table", MTX_DEF) 210283555Sadrian#define MESH_RT_LOCK_DESTROY(ms) \ 211283555Sadrian mtx_destroy(&(ms)->ms_rt_lock) 212283555Sadrian 213283555Sadrian/* 214138568Ssam * Node reference counting definitions. 215138568Ssam * 216138568Ssam * ieee80211_node_initref initialize the reference count to 1 217138568Ssam * ieee80211_node_incref add a reference 218138568Ssam * ieee80211_node_decref remove a reference 219138568Ssam * ieee80211_node_dectestref remove a reference and return 1 if this 220138568Ssam * is the last reference, otherwise 0 221138568Ssam * ieee80211_node_refcnt reference count for printing (only) 222138568Ssam */ 223138568Ssam#include <machine/atomic.h> 224138568Ssam 225343489Savosstruct ieee80211vap; 226343489Savosint ieee80211_com_vincref(struct ieee80211vap *); 227343489Savosvoid ieee80211_com_vdecref(struct ieee80211vap *); 228343489Savosvoid ieee80211_com_vdetach(struct ieee80211vap *); 229343489Savos 230138568Ssam#define ieee80211_node_initref(_ni) \ 231138568Ssam do { ((_ni)->ni_refcnt = 1); } while (0) 232138568Ssam#define ieee80211_node_incref(_ni) \ 233138568Ssam atomic_add_int(&(_ni)->ni_refcnt, 1) 234138568Ssam#define ieee80211_node_decref(_ni) \ 235138568Ssam atomic_subtract_int(&(_ni)->ni_refcnt, 1) 236138568Ssamstruct ieee80211_node; 237144618Ssamint ieee80211_node_dectestref(struct ieee80211_node *ni); 238138568Ssam#define ieee80211_node_refcnt(_ni) (_ni)->ni_refcnt 239138568Ssam 240165904Ssamstruct ifqueue; 241165894Ssamvoid ieee80211_drain_ifq(struct ifqueue *); 242178354Ssamvoid ieee80211_flush_ifq(struct ifqueue *, struct ieee80211vap *); 243165894Ssam 244178354Ssamvoid ieee80211_vap_destroy(struct ieee80211vap *); 245178354Ssam 246178354Ssam#define IFNET_IS_UP_RUNNING(_ifp) \ 247178354Ssam (((_ifp)->if_flags & IFF_UP) && \ 248178354Ssam ((_ifp)->if_drv_flags & IFF_DRV_RUNNING)) 249178354Ssam 250293022Sadrian/* XXX TODO: cap these at 1, as hz may not be 1000 */ 251171022Ssam#define msecs_to_ticks(ms) (((ms)*hz)/1000) 252178354Ssam#define ticks_to_msecs(t) (1000*(t) / hz) 253178354Ssam#define ticks_to_secs(t) ((t) / hz) 254293022Sadrian 255297405Sadrian#define ieee80211_time_after(a,b) ((long)(b) - (long)(a) < 0) 256297405Sadrian#define ieee80211_time_before(a,b) ieee80211_time_after(b,a) 257297405Sadrian#define ieee80211_time_after_eq(a,b) ((long)(a) - (long)(b) >= 0) 258297405Sadrian#define ieee80211_time_before_eq(a,b) ieee80211_time_after_eq(b,a) 259170530Ssam 260170530Ssamstruct mbuf *ieee80211_getmgtframe(uint8_t **frm, int headroom, int pktlen); 261172054Ssam 262170530Ssam/* tx path usage */ 263184286Ssam#define M_ENCAP M_PROTO1 /* 802.11 encap done */ 264178354Ssam#define M_EAPOL M_PROTO3 /* PAE/EAPOL frame */ 265138568Ssam#define M_PWR_SAV M_PROTO4 /* bypass PS handling */ 266147789Ssam#define M_MORE_DATA M_PROTO5 /* more data frames to follow */ 267297594Sadrian#define M_FF M_PROTO6 /* fast frame / A-MSDU */ 268178354Ssam#define M_TXCB M_PROTO7 /* do tx complete callback */ 269183247Ssam#define M_AMPDU_MPDU M_PROTO8 /* ok for A-MPDU aggregation */ 270254526Sandre#define M_FRAG M_PROTO9 /* frame fragmentation */ 271254526Sandre#define M_FIRSTFRAG M_PROTO10 /* first frame fragment */ 272254526Sandre#define M_LASTFRAG M_PROTO11 /* last frame fragment */ 273254640Sadrian 274178354Ssam#define M_80211_TX \ 275254526Sandre (M_ENCAP|M_EAPOL|M_PWR_SAV|M_MORE_DATA|M_FF|M_TXCB| \ 276254526Sandre M_AMPDU_MPDU|M_FRAG|M_FIRSTFRAG|M_LASTFRAG) 277172054Ssam 278170530Ssam/* rx path usage */ 279183247Ssam#define M_AMPDU M_PROTO1 /* A-MPDU subframe */ 280172054Ssam#define M_WEP M_PROTO2 /* WEP done by hardware */ 281183247Ssam#if 0 282183247Ssam#define M_AMPDU_MPDU M_PROTO8 /* A-MPDU re-order done */ 283183247Ssam#endif 284183247Ssam#define M_80211_RX (M_AMPDU|M_WEP|M_AMPDU_MPDU) 285195618Srpaulo 286195618Srpaulo#define IEEE80211_MBUF_TX_FLAG_BITS \ 287254527Sandre M_FLAG_BITS \ 288254527Sandre "\15M_ENCAP\17M_EAPOL\20M_PWR_SAV\21M_MORE_DATA\22M_FF\23M_TXCB" \ 289254527Sandre "\24M_AMPDU_MPDU\25M_FRAG\26M_FIRSTFRAG\27M_LASTFRAG" 290195618Srpaulo 291195618Srpaulo#define IEEE80211_MBUF_RX_FLAG_BITS \ 292254527Sandre M_FLAG_BITS \ 293254527Sandre "\15M_AMPDU\16M_WEP\24M_AMPDU_MPDU" 294195618Srpaulo 295138568Ssam/* 296178354Ssam * Store WME access control bits in the vlan tag. 297178354Ssam * This is safe since it's done after the packet is classified 298178354Ssam * (where we use any previous tag) and because it's passed 299178354Ssam * directly in to the driver and there's no chance someone 300178354Ssam * else will clobber them on us. 301138568Ssam */ 302138568Ssam#define M_WME_SETAC(m, ac) \ 303178354Ssam ((m)->m_pkthdr.ether_vtag = (ac)) 304178354Ssam#define M_WME_GETAC(m) ((m)->m_pkthdr.ether_vtag) 305138568Ssam 306138568Ssam/* 307138568Ssam * Mbufs on the power save queue are tagged with an age and 308138568Ssam * timed out. We reuse the hardware checksum field in the 309138568Ssam * mbuf packet header to store this data. 310138568Ssam */ 311138568Ssam#define M_AGE_SET(m,v) (m->m_pkthdr.csum_data = v) 312138568Ssam#define M_AGE_GET(m) (m->m_pkthdr.csum_data) 313138568Ssam#define M_AGE_SUB(m,adj) (m->m_pkthdr.csum_data -= adj) 314138568Ssam 315191571Ssam/* 316191571Ssam * Store the sequence number. 317191571Ssam */ 318191571Ssam#define M_SEQNO_SET(m, seqno) \ 319191571Ssam ((m)->m_pkthdr.tso_segsz = (seqno)) 320191571Ssam#define M_SEQNO_GET(m) ((m)->m_pkthdr.tso_segsz) 321191571Ssam 322170530Ssam#define MTAG_ABI_NET80211 1132948340 /* net80211 ABI */ 323170530Ssam 324170530Ssamstruct ieee80211_cb { 325170530Ssam void (*func)(struct ieee80211_node *, void *, int status); 326170530Ssam void *arg; 327170530Ssam}; 328170530Ssam#define NET80211_TAG_CALLBACK 0 /* xmit complete callback */ 329170530Ssamint ieee80211_add_callback(struct mbuf *m, 330170530Ssam void (*func)(struct ieee80211_node *, void *, int), void *arg); 331170530Ssamvoid ieee80211_process_callback(struct ieee80211_node *, struct mbuf *, int); 332170530Ssam 333283980Sadrian#define NET80211_TAG_XMIT_PARAMS 1 334283980Sadrian/* See below; this is after the bpf_params definition */ 335283980Sadrian 336288245Sadrian#define NET80211_TAG_RECV_PARAMS 2 337288245Sadrian 338248069Sadrianstruct ieee80211com; 339254082Sadrianint ieee80211_parent_xmitpkt(struct ieee80211com *, struct mbuf *); 340254082Sadrianint ieee80211_vap_xmitpkt(struct ieee80211vap *, struct mbuf *); 341248069Sadrian 342144618Ssamvoid get_random_bytes(void *, size_t); 343138568Ssam 344138568Ssamvoid ieee80211_sysctl_attach(struct ieee80211com *); 345138568Ssamvoid ieee80211_sysctl_detach(struct ieee80211com *); 346178354Ssamvoid ieee80211_sysctl_vattach(struct ieee80211vap *); 347178354Ssamvoid ieee80211_sysctl_vdetach(struct ieee80211vap *); 348138568Ssam 349192473SsamSYSCTL_DECL(_net_wlan); 350192473Ssamint ieee80211_sysctl_msecs_ticks(SYSCTL_HANDLER_ARGS); 351192473Ssam 352138568Ssamvoid ieee80211_load_module(const char *); 353170530Ssam 354178354Ssam/* 355178354Ssam * A "policy module" is an adjunct module to net80211 that provides 356178354Ssam * functionality that typically includes policy decisions. This 357178354Ssam * modularity enables extensibility and vendor-supplied functionality. 358178354Ssam */ 359178354Ssam#define _IEEE80211_POLICY_MODULE(policy, name, version) \ 360178354Ssamtypedef void (*policy##_setup)(int); \ 361178354SsamSET_DECLARE(policy##_set, policy##_setup); \ 362170530Ssamstatic int \ 363178354Ssamwlan_##name##_modevent(module_t mod, int type, void *unused) \ 364170530Ssam{ \ 365178354Ssam policy##_setup * const *iter, f; \ 366170530Ssam switch (type) { \ 367170530Ssam case MOD_LOAD: \ 368178354Ssam SET_FOREACH(iter, policy##_set) { \ 369178354Ssam f = (void*) *iter; \ 370178354Ssam f(type); \ 371178354Ssam } \ 372170530Ssam return 0; \ 373170530Ssam case MOD_UNLOAD: \ 374170530Ssam case MOD_QUIESCE: \ 375170530Ssam if (nrefs) { \ 376282406Sadrian printf("wlan_" #name ": still in use " \ 377282406Sadrian "(%u dynamic refs)\n", nrefs); \ 378170530Ssam return EBUSY; \ 379170530Ssam } \ 380178354Ssam if (type == MOD_UNLOAD) { \ 381178354Ssam SET_FOREACH(iter, policy##_set) { \ 382178354Ssam f = (void*) *iter; \ 383178354Ssam f(type); \ 384178354Ssam } \ 385178354Ssam } \ 386170530Ssam return 0; \ 387170530Ssam } \ 388170530Ssam return EINVAL; \ 389170530Ssam} \ 390170530Ssamstatic moduledata_t name##_mod = { \ 391170530Ssam "wlan_" #name, \ 392178354Ssam wlan_##name##_modevent, \ 393241394Skevlo 0 \ 394170530Ssam}; \ 395170530SsamDECLARE_MODULE(wlan_##name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);\ 396170530SsamMODULE_VERSION(wlan_##name, version); \ 397170530SsamMODULE_DEPEND(wlan_##name, wlan, 1, 1, 1) 398178354Ssam 399178354Ssam/* 400178354Ssam * Crypto modules implement cipher support. 401178354Ssam */ 402178354Ssam#define IEEE80211_CRYPTO_MODULE(name, version) \ 403178354Ssam_IEEE80211_POLICY_MODULE(crypto, name, version); \ 404178354Ssamstatic void \ 405178354Ssamname##_modevent(int type) \ 406178354Ssam{ \ 407178354Ssam if (type == MOD_LOAD) \ 408178354Ssam ieee80211_crypto_register(&name); \ 409178354Ssam else \ 410178354Ssam ieee80211_crypto_unregister(&name); \ 411178354Ssam} \ 412178354SsamTEXT_SET(crypto##_set, name##_modevent) 413178354Ssam 414178354Ssam/* 415178354Ssam * Scanner modules provide scanning policy. 416178354Ssam */ 417178354Ssam#define IEEE80211_SCANNER_MODULE(name, version) \ 418178354Ssam _IEEE80211_POLICY_MODULE(scanner, name, version) 419178354Ssam 420178354Ssam#define IEEE80211_SCANNER_ALG(name, alg, v) \ 421178354Ssamstatic void \ 422178354Ssamname##_modevent(int type) \ 423178354Ssam{ \ 424178354Ssam if (type == MOD_LOAD) \ 425178354Ssam ieee80211_scanner_register(alg, &v); \ 426178354Ssam else \ 427178354Ssam ieee80211_scanner_unregister(alg, &v); \ 428178354Ssam} \ 429178354SsamTEXT_SET(scanner_set, name##_modevent); \ 430178354Ssam 431178354Ssam/* 432178354Ssam * ACL modules implement acl policy. 433178354Ssam */ 434178354Ssam#define IEEE80211_ACL_MODULE(name, alg, version) \ 435178354Ssam_IEEE80211_POLICY_MODULE(acl, name, version); \ 436178354Ssamstatic void \ 437178354Ssamalg##_modevent(int type) \ 438178354Ssam{ \ 439178354Ssam if (type == MOD_LOAD) \ 440178354Ssam ieee80211_aclator_register(&alg); \ 441178354Ssam else \ 442178354Ssam ieee80211_aclator_unregister(&alg); \ 443178354Ssam} \ 444178354SsamTEXT_SET(acl_set, alg##_modevent); \ 445178354Ssam 446178354Ssam/* 447178354Ssam * Authenticator modules handle 802.1x/WPA authentication. 448178354Ssam */ 449178354Ssam#define IEEE80211_AUTH_MODULE(name, version) \ 450178354Ssam _IEEE80211_POLICY_MODULE(auth, name, version) 451178354Ssam 452178354Ssam#define IEEE80211_AUTH_ALG(name, alg, v) \ 453178354Ssamstatic void \ 454178354Ssamname##_modevent(int type) \ 455178354Ssam{ \ 456178354Ssam if (type == MOD_LOAD) \ 457178354Ssam ieee80211_authenticator_register(alg, &v); \ 458178354Ssam else \ 459178354Ssam ieee80211_authenticator_unregister(alg); \ 460178354Ssam} \ 461178354SsamTEXT_SET(auth_set, name##_modevent) 462178354Ssam 463178354Ssam/* 464178354Ssam * Rate control modules provide tx rate control support. 465178354Ssam */ 466206358Srpaulo#define IEEE80211_RATECTL_MODULE(alg, version) \ 467206358Srpaulo _IEEE80211_POLICY_MODULE(ratectl, alg, version); \ 468206358Srpaulo 469206358Srpaulo#define IEEE80211_RATECTL_ALG(name, alg, v) \ 470178354Ssamstatic void \ 471178354Ssamalg##_modevent(int type) \ 472178354Ssam{ \ 473206358Srpaulo if (type == MOD_LOAD) \ 474206358Srpaulo ieee80211_ratectl_register(alg, &v); \ 475206358Srpaulo else \ 476206358Srpaulo ieee80211_ratectl_unregister(alg); \ 477178354Ssam} \ 478206358SrpauloTEXT_SET(ratectl##_set, alg##_modevent) 479138568Ssam 480190384Ssamstruct ieee80211req; 481190384Ssamtypedef int ieee80211_ioctl_getfunc(struct ieee80211vap *, 482190384Ssam struct ieee80211req *); 483190384SsamSET_DECLARE(ieee80211_ioctl_getset, ieee80211_ioctl_getfunc); 484190384Ssam#define IEEE80211_IOCTL_GET(_name, _get) TEXT_SET(ieee80211_ioctl_getset, _get) 485190384Ssam 486190384Ssamtypedef int ieee80211_ioctl_setfunc(struct ieee80211vap *, 487190384Ssam struct ieee80211req *); 488190384SsamSET_DECLARE(ieee80211_ioctl_setset, ieee80211_ioctl_setfunc); 489190384Ssam#define IEEE80211_IOCTL_SET(_name, _set) TEXT_SET(ieee80211_ioctl_setset, _set) 490190394Ssam#endif /* _KERNEL */ 491190384Ssam 492138568Ssam/* XXX this stuff belongs elsewhere */ 493138568Ssam/* 494138568Ssam * Message formats for messages from the net80211 layer to user 495138568Ssam * applications via the routing socket. These messages are appended 496138568Ssam * to an if_announcemsghdr structure. 497138568Ssam */ 498138568Ssamstruct ieee80211_join_event { 499138568Ssam uint8_t iev_addr[6]; 500138568Ssam}; 501138568Ssam 502138568Ssamstruct ieee80211_leave_event { 503138568Ssam uint8_t iev_addr[6]; 504138568Ssam}; 505138568Ssam 506138568Ssamstruct ieee80211_replay_event { 507138568Ssam uint8_t iev_src[6]; /* src MAC */ 508138568Ssam uint8_t iev_dst[6]; /* dst MAC */ 509138568Ssam uint8_t iev_cipher; /* cipher type */ 510138568Ssam uint8_t iev_keyix; /* key id/index */ 511138568Ssam uint64_t iev_keyrsc; /* RSC from key */ 512138568Ssam uint64_t iev_rsc; /* RSC from frame */ 513138568Ssam}; 514138568Ssam 515138568Ssamstruct ieee80211_michael_event { 516138568Ssam uint8_t iev_src[6]; /* src MAC */ 517138568Ssam uint8_t iev_dst[6]; /* dst MAC */ 518138568Ssam uint8_t iev_cipher; /* cipher type */ 519138568Ssam uint8_t iev_keyix; /* key id/index */ 520138568Ssam}; 521138568Ssam 522178354Ssamstruct ieee80211_wds_event { 523178354Ssam uint8_t iev_addr[6]; 524178354Ssam}; 525178354Ssam 526178354Ssamstruct ieee80211_csa_event { 527178354Ssam uint32_t iev_flags; /* channel flags */ 528178354Ssam uint16_t iev_freq; /* setting in Mhz */ 529178354Ssam uint8_t iev_ieee; /* IEEE channel number */ 530178354Ssam uint8_t iev_mode; /* CSA mode */ 531178354Ssam uint8_t iev_count; /* CSA count */ 532178354Ssam}; 533178354Ssam 534178354Ssamstruct ieee80211_cac_event { 535178354Ssam uint32_t iev_flags; /* channel flags */ 536178354Ssam uint16_t iev_freq; /* setting in Mhz */ 537178354Ssam uint8_t iev_ieee; /* IEEE channel number */ 538178354Ssam /* XXX timestamp? */ 539178354Ssam uint8_t iev_type; /* IEEE80211_NOTIFY_CAC_* */ 540178354Ssam}; 541178354Ssam 542178354Ssamstruct ieee80211_radar_event { 543178354Ssam uint32_t iev_flags; /* channel flags */ 544178354Ssam uint16_t iev_freq; /* setting in Mhz */ 545178354Ssam uint8_t iev_ieee; /* IEEE channel number */ 546178354Ssam /* XXX timestamp? */ 547178354Ssam}; 548178354Ssam 549178354Ssamstruct ieee80211_auth_event { 550178354Ssam uint8_t iev_addr[6]; 551178354Ssam}; 552178354Ssam 553178354Ssamstruct ieee80211_deauth_event { 554178354Ssam uint8_t iev_addr[6]; 555178354Ssam}; 556178354Ssam 557178354Ssamstruct ieee80211_country_event { 558178354Ssam uint8_t iev_addr[6]; 559178354Ssam uint8_t iev_cc[2]; /* ISO country code */ 560178354Ssam}; 561178354Ssam 562178354Ssamstruct ieee80211_radio_event { 563178354Ssam uint8_t iev_state; /* 1 on, 0 off */ 564178354Ssam}; 565178354Ssam 566138568Ssam#define RTM_IEEE80211_ASSOC 100 /* station associate (bss mode) */ 567138568Ssam#define RTM_IEEE80211_REASSOC 101 /* station re-associate (bss mode) */ 568138568Ssam#define RTM_IEEE80211_DISASSOC 102 /* station disassociate (bss mode) */ 569138568Ssam#define RTM_IEEE80211_JOIN 103 /* station join (ap mode) */ 570138568Ssam#define RTM_IEEE80211_LEAVE 104 /* station leave (ap mode) */ 571138568Ssam#define RTM_IEEE80211_SCAN 105 /* scan complete, results available */ 572138568Ssam#define RTM_IEEE80211_REPLAY 106 /* sequence counter replay detected */ 573138568Ssam#define RTM_IEEE80211_MICHAEL 107 /* Michael MIC failure detected */ 574144302Ssam#define RTM_IEEE80211_REJOIN 108 /* station re-associate (ap mode) */ 575178354Ssam#define RTM_IEEE80211_WDS 109 /* WDS discovery (ap mode) */ 576178354Ssam#define RTM_IEEE80211_CSA 110 /* Channel Switch Announcement event */ 577178354Ssam#define RTM_IEEE80211_RADAR 111 /* radar event */ 578178354Ssam#define RTM_IEEE80211_CAC 112 /* Channel Availability Check event */ 579178354Ssam#define RTM_IEEE80211_DEAUTH 113 /* station deauthenticate */ 580178354Ssam#define RTM_IEEE80211_AUTH 114 /* station authenticate (ap mode) */ 581178354Ssam#define RTM_IEEE80211_COUNTRY 115 /* discovered country code (sta mode) */ 582178354Ssam#define RTM_IEEE80211_RADIO 116 /* RF kill switch state change */ 583138568Ssam 584160690Ssam/* 585160690Ssam * Structure prepended to raw packets sent through the bpf 586160690Ssam * interface when set to DLT_IEEE802_11_RADIO. This allows 587160690Ssam * user applications to specify pretty much everything in 588160690Ssam * an Atheros tx descriptor. XXX need to generalize. 589160690Ssam * 590160690Ssam * XXX cannot be more than 14 bytes as it is copied to a sockaddr's 591160690Ssam * XXX sa_data area. 592160690Ssam */ 593160690Ssamstruct ieee80211_bpf_params { 594160690Ssam uint8_t ibp_vers; /* version */ 595160690Ssam#define IEEE80211_BPF_VERSION 0 596160690Ssam uint8_t ibp_len; /* header length in bytes */ 597160690Ssam uint8_t ibp_flags; 598160690Ssam#define IEEE80211_BPF_SHORTPRE 0x01 /* tx with short preamble */ 599160690Ssam#define IEEE80211_BPF_NOACK 0x02 /* tx with no ack */ 600160690Ssam#define IEEE80211_BPF_CRYPTO 0x04 /* tx with h/w encryption */ 601160690Ssam#define IEEE80211_BPF_FCS 0x10 /* frame incldues FCS */ 602160690Ssam#define IEEE80211_BPF_DATAPAD 0x20 /* frame includes data padding */ 603160690Ssam#define IEEE80211_BPF_RTS 0x40 /* tx with RTS/CTS */ 604160690Ssam#define IEEE80211_BPF_CTS 0x80 /* tx with CTS only */ 605160690Ssam uint8_t ibp_pri; /* WME/WMM AC+tx antenna */ 606160690Ssam uint8_t ibp_try0; /* series 1 try count */ 607160690Ssam uint8_t ibp_rate0; /* series 1 IEEE tx rate */ 608160690Ssam uint8_t ibp_power; /* tx power (device units) */ 609160690Ssam uint8_t ibp_ctsrate; /* IEEE tx rate for CTS */ 610160690Ssam uint8_t ibp_try1; /* series 2 try count */ 611160690Ssam uint8_t ibp_rate1; /* series 2 IEEE tx rate */ 612160690Ssam uint8_t ibp_try2; /* series 3 try count */ 613160690Ssam uint8_t ibp_rate2; /* series 3 IEEE tx rate */ 614160690Ssam uint8_t ibp_try3; /* series 4 try count */ 615160690Ssam uint8_t ibp_rate3; /* series 4 IEEE tx rate */ 616160690Ssam}; 617283538Sadrian 618283986Sandrew#ifdef _KERNEL 619283980Sadrianstruct ieee80211_tx_params { 620283980Sadrian struct ieee80211_bpf_params params; 621283980Sadrian}; 622283980Sadrianint ieee80211_add_xmit_params(struct mbuf *m, 623283980Sadrian const struct ieee80211_bpf_params *); 624283980Sadrianint ieee80211_get_xmit_params(struct mbuf *m, 625283980Sadrian struct ieee80211_bpf_params *); 626288245Sadrian 627330576Seadler#define IEEE80211_MAX_CHAINS 3 628288245Sadrian#define IEEE80211_MAX_EVM_PILOTS 6 629288245Sadrian 630330576Seadler#define IEEE80211_R_NF 0x0000001 /* global NF value valid */ 631330576Seadler#define IEEE80211_R_RSSI 0x0000002 /* global RSSI value valid */ 632330576Seadler#define IEEE80211_R_C_CHAIN 0x0000004 /* RX chain count valid */ 633330576Seadler#define IEEE80211_R_C_NF 0x0000008 /* per-chain NF value valid */ 634330576Seadler#define IEEE80211_R_C_RSSI 0x0000010 /* per-chain RSSI value valid */ 635330576Seadler#define IEEE80211_R_C_EVM 0x0000020 /* per-chain EVM valid */ 636330576Seadler#define IEEE80211_R_C_HT40 0x0000040 /* RX'ed packet is 40mhz, pilots 4,5 valid */ 637330576Seadler#define IEEE80211_R_FREQ 0x0000080 /* Freq value populated, MHz */ 638330576Seadler#define IEEE80211_R_IEEE 0x0000100 /* IEEE value populated */ 639330576Seadler#define IEEE80211_R_BAND 0x0000200 /* Frequency band populated */ 640288245Sadrian 641288245Sadrianstruct ieee80211_rx_stats { 642288245Sadrian uint32_t r_flags; /* IEEE80211_R_* flags */ 643288245Sadrian uint8_t c_chain; /* number of RX chains involved */ 644330576Seadler int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 645330576Seadler int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 646330576Seadler int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 647330576Seadler int16_t c_rssi_ext[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 648330576Seadler uint8_t nf; /* global NF */ 649330576Seadler uint8_t rssi; /* global RSSI */ 650330576Seadler uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS]; 651330576Seadler /* per-chain, per-pilot EVM values */ 652330576Seadler uint16_t c_freq; 653330576Seadler uint8_t c_ieee; 654288245Sadrian}; 655288245Sadrian 656288245Sadrianstruct ieee80211_rx_params { 657288245Sadrian struct ieee80211_rx_stats params; 658288245Sadrian}; 659288245Sadrianint ieee80211_add_rx_params(struct mbuf *m, 660288245Sadrian const struct ieee80211_rx_stats *rxs); 661288245Sadrianint ieee80211_get_rx_params(struct mbuf *m, 662288245Sadrian struct ieee80211_rx_stats *rxs); 663283986Sandrew#endif /* _KERNEL */ 664283980Sadrian 665283538Sadrian/* 666283538Sadrian * Malloc API. Other BSD operating systems have slightly 667283538Sadrian * different malloc/free namings (eg DragonflyBSD.) 668283538Sadrian */ 669283538Sadrian#define IEEE80211_MALLOC malloc 670283538Sadrian#define IEEE80211_FREE free 671283538Sadrian 672283538Sadrian/* XXX TODO: get rid of WAITOK, fix all the users of it? */ 673283538Sadrian#define IEEE80211_M_NOWAIT M_NOWAIT 674283538Sadrian#define IEEE80211_M_WAITOK M_WAITOK 675283538Sadrian#define IEEE80211_M_ZERO M_ZERO 676283538Sadrian 677283538Sadrian/* XXX TODO: the type fields */ 678283538Sadrian 679138568Ssam#endif /* _NET80211_IEEE80211_FREEBSD_H_ */ 680