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