1 /* $NetBSD: ieee80211_node.h,v 1.22 2006/06/30 06:17:10 tacha Exp $ */
2 /*-
3 * Copyright (c) 2001 Atsushi Onoe
4 * Copyright (c) 2002-2005 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.22 2005/08/10 16:22:29 sam Exp $
34 */
35 #ifndef _NET80211_IEEE80211_NODE_H_
36 #define _NET80211_IEEE80211_NODE_H_
37
38 #include <net80211/ieee80211_netbsd.h>
39 #include <net80211/ieee80211_ioctl.h> /* for ieee80211_nodestats */
40
41 /*
42 * Each ieee80211com instance has a single timer that fires once a
43 * second. This is used to initiate various work depending on the
44 * state of the instance: scanning (passive or active), ``transition''
45 * (waiting for a response to a management frame when operating
46 * as a station), and node inactivity processing (when operating
47 * as an AP). For inactivity processing each node has a timeout
48 * set in it's ni_inact field that is decremented on each timeout
49 * and the node is reclaimed when the counter goes to zero. We
50 * use different inactivity timeout values depending on whether
51 * the node is associated and authorized (either by 802.1x or
52 * open/shared key authentication) or associated but yet to be
53 * authorized. The latter timeout is shorter to more aggressively
54 * reclaim nodes that leave part way through the 802.1x exchange.
55 */
56 #define IEEE80211_INACT_WAIT 15 /* inactivity interval (secs) */
57 #define IEEE80211_INACT_INIT (30/IEEE80211_INACT_WAIT) /* initial */
58 #define IEEE80211_INACT_AUTH (180/IEEE80211_INACT_WAIT) /* associated but not authorized */
59 #define IEEE80211_INACT_RUN (300/IEEE80211_INACT_WAIT) /* authorized */
60 #define IEEE80211_INACT_PROBE (30/IEEE80211_INACT_WAIT) /* probe */
61 #define IEEE80211_INACT_SCAN (300/IEEE80211_INACT_WAIT) /* scanned */
62
63 #define IEEE80211_TRANS_WAIT 5 /* mgt frame tx timer (secs) */
64
65 #define IEEE80211_NODE_HASHSIZE 32
66 /* simple hash is enough for variation of macaddr */
67 #define IEEE80211_NODE_HASH(addr) \
68 (((const u_int8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \
69 IEEE80211_NODE_HASHSIZE)
70
71 struct ieee80211_rsnparms {
72 u_int8_t rsn_mcastcipher; /* mcast/group cipher */
73 u_int8_t rsn_mcastkeylen; /* mcast key length */
74 u_int8_t rsn_ucastcipherset; /* unicast cipher set */
75 u_int8_t rsn_ucastcipher; /* selected unicast cipher */
76 u_int8_t rsn_ucastkeylen; /* unicast key length */
77 u_int8_t rsn_keymgmtset; /* key mangement algorithms */
78 u_int8_t rsn_keymgmt; /* selected key mgmt algo */
79 u_int16_t rsn_caps; /* capabilities */
80 };
81
82 struct ieee80211_node_table;
83 struct ieee80211com;
84
85 /*
86 * Node specific information. Note that drivers are expected
87 * to derive from this structure to add device-specific per-node
88 * state. This is done by overriding the ic_node_* methods in
89 * the ieee80211com structure.
90 */
91 struct ieee80211_node {
92 struct ieee80211com *ni_ic;
93 struct ieee80211_node_table *ni_table;
94 TAILQ_ENTRY(ieee80211_node) ni_list;
95 LIST_ENTRY(ieee80211_node) ni_hash;
96 u_int ni_refcnt;
97 u_int ni_scangen; /* gen# for timeout scan */
98 u_int8_t ni_authmode; /* authentication algorithm */
99 u_int16_t ni_flags; /* special-purpose state */
100 #define IEEE80211_NODE_AUTH 0x0001 /* authorized for data */
101 #define IEEE80211_NODE_QOS 0x0002 /* QoS enabled */
102 #define IEEE80211_NODE_ERP 0x0004 /* ERP enabled */
103 /* NB: this must have the same value as IEEE80211_FC1_PWR_MGT */
104 #define IEEE80211_NODE_PWR_MGT 0x0010 /* power save mode enabled */
105 #define IEEE80211_NODE_AREF 0x0020 /* authentication ref held */
106 u_int16_t ni_associd; /* assoc response */
107 u_int16_t ni_txpower; /* current transmit power */
108 u_int16_t ni_vlan; /* vlan tag */
109 u_int32_t *ni_challenge; /* shared-key challenge */
110 u_int8_t *ni_wpa_ie; /* captured WPA/RSN ie */
111 u_int8_t *ni_wme_ie; /* captured WME ie */
112 u_int16_t ni_txseqs[17]; /* tx seq per-tid */
113 u_int16_t ni_rxseqs[17]; /* rx seq previous per-tid*/
114 u_int32_t ni_rxfragstamp; /* time stamp of last rx frag */
115 struct mbuf *ni_rxfrag[3]; /* rx frag reassembly */
116 struct ieee80211_rsnparms ni_rsn; /* RSN/WPA parameters */
117 struct ieee80211_key ni_ucastkey; /* unicast key */
118
119 /* hardware */
120 u_int32_t ni_rstamp; /* recv timestamp */
121 u_int8_t ni_rssi; /* recv ssi */
122
123 /* header */
124 u_int8_t ni_macaddr[IEEE80211_ADDR_LEN];
125 u_int8_t ni_bssid[IEEE80211_ADDR_LEN];
126
127 /* beacon, probe response */
128 union {
129 u_int8_t data[8];
130 u_int64_t tsf;
131 } ni_tstamp; /* from last rcv'd beacon */
132 u_int16_t ni_intval; /* beacon interval */
133 u_int16_t ni_capinfo; /* capabilities */
134 u_int8_t ni_esslen;
135 u_int8_t ni_essid[IEEE80211_NWID_LEN];
136 struct ieee80211_rateset ni_rates; /* negotiated rate set */
137 struct ieee80211_channel *ni_chan; /* XXX multiple uses */
138 u_int16_t ni_fhdwell; /* FH only */
139 u_int8_t ni_fhindex; /* FH only */
140 u_int8_t ni_erp; /* ERP from beacon/probe resp */
141 u_int16_t ni_timoff; /* byte offset to TIM ie */
142 u_int8_t ni_dtim_period; /* DTIM period */
143 u_int8_t ni_dtim_count; /* DTIM count for last bcn */
144
145 /* others */
146 int ni_fails; /* failure count to associate */
147 short ni_inact; /* inactivity mark count */
148 short ni_inact_reload;/* inactivity reload value */
149 int ni_txrate; /* index to ni_rates[] */
150 struct ifqueue ni_savedq; /* ps-poll queue */
151 struct ieee80211_nodestats ni_stats; /* per-node statistics */
152 };
153 #ifdef _KERNEL
154 MALLOC_DECLARE(M_80211_NODE);
155 #endif /* _KERNEL */
156
157 #define IEEE80211_NODE_AID(ni) IEEE80211_AID(ni->ni_associd)
158
159 #define IEEE80211_NODE_STAT(ni,stat) (ni->ni_stats.ns_##stat++)
160 #define IEEE80211_NODE_STAT_ADD(ni,stat,v) (ni->ni_stats.ns_##stat += v)
161 #define IEEE80211_NODE_STAT_SET(ni,stat,v) (ni->ni_stats.ns_##stat = v)
162
163 static __inline struct ieee80211_node *
164 ieee80211_ref_node(struct ieee80211_node *ni)
165 {
166 ieee80211_node_incref(ni);
167 return ni;
168 }
169
170 static __inline void
171 ieee80211_unref_node(struct ieee80211_node **ni)
172 {
173 ieee80211_node_decref(*ni);
174 *ni = NULL; /* guard against use */
175 }
176
177 struct ieee80211com;
178
179 void ieee80211_node_attach(struct ieee80211com *);
180 void ieee80211_node_lateattach(struct ieee80211com *);
181 void ieee80211_node_detach(struct ieee80211com *);
182
183 static __inline int
184 ieee80211_node_is_authorized(const struct ieee80211_node *ni)
185 {
186 return (ni->ni_flags & IEEE80211_NODE_AUTH);
187 }
188
189 void ieee80211_node_authorize(struct ieee80211_node *);
190 void ieee80211_node_unauthorize(struct ieee80211_node *);
191
192 void ieee80211_begin_scan(struct ieee80211com *, int);
193 int ieee80211_next_scan(struct ieee80211com *);
194 void ieee80211_probe_curchan(struct ieee80211com *, int);
195 void ieee80211_create_ibss(struct ieee80211com*, struct ieee80211_channel *);
196 void ieee80211_reset_bss(struct ieee80211com *);
197 void ieee80211_cancel_scan(struct ieee80211com *);
198 void ieee80211_end_scan(struct ieee80211com *);
199 int ieee80211_ibss_merge(struct ieee80211_node *);
200 int ieee80211_sta_join(struct ieee80211com *, struct ieee80211_node *);
201 void ieee80211_sta_leave(struct ieee80211com *, struct ieee80211_node *);
202
203 /*
204 * Table of ieee80211_node instances. Each ieee80211com
205 * has at least one for holding the scan candidates.
206 * When operating as an access point or in ibss mode there
207 * is a second table for associated stations or neighbors.
208 */
209 struct ieee80211_node_table {
210 struct ieee80211com *nt_ic; /* back reference */
211 ieee80211_node_lock_t nt_nodelock; /* on node table */
212 TAILQ_HEAD(, ieee80211_node) nt_node; /* information of all nodes */
213 LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE];
214 const char *nt_name; /* for debugging */
215 ieee80211_scan_lock_t nt_scanlock; /* on nt_scangen */
216 u_int nt_scangen; /* gen# for timeout scan */
217 int nt_inact_timer; /* inactivity timer */
218 int nt_inact_init; /* initial node inact setting */
219 struct ieee80211_node **nt_keyixmap; /* key ix -> node map */
220 int nt_keyixmax; /* keyixmap size */
221
222 void (*nt_timeout)(struct ieee80211_node_table *);
223 };
224 void ieee80211_node_table_reset(struct ieee80211_node_table *);
225
226 struct ieee80211_node *ieee80211_alloc_node(
227 struct ieee80211_node_table *, const u_int8_t *);
228 struct ieee80211_node *ieee80211_tmp_node(struct ieee80211com *,
229 const u_int8_t *macaddr);
230 struct ieee80211_node *ieee80211_dup_bss(struct ieee80211_node_table *,
231 const u_int8_t *);
232 #ifdef IEEE80211_DEBUG_REFCNT
233 void ieee80211_free_node_debug(struct ieee80211_node *,
234 const char *func, int line);
235 struct ieee80211_node *ieee80211_find_node_debug(
236 struct ieee80211_node_table *, const u_int8_t *,
237 const char *func, int line);
238 struct ieee80211_node * ieee80211_find_rxnode_debug(
239 struct ieee80211com *, const struct ieee80211_frame_min *,
240 const char *func, int line);
241 struct ieee80211_node * ieee80211_find_rxnode_withkey_debug(
242 struct ieee80211com *,
243 const struct ieee80211_frame_min *, u_int16_t keyix,
244 const char *func, int line);
245 struct ieee80211_node *ieee80211_find_txnode_debug(
246 struct ieee80211com *, const u_int8_t *,
247 const char *func, int line);
248 struct ieee80211_node *ieee80211_find_node_with_channel_debug(
249 struct ieee80211_node_table *, const u_int8_t *macaddr,
250 struct ieee80211_channel *, const char *func, int line);
251 struct ieee80211_node *ieee80211_find_node_with_ssid_debug(
252 struct ieee80211_node_table *, const u_int8_t *macaddr,
253 u_int ssidlen, const u_int8_t *ssid,
254 const char *func, int line);
255 #define ieee80211_free_node(ni) \
256 ieee80211_free_node_debug(ni, __func__, __LINE__)
257 #define ieee80211_find_node(nt, mac) \
258 ieee80211_find_node_debug(nt, mac, __func__, __LINE__)
259 #define ieee80211_find_rxnode(nt, wh) \
260 ieee80211_find_rxnode_debug(nt, wh, __func__, __LINE__)
261 #define ieee80211_find_rxnode_withkey(nt, wh, keyix) \
262 ieee80211_find_rxnode_withkey_debug(nt, wh, keyix, __func__, __LINE__)
263 #define ieee80211_find_txnode(nt, mac) \
264 ieee80211_find_txnode_debug(nt, mac, __func__, __LINE__)
265 #define ieee80211_find_node_with_channel(nt, mac, c) \
266 ieee80211_find_node_with_channel_debug(nt, mac, c, __func__, __LINE__)
267 #define ieee80211_find_node_with_ssid(nt, mac, sl, ss) \
268 ieee80211_find_node_with_ssid_debug(nt, mac, sl, ss, __func__, __LINE__)
269 #else
270 void ieee80211_free_node(struct ieee80211_node *);
271 struct ieee80211_node *ieee80211_find_node(
272 struct ieee80211_node_table *, const u_int8_t *);
273 struct ieee80211_node * ieee80211_find_rxnode(
274 struct ieee80211com *, const struct ieee80211_frame_min *);
275 struct ieee80211_node * ieee80211_find_rxnode_withkey(struct ieee80211com *,
276 const struct ieee80211_frame_min *, u_int16_t keyix);
277 struct ieee80211_node *ieee80211_find_txnode(
278 struct ieee80211com *, const u_int8_t *);
279 struct ieee80211_node *ieee80211_find_node_with_channel(
280 struct ieee80211_node_table *, const u_int8_t *macaddr,
281 struct ieee80211_channel *);
282 struct ieee80211_node *ieee80211_find_node_with_ssid(
283 struct ieee80211_node_table *, const u_int8_t *macaddr,
284 u_int ssidlen, const u_int8_t *ssid);
285 #endif
286 int ieee80211_node_delucastkey(struct ieee80211_node *);
287
288 struct ieee80211_node *ieee80211_refine_node_for_beacon(
289 struct ieee80211com *, struct ieee80211_node *,
290 struct ieee80211_channel *, const u_int8_t *ssid);
291 typedef void ieee80211_iter_func(void *, struct ieee80211_node *);
292 void ieee80211_iterate_nodes(struct ieee80211_node_table *,
293 ieee80211_iter_func *, void *);
294
295 void ieee80211_dump_node(struct ieee80211_node_table *,
296 struct ieee80211_node *);
297 void ieee80211_dump_nodes(struct ieee80211_node_table *);
298
299 struct ieee80211_node *ieee80211_fakeup_adhoc_node(
300 struct ieee80211_node_table *, const u_int8_t macaddr[]);
301 void ieee80211_node_join(struct ieee80211com *, struct ieee80211_node *,int);
302 void ieee80211_node_leave(struct ieee80211com *, struct ieee80211_node *);
303 u_int8_t ieee80211_getrssi(struct ieee80211com *ic);
304
305 /*
306 * Parameters supplied when adding/updating an entry in a
307 * scan cache. Pointer variables should be set to NULL
308 * if no data is available. Pointer references can be to
309 * local data; any information that is saved will be copied.
310 * All multi-byte values must be in host byte order.
311 */
312 struct ieee80211_scanparams {
313 u_int16_t capinfo; /* 802.11 capabilities */
314 u_int16_t fhdwell; /* FHSS dwell interval */
315 u_int8_t chan; /* */
316 u_int8_t bchan;
317 u_int8_t fhindex;
318 u_int8_t erp;
319 u_int16_t bintval;
320 u_int8_t timoff;
321 u_int8_t *tim;
322 u_int8_t *tstamp;
323 u_int8_t *country;
324 u_int8_t *ssid;
325 u_int8_t *rates;
326 u_int8_t *xrates;
327 u_int8_t *wpa;
328 u_int8_t *wme;
329 };
330
331 void ieee80211_add_scan(struct ieee80211com *,
332 const struct ieee80211_scanparams *,
333 const struct ieee80211_frame *,
334 int subtype, int rssi, int rstamp);
335 void ieee80211_init_neighbor(struct ieee80211com *, struct ieee80211_node *,
336 const struct ieee80211_frame *,
337 const struct ieee80211_scanparams *, int);
338 struct ieee80211_node *ieee80211_add_neighbor(struct ieee80211com *,
339 const struct ieee80211_frame *,
340 const struct ieee80211_scanparams *);
341 #endif /* !_NET80211_IEEE80211_NODE_H_ */
Cache object: 9116c9f8e3c48873c759e58f9c8670a4
|