ieee80211_freebsd.h revision 165911
1/*- 2 * Copyright (c) 2003-2005 Sam Leffler, Errno Consulting 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * $FreeBSD: head/sys/net80211/ieee80211_freebsd.h 165911 2007-01-09 04:37:05Z sam $ 28 */ 29#ifndef _NET80211_IEEE80211_FREEBSD_H_ 30#define _NET80211_IEEE80211_FREEBSD_H_ 31 32#ifdef _KERNEL 33/* 34 * Beacon locking definitions. 35 */ 36typedef struct mtx ieee80211_beacon_lock_t; 37#define IEEE80211_BEACON_LOCK_INIT(_ic, _name) \ 38 mtx_init(&(_ic)->ic_beaconlock, _name, "802.11 beacon lock", MTX_DEF) 39#define IEEE80211_BEACON_LOCK_DESTROY(_ic) mtx_destroy(&(_ic)->ic_beaconlock) 40#define IEEE80211_BEACON_LOCK(_ic) mtx_lock(&(_ic)->ic_beaconlock) 41#define IEEE80211_BEACON_UNLOCK(_ic) mtx_unlock(&(_ic)->ic_beaconlock) 42#define IEEE80211_BEACON_LOCK_ASSERT(_ic) \ 43 mtx_assert(&(_ic)->ic_beaconlock, MA_OWNED) 44 45/* 46 * Node locking definitions. 47 * NB: MTX_DUPOK is because we don't generate per-interface strings. 48 */ 49typedef struct mtx ieee80211_node_lock_t; 50#define IEEE80211_NODE_LOCK_INIT(_nt, _name) \ 51 mtx_init(&(_nt)->nt_nodelock, _name, "802.11 node table", \ 52 MTX_DEF | MTX_DUPOK) 53#define IEEE80211_NODE_LOCK_DESTROY(_nt) mtx_destroy(&(_nt)->nt_nodelock) 54#define IEEE80211_NODE_LOCK(_nt) mtx_lock(&(_nt)->nt_nodelock) 55#define IEEE80211_NODE_IS_LOCKED(_nt) mtx_owned(&(_nt)->nt_nodelock) 56#define IEEE80211_NODE_UNLOCK(_nt) mtx_unlock(&(_nt)->nt_nodelock) 57#define IEEE80211_NODE_LOCK_ASSERT(_nt) \ 58 mtx_assert(&(_nt)->nt_nodelock, MA_OWNED) 59 60/* 61 * Node table scangen locking definitions. 62 */ 63typedef struct mtx ieee80211_scan_lock_t; 64#define IEEE80211_SCAN_LOCK_INIT(_nt, _name) \ 65 mtx_init(&(_nt)->nt_scanlock, _name, "802.11 scangen", MTX_DEF) 66#define IEEE80211_SCAN_LOCK_DESTROY(_nt) mtx_destroy(&(_nt)->nt_scanlock) 67#define IEEE80211_SCAN_LOCK(_nt) mtx_lock(&(_nt)->nt_scanlock) 68#define IEEE80211_SCAN_UNLOCK(_nt) mtx_unlock(&(_nt)->nt_scanlock) 69#define IEEE80211_SCAN_LOCK_ASSERT(_nt) \ 70 mtx_assert(&(_nt)->nt_scanlock, MA_OWNED) 71 72/* 73 * Per-node power-save queue definitions. 74 */ 75#define IEEE80211_NODE_SAVEQ_INIT(_ni, _name) do { \ 76 mtx_init(&(_ni)->ni_savedq.ifq_mtx, _name, "802.11 ps queue", MTX_DEF);\ 77 (_ni)->ni_savedq.ifq_maxlen = IEEE80211_PS_MAX_QUEUE; \ 78} while (0) 79#define IEEE80211_NODE_SAVEQ_DESTROY(_ni) \ 80 mtx_destroy(&(_ni)->ni_savedq.ifq_mtx) 81#define IEEE80211_NODE_SAVEQ_QLEN(_ni) \ 82 _IF_QLEN(&(_ni)->ni_savedq) 83#define IEEE80211_NODE_SAVEQ_LOCK(_ni) do { \ 84 IF_LOCK(&(_ni)->ni_savedq); \ 85} while (0) 86#define IEEE80211_NODE_SAVEQ_UNLOCK(_ni) do { \ 87 IF_UNLOCK(&(_ni)->ni_savedq); \ 88} while (0) 89#define IEEE80211_NODE_SAVEQ_DEQUEUE(_ni, _m, _qlen) do { \ 90 IEEE80211_NODE_SAVEQ_LOCK(_ni); \ 91 _IF_DEQUEUE(&(_ni)->ni_savedq, _m); \ 92 (_qlen) = IEEE80211_NODE_SAVEQ_QLEN(_ni); \ 93 IEEE80211_NODE_SAVEQ_UNLOCK(_ni); \ 94} while (0) 95#define IEEE80211_NODE_SAVEQ_DRAIN(_ni, _qlen) do { \ 96 IEEE80211_NODE_SAVEQ_LOCK(_ni); \ 97 (_qlen) = IEEE80211_NODE_SAVEQ_QLEN(_ni); \ 98 _IF_DRAIN(&(_ni)->ni_savedq); \ 99 IEEE80211_NODE_SAVEQ_UNLOCK(_ni); \ 100} while (0) 101/* XXX could be optimized */ 102#define _IEEE80211_NODE_SAVEQ_DEQUEUE_HEAD(_ni, _m) do { \ 103 _IF_DEQUEUE(&(_ni)->ni_savedq, m); \ 104} while (0) 105#define _IEEE80211_NODE_SAVEQ_ENQUEUE(_ni, _m, _qlen, _age) do {\ 106 (_m)->m_nextpkt = NULL; \ 107 if ((_ni)->ni_savedq.ifq_tail != NULL) { \ 108 _age -= M_AGE_GET((_ni)->ni_savedq.ifq_tail); \ 109 (_ni)->ni_savedq.ifq_tail->m_nextpkt = (_m); \ 110 } else { \ 111 (_ni)->ni_savedq.ifq_head = (_m); \ 112 } \ 113 M_AGE_SET(_m, _age); \ 114 (_ni)->ni_savedq.ifq_tail = (_m); \ 115 (_qlen) = ++(_ni)->ni_savedq.ifq_len; \ 116} while (0) 117 118/* 119 * 802.1x MAC ACL database locking definitions. 120 */ 121typedef struct mtx acl_lock_t; 122#define ACL_LOCK_INIT(_as, _name) \ 123 mtx_init(&(_as)->as_lock, _name, "802.11 ACL", MTX_DEF) 124#define ACL_LOCK_DESTROY(_as) mtx_destroy(&(_as)->as_lock) 125#define ACL_LOCK(_as) mtx_lock(&(_as)->as_lock) 126#define ACL_UNLOCK(_as) mtx_unlock(&(_as)->as_lock) 127#define ACL_LOCK_ASSERT(_as) \ 128 mtx_assert((&(_as)->as_lock), MA_OWNED) 129 130/* 131 * Node reference counting definitions. 132 * 133 * ieee80211_node_initref initialize the reference count to 1 134 * ieee80211_node_incref add a reference 135 * ieee80211_node_decref remove a reference 136 * ieee80211_node_dectestref remove a reference and return 1 if this 137 * is the last reference, otherwise 0 138 * ieee80211_node_refcnt reference count for printing (only) 139 */ 140#include <machine/atomic.h> 141 142#define ieee80211_node_initref(_ni) \ 143 do { ((_ni)->ni_refcnt = 1); } while (0) 144#define ieee80211_node_incref(_ni) \ 145 atomic_add_int(&(_ni)->ni_refcnt, 1) 146#define ieee80211_node_decref(_ni) \ 147 atomic_subtract_int(&(_ni)->ni_refcnt, 1) 148struct ieee80211_node; 149int ieee80211_node_dectestref(struct ieee80211_node *ni); 150#define ieee80211_node_refcnt(_ni) (_ni)->ni_refcnt 151 152struct ifqueue; 153void ieee80211_drain_ifq(struct ifqueue *); 154 155struct mbuf *ieee80211_getmgtframe(u_int8_t **frm, u_int pktlen); 156#define M_LINK0 M_PROTO1 /* WEP requested */ 157#define M_PWR_SAV M_PROTO4 /* bypass PS handling */ 158#define M_MORE_DATA M_PROTO5 /* more data frames to follow */ 159/* 160 * Encode WME access control bits in the PROTO flags. 161 * This is safe since it's passed directly in to the 162 * driver and there's no chance someone else will clobber 163 * them on us. 164 */ 165#define M_WME_AC_MASK (M_PROTO2|M_PROTO3) 166/* XXX 5 is wrong if M_PROTO* are redefined */ 167#define M_WME_AC_SHIFT 5 168 169#define M_WME_SETAC(m, ac) \ 170 ((m)->m_flags = ((m)->m_flags &~ M_WME_AC_MASK) | \ 171 ((ac) << M_WME_AC_SHIFT)) 172#define M_WME_GETAC(m) (((m)->m_flags >> M_WME_AC_SHIFT) & 0x3) 173 174/* 175 * Mbufs on the power save queue are tagged with an age and 176 * timed out. We reuse the hardware checksum field in the 177 * mbuf packet header to store this data. 178 */ 179#define M_AGE_SET(m,v) (m->m_pkthdr.csum_data = v) 180#define M_AGE_GET(m) (m->m_pkthdr.csum_data) 181#define M_AGE_SUB(m,adj) (m->m_pkthdr.csum_data -= adj) 182 183void get_random_bytes(void *, size_t); 184 185struct ieee80211com; 186 187void ieee80211_sysctl_attach(struct ieee80211com *); 188void ieee80211_sysctl_detach(struct ieee80211com *); 189 190void ieee80211_load_module(const char *); 191#endif /* _KERNEL */ 192 193/* XXX this stuff belongs elsewhere */ 194/* 195 * Message formats for messages from the net80211 layer to user 196 * applications via the routing socket. These messages are appended 197 * to an if_announcemsghdr structure. 198 */ 199struct ieee80211_join_event { 200 uint8_t iev_addr[6]; 201}; 202 203struct ieee80211_leave_event { 204 uint8_t iev_addr[6]; 205}; 206 207struct ieee80211_replay_event { 208 uint8_t iev_src[6]; /* src MAC */ 209 uint8_t iev_dst[6]; /* dst MAC */ 210 uint8_t iev_cipher; /* cipher type */ 211 uint8_t iev_keyix; /* key id/index */ 212 uint64_t iev_keyrsc; /* RSC from key */ 213 uint64_t iev_rsc; /* RSC from frame */ 214}; 215 216struct ieee80211_michael_event { 217 uint8_t iev_src[6]; /* src MAC */ 218 uint8_t iev_dst[6]; /* dst MAC */ 219 uint8_t iev_cipher; /* cipher type */ 220 uint8_t iev_keyix; /* key id/index */ 221}; 222 223#define RTM_IEEE80211_ASSOC 100 /* station associate (bss mode) */ 224#define RTM_IEEE80211_REASSOC 101 /* station re-associate (bss mode) */ 225#define RTM_IEEE80211_DISASSOC 102 /* station disassociate (bss mode) */ 226#define RTM_IEEE80211_JOIN 103 /* station join (ap mode) */ 227#define RTM_IEEE80211_LEAVE 104 /* station leave (ap mode) */ 228#define RTM_IEEE80211_SCAN 105 /* scan complete, results available */ 229#define RTM_IEEE80211_REPLAY 106 /* sequence counter replay detected */ 230#define RTM_IEEE80211_MICHAEL 107 /* Michael MIC failure detected */ 231#define RTM_IEEE80211_REJOIN 108 /* station re-associate (ap mode) */ 232 233/* 234 * Structure prepended to raw packets sent through the bpf 235 * interface when set to DLT_IEEE802_11_RADIO. This allows 236 * user applications to specify pretty much everything in 237 * an Atheros tx descriptor. XXX need to generalize. 238 * 239 * XXX cannot be more than 14 bytes as it is copied to a sockaddr's 240 * XXX sa_data area. 241 */ 242struct ieee80211_bpf_params { 243 uint8_t ibp_vers; /* version */ 244#define IEEE80211_BPF_VERSION 0 245 uint8_t ibp_len; /* header length in bytes */ 246 uint8_t ibp_flags; 247#define IEEE80211_BPF_SHORTPRE 0x01 /* tx with short preamble */ 248#define IEEE80211_BPF_NOACK 0x02 /* tx with no ack */ 249#define IEEE80211_BPF_CRYPTO 0x04 /* tx with h/w encryption */ 250#define IEEE80211_BPF_FCS 0x10 /* frame incldues FCS */ 251#define IEEE80211_BPF_DATAPAD 0x20 /* frame includes data padding */ 252#define IEEE80211_BPF_RTS 0x40 /* tx with RTS/CTS */ 253#define IEEE80211_BPF_CTS 0x80 /* tx with CTS only */ 254 uint8_t ibp_pri; /* WME/WMM AC+tx antenna */ 255 uint8_t ibp_try0; /* series 1 try count */ 256 uint8_t ibp_rate0; /* series 1 IEEE tx rate */ 257 uint8_t ibp_power; /* tx power (device units) */ 258 uint8_t ibp_ctsrate; /* IEEE tx rate for CTS */ 259 uint8_t ibp_try1; /* series 2 try count */ 260 uint8_t ibp_rate1; /* series 2 IEEE tx rate */ 261 uint8_t ibp_try2; /* series 3 try count */ 262 uint8_t ibp_rate2; /* series 3 IEEE tx rate */ 263 uint8_t ibp_try3; /* series 4 try count */ 264 uint8_t ibp_rate3; /* series 4 IEEE tx rate */ 265}; 266#endif /* _NET80211_IEEE80211_FREEBSD_H_ */ 267