The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/net80211/ieee80211_node.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 63b7088e9e9e50a86ef5301d6404cfec


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.