sys/net80211/ieee80211_var.h

   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$
  27  */
  28 #ifndef _NET80211_IEEE80211_VAR_H_
  29 #define _NET80211_IEEE80211_VAR_H_
  30
  31 /*
  32  * Definitions for IEEE 802.11 drivers.
  33  */
  34 /* NB: portability glue must go first */
  35 #ifdef __NetBSD__
  36 #include <net80211/ieee80211_netbsd.h>
  37 #elif __FreeBSD__
  38 #include <net80211/ieee80211_freebsd.h>
  39 #elif __linux__
  40 #include <net80211/ieee80211_linux.h>
  41 #else
  42 #error  "No support for your operating system!"
  43 #endif
  44
  45 #include <net80211/_ieee80211.h>
  46 #include <net80211/ieee80211.h>
  47 #include <net80211/ieee80211_crypto.h>
  48 #include <net80211/ieee80211_dfs.h>
  49 #include <net80211/ieee80211_ioctl.h>           /* for ieee80211_stats */
  50 #include <net80211/ieee80211_node.h>
  51 #include <net80211/ieee80211_power.h>
  52 #include <net80211/ieee80211_proto.h>
  53 #include <net80211/ieee80211_scan.h>
  54
  55 #define IEEE80211_TXPOWER_MAX   100     /* .5 dbM (XXX units?) */
  56 #define IEEE80211_TXPOWER_MIN   0       /* kill radio */
  57
  58 #define IEEE80211_DTIM_DEFAULT  1       /* default DTIM period */
  59 #define IEEE80211_BINTVAL_DEFAULT 100   /* default beacon interval (TU's) */
  60
  61 #define IEEE80211_BMISS_MAX     2       /* maximum consecutive bmiss allowed */
  62 #define IEEE80211_HWBMISS_DEFAULT 7     /* h/w bmiss threshold (beacons) */
  63
  64 #define IEEE80211_BGSCAN_INTVAL_MIN     15      /* min bg scan intvl (secs) */
  65 #define IEEE80211_BGSCAN_INTVAL_DEFAULT (5*60)  /* default bg scan intvl */
  66
  67 #define IEEE80211_BGSCAN_IDLE_MIN       100     /* min idle time (ms) */
  68 #define IEEE80211_BGSCAN_IDLE_DEFAULT   250     /* default idle time (ms) */
  69
  70 #define IEEE80211_SCAN_VALID_MIN        10      /* min scan valid time (secs) */
  71 #define IEEE80211_SCAN_VALID_DEFAULT    60      /* default scan valid time */
  72
  73 #define IEEE80211_PS_SLEEP      0x1     /* STA is in power saving mode */
  74 #define IEEE80211_PS_MAX_QUEUE  50      /* maximum saved packets */
  75
  76 #define IEEE80211_FIXED_RATE_NONE       0xff
  77 #define IEEE80211_TXMAX_DEFAULT         6       /* default ucast max retries */
  78
  79 #define IEEE80211_RTS_DEFAULT           IEEE80211_RTS_MAX
  80 #define IEEE80211_FRAG_DEFAULT          IEEE80211_FRAG_MAX
  81
  82 #define IEEE80211_MS_TO_TU(x)   (((x) * 1000) / 1024)
  83 #define IEEE80211_TU_TO_MS(x)   (((x) * 1024) / 1000)
  84 #define IEEE80211_TU_TO_TICKS(x)(((x) * 1024 * hz) / (1000 * 1000))
  85
  86 /*
  87  * 802.11 control state is split into a common portion that maps
  88  * 1-1 to a physical device and one or more "Virtual AP's" (VAP)
  89  * that are bound to an ieee80211com instance and share a single
  90  * underlying device.  Each VAP has a corresponding OS device
  91  * entity through which traffic flows and that applications use
  92  * for issuing ioctls, etc.
  93  */
  94
  95 /*
  96  * Data common to one or more virtual AP's.  State shared by
  97  * the underlying device and the net80211 layer is exposed here;
  98  * e.g. device-specific callbacks.
  99  */
 100 struct ieee80211vap;
 101 typedef void (*ieee80211vap_attach)(struct ieee80211vap *);
 102
 103 struct ieee80211_appie {
 104         uint16_t                ie_len;         /* size of ie_data */
 105         uint8_t                 ie_data[];      /* user-specified IE's */
 106 };
 107
 108 struct ieee80211com {
 109         struct ifnet            *ic_ifp;        /* associated device */
 110         ieee80211_com_lock_t    ic_comlock;     /* state update lock */
 111         TAILQ_HEAD(, ieee80211vap) ic_vaps;     /* list of vap instances */
 112         struct ieee80211_stats  ic_stats;       /* statistics */
 113         int                     ic_headroom;    /* driver tx headroom needs */
 114         enum ieee80211_phytype  ic_phytype;     /* XXX wrong for multi-mode */
 115         enum ieee80211_opmode   ic_opmode;      /* operation mode */
 116         struct ifmedia          ic_media;       /* interface media config */
 117         uint8_t                 ic_myaddr[IEEE80211_ADDR_LEN];
 118         struct callout          ic_inact;       /* inactivity processing */
 119         struct task             ic_parent_task; /* deferred parent processing */
 120
 121         uint32_t                ic_flags;       /* state flags */
 122         uint32_t                ic_flags_ext;   /* extended state flags */
 123         uint32_t                ic_flags_ven;   /* vendor state flags */
 124         uint32_t                ic_caps;        /* capabilities */
 125         uint32_t                ic_htcaps;      /* HT capabilities */
 126         uint32_t                ic_cryptocaps;  /* crypto capabilities */
 127         uint8_t                 ic_modecaps[2]; /* set of mode capabilities */
 128         uint8_t                 ic_promisc;     /* vap's needing promisc mode */
 129         uint8_t                 ic_allmulti;    /* vap's needing all multicast*/
 130         uint8_t                 ic_nrunning;    /* vap's marked running */
 131         uint8_t                 ic_curmode;     /* current mode */
 132         uint16_t                ic_bintval;     /* beacon interval */
 133         uint16_t                ic_lintval;     /* listen interval */
 134         uint16_t                ic_holdover;    /* PM hold over duration */
 135         uint16_t                ic_txpowlimit;  /* global tx power limit */
 136         struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
 137
 138         /*
 139          * Channel state:
 140          *
 141          * ic_channels is the set of available channels for the device;
 142          *    it is setup by the driver
 143          * ic_nchans is the number of valid entries in ic_channels
 144          * ic_chan_avail is a bit vector of these channels used to check
 145          *    whether a channel is available w/o searching the channel table.
 146          * ic_chan_active is a (potentially) constrained subset of
 147          *    ic_chan_avail that reflects any mode setting or user-specified
 148          *    limit on the set of channels to use/scan
 149          * ic_curchan is the current channel the device is set to; it may
 150          *    be different from ic_bsschan when we are off-channel scanning
 151          *    or otherwise doing background work
 152          * ic_bsschan is the channel selected for operation; it may
 153          *    be undefined (IEEE80211_CHAN_ANYC)
 154          * ic_prevchan is a cached ``previous channel'' used to optimize
 155          *    lookups when switching back+forth between two channels
 156          *    (e.g. for dynamic turbo)
 157          */
 158         int                     ic_nchans;      /* # entries in ic_channels */
 159         struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
 160         uint8_t                 ic_chan_avail[IEEE80211_CHAN_BYTES];
 161         uint8_t                 ic_chan_active[IEEE80211_CHAN_BYTES];
 162         uint8_t                 ic_chan_scan[IEEE80211_CHAN_BYTES];
 163         struct ieee80211_channel *ic_curchan;   /* current channel */
 164         struct ieee80211_channel *ic_bsschan;   /* bss channel */
 165         struct ieee80211_channel *ic_prevchan;  /* previous channel */
 166         struct ieee80211_regdomain ic_regdomain;/* regulatory data */
 167         struct ieee80211_appie  *ic_countryie;  /* calculated country ie */
 168         struct ieee80211_channel *ic_countryie_chan;
 169
 170         /* 802.11h/DFS state */
 171         struct ieee80211_channel *ic_csa_newchan;/* channel for doing CSA */
 172         int                     ic_csa_count;   /* count for doing CSA */
 173         struct ieee80211_dfs_state ic_dfs;      /* DFS state */
 174
 175         struct ieee80211_scan_state *ic_scan;   /* scan state */
 176         int                     ic_lastdata;    /* time of last data frame */
 177         int                     ic_lastscan;    /* time last scan completed */
 178
 179         /* NB: this is the union of all vap stations/neighbors */
 180         int                     ic_max_keyix;   /* max h/w key index */
 181         struct ieee80211_node_table ic_sta;     /* stations/neighbors */
 182
 183         /* XXX multi-bss: split out common/vap parts */
 184         struct ieee80211_wme_state ic_wme;      /* WME/WMM state */
 185
 186         /* XXX multi-bss: can per-vap be done/make sense? */
 187         enum ieee80211_protmode ic_protmode;    /* 802.11g protection mode */
 188         uint16_t                ic_nonerpsta;   /* # non-ERP stations */
 189         uint16_t                ic_longslotsta; /* # long slot time stations */
 190         uint16_t                ic_sta_assoc;   /* stations associated */
 191         uint16_t                ic_ht_sta_assoc;/* HT stations associated */
 192         uint16_t                ic_ht40_sta_assoc;/* HT40 stations associated */
 193         uint8_t                 ic_curhtprotmode;/* HTINFO bss state */
 194         enum ieee80211_protmode ic_htprotmode;  /* HT protection mode */
 195         int                     ic_lastnonerp;  /* last time non-ERP sta noted*/
 196         int                     ic_lastnonht;   /* last time non-HT sta noted */
 197
 198         /* virtual ap create/delete */
 199         struct ieee80211vap*    (*ic_vap_create)(struct ieee80211com *,
 200                                     const char name[IFNAMSIZ], int unit,
 201                                     int opmode, int flags,
 202                                     const uint8_t bssid[IEEE80211_ADDR_LEN],
 203                                     const uint8_t macaddr[IEEE80211_ADDR_LEN]);
 204         void                    (*ic_vap_delete)(struct ieee80211vap *);
 205         /* operating mode attachment */
 206         ieee80211vap_attach     ic_vattach[IEEE80211_OPMODE_MAX];
 207         /* return hardware/radio capabilities */
 208         void                    (*ic_getradiocaps)(struct ieee80211com *,
 209                                     int *, struct ieee80211_channel []);
 210         /* check and/or prepare regdomain state change */
 211         int                     (*ic_setregdomain)(struct ieee80211com *,
 212                                     struct ieee80211_regdomain *,
 213                                     int, struct ieee80211_channel []);
 214         /* send/recv 802.11 management frame */
 215         int                     (*ic_send_mgmt)(struct ieee80211_node *,
 216                                      int, int);
 217         /* send raw 802.11 frame */
 218         int                     (*ic_raw_xmit)(struct ieee80211_node *,
 219                                     struct mbuf *,
 220                                     const struct ieee80211_bpf_params *);
 221         /* update device state for 802.11 slot time change */
 222         void                    (*ic_updateslot)(struct ifnet *);
 223         /* handle multicast state changes */
 224         void                    (*ic_update_mcast)(struct ifnet *);
 225         /* handle promiscuous mode changes */
 226         void                    (*ic_update_promisc)(struct ifnet *);
 227         /* new station association callback/notification */
 228         void                    (*ic_newassoc)(struct ieee80211_node *, int);
 229         /* node state management */
 230         struct ieee80211_node*  (*ic_node_alloc)(struct ieee80211_node_table *);
 231         void                    (*ic_node_free)(struct ieee80211_node *);
 232         void                    (*ic_node_cleanup)(struct ieee80211_node *);
 233         void                    (*ic_node_age)(struct ieee80211_node *);
 234         void                    (*ic_node_drain)(struct ieee80211_node *);
 235         int8_t                  (*ic_node_getrssi)(const struct ieee80211_node*);
 236         void                    (*ic_node_getsignal)(const struct ieee80211_node*,
 237                                     int8_t *, int8_t *);
 238         void                    (*ic_node_getmimoinfo)(
 239                                     const struct ieee80211_node*,
 240                                     struct ieee80211_mimo_info *);
 241         /* scanning support */
 242         void                    (*ic_scan_start)(struct ieee80211com *);
 243         void                    (*ic_scan_end)(struct ieee80211com *);
 244         void                    (*ic_set_channel)(struct ieee80211com *);
 245         void                    (*ic_scan_curchan)(struct ieee80211_scan_state *,
 246                                     unsigned long);
 247         void                    (*ic_scan_mindwell)(struct ieee80211_scan_state *);
 248
 249         /*
 250          * 802.11n ADDBA support.  A simple/generic implementation
 251          * of A-MPDU tx aggregation is provided; the driver may
 252          * override these methods to provide their own support.
 253          * A-MPDU rx re-ordering happens automatically if the
 254          * driver passes out-of-order frames to ieee80211_input
 255          * from an assocated HT station.
 256          */
 257         void                    (*ic_recv_action)(struct ieee80211_node *,
 258                                     const uint8_t *frm, const uint8_t *efrm);
 259         int                     (*ic_send_action)(struct ieee80211_node *,
 260                                     int category, int action,
 261                                     uint16_t args[4]);
 262         /* check if A-MPDU should be enabled this station+ac */
 263         int                     (*ic_ampdu_enable)(struct ieee80211_node *,
 264                                     struct ieee80211_tx_ampdu *);
 265         /* start/stop doing A-MPDU tx aggregation for a station */
 266         int                     (*ic_addba_request)(struct ieee80211_node *,
 267                                     struct ieee80211_tx_ampdu *,
 268                                     int dialogtoken, int baparamset,
 269                                     int batimeout);
 270         int                     (*ic_addba_response)(struct ieee80211_node *,
 271                                     struct ieee80211_tx_ampdu *,
 272                                     int status, int baparamset, int batimeout);
 273         void                    (*ic_addba_stop)(struct ieee80211_node *,
 274                                     struct ieee80211_tx_ampdu *);
 275 };
 276
 277 struct ieee80211_aclator;
 278
 279 struct ieee80211vap {
 280         struct ifmedia          iv_media;       /* interface media config */
 281         struct ifnet            *iv_ifp;        /* associated device */
 282         struct bpf_if           *iv_rawbpf;     /* packet filter structure */
 283         struct sysctl_ctx_list  *iv_sysctl;     /* dynamic sysctl context */
 284         struct sysctl_oid       *iv_oid;        /* net.wlan.X sysctl oid */
 285
 286         TAILQ_ENTRY(ieee80211vap) iv_next;      /* list of vap instances */
 287         struct ieee80211com     *iv_ic;         /* back ptr to common state */
 288         uint32_t                iv_debug;       /* debug msg flags */
 289         struct ieee80211_stats  iv_stats;       /* statistics */
 290
 291         uint8_t                 iv_myaddr[IEEE80211_ADDR_LEN];
 292         uint32_t                iv_flags;       /* state flags */
 293         uint32_t                iv_flags_ext;   /* extended state flags */
 294         uint32_t                iv_flags_ven;   /* vendor state flags */
 295         uint32_t                iv_caps;        /* capabilities */
 296         uint32_t                iv_htcaps;      /* HT capabilities */
 297         enum ieee80211_opmode   iv_opmode;      /* operation mode */
 298         enum ieee80211_state    iv_state;       /* state machine state */
 299         void                    (*iv_newstate_cb)(struct ieee80211vap *,
 300                                     enum ieee80211_state, int);
 301         struct callout          iv_mgtsend;     /* mgmt frame response timer */
 302                                                 /* inactivity timer settings */
 303         int                     iv_inact_init;  /* setting for new station */
 304         int                     iv_inact_auth;  /* auth but not assoc setting */
 305         int                     iv_inact_run;   /* authorized setting */
 306         int                     iv_inact_probe; /* inactive probe time */
 307
 308         int                     iv_des_nssid;   /* # desired ssids */
 309         struct ieee80211_scan_ssid iv_des_ssid[1];/* desired ssid table */
 310         uint8_t                 iv_des_bssid[IEEE80211_ADDR_LEN];
 311         struct ieee80211_channel *iv_des_chan;  /* desired channel */
 312         uint16_t                iv_des_mode;    /* desired mode */
 313         int                     iv_nicknamelen; /* XXX junk */
 314         uint8_t                 iv_nickname[IEEE80211_NWID_LEN];
 315         u_int                   iv_bgscanidle;  /* bg scan idle threshold */
 316         u_int                   iv_bgscanintvl; /* bg scan min interval */
 317         u_int                   iv_scanvalid;   /* scan cache valid threshold */
 318         u_int                   iv_scanreq_duration;
 319         u_int                   iv_scanreq_mindwell;
 320         u_int                   iv_scanreq_maxdwell;
 321         uint16_t                iv_scanreq_flags;/* held scan request params */
 322         uint8_t                 iv_scanreq_nssid;
 323         struct ieee80211_scan_ssid iv_scanreq_ssid[IEEE80211_SCAN_MAX_SSID];
 324         /* sta-mode roaming state */
 325         enum ieee80211_roamingmode iv_roaming;  /* roaming mode */
 326         struct ieee80211_roamparam iv_roamparms[IEEE80211_MODE_MAX];
 327
 328         uint8_t                 iv_bmissthreshold;
 329         uint8_t                 iv_bmiss_count; /* current beacon miss count */
 330         int                     iv_bmiss_max;   /* max bmiss before scan */
 331         uint16_t                iv_swbmiss_count;/* beacons in last period */
 332         uint16_t                iv_swbmiss_period;/* s/w bmiss period */
 333         struct callout          iv_swbmiss;     /* s/w beacon miss timer */
 334
 335         int                     iv_ampdu_rxmax; /* A-MPDU rx limit (bytes) */
 336         int                     iv_ampdu_density;/* A-MPDU density */
 337         int                     iv_ampdu_limit; /* A-MPDU tx limit (bytes) */
 338         int                     iv_amsdu_limit; /* A-MSDU tx limit (bytes) */
 339         u_int                   iv_ampdu_mintraffic[WME_NUM_AC];
 340
 341         uint32_t                *iv_aid_bitmap; /* association id map */
 342         uint16_t                iv_max_aid;
 343         uint16_t                iv_sta_assoc;   /* stations associated */
 344         uint16_t                iv_ps_sta;      /* stations in power save */
 345         uint16_t                iv_ps_pending;  /* ps sta's w/ pending frames */
 346         uint16_t                iv_txseq;       /* mcast xmit seq# space */
 347         uint16_t                iv_tim_len;     /* ic_tim_bitmap size (bytes) */
 348         uint8_t                 *iv_tim_bitmap; /* power-save stations w/ data*/
 349         uint8_t                 iv_dtim_period; /* DTIM period */
 350         uint8_t                 iv_dtim_count;  /* DTIM count from last bcn */
 351                                                 /* set/unset aid pwrsav state */
 352         int                     iv_csa_count;   /* count for doing CSA */
 353
 354         struct ieee80211_node   *iv_bss;        /* information for this node */
 355         struct ieee80211_txparam iv_txparms[IEEE80211_MODE_MAX];
 356         uint16_t                iv_rtsthreshold;
 357         uint16_t                iv_fragthreshold;
 358         int                     iv_inact_timer; /* inactivity timer wait */
 359         /* application-specified IE's to attach to mgt frames */
 360         struct ieee80211_appie  *iv_appie_beacon;
 361         struct ieee80211_appie  *iv_appie_probereq;
 362         struct ieee80211_appie  *iv_appie_proberesp;
 363         struct ieee80211_appie  *iv_appie_assocreq;
 364         struct ieee80211_appie  *iv_appie_assocresp;
 365         struct ieee80211_appie  *iv_appie_wpa;
 366         uint8_t                 *iv_wpa_ie;
 367         uint8_t                 *iv_rsn_ie;
 368         uint16_t                iv_max_keyix;   /* max h/w key index */
 369         ieee80211_keyix         iv_def_txkey;   /* default/group tx key index */
 370         struct ieee80211_key    iv_nw_keys[IEEE80211_WEP_NKID];
 371         int                     (*iv_key_alloc)(struct ieee80211vap *,
 372                                     const struct ieee80211_key *,
 373                                     ieee80211_keyix *, ieee80211_keyix *);
 374         int                     (*iv_key_delete)(struct ieee80211vap *,
 375                                     const struct ieee80211_key *);
 376         int                     (*iv_key_set)(struct ieee80211vap *,
 377                                     const struct ieee80211_key *,
 378                                     const uint8_t mac[IEEE80211_ADDR_LEN]);
 379         void                    (*iv_key_update_begin)(struct ieee80211vap *);
 380         void                    (*iv_key_update_end)(struct ieee80211vap *);
 381
 382         const struct ieee80211_authenticator *iv_auth; /* authenticator glue */
 383         void                    *iv_ec;         /* private auth state */
 384
 385         const struct ieee80211_aclator *iv_acl; /* acl glue */
 386         void                    *iv_as;         /* private aclator state */
 387
 388         /* operate-mode detach hook */
 389         void                    (*iv_opdetach)(struct ieee80211vap *);
 390         /* receive processing */
 391         int                     (*iv_input)(struct ieee80211_node *,
 392                                     struct mbuf *, int rssi, int noise,
 393                                     uint32_t rstamp);
 394         void                    (*iv_recv_mgmt)(struct ieee80211_node *,
 395                                     struct mbuf *, int, int, int, uint32_t);
 396         void                    (*iv_deliver_data)(struct ieee80211vap *,
 397                                     struct ieee80211_node *, struct mbuf *);
 398 #if 0
 399         /* send processing */
 400         int                     (*iv_send_mgmt)(struct ieee80211_node *,
 401                                      int, int);
 402 #endif
 403         /* beacon miss processing */
 404         void                    (*iv_bmiss)(struct ieee80211vap *);
 405         /* reset device state after 802.11 parameter/state change */
 406         int                     (*iv_reset)(struct ieee80211vap *, u_long);
 407         /* [schedule] beacon frame update */
 408         void                    (*iv_update_beacon)(struct ieee80211vap *, int);
 409         /* power save handling */
 410         void                    (*iv_update_ps)(struct ieee80211vap *, int);
 411         int                     (*iv_set_tim)(struct ieee80211_node *, int);
 412         /* state machine processing */
 413         int                     (*iv_newstate)(struct ieee80211vap *,
 414                                     enum ieee80211_state, int);
 415         /* 802.3 output method for raw frame xmit */
 416         int                     (*iv_output)(struct ifnet *, struct mbuf *,
 417                                     struct sockaddr *, struct rtentry *);
 418 };
 419 MALLOC_DECLARE(M_80211_VAP);
 420
 421 #define IEEE80211_ADDR_EQ(a1,a2)        (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
 422 #define IEEE80211_ADDR_COPY(dst,src)    memcpy(dst,src,IEEE80211_ADDR_LEN)
 423
 424 /* ic_flags/iv_flags */
 425 #define IEEE80211_F_TURBOP      0x00000001      /* CONF: ATH Turbo enabled*/
 426 #define IEEE80211_F_COMP        0x00000002      /* CONF: ATH comp enabled */
 427 #define IEEE80211_F_FF          0x00000004      /* CONF: ATH FF enabled */
 428 #define IEEE80211_F_BURST       0x00000008      /* CONF: bursting enabled */
 429 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
 430 #define IEEE80211_F_PRIVACY     0x00000010      /* CONF: privacy enabled */
 431 #define IEEE80211_F_PUREG       0x00000020      /* CONF: 11g w/o 11b sta's */
 432 #define IEEE80211_F_SCAN        0x00000080      /* STATUS: scanning */
 433 #define IEEE80211_F_ASCAN       0x00000100      /* STATUS: active scan */
 434 #define IEEE80211_F_SIBSS       0x00000200      /* STATUS: start IBSS */
 435 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
 436 #define IEEE80211_F_SHSLOT      0x00000400      /* STATUS: use short slot time*/
 437 #define IEEE80211_F_PMGTON      0x00000800      /* CONF: Power mgmt enable */
 438 #define IEEE80211_F_DESBSSID    0x00001000      /* CONF: des_bssid is set */
 439 #define IEEE80211_F_WME         0x00002000      /* CONF: enable WME use */
 440 #define IEEE80211_F_BGSCAN      0x00004000      /* CONF: bg scan enabled (???)*/
 441 #define IEEE80211_F_SWRETRY     0x00008000      /* CONF: sw tx retry enabled */
 442 #define IEEE80211_F_TXPOW_FIXED 0x00010000      /* TX Power: fixed rate */
 443 #define IEEE80211_F_IBSSON      0x00020000      /* CONF: IBSS creation enable */
 444 #define IEEE80211_F_SHPREAMBLE  0x00040000      /* STATUS: use short preamble */
 445 #define IEEE80211_F_DATAPAD     0x00080000      /* CONF: do alignment pad */
 446 #define IEEE80211_F_USEPROT     0x00100000      /* STATUS: protection enabled */
 447 #define IEEE80211_F_USEBARKER   0x00200000      /* STATUS: use barker preamble*/
 448 #define IEEE80211_F_CSAPENDING  0x00400000      /* STATUS: chan switch pending*/
 449 #define IEEE80211_F_WPA1        0x00800000      /* CONF: WPA enabled */
 450 #define IEEE80211_F_WPA2        0x01000000      /* CONF: WPA2 enabled */
 451 #define IEEE80211_F_WPA         0x01800000      /* CONF: WPA/WPA2 enabled */
 452 #define IEEE80211_F_DROPUNENC   0x02000000      /* CONF: drop unencrypted */
 453 #define IEEE80211_F_COUNTERM    0x04000000      /* CONF: TKIP countermeasures */
 454 #define IEEE80211_F_HIDESSID    0x08000000      /* CONF: hide SSID in beacon */
 455 #define IEEE80211_F_NOBRIDGE    0x10000000      /* CONF: dis. internal bridge */
 456 #define IEEE80211_F_PCF         0x20000000      /* CONF: PCF enabled */
 457 #define IEEE80211_F_DOTH        0x40000000      /* CONF: 11h enabled */
 458 #define IEEE80211_F_DWDS        0x80000000      /* CONF: Dynamic WDS enabled */
 459
 460 /* Atheros protocol-specific flags */
 461 #define IEEE80211_F_ATHEROS \
 462         (IEEE80211_F_FF | IEEE80211_F_COMP | IEEE80211_F_TURBOP)
 463 /* Check if an Atheros capability was negotiated for use */
 464 #define IEEE80211_ATH_CAP(vap, ni, bit) \
 465         ((vap)->iv_flags & (ni)->ni_ath_flags & (bit))
 466
 467 /* ic_flags_ext/iv_flags_ext */
 468 #define IEEE80211_FEXT_NONHT_PR  0x00000001     /* STATUS: non-HT sta present */
 469 #define IEEE80211_FEXT_INACT     0x00000002     /* CONF: sta inact handling */
 470 #define IEEE80211_FEXT_SCANWAIT  0x00000004     /* STATUS: awaiting scan */
 471 /* 0x00000006 reserved */
 472 #define IEEE80211_FEXT_BGSCAN    0x00000008     /* STATUS: complete bgscan */
 473 #define IEEE80211_FEXT_WPS       0x00000010     /* CONF: WPS enabled */
 474 #define IEEE80211_FEXT_TSN       0x00000020     /* CONF: TSN enabled */
 475 #define IEEE80211_FEXT_SCANREQ   0x00000040     /* STATUS: scan req params */
 476 #define IEEE80211_FEXT_DFS       0x00000800     /* CONF: DFS enabled */
 477 #define IEEE80211_FEXT_NONERP_PR 0x00000200     /* STATUS: non-ERP sta present*/
 478 #define IEEE80211_FEXT_SWBMISS   0x00000400     /* CONF: do bmiss in s/w */
 479 #define IEEE80211_FEXT_DOTD      0x00001000     /* CONF: 11d enabled */
 480 /* NB: immutable: should be set only when creating a vap */
 481 #define IEEE80211_FEXT_WDSLEGACY 0x00010000     /* CONF: legacy WDS operation */
 482 #define IEEE80211_FEXT_PROBECHAN 0x00020000     /* CONF: probe passive channel*/
 483 #define IEEE80211_FEXT_HT        0x00080000     /* CONF: HT supported */
 484 #define IEEE80211_FEXT_AMPDU_TX  0x00100000     /* CONF: A-MPDU tx supported */
 485 #define IEEE80211_FEXT_AMPDU_RX  0x00200000     /* CONF: A-MPDU tx supported */
 486 #define IEEE80211_FEXT_AMSDU_TX  0x00400000     /* CONF: A-MSDU tx supported */
 487 #define IEEE80211_FEXT_AMSDU_RX  0x00800000     /* CONF: A-MSDU tx supported */
 488 #define IEEE80211_FEXT_USEHT40   0x01000000     /* CONF: 20/40 use enabled */
 489 #define IEEE80211_FEXT_PUREN     0x02000000     /* CONF: 11n w/o legacy sta's */
 490 #define IEEE80211_FEXT_SHORTGI20 0x04000000     /* CONF: short GI in HT20 */
 491 #define IEEE80211_FEXT_SHORTGI40 0x08000000     /* CONF: short GI in HT40 */
 492 #define IEEE80211_FEXT_HTCOMPAT  0x10000000     /* CONF: HT vendor OUI's */
 493
 494 /* ic_caps/iv_caps: device driver capabilities */
 495 /* 0x2f available */
 496 #define IEEE80211_C_STA         0x00000001      /* CAPABILITY: STA available */
 497 #define IEEE80211_C_FF          0x00000040      /* CAPABILITY: ATH FF avail */
 498 #define IEEE80211_C_TURBOP      0x00000080      /* CAPABILITY: ATH Turbo avail*/
 499 #define IEEE80211_C_IBSS        0x00000100      /* CAPABILITY: IBSS available */
 500 #define IEEE80211_C_PMGT        0x00000200      /* CAPABILITY: Power mgmt */
 501 #define IEEE80211_C_HOSTAP      0x00000400      /* CAPABILITY: HOSTAP avail */
 502 #define IEEE80211_C_AHDEMO      0x00000800      /* CAPABILITY: Old Adhoc Demo */
 503 #define IEEE80211_C_SWRETRY     0x00001000      /* CAPABILITY: sw tx retry */
 504 #define IEEE80211_C_TXPMGT      0x00002000      /* CAPABILITY: tx power mgmt */
 505 #define IEEE80211_C_SHSLOT      0x00004000      /* CAPABILITY: short slottime */
 506 #define IEEE80211_C_SHPREAMBLE  0x00008000      /* CAPABILITY: short preamble */
 507 #define IEEE80211_C_MONITOR     0x00010000      /* CAPABILITY: monitor mode */
 508 #define IEEE80211_C_DFS         0x00020000      /* CAPABILITY: DFS/radar avail*/
 509 /* 0x7c0000 available */
 510 #define IEEE80211_C_WPA1        0x00800000      /* CAPABILITY: WPA1 avail */
 511 #define IEEE80211_C_WPA2        0x01000000      /* CAPABILITY: WPA2 avail */
 512 #define IEEE80211_C_WPA         0x01800000      /* CAPABILITY: WPA1+WPA2 avail*/
 513 #define IEEE80211_C_BURST       0x02000000      /* CAPABILITY: frame bursting */
 514 #define IEEE80211_C_WME         0x04000000      /* CAPABILITY: WME avail */
 515 #define IEEE80211_C_WDS         0x08000000      /* CAPABILITY: 4-addr support */
 516 /* 0x10000000 reserved */
 517 #define IEEE80211_C_BGSCAN      0x20000000      /* CAPABILITY: bg scanning */
 518 #define IEEE80211_C_TXFRAG      0x40000000      /* CAPABILITY: tx fragments */
 519 /* XXX protection/barker? */
 520
 521 #define IEEE80211_C_OPMODE \
 522         (IEEE80211_C_STA | IEEE80211_C_IBSS | IEEE80211_C_HOSTAP | \
 523          IEEE80211_C_AHDEMO | IEEE80211_C_MONITOR | IEEE80211_C_WDS)
 524
 525 /*
 526  * ic_htcaps/iv_htcaps: HT-specific device/driver capabilities
 527  *
 528  * NB: the low 16-bits are the 802.11 definitions, the upper
 529  *     16-bits are used to define s/w/driver capabilities.
 530  */
 531 #define IEEE80211_HTC_AMPDU     0x00010000      /* CAPABILITY: A-MPDU tx */
 532 #define IEEE80211_HTC_AMSDU     0x00020000      /* CAPABILITY: A-MSDU tx */
 533 /* NB: HT40 is implied by IEEE80211_HTCAP_CHWIDTH40 */
 534 #define IEEE80211_HTC_HT        0x00040000      /* CAPABILITY: HT operation */
 535
 536 void    ieee80211_ifattach(struct ieee80211com *);
 537 void    ieee80211_ifdetach(struct ieee80211com *);
 538 int     ieee80211_vap_setup(struct ieee80211com *, struct ieee80211vap *,
 539                 const char name[IFNAMSIZ], int unit, int opmode, int flags,
 540                 const uint8_t bssid[IEEE80211_ADDR_LEN],
 541                 const uint8_t macaddr[IEEE80211_ADDR_LEN]);
 542 int     ieee80211_vap_attach(struct ieee80211vap *,
 543                 ifm_change_cb_t, ifm_stat_cb_t);
 544 void    ieee80211_vap_detach(struct ieee80211vap *);
 545 const struct ieee80211_rateset *ieee80211_get_suprates(struct ieee80211com *ic,
 546                 const struct ieee80211_channel *);
 547 void    ieee80211_announce(struct ieee80211com *);
 548 void    ieee80211_announce_channels(struct ieee80211com *);
 549 void    ieee80211_drain(struct ieee80211com *);
 550 void    ieee80211_media_init(struct ieee80211com *);
 551 struct ieee80211com *ieee80211_find_vap(const uint8_t mac[IEEE80211_ADDR_LEN]);
 552 int     ieee80211_media_change(struct ifnet *);
 553 void    ieee80211_media_status(struct ifnet *, struct ifmediareq *);
 554 int     ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
 555 int     ieee80211_rate2media(struct ieee80211com *, int,
 556                 enum ieee80211_phymode);
 557 int     ieee80211_media2rate(int);
 558 int     ieee80211_mhz2ieee(u_int, u_int);
 559 int     ieee80211_chan2ieee(struct ieee80211com *,
 560                 const struct ieee80211_channel *);
 561 u_int   ieee80211_ieee2mhz(u_int, u_int);
 562 struct ieee80211_channel *ieee80211_find_channel(struct ieee80211com *,
 563                 int freq, int flags);
 564 struct ieee80211_channel *ieee80211_find_channel_byieee(struct ieee80211com *,
 565                 int ieee, int flags);
 566 int     ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
 567 enum ieee80211_phymode ieee80211_chan2mode(const struct ieee80211_channel *);
 568
 569 /*
 570  * Key update synchronization methods.  XXX should not be visible.
 571  */
 572 static __inline void
 573 ieee80211_key_update_begin(struct ieee80211vap *vap)
 574 {
 575         vap->iv_key_update_begin(vap);
 576 }
 577 static __inline void
 578 ieee80211_key_update_end(struct ieee80211vap *vap)
 579 {
 580         vap->iv_key_update_end(vap);
 581 }
 582
 583 /*
 584  * XXX these need to be here for IEEE80211_F_DATAPAD
 585  */
 586
 587 /*
 588  * Return the space occupied by the 802.11 header and any
 589  * padding required by the driver.  This works for a
 590  * management or data frame.
 591  */
 592 static __inline int
 593 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
 594 {
 595         int size = ieee80211_hdrsize(data);
 596         if (ic->ic_flags & IEEE80211_F_DATAPAD)
 597                 size = roundup(size, sizeof(uint32_t));
 598         return size;
 599 }
 600
 601 /*
 602  * Like ieee80211_hdrspace, but handles any type of frame.
 603  */
 604 static __inline int
 605 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
 606 {
 607         int size = ieee80211_anyhdrsize(data);
 608         if (ic->ic_flags & IEEE80211_F_DATAPAD)
 609                 size = roundup(size, sizeof(uint32_t));
 610         return size;
 611 }
 612
 613 /*
 614  * Notify a vap that beacon state has been updated.
 615  */
 616 static __inline void
 617 ieee80211_beacon_notify(struct ieee80211vap *vap, int what)
 618 {
 619         if (vap->iv_state == IEEE80211_S_RUN)
 620                 vap->iv_update_beacon(vap, what);
 621 }
 622
 623 /*
 624  * Calculate HT channel promotion flags for a channel.
 625  * XXX belongs in ieee80211_ht.h but needs IEEE80211_FEXT_*
 626  */
 627 static __inline int
 628 ieee80211_htchanflags(const struct ieee80211_channel *c)
 629 {
 630         return IEEE80211_IS_CHAN_HT40(c) ?
 631             IEEE80211_FEXT_HT | IEEE80211_FEXT_USEHT40 :
 632             IEEE80211_IS_CHAN_HT(c) ?  IEEE80211_FEXT_HT : 0;
 633 }
 634
 635 /*
 636  * Debugging facilities compiled in when IEEE80211_DEBUG is defined.
 637  *
 638  * The intent is that any problem in the net80211 layer can be
 639  * diagnosed by inspecting the statistics (dumped by the wlanstats
 640  * program) and/or the msgs generated by net80211.  Messages are
 641  * broken into functional classes and can be controlled with the
 642  * wlandebug program.  Certain of these msg groups are for facilities
 643  * that are no longer part of net80211 (e.g. IEEE80211_MSG_DOT1X).
 644  */
 645 #define IEEE80211_MSG_11N       0x80000000      /* 11n mode debug */
 646 #define IEEE80211_MSG_DEBUG     0x40000000      /* IFF_DEBUG equivalent */
 647 #define IEEE80211_MSG_DUMPPKTS  0x20000000      /* IFF_LINK2 equivalant */
 648 #define IEEE80211_MSG_CRYPTO    0x10000000      /* crypto work */
 649 #define IEEE80211_MSG_INPUT     0x08000000      /* input handling */
 650 #define IEEE80211_MSG_XRATE     0x04000000      /* rate set handling */
 651 #define IEEE80211_MSG_ELEMID    0x02000000      /* element id parsing */
 652 #define IEEE80211_MSG_NODE      0x01000000      /* node handling */
 653 #define IEEE80211_MSG_ASSOC     0x00800000      /* association handling */
 654 #define IEEE80211_MSG_AUTH      0x00400000      /* authentication handling */
 655 #define IEEE80211_MSG_SCAN      0x00200000      /* scanning */
 656 #define IEEE80211_MSG_OUTPUT    0x00100000      /* output handling */
 657 #define IEEE80211_MSG_STATE     0x00080000      /* state machine */
 658 #define IEEE80211_MSG_POWER     0x00040000      /* power save handling */
 659 #define IEEE80211_MSG_DOT1X     0x00020000      /* 802.1x authenticator */
 660 #define IEEE80211_MSG_DOT1XSM   0x00010000      /* 802.1x state machine */
 661 #define IEEE80211_MSG_RADIUS    0x00008000      /* 802.1x radius client */
 662 #define IEEE80211_MSG_RADDUMP   0x00004000      /* dump 802.1x radius packets */
 663 #define IEEE80211_MSG_RADKEYS   0x00002000      /* dump 802.1x keys */
 664 #define IEEE80211_MSG_WPA       0x00001000      /* WPA/RSN protocol */
 665 #define IEEE80211_MSG_ACL       0x00000800      /* ACL handling */
 666 #define IEEE80211_MSG_WME       0x00000400      /* WME protocol */
 667 #define IEEE80211_MSG_SUPERG    0x00000200      /* Atheros SuperG protocol */
 668 #define IEEE80211_MSG_DOTH      0x00000100      /* 802.11h support */
 669 #define IEEE80211_MSG_INACT     0x00000080      /* inactivity handling */
 670 #define IEEE80211_MSG_ROAM      0x00000040      /* sta-mode roaming */
 671 #define IEEE80211_MSG_RATECTL   0x00000020      /* tx rate control */
 672 #define IEEE80211_MSG_ACTION    0x00000010      /* action frame handling */
 673 #define IEEE80211_MSG_WDS       0x00000008      /* WDS handling */
 674 #define IEEE80211_MSG_IOCTL     0x00000004      /* ioctl handling */
 675
 676 #define IEEE80211_MSG_ANY       0xffffffff      /* anything */
 677
 678 #ifdef IEEE80211_DEBUG
 679 #define ieee80211_msg(_vap, _m) ((_vap)->iv_debug & (_m))
 680 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...) do {                     \
 681         if (ieee80211_msg(_vap, _m))                                    \
 682                 ieee80211_note(_vap, _fmt, __VA_ARGS__);                \
 683 } while (0)
 684 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...) do {                   \
 685         if (ieee80211_msg(_vap, _m))                                    \
 686                 ieee80211_note_mac(_vap, (_ni)->ni_macaddr, _fmt, __VA_ARGS__);\
 687 } while (0)
 688 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...) do {              \
 689         if (ieee80211_msg(_vap, _m))                                    \
 690                 ieee80211_note_mac(_vap, _mac, _fmt, __VA_ARGS__);      \
 691 } while (0)
 692 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...) do {             \
 693         if (ieee80211_msg(_vap, _m))                                    \
 694                 ieee80211_note_frame(_vap, _wh, _fmt, __VA_ARGS__);     \
 695 } while (0)
 696 void    ieee80211_note(struct ieee80211vap *, const char *, ...);
 697 void    ieee80211_note_mac(struct ieee80211vap *,
 698                 const uint8_t mac[IEEE80211_ADDR_LEN], const char *, ...);
 699 void    ieee80211_note_frame(struct ieee80211vap *,
 700                 const struct ieee80211_frame *, const char *, ...);
 701 #define ieee80211_msg_debug(_vap) \
 702         ((_vap)->iv_debug & IEEE80211_MSG_DEBUG)
 703 #define ieee80211_msg_dumppkts(_vap) \
 704         ((_vap)->iv_debug & IEEE80211_MSG_DUMPPKTS)
 705 #define ieee80211_msg_input(_vap) \
 706         ((_vap)->iv_debug & IEEE80211_MSG_INPUT)
 707 #define ieee80211_msg_radius(_vap) \
 708         ((_vap)->iv_debug & IEEE80211_MSG_RADIUS)
 709 #define ieee80211_msg_dumpradius(_vap) \
 710         ((_vap)->iv_debug & IEEE80211_MSG_RADDUMP)
 711 #define ieee80211_msg_dumpradkeys(_vap) \
 712         ((_vap)->iv_debug & IEEE80211_MSG_RADKEYS)
 713 #define ieee80211_msg_scan(_vap) \
 714         ((_vap)->iv_debug & IEEE80211_MSG_SCAN)
 715 #define ieee80211_msg_assoc(_vap) \
 716         ((_vap)->iv_debug & IEEE80211_MSG_ASSOC)
 717
 718 /*
 719  * Emit a debug message about discarding a frame or information
 720  * element.  One format is for extracting the mac address from
 721  * the frame header; the other is for when a header is not
 722  * available or otherwise appropriate.
 723  */
 724 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...) do {         \
 725         if ((_vap)->iv_debug & (_m))                                    \
 726                 ieee80211_discard_frame(_vap, _wh, _type, _fmt, __VA_ARGS__);\
 727 } while (0)
 728 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...) do {      \
 729         if ((_vap)->iv_debug & (_m))                                    \
 730                 ieee80211_discard_ie(_vap, _wh, _type, _fmt, __VA_ARGS__);\
 731 } while (0)
 732 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...) do {    \
 733         if ((_vap)->iv_debug & (_m))                                    \
 734                 ieee80211_discard_mac(_vap, _mac, _type, _fmt, __VA_ARGS__);\
 735 } while (0)
 736
 737 void ieee80211_discard_frame(struct ieee80211vap *,
 738         const struct ieee80211_frame *, const char *type, const char *fmt, ...);
 739 void ieee80211_discard_ie(struct ieee80211vap *,
 740         const struct ieee80211_frame *, const char *type, const char *fmt, ...);
 741 void ieee80211_discard_mac(struct ieee80211vap *,
 742         const uint8_t mac[IEEE80211_ADDR_LEN], const char *type,
 743         const char *fmt, ...);
 744 #else
 745 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...)
 746 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...)
 747 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...)
 748 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...)
 749 #define ieee80211_msg_dumppkts(_vap)    0
 750 #define ieee80211_msg(_vap, _m)         0
 751
 752 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...)
 753 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...)
 754 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...)
 755 #endif
 756
 757 #endif /* _NET80211_IEEE80211_VAR_H_ */