ieee80211_freebsd.h revision 288245
1/*-
2 * Copyright (c) 2003-2008 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 *
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.
24 *
25 * $FreeBSD: head/sys/net80211/ieee80211_freebsd.h 288245 2015-09-26 00:53:37Z adrian $
26 */
27#ifndef _NET80211_IEEE80211_FREEBSD_H_
28#define _NET80211_IEEE80211_FREEBSD_H_
29
30#ifdef _KERNEL
31#include <sys/types.h>
32#include <sys/systm.h>
33#include <sys/counter.h>
34#include <sys/lock.h>
35#include <sys/mutex.h>
36#include <sys/rwlock.h>
37#include <sys/sysctl.h>
38#include <sys/taskqueue.h>
39
40/*
41 * Common state locking definitions.
42 */
43typedef struct {
44	char		name[16];		/* e.g. "ath0_com_lock" */
45	struct mtx	mtx;
46} ieee80211_com_lock_t;
47#define	IEEE80211_LOCK_INIT(_ic, _name) do {				\
48	ieee80211_com_lock_t *cl = &(_ic)->ic_comlock;			\
49	snprintf(cl->name, sizeof(cl->name), "%s_com_lock", _name);	\
50	mtx_init(&cl->mtx, cl->name, NULL, MTX_DEF | MTX_RECURSE);	\
51} while (0)
52#define	IEEE80211_LOCK_OBJ(_ic)	(&(_ic)->ic_comlock.mtx)
53#define	IEEE80211_LOCK_DESTROY(_ic) mtx_destroy(IEEE80211_LOCK_OBJ(_ic))
54#define	IEEE80211_LOCK(_ic)	   mtx_lock(IEEE80211_LOCK_OBJ(_ic))
55#define	IEEE80211_UNLOCK(_ic)	   mtx_unlock(IEEE80211_LOCK_OBJ(_ic))
56#define	IEEE80211_LOCK_ASSERT(_ic) \
57	mtx_assert(IEEE80211_LOCK_OBJ(_ic), MA_OWNED)
58#define	IEEE80211_UNLOCK_ASSERT(_ic) \
59	mtx_assert(IEEE80211_LOCK_OBJ(_ic), MA_NOTOWNED)
60
61/*
62 * Transmit lock.
63 *
64 * This is a (mostly) temporary lock designed to serialise all of the
65 * transmission operations throughout the stack.
66 */
67typedef struct {
68	char		name[16];		/* e.g. "ath0_com_lock" */
69	struct mtx	mtx;
70} ieee80211_tx_lock_t;
71#define	IEEE80211_TX_LOCK_INIT(_ic, _name) do {				\
72	ieee80211_tx_lock_t *cl = &(_ic)->ic_txlock;			\
73	snprintf(cl->name, sizeof(cl->name), "%s_tx_lock", _name);	\
74	mtx_init(&cl->mtx, cl->name, NULL, MTX_DEF);	\
75} while (0)
76#define	IEEE80211_TX_LOCK_OBJ(_ic)	(&(_ic)->ic_txlock.mtx)
77#define	IEEE80211_TX_LOCK_DESTROY(_ic) mtx_destroy(IEEE80211_TX_LOCK_OBJ(_ic))
78#define	IEEE80211_TX_LOCK(_ic)	   mtx_lock(IEEE80211_TX_LOCK_OBJ(_ic))
79#define	IEEE80211_TX_UNLOCK(_ic)	   mtx_unlock(IEEE80211_TX_LOCK_OBJ(_ic))
80#define	IEEE80211_TX_LOCK_ASSERT(_ic) \
81	mtx_assert(IEEE80211_TX_LOCK_OBJ(_ic), MA_OWNED)
82#define	IEEE80211_TX_UNLOCK_ASSERT(_ic) \
83	mtx_assert(IEEE80211_TX_LOCK_OBJ(_ic), MA_NOTOWNED)
84
85/*
86 * Node locking definitions.
87 */
88typedef struct {
89	char		name[16];		/* e.g. "ath0_node_lock" */
90	struct mtx	mtx;
91} ieee80211_node_lock_t;
92#define	IEEE80211_NODE_LOCK_INIT(_nt, _name) do {			\
93	ieee80211_node_lock_t *nl = &(_nt)->nt_nodelock;		\
94	snprintf(nl->name, sizeof(nl->name), "%s_node_lock", _name);	\
95	mtx_init(&nl->mtx, nl->name, NULL, MTX_DEF | MTX_RECURSE);	\
96} while (0)
97#define	IEEE80211_NODE_LOCK_OBJ(_nt)	(&(_nt)->nt_nodelock.mtx)
98#define	IEEE80211_NODE_LOCK_DESTROY(_nt) \
99	mtx_destroy(IEEE80211_NODE_LOCK_OBJ(_nt))
100#define	IEEE80211_NODE_LOCK(_nt) \
101	mtx_lock(IEEE80211_NODE_LOCK_OBJ(_nt))
102#define	IEEE80211_NODE_IS_LOCKED(_nt) \
103	mtx_owned(IEEE80211_NODE_LOCK_OBJ(_nt))
104#define	IEEE80211_NODE_UNLOCK(_nt) \
105	mtx_unlock(IEEE80211_NODE_LOCK_OBJ(_nt))
106#define	IEEE80211_NODE_LOCK_ASSERT(_nt)	\
107	mtx_assert(IEEE80211_NODE_LOCK_OBJ(_nt), MA_OWNED)
108
109/*
110 * Node table iteration locking definitions; this protects the
111 * scan generation # used to iterate over the station table
112 * while grabbing+releasing the node lock.
113 */
114typedef struct {
115	char		name[16];		/* e.g. "ath0_scan_lock" */
116	struct mtx	mtx;
117} ieee80211_scan_lock_t;
118#define	IEEE80211_NODE_ITERATE_LOCK_INIT(_nt, _name) do {		\
119	ieee80211_scan_lock_t *sl = &(_nt)->nt_scanlock;		\
120	snprintf(sl->name, sizeof(sl->name), "%s_scan_lock", _name);	\
121	mtx_init(&sl->mtx, sl->name, NULL, MTX_DEF);			\
122} while (0)
123#define	IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt)	(&(_nt)->nt_scanlock.mtx)
124#define	IEEE80211_NODE_ITERATE_LOCK_DESTROY(_nt) \
125	mtx_destroy(IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt))
126#define	IEEE80211_NODE_ITERATE_LOCK(_nt) \
127	mtx_lock(IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt))
128#define	IEEE80211_NODE_ITERATE_UNLOCK(_nt) \
129	mtx_unlock(IEEE80211_NODE_ITERATE_LOCK_OBJ(_nt))
130
131/*
132 * Power-save queue definitions.
133 */
134typedef struct mtx ieee80211_psq_lock_t;
135#define	IEEE80211_PSQ_INIT(_psq, _name) \
136	mtx_init(&(_psq)->psq_lock, _name, "802.11 ps q", MTX_DEF)
137#define	IEEE80211_PSQ_DESTROY(_psq)	mtx_destroy(&(_psq)->psq_lock)
138#define	IEEE80211_PSQ_LOCK(_psq)	mtx_lock(&(_psq)->psq_lock)
139#define	IEEE80211_PSQ_UNLOCK(_psq)	mtx_unlock(&(_psq)->psq_lock)
140
141#ifndef IF_PREPEND_LIST
142#define _IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do {	\
143	(mtail)->m_nextpkt = (ifq)->ifq_head;			\
144	if ((ifq)->ifq_tail == NULL)				\
145		(ifq)->ifq_tail = (mtail);			\
146	(ifq)->ifq_head = (mhead);				\
147	(ifq)->ifq_len += (mcount);				\
148} while (0)
149#define IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do {		\
150	IF_LOCK(ifq);						\
151	_IF_PREPEND_LIST(ifq, mhead, mtail, mcount);		\
152	IF_UNLOCK(ifq);						\
153} while (0)
154#endif /* IF_PREPEND_LIST */
155
156/*
157 * Age queue definitions.
158 */
159typedef struct mtx ieee80211_ageq_lock_t;
160#define	IEEE80211_AGEQ_INIT(_aq, _name) \
161	mtx_init(&(_aq)->aq_lock, _name, "802.11 age q", MTX_DEF)
162#define	IEEE80211_AGEQ_DESTROY(_aq)	mtx_destroy(&(_aq)->aq_lock)
163#define	IEEE80211_AGEQ_LOCK(_aq)	mtx_lock(&(_aq)->aq_lock)
164#define	IEEE80211_AGEQ_UNLOCK(_aq)	mtx_unlock(&(_aq)->aq_lock)
165
166/*
167 * 802.1x MAC ACL database locking definitions.
168 */
169typedef struct mtx acl_lock_t;
170#define	ACL_LOCK_INIT(_as, _name) \
171	mtx_init(&(_as)->as_lock, _name, "802.11 ACL", MTX_DEF)
172#define	ACL_LOCK_DESTROY(_as)		mtx_destroy(&(_as)->as_lock)
173#define	ACL_LOCK(_as)			mtx_lock(&(_as)->as_lock)
174#define	ACL_UNLOCK(_as)			mtx_unlock(&(_as)->as_lock)
175#define	ACL_LOCK_ASSERT(_as) \
176	mtx_assert((&(_as)->as_lock), MA_OWNED)
177
178/*
179 * Scan table definitions.
180 */
181typedef struct mtx ieee80211_scan_table_lock_t;
182#define	IEEE80211_SCAN_TABLE_LOCK_INIT(_st, _name) \
183	mtx_init(&(_st)->st_lock, _name, "802.11 scan table", MTX_DEF)
184#define	IEEE80211_SCAN_TABLE_LOCK_DESTROY(_st)	mtx_destroy(&(_st)->st_lock)
185#define	IEEE80211_SCAN_TABLE_LOCK(_st)		mtx_lock(&(_st)->st_lock)
186#define	IEEE80211_SCAN_TABLE_UNLOCK(_st)	mtx_unlock(&(_st)->st_lock)
187
188typedef struct mtx ieee80211_scan_iter_lock_t;
189#define	IEEE80211_SCAN_ITER_LOCK_INIT(_st, _name) \
190	mtx_init(&(_st)->st_scanlock, _name, "802.11 scangen", MTX_DEF)
191#define	IEEE80211_SCAN_ITER_LOCK_DESTROY(_st)	mtx_destroy(&(_st)->st_scanlock)
192#define	IEEE80211_SCAN_ITER_LOCK(_st)		mtx_lock(&(_st)->st_scanlock)
193#define	IEEE80211_SCAN_ITER_UNLOCK(_st)	mtx_unlock(&(_st)->st_scanlock)
194
195/*
196 * Mesh node/routing definitions.
197 */
198typedef struct mtx ieee80211_rte_lock_t;
199#define	MESH_RT_ENTRY_LOCK_INIT(_rt, _name) \
200	mtx_init(&(rt)->rt_lock, _name, "802.11s route entry", MTX_DEF)
201#define	MESH_RT_ENTRY_LOCK_DESTROY(_rt) \
202	mtx_destroy(&(_rt)->rt_lock)
203#define	MESH_RT_ENTRY_LOCK(rt)	mtx_lock(&(rt)->rt_lock)
204#define	MESH_RT_ENTRY_LOCK_ASSERT(rt) mtx_assert(&(rt)->rt_lock, MA_OWNED)
205#define	MESH_RT_ENTRY_UNLOCK(rt)	mtx_unlock(&(rt)->rt_lock)
206
207typedef struct mtx ieee80211_rt_lock_t;
208#define	MESH_RT_LOCK(ms)	mtx_lock(&(ms)->ms_rt_lock)
209#define	MESH_RT_LOCK_ASSERT(ms)	mtx_assert(&(ms)->ms_rt_lock, MA_OWNED)
210#define	MESH_RT_UNLOCK(ms)	mtx_unlock(&(ms)->ms_rt_lock)
211#define	MESH_RT_LOCK_INIT(ms, name) \
212	mtx_init(&(ms)->ms_rt_lock, name, "802.11s routing table", MTX_DEF)
213#define	MESH_RT_LOCK_DESTROY(ms) \
214	mtx_destroy(&(ms)->ms_rt_lock)
215
216/*
217 * Node reference counting definitions.
218 *
219 * ieee80211_node_initref	initialize the reference count to 1
220 * ieee80211_node_incref	add a reference
221 * ieee80211_node_decref	remove a reference
222 * ieee80211_node_dectestref	remove a reference and return 1 if this
223 *				is the last reference, otherwise 0
224 * ieee80211_node_refcnt	reference count for printing (only)
225 */
226#include <machine/atomic.h>
227
228#define ieee80211_node_initref(_ni) \
229	do { ((_ni)->ni_refcnt = 1); } while (0)
230#define ieee80211_node_incref(_ni) \
231	atomic_add_int(&(_ni)->ni_refcnt, 1)
232#define	ieee80211_node_decref(_ni) \
233	atomic_subtract_int(&(_ni)->ni_refcnt, 1)
234struct ieee80211_node;
235int	ieee80211_node_dectestref(struct ieee80211_node *ni);
236#define	ieee80211_node_refcnt(_ni)	(_ni)->ni_refcnt
237
238struct ifqueue;
239struct ieee80211vap;
240void	ieee80211_drain_ifq(struct ifqueue *);
241void	ieee80211_flush_ifq(struct ifqueue *, struct ieee80211vap *);
242
243void	ieee80211_vap_destroy(struct ieee80211vap *);
244
245#define	IFNET_IS_UP_RUNNING(_ifp) \
246	(((_ifp)->if_flags & IFF_UP) && \
247	 ((_ifp)->if_drv_flags & IFF_DRV_RUNNING))
248
249#define	msecs_to_ticks(ms)	(((ms)*hz)/1000)
250#define	ticks_to_msecs(t)	(1000*(t) / hz)
251#define	ticks_to_secs(t)	((t) / hz)
252#define time_after(a,b) 	((long)(b) - (long)(a) < 0)
253#define time_before(a,b)	time_after(b,a)
254#define time_after_eq(a,b)	((long)(a) - (long)(b) >= 0)
255#define time_before_eq(a,b)	time_after_eq(b,a)
256
257struct mbuf *ieee80211_getmgtframe(uint8_t **frm, int headroom, int pktlen);
258
259/* tx path usage */
260#define	M_ENCAP		M_PROTO1		/* 802.11 encap done */
261#define	M_EAPOL		M_PROTO3		/* PAE/EAPOL frame */
262#define	M_PWR_SAV	M_PROTO4		/* bypass PS handling */
263#define	M_MORE_DATA	M_PROTO5		/* more data frames to follow */
264#define	M_FF		M_PROTO6		/* fast frame */
265#define	M_TXCB		M_PROTO7		/* do tx complete callback */
266#define	M_AMPDU_MPDU	M_PROTO8		/* ok for A-MPDU aggregation */
267#define	M_FRAG		M_PROTO9		/* frame fragmentation */
268#define	M_FIRSTFRAG	M_PROTO10		/* first frame fragment */
269#define	M_LASTFRAG	M_PROTO11		/* last frame fragment */
270
271#define	M_80211_TX \
272	(M_ENCAP|M_EAPOL|M_PWR_SAV|M_MORE_DATA|M_FF|M_TXCB| \
273	 M_AMPDU_MPDU|M_FRAG|M_FIRSTFRAG|M_LASTFRAG)
274
275/* rx path usage */
276#define	M_AMPDU		M_PROTO1		/* A-MPDU subframe */
277#define	M_WEP		M_PROTO2		/* WEP done by hardware */
278#if 0
279#define	M_AMPDU_MPDU	M_PROTO8		/* A-MPDU re-order done */
280#endif
281#define	M_80211_RX	(M_AMPDU|M_WEP|M_AMPDU_MPDU)
282
283#define	IEEE80211_MBUF_TX_FLAG_BITS \
284	M_FLAG_BITS \
285	"\15M_ENCAP\17M_EAPOL\20M_PWR_SAV\21M_MORE_DATA\22M_FF\23M_TXCB" \
286	"\24M_AMPDU_MPDU\25M_FRAG\26M_FIRSTFRAG\27M_LASTFRAG"
287
288#define	IEEE80211_MBUF_RX_FLAG_BITS \
289	M_FLAG_BITS \
290	"\15M_AMPDU\16M_WEP\24M_AMPDU_MPDU"
291
292/*
293 * Store WME access control bits in the vlan tag.
294 * This is safe since it's done after the packet is classified
295 * (where we use any previous tag) and because it's passed
296 * directly in to the driver and there's no chance someone
297 * else will clobber them on us.
298 */
299#define	M_WME_SETAC(m, ac) \
300	((m)->m_pkthdr.ether_vtag = (ac))
301#define	M_WME_GETAC(m)	((m)->m_pkthdr.ether_vtag)
302
303/*
304 * Mbufs on the power save queue are tagged with an age and
305 * timed out.  We reuse the hardware checksum field in the
306 * mbuf packet header to store this data.
307 */
308#define	M_AGE_SET(m,v)		(m->m_pkthdr.csum_data = v)
309#define	M_AGE_GET(m)		(m->m_pkthdr.csum_data)
310#define	M_AGE_SUB(m,adj)	(m->m_pkthdr.csum_data -= adj)
311
312/*
313 * Store the sequence number.
314 */
315#define	M_SEQNO_SET(m, seqno) \
316	((m)->m_pkthdr.tso_segsz = (seqno))
317#define	M_SEQNO_GET(m)	((m)->m_pkthdr.tso_segsz)
318
319#define	MTAG_ABI_NET80211	1132948340	/* net80211 ABI */
320
321struct ieee80211_cb {
322	void	(*func)(struct ieee80211_node *, void *, int status);
323	void	*arg;
324};
325#define	NET80211_TAG_CALLBACK	0	/* xmit complete callback */
326int	ieee80211_add_callback(struct mbuf *m,
327		void (*func)(struct ieee80211_node *, void *, int), void *arg);
328void	ieee80211_process_callback(struct ieee80211_node *, struct mbuf *, int);
329
330#define	NET80211_TAG_XMIT_PARAMS	1
331/* See below; this is after the bpf_params definition */
332
333#define	NET80211_TAG_RECV_PARAMS	2
334
335struct ieee80211com;
336int	ieee80211_parent_xmitpkt(struct ieee80211com *, struct mbuf *);
337int	ieee80211_vap_xmitpkt(struct ieee80211vap *, struct mbuf *);
338
339void	get_random_bytes(void *, size_t);
340
341void	ieee80211_sysctl_attach(struct ieee80211com *);
342void	ieee80211_sysctl_detach(struct ieee80211com *);
343void	ieee80211_sysctl_vattach(struct ieee80211vap *);
344void	ieee80211_sysctl_vdetach(struct ieee80211vap *);
345
346SYSCTL_DECL(_net_wlan);
347int	ieee80211_sysctl_msecs_ticks(SYSCTL_HANDLER_ARGS);
348
349void	ieee80211_load_module(const char *);
350
351/*
352 * A "policy module" is an adjunct module to net80211 that provides
353 * functionality that typically includes policy decisions.  This
354 * modularity enables extensibility and vendor-supplied functionality.
355 */
356#define	_IEEE80211_POLICY_MODULE(policy, name, version)			\
357typedef void (*policy##_setup)(int);					\
358SET_DECLARE(policy##_set, policy##_setup);				\
359static int								\
360wlan_##name##_modevent(module_t mod, int type, void *unused)		\
361{									\
362	policy##_setup * const *iter, f;				\
363	switch (type) {							\
364	case MOD_LOAD:							\
365		SET_FOREACH(iter, policy##_set) {			\
366			f = (void*) *iter;				\
367			f(type);					\
368		}							\
369		return 0;						\
370	case MOD_UNLOAD:						\
371	case MOD_QUIESCE:						\
372		if (nrefs) {						\
373			printf("wlan_" #name ": still in use "		\
374				"(%u dynamic refs)\n", nrefs);		\
375			return EBUSY;					\
376		}							\
377		if (type == MOD_UNLOAD) {				\
378			SET_FOREACH(iter, policy##_set) {		\
379				f = (void*) *iter;			\
380				f(type);				\
381			}						\
382		}							\
383		return 0;						\
384	}								\
385	return EINVAL;							\
386}									\
387static moduledata_t name##_mod = {					\
388	"wlan_" #name,							\
389	wlan_##name##_modevent,						\
390	0								\
391};									\
392DECLARE_MODULE(wlan_##name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);\
393MODULE_VERSION(wlan_##name, version);					\
394MODULE_DEPEND(wlan_##name, wlan, 1, 1, 1)
395
396/*
397 * Crypto modules implement cipher support.
398 */
399#define	IEEE80211_CRYPTO_MODULE(name, version)				\
400_IEEE80211_POLICY_MODULE(crypto, name, version);			\
401static void								\
402name##_modevent(int type)						\
403{									\
404	if (type == MOD_LOAD)						\
405		ieee80211_crypto_register(&name);			\
406	else								\
407		ieee80211_crypto_unregister(&name);			\
408}									\
409TEXT_SET(crypto##_set, name##_modevent)
410
411/*
412 * Scanner modules provide scanning policy.
413 */
414#define	IEEE80211_SCANNER_MODULE(name, version)				\
415	_IEEE80211_POLICY_MODULE(scanner, name, version)
416
417#define	IEEE80211_SCANNER_ALG(name, alg, v)				\
418static void								\
419name##_modevent(int type)						\
420{									\
421	if (type == MOD_LOAD)						\
422		ieee80211_scanner_register(alg, &v);			\
423	else								\
424		ieee80211_scanner_unregister(alg, &v);			\
425}									\
426TEXT_SET(scanner_set, name##_modevent);					\
427
428/*
429 * ACL modules implement acl policy.
430 */
431#define	IEEE80211_ACL_MODULE(name, alg, version)			\
432_IEEE80211_POLICY_MODULE(acl, name, version);				\
433static void								\
434alg##_modevent(int type)						\
435{									\
436	if (type == MOD_LOAD)						\
437		ieee80211_aclator_register(&alg);			\
438	else								\
439		ieee80211_aclator_unregister(&alg);			\
440}									\
441TEXT_SET(acl_set, alg##_modevent);					\
442
443/*
444 * Authenticator modules handle 802.1x/WPA authentication.
445 */
446#define	IEEE80211_AUTH_MODULE(name, version)				\
447	_IEEE80211_POLICY_MODULE(auth, name, version)
448
449#define	IEEE80211_AUTH_ALG(name, alg, v)				\
450static void								\
451name##_modevent(int type)						\
452{									\
453	if (type == MOD_LOAD)						\
454		ieee80211_authenticator_register(alg, &v);		\
455	else								\
456		ieee80211_authenticator_unregister(alg);		\
457}									\
458TEXT_SET(auth_set, name##_modevent)
459
460/*
461 * Rate control modules provide tx rate control support.
462 */
463#define	IEEE80211_RATECTL_MODULE(alg, version)				\
464	_IEEE80211_POLICY_MODULE(ratectl, alg, version);		\
465
466#define	IEEE80211_RATECTL_ALG(name, alg, v)				\
467static void								\
468alg##_modevent(int type)						\
469{									\
470	if (type == MOD_LOAD)						\
471		ieee80211_ratectl_register(alg, &v);			\
472	else								\
473		ieee80211_ratectl_unregister(alg);			\
474}									\
475TEXT_SET(ratectl##_set, alg##_modevent)
476
477struct ieee80211req;
478typedef int ieee80211_ioctl_getfunc(struct ieee80211vap *,
479    struct ieee80211req *);
480SET_DECLARE(ieee80211_ioctl_getset, ieee80211_ioctl_getfunc);
481#define	IEEE80211_IOCTL_GET(_name, _get) TEXT_SET(ieee80211_ioctl_getset, _get)
482
483typedef int ieee80211_ioctl_setfunc(struct ieee80211vap *,
484    struct ieee80211req *);
485SET_DECLARE(ieee80211_ioctl_setset, ieee80211_ioctl_setfunc);
486#define	IEEE80211_IOCTL_SET(_name, _set) TEXT_SET(ieee80211_ioctl_setset, _set)
487#endif /* _KERNEL */
488
489/* XXX this stuff belongs elsewhere */
490/*
491 * Message formats for messages from the net80211 layer to user
492 * applications via the routing socket.  These messages are appended
493 * to an if_announcemsghdr structure.
494 */
495struct ieee80211_join_event {
496	uint8_t		iev_addr[6];
497};
498
499struct ieee80211_leave_event {
500	uint8_t		iev_addr[6];
501};
502
503struct ieee80211_replay_event {
504	uint8_t		iev_src[6];	/* src MAC */
505	uint8_t		iev_dst[6];	/* dst MAC */
506	uint8_t		iev_cipher;	/* cipher type */
507	uint8_t		iev_keyix;	/* key id/index */
508	uint64_t	iev_keyrsc;	/* RSC from key */
509	uint64_t	iev_rsc;	/* RSC from frame */
510};
511
512struct ieee80211_michael_event {
513	uint8_t		iev_src[6];	/* src MAC */
514	uint8_t		iev_dst[6];	/* dst MAC */
515	uint8_t		iev_cipher;	/* cipher type */
516	uint8_t		iev_keyix;	/* key id/index */
517};
518
519struct ieee80211_wds_event {
520	uint8_t		iev_addr[6];
521};
522
523struct ieee80211_csa_event {
524	uint32_t	iev_flags;	/* channel flags */
525	uint16_t	iev_freq;	/* setting in Mhz */
526	uint8_t		iev_ieee;	/* IEEE channel number */
527	uint8_t		iev_mode;	/* CSA mode */
528	uint8_t		iev_count;	/* CSA count */
529};
530
531struct ieee80211_cac_event {
532	uint32_t	iev_flags;	/* channel flags */
533	uint16_t	iev_freq;	/* setting in Mhz */
534	uint8_t		iev_ieee;	/* IEEE channel number */
535	/* XXX timestamp? */
536	uint8_t		iev_type;	/* IEEE80211_NOTIFY_CAC_* */
537};
538
539struct ieee80211_radar_event {
540	uint32_t	iev_flags;	/* channel flags */
541	uint16_t	iev_freq;	/* setting in Mhz */
542	uint8_t		iev_ieee;	/* IEEE channel number */
543	/* XXX timestamp? */
544};
545
546struct ieee80211_auth_event {
547	uint8_t		iev_addr[6];
548};
549
550struct ieee80211_deauth_event {
551	uint8_t		iev_addr[6];
552};
553
554struct ieee80211_country_event {
555	uint8_t		iev_addr[6];
556	uint8_t		iev_cc[2];	/* ISO country code */
557};
558
559struct ieee80211_radio_event {
560	uint8_t		iev_state;	/* 1 on, 0 off */
561};
562
563#define	RTM_IEEE80211_ASSOC	100	/* station associate (bss mode) */
564#define	RTM_IEEE80211_REASSOC	101	/* station re-associate (bss mode) */
565#define	RTM_IEEE80211_DISASSOC	102	/* station disassociate (bss mode) */
566#define	RTM_IEEE80211_JOIN	103	/* station join (ap mode) */
567#define	RTM_IEEE80211_LEAVE	104	/* station leave (ap mode) */
568#define	RTM_IEEE80211_SCAN	105	/* scan complete, results available */
569#define	RTM_IEEE80211_REPLAY	106	/* sequence counter replay detected */
570#define	RTM_IEEE80211_MICHAEL	107	/* Michael MIC failure detected */
571#define	RTM_IEEE80211_REJOIN	108	/* station re-associate (ap mode) */
572#define	RTM_IEEE80211_WDS	109	/* WDS discovery (ap mode) */
573#define	RTM_IEEE80211_CSA	110	/* Channel Switch Announcement event */
574#define	RTM_IEEE80211_RADAR	111	/* radar event */
575#define	RTM_IEEE80211_CAC	112	/* Channel Availability Check event */
576#define	RTM_IEEE80211_DEAUTH	113	/* station deauthenticate */
577#define	RTM_IEEE80211_AUTH	114	/* station authenticate (ap mode) */
578#define	RTM_IEEE80211_COUNTRY	115	/* discovered country code (sta mode) */
579#define	RTM_IEEE80211_RADIO	116	/* RF kill switch state change */
580
581/*
582 * Structure prepended to raw packets sent through the bpf
583 * interface when set to DLT_IEEE802_11_RADIO.  This allows
584 * user applications to specify pretty much everything in
585 * an Atheros tx descriptor.  XXX need to generalize.
586 *
587 * XXX cannot be more than 14 bytes as it is copied to a sockaddr's
588 * XXX sa_data area.
589 */
590struct ieee80211_bpf_params {
591	uint8_t		ibp_vers;	/* version */
592#define	IEEE80211_BPF_VERSION	0
593	uint8_t		ibp_len;	/* header length in bytes */
594	uint8_t		ibp_flags;
595#define	IEEE80211_BPF_SHORTPRE	0x01	/* tx with short preamble */
596#define	IEEE80211_BPF_NOACK	0x02	/* tx with no ack */
597#define	IEEE80211_BPF_CRYPTO	0x04	/* tx with h/w encryption */
598#define	IEEE80211_BPF_FCS	0x10	/* frame incldues FCS */
599#define	IEEE80211_BPF_DATAPAD	0x20	/* frame includes data padding */
600#define	IEEE80211_BPF_RTS	0x40	/* tx with RTS/CTS */
601#define	IEEE80211_BPF_CTS	0x80	/* tx with CTS only */
602	uint8_t		ibp_pri;	/* WME/WMM AC+tx antenna */
603	uint8_t		ibp_try0;	/* series 1 try count */
604	uint8_t		ibp_rate0;	/* series 1 IEEE tx rate */
605	uint8_t		ibp_power;	/* tx power (device units) */
606	uint8_t		ibp_ctsrate;	/* IEEE tx rate for CTS */
607	uint8_t		ibp_try1;	/* series 2 try count */
608	uint8_t		ibp_rate1;	/* series 2 IEEE tx rate */
609	uint8_t		ibp_try2;	/* series 3 try count */
610	uint8_t		ibp_rate2;	/* series 3 IEEE tx rate */
611	uint8_t		ibp_try3;	/* series 4 try count */
612	uint8_t		ibp_rate3;	/* series 4 IEEE tx rate */
613};
614
615#ifdef _KERNEL
616struct ieee80211_tx_params {
617	struct ieee80211_bpf_params params;
618};
619int	ieee80211_add_xmit_params(struct mbuf *m,
620	    const struct ieee80211_bpf_params *);
621int	ieee80211_get_xmit_params(struct mbuf *m,
622	    struct ieee80211_bpf_params *);
623
624#define	IEEE80211_MAX_CHAINS		3
625#define	IEEE80211_MAX_EVM_PILOTS	6
626
627#define	IEEE80211_R_NF		0x0000001	/* global NF value valid */
628#define	IEEE80211_R_RSSI	0x0000002	/* global RSSI value valid */
629#define	IEEE80211_R_C_CHAIN	0x0000004	/* RX chain count valid */
630#define	IEEE80211_R_C_NF	0x0000008	/* per-chain NF value valid */
631#define	IEEE80211_R_C_RSSI	0x0000010	/* per-chain RSSI value valid */
632#define	IEEE80211_R_C_EVM	0x0000020	/* per-chain EVM valid */
633#define	IEEE80211_R_C_HT40	0x0000040	/* RX'ed packet is 40mhz, pilots 4,5 valid */
634#define	IEEE80211_R_FREQ	0x0000080	/* Freq value populated, MHz */
635#define	IEEE80211_R_IEEE	0x0000100	/* IEEE value populated */
636#define	IEEE80211_R_BAND	0x0000200	/* Frequency band populated */
637
638struct ieee80211_rx_stats {
639	uint32_t r_flags;		/* IEEE80211_R_* flags */
640	uint8_t c_chain;		/* number of RX chains involved */
641	int16_t	c_nf_ctl[IEEE80211_MAX_CHAINS];	/* per-chain NF */
642	int16_t	c_nf_ext[IEEE80211_MAX_CHAINS];	/* per-chain NF */
643	int16_t	c_rssi_ctl[IEEE80211_MAX_CHAINS];	/* per-chain RSSI */
644	int16_t	c_rssi_ext[IEEE80211_MAX_CHAINS];	/* per-chain RSSI */
645	uint8_t nf;			/* global NF */
646	uint8_t rssi;			/* global RSSI */
647	uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS];
648					/* per-chain, per-pilot EVM values */
649	uint16_t c_freq;
650	uint8_t c_ieee;
651};
652
653struct ieee80211_rx_params {
654	struct ieee80211_rx_stats params;
655};
656int	ieee80211_add_rx_params(struct mbuf *m,
657	    const struct ieee80211_rx_stats *rxs);
658int	ieee80211_get_rx_params(struct mbuf *m,
659	    struct ieee80211_rx_stats *rxs);
660#endif /* _KERNEL */
661
662/*
663 * Malloc API.  Other BSD operating systems have slightly
664 * different malloc/free namings (eg DragonflyBSD.)
665 */
666#define	IEEE80211_MALLOC	malloc
667#define	IEEE80211_FREE		free
668
669/* XXX TODO: get rid of WAITOK, fix all the users of it? */
670#define	IEEE80211_M_NOWAIT	M_NOWAIT
671#define	IEEE80211_M_WAITOK	M_WAITOK
672#define	IEEE80211_M_ZERO	M_ZERO
673
674/* XXX TODO: the type fields */
675
676#endif /* _NET80211_IEEE80211_FREEBSD_H_ */
677