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