ieee80211_freebsd.h revision 293022
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 293022 2016-01-01 00:21:07Z 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/* XXX TODO: cap these at 1, as hz may not be 1000 */
250#define	msecs_to_ticks(ms)	(((ms)*hz)/1000)
251#define	ticks_to_msecs(t)	(1000*(t) / hz)
252#define	ticks_to_secs(t)	((t) / hz)
253
254#define time_after(a,b) 	((long)(b) - (long)(a) < 0)
255#define time_before(a,b)	time_after(b,a)
256#define time_after_eq(a,b)	((long)(a) - (long)(b) >= 0)
257#define time_before_eq(a,b)	time_after_eq(b,a)
258
259struct mbuf *ieee80211_getmgtframe(uint8_t **frm, int headroom, int pktlen);
260
261/* tx path usage */
262#define	M_ENCAP		M_PROTO1		/* 802.11 encap done */
263#define	M_EAPOL		M_PROTO3		/* PAE/EAPOL frame */
264#define	M_PWR_SAV	M_PROTO4		/* bypass PS handling */
265#define	M_MORE_DATA	M_PROTO5		/* more data frames to follow */
266#define	M_FF		M_PROTO6		/* fast frame */
267#define	M_TXCB		M_PROTO7		/* do tx complete callback */
268#define	M_AMPDU_MPDU	M_PROTO8		/* ok for A-MPDU aggregation */
269#define	M_FRAG		M_PROTO9		/* frame fragmentation */
270#define	M_FIRSTFRAG	M_PROTO10		/* first frame fragment */
271#define	M_LASTFRAG	M_PROTO11		/* last frame fragment */
272
273#define	M_80211_TX \
274	(M_ENCAP|M_EAPOL|M_PWR_SAV|M_MORE_DATA|M_FF|M_TXCB| \
275	 M_AMPDU_MPDU|M_FRAG|M_FIRSTFRAG|M_LASTFRAG)
276
277/* rx path usage */
278#define	M_AMPDU		M_PROTO1		/* A-MPDU subframe */
279#define	M_WEP		M_PROTO2		/* WEP done by hardware */
280#if 0
281#define	M_AMPDU_MPDU	M_PROTO8		/* A-MPDU re-order done */
282#endif
283#define	M_80211_RX	(M_AMPDU|M_WEP|M_AMPDU_MPDU)
284
285#define	IEEE80211_MBUF_TX_FLAG_BITS \
286	M_FLAG_BITS \
287	"\15M_ENCAP\17M_EAPOL\20M_PWR_SAV\21M_MORE_DATA\22M_FF\23M_TXCB" \
288	"\24M_AMPDU_MPDU\25M_FRAG\26M_FIRSTFRAG\27M_LASTFRAG"
289
290#define	IEEE80211_MBUF_RX_FLAG_BITS \
291	M_FLAG_BITS \
292	"\15M_AMPDU\16M_WEP\24M_AMPDU_MPDU"
293
294/*
295 * Store WME access control bits in the vlan tag.
296 * This is safe since it's done after the packet is classified
297 * (where we use any previous tag) and because it's passed
298 * directly in to the driver and there's no chance someone
299 * else will clobber them on us.
300 */
301#define	M_WME_SETAC(m, ac) \
302	((m)->m_pkthdr.ether_vtag = (ac))
303#define	M_WME_GETAC(m)	((m)->m_pkthdr.ether_vtag)
304
305/*
306 * Mbufs on the power save queue are tagged with an age and
307 * timed out.  We reuse the hardware checksum field in the
308 * mbuf packet header to store this data.
309 */
310#define	M_AGE_SET(m,v)		(m->m_pkthdr.csum_data = v)
311#define	M_AGE_GET(m)		(m->m_pkthdr.csum_data)
312#define	M_AGE_SUB(m,adj)	(m->m_pkthdr.csum_data -= adj)
313
314/*
315 * Store the sequence number.
316 */
317#define	M_SEQNO_SET(m, seqno) \
318	((m)->m_pkthdr.tso_segsz = (seqno))
319#define	M_SEQNO_GET(m)	((m)->m_pkthdr.tso_segsz)
320
321#define	MTAG_ABI_NET80211	1132948340	/* net80211 ABI */
322
323struct ieee80211_cb {
324	void	(*func)(struct ieee80211_node *, void *, int status);
325	void	*arg;
326};
327#define	NET80211_TAG_CALLBACK	0	/* xmit complete callback */
328int	ieee80211_add_callback(struct mbuf *m,
329		void (*func)(struct ieee80211_node *, void *, int), void *arg);
330void	ieee80211_process_callback(struct ieee80211_node *, struct mbuf *, int);
331
332#define	NET80211_TAG_XMIT_PARAMS	1
333/* See below; this is after the bpf_params definition */
334
335#define	NET80211_TAG_RECV_PARAMS	2
336
337struct ieee80211com;
338int	ieee80211_parent_xmitpkt(struct ieee80211com *, struct mbuf *);
339int	ieee80211_vap_xmitpkt(struct ieee80211vap *, struct mbuf *);
340
341void	get_random_bytes(void *, size_t);
342
343void	ieee80211_sysctl_attach(struct ieee80211com *);
344void	ieee80211_sysctl_detach(struct ieee80211com *);
345void	ieee80211_sysctl_vattach(struct ieee80211vap *);
346void	ieee80211_sysctl_vdetach(struct ieee80211vap *);
347
348SYSCTL_DECL(_net_wlan);
349int	ieee80211_sysctl_msecs_ticks(SYSCTL_HANDLER_ARGS);
350
351void	ieee80211_load_module(const char *);
352
353/*
354 * A "policy module" is an adjunct module to net80211 that provides
355 * functionality that typically includes policy decisions.  This
356 * modularity enables extensibility and vendor-supplied functionality.
357 */
358#define	_IEEE80211_POLICY_MODULE(policy, name, version)			\
359typedef void (*policy##_setup)(int);					\
360SET_DECLARE(policy##_set, policy##_setup);				\
361static int								\
362wlan_##name##_modevent(module_t mod, int type, void *unused)		\
363{									\
364	policy##_setup * const *iter, f;				\
365	switch (type) {							\
366	case MOD_LOAD:							\
367		SET_FOREACH(iter, policy##_set) {			\
368			f = (void*) *iter;				\
369			f(type);					\
370		}							\
371		return 0;						\
372	case MOD_UNLOAD:						\
373	case MOD_QUIESCE:						\
374		if (nrefs) {						\
375			printf("wlan_" #name ": still in use "		\
376				"(%u dynamic refs)\n", nrefs);		\
377			return EBUSY;					\
378		}							\
379		if (type == MOD_UNLOAD) {				\
380			SET_FOREACH(iter, policy##_set) {		\
381				f = (void*) *iter;			\
382				f(type);				\
383			}						\
384		}							\
385		return 0;						\
386	}								\
387	return EINVAL;							\
388}									\
389static moduledata_t name##_mod = {					\
390	"wlan_" #name,							\
391	wlan_##name##_modevent,						\
392	0								\
393};									\
394DECLARE_MODULE(wlan_##name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);\
395MODULE_VERSION(wlan_##name, version);					\
396MODULE_DEPEND(wlan_##name, wlan, 1, 1, 1)
397
398/*
399 * Crypto modules implement cipher support.
400 */
401#define	IEEE80211_CRYPTO_MODULE(name, version)				\
402_IEEE80211_POLICY_MODULE(crypto, name, version);			\
403static void								\
404name##_modevent(int type)						\
405{									\
406	if (type == MOD_LOAD)						\
407		ieee80211_crypto_register(&name);			\
408	else								\
409		ieee80211_crypto_unregister(&name);			\
410}									\
411TEXT_SET(crypto##_set, name##_modevent)
412
413/*
414 * Scanner modules provide scanning policy.
415 */
416#define	IEEE80211_SCANNER_MODULE(name, version)				\
417	_IEEE80211_POLICY_MODULE(scanner, name, version)
418
419#define	IEEE80211_SCANNER_ALG(name, alg, v)				\
420static void								\
421name##_modevent(int type)						\
422{									\
423	if (type == MOD_LOAD)						\
424		ieee80211_scanner_register(alg, &v);			\
425	else								\
426		ieee80211_scanner_unregister(alg, &v);			\
427}									\
428TEXT_SET(scanner_set, name##_modevent);					\
429
430/*
431 * ACL modules implement acl policy.
432 */
433#define	IEEE80211_ACL_MODULE(name, alg, version)			\
434_IEEE80211_POLICY_MODULE(acl, name, version);				\
435static void								\
436alg##_modevent(int type)						\
437{									\
438	if (type == MOD_LOAD)						\
439		ieee80211_aclator_register(&alg);			\
440	else								\
441		ieee80211_aclator_unregister(&alg);			\
442}									\
443TEXT_SET(acl_set, alg##_modevent);					\
444
445/*
446 * Authenticator modules handle 802.1x/WPA authentication.
447 */
448#define	IEEE80211_AUTH_MODULE(name, version)				\
449	_IEEE80211_POLICY_MODULE(auth, name, version)
450
451#define	IEEE80211_AUTH_ALG(name, alg, v)				\
452static void								\
453name##_modevent(int type)						\
454{									\
455	if (type == MOD_LOAD)						\
456		ieee80211_authenticator_register(alg, &v);		\
457	else								\
458		ieee80211_authenticator_unregister(alg);		\
459}									\
460TEXT_SET(auth_set, name##_modevent)
461
462/*
463 * Rate control modules provide tx rate control support.
464 */
465#define	IEEE80211_RATECTL_MODULE(alg, version)				\
466	_IEEE80211_POLICY_MODULE(ratectl, alg, version);		\
467
468#define	IEEE80211_RATECTL_ALG(name, alg, v)				\
469static void								\
470alg##_modevent(int type)						\
471{									\
472	if (type == MOD_LOAD)						\
473		ieee80211_ratectl_register(alg, &v);			\
474	else								\
475		ieee80211_ratectl_unregister(alg);			\
476}									\
477TEXT_SET(ratectl##_set, alg##_modevent)
478
479struct ieee80211req;
480typedef int ieee80211_ioctl_getfunc(struct ieee80211vap *,
481    struct ieee80211req *);
482SET_DECLARE(ieee80211_ioctl_getset, ieee80211_ioctl_getfunc);
483#define	IEEE80211_IOCTL_GET(_name, _get) TEXT_SET(ieee80211_ioctl_getset, _get)
484
485typedef int ieee80211_ioctl_setfunc(struct ieee80211vap *,
486    struct ieee80211req *);
487SET_DECLARE(ieee80211_ioctl_setset, ieee80211_ioctl_setfunc);
488#define	IEEE80211_IOCTL_SET(_name, _set) TEXT_SET(ieee80211_ioctl_setset, _set)
489#endif /* _KERNEL */
490
491/* XXX this stuff belongs elsewhere */
492/*
493 * Message formats for messages from the net80211 layer to user
494 * applications via the routing socket.  These messages are appended
495 * to an if_announcemsghdr structure.
496 */
497struct ieee80211_join_event {
498	uint8_t		iev_addr[6];
499};
500
501struct ieee80211_leave_event {
502	uint8_t		iev_addr[6];
503};
504
505struct ieee80211_replay_event {
506	uint8_t		iev_src[6];	/* src MAC */
507	uint8_t		iev_dst[6];	/* dst MAC */
508	uint8_t		iev_cipher;	/* cipher type */
509	uint8_t		iev_keyix;	/* key id/index */
510	uint64_t	iev_keyrsc;	/* RSC from key */
511	uint64_t	iev_rsc;	/* RSC from frame */
512};
513
514struct ieee80211_michael_event {
515	uint8_t		iev_src[6];	/* src MAC */
516	uint8_t		iev_dst[6];	/* dst MAC */
517	uint8_t		iev_cipher;	/* cipher type */
518	uint8_t		iev_keyix;	/* key id/index */
519};
520
521struct ieee80211_wds_event {
522	uint8_t		iev_addr[6];
523};
524
525struct ieee80211_csa_event {
526	uint32_t	iev_flags;	/* channel flags */
527	uint16_t	iev_freq;	/* setting in Mhz */
528	uint8_t		iev_ieee;	/* IEEE channel number */
529	uint8_t		iev_mode;	/* CSA mode */
530	uint8_t		iev_count;	/* CSA count */
531};
532
533struct ieee80211_cac_event {
534	uint32_t	iev_flags;	/* channel flags */
535	uint16_t	iev_freq;	/* setting in Mhz */
536	uint8_t		iev_ieee;	/* IEEE channel number */
537	/* XXX timestamp? */
538	uint8_t		iev_type;	/* IEEE80211_NOTIFY_CAC_* */
539};
540
541struct ieee80211_radar_event {
542	uint32_t	iev_flags;	/* channel flags */
543	uint16_t	iev_freq;	/* setting in Mhz */
544	uint8_t		iev_ieee;	/* IEEE channel number */
545	/* XXX timestamp? */
546};
547
548struct ieee80211_auth_event {
549	uint8_t		iev_addr[6];
550};
551
552struct ieee80211_deauth_event {
553	uint8_t		iev_addr[6];
554};
555
556struct ieee80211_country_event {
557	uint8_t		iev_addr[6];
558	uint8_t		iev_cc[2];	/* ISO country code */
559};
560
561struct ieee80211_radio_event {
562	uint8_t		iev_state;	/* 1 on, 0 off */
563};
564
565#define	RTM_IEEE80211_ASSOC	100	/* station associate (bss mode) */
566#define	RTM_IEEE80211_REASSOC	101	/* station re-associate (bss mode) */
567#define	RTM_IEEE80211_DISASSOC	102	/* station disassociate (bss mode) */
568#define	RTM_IEEE80211_JOIN	103	/* station join (ap mode) */
569#define	RTM_IEEE80211_LEAVE	104	/* station leave (ap mode) */
570#define	RTM_IEEE80211_SCAN	105	/* scan complete, results available */
571#define	RTM_IEEE80211_REPLAY	106	/* sequence counter replay detected */
572#define	RTM_IEEE80211_MICHAEL	107	/* Michael MIC failure detected */
573#define	RTM_IEEE80211_REJOIN	108	/* station re-associate (ap mode) */
574#define	RTM_IEEE80211_WDS	109	/* WDS discovery (ap mode) */
575#define	RTM_IEEE80211_CSA	110	/* Channel Switch Announcement event */
576#define	RTM_IEEE80211_RADAR	111	/* radar event */
577#define	RTM_IEEE80211_CAC	112	/* Channel Availability Check event */
578#define	RTM_IEEE80211_DEAUTH	113	/* station deauthenticate */
579#define	RTM_IEEE80211_AUTH	114	/* station authenticate (ap mode) */
580#define	RTM_IEEE80211_COUNTRY	115	/* discovered country code (sta mode) */
581#define	RTM_IEEE80211_RADIO	116	/* RF kill switch state change */
582
583/*
584 * Structure prepended to raw packets sent through the bpf
585 * interface when set to DLT_IEEE802_11_RADIO.  This allows
586 * user applications to specify pretty much everything in
587 * an Atheros tx descriptor.  XXX need to generalize.
588 *
589 * XXX cannot be more than 14 bytes as it is copied to a sockaddr's
590 * XXX sa_data area.
591 */
592struct ieee80211_bpf_params {
593	uint8_t		ibp_vers;	/* version */
594#define	IEEE80211_BPF_VERSION	0
595	uint8_t		ibp_len;	/* header length in bytes */
596	uint8_t		ibp_flags;
597#define	IEEE80211_BPF_SHORTPRE	0x01	/* tx with short preamble */
598#define	IEEE80211_BPF_NOACK	0x02	/* tx with no ack */
599#define	IEEE80211_BPF_CRYPTO	0x04	/* tx with h/w encryption */
600#define	IEEE80211_BPF_FCS	0x10	/* frame incldues FCS */
601#define	IEEE80211_BPF_DATAPAD	0x20	/* frame includes data padding */
602#define	IEEE80211_BPF_RTS	0x40	/* tx with RTS/CTS */
603#define	IEEE80211_BPF_CTS	0x80	/* tx with CTS only */
604	uint8_t		ibp_pri;	/* WME/WMM AC+tx antenna */
605	uint8_t		ibp_try0;	/* series 1 try count */
606	uint8_t		ibp_rate0;	/* series 1 IEEE tx rate */
607	uint8_t		ibp_power;	/* tx power (device units) */
608	uint8_t		ibp_ctsrate;	/* IEEE tx rate for CTS */
609	uint8_t		ibp_try1;	/* series 2 try count */
610	uint8_t		ibp_rate1;	/* series 2 IEEE tx rate */
611	uint8_t		ibp_try2;	/* series 3 try count */
612	uint8_t		ibp_rate2;	/* series 3 IEEE tx rate */
613	uint8_t		ibp_try3;	/* series 4 try count */
614	uint8_t		ibp_rate3;	/* series 4 IEEE tx rate */
615};
616
617#ifdef _KERNEL
618struct ieee80211_tx_params {
619	struct ieee80211_bpf_params params;
620};
621int	ieee80211_add_xmit_params(struct mbuf *m,
622	    const struct ieee80211_bpf_params *);
623int	ieee80211_get_xmit_params(struct mbuf *m,
624	    struct ieee80211_bpf_params *);
625
626#define	IEEE80211_MAX_CHAINS		3
627#define	IEEE80211_MAX_EVM_PILOTS	6
628
629#define	IEEE80211_R_NF		0x0000001	/* global NF value valid */
630#define	IEEE80211_R_RSSI	0x0000002	/* global RSSI value valid */
631#define	IEEE80211_R_C_CHAIN	0x0000004	/* RX chain count valid */
632#define	IEEE80211_R_C_NF	0x0000008	/* per-chain NF value valid */
633#define	IEEE80211_R_C_RSSI	0x0000010	/* per-chain RSSI value valid */
634#define	IEEE80211_R_C_EVM	0x0000020	/* per-chain EVM valid */
635#define	IEEE80211_R_C_HT40	0x0000040	/* RX'ed packet is 40mhz, pilots 4,5 valid */
636#define	IEEE80211_R_FREQ	0x0000080	/* Freq value populated, MHz */
637#define	IEEE80211_R_IEEE	0x0000100	/* IEEE value populated */
638#define	IEEE80211_R_BAND	0x0000200	/* Frequency band populated */
639
640struct ieee80211_rx_stats {
641	uint32_t r_flags;		/* IEEE80211_R_* flags */
642	uint8_t c_chain;		/* number of RX chains involved */
643	int16_t	c_nf_ctl[IEEE80211_MAX_CHAINS];	/* per-chain NF */
644	int16_t	c_nf_ext[IEEE80211_MAX_CHAINS];	/* per-chain NF */
645	int16_t	c_rssi_ctl[IEEE80211_MAX_CHAINS];	/* per-chain RSSI */
646	int16_t	c_rssi_ext[IEEE80211_MAX_CHAINS];	/* per-chain RSSI */
647	uint8_t nf;			/* global NF */
648	uint8_t rssi;			/* global RSSI */
649	uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS];
650					/* per-chain, per-pilot EVM values */
651	uint16_t c_freq;
652	uint8_t c_ieee;
653};
654
655struct ieee80211_rx_params {
656	struct ieee80211_rx_stats params;
657};
658int	ieee80211_add_rx_params(struct mbuf *m,
659	    const struct ieee80211_rx_stats *rxs);
660int	ieee80211_get_rx_params(struct mbuf *m,
661	    struct ieee80211_rx_stats *rxs);
662#endif /* _KERNEL */
663
664/*
665 * Malloc API.  Other BSD operating systems have slightly
666 * different malloc/free namings (eg DragonflyBSD.)
667 */
668#define	IEEE80211_MALLOC	malloc
669#define	IEEE80211_FREE		free
670
671/* XXX TODO: get rid of WAITOK, fix all the users of it? */
672#define	IEEE80211_M_NOWAIT	M_NOWAIT
673#define	IEEE80211_M_WAITOK	M_WAITOK
674#define	IEEE80211_M_ZERO	M_ZERO
675
676/* XXX TODO: the type fields */
677
678#endif /* _NET80211_IEEE80211_FREEBSD_H_ */
679