xref: /src/sys/net80211/ieee80211_netbsd.h

/* $NetBSD: ieee80211_netbsd.h,v 1.14.4.3 2008/02/23 14:31:31 skrll Exp $ */
/*-
 * Copyright (c) 2003-2005 Sam Leffler, Errno Consulting
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: src/sys/net80211/ieee80211_freebsd.h,v 1.6 2005/08/08 18:46:36 sam Exp $
 */
#ifndef _NET80211_IEEE80211_NETBSD_H_
#define _NET80211_IEEE80211_NETBSD_H_

#ifdef _KERNEL
#define	IASSERT(__cond, __complaint)	 	\
	do {				 	\
		if (!(__cond))		 	\
			panic __complaint ;	\
	} while (/*CONSTCOND*/0)

void if_printf(struct ifnet *, const char *, ...)
    __attribute__((__format__(__printf__,2,3)));

#define	IEEE80211_LOCK_INIT_IMPL(_ic, _name, _member)	\
	mutex_init(&(_ic)->_member, MUTEX_DEFAULT, IPL_NET)
#define	IEEE80211_LOCK_IMPL(_ic, _member)		\
	mutex_enter(&(_ic)->_member)
#define IEEE80211_IS_LOCKED_IMPL(_ic, _member)          \
        mutex_owned(&(_ic)->_member)
#define	IEEE80211_UNLOCK_IMPL(_ic, _member)		\
	mutex_exit(&(_ic)->_member)
#define	IEEE80211_LOCK_ASSERT_IMPL(_ic, _member)	\
	IASSERT(mutex_owned(&(_ic)->_member),		\
	    ("%s: IEEE80211_LOCK not held", __func__))
#define IEEE80211_LOCK_DESTROY_IMPL(_ic, _member)	\
        mutex_destroy(&(_ic)->_member)

/*
 * Common state locking definitions.
 */
typedef kmutex_t ieee80211_com_lock_t;
#define	IEEE80211_LOCK_INIT(_ic, _name) \
	IEEE80211_LOCK_INIT_IMPL(_ic, _name, ic_comlock)
#define	IEEE80211_LOCK_DESTROY(_ic)			\
	IEEE80211_LOCK_DESTROY_IMPL(_ic, ic_comlock)
#define	IEEE80211_LOCK(_ic) \
	IEEE80211_LOCK_IMPL(_ic, ic_comlock)
#define	IEEE80211_UNLOCK(_ic)\
	IEEE80211_UNLOCK_IMPL(_ic, ic_comlock)
#define	IEEE80211_LOCK_ASSERT(_ic) \
	IEEE80211_LOCK_ASSERT_IMPL(_ic, ic_comlock)

/*
 * Beacon locking definitions.
 */
typedef kmutex_t ieee80211_beacon_lock_t;
#define	IEEE80211_BEACON_LOCK_INIT(_ic, _name)		\
	IEEE80211_LOCK_INIT_IMPL(_ic, _name, ic_beaconlock)
#define	IEEE80211_BEACON_LOCK_DESTROY(_ic)		\
	IEEE80211_LOCK_DESTROY_IMPL(_ic, ic_beaconlock)
#define	IEEE80211_BEACON_LOCK(_ic)			\
	IEEE80211_LOCK_IMPL(_ic, ic_beaconlock)
#define	IEEE80211_BEACON_UNLOCK(_ic)			\
	IEEE80211_UNLOCK_IMPL(_ic, ic_beaconlock)
#define	IEEE80211_BEACON_LOCK_ASSERT(_ic)		\
	IEEE80211_LOCK_ASSERT_IMPL(_ic, ic_beaconlock)

/*
 * Node locking definitions.
 * NB: MTX_DUPOK is because we don't generate per-interface strings.
 */
typedef kmutex_t ieee80211_node_lock_t;
#define	IEEE80211_NODE_LOCK_INIT(_nt, _name)		\
	IEEE80211_LOCK_INIT_IMPL(_nt, _name, nt_nodelock)
#define	IEEE80211_NODE_LOCK_DESTROY(_nt)		\
	IEEE80211_LOCK_DESTROY_IMPL(_nt, nt_nodelock)
#define	IEEE80211_NODE_LOCK(_nt)			\
	IEEE80211_LOCK_IMPL(_nt, nt_nodelock)
#define IEEE80211_NODE_IS_LOCKED(_nt)                   \
        IEEE80211_IS_LOCKED_IMPL(_nt, nt_nodelock)
#define	IEEE80211_NODE_UNLOCK(_nt)			\
	IEEE80211_UNLOCK_IMPL(_nt, nt_nodelock)
#define	IEEE80211_NODE_LOCK_ASSERT(_nt)			\
	IEEE80211_LOCK_ASSERT_IMPL(_nt, nt_nodelock)

/*
 * Node table scangen locking definitions.
 */
typedef kmutex_t ieee80211_scan_lock_t;
#define	IEEE80211_SCAN_LOCK_INIT(_nt, _name)		\
	IEEE80211_LOCK_INIT_IMPL(_nt, _name, nt_scanlock)
#define	IEEE80211_SCAN_LOCK_DESTROY(_nt)		\
	IEEE80211_LOCK_DESTROY_IMPL(_nt, nt_scanlock)
#define	IEEE80211_SCAN_LOCK(_nt)			\
	IEEE80211_LOCK_IMPL(_nt, nt_scanlock)
#define	IEEE80211_SCAN_UNLOCK(_nt)			\
	IEEE80211_UNLOCK_IMPL(_nt, nt_scanlock)
#define	IEEE80211_SCAN_LOCK_ASSERT(_nt)			\
	IEEE80211_LOCK_ASSERT_IMPL(_nt, nt_scanlock)

/*
 * Scan table locking definitions.
 */
typedef kmutex_t ieee80211_scantable_lock_t;
#define	IEEE80211_SCANTABLE_LOCK_INIT(_st, _name)	\
	IEEE80211_LOCK_INIT_IMPL(_st, _name, st_lock)
#define	IEEE80211_SCANTABLE_LOCK_DESTROY(_st)		\
	IEEE80211_LOCK_DESTROY_IMPL(_st, st_lock)
#define	IEEE80211_SCANTABLE_LOCK(_st)			\
	IEEE80211_LOCK_IMPL(_st, st_lock)
#define	IEEE80211_SCANTABLE_UNLOCK(_st)			\
	IEEE80211_UNLOCK_IMPL(_st, st_lock)
#define	IEEE80211_SCANTABLE_LOCK_ASSERT(_st)		\
	IEEE80211_LOCK_ASSERT_IMPL(_st, st_lock)

/*
 * Scan table scangen locking definitions.
 */
typedef kmutex_t ieee80211_scangen_lock_t;
#define	IEEE80211_SCANGEN_LOCK_INIT(_st, _name)		\
	IEEE80211_LOCK_INIT_IMPL(_st, _name, st_scanlock)
#define	IEEE80211_SCANGEN_LOCK_DESTROY(_st)		\
	IEEE80211_LOCK_DESTROY_IMPL(_st, st_scanlock)
#define	IEEE80211_SCANGEN_LOCK(_st)			\
	IEEE80211_LOCK_IMPL(_st, st_scanlock)
#define	IEEE80211_SCANGEN_UNLOCK(_st)			\
	IEEE80211_UNLOCK_IMPL(_st, st_scanlock)
#define	IEEE80211_SCANGEN_LOCK_ASSERT(_st)		\
	IEEE80211_LOCK_ASSERT_IMPL(_st, st_scanlock)

/*
 * Per-node power-save queue definitions.
 */
#define	IEEE80211_NODE_SAVEQ_INIT(_ni, _name) do {		\
	(_ni)->ni_savedq.ifq_maxlen = IEEE80211_PS_MAX_QUEUE;	\
} while (0)
#define	IEEE80211_NODE_SAVEQ_DESTROY(_ni)
#define	IEEE80211_NODE_SAVEQ_QLEN(_ni)	((_ni)->ni_savedq.ifq_len)
#define	IEEE80211_NODE_SAVEQ_LOCK(_ni)
#define	IEEE80211_NODE_SAVEQ_UNLOCK(_ni)
#define	IEEE80211_NODE_SAVEQ_DEQUEUE(_ni, _m, _qlen) do {	\
	IEEE80211_NODE_SAVEQ_LOCK(_ni);				\
	IF_DEQUEUE(&(_ni)->ni_savedq, _m);			\
	(_qlen) = IEEE80211_NODE_SAVEQ_QLEN(_ni);		\
	IEEE80211_NODE_SAVEQ_UNLOCK(_ni);			\
} while (0)
#define	IEEE80211_NODE_SAVEQ_DRAIN(_ni, _qlen) do {		\
	IEEE80211_NODE_SAVEQ_LOCK(_ni);				\
	(_qlen) = IEEE80211_NODE_SAVEQ_QLEN(_ni);		\
	IF_PURGE(&(_ni)->ni_savedq);				\
	IEEE80211_NODE_SAVEQ_UNLOCK(_ni);			\
} while (0)
/* XXX could be optimized */
#define	_IEEE80211_NODE_SAVEQ_DEQUEUE_HEAD(_ni, _m) do {	\
	IF_DEQUEUE(&(_ni)->ni_savedq, m);			\
} while (0)
#define	_IEEE80211_NODE_SAVEQ_ENQUEUE(_ni, _m, _qlen, _age) do {\
	(_m)->m_nextpkt = NULL;					\
	if ((_ni)->ni_savedq.ifq_tail != NULL) { 		\
		_age -= M_AGE_GET((_ni)->ni_savedq.ifq_tail);	\
		(_ni)->ni_savedq.ifq_tail->m_nextpkt = (_m);	\
	} else { 						\
		(_ni)->ni_savedq.ifq_head = (_m); 		\
	}							\
	M_AGE_SET(_m, _age);					\
	(_ni)->ni_savedq.ifq_tail = (_m); 			\
	(_qlen) = ++(_ni)->ni_savedq.ifq_len; 			\
} while (0)

#define	IEEE80211_TAPQ_INIT(_tap) do {				\
	(_tap)->txa_q.ifq_maxlen = IEEE80211_AGGR_BAWMAX;	\
} while (0)
#define	IEEE80211_TAPQ_DESTROY(_tap)

#define IF_PREPEND_LIST(ifq, mhead, mtail, mcount) do {		\
	(mtail)->m_nextpkt = (ifq)->ifq_head;			\
	if ((ifq)->ifq_tail == NULL)				\
		(ifq)->ifq_tail = (mtail);			\
	(ifq)->ifq_head = (mhead);				\
	(ifq)->ifq_len += (mcount);				\
} while (0)

/*
 * 802.1x MAC ACL database locking definitions.
 */
typedef kmutex_t acl_lock_t;
#define	ACL_LOCK_INIT(_as, _name)	\
	IEEE80211_LOCK_INIT_IMPL(_as, _name, as_lock)
#define	ACL_LOCK_DESTROY(_as)		\
	IEEE80211_LOCK_DESTROY_IMPL(_as, as_lock)
#define	ACL_LOCK(_as)			IEEE80211_LOCK_IMPL(_as, as_lock)
#define	ACL_UNLOCK(_as)			IEEE80211_UNLOCK_IMPL(_as, as_lock)
#define	ACL_LOCK_ASSERT(_as)		IEEE80211_LOCK_ASSERT_IMPL(_as, as_lock)

/*
 * Node reference counting definitions.
 *
 * ieee80211_node_initref	initialize the reference count to 1
 * ieee80211_node_incref	add a reference
 * ieee80211_node_decref	remove a reference
 * ieee80211_node_dectestref	remove a reference and return 1 if this
 *				is the last reference, otherwise 0
 * ieee80211_node_refcnt	reference count for printing (only)
 */

#define ieee80211_node_initref(_ni) \
	do { ((_ni)->ni_refcnt = 1); } while (0)
#define ieee80211_node_incref(_ni) \
	do { (_ni)->ni_refcnt++; } while (0)
#define	ieee80211_node_decref(_ni) \
	do { (_ni)->ni_refcnt--; } while (0)
struct ieee80211_node;
int ieee80211_node_dectestref(struct ieee80211_node *ni);
#define	ieee80211_node_refcnt(_ni)	(_ni)->ni_refcnt

struct ifqueue;
void	ieee80211_drain_ifq(struct ifqueue *);

#define	msecs_to_ticks(ms)	(((ms)*hz)/1000)
#define	ticks_to_msecs(t)	((t) / hz)
#define time_after(a,b) 	((long)(b) - (long)(a) < 0)
#define time_before(a,b)	time_after(b,a)
#define time_after_eq(a,b)	((long)(a) - (long)(b) >= 0)
#define time_before_eq(a,b)	time_after_eq(b,a)

struct mbuf *ieee80211_getmgtframe(uint8_t **frm, int, u_int pktlen);

/* tx path usage */
#define	M_PWR_SAV	M_PROTO1		/* bypass PS handling */
#define	M_MORE_DATA	M_LINK3			/* more data frames to follow */
#define	M_FRAG		M_LINK4			/* 802.11 fragment */
#define	M_FIRSTFRAG	M_LINK5			/* first 802.11 fragment */
#define	M_FF		M_LINK6			/* "fast frames" */

/* rx path usage */
#define M_AMPDU		M_PROTO1		/* A-MPDU processing done */
#define	M_WEP		M_LINK3			/* WEP done by hardware */ /* XXXNH */
#define	M_80211_RX	(M_AMPDU|M_WEP)

#ifdef __FreeBSD__
/* tx path usage */
#define M_LINK0         M_PROTO1                /* WEP requested */
#define M_PWR_SAV       M_PROTO4                /* bypass PS handling */
#define M_MORE_DATA     M_PROTO5                /* more data frames to follow */
#define M_FF            0x20000                 /* fast frame */
#define M_TXCB          0x40000                 /* do tx complete callback */
#define M_80211_TX      (0x60000|M_PROTO1|M_WME_AC_MASK|M_PROTO4|M_PROTO5)

/* rx path usage */
#define M_AMPDU         M_PROTO1                /* A-MPDU processing done */
#define M_WEP           M_PROTO2                /* WEP done by hardware */
#define M_80211_RX      (M_AMPDU|M_WEP)
#endif

/*
 * Encode WME access control bits in the PROTO flags.
 * This is safe since it's passed directly in to the
 * driver and there's no chance someone else will clobber
 * them on us.
 */
#define	M_WME_AC_MASK	(M_LINK1|M_LINK2)
/* XXX 5 is wrong if M_LINK* are redefined */
#define	M_WME_AC_SHIFT	13

#define	M_WME_SETAC(m, ac) \
	((m)->m_flags = ((m)->m_flags &~ M_WME_AC_MASK) | \
		((ac) << M_WME_AC_SHIFT))
#define	M_WME_GETAC(m)	(((m)->m_flags >> M_WME_AC_SHIFT) & 0x3)

/*
 * Mbufs on the power save queue are tagged with an age and
 * timed out.  We reuse the hardware checksum field in the
 * mbuf packet header to store this data.
 */
#define	M_AGE_SET(m,v)		(m->m_pkthdr.csum_data = v)
#define	M_AGE_GET(m)		(m->m_pkthdr.csum_data)
#define	M_AGE_SUB(m,adj)	(m->m_pkthdr.csum_data -= adj)

struct ieee80211_cb {
	void	(*func)(struct ieee80211_node *, void *, int status);
	void	*arg;
};
#define	NET80211_TAG_CALLBACK	0	/* xmit complete callback */
int	ieee80211_add_callback(struct mbuf *m,
		void (*func)(struct ieee80211_node *, void *, int), void *arg);
void	ieee80211_process_callback(struct ieee80211_node *, struct mbuf *, int);

struct ieee80211com;
#endif /* _KERNEL */

/* XXX this stuff belongs elsewhere */
/*
 * Message formats for messages from the net80211 layer to user
 * applications via the routing socket.  These messages are appended
 * to an if_announcemsghdr structure.
 */
struct ieee80211_join_event {
	uint8_t		iev_addr[6];
};

struct ieee80211_leave_event {
	uint8_t		iev_addr[6];
};

struct ieee80211_replay_event {
	uint8_t		iev_src[6];	/* src MAC */
	uint8_t		iev_dst[6];	/* dst MAC */
	uint8_t		iev_cipher;	/* cipher type */
	uint8_t		iev_keyix;	/* key id/index */
	uint64_t	iev_keyrsc;	/* RSC from key */
	uint64_t	iev_rsc;	/* RSC from frame */
};

struct ieee80211_michael_event {
	uint8_t		iev_src[6];	/* src MAC */
	uint8_t		iev_dst[6];	/* dst MAC */
	uint8_t		iev_cipher;	/* cipher type */
	uint8_t		iev_keyix;	/* key id/index */
};

#define	RTM_IEEE80211_ASSOC	100	/* station associate (bss mode) */
#define	RTM_IEEE80211_REASSOC	101	/* station re-associate (bss mode) */
#define	RTM_IEEE80211_DISASSOC	102	/* station disassociate (bss mode) */
#define	RTM_IEEE80211_JOIN	103	/* station join (ap mode) */
#define	RTM_IEEE80211_LEAVE	104	/* station leave (ap mode) */
#define	RTM_IEEE80211_SCAN	105	/* scan complete, results available */
#define	RTM_IEEE80211_REPLAY	106	/* sequence counter replay detected */
#define	RTM_IEEE80211_MICHAEL	107	/* Michael MIC failure detected */
#define	RTM_IEEE80211_REJOIN	108	/* station re-associate (ap mode) */

#ifdef _KERNEL
#define	__offsetof	offsetof
#define	ticks	hardclock_ticks
#define	ovbcopy(__src, __dst, __n)	((void)memmove(__dst, __src, __n))

#define TAILQ_FOREACH_SAFE(var, head, field, nextvar)			\
	for (var = TAILQ_FIRST(head);					\
	     var != NULL && (nextvar = TAILQ_NEXT(var, field), 1);	\
	     var = nextvar)

void	if_printf(struct ifnet *, const char *, ...);
void	m_align(struct mbuf *, int);
int	m_append(struct mbuf *, int, const void *);
void	get_random_bytes(void *, size_t);

void	ieee80211_sysctl_attach(struct ieee80211com *);
void	ieee80211_sysctl_detach(struct ieee80211com *);
void	ieee80211_load_module(const char *);

void	net80211_init(void);
#define	IEEE80211_CRYPTO_SETUP(name)				\
	static void name(void);					\
	__link_set_add_text(ieee80211_funcs, name);		\
	static void name(void)
#endif /* _KERNEL */

#endif /* !_NET80211_IEEE80211_NETBSD_H_ */