ieee80211_node.h revision 127877 
1/*-
2 * Copyright (c) 2001 Atsushi Onoe
3 * Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 *    derived from this software without specific prior written permission.
16 *
17 * Alternatively, this software may be distributed under the terms of the
18 * GNU General Public License ("GPL") version 2 as published by the Free
19 * Software Foundation.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * $FreeBSD: head/sys/net80211/ieee80211_node.h 127877 2004-04-05 04:17:03Z sam $
33 */
34#ifndef _NET80211_IEEE80211_NODE_H_
35#define _NET80211_IEEE80211_NODE_H_
36
37#define	IEEE80211_PSCAN_WAIT 	5		/* passive scan wait */
38#define	IEEE80211_TRANS_WAIT 	5		/* transition wait */
39#define	IEEE80211_INACT_WAIT	5		/* inactivity timer interval */
40#define	IEEE80211_INACT_MAX	(300/IEEE80211_INACT_WAIT)
41
42#define	IEEE80211_NODE_HASHSIZE	32
43/* simple hash is enough for variation of macaddr */
44#define	IEEE80211_NODE_HASH(addr)	\
45	(((u_int8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % IEEE80211_NODE_HASHSIZE)
46
47#define	IEEE80211_RATE_SIZE	8		/* 802.11 standard */
48#define	IEEE80211_RATE_MAXSIZE	15		/* max rates we'll handle */
49
50struct ieee80211_rateset {
51	u_int8_t		rs_nrates;
52	u_int8_t		rs_rates[IEEE80211_RATE_MAXSIZE];
53};
54
55/*
56 * Node specific information.  Note that drivers are expected
57 * to derive from this structure to add device-specific per-node
58 * state.  This is done by overriding the ic_node_* methods in
59 * the ieee80211com structure.
60 */
61struct ieee80211_node {
62	TAILQ_ENTRY(ieee80211_node)	ni_list;
63	LIST_ENTRY(ieee80211_node)	ni_hash;
64	u_int			ni_refcnt;
65	u_int			ni_scangen;	/* gen# for timeout scan */
66
67	/* hardware */
68	u_int32_t		ni_rstamp;	/* recv timestamp */
69	u_int8_t		ni_rssi;	/* recv ssi */
70
71	/* header */
72	u_int8_t		ni_macaddr[IEEE80211_ADDR_LEN];
73	u_int8_t		ni_bssid[IEEE80211_ADDR_LEN];
74
75	/* beacon, probe response */
76	u_int8_t		ni_tstamp[8];	/* from last rcv'd beacon */
77	u_int16_t		ni_intval;	/* beacon interval */
78	u_int16_t		ni_capinfo;	/* capabilities */
79	u_int8_t		ni_esslen;
80	u_int8_t		ni_essid[IEEE80211_NWID_LEN];
81	struct ieee80211_rateset ni_rates;	/* negotiated rate set */
82	u_int8_t		*ni_country;	/* country information XXX */
83	struct ieee80211_channel *ni_chan;
84	u_int16_t		ni_fhdwell;	/* FH only */
85	u_int8_t		ni_fhindex;	/* FH only */
86	u_int8_t		ni_erp;		/* 11g only */
87
88#ifdef notyet
89	/* DTIM and contention free period (CFP) */
90	u_int8_t		ni_dtimperiod;
91	u_int8_t		ni_cfpperiod;	/* # of DTIMs between CFPs */
92	u_int16_t		ni_cfpduremain;	/* remaining cfp duration */
93	u_int16_t		ni_cfpmaxduration;/* max CFP duration in TU */
94	u_int16_t		ni_nextdtim;	/* time to next DTIM */
95	u_int16_t		ni_timoffset;
96#endif
97
98	/* others */
99	u_int16_t		ni_associd;	/* assoc response */
100	u_int16_t		ni_txseq;	/* seq to be transmitted */
101	u_int16_t		ni_rxseq;	/* seq previous received */
102	int			ni_fails;	/* failure count to associate */
103	int			ni_inact;	/* inactivity mark count */
104	int			ni_txrate;	/* index to ni_rates[] */
105};
106
107static __inline struct ieee80211_node *
108ieee80211_ref_node(struct ieee80211_node *ni)
109{
110	atomic_add_int(&ni->ni_refcnt, 1);
111	return ni;
112}
113
114static __inline void
115ieee80211_unref_node(struct ieee80211_node **ni)
116{
117	atomic_subtract_int(&(*ni)->ni_refcnt, 1);
118	*ni = NULL;			/* guard against use */
119}
120
121#define	IEEE80211_NODE_LOCK_INIT(_ic, _name) \
122	mtx_init(&(_ic)->ic_nodelock, _name, "802.11 node table", MTX_DEF)
123#define	IEEE80211_NODE_LOCK_DESTROY(_ic)	mtx_destroy(&(_ic)->ic_nodelock)
124#define	IEEE80211_NODE_LOCK(_ic)		mtx_lock(&(_ic)->ic_nodelock)
125#define	IEEE80211_NODE_UNLOCK(_ic)		mtx_unlock(&(_ic)->ic_nodelock)
126#define	IEEE80211_NODE_LOCK_ASSERT(_ic) \
127	mtx_assert(&(_ic)->ic_nodelock, MA_OWNED)
128
129struct ieee80211com;
130
131MALLOC_DECLARE(M_80211_NODE);
132
133extern	void ieee80211_node_attach(struct ifnet *);
134extern	void ieee80211_node_lateattach(struct ifnet *);
135extern	void ieee80211_node_detach(struct ifnet *);
136
137extern	void ieee80211_begin_scan(struct ifnet *);
138extern	void ieee80211_next_scan(struct ifnet *);
139extern	void ieee80211_end_scan(struct ifnet *);
140extern	struct ieee80211_node *ieee80211_alloc_node(struct ieee80211com *,
141		u_int8_t *);
142extern	struct ieee80211_node *ieee80211_dup_bss(struct ieee80211com *,
143		u_int8_t *);
144extern	struct ieee80211_node *ieee80211_find_node(struct ieee80211com *,
145		u_int8_t *);
146extern	struct ieee80211_node *ieee80211_find_txnode(struct ieee80211com *,
147		u_int8_t *);
148extern	struct ieee80211_node * ieee80211_lookup_node(struct ieee80211com *,
149		u_int8_t *macaddr, struct ieee80211_channel *);
150extern	void ieee80211_free_node(struct ieee80211com *,
151		struct ieee80211_node *);
152extern	void ieee80211_free_allnodes(struct ieee80211com *);
153typedef void ieee80211_iter_func(void *, struct ieee80211_node *);
154extern	void ieee80211_iterate_nodes(struct ieee80211com *ic,
155		ieee80211_iter_func *, void *);
156extern	void ieee80211_timeout_nodes(struct ieee80211com *);
157
158extern	void ieee80211_create_ibss(struct ieee80211com* ,
159		struct ieee80211_channel *);
160#endif /* _NET80211_IEEE80211_NODE_H_ */
161