2 * Copyright (c) 2003-2008 Sam Leffler, Errno Consulting
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #ifndef _NET80211_IEEE80211_FREEBSD_H_
28 #define _NET80211_IEEE80211_FREEBSD_H_
31 #include <sys/param.h>
33 #include <sys/mutex.h>
34 #include <sys/rwlock.h>
35 #include <sys/sysctl.h>
36 #include <sys/taskqueue.h>
39 * Common state locking definitions.
42 char name[16]; /* e.g. "ath0_com_lock" */
44 } ieee80211_com_lock_t;
45 #define IEEE80211_LOCK_INIT(_ic, _name) do { \
46 ieee80211_com_lock_t *cl = &(_ic)->ic_comlock; \
47 snprintf(cl->name, sizeof(cl->name), "%s_com_lock", _name); \
48 mtx_init(&cl->mtx, cl->name, NULL, MTX_DEF | MTX_RECURSE); \
50 #define IEEE80211_LOCK_OBJ(_ic) (&(_ic)->ic_comlock.mtx)
51 #define IEEE80211_LOCK_DESTROY(_ic) mtx_destroy(IEEE80211_LOCK_OBJ(_ic))
52 #define IEEE80211_LOCK(_ic) mtx_lock(IEEE80211_LOCK_OBJ(_ic))
53 #define IEEE80211_UNLOCK(_ic) mtx_unlock(IEEE80211_LOCK_OBJ(_ic))
54 #define IEEE80211_LOCK_ASSERT(_ic) \
55 mtx_assert(IEEE80211_LOCK_OBJ(_ic), MA_OWNED)
58 * Node locking definitions.
61 char name[16]; /* e.g. "ath0_node_lock" */
63 } ieee80211_node_lock_t;
64 #define IEEE80211_NODE_LOCK_INIT(_nt, _name) do { \
65 ieee80211_node_lock_t *nl = &(_nt)->nt_nodelock; \
66 snprintf(nl->name, sizeof(nl->name), "%s_node_lock", _name); \
67 mtx_init(&nl->mtx, nl->name, NULL, MTX_DEF | MTX_RECURSE); \
69 #define IEEE80211_NODE_LOCK_OBJ(_nt) (&(_nt)->nt_nodelock.mtx)
70 #define IEEE80211_NODE_LOCK_DESTROY(_nt) \
71 mtx_destroy(IEEE80211_NODE_LOCK_OBJ(_nt))
72 #define IEEE80211_NODE_LOCK(_nt) \
73 mtx_lock(IEEE80211_NODE_LOCK_OBJ(_nt))
74 #define IEEE80211_NODE_IS_LOCKED(_nt) \
75 mtx_owned(IEEE80211_NODE_LOCK_OBJ(_nt))
76 #define IEEE80211_NODE_UNLOCK(_nt) \
77 mtx_unlock(IEEE80211_NODE_LOCK_OBJ(_nt))
78 #define IEEE80211_NODE_LOCK_ASSERT(_nt) \
79 mtx_assert(IEEE80211_NODE_LOCK_OBJ(_nt), MA_OWNED)
82 * Node table iteration locking definitions; this protects the
83 * scan generation # used to iterate over the station table
84 * while grabbing+releasing the node lock.
87 char name[16]; /* e.g. "ath0_scan_lock" */
89 } ieee80211_scan_lock_t;
90 #define IEEE80211_NODE_ITERATE_LOCK_INIT(_nt, _name) do { \
91 ieee80211_scan_lock_t *sl = &(_nt)->nt_scanlock; \
92 snprintf(sl->name, sizeof(sl->name), "%s_scan_lock", _name); \
93 mtx_init(&sl->mtx, sl->name, NULL, MTX_DEF); \
95 #define IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt) (&(_nt)->nt_scanlock.mtx)
96 #define IEEE80211_NODE_ITERATE_LOCK_DESTROY(_nt) \
97 mtx_destroy(IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt))
98 #define IEEE80211_NODE_ITERATE_LOCK(_nt) \
99 mtx_lock(IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt))
100 #define IEEE80211_NODE_ITERATE_UNLOCK(_nt) \
101 mtx_unlock(IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt))
103 #define _AGEQ_ENQUEUE(_ifq, _m, _qlen, _age) do { \
104 (_m)->m_nextpkt = NULL; \
105 if ((_ifq)->ifq_tail != NULL) { \
106 _age -= M_AGE_GET((_ifq)->ifq_head); \
107 (_ifq)->ifq_tail->m_nextpkt = (_m); \
109 (_ifq)->ifq_head = (_m); \
111 M_AGE_SET(_m, _age); \
112 (_ifq)->ifq_tail = (_m); \
113 (_qlen) = ++(_ifq)->ifq_len; \
117 * Power-save queue definitions.
119 typedef struct mtx ieee80211_psq_lock_t;
120 #define IEEE80211_PSQ_INIT(_psq, _name) \
121 mtx_init(&(_psq)->psq_lock, _name, "802.11 ps q", MTX_DEF);
122 #define IEEE80211_PSQ_DESTROY(_psq) mtx_destroy(&(_psq)->psq_lock)
123 #define IEEE80211_PSQ_LOCK(_psq) mtx_lock(&(_psq)->psq_lock)
124 #define IEEE80211_PSQ_UNLOCK(_psq) mtx_unlock(&(_psq)->psq_lock)
126 #ifndef IF_PREPEND_LIST
127 #define _IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do { \
128 (mtail)->m_nextpkt = (ifq)->ifq_head; \
129 if ((ifq)->ifq_tail == NULL) \
130 (ifq)->ifq_tail = (mtail); \
131 (ifq)->ifq_head = (mhead); \
132 (ifq)->ifq_len += (mcount); \
134 #define IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do { \
136 _IF_PREPEND_LIST(ifq, mhead, mtail, mcount); \
139 #endif /* IF_PREPEND_LIST */
142 #define IEEE80211_NODE_WDSQ_INIT(_ni, _name) do { \
143 mtx_init(&(_ni)->ni_wdsq.ifq_mtx, _name, "802.11 wds queue", MTX_DEF);\
144 (_ni)->ni_wdsq.ifq_maxlen = IEEE80211_PS_MAX_QUEUE; \
146 #define IEEE80211_NODE_WDSQ_DESTROY(_ni) do { \
147 mtx_destroy(&(_ni)->ni_wdsq.ifq_mtx); \
149 #define IEEE80211_NODE_WDSQ_QLEN(_ni) _IF_QLEN(&(_ni)->ni_wdsq)
150 #define IEEE80211_NODE_WDSQ_LOCK(_ni) IF_LOCK(&(_ni)->ni_wdsq)
151 #define IEEE80211_NODE_WDSQ_UNLOCK(_ni) IF_UNLOCK(&(_ni)->ni_wdsq)
152 #define _IEEE80211_NODE_WDSQ_DEQUEUE_HEAD(_ni, _m) do { \
153 _IF_DEQUEUE(&(_ni)->ni_wdsq, m); \
155 #define _IEEE80211_NODE_WDSQ_ENQUEUE(_ni, _m, _qlen, _age) do { \
156 _AGEQ_ENQUEUE(&ni->ni_wdsq, _m, _qlen, _age); \
160 * 802.1x MAC ACL database locking definitions.
162 typedef struct mtx acl_lock_t;
163 #define ACL_LOCK_INIT(_as, _name) \
164 mtx_init(&(_as)->as_lock, _name, "802.11 ACL", MTX_DEF)
165 #define ACL_LOCK_DESTROY(_as) mtx_destroy(&(_as)->as_lock)
166 #define ACL_LOCK(_as) mtx_lock(&(_as)->as_lock)
167 #define ACL_UNLOCK(_as) mtx_unlock(&(_as)->as_lock)
168 #define ACL_LOCK_ASSERT(_as) \
169 mtx_assert((&(_as)->as_lock), MA_OWNED)
172 * Node reference counting definitions.
174 * ieee80211_node_initref initialize the reference count to 1
175 * ieee80211_node_incref add a reference
176 * ieee80211_node_decref remove a reference
177 * ieee80211_node_dectestref remove a reference and return 1 if this
178 * is the last reference, otherwise 0
179 * ieee80211_node_refcnt reference count for printing (only)
181 #include <machine/atomic.h>
183 #define ieee80211_node_initref(_ni) \
184 do { ((_ni)->ni_refcnt = 1); } while (0)
185 #define ieee80211_node_incref(_ni) \
186 atomic_add_int(&(_ni)->ni_refcnt, 1)
187 #define ieee80211_node_decref(_ni) \
188 atomic_subtract_int(&(_ni)->ni_refcnt, 1)
189 struct ieee80211_node;
190 int ieee80211_node_dectestref(struct ieee80211_node *ni);
191 #define ieee80211_node_refcnt(_ni) (_ni)->ni_refcnt
195 void ieee80211_drain_ifq(struct ifqueue *);
196 void ieee80211_flush_ifq(struct ifqueue *, struct ieee80211vap *);
198 void ieee80211_vap_destroy(struct ieee80211vap *);
200 #define IFNET_IS_UP_RUNNING(_ifp) \
201 (((_ifp)->if_flags & IFF_UP) && \
202 ((_ifp)->if_drv_flags & IFF_DRV_RUNNING))
204 #define msecs_to_ticks(ms) (((ms)*hz)/1000)
205 #define ticks_to_msecs(t) (1000*(t) / hz)
206 #define ticks_to_secs(t) ((t) / hz)
207 #define time_after(a,b) ((long)(b) - (long)(a) < 0)
208 #define time_before(a,b) time_after(b,a)
209 #define time_after_eq(a,b) ((long)(a) - (long)(b) >= 0)
210 #define time_before_eq(a,b) time_after_eq(b,a)
212 struct mbuf *ieee80211_getmgtframe(uint8_t **frm, int headroom, int pktlen);
215 #define M_ENCAP M_PROTO1 /* 802.11 encap done */
216 #define M_EAPOL M_PROTO3 /* PAE/EAPOL frame */
217 #define M_PWR_SAV M_PROTO4 /* bypass PS handling */
218 #define M_MORE_DATA M_PROTO5 /* more data frames to follow */
219 #define M_FF M_PROTO6 /* fast frame */
220 #define M_TXCB M_PROTO7 /* do tx complete callback */
221 #define M_AMPDU_MPDU M_PROTO8 /* ok for A-MPDU aggregation */
223 (M_FRAG|M_FIRSTFRAG|M_LASTFRAG|M_ENCAP|M_EAPOL|M_PWR_SAV|\
224 M_MORE_DATA|M_FF|M_TXCB|M_AMPDU_MPDU)
227 #define M_AMPDU M_PROTO1 /* A-MPDU subframe */
228 #define M_WEP M_PROTO2 /* WEP done by hardware */
230 #define M_AMPDU_MPDU M_PROTO8 /* A-MPDU re-order done */
232 #define M_80211_RX (M_AMPDU|M_WEP|M_AMPDU_MPDU)
234 * Store WME access control bits in the vlan tag.
235 * This is safe since it's done after the packet is classified
236 * (where we use any previous tag) and because it's passed
237 * directly in to the driver and there's no chance someone
238 * else will clobber them on us.
240 #define M_WME_SETAC(m, ac) \
241 ((m)->m_pkthdr.ether_vtag = (ac))
242 #define M_WME_GETAC(m) ((m)->m_pkthdr.ether_vtag)
245 * Mbufs on the power save queue are tagged with an age and
246 * timed out. We reuse the hardware checksum field in the
247 * mbuf packet header to store this data.
249 #define M_AGE_SET(m,v) (m->m_pkthdr.csum_data = v)
250 #define M_AGE_GET(m) (m->m_pkthdr.csum_data)
251 #define M_AGE_SUB(m,adj) (m->m_pkthdr.csum_data -= adj)
254 * Store the sequence number.
256 #define M_SEQNO_SET(m, seqno) \
257 ((m)->m_pkthdr.tso_segsz = (seqno))
258 #define M_SEQNO_GET(m) ((m)->m_pkthdr.tso_segsz)
260 #define MTAG_ABI_NET80211 1132948340 /* net80211 ABI */
262 struct ieee80211_cb {
263 void (*func)(struct ieee80211_node *, void *, int status);
266 #define NET80211_TAG_CALLBACK 0 /* xmit complete callback */
267 int ieee80211_add_callback(struct mbuf *m,
268 void (*func)(struct ieee80211_node *, void *, int), void *arg);
269 void ieee80211_process_callback(struct ieee80211_node *, struct mbuf *, int);
271 void get_random_bytes(void *, size_t);
275 void ieee80211_sysctl_attach(struct ieee80211com *);
276 void ieee80211_sysctl_detach(struct ieee80211com *);
277 void ieee80211_sysctl_vattach(struct ieee80211vap *);
278 void ieee80211_sysctl_vdetach(struct ieee80211vap *);
280 SYSCTL_DECL(_net_wlan);
281 int ieee80211_sysctl_msecs_ticks(SYSCTL_HANDLER_ARGS);
283 void ieee80211_load_module(const char *);
286 * A "policy module" is an adjunct module to net80211 that provides
287 * functionality that typically includes policy decisions. This
288 * modularity enables extensibility and vendor-supplied functionality.
290 #define _IEEE80211_POLICY_MODULE(policy, name, version) \
291 typedef void (*policy##_setup)(int); \
292 SET_DECLARE(policy##_set, policy##_setup); \
294 wlan_##name##_modevent(module_t mod, int type, void *unused) \
296 policy##_setup * const *iter, f; \
299 SET_FOREACH(iter, policy##_set) { \
307 printf("wlan_##name: still in use (%u dynamic refs)\n",\
311 if (type == MOD_UNLOAD) { \
312 SET_FOREACH(iter, policy##_set) { \
321 static moduledata_t name##_mod = { \
323 wlan_##name##_modevent, \
326 DECLARE_MODULE(wlan_##name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);\
327 MODULE_VERSION(wlan_##name, version); \
328 MODULE_DEPEND(wlan_##name, wlan, 1, 1, 1)
331 * Crypto modules implement cipher support.
333 #define IEEE80211_CRYPTO_MODULE(name, version) \
334 _IEEE80211_POLICY_MODULE(crypto, name, version); \
336 name##_modevent(int type) \
338 if (type == MOD_LOAD) \
339 ieee80211_crypto_register(&name); \
341 ieee80211_crypto_unregister(&name); \
343 TEXT_SET(crypto##_set, name##_modevent)
346 * Scanner modules provide scanning policy.
348 #define IEEE80211_SCANNER_MODULE(name, version) \
349 _IEEE80211_POLICY_MODULE(scanner, name, version)
351 #define IEEE80211_SCANNER_ALG(name, alg, v) \
353 name##_modevent(int type) \
355 if (type == MOD_LOAD) \
356 ieee80211_scanner_register(alg, &v); \
358 ieee80211_scanner_unregister(alg, &v); \
360 TEXT_SET(scanner_set, name##_modevent); \
363 * ACL modules implement acl policy.
365 #define IEEE80211_ACL_MODULE(name, alg, version) \
366 _IEEE80211_POLICY_MODULE(acl, name, version); \
368 alg##_modevent(int type) \
370 if (type == MOD_LOAD) \
371 ieee80211_aclator_register(&alg); \
373 ieee80211_aclator_unregister(&alg); \
375 TEXT_SET(acl_set, alg##_modevent); \
378 * Authenticator modules handle 802.1x/WPA authentication.
380 #define IEEE80211_AUTH_MODULE(name, version) \
381 _IEEE80211_POLICY_MODULE(auth, name, version)
383 #define IEEE80211_AUTH_ALG(name, alg, v) \
385 name##_modevent(int type) \
387 if (type == MOD_LOAD) \
388 ieee80211_authenticator_register(alg, &v); \
390 ieee80211_authenticator_unregister(alg); \
392 TEXT_SET(auth_set, name##_modevent)
395 * Rate control modules provide tx rate control support.
397 #define IEEE80211_RATE_MODULE(alg, version) \
398 _IEEE80211_POLICY_MODULE(rate, alg, version); \
400 alg##_modevent(int type) \
402 /* XXX nothing to do until the rate control framework arrives */\
404 TEXT_SET(rate##_set, alg##_modevent)
407 typedef int ieee80211_ioctl_getfunc(struct ieee80211vap *,
408 struct ieee80211req *);
409 SET_DECLARE(ieee80211_ioctl_getset, ieee80211_ioctl_getfunc);
410 #define IEEE80211_IOCTL_GET(_name, _get) TEXT_SET(ieee80211_ioctl_getset, _get)
412 typedef int ieee80211_ioctl_setfunc(struct ieee80211vap *,
413 struct ieee80211req *);
414 SET_DECLARE(ieee80211_ioctl_setset, ieee80211_ioctl_setfunc);
415 #define IEEE80211_IOCTL_SET(_name, _set) TEXT_SET(ieee80211_ioctl_setset, _set)
418 /* XXX this stuff belongs elsewhere */
420 * Message formats for messages from the net80211 layer to user
421 * applications via the routing socket. These messages are appended
422 * to an if_announcemsghdr structure.
424 struct ieee80211_join_event {
428 struct ieee80211_leave_event {
432 struct ieee80211_replay_event {
433 uint8_t iev_src[6]; /* src MAC */
434 uint8_t iev_dst[6]; /* dst MAC */
435 uint8_t iev_cipher; /* cipher type */
436 uint8_t iev_keyix; /* key id/index */
437 uint64_t iev_keyrsc; /* RSC from key */
438 uint64_t iev_rsc; /* RSC from frame */
441 struct ieee80211_michael_event {
442 uint8_t iev_src[6]; /* src MAC */
443 uint8_t iev_dst[6]; /* dst MAC */
444 uint8_t iev_cipher; /* cipher type */
445 uint8_t iev_keyix; /* key id/index */
448 struct ieee80211_wds_event {
452 struct ieee80211_csa_event {
453 uint32_t iev_flags; /* channel flags */
454 uint16_t iev_freq; /* setting in Mhz */
455 uint8_t iev_ieee; /* IEEE channel number */
456 uint8_t iev_mode; /* CSA mode */
457 uint8_t iev_count; /* CSA count */
460 struct ieee80211_cac_event {
461 uint32_t iev_flags; /* channel flags */
462 uint16_t iev_freq; /* setting in Mhz */
463 uint8_t iev_ieee; /* IEEE channel number */
465 uint8_t iev_type; /* IEEE80211_NOTIFY_CAC_* */
468 struct ieee80211_radar_event {
469 uint32_t iev_flags; /* channel flags */
470 uint16_t iev_freq; /* setting in Mhz */
471 uint8_t iev_ieee; /* IEEE channel number */
475 struct ieee80211_auth_event {
479 struct ieee80211_deauth_event {
483 struct ieee80211_country_event {
485 uint8_t iev_cc[2]; /* ISO country code */
488 struct ieee80211_radio_event {
489 uint8_t iev_state; /* 1 on, 0 off */
492 #define RTM_IEEE80211_ASSOC 100 /* station associate (bss mode) */
493 #define RTM_IEEE80211_REASSOC 101 /* station re-associate (bss mode) */
494 #define RTM_IEEE80211_DISASSOC 102 /* station disassociate (bss mode) */
495 #define RTM_IEEE80211_JOIN 103 /* station join (ap mode) */
496 #define RTM_IEEE80211_LEAVE 104 /* station leave (ap mode) */
497 #define RTM_IEEE80211_SCAN 105 /* scan complete, results available */
498 #define RTM_IEEE80211_REPLAY 106 /* sequence counter replay detected */
499 #define RTM_IEEE80211_MICHAEL 107 /* Michael MIC failure detected */
500 #define RTM_IEEE80211_REJOIN 108 /* station re-associate (ap mode) */
501 #define RTM_IEEE80211_WDS 109 /* WDS discovery (ap mode) */
502 #define RTM_IEEE80211_CSA 110 /* Channel Switch Announcement event */
503 #define RTM_IEEE80211_RADAR 111 /* radar event */
504 #define RTM_IEEE80211_CAC 112 /* Channel Availability Check event */
505 #define RTM_IEEE80211_DEAUTH 113 /* station deauthenticate */
506 #define RTM_IEEE80211_AUTH 114 /* station authenticate (ap mode) */
507 #define RTM_IEEE80211_COUNTRY 115 /* discovered country code (sta mode) */
508 #define RTM_IEEE80211_RADIO 116 /* RF kill switch state change */
511 * Structure prepended to raw packets sent through the bpf
512 * interface when set to DLT_IEEE802_11_RADIO. This allows
513 * user applications to specify pretty much everything in
514 * an Atheros tx descriptor. XXX need to generalize.
516 * XXX cannot be more than 14 bytes as it is copied to a sockaddr's
519 struct ieee80211_bpf_params {
520 uint8_t ibp_vers; /* version */
521 #define IEEE80211_BPF_VERSION 0
522 uint8_t ibp_len; /* header length in bytes */
524 #define IEEE80211_BPF_SHORTPRE 0x01 /* tx with short preamble */
525 #define IEEE80211_BPF_NOACK 0x02 /* tx with no ack */
526 #define IEEE80211_BPF_CRYPTO 0x04 /* tx with h/w encryption */
527 #define IEEE80211_BPF_FCS 0x10 /* frame incldues FCS */
528 #define IEEE80211_BPF_DATAPAD 0x20 /* frame includes data padding */
529 #define IEEE80211_BPF_RTS 0x40 /* tx with RTS/CTS */
530 #define IEEE80211_BPF_CTS 0x80 /* tx with CTS only */
531 uint8_t ibp_pri; /* WME/WMM AC+tx antenna */
532 uint8_t ibp_try0; /* series 1 try count */
533 uint8_t ibp_rate0; /* series 1 IEEE tx rate */
534 uint8_t ibp_power; /* tx power (device units) */
535 uint8_t ibp_ctsrate; /* IEEE tx rate for CTS */
536 uint8_t ibp_try1; /* series 2 try count */
537 uint8_t ibp_rate1; /* series 2 IEEE tx rate */
538 uint8_t ibp_try2; /* series 3 try count */
539 uint8_t ibp_rate2; /* series 3 IEEE tx rate */
540 uint8_t ibp_try3; /* series 4 try count */
541 uint8_t ibp_rate3; /* series 4 IEEE tx rate */
543 #endif /* _NET80211_IEEE80211_FREEBSD_H_ */