ieee80211_node.h revision 172211
1215976Sjmallett/*- 2232812Sjmallett * Copyright (c) 2001 Atsushi Onoe 3215976Sjmallett * Copyright (c) 2002-2007 Sam Leffler, Errno Consulting 4215976Sjmallett * All rights reserved. 5215976Sjmallett * 6215976Sjmallett * Redistribution and use in source and binary forms, with or without 7215976Sjmallett * modification, are permitted provided that the following conditions 8215976Sjmallett * are met: 9215976Sjmallett * 1. Redistributions of source code must retain the above copyright 10215976Sjmallett * notice, this list of conditions and the following disclaimer. 11215976Sjmallett * 2. Redistributions in binary form must reproduce the above copyright 12215976Sjmallett * notice, this list of conditions and the following disclaimer in the 13215976Sjmallett * documentation and/or other materials provided with the distribution. 14215976Sjmallett * 15215976Sjmallett * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16215976Sjmallett * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17215976Sjmallett * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18232812Sjmallett * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19215976Sjmallett * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20215976Sjmallett * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21215976Sjmallett * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22215976Sjmallett * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23215976Sjmallett * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24215976Sjmallett * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25215976Sjmallett * 26215976Sjmallett * $FreeBSD: head/sys/net80211/ieee80211_node.h 172211 2007-09-17 19:07:24Z sam $ 27215976Sjmallett */ 28215976Sjmallett#ifndef _NET80211_IEEE80211_NODE_H_ 29232812Sjmallett#define _NET80211_IEEE80211_NODE_H_ 30215976Sjmallett 31215976Sjmallett#include <net80211/ieee80211_ioctl.h> /* for ieee80211_nodestats */ 32215976Sjmallett#include <net80211/ieee80211_ht.h> /* for aggregation state */ 33215976Sjmallett 34215976Sjmallett/* 35215976Sjmallett * Each ieee80211com instance has a single timer that fires once a 36215976Sjmallett * second. This is used to initiate various work depending on the 37215976Sjmallett * state of the instance: scanning (passive or active), ``transition'' 38215976Sjmallett * (waiting for a response to a management frame when operating 39215976Sjmallett * as a station), and node inactivity processing (when operating 40215976Sjmallett * as an AP). For inactivity processing each node has a timeout 41215976Sjmallett * set in it's ni_inact field that is decremented on each timeout 42215976Sjmallett * and the node is reclaimed when the counter goes to zero. We 43215976Sjmallett * use different inactivity timeout values depending on whether 44215976Sjmallett * the node is associated and authorized (either by 802.1x or 45215976Sjmallett * open/shared key authentication) or associated but yet to be 46215976Sjmallett * authorized. The latter timeout is shorter to more aggressively 47215976Sjmallett * reclaim nodes that leave part way through the 802.1x exchange. 48215976Sjmallett */ 49215976Sjmallett#define IEEE80211_INACT_WAIT 15 /* inactivity interval (secs) */ 50215976Sjmallett#define IEEE80211_INACT_INIT (30/IEEE80211_INACT_WAIT) /* initial */ 51232812Sjmallett#define IEEE80211_INACT_AUTH (180/IEEE80211_INACT_WAIT) /* associated but not authorized */ 52215976Sjmallett#define IEEE80211_INACT_RUN (300/IEEE80211_INACT_WAIT) /* authorized */ 53215976Sjmallett#define IEEE80211_INACT_PROBE (30/IEEE80211_INACT_WAIT) /* probe */ 54215976Sjmallett#define IEEE80211_INACT_SCAN (300/IEEE80211_INACT_WAIT) /* scanned */ 55232812Sjmallett 56232812Sjmallett#define IEEE80211_TRANS_WAIT 2 /* mgt frame tx timer (secs) */ 57215976Sjmallett 58215976Sjmallett/* threshold for aging overlapping non-ERP bss */ 59215976Sjmallett#define IEEE80211_NONERP_PRESENT_AGE msecs_to_ticks(60*1000) 60215976Sjmallett 61215976Sjmallett#define IEEE80211_NODE_HASHSIZE 32 62215976Sjmallett/* simple hash is enough for variation of macaddr */ 63215976Sjmallett#define IEEE80211_NODE_HASH(addr) \ 64215976Sjmallett (((const uint8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \ 65215976Sjmallett IEEE80211_NODE_HASHSIZE) 66215976Sjmallett 67232812Sjmallettstruct ieee80211_rsnparms { 68232812Sjmallett uint8_t rsn_mcastcipher; /* mcast/group cipher */ 69232812Sjmallett uint8_t rsn_mcastkeylen; /* mcast key length */ 70232812Sjmallett uint8_t rsn_ucastcipherset; /* unicast cipher set */ 71232812Sjmallett uint8_t rsn_ucastcipher; /* selected unicast cipher */ 72215976Sjmallett uint8_t rsn_ucastkeylen; /* unicast key length */ 73215976Sjmallett uint8_t rsn_keymgmtset; /* key mangement algorithms */ 74215976Sjmallett uint8_t rsn_keymgmt; /* selected key mgmt algo */ 75215976Sjmallett uint16_t rsn_caps; /* capabilities */ 76215976Sjmallett}; 77215976Sjmallett 78215976Sjmallettstruct ieee80211_node_table; 79215976Sjmallettstruct ieee80211com; 80215976Sjmallett 81215976Sjmallett/* 82215976Sjmallett * Node specific information. Note that drivers are expected 83215976Sjmallett * to derive from this structure to add device-specific per-node 84215976Sjmallett * state. This is done by overriding the ic_node_* methods in 85215976Sjmallett * the ieee80211com structure. 86215976Sjmallett */ 87215976Sjmallettstruct ieee80211_node { 88215976Sjmallett struct ieee80211com *ni_ic; 89215976Sjmallett struct ieee80211_node_table *ni_table; 90215976Sjmallett TAILQ_ENTRY(ieee80211_node) ni_list; 91215976Sjmallett LIST_ENTRY(ieee80211_node) ni_hash; 92215976Sjmallett u_int ni_refcnt; 93215976Sjmallett u_int ni_scangen; /* gen# for timeout scan */ 94215976Sjmallett uint8_t ni_authmode; /* authentication algorithm */ 95215976Sjmallett uint8_t ni_ath_flags; /* Atheros feature flags */ 96215976Sjmallett /* NB: These must have the same values as IEEE80211_ATHC_* */ 97215976Sjmallett#define IEEE80211_NODE_TURBOP 0x0001 /* Turbo prime enable */ 98215976Sjmallett#define IEEE80211_NODE_COMP 0x0002 /* Compresssion enable */ 99215976Sjmallett#define IEEE80211_NODE_FF 0x0004 /* Fast Frame capable */ 100215976Sjmallett#define IEEE80211_NODE_XR 0x0008 /* Atheros WME enable */ 101232812Sjmallett#define IEEE80211_NODE_AR 0x0010 /* AR capable */ 102215976Sjmallett#define IEEE80211_NODE_BOOST 0x0080 103215976Sjmallett#define IEEE80211_NODE_PSUPDATE 0x0200 /* power save state changed */ 104215976Sjmallett#define IEEE80211_NODE_CHWUPDATE 0x0400 /* 11n channel width change */ 105215976Sjmallett uint16_t ni_flags; /* special-purpose state */ 106215976Sjmallett#define IEEE80211_NODE_AUTH 0x0001 /* authorized for data */ 107215976Sjmallett#define IEEE80211_NODE_QOS 0x0002 /* QoS enabled */ 108215976Sjmallett#define IEEE80211_NODE_ERP 0x0004 /* ERP enabled */ 109215976Sjmallett/* NB: this must have the same value as IEEE80211_FC1_PWR_MGT */ 110215976Sjmallett#define IEEE80211_NODE_PWR_MGT 0x0010 /* power save mode enabled */ 111232812Sjmallett#define IEEE80211_NODE_AREF 0x0020 /* authentication ref held */ 112232812Sjmallett#define IEEE80211_NODE_HT 0x0040 /* HT enabled */ 113232812Sjmallett#define IEEE80211_NODE_HTCOMPAT 0x0080 /* HT setup w/ vendor OUI's */ 114232812Sjmallett uint16_t ni_ath_defkeyix;/* Atheros def key index */ 115215976Sjmallett uint16_t ni_associd; /* assoc response */ 116232812Sjmallett uint16_t ni_txpower; /* current transmit power */ 117232812Sjmallett uint16_t ni_vlan; /* vlan tag */ 118232812Sjmallett uint32_t *ni_challenge; /* shared-key challenge */ 119232812Sjmallett uint8_t *ni_wpa_ie; /* captured WPA ie */ 120232812Sjmallett uint8_t *ni_rsn_ie; /* captured RSN ie */ 121232812Sjmallett uint8_t *ni_wme_ie; /* captured WME ie */ 122232812Sjmallett uint8_t *ni_ath_ie; /* captured Atheros ie */ 123232812Sjmallett#define IEEE80211_NONQOS_TID 16 /* index for non-QoS sta */ 124232812Sjmallett uint16_t ni_txseqs[17]; /* tx seq per-tid */ 125232812Sjmallett uint16_t ni_rxseqs[17]; /* rx seq previous per-tid*/ 126232812Sjmallett uint32_t ni_rxfragstamp; /* time stamp of last rx frag */ 127232812Sjmallett struct mbuf *ni_rxfrag[3]; /* rx frag reassembly */ 128232812Sjmallett struct ieee80211_rsnparms ni_rsn; /* RSN/WPA parameters */ 129232812Sjmallett struct ieee80211_key ni_ucastkey; /* unicast key */ 130232812Sjmallett 131232812Sjmallett /* hardware */ 132232812Sjmallett uint32_t ni_rstamp; /* recv timestamp */ 133232812Sjmallett int8_t ni_rssi; /* recv ssi */ 134232812Sjmallett int8_t ni_noise; /* noise floor */ 135232812Sjmallett 136232812Sjmallett /* header */ 137232812Sjmallett uint8_t ni_macaddr[IEEE80211_ADDR_LEN]; 138232812Sjmallett uint8_t ni_bssid[IEEE80211_ADDR_LEN]; 139232812Sjmallett 140232812Sjmallett /* beacon, probe response */ 141232812Sjmallett union { 142232812Sjmallett uint8_t data[8]; 143232812Sjmallett uint64_t tsf; 144232812Sjmallett } ni_tstamp; /* from last rcv'd beacon */ 145232812Sjmallett uint16_t ni_intval; /* beacon interval */ 146232812Sjmallett uint16_t ni_capinfo; /* capabilities */ 147232812Sjmallett uint8_t ni_esslen; 148232812Sjmallett uint8_t ni_essid[IEEE80211_NWID_LEN]; 149232812Sjmallett struct ieee80211_rateset ni_rates; /* negotiated rate set */ 150232812Sjmallett struct ieee80211_channel *ni_chan; 151232812Sjmallett uint16_t ni_fhdwell; /* FH only */ 152232812Sjmallett uint8_t ni_fhindex; /* FH only */ 153232812Sjmallett uint8_t ni_erp; /* ERP from beacon/probe resp */ 154232812Sjmallett uint16_t ni_timoff; /* byte offset to TIM ie */ 155232812Sjmallett uint8_t ni_dtim_period; /* DTIM period */ 156232812Sjmallett uint8_t ni_dtim_count; /* DTIM count for last bcn */ 157232812Sjmallett 158232812Sjmallett /* 11n state */ 159232812Sjmallett uint16_t ni_htcap; /* HT capabilities */ 160232812Sjmallett uint8_t ni_htparam; /* HT params */ 161232812Sjmallett uint8_t ni_htctlchan; /* HT control channel */ 162232812Sjmallett uint8_t ni_ht2ndchan; /* HT 2nd channel */ 163232812Sjmallett uint8_t ni_htopmode; /* HT operating mode */ 164232812Sjmallett uint8_t ni_htstbc; /* HT */ 165232812Sjmallett uint8_t ni_reqcw; /* requested tx channel width */ 166232812Sjmallett uint8_t ni_chw; /* negotiated channel width */ 167232812Sjmallett struct ieee80211_htrateset ni_htrates; /* negotiated ht rate set */ 168232812Sjmallett struct ieee80211_tx_ampdu ni_tx_ampdu[WME_NUM_AC]; 169232812Sjmallett struct ieee80211_rx_ampdu ni_rx_ampdu[WME_NUM_TID]; 170232812Sjmallett 171232812Sjmallett /* others */ 172232812Sjmallett int ni_fails; /* failure count to associate */ 173232812Sjmallett short ni_inact; /* inactivity mark count */ 174232812Sjmallett short ni_inact_reload;/* inactivity reload value */ 175232812Sjmallett int ni_txrate; /* index to ni_rates[] */ 176232812Sjmallett struct ifqueue ni_savedq; /* ps-poll queue */ 177232812Sjmallett struct ieee80211_nodestats ni_stats; /* per-node statistics */ 178232812Sjmallett}; 179232812SjmallettMALLOC_DECLARE(M_80211_NODE); 180232812Sjmallett 181232812Sjmallett#define IEEE80211_NODE_ATH (IEEE80211_NODE_FF | IEEE80211_NODE_TURBOP) 182232812Sjmallett 183232812Sjmallett#define IEEE80211_NODE_AID(ni) IEEE80211_AID(ni->ni_associd) 184232812Sjmallett 185232812Sjmallett#define IEEE80211_NODE_STAT(ni,stat) (ni->ni_stats.ns_##stat++) 186232812Sjmallett#define IEEE80211_NODE_STAT_ADD(ni,stat,v) (ni->ni_stats.ns_##stat += v) 187232812Sjmallett#define IEEE80211_NODE_STAT_SET(ni,stat,v) (ni->ni_stats.ns_##stat = v) 188215976Sjmallett 189215976Sjmallettstatic __inline struct ieee80211_node * 190215976Sjmallettieee80211_ref_node(struct ieee80211_node *ni) 191215976Sjmallett{ 192215976Sjmallett ieee80211_node_incref(ni); 193215976Sjmallett return ni; 194232812Sjmallett} 195232812Sjmallett 196215976Sjmallettstatic __inline void 197232812Sjmallettieee80211_unref_node(struct ieee80211_node **ni) 198232812Sjmallett{ 199232812Sjmallett ieee80211_node_decref(*ni); 200232812Sjmallett *ni = NULL; /* guard against use */ 201232812Sjmallett} 202232812Sjmallett 203232812Sjmallettstruct ieee80211com; 204232812Sjmallett 205232812Sjmallettvoid ieee80211_node_attach(struct ieee80211com *); 206232812Sjmallettvoid ieee80211_node_lateattach(struct ieee80211com *); 207232812Sjmallettvoid ieee80211_node_detach(struct ieee80211com *); 208232812Sjmallett 209232812Sjmallettstatic __inline int 210232812Sjmallettieee80211_node_is_authorized(const struct ieee80211_node *ni) 211232812Sjmallett{ 212232812Sjmallett return (ni->ni_flags & IEEE80211_NODE_AUTH); 213232812Sjmallett} 214232812Sjmallett 215232812Sjmallettvoid ieee80211_node_authorize(struct ieee80211_node *); 216215976Sjmallettvoid ieee80211_node_unauthorize(struct ieee80211_node *); 217215976Sjmallett 218215976Sjmallettvoid ieee80211_probe_curchan(struct ieee80211com *, int); 219215976Sjmallettvoid ieee80211_create_ibss(struct ieee80211com*, struct ieee80211_channel *); 220215976Sjmallettvoid ieee80211_reset_bss(struct ieee80211com *); 221232812Sjmallettint ieee80211_ibss_merge(struct ieee80211_node *); 222215976Sjmallettstruct ieee80211_scan_entry; 223215976Sjmallettint ieee80211_sta_join(struct ieee80211com *, 224215976Sjmallett const struct ieee80211_scan_entry *); 225232812Sjmallettvoid ieee80211_sta_leave(struct ieee80211com *, struct ieee80211_node *); 226215976Sjmallett 227215976Sjmallett/* 228232812Sjmallett * Table of ieee80211_node instances. Each ieee80211com 229215976Sjmallett * has at least one for holding the scan candidates. 230215976Sjmallett * When operating as an access point or in ibss mode there 231215976Sjmallett * is a second table for associated stations or neighbors. 232215976Sjmallett */ 233215976Sjmallettstruct ieee80211_node_table { 234215976Sjmallett struct ieee80211com *nt_ic; /* back reference */ 235215976Sjmallett ieee80211_node_lock_t nt_nodelock; /* on node table */ 236215976Sjmallett TAILQ_HEAD(, ieee80211_node) nt_node; /* information of all nodes */ 237215976Sjmallett LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE]; 238215976Sjmallett struct ieee80211_node **nt_keyixmap; /* key ix -> node map */ 239215976Sjmallett int nt_keyixmax; /* keyixmap size */ 240215976Sjmallett const char *nt_name; /* for debugging */ 241215976Sjmallett ieee80211_scan_lock_t nt_scanlock; /* on nt_scangen */ 242215976Sjmallett u_int nt_scangen; /* gen# for timeout scan */ 243215976Sjmallett int nt_inact_init; /* initial node inact setting */ 244215976Sjmallett}; 245215976Sjmallett 246215976Sjmallettstruct ieee80211_node *ieee80211_alloc_node( 247215976Sjmallett struct ieee80211_node_table *, const uint8_t *); 248215976Sjmallettstruct ieee80211_node *ieee80211_tmp_node(struct ieee80211com *, 249215976Sjmallett const uint8_t *macaddr); 250215976Sjmallettstruct ieee80211_node *ieee80211_dup_bss(struct ieee80211_node_table *, 251215976Sjmallett const uint8_t *); 252215976Sjmallett#ifdef IEEE80211_DEBUG_REFCNT 253215976Sjmallettvoid ieee80211_free_node_debug(struct ieee80211_node *, 254215976Sjmallett const char *func, int line); 255215976Sjmallettstruct ieee80211_node *ieee80211_find_node_debug(struct ieee80211_node_table *, 256215976Sjmallett const uint8_t *, 257215976Sjmallett const char *func, int line); 258215976Sjmallettstruct ieee80211_node * ieee80211_find_rxnode_debug(struct ieee80211com *, 259215976Sjmallett const struct ieee80211_frame_min *, 260215976Sjmallett const char *func, int line); 261215976Sjmallettstruct ieee80211_node * ieee80211_find_rxnode_withkey_debug( 262215976Sjmallett struct ieee80211com *, 263215976Sjmallett const struct ieee80211_frame_min *, uint16_t keyix, 264215976Sjmallett const char *func, int line); 265215976Sjmallettstruct ieee80211_node * ieee80211_find_rxnode_withkey_debug( 266215976Sjmallett struct ieee80211com *, 267215976Sjmallett const struct ieee80211_frame_min *, uint16_t keyix, 268215976Sjmallett const char *func, int line); 269215976Sjmallettstruct ieee80211_node *ieee80211_find_txnode_debug(struct ieee80211com *, 270215976Sjmallett const uint8_t *, 271215976Sjmallett const char *func, int line); 272215976Sjmallettstruct ieee80211_node *ieee80211_find_node_with_ssid_debug( 273215976Sjmallett struct ieee80211_node_table *, const uint8_t *macaddr, 274215976Sjmallett u_int ssidlen, const uint8_t *ssid, 275215976Sjmallett const char *func, int line); 276215976Sjmallett#define ieee80211_free_node(ni) \ 277215976Sjmallett ieee80211_free_node_debug(ni, __func__, __LINE__) 278215976Sjmallett#define ieee80211_find_node(nt, mac) \ 279215976Sjmallett ieee80211_find_node_debug(nt, mac, __func__, __LINE__) 280215976Sjmallett#define ieee80211_find_rxnode(nt, wh) \ 281215976Sjmallett ieee80211_find_rxnode_debug(nt, wh, __func__, __LINE__) 282232812Sjmallett#define ieee80211_find_rxnode_withkey(nt, wh, keyix) \ 283232812Sjmallett ieee80211_find_rxnode_withkey_debug(nt, wh, keyix, __func__, __LINE__) 284232812Sjmallett#define ieee80211_find_txnode(nt, mac) \ 285232812Sjmallett ieee80211_find_txnode_debug(nt, mac, __func__, __LINE__) 286232812Sjmallett#define ieee80211_find_node_with_ssid(nt, mac, sl, ss) \ 287232812Sjmallett ieee80211_find_node_with_ssid_debug(nt, mac, sl, ss, __func__, __LINE__) 288232812Sjmallett#else 289232812Sjmallettvoid ieee80211_free_node(struct ieee80211_node *); 290232812Sjmallettstruct ieee80211_node *ieee80211_find_node(struct ieee80211_node_table *, 291232812Sjmallett const uint8_t *); 292232812Sjmallettstruct ieee80211_node * ieee80211_find_rxnode(struct ieee80211com *, 293232812Sjmallett const struct ieee80211_frame_min *); 294232812Sjmallettstruct ieee80211_node * ieee80211_find_rxnode_withkey(struct ieee80211com *, 295232812Sjmallett const struct ieee80211_frame_min *, uint16_t keyix); 296232812Sjmallettstruct ieee80211_node *ieee80211_find_txnode(struct ieee80211com *, 297232812Sjmallett const uint8_t *); 298232812Sjmallettstruct ieee80211_node *ieee80211_find_node_with_ssid( 299232812Sjmallett struct ieee80211_node_table *, const uint8_t *macaddr, 300232812Sjmallett u_int ssidlen, const uint8_t *ssid); 301232812Sjmallett#endif 302232812Sjmallettint ieee80211_node_delucastkey(struct ieee80211_node *); 303232812Sjmallettvoid ieee80211_node_timeout(void *arg); 304232812Sjmallett 305232812Sjmalletttypedef void ieee80211_iter_func(void *, struct ieee80211_node *); 306232812Sjmallettvoid ieee80211_iterate_nodes(struct ieee80211_node_table *, 307232812Sjmallett ieee80211_iter_func *, void *); 308232812Sjmallett 309232812Sjmallettvoid ieee80211_dump_node(struct ieee80211_node_table *, 310232812Sjmallett struct ieee80211_node *); 311232812Sjmallettvoid ieee80211_dump_nodes(struct ieee80211_node_table *); 312232812Sjmallett 313232812Sjmallettvoid ieee80211_notify_erp(struct ieee80211com *); 314232812Sjmallett 315232812Sjmallettstruct ieee80211_node *ieee80211_fakeup_adhoc_node( 316232812Sjmallett struct ieee80211_node_table *, const uint8_t macaddr[]); 317232812Sjmallettstruct ieee80211_scanparams; 318232812Sjmallettvoid ieee80211_init_neighbor(struct ieee80211_node *, 319215976Sjmallett const struct ieee80211_frame *, 320232812Sjmallett const struct ieee80211_scanparams *); 321215976Sjmallettstruct ieee80211_node *ieee80211_add_neighbor(struct ieee80211com *, 322232812Sjmallett const struct ieee80211_frame *, 323232812Sjmallett const struct ieee80211_scanparams *); 324215976Sjmallettvoid ieee80211_node_join(struct ieee80211com *, struct ieee80211_node *,int); 325215976Sjmallettvoid ieee80211_node_leave(struct ieee80211com *, struct ieee80211_node *); 326232812Sjmallettint8_t ieee80211_getrssi(struct ieee80211com *); 327232812Sjmallettvoid ieee80211_getsignal(struct ieee80211com *, int8_t *, int8_t *); 328232812Sjmallett#endif /* _NET80211_IEEE80211_NODE_H_ */ 329215976Sjmallett