ieee80211_node.h revision 186099
1/*- 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002-2008 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 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD: head/sys/net80211/ieee80211_node.h 186099 2008-12-15 00:47:24Z sam $ 27 */ 28#ifndef _NET80211_IEEE80211_NODE_H_ 29#define _NET80211_IEEE80211_NODE_H_ 30 31#include <net80211/ieee80211_ioctl.h> /* for ieee80211_nodestats */ 32#include <net80211/ieee80211_ht.h> /* for aggregation state */ 33 34/* 35 * Each ieee80211com instance has a single timer that fires every 36 * IEEE80211_INACT_WAIT seconds to handle "inactivity processing". 37 * This is used to do node inactivity processing when operating 38 * as an AP or in adhoc mode. For inactivity processing each node 39 * has a timeout set in it's ni_inact field that is decremented 40 * on each timeout and the node is reclaimed when the counter goes 41 * to zero. We use different inactivity timeout values depending 42 * on whether the node is associated and authorized (either by 43 * 802.1x or open/shared key authentication) or associated but yet 44 * to be authorized. The latter timeout is shorter to more aggressively 45 * reclaim nodes that leave part way through the 802.1x exchange. 46 */ 47#define IEEE80211_INACT_WAIT 15 /* inactivity interval (secs) */ 48#define IEEE80211_INACT_INIT (30/IEEE80211_INACT_WAIT) /* initial */ 49#define IEEE80211_INACT_AUTH (180/IEEE80211_INACT_WAIT) /* associated but not authorized */ 50#define IEEE80211_INACT_RUN (300/IEEE80211_INACT_WAIT) /* authorized */ 51#define IEEE80211_INACT_PROBE (30/IEEE80211_INACT_WAIT) /* probe */ 52#define IEEE80211_INACT_SCAN (300/IEEE80211_INACT_WAIT) /* scanned */ 53 54#define IEEE80211_TRANS_WAIT 2 /* mgt frame tx timer (secs) */ 55 56/* threshold for aging overlapping non-ERP bss */ 57#define IEEE80211_NONERP_PRESENT_AGE msecs_to_ticks(60*1000) 58 59#define IEEE80211_NODE_HASHSIZE 32 60/* simple hash is enough for variation of macaddr */ 61#define IEEE80211_NODE_HASH(addr) \ 62 (((const uint8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \ 63 IEEE80211_NODE_HASHSIZE) 64 65struct ieee80211_node_table; 66struct ieee80211com; 67struct ieee80211vap; 68 69/* 70 * Information element ``blob''. We use this structure 71 * to capture management frame payloads that need to be 72 * retained. Information elemnts within the payload that 73 * we need to consult have references recorded. 74 */ 75struct ieee80211_ies { 76 /* the following are either NULL or point within data */ 77 uint8_t *wpa_ie; /* captured WPA ie */ 78 uint8_t *rsn_ie; /* captured RSN ie */ 79 uint8_t *wme_ie; /* captured WME ie */ 80 uint8_t *ath_ie; /* captured Atheros ie */ 81 uint8_t *htcap_ie; /* captured HTCAP ie */ 82 uint8_t *htinfo_ie; /* captured HTINFO ie */ 83 /* NB: these must be the last members of this structure */ 84 uint8_t *data; /* frame data > 802.11 header */ 85 int len; /* data size in bytes */ 86}; 87 88/* 89 * Node specific information. Note that drivers are expected 90 * to derive from this structure to add device-specific per-node 91 * state. This is done by overriding the ic_node_* methods in 92 * the ieee80211com structure. 93 */ 94struct ieee80211_node { 95 struct ieee80211vap *ni_vap; /* associated vap */ 96 struct ieee80211com *ni_ic; /* copy from vap to save deref*/ 97 struct ieee80211_node_table *ni_table; /* NB: may be NULL */ 98 TAILQ_ENTRY(ieee80211_node) ni_list; /* list of all nodes */ 99 LIST_ENTRY(ieee80211_node) ni_hash; /* hash collision list */ 100 u_int ni_refcnt; /* count of held references */ 101 u_int ni_scangen; /* gen# for timeout scan */ 102 u_int ni_flags; 103#define IEEE80211_NODE_AUTH 0x000001 /* authorized for data */ 104#define IEEE80211_NODE_QOS 0x000002 /* QoS enabled */ 105#define IEEE80211_NODE_ERP 0x000004 /* ERP enabled */ 106/* NB: this must have the same value as IEEE80211_FC1_PWR_MGT */ 107#define IEEE80211_NODE_PWR_MGT 0x000010 /* power save mode enabled */ 108#define IEEE80211_NODE_AREF 0x000020 /* authentication ref held */ 109#define IEEE80211_NODE_HT 0x000040 /* HT enabled */ 110#define IEEE80211_NODE_HTCOMPAT 0x000080 /* HT setup w/ vendor OUI's */ 111#define IEEE80211_NODE_WPS 0x000100 /* WPS association */ 112#define IEEE80211_NODE_TSN 0x000200 /* TSN association */ 113#define IEEE80211_NODE_AMPDU_RX 0x000400 /* AMPDU rx enabled */ 114#define IEEE80211_NODE_AMPDU_TX 0x000800 /* AMPDU tx enabled */ 115#define IEEE80211_NODE_MIMO_PS 0x001000 /* MIMO power save enabled */ 116#define IEEE80211_NODE_MIMO_RTS 0x002000 /* send RTS in MIMO PS */ 117#define IEEE80211_NODE_RIFS 0x004000 /* RIFS enabled */ 118#define IEEE80211_NODE_SGI20 0x008000 /* Short GI in HT20 enabled */ 119#define IEEE80211_NODE_SGI40 0x010000 /* Short GI in HT40 enabled */ 120#define IEEE80211_NODE_ASSOCID 0x020000 /* xmit requires associd */ 121 uint16_t ni_associd; /* association ID */ 122 uint16_t ni_vlan; /* vlan tag */ 123 uint16_t ni_txpower; /* current transmit power */ 124 uint8_t ni_authmode; /* authentication algorithm */ 125 uint8_t ni_ath_flags; /* Atheros feature flags */ 126 /* NB: These must have the same values as IEEE80211_ATHC_* */ 127#define IEEE80211_NODE_TURBOP 0x0001 /* Turbo prime enable */ 128#define IEEE80211_NODE_COMP 0x0002 /* Compresssion enable */ 129#define IEEE80211_NODE_FF 0x0004 /* Fast Frame capable */ 130#define IEEE80211_NODE_XR 0x0008 /* Atheros WME enable */ 131#define IEEE80211_NODE_AR 0x0010 /* AR capable */ 132#define IEEE80211_NODE_BOOST 0x0080 /* Dynamic Turbo boosted */ 133 uint16_t ni_ath_defkeyix;/* Atheros def key index */ 134 const struct ieee80211_txparam *ni_txparms; 135 uint32_t ni_jointime; /* time of join (secs) */ 136 uint32_t *ni_challenge; /* shared-key challenge */ 137 struct ieee80211_ies ni_ies; /* captured ie's */ 138 /* tx seq per-tid */ 139 uint16_t ni_txseqs[IEEE80211_TID_SIZE]; 140 /* rx seq previous per-tid*/ 141 uint16_t ni_rxseqs[IEEE80211_TID_SIZE]; 142 uint32_t ni_rxfragstamp; /* time stamp of last rx frag */ 143 struct mbuf *ni_rxfrag[3]; /* rx frag reassembly */ 144 struct ieee80211_key ni_ucastkey; /* unicast key */ 145 146 /* hardware */ 147 uint32_t ni_rstamp; /* recv timestamp */ 148 uint32_t ni_avgrssi; /* recv ssi state */ 149 int8_t ni_noise; /* noise floor */ 150 151 /* header */ 152 uint8_t ni_macaddr[IEEE80211_ADDR_LEN]; 153 uint8_t ni_bssid[IEEE80211_ADDR_LEN]; 154 155 /* beacon, probe response */ 156 union { 157 uint8_t data[8]; 158 u_int64_t tsf; 159 } ni_tstamp; /* from last rcv'd beacon */ 160 uint16_t ni_intval; /* beacon interval */ 161 uint16_t ni_capinfo; /* capabilities */ 162 uint8_t ni_esslen; 163 uint8_t ni_essid[IEEE80211_NWID_LEN]; 164 struct ieee80211_rateset ni_rates; /* negotiated rate set */ 165 struct ieee80211_channel *ni_chan; 166 uint16_t ni_fhdwell; /* FH only */ 167 uint8_t ni_fhindex; /* FH only */ 168 uint16_t ni_erp; /* ERP from beacon/probe resp */ 169 uint16_t ni_timoff; /* byte offset to TIM ie */ 170 uint8_t ni_dtim_period; /* DTIM period */ 171 uint8_t ni_dtim_count; /* DTIM count for last bcn */ 172 173 /* 11n state */ 174 uint16_t ni_htcap; /* HT capabilities */ 175 uint8_t ni_htparam; /* HT params */ 176 uint8_t ni_htctlchan; /* HT control channel */ 177 uint8_t ni_ht2ndchan; /* HT 2nd channel */ 178 uint8_t ni_htopmode; /* HT operating mode */ 179 uint8_t ni_htstbc; /* HT */ 180 uint8_t ni_chw; /* negotiated channel width */ 181 struct ieee80211_htrateset ni_htrates; /* negotiated ht rate set */ 182 struct ieee80211_tx_ampdu ni_tx_ampdu[WME_NUM_AC]; 183 struct ieee80211_rx_ampdu ni_rx_ampdu[WME_NUM_TID]; 184 185 /* others */ 186 short ni_inact; /* inactivity mark count */ 187 short ni_inact_reload;/* inactivity reload value */ 188 int ni_txrate; /* legacy rate/MCS */ 189 struct ieee80211_psq ni_psq; /* power save queue */ 190 struct ieee80211_nodestats ni_stats; /* per-node statistics */ 191 192 struct ieee80211vap *ni_wdsvap; /* associated WDS vap */ 193 /* XXX move to vap? */ 194 struct ifqueue ni_wdsq; /* wds pending queue */ 195}; 196MALLOC_DECLARE(M_80211_NODE); 197MALLOC_DECLARE(M_80211_NODE_IE); 198 199#define IEEE80211_NODE_ATH (IEEE80211_NODE_FF | IEEE80211_NODE_TURBOP) 200#define IEEE80211_NODE_AMPDU \ 201 (IEEE80211_NODE_AMPDU_RX | IEEE80211_NODE_AMPDU_TX) 202#define IEEE80211_NODE_HT_ALL \ 203 (IEEE80211_NODE_HT | IEEE80211_NODE_HTCOMPAT | \ 204 IEEE80211_NODE_AMPDU | IEEE80211_NODE_MIMO_PS | \ 205 IEEE80211_NODE_MIMO_RTS | IEEE80211_NODE_RIFS | \ 206 IEEE80211_NODE_SGI20 | IEEE80211_NODE_SGI40) 207 208#define IEEE80211_NODE_AID(ni) IEEE80211_AID(ni->ni_associd) 209 210#define IEEE80211_NODE_STAT(ni,stat) (ni->ni_stats.ns_##stat++) 211#define IEEE80211_NODE_STAT_ADD(ni,stat,v) (ni->ni_stats.ns_##stat += v) 212#define IEEE80211_NODE_STAT_SET(ni,stat,v) (ni->ni_stats.ns_##stat = v) 213 214/* 215 * Filtered rssi calculation support. The receive rssi is maintained 216 * as an average over the last 10 frames received using a low pass filter 217 * (all frames for now, possibly need to be more selective). Calculations 218 * are designed such that a good compiler can optimize them. The avg 219 * rssi state should be initialized to IEEE80211_RSSI_DUMMY_MARKER and 220 * each sample incorporated with IEEE80211_RSSI_LPF. Use IEEE80211_RSSI_GET 221 * to extract the current value. 222 * 223 * Note that we assume rssi data are in the range [-127..127] and we 224 * discard values <-20. This is consistent with assumptions throughout 225 * net80211 that signal strength data are in .5 dBm units relative to 226 * the current noise floor (linear, not log). 227 */ 228#define IEEE80211_RSSI_LPF_LEN 10 229#define IEEE80211_RSSI_DUMMY_MARKER 127 230/* NB: pow2 to optimize out * and / */ 231#define IEEE80211_RSSI_EP_MULTIPLIER (1<<7) 232#define IEEE80211_RSSI_IN(x) ((x) * IEEE80211_RSSI_EP_MULTIPLIER) 233#define _IEEE80211_RSSI_LPF(x, y, len) \ 234 (((x) != IEEE80211_RSSI_DUMMY_MARKER) ? (((x) * ((len) - 1) + (y)) / (len)) : (y)) 235#define IEEE80211_RSSI_LPF(x, y) do { \ 236 if ((y) >= -20) { \ 237 x = _IEEE80211_RSSI_LPF((x), IEEE80211_RSSI_IN((y)), \ 238 IEEE80211_RSSI_LPF_LEN); \ 239 } \ 240} while (0) 241#define IEEE80211_RSSI_EP_RND(x, mul) \ 242 ((((x) % (mul)) >= ((mul)/2)) ? ((x) + ((mul) - 1)) / (mul) : (x)/(mul)) 243#define IEEE80211_RSSI_GET(x) \ 244 IEEE80211_RSSI_EP_RND(x, IEEE80211_RSSI_EP_MULTIPLIER) 245 246static __inline struct ieee80211_node * 247ieee80211_ref_node(struct ieee80211_node *ni) 248{ 249 ieee80211_node_incref(ni); 250 return ni; 251} 252 253static __inline void 254ieee80211_unref_node(struct ieee80211_node **ni) 255{ 256 ieee80211_node_decref(*ni); 257 *ni = NULL; /* guard against use */ 258} 259 260struct ieee80211com; 261 262void ieee80211_node_attach(struct ieee80211com *); 263void ieee80211_node_lateattach(struct ieee80211com *); 264void ieee80211_node_detach(struct ieee80211com *); 265void ieee80211_node_vattach(struct ieee80211vap *); 266void ieee80211_node_latevattach(struct ieee80211vap *); 267void ieee80211_node_vdetach(struct ieee80211vap *); 268 269static __inline int 270ieee80211_node_is_authorized(const struct ieee80211_node *ni) 271{ 272 return (ni->ni_flags & IEEE80211_NODE_AUTH); 273} 274 275void ieee80211_node_authorize(struct ieee80211_node *); 276void ieee80211_node_unauthorize(struct ieee80211_node *); 277 278void ieee80211_node_set_chan(struct ieee80211_node *, 279 struct ieee80211_channel *); 280void ieee80211_create_ibss(struct ieee80211vap*, struct ieee80211_channel *); 281void ieee80211_reset_bss(struct ieee80211vap *); 282void ieee80211_sync_curchan(struct ieee80211com *); 283void ieee80211_setcurchan(struct ieee80211com *, struct ieee80211_channel *); 284int ieee80211_ibss_merge(struct ieee80211_node *); 285struct ieee80211_scan_entry; 286int ieee80211_sta_join(struct ieee80211vap *, struct ieee80211_channel *, 287 const struct ieee80211_scan_entry *); 288void ieee80211_sta_leave(struct ieee80211_node *); 289void ieee80211_node_deauth(struct ieee80211_node *, int); 290 291int ieee80211_ies_init(struct ieee80211_ies *, const uint8_t *, int); 292void ieee80211_ies_cleanup(struct ieee80211_ies *); 293void ieee80211_ies_expand(struct ieee80211_ies *); 294#define ieee80211_ies_setie(_ies, _ie, _off) do { \ 295 (_ies)._ie = (_ies).data + (_off); \ 296} while (0) 297 298/* 299 * Table of ieee80211_node instances. Each ieee80211com 300 * has one that holds association stations (when operating 301 * as an ap) or neighbors (in ibss mode). 302 * 303 * XXX embed this in ieee80211com instead of indirect? 304 */ 305struct ieee80211_node_table { 306 struct ieee80211com *nt_ic; /* back reference */ 307 ieee80211_node_lock_t nt_nodelock; /* on node table */ 308 TAILQ_HEAD(, ieee80211_node) nt_node; /* information of all nodes */ 309 LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE]; 310 struct ieee80211_node **nt_keyixmap; /* key ix -> node map */ 311 int nt_keyixmax; /* keyixmap size */ 312 const char *nt_name; /* table name for debug msgs */ 313 ieee80211_scan_lock_t nt_scanlock; /* on nt_scangen */ 314 u_int nt_scangen; /* gen# for iterators */ 315 int nt_inact_init; /* initial node inact setting */ 316}; 317 318struct ieee80211_node *ieee80211_alloc_node(struct ieee80211_node_table *, 319 struct ieee80211vap *, 320 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 321struct ieee80211_node *ieee80211_tmp_node(struct ieee80211vap *, 322 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 323struct ieee80211_node *ieee80211_dup_bss(struct ieee80211vap *, 324 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 325struct ieee80211_node *ieee80211_node_create_wds(struct ieee80211vap *, 326 const uint8_t bssid[IEEE80211_ADDR_LEN], 327 struct ieee80211_channel *); 328#ifdef IEEE80211_DEBUG_REFCNT 329void ieee80211_free_node_debug(struct ieee80211_node *, 330 const char *func, int line); 331struct ieee80211_node *ieee80211_find_node_locked_debug( 332 struct ieee80211_node_table *, 333 const uint8_t macaddr[IEEE80211_ADDR_LEN], 334 const char *func, int line); 335struct ieee80211_node *ieee80211_find_node_debug(struct ieee80211_node_table *, 336 const uint8_t macaddr[IEEE80211_ADDR_LEN], 337 const char *func, int line); 338struct ieee80211_node *ieee80211_find_vap_node_locked_debug( 339 struct ieee80211_node_table *, 340 const struct ieee80211vap *vap, 341 const uint8_t macaddr[IEEE80211_ADDR_LEN], 342 const char *func, int line); 343struct ieee80211_node *ieee80211_find_vap_node_debug( 344 struct ieee80211_node_table *, 345 const struct ieee80211vap *vap, 346 const uint8_t macaddr[IEEE80211_ADDR_LEN], 347 const char *func, int line); 348struct ieee80211_node * ieee80211_find_rxnode_debug(struct ieee80211com *, 349 const struct ieee80211_frame_min *, 350 const char *func, int line); 351struct ieee80211_node * ieee80211_find_rxnode_withkey_debug( 352 struct ieee80211com *, 353 const struct ieee80211_frame_min *, uint16_t keyix, 354 const char *func, int line); 355struct ieee80211_node *ieee80211_find_txnode_debug(struct ieee80211vap *, 356 const uint8_t *, 357 const char *func, int line); 358#define ieee80211_free_node(ni) \ 359 ieee80211_free_node_debug(ni, __func__, __LINE__) 360#define ieee80211_find_node_locked(nt, mac) \ 361 ieee80211_find_node_locked_debug(nt, mac, __func__, __LINE__) 362#define ieee80211_find_node(nt, mac) \ 363 ieee80211_find_node_debug(nt, mac, __func__, __LINE__) 364#define ieee80211_find_vap_node_locked(nt, vap, mac) \ 365 ieee80211_find_vap_node_locked_debug(nt, vap, mac, __func__, __LINE__) 366#define ieee80211_find_vap_node(nt, vap, mac) \ 367 ieee80211_find_vap_node_debug(nt, vap, mac, __func__, __LINE__) 368#define ieee80211_find_rxnode(ic, wh) \ 369 ieee80211_find_rxnode_debug(ic, wh, __func__, __LINE__) 370#define ieee80211_find_rxnode_withkey(ic, wh, keyix) \ 371 ieee80211_find_rxnode_withkey_debug(ic, wh, keyix, __func__, __LINE__) 372#define ieee80211_find_txnode(vap, mac) \ 373 ieee80211_find_txnode_debug(vap, mac, __func__, __LINE__) 374#else 375void ieee80211_free_node(struct ieee80211_node *); 376struct ieee80211_node *ieee80211_find_node_locked(struct ieee80211_node_table *, 377 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 378struct ieee80211_node *ieee80211_find_node(struct ieee80211_node_table *, 379 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 380struct ieee80211_node *ieee80211_find_vap_node_locked( 381 struct ieee80211_node_table *, const struct ieee80211vap *, 382 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 383struct ieee80211_node *ieee80211_find_vap_node( 384 struct ieee80211_node_table *, const struct ieee80211vap *, 385 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 386struct ieee80211_node * ieee80211_find_rxnode(struct ieee80211com *, 387 const struct ieee80211_frame_min *); 388struct ieee80211_node * ieee80211_find_rxnode_withkey(struct ieee80211com *, 389 const struct ieee80211_frame_min *, uint16_t keyix); 390struct ieee80211_node *ieee80211_find_txnode(struct ieee80211vap *, 391 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 392#endif 393int ieee80211_node_delucastkey(struct ieee80211_node *); 394void ieee80211_node_timeout(void *arg); 395 396typedef void ieee80211_iter_func(void *, struct ieee80211_node *); 397void ieee80211_iterate_nodes(struct ieee80211_node_table *, 398 ieee80211_iter_func *, void *); 399 400void ieee80211_notify_erp(struct ieee80211com *); 401void ieee80211_dump_node(struct ieee80211_node_table *, 402 struct ieee80211_node *); 403void ieee80211_dump_nodes(struct ieee80211_node_table *); 404 405struct ieee80211_node *ieee80211_fakeup_adhoc_node(struct ieee80211vap *, 406 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 407struct ieee80211_scanparams; 408void ieee80211_init_neighbor(struct ieee80211_node *, 409 const struct ieee80211_frame *, 410 const struct ieee80211_scanparams *); 411struct ieee80211_node *ieee80211_add_neighbor(struct ieee80211vap *, 412 const struct ieee80211_frame *, 413 const struct ieee80211_scanparams *); 414void ieee80211_node_join(struct ieee80211_node *,int); 415void ieee80211_node_leave(struct ieee80211_node *); 416int8_t ieee80211_getrssi(struct ieee80211vap *); 417void ieee80211_getsignal(struct ieee80211vap *, int8_t *, int8_t *); 418#endif /* _NET80211_IEEE80211_NODE_H_ */ 419