sys/net80211/ieee80211_freebsd.h

   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$
  28  */
  29 #ifndef _NET80211_IEEE80211_FREEBSD_H_
  30 #define _NET80211_IEEE80211_FREEBSD_H_
  31
  32 /*
  33  * Beacon locking definitions.
  34  */
  35 typedef struct mtx ieee80211_beacon_lock_t;
  36 #define IEEE80211_BEACON_LOCK_INIT(_ic, _name) \
  37         mtx_init(&(_ic)->ic_beaconlock, _name, "802.11 beacon lock", MTX_DEF)
  38 #define IEEE80211_BEACON_LOCK_DESTROY(_ic) mtx_destroy(&(_ic)->ic_beaconlock)
  39 #define IEEE80211_BEACON_LOCK(_ic)         mtx_lock(&(_ic)->ic_beaconlock)
  40 #define IEEE80211_BEACON_UNLOCK(_ic)       mtx_unlock(&(_ic)->ic_beaconlock)
  41 #define IEEE80211_BEACON_LOCK_ASSERT(_ic) \
  42         mtx_assert(&(_ic)->ic_beaconlock, MA_OWNED)
  43
  44 /*
  45  * Node locking definitions.
  46  * NB: MTX_DUPOK is because we don't generate per-interface strings.
  47  */
  48 typedef struct mtx ieee80211_node_lock_t;
  49 #define IEEE80211_NODE_LOCK_INIT(_nt, _name) \
  50         mtx_init(&(_nt)->nt_nodelock, _name, "802.11 node table", \
  51                 MTX_DEF | MTX_DUPOK)
  52 #define IEEE80211_NODE_LOCK_DESTROY(_nt)        mtx_destroy(&(_nt)->nt_nodelock)
  53 #define IEEE80211_NODE_LOCK(_nt)                mtx_lock(&(_nt)->nt_nodelock)
  54 #define IEEE80211_NODE_IS_LOCKED(_nt)           mtx_owned(&(_nt)->nt_nodelock)
  55 #define IEEE80211_NODE_UNLOCK(_nt)              mtx_unlock(&(_nt)->nt_nodelock)
  56 #define IEEE80211_NODE_LOCK_ASSERT(_nt) \
  57         mtx_assert(&(_nt)->nt_nodelock, MA_OWNED)
  58
  59 /*
  60  * Node table scangen locking definitions.
  61  */
  62 typedef struct mtx ieee80211_scan_lock_t;
  63 #define IEEE80211_SCAN_LOCK_INIT(_nt, _name) \
  64         mtx_init(&(_nt)->nt_scanlock, _name, "802.11 scangen", MTX_DEF)
  65 #define IEEE80211_SCAN_LOCK_DESTROY(_nt)        mtx_destroy(&(_nt)->nt_scanlock)
  66 #define IEEE80211_SCAN_LOCK(_nt)                mtx_lock(&(_nt)->nt_scanlock)
  67 #define IEEE80211_SCAN_UNLOCK(_nt)              mtx_unlock(&(_nt)->nt_scanlock)
  68 #define IEEE80211_SCAN_LOCK_ASSERT(_nt) \
  69         mtx_assert(&(_nt)->nt_scanlock, MA_OWNED)
  70
  71 /*
  72  * Per-node power-save queue definitions.
  73  */
  74 #define IEEE80211_NODE_SAVEQ_INIT(_ni, _name) do {              \
  75         mtx_init(&(_ni)->ni_savedq.ifq_mtx, _name, "802.11 ps queue", MTX_DEF);\
  76         (_ni)->ni_savedq.ifq_maxlen = IEEE80211_PS_MAX_QUEUE;   \
  77 } while (0)
  78 #define IEEE80211_NODE_SAVEQ_DESTROY(_ni) \
  79         mtx_destroy(&(_ni)->ni_savedq.ifq_mtx)
  80 #define IEEE80211_NODE_SAVEQ_QLEN(_ni) \
  81         _IF_QLEN(&(_ni)->ni_savedq)
  82 #define IEEE80211_NODE_SAVEQ_LOCK(_ni) do {     \
  83         IF_LOCK(&(_ni)->ni_savedq);                             \
  84 } while (0)
  85 #define IEEE80211_NODE_SAVEQ_UNLOCK(_ni) do {   \
  86         IF_UNLOCK(&(_ni)->ni_savedq);                           \
  87 } while (0)
  88 #define IEEE80211_NODE_SAVEQ_DEQUEUE(_ni, _m, _qlen) do {       \
  89         IEEE80211_NODE_SAVEQ_LOCK(_ni);                         \
  90         _IF_DEQUEUE(&(_ni)->ni_savedq, _m);                     \
  91         (_qlen) = IEEE80211_NODE_SAVEQ_QLEN(_ni);               \
  92         IEEE80211_NODE_SAVEQ_UNLOCK(_ni);                       \
  93 } while (0)
  94 #define IEEE80211_NODE_SAVEQ_DRAIN(_ni, _qlen) do {             \
  95         IEEE80211_NODE_SAVEQ_LOCK(_ni);                         \
  96         (_qlen) = IEEE80211_NODE_SAVEQ_QLEN(_ni);               \
  97         _IF_DRAIN(&(_ni)->ni_savedq);                           \
  98         IEEE80211_NODE_SAVEQ_UNLOCK(_ni);                       \
  99 } while (0)
 100 /* XXX could be optimized */
 101 #define _IEEE80211_NODE_SAVEQ_DEQUEUE_HEAD(_ni, _m) do {        \
 102         _IF_DEQUEUE(&(_ni)->ni_savedq, m);                      \
 103 } while (0)
 104 #define _IEEE80211_NODE_SAVEQ_ENQUEUE(_ni, _m, _qlen, _age) do {\
 105         (_m)->m_nextpkt = NULL;                                 \
 106         if ((_ni)->ni_savedq.ifq_tail != NULL) {                \
 107                 _age -= M_AGE_GET((_ni)->ni_savedq.ifq_tail);   \
 108                 (_ni)->ni_savedq.ifq_tail->m_nextpkt = (_m);    \
 109         } else {                                                \
 110                 (_ni)->ni_savedq.ifq_head = (_m);               \
 111         }                                                       \
 112         M_AGE_SET(_m, _age);                                    \
 113         (_ni)->ni_savedq.ifq_tail = (_m);                       \
 114         (_qlen) = ++(_ni)->ni_savedq.ifq_len;                   \
 115 } while (0)
 116
 117 /*
 118  * 802.1x MAC ACL database locking definitions.
 119  */
 120 typedef struct mtx acl_lock_t;
 121 #define ACL_LOCK_INIT(_as, _name) \
 122         mtx_init(&(_as)->as_lock, _name, "802.11 ACL", MTX_DEF)
 123 #define ACL_LOCK_DESTROY(_as)           mtx_destroy(&(_as)->as_lock)
 124 #define ACL_LOCK(_as)                   mtx_lock(&(_as)->as_lock)
 125 #define ACL_UNLOCK(_as)                 mtx_unlock(&(_as)->as_lock)
 126 #define ACL_LOCK_ASSERT(_as) \
 127         mtx_assert((&(_as)->as_lock), MA_OWNED)
 128
 129 /*
 130  * Node reference counting definitions.
 131  *
 132  * ieee80211_node_initref       initialize the reference count to 1
 133  * ieee80211_node_incref        add a reference
 134  * ieee80211_node_decref        remove a reference
 135  * ieee80211_node_dectestref    remove a reference and return 1 if this
 136  *                              is the last reference, otherwise 0
 137  * ieee80211_node_refcnt        reference count for printing (only)
 138  */
 139 #include <machine/atomic.h>
 140
 141 #define ieee80211_node_initref(_ni) \
 142         do { ((_ni)->ni_refcnt = 1); } while (0)
 143 #define ieee80211_node_incref(_ni) \
 144         atomic_add_int(&(_ni)->ni_refcnt, 1)
 145 #define ieee80211_node_decref(_ni) \
 146         atomic_subtract_int(&(_ni)->ni_refcnt, 1)
 147 struct ieee80211_node;
 148 int     ieee80211_node_dectestref(struct ieee80211_node *ni);
 149 #define ieee80211_node_refcnt(_ni)      (_ni)->ni_refcnt
 150
 151 struct mbuf *ieee80211_getmgtframe(u_int8_t **frm, u_int pktlen);
 152 #define M_LINK0         M_PROTO1                /* WEP requested */
 153 #define M_PWR_SAV       M_PROTO4                /* bypass PS handling */
 154 #define M_MORE_DATA     M_PROTO5                /* more data frames to follow */
 155 /*
 156  * Encode WME access control bits in the PROTO flags.
 157  * This is safe since it's passed directly in to the
 158  * driver and there's no chance someone else will clobber
 159  * them on us.
 160  */
 161 #define M_WME_AC_MASK   (M_PROTO2|M_PROTO3)
 162 /* XXX 5 is wrong if M_PROTO* are redefined */
 163 #define M_WME_AC_SHIFT  5
 164
 165 #define M_WME_SETAC(m, ac) \
 166         ((m)->m_flags = ((m)->m_flags &~ M_WME_AC_MASK) | \
 167                 ((ac) << M_WME_AC_SHIFT))
 168 #define M_WME_GETAC(m)  (((m)->m_flags >> M_WME_AC_SHIFT) & 0x3)
 169
 170 /*
 171  * Mbufs on the power save queue are tagged with an age and
 172  * timed out.  We reuse the hardware checksum field in the
 173  * mbuf packet header to store this data.
 174  */
 175 #define M_AGE_SET(m,v)          (m->m_pkthdr.csum_data = v)
 176 #define M_AGE_GET(m)            (m->m_pkthdr.csum_data)
 177 #define M_AGE_SUB(m,adj)        (m->m_pkthdr.csum_data -= adj)
 178
 179 void    get_random_bytes(void *, size_t);
 180
 181 struct ieee80211com;
 182
 183 void    ieee80211_sysctl_attach(struct ieee80211com *);
 184 void    ieee80211_sysctl_detach(struct ieee80211com *);
 185
 186 void    ieee80211_load_module(const char *);
 187
 188 /* XXX this stuff belongs elsewhere */
 189 /*
 190  * Message formats for messages from the net80211 layer to user
 191  * applications via the routing socket.  These messages are appended
 192  * to an if_announcemsghdr structure.
 193  */
 194 struct ieee80211_join_event {
 195         uint8_t         iev_addr[6];
 196 };
 197
 198 struct ieee80211_leave_event {
 199         uint8_t         iev_addr[6];
 200 };
 201
 202 struct ieee80211_replay_event {
 203         uint8_t         iev_src[6];     /* src MAC */
 204         uint8_t         iev_dst[6];     /* dst MAC */
 205         uint8_t         iev_cipher;     /* cipher type */
 206         uint8_t         iev_keyix;      /* key id/index */
 207         uint64_t        iev_keyrsc;     /* RSC from key */
 208         uint64_t        iev_rsc;        /* RSC from frame */
 209 };
 210
 211 struct ieee80211_michael_event {
 212         uint8_t         iev_src[6];     /* src MAC */
 213         uint8_t         iev_dst[6];     /* dst MAC */
 214         uint8_t         iev_cipher;     /* cipher type */
 215         uint8_t         iev_keyix;      /* key id/index */
 216 };
 217
 218 #define RTM_IEEE80211_ASSOC     100     /* station associate (bss mode) */
 219 #define RTM_IEEE80211_REASSOC   101     /* station re-associate (bss mode) */
 220 #define RTM_IEEE80211_DISASSOC  102     /* station disassociate (bss mode) */
 221 #define RTM_IEEE80211_JOIN      103     /* station join (ap mode) */
 222 #define RTM_IEEE80211_LEAVE     104     /* station leave (ap mode) */
 223 #define RTM_IEEE80211_SCAN      105     /* scan complete, results available */
 224 #define RTM_IEEE80211_REPLAY    106     /* sequence counter replay detected */
 225 #define RTM_IEEE80211_MICHAEL   107     /* Michael MIC failure detected */
 226 #define RTM_IEEE80211_REJOIN    108     /* station re-associate (ap mode) */
 227
 228 #endif /* _NET80211_IEEE80211_FREEBSD_H_ */