]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/net80211/ieee80211_var.h
vmm(4): Fix a typo in a kernel message
[FreeBSD/FreeBSD.git] / sys / net80211 / ieee80211_var.h
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Atsushi Onoe
5  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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 #if defined(__NetBSD__)
36 #include <net80211/ieee80211_netbsd.h>
37 #elif defined(__FreeBSD__)
38 #include <net80211/ieee80211_freebsd.h>
39 #elif defined(__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_ageq.h>
48 #include <net80211/ieee80211_crypto.h>
49 #include <net80211/ieee80211_dfs.h>
50 #include <net80211/ieee80211_ioctl.h>           /* for ieee80211_stats */
51 #include <net80211/ieee80211_phy.h>
52 #include <net80211/ieee80211_power.h>
53 #include <net80211/ieee80211_node.h>
54 #include <net80211/ieee80211_proto.h>
55 #include <net80211/ieee80211_radiotap.h>
56 #include <net80211/ieee80211_scan.h>
57
58 #define IEEE80211_TXPOWER_MAX   100     /* .5 dBm (XXX units?) */
59 #define IEEE80211_TXPOWER_MIN   0       /* kill radio */
60
61 #define IEEE80211_DTIM_DEFAULT  1       /* default DTIM period */
62 #define IEEE80211_BINTVAL_DEFAULT 100   /* default beacon interval (TU's) */
63
64 #define IEEE80211_BMISS_MAX     2       /* maximum consecutive bmiss allowed */
65 #define IEEE80211_HWBMISS_DEFAULT 7     /* h/w bmiss threshold (beacons) */
66
67 #define IEEE80211_BGSCAN_INTVAL_MIN     15      /* min bg scan intvl (secs) */
68 #define IEEE80211_BGSCAN_INTVAL_DEFAULT (5*60)  /* default bg scan intvl */
69
70 #define IEEE80211_BGSCAN_IDLE_MIN       100     /* min idle time (ms) */
71 #define IEEE80211_BGSCAN_IDLE_DEFAULT   250     /* default idle time (ms) */
72
73 #define IEEE80211_SCAN_VALID_MIN        10      /* min scan valid time (secs) */
74 #define IEEE80211_SCAN_VALID_DEFAULT    60      /* default scan valid time */
75
76 #define IEEE80211_PS_SLEEP      0x1     /* STA is in power saving mode */
77 #define IEEE80211_PS_MAX_QUEUE  50      /* maximum saved packets */
78
79 #define IEEE80211_FIXED_RATE_NONE       0xff
80 #define IEEE80211_TXMAX_DEFAULT         6       /* default ucast max retries */
81
82 #define IEEE80211_RTS_DEFAULT           IEEE80211_RTS_MAX
83 #define IEEE80211_FRAG_DEFAULT          IEEE80211_FRAG_MAX
84
85 #define IEEE80211_MS_TO_TU(x)   (((x) * 1000) / 1024)
86 #define IEEE80211_TU_TO_MS(x)   (((x) * 1024) / 1000)
87 /* XXX TODO: cap this at 1, in case hz is not 1000 */
88 #define IEEE80211_TU_TO_TICKS(x)(((uint64_t)(x) * 1024 * hz) / (1000 * 1000))
89
90 /*
91  * Technically, vhtflags may be 0 /and/ 11ac is enabled.
92  * At some point ic should just grow a flag somewhere that
93  * says that VHT is supported - and then this macro can be
94  * changed.
95  */
96 #define IEEE80211_CONF_VHT(ic)                  \
97             ((ic)->ic_flags_ext & IEEE80211_FEXT_VHT)
98
99 #define IEEE80211_CONF_SEQNO_OFFLOAD(ic)        \
100             ((ic)->ic_flags_ext & IEEE80211_FEXT_SEQNO_OFFLOAD)
101 #define IEEE80211_CONF_FRAG_OFFLOAD(ic) \
102             ((ic)->ic_flags_ext & IEEE80211_FEXT_FRAG_OFFLOAD)
103
104 /*
105  * 802.11 control state is split into a common portion that maps
106  * 1-1 to a physical device and one or more "Virtual AP's" (VAP)
107  * that are bound to an ieee80211com instance and share a single
108  * underlying device.  Each VAP has a corresponding OS device
109  * entity through which traffic flows and that applications use
110  * for issuing ioctls, etc.
111  */
112
113 /*
114  * Data common to one or more virtual AP's.  State shared by
115  * the underlying device and the net80211 layer is exposed here;
116  * e.g. device-specific callbacks.
117  */
118 struct ieee80211vap;
119 typedef void (*ieee80211vap_attach)(struct ieee80211vap *);
120
121 struct ieee80211_appie {
122         uint16_t                ie_len;         /* size of ie_data */
123         uint8_t                 ie_data[];      /* user-specified IE's */
124 };
125
126 struct ieee80211_tdma_param;
127 struct ieee80211_rate_table;
128 struct ieee80211_tx_ampdu;
129 struct ieee80211_rx_ampdu;
130 struct ieee80211_superg;
131 struct ieee80211_frame;
132
133 struct net80211dump_methods;
134
135 struct ieee80211com {
136         void                    *ic_softc;      /* driver softc */
137         const char              *ic_name;       /* usually device name */
138         ieee80211_com_lock_t    ic_comlock;     /* state update lock */
139         ieee80211_tx_lock_t     ic_txlock;      /* ic/vap TX lock */
140         ieee80211_ff_lock_t     ic_fflock;      /* stageq/ni_tx_superg lock */
141         LIST_ENTRY(ieee80211com)   ic_next;     /* on global list */
142         TAILQ_HEAD(, ieee80211vap) ic_vaps;     /* list of vap instances */
143         int                     ic_headroom;    /* driver tx headroom needs */
144         enum ieee80211_phytype  ic_phytype;     /* XXX wrong for multi-mode */
145         enum ieee80211_opmode   ic_opmode;      /* operation mode */
146         struct callout          ic_inact;       /* inactivity processing */
147         struct taskqueue        *ic_tq;         /* deferred state thread */
148         struct task             ic_parent_task; /* deferred parent processing */
149         struct task             ic_promisc_task;/* deferred promisc update */
150         struct task             ic_mcast_task;  /* deferred mcast update */
151         struct task             ic_chan_task;   /* deferred channel change */
152         struct task             ic_bmiss_task;  /* deferred beacon miss hndlr */
153         struct task             ic_chw_task;    /* deferred HT CHW update */
154         struct task             ic_restart_task; /* deferred device restart */
155
156         counter_u64_t           ic_ierrors;     /* input errors */
157         counter_u64_t           ic_oerrors;     /* output errors */
158
159         uint32_t                ic_flags;       /* state flags */
160         uint32_t                ic_flags_ext;   /* extended state flags */
161         uint32_t                ic_flags_ht;    /* HT state flags */
162         uint32_t                ic_flags_ven;   /* vendor state flags */
163         uint32_t                ic_caps;        /* capabilities */
164         uint32_t                ic_htcaps;      /* HT capabilities */
165         uint32_t                ic_htextcaps;   /* HT extended capabilities */
166         uint32_t                ic_cryptocaps;  /* crypto capabilities */
167                                                 /* set of mode capabilities */
168         uint8_t                 ic_modecaps[IEEE80211_MODE_BYTES];
169         uint8_t                 ic_promisc;     /* vap's needing promisc mode */
170         uint8_t                 ic_allmulti;    /* vap's needing all multicast*/
171         uint8_t                 ic_nrunning;    /* vap's marked running */
172         uint8_t                 ic_curmode;     /* current mode */
173         uint8_t                 ic_macaddr[IEEE80211_ADDR_LEN];
174         uint16_t                ic_bintval;     /* beacon interval */
175         uint16_t                ic_lintval;     /* listen interval */
176         uint16_t                ic_holdover;    /* PM hold over duration */
177         uint16_t                ic_txpowlimit;  /* global tx power limit */
178         struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
179         struct ieee80211_htrateset ic_sup_htrates;
180
181         /*
182          * Channel state:
183          *
184          * ic_channels is the set of available channels for the device;
185          *    it is setup by the driver
186          * ic_nchans is the number of valid entries in ic_channels
187          * ic_chan_avail is a bit vector of these channels used to check
188          *    whether a channel is available w/o searching the channel table.
189          * ic_chan_active is a (potentially) constrained subset of
190          *    ic_chan_avail that reflects any mode setting or user-specified
191          *    limit on the set of channels to use/scan
192          * ic_curchan is the current channel the device is set to; it may
193          *    be different from ic_bsschan when we are off-channel scanning
194          *    or otherwise doing background work
195          * ic_bsschan is the channel selected for operation; it may
196          *    be undefined (IEEE80211_CHAN_ANYC)
197          * ic_prevchan is a cached ``previous channel'' used to optimize
198          *    lookups when switching back+forth between two channels
199          *    (e.g. for dynamic turbo)
200          */
201         int                     ic_nchans;      /* # entries in ic_channels */
202         struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX];
203         uint8_t                 ic_chan_avail[IEEE80211_CHAN_BYTES];
204         uint8_t                 ic_chan_active[IEEE80211_CHAN_BYTES];
205         uint8_t                 ic_chan_scan[IEEE80211_CHAN_BYTES];
206         struct ieee80211_channel *ic_curchan;   /* current channel */
207         const struct ieee80211_rate_table *ic_rt; /* table for ic_curchan */
208         struct ieee80211_channel *ic_bsschan;   /* bss channel */
209         struct ieee80211_channel *ic_prevchan;  /* previous channel */
210         struct ieee80211_regdomain ic_regdomain;/* regulatory data */
211         struct ieee80211_appie  *ic_countryie;  /* calculated country ie */
212         struct ieee80211_channel *ic_countryie_chan;
213
214         /* 802.11h/DFS state */
215         struct ieee80211_channel *ic_csa_newchan;/* channel for doing CSA */
216         short                   ic_csa_mode;    /* mode for doing CSA */
217         short                   ic_csa_count;   /* count for doing CSA */
218         struct ieee80211_dfs_state ic_dfs;      /* DFS state */
219
220         struct ieee80211_scan_state *ic_scan;   /* scan state */
221         struct ieee80211_scan_methods *ic_scan_methods; /* scan methods */
222         int                     ic_lastdata;    /* time of last data frame */
223         int                     ic_lastscan;    /* time last scan completed */
224
225         /* NB: this is the union of all vap stations/neighbors */
226         int                     ic_max_keyix;   /* max h/w key index */
227         struct ieee80211_node_table ic_sta;     /* stations/neighbors */
228         struct ieee80211_ageq   ic_stageq;      /* frame staging queue */
229         uint32_t                ic_hash_key;    /* random key for mac hash */
230
231         /* XXX multi-bss: split out common/vap parts */
232         struct ieee80211_wme_state ic_wme;      /* WME/WMM state */
233
234         /* Protection mode for net80211 driven channel NICs */
235         enum ieee80211_protmode ic_protmode;    /* 802.11g protection mode */
236         enum ieee80211_protmode ic_htprotmode;  /* HT protection mode */
237         uint8_t                 ic_curhtprotmode;/* HTINFO bss state */
238
239         uint8_t                 ic_rxstream;    /* # RX streams */
240         uint8_t                 ic_txstream;    /* # TX streams */
241
242         /* VHT information */
243         uint32_t                ic_vht_flags;   /* VHT state flags */
244         struct ieee80211_vht_cap ic_vht_cap;    /* VHT capabilities + MCS info */
245         uint32_t                ic_vhtextcaps;  /* VHT extended capabilities (TODO) */
246         uint32_t                ic_vht_spare[3];
247
248         /* optional state for Atheros SuperG protocol extensions */
249         struct ieee80211_superg *ic_superg;
250
251         /* radiotap handling */
252         struct ieee80211_radiotap_header *ic_th;/* tx radiotap headers */
253         void                    *ic_txchan;     /* channel state in ic_th */
254         struct ieee80211_radiotap_header *ic_rh;/* rx radiotap headers */
255         void                    *ic_rxchan;     /* channel state in ic_rh */
256         int                     ic_montaps;     /* active monitor mode taps */
257
258         /* virtual ap create/delete */
259         struct ieee80211vap*    (*ic_vap_create)(struct ieee80211com *,
260                                     const char [IFNAMSIZ], int,
261                                     enum ieee80211_opmode, int,
262                                     const uint8_t [IEEE80211_ADDR_LEN],
263                                     const uint8_t [IEEE80211_ADDR_LEN]);
264         void                    (*ic_vap_delete)(struct ieee80211vap *);
265         /* device specific ioctls */
266         int                     (*ic_ioctl)(struct ieee80211com *,
267                                     u_long, void *);
268         /* start/stop device */
269         void                    (*ic_parent)(struct ieee80211com *);
270         /* operating mode attachment */
271         ieee80211vap_attach     ic_vattach[IEEE80211_OPMODE_MAX];
272         /* return hardware/radio capabilities */
273         void                    (*ic_getradiocaps)(struct ieee80211com *,
274                                     int, int *, struct ieee80211_channel []);
275         /* check and/or prepare regdomain state change */
276         int                     (*ic_setregdomain)(struct ieee80211com *,
277                                     struct ieee80211_regdomain *,
278                                     int, struct ieee80211_channel []);
279
280         int                     (*ic_set_quiet)(struct ieee80211_node *,
281                                     u_int8_t *quiet_elm);
282
283         /* regular transmit */
284         int                     (*ic_transmit)(struct ieee80211com *,
285                                     struct mbuf *);
286         /* send/recv 802.11 management frame */
287         int                     (*ic_send_mgmt)(struct ieee80211_node *,
288                                      int, int);
289         /* send raw 802.11 frame */
290         int                     (*ic_raw_xmit)(struct ieee80211_node *,
291                                     struct mbuf *,
292                                     const struct ieee80211_bpf_params *);
293         /* update device state for 802.11 slot time change */
294         void                    (*ic_updateslot)(struct ieee80211com *);
295         /* handle multicast state changes */
296         void                    (*ic_update_mcast)(struct ieee80211com *);
297         /* handle promiscuous mode changes */
298         void                    (*ic_update_promisc)(struct ieee80211com *);
299         /* new station association callback/notification */
300         void                    (*ic_newassoc)(struct ieee80211_node *, int);
301         /* TDMA update notification */
302         void                    (*ic_tdma_update)(struct ieee80211_node *,
303                                     const struct ieee80211_tdma_param *, int);
304
305         /* Node state management */
306
307         /* Allocate a new node */
308         struct ieee80211_node*  (*ic_node_alloc)(struct ieee80211vap *,
309                                     const uint8_t [IEEE80211_ADDR_LEN]);
310
311         /* Driver node initialisation after net80211 setup */
312         int                     (*ic_node_init)(struct ieee80211_node *);
313
314         /* Driver node deallocation */
315         void                    (*ic_node_free)(struct ieee80211_node *);
316
317         /* Driver node state cleanup before deallocation */
318         void                    (*ic_node_cleanup)(struct ieee80211_node *);
319
320         void                    (*ic_node_age)(struct ieee80211_node *);
321         void                    (*ic_node_drain)(struct ieee80211_node *);
322         int8_t                  (*ic_node_getrssi)(const struct ieee80211_node*);
323         void                    (*ic_node_getsignal)(const struct ieee80211_node*,
324                                     int8_t *, int8_t *);
325         void                    (*ic_node_getmimoinfo)(
326                                     const struct ieee80211_node*,
327                                     struct ieee80211_mimo_info *);
328         /* scanning support */
329         void                    (*ic_scan_start)(struct ieee80211com *);
330         void                    (*ic_scan_end)(struct ieee80211com *);
331         void                    (*ic_set_channel)(struct ieee80211com *);
332         void                    (*ic_scan_curchan)(struct ieee80211_scan_state *,
333                                     unsigned long);
334         void                    (*ic_scan_mindwell)(struct ieee80211_scan_state *);
335
336         /*
337          * 802.11n ADDBA support.  A simple/generic implementation
338          * of A-MPDU tx aggregation is provided; the driver may
339          * override these methods to provide their own support.
340          * A-MPDU rx re-ordering happens automatically if the
341          * driver passes out-of-order frames to ieee80211_input
342          * from an assocated HT station.
343          */
344         int                     (*ic_recv_action)(struct ieee80211_node *,
345                                     const struct ieee80211_frame *,
346                                     const uint8_t *frm, const uint8_t *efrm);
347         int                     (*ic_send_action)(struct ieee80211_node *,
348                                     int category, int action, void *);
349         /* check if A-MPDU should be enabled this station+ac */
350         int                     (*ic_ampdu_enable)(struct ieee80211_node *,
351                                     struct ieee80211_tx_ampdu *);
352         /* start/stop doing A-MPDU tx aggregation for a station */
353         int                     (*ic_addba_request)(struct ieee80211_node *,
354                                     struct ieee80211_tx_ampdu *,
355                                     int dialogtoken, int baparamset,
356                                     int batimeout);
357         int                     (*ic_addba_response)(struct ieee80211_node *,
358                                     struct ieee80211_tx_ampdu *,
359                                     int status, int baparamset, int batimeout);
360         void                    (*ic_addba_stop)(struct ieee80211_node *,
361                                     struct ieee80211_tx_ampdu *);
362         void                    (*ic_addba_response_timeout)(struct ieee80211_node *,
363                                     struct ieee80211_tx_ampdu *);
364         /* BAR response received */
365         void                    (*ic_bar_response)(struct ieee80211_node *,
366                                     struct ieee80211_tx_ampdu *, int status);
367         /* start/stop doing A-MPDU rx processing for a station */
368         int                     (*ic_ampdu_rx_start)(struct ieee80211_node *,
369                                     struct ieee80211_rx_ampdu *, int baparamset,
370                                     int batimeout, int baseqctl);
371         void                    (*ic_ampdu_rx_stop)(struct ieee80211_node *,
372                                     struct ieee80211_rx_ampdu *);
373
374         /* The channel width has changed (20<->2040) */
375         void                    (*ic_update_chw)(struct ieee80211com *);
376
377         const struct debugnet80211_methods      *ic_debugnet_meth;
378         uint64_t                ic_spare[7];
379 };
380
381 struct ieee80211_aclator;
382 struct ieee80211_tdma_state;
383 struct ieee80211_mesh_state;
384 struct ieee80211_hwmp_state;
385 struct ieee80211_rx_histogram;
386 struct ieee80211_tx_histogram;
387
388 struct ieee80211vap {
389         struct ifmedia          iv_media;       /* interface media config */
390         struct ifnet            *iv_ifp;        /* associated device */
391         struct bpf_if           *iv_rawbpf;     /* packet filter structure */
392         struct sysctl_ctx_list  *iv_sysctl;     /* dynamic sysctl context */
393         struct sysctl_oid       *iv_oid;        /* net.wlan.X sysctl oid */
394
395         TAILQ_ENTRY(ieee80211vap) iv_next;      /* list of vap instances */
396         struct ieee80211com     *iv_ic;         /* back ptr to common state */
397         /* MAC address: ifp or ic */
398         uint8_t                 iv_myaddr[IEEE80211_ADDR_LEN];
399         uint32_t                iv_debug;       /* debug msg flags */
400         struct ieee80211_stats  iv_stats;       /* statistics */
401
402         uint32_t                iv_flags;       /* state flags */
403         uint32_t                iv_flags_ext;   /* extended state flags */
404         uint32_t                iv_flags_ht;    /* HT state flags */
405         uint32_t                iv_flags_ven;   /* vendor state flags */
406         uint32_t                iv_ifflags;     /* ifnet flags */
407         uint32_t                iv_caps;        /* capabilities */
408         uint32_t                iv_htcaps;      /* HT capabilities */
409         uint32_t                iv_htextcaps;   /* HT extended capabilities */
410         uint32_t                iv_com_state;   /* com usage / detached flag */
411         enum ieee80211_opmode   iv_opmode;      /* operation mode */
412         enum ieee80211_state    iv_state;       /* state machine state */
413
414         /* Deferred state processing. */
415         enum ieee80211_state    iv_nstate;              /* next pending state (historic) */
416 #define NET80211_IV_NSTATE_NUM  8
417         int                     iv_nstate_b;            /* First filled slot. */
418         int                     iv_nstate_n;            /* # of filled slots. */
419         enum ieee80211_state    iv_nstates[NET80211_IV_NSTATE_NUM];     /* queued pending state(s) */
420         int                     iv_nstate_args[NET80211_IV_NSTATE_NUM]; /* queued pending state(s) arg */
421         struct task             iv_nstate_task[NET80211_IV_NSTATE_NUM];
422
423         struct task             iv_swbmiss_task;/* deferred iv_bmiss call */
424         struct callout          iv_mgtsend;     /* mgmt frame response timer */
425                                                 /* inactivity timer settings */
426         int                     iv_inact_init;  /* setting for new station */
427         int                     iv_inact_auth;  /* auth but not assoc setting */
428         int                     iv_inact_run;   /* authorized setting */
429         int                     iv_inact_probe; /* inactive probe time */
430
431         /* VHT flags */
432         uint32_t                iv_vht_flags;   /* VHT state flags */
433         struct ieee80211_vht_cap iv_vht_cap;    /* VHT capabilities + MCS info */
434         uint32_t                iv_vhtextcaps;  /* VHT extended capabilities (TODO) */
435         uint32_t                iv_vht_spare[4];
436
437         int                     iv_des_nssid;   /* # desired ssids */
438         struct ieee80211_scan_ssid iv_des_ssid[1];/* desired ssid table */
439         uint8_t                 iv_des_bssid[IEEE80211_ADDR_LEN];
440         struct ieee80211_channel *iv_des_chan;  /* desired channel */
441         uint16_t                iv_des_mode;    /* desired mode */
442         int                     iv_nicknamelen; /* XXX junk */
443         uint8_t                 iv_nickname[IEEE80211_NWID_LEN];
444         u_int                   iv_bgscanidle;  /* bg scan idle threshold */
445         u_int                   iv_bgscanintvl; /* bg scan min interval */
446         u_int                   iv_scanvalid;   /* scan cache valid threshold */
447         u_int                   iv_scanreq_duration;
448         u_int                   iv_scanreq_mindwell;
449         u_int                   iv_scanreq_maxdwell;
450         uint16_t                iv_scanreq_flags;/* held scan request params */
451         uint8_t                 iv_scanreq_nssid;
452         struct ieee80211_scan_ssid iv_scanreq_ssid[IEEE80211_SCAN_MAX_SSID];
453         /* sta-mode roaming state */
454         enum ieee80211_roamingmode iv_roaming;  /* roaming mode */
455         struct ieee80211_roamparam iv_roamparms[IEEE80211_MODE_MAX];
456
457         uint8_t                 iv_bmissthreshold;
458         uint8_t                 iv_bmiss_count; /* current beacon miss count */
459         int                     iv_bmiss_max;   /* max bmiss before scan */
460         uint16_t                iv_swbmiss_count;/* beacons in last period */
461         uint16_t                iv_swbmiss_period;/* s/w bmiss period */
462         struct callout          iv_swbmiss;     /* s/w beacon miss timer */
463
464         int                     iv_ampdu_rxmax; /* A-MPDU rx limit (bytes) */
465         int                     iv_ampdu_density;/* A-MPDU density */
466         int                     iv_ampdu_limit; /* A-MPDU tx limit (bytes) */
467         int                     iv_amsdu_limit; /* A-MSDU tx limit (bytes) */
468         u_int                   iv_ampdu_mintraffic[WME_NUM_AC];
469
470         struct ieee80211_beacon_offsets iv_bcn_off;
471         uint32_t                *iv_aid_bitmap; /* association id map */
472         uint16_t                iv_max_aid;
473         uint16_t                iv_sta_assoc;   /* stations associated */
474         uint16_t                iv_ps_sta;      /* stations in power save */
475         uint16_t                iv_ps_pending;  /* ps sta's w/ pending frames */
476         uint16_t                iv_txseq;       /* mcast xmit seq# space */
477         uint16_t                iv_tim_len;     /* ic_tim_bitmap size (bytes) */
478         uint8_t                 *iv_tim_bitmap; /* power-save stations w/ data*/
479         uint8_t                 iv_dtim_period; /* DTIM period */
480         uint8_t                 iv_dtim_count;  /* DTIM count from last bcn */
481                                                 /* set/unset aid pwrsav state */
482         uint8_t                 iv_quiet;       /* Quiet Element */
483         uint8_t                 iv_quiet_count; /* constant count for Quiet Element */
484         uint8_t                 iv_quiet_count_value;   /* variable count for Quiet Element */
485         uint8_t                 iv_quiet_period;        /* period for Quiet Element */
486         uint16_t                iv_quiet_duration;      /* duration for Quiet Element */
487         uint16_t                iv_quiet_offset;        /* offset for Quiet Element */
488         int                     iv_csa_count;   /* count for doing CSA */
489
490         struct ieee80211_node   *iv_bss;        /* information for this node */
491         struct ieee80211_txparam iv_txparms[IEEE80211_MODE_MAX];
492         uint16_t                iv_rtsthreshold;
493         uint16_t                iv_fragthreshold;
494         int                     iv_inact_timer; /* inactivity timer wait */
495         /* application-specified IE's to attach to mgt frames */
496         struct ieee80211_appie  *iv_appie_beacon;
497         struct ieee80211_appie  *iv_appie_probereq;
498         struct ieee80211_appie  *iv_appie_proberesp;
499         struct ieee80211_appie  *iv_appie_assocreq;
500         struct ieee80211_appie  *iv_appie_assocresp;
501         struct ieee80211_appie  *iv_appie_wpa;
502         uint8_t                 *iv_wpa_ie;
503         uint8_t                 *iv_rsn_ie;
504
505         /* Key management */
506         uint16_t                iv_max_keyix;   /* max h/w key index */
507         ieee80211_keyix         iv_def_txkey;   /* default/group tx key index */
508         struct ieee80211_key    iv_nw_keys[IEEE80211_WEP_NKID];
509         int                     (*iv_key_alloc)(struct ieee80211vap *,
510                                     struct ieee80211_key *,
511                                     ieee80211_keyix *, ieee80211_keyix *);
512         int                     (*iv_key_delete)(struct ieee80211vap *, 
513                                     const struct ieee80211_key *);
514         int                     (*iv_key_set)(struct ieee80211vap *,
515                                     const struct ieee80211_key *);
516         void                    (*iv_key_update_begin)(struct ieee80211vap *);
517         void                    (*iv_key_update_end)(struct ieee80211vap *);
518         void                    (*iv_update_deftxkey)(struct ieee80211vap *,
519                                     ieee80211_keyix deftxkey);
520
521         const struct ieee80211_authenticator *iv_auth; /* authenticator glue */
522         void                    *iv_ec;         /* private auth state */
523
524         const struct ieee80211_aclator *iv_acl; /* acl glue */
525         void                    *iv_as;         /* private aclator state */
526
527         const struct ieee80211_ratectl *iv_rate;
528         void                    *iv_rs;         /* private ratectl state */
529
530         struct ieee80211_tdma_state *iv_tdma;   /* tdma state */
531         struct ieee80211_mesh_state *iv_mesh;   /* MBSS state */
532         struct ieee80211_hwmp_state *iv_hwmp;   /* HWMP state */
533
534         /* operate-mode detach hook */
535         void                    (*iv_opdetach)(struct ieee80211vap *);
536         /* receive processing */
537         int                     (*iv_input)(struct ieee80211_node *,
538                                     struct mbuf *,
539                                     const struct ieee80211_rx_stats *,
540                                     int, int);
541         void                    (*iv_recv_mgmt)(struct ieee80211_node *,
542                                     struct mbuf *, int,
543                                     const struct ieee80211_rx_stats *,
544                                     int, int);
545         void                    (*iv_recv_ctl)(struct ieee80211_node *,
546                                     struct mbuf *, int);
547         void                    (*iv_deliver_data)(struct ieee80211vap *,
548                                     struct ieee80211_node *, struct mbuf *);
549 #if 0
550         /* send processing */
551         int                     (*iv_send_mgmt)(struct ieee80211_node *,
552                                      int, int);
553 #endif
554         /* beacon miss processing */
555         void                    (*iv_bmiss)(struct ieee80211vap *);
556         /* reset device state after 802.11 parameter/state change */
557         int                     (*iv_reset)(struct ieee80211vap *, u_long);
558         /* [schedule] beacon frame update */
559         void                    (*iv_update_beacon)(struct ieee80211vap *, int);
560         /* power save handling */
561         void                    (*iv_update_ps)(struct ieee80211vap *, int);
562         int                     (*iv_set_tim)(struct ieee80211_node *, int);
563         void                    (*iv_node_ps)(struct ieee80211_node *, int);
564         void                    (*iv_sta_ps)(struct ieee80211vap *, int);
565         void                    (*iv_recv_pspoll)(struct ieee80211_node *,
566                                     struct mbuf *);
567
568         /* state machine processing */
569         int                     (*iv_newstate)(struct ieee80211vap *,
570                                     enum ieee80211_state, int);
571         struct ieee80211_node * (*iv_update_bss)(struct ieee80211vap *,
572                                     struct ieee80211_node *);
573
574         /* 802.3 output method for raw frame xmit */
575         int                     (*iv_output)(struct ifnet *, struct mbuf *,
576                                     const struct sockaddr *, struct route *);
577
578         int                     (*iv_wme_update)(struct ieee80211vap *,
579                                     const struct wmeParams *wme_params);
580         struct task             iv_wme_task;    /* deferred VAP WME update */
581
582         /* associated state; protection mode */
583         enum ieee80211_protmode iv_protmode;    /* 802.11g protection mode */
584         enum ieee80211_protmode iv_htprotmode;  /* HT protection mode */
585         uint8_t                 iv_curhtprotmode;/* HTINFO bss state */
586
587         uint16_t                iv_nonerpsta;   /* # non-ERP stations */
588         uint16_t                iv_longslotsta; /* # long slot time stations */
589         uint16_t                iv_ht_sta_assoc;/* HT stations associated */
590         uint16_t                iv_ht40_sta_assoc;/* HT40 stations associated */
591         int                     iv_lastnonerp;  /* last time non-ERP sta noted*/
592         int                     iv_lastnonht;   /* last time non-HT sta noted */
593
594         /* update device state for 802.11 slot time change */
595         void                    (*iv_updateslot)(struct ieee80211vap *);
596         struct task             iv_slot_task;   /* deferred slot time update */
597
598         struct task             iv_erp_protmode_task;   /* deferred ERP protmode update */
599         void                    (*iv_erp_protmode_update)(struct ieee80211vap *);
600
601         struct task             iv_preamble_task;       /* deferred short/barker preamble update */
602         void                    (*iv_preamble_update)(struct ieee80211vap *);
603
604         struct task             iv_ht_protmode_task;    /* deferred HT protmode update */
605         void                    (*iv_ht_protmode_update)(struct ieee80211vap *);
606
607         /* per-vap U-APSD state */
608         uint8_t                 iv_uapsdinfo;   /* sta mode QoS Info flags */
609
610         /* Optional transmit/receive histogram statistics */
611         struct ieee80211_rx_histogram   *rx_histogram;
612         struct ieee80211_tx_histogram   *tx_histogram;
613
614         uint64_t                iv_spare[36];
615 };
616 MALLOC_DECLARE(M_80211_VAP);
617
618 #define IEEE80211_ADDR_EQ(a1,a2)        (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
619 #define IEEE80211_ADDR_COPY(dst,src)    memcpy(dst,src,IEEE80211_ADDR_LEN)
620
621 /* ic_flags/iv_flags */
622 #define IEEE80211_F_TURBOP      0x00000001      /* CONF: ATH Turbo enabled*/
623 #define IEEE80211_F_COMP        0x00000002      /* CONF: ATH comp enabled */
624 #define IEEE80211_F_FF          0x00000004      /* CONF: ATH FF enabled */
625 #define IEEE80211_F_BURST       0x00000008      /* CONF: bursting enabled */
626 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
627 #define IEEE80211_F_PRIVACY     0x00000010      /* CONF: privacy enabled */
628 #define IEEE80211_F_PUREG       0x00000020      /* CONF: 11g w/o 11b sta's */
629 #define IEEE80211_F_SCAN        0x00000080      /* STATUS: scanning */
630 /* 0x00000300 reserved */
631 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
632 #define IEEE80211_F_SHSLOT      0x00000400      /* STATUS: use short slot time*/
633 #define IEEE80211_F_PMGTON      0x00000800      /* CONF: Power mgmt enable */
634 #define IEEE80211_F_DESBSSID    0x00001000      /* CONF: des_bssid is set */
635 #define IEEE80211_F_WME         0x00002000      /* CONF: enable WME use */
636 #define IEEE80211_F_BGSCAN      0x00004000      /* CONF: bg scan enabled (???)*/
637 #define IEEE80211_F_SWRETRY     0x00008000      /* CONF: sw tx retry enabled */
638 /* 0x00030000 reserved */
639 #define IEEE80211_F_SHPREAMBLE  0x00040000      /* STATUS: use short preamble */
640 #define IEEE80211_F_DATAPAD     0x00080000      /* CONF: do alignment pad */
641 #define IEEE80211_F_USEPROT     0x00100000      /* STATUS: protection enabled */
642 #define IEEE80211_F_USEBARKER   0x00200000      /* STATUS: use barker preamble*/
643 #define IEEE80211_F_CSAPENDING  0x00400000      /* STATUS: chan switch pending*/
644 #define IEEE80211_F_WPA1        0x00800000      /* CONF: WPA enabled */
645 #define IEEE80211_F_WPA2        0x01000000      /* CONF: WPA2 enabled */
646 #define IEEE80211_F_WPA         0x01800000      /* CONF: WPA/WPA2 enabled */
647 #define IEEE80211_F_DROPUNENC   0x02000000      /* CONF: drop unencrypted */
648 #define IEEE80211_F_COUNTERM    0x04000000      /* CONF: TKIP countermeasures */
649 #define IEEE80211_F_HIDESSID    0x08000000      /* CONF: hide SSID in beacon */
650 #define IEEE80211_F_NOBRIDGE    0x10000000      /* CONF: dis. internal bridge */
651 #define IEEE80211_F_PCF         0x20000000      /* CONF: PCF enabled */
652 #define IEEE80211_F_DOTH        0x40000000      /* CONF: 11h enabled */
653 #define IEEE80211_F_DWDS        0x80000000      /* CONF: Dynamic WDS enabled */
654
655 #define IEEE80211_F_BITS \
656         "\20\1TURBOP\2COMP\3FF\4BURST\5PRIVACY\6PUREG\10SCAN" \
657         "\13SHSLOT\14PMGTON\15DESBSSID\16WME\17BGSCAN\20SWRETRY" \
658         "\23SHPREAMBLE\24DATAPAD\25USEPROT\26USERBARKER\27CSAPENDING" \
659         "\30WPA1\31WPA2\32DROPUNENC\33COUNTERM\34HIDESSID\35NOBRIDG\36PCF" \
660         "\37DOTH\40DWDS"
661
662 /* Atheros protocol-specific flags */
663 #define IEEE80211_F_ATHEROS \
664         (IEEE80211_F_FF | IEEE80211_F_COMP | IEEE80211_F_TURBOP)
665 /* Check if an Atheros capability was negotiated for use */
666 #define IEEE80211_ATH_CAP(vap, ni, bit) \
667         ((vap)->iv_flags & (ni)->ni_ath_flags & (bit))
668
669 /* ic_flags_ext/iv_flags_ext */
670 #define IEEE80211_FEXT_INACT     0x00000002     /* CONF: sta inact handling */
671 #define IEEE80211_FEXT_SCANWAIT  0x00000004     /* STATUS: awaiting scan */
672 /* 0x00000006 reserved */
673 #define IEEE80211_FEXT_BGSCAN    0x00000008     /* STATUS: complete bgscan */
674 #define IEEE80211_FEXT_WPS       0x00000010     /* CONF: WPS enabled */
675 #define IEEE80211_FEXT_TSN       0x00000020     /* CONF: TSN enabled */
676 #define IEEE80211_FEXT_SCANREQ   0x00000040     /* STATUS: scan req params */
677 #define IEEE80211_FEXT_RESUME    0x00000080     /* STATUS: start on resume */
678 #define IEEE80211_FEXT_4ADDR     0x00000100     /* CONF: apply 4-addr encap */
679 #define IEEE80211_FEXT_NONERP_PR 0x00000200     /* STATUS: non-ERP sta present*/
680 #define IEEE80211_FEXT_SWBMISS   0x00000400     /* CONF: do bmiss in s/w */
681 #define IEEE80211_FEXT_DFS       0x00000800     /* CONF: DFS enabled */
682 #define IEEE80211_FEXT_DOTD      0x00001000     /* CONF: 11d enabled */
683 #define IEEE80211_FEXT_STATEWAIT 0x00002000     /* STATUS: awaiting state chg */
684 #define IEEE80211_FEXT_REINIT    0x00004000     /* STATUS: INIT state first */
685 #define IEEE80211_FEXT_BPF       0x00008000     /* STATUS: BPF tap present */
686 /* NB: immutable: should be set only when creating a vap */
687 #define IEEE80211_FEXT_WDSLEGACY 0x00010000     /* CONF: legacy WDS operation */
688 #define IEEE80211_FEXT_PROBECHAN 0x00020000     /* CONF: probe passive channel*/
689 #define IEEE80211_FEXT_UNIQMAC   0x00040000     /* CONF: user or computed mac */
690 #define IEEE80211_FEXT_SCAN_OFFLOAD     0x00080000      /* CONF: scan is fully offloaded */
691 #define IEEE80211_FEXT_SEQNO_OFFLOAD    0x00100000      /* CONF: driver does seqno insertion/allocation */
692 #define IEEE80211_FEXT_FRAG_OFFLOAD     0x00200000      /* CONF: hardware does 802.11 fragmentation + assignment */
693 #define IEEE80211_FEXT_VHT      0x00400000      /* CONF: VHT support */
694 #define IEEE80211_FEXT_QUIET_IE 0x00800000      /* STATUS: quiet IE in a beacon has been added */
695 #define IEEE80211_FEXT_UAPSD    0x01000000      /* CONF: enable U-APSD */
696
697 #define IEEE80211_FEXT_BITS \
698         "\20\2INACT\3SCANWAIT\4BGSCAN\5WPS\6TSN\7SCANREQ\10RESUME" \
699         "\0114ADDR\12NONEPR_PR\13SWBMISS\14DFS\15DOTD\16STATEWAIT\17REINIT" \
700         "\20BPF\21WDSLEGACY\22PROBECHAN\23UNIQMAC\24SCAN_OFFLOAD\25SEQNO_OFFLOAD" \
701             "\26FRAG_OFFLOAD\27VHT" \
702         "\30QUIET_IE\31UAPSD"
703
704 /* ic_flags_ht/iv_flags_ht */
705 #define IEEE80211_FHT_NONHT_PR   0x00000001     /* STATUS: non-HT sta present */
706 #define IEEE80211_FHT_LDPC_TX    0x00010000     /* CONF: LDPC tx enabled */
707 #define IEEE80211_FHT_LDPC_RX    0x00020000     /* CONF: LDPC rx enabled */
708 #define IEEE80211_FHT_GF         0x00040000     /* CONF: Greenfield enabled */
709 #define IEEE80211_FHT_HT         0x00080000     /* CONF: HT supported */
710 #define IEEE80211_FHT_AMPDU_TX   0x00100000     /* CONF: A-MPDU tx supported */
711 #define IEEE80211_FHT_AMPDU_RX   0x00200000     /* CONF: A-MPDU rx supported */
712 #define IEEE80211_FHT_AMSDU_TX   0x00400000     /* CONF: A-MSDU tx supported */
713 #define IEEE80211_FHT_AMSDU_RX   0x00800000     /* CONF: A-MSDU rx supported */
714 #define IEEE80211_FHT_USEHT40    0x01000000     /* CONF: 20/40 use enabled */
715 #define IEEE80211_FHT_PUREN      0x02000000     /* CONF: 11n w/o legacy sta's */
716 #define IEEE80211_FHT_SHORTGI20  0x04000000     /* CONF: short GI in HT20 */
717 #define IEEE80211_FHT_SHORTGI40  0x08000000     /* CONF: short GI in HT40 */
718 #define IEEE80211_FHT_HTCOMPAT   0x10000000     /* CONF: HT vendor OUI's */
719 #define IEEE80211_FHT_RIFS       0x20000000     /* CONF: RIFS enabled */
720 #define IEEE80211_FHT_STBC_TX    0x40000000     /* CONF: STBC tx enabled */
721 #define IEEE80211_FHT_STBC_RX    0x80000000     /* CONF: STBC rx enabled */
722
723 #define IEEE80211_FHT_BITS \
724         "\20\1NONHT_PR" \
725         "\23GF\24HT\25AMPDU_TX\26AMPDU_TX" \
726         "\27AMSDU_TX\30AMSDU_RX\31USEHT40\32PUREN\33SHORTGI20\34SHORTGI40" \
727         "\35HTCOMPAT\36RIFS\37STBC_TX\40STBC_RX"
728
729 #define IEEE80211_FVEN_BITS     "\20"
730
731 #define IEEE80211_FVHT_VHT      0x000000001     /* CONF: VHT supported */
732 #define IEEE80211_FVHT_USEVHT40 0x000000002     /* CONF: Use VHT40 */
733 #define IEEE80211_FVHT_USEVHT80 0x000000004     /* CONF: Use VHT80 */
734 #define IEEE80211_FVHT_USEVHT160        0x000000008     /* CONF: Use VHT160 */
735 #define IEEE80211_FVHT_USEVHT80P80      0x000000010     /* CONF: Use VHT 80+80 */
736 #define IEEE80211_FVHT_MASK                                             \
737         (IEEE80211_FVHT_VHT | IEEE80211_FVHT_USEVHT40 |                 \
738         IEEE80211_FVHT_USEVHT80 | IEEE80211_FVHT_USEVHT160 |            \
739         IEEE80211_FVHT_USEVHT80P80)
740 #define IEEE80211_VFHT_BITS \
741         "\20\1VHT\2VHT40\3VHT80\4VHT160\5VHT80P80"
742
743 #define IEEE80211_COM_DETACHED  0x00000001      /* ieee80211_ifdetach called */
744 #define IEEE80211_COM_REF_ADD   0x00000002      /* add / remove reference */
745 #define IEEE80211_COM_REF       0xfffffffe      /* reference counter bits */
746 #define IEEE80211_COM_REF_S     1
747 #define IEEE80211_COM_REF_MAX   (IEEE80211_COM_REF >> IEEE80211_COM_REF_S)
748
749 int     ic_printf(struct ieee80211com *, const char *, ...) __printflike(2, 3);
750 void    ieee80211_ifattach(struct ieee80211com *);
751 void    ieee80211_ifdetach(struct ieee80211com *);
752 int     ieee80211_vap_setup(struct ieee80211com *, struct ieee80211vap *,
753                 const char name[IFNAMSIZ], int unit,
754                 enum ieee80211_opmode opmode, int flags,
755                 const uint8_t bssid[IEEE80211_ADDR_LEN]);
756 int     ieee80211_vap_attach(struct ieee80211vap *,
757                 ifm_change_cb_t, ifm_stat_cb_t,
758                 const uint8_t macaddr[IEEE80211_ADDR_LEN]);
759 void    ieee80211_vap_detach(struct ieee80211vap *);
760 const struct ieee80211_rateset *ieee80211_get_suprates(struct ieee80211com *ic,
761                 const struct ieee80211_channel *);
762 const struct ieee80211_htrateset *ieee80211_get_suphtrates(
763                 struct ieee80211com *, const struct ieee80211_channel *);
764 void    ieee80211_announce(struct ieee80211com *);
765 void    ieee80211_announce_channels(struct ieee80211com *);
766 void    ieee80211_drain(struct ieee80211com *);
767 void    ieee80211_chan_init(struct ieee80211com *);
768 struct ieee80211com *ieee80211_find_vap(const uint8_t mac[IEEE80211_ADDR_LEN]);
769 struct ieee80211com *ieee80211_find_com(const char *name);
770 typedef void ieee80211_com_iter_func(void *, struct ieee80211com *);
771 void    ieee80211_iterate_coms(ieee80211_com_iter_func *, void *);
772 int     ieee80211_media_change(struct ifnet *);
773 void    ieee80211_media_status(struct ifnet *, struct ifmediareq *);
774 int     ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
775 int     ieee80211_rate2media(struct ieee80211com *, int,
776                 enum ieee80211_phymode);
777 int     ieee80211_media2rate(int);
778 int     ieee80211_mhz2ieee(u_int, u_int);
779 int     ieee80211_chan2ieee(struct ieee80211com *,
780                 const struct ieee80211_channel *);
781 u_int   ieee80211_ieee2mhz(u_int, u_int);
782 int     ieee80211_add_channel_cbw(struct ieee80211_channel[], int, int *,
783             uint8_t, uint16_t, int8_t, uint32_t, const uint8_t[], int);
784 int     ieee80211_add_channel(struct ieee80211_channel[], int, int *,
785             uint8_t, uint16_t, int8_t, uint32_t, const uint8_t[]);
786 int     ieee80211_add_channel_ht40(struct ieee80211_channel[], int, int *,
787             uint8_t, int8_t, uint32_t);
788 uint32_t ieee80211_get_channel_center_freq(const struct ieee80211_channel *);
789 uint32_t ieee80211_get_channel_center_freq1(const struct ieee80211_channel *);
790 uint32_t ieee80211_get_channel_center_freq2(const struct ieee80211_channel *);
791 #define NET80211_CBW_FLAG_HT40          0x01
792 #define NET80211_CBW_FLAG_VHT80         0x02
793 #define NET80211_CBW_FLAG_VHT160        0x04
794 #define NET80211_CBW_FLAG_VHT80P80      0x08
795 int     ieee80211_add_channel_list_2ghz(struct ieee80211_channel[], int, int *,
796             const uint8_t[], int, const uint8_t[], int);
797 int     ieee80211_add_channels_default_2ghz(struct ieee80211_channel[], int,
798             int *, const uint8_t[], int);
799 int     ieee80211_add_channel_list_5ghz(struct ieee80211_channel[], int, int *,
800             const uint8_t[], int, const uint8_t[], int);
801 struct ieee80211_channel *ieee80211_find_channel(struct ieee80211com *,
802                 int freq, int flags);
803 struct ieee80211_channel *ieee80211_find_channel_byieee(struct ieee80211com *,
804                 int ieee, int flags);
805 struct ieee80211_channel *ieee80211_lookup_channel_rxstatus(struct ieee80211vap *,
806                 const struct ieee80211_rx_stats *);
807 int     ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
808 enum ieee80211_phymode ieee80211_chan2mode(const struct ieee80211_channel *);
809 uint32_t ieee80211_mac_hash(const struct ieee80211com *,
810                 const uint8_t addr[IEEE80211_ADDR_LEN]);
811 char    ieee80211_channel_type_char(const struct ieee80211_channel *c);
812
813 #define ieee80211_get_current_channel(_ic)      ((_ic)->ic_curchan)
814 #define ieee80211_get_home_channel(_ic)         ((_ic)->ic_bsschan)
815 #define ieee80211_get_vap_desired_channel(_iv)  ((_iv)->iv_des_chan)
816
817 void    ieee80211_radiotap_attach(struct ieee80211com *,
818             struct ieee80211_radiotap_header *th, int tlen,
819                 uint32_t tx_radiotap,
820             struct ieee80211_radiotap_header *rh, int rlen,
821                 uint32_t rx_radiotap);
822 void    ieee80211_radiotap_attachv(struct ieee80211com *,
823             struct ieee80211_radiotap_header *th,
824             int tlen, int n_tx_v, uint32_t tx_radiotap,
825             struct ieee80211_radiotap_header *rh,
826             int rlen, int n_rx_v, uint32_t rx_radiotap);
827 void    ieee80211_radiotap_detach(struct ieee80211com *);
828 void    ieee80211_radiotap_vattach(struct ieee80211vap *);
829 void    ieee80211_radiotap_vdetach(struct ieee80211vap *);
830 void    ieee80211_radiotap_chan_change(struct ieee80211com *);
831 void    ieee80211_radiotap_tx(struct ieee80211vap *, struct mbuf *);
832 void    ieee80211_radiotap_rx(struct ieee80211vap *, struct mbuf *);
833 void    ieee80211_radiotap_rx_all(struct ieee80211com *, struct mbuf *);
834
835 static __inline int
836 ieee80211_radiotap_active(const struct ieee80211com *ic)
837 {
838         return (ic->ic_flags_ext & IEEE80211_FEXT_BPF) != 0;
839 }
840
841 static __inline int
842 ieee80211_radiotap_active_vap(const struct ieee80211vap *vap)
843 {
844         return (vap->iv_flags_ext & IEEE80211_FEXT_BPF) ||
845             vap->iv_ic->ic_montaps != 0;
846 }
847
848 /*
849  * Enqueue a task on the state thread.
850  */
851 static __inline void
852 ieee80211_runtask(struct ieee80211com *ic, struct task *task)
853 {
854         taskqueue_enqueue(ic->ic_tq, task);
855 }
856
857 /*
858  * Wait for a queued task to complete.
859  */
860 static __inline void
861 ieee80211_draintask(struct ieee80211com *ic, struct task *task)
862 {
863         taskqueue_drain(ic->ic_tq, task);
864 }
865
866 /* 
867  * Key update synchronization methods.  XXX should not be visible.
868  */
869 static __inline void
870 ieee80211_key_update_begin(struct ieee80211vap *vap)
871 {
872         vap->iv_key_update_begin(vap);
873 }
874 static __inline void
875 ieee80211_key_update_end(struct ieee80211vap *vap)
876 {
877         vap->iv_key_update_end(vap);
878 }
879
880 /*
881  * XXX these need to be here for IEEE80211_F_DATAPAD
882  */
883
884 /*
885  * Return the space occupied by the 802.11 header and any
886  * padding required by the driver.  This works for a
887  * management or data frame.
888  */
889 static __inline int
890 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
891 {
892         int size = ieee80211_hdrsize(data);
893         if (ic->ic_flags & IEEE80211_F_DATAPAD)
894                 size = roundup(size, sizeof(uint32_t));
895         return size;
896 }
897
898 /*
899  * Like ieee80211_hdrspace, but handles any type of frame.
900  */
901 static __inline int
902 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
903 {
904         int size = ieee80211_anyhdrsize(data);
905         if (ic->ic_flags & IEEE80211_F_DATAPAD)
906                 size = roundup(size, sizeof(uint32_t));
907         return size;
908 }
909
910 /*
911  * Notify a vap that beacon state has been updated.
912  */
913 static __inline void
914 ieee80211_beacon_notify(struct ieee80211vap *vap, int what)
915 {
916         if (vap->iv_state == IEEE80211_S_RUN)
917                 vap->iv_update_beacon(vap, what);
918 }
919
920 /*
921  * Calculate HT channel promotion flags for a channel.
922  * XXX belongs in ieee80211_ht.h but needs IEEE80211_FHT_*
923  */
924 static __inline int
925 ieee80211_htchanflags(const struct ieee80211_channel *c)
926 {
927         return IEEE80211_IS_CHAN_HT40(c) ?
928             IEEE80211_FHT_HT | IEEE80211_FHT_USEHT40 :
929             IEEE80211_IS_CHAN_HT(c) ?  IEEE80211_FHT_HT : 0;
930 }
931
932 /*
933  * Calculate VHT channel promotion flags for a channel.
934  * XXX belongs in ieee80211_vht.h but needs IEEE80211_FVHT_*
935  */
936 static __inline int
937 ieee80211_vhtchanflags(const struct ieee80211_channel *c)
938 {
939
940         if (IEEE80211_IS_CHAN_VHT160(c))
941                 return IEEE80211_FVHT_USEVHT160;
942         if (IEEE80211_IS_CHAN_VHT80P80(c))
943                 return IEEE80211_FVHT_USEVHT80P80;
944         if (IEEE80211_IS_CHAN_VHT80(c))
945                 return IEEE80211_FVHT_USEVHT80;
946         if (IEEE80211_IS_CHAN_VHT40(c))
947                 return IEEE80211_FVHT_USEVHT40;
948         if (IEEE80211_IS_CHAN_VHT(c))
949                 return IEEE80211_FVHT_VHT;
950         return (0);
951 }
952
953 /*
954  * Fetch the current TX power (cap) for the given node.
955  *
956  * This includes the node and ic/vap TX power limit as needed,
957  * but it doesn't take into account any per-rate limit.
958  */
959 static __inline uint16_t
960 ieee80211_get_node_txpower(struct ieee80211_node *ni)
961 {
962         struct ieee80211com *ic = ni->ni_ic;
963         uint16_t txpower;
964
965         txpower = ni->ni_txpower;
966         txpower = MIN(txpower, ic->ic_txpowlimit);
967         if (ic->ic_curchan != NULL) {
968                 txpower = MIN(txpower, 2 * ic->ic_curchan->ic_maxregpower);
969                 txpower = MIN(txpower, ic->ic_curchan->ic_maxpower);
970         }
971
972         return (txpower);
973 }
974
975 /*
976  * Debugging facilities compiled in when IEEE80211_DEBUG is defined.
977  *
978  * The intent is that any problem in the net80211 layer can be
979  * diagnosed by inspecting the statistics (dumped by the wlanstats
980  * program) and/or the msgs generated by net80211.  Messages are
981  * broken into functional classes and can be controlled with the
982  * wlandebug program.  Certain of these msg groups are for facilities
983  * that are no longer part of net80211 (e.g. IEEE80211_MSG_DOT1XSM).
984  */
985 #define IEEE80211_MSG_11N       0x80000000      /* 11n mode debug */
986 #define IEEE80211_MSG_DEBUG     0x40000000      /* IFF_DEBUG equivalent */
987 #define IEEE80211_MSG_DUMPPKTS  0x20000000      /* IFF_LINK2 equivalant */
988 #define IEEE80211_MSG_CRYPTO    0x10000000      /* crypto work */
989 #define IEEE80211_MSG_INPUT     0x08000000      /* input handling */
990 #define IEEE80211_MSG_XRATE     0x04000000      /* rate set handling */
991 #define IEEE80211_MSG_ELEMID    0x02000000      /* element id parsing */
992 #define IEEE80211_MSG_NODE      0x01000000      /* node handling */
993 #define IEEE80211_MSG_ASSOC     0x00800000      /* association handling */
994 #define IEEE80211_MSG_AUTH      0x00400000      /* authentication handling */
995 #define IEEE80211_MSG_SCAN      0x00200000      /* scanning */
996 #define IEEE80211_MSG_OUTPUT    0x00100000      /* output handling */
997 #define IEEE80211_MSG_STATE     0x00080000      /* state machine */
998 #define IEEE80211_MSG_POWER     0x00040000      /* power save handling */
999 #define IEEE80211_MSG_HWMP      0x00020000      /* hybrid mesh protocol */
1000 #define IEEE80211_MSG_DOT1XSM   0x00010000      /* 802.1x state machine */
1001 #define IEEE80211_MSG_RADIUS    0x00008000      /* 802.1x radius client */
1002 #define IEEE80211_MSG_RADDUMP   0x00004000      /* dump 802.1x radius packets */
1003 #define IEEE80211_MSG_MESH      0x00002000      /* mesh networking */
1004 #define IEEE80211_MSG_WPA       0x00001000      /* WPA/RSN protocol */
1005 #define IEEE80211_MSG_ACL       0x00000800      /* ACL handling */
1006 #define IEEE80211_MSG_WME       0x00000400      /* WME protocol */
1007 #define IEEE80211_MSG_SUPERG    0x00000200      /* Atheros SuperG protocol */
1008 #define IEEE80211_MSG_DOTH      0x00000100      /* 802.11h support */
1009 #define IEEE80211_MSG_INACT     0x00000080      /* inactivity handling */
1010 #define IEEE80211_MSG_ROAM      0x00000040      /* sta-mode roaming */
1011 #define IEEE80211_MSG_RATECTL   0x00000020      /* tx rate control */
1012 #define IEEE80211_MSG_ACTION    0x00000010      /* action frame handling */
1013 #define IEEE80211_MSG_WDS       0x00000008      /* WDS handling */
1014 #define IEEE80211_MSG_IOCTL     0x00000004      /* ioctl handling */
1015 #define IEEE80211_MSG_TDMA      0x00000002      /* TDMA handling */
1016
1017 #define IEEE80211_MSG_ANY       0xffffffff      /* anything */
1018
1019 #define IEEE80211_MSG_BITS \
1020         "\20\2TDMA\3IOCTL\4WDS\5ACTION\6RATECTL\7ROAM\10INACT\11DOTH\12SUPERG" \
1021         "\13WME\14ACL\15WPA\16RADKEYS\17RADDUMP\20RADIUS\21DOT1XSM\22HWMP" \
1022         "\23POWER\24STATE\25OUTPUT\26SCAN\27AUTH\30ASSOC\31NODE\32ELEMID" \
1023         "\33XRATE\34INPUT\35CRYPTO\36DUPMPKTS\37DEBUG\04011N"
1024
1025 /* Helper macros unified. */
1026 #define _IEEE80211_MASKSHIFT(_v, _f)    (((_v) & _f) >> _f##_S)
1027 #define _IEEE80211_SHIFTMASK(_v, _f)    (((_v) << _f##_S) & _f)
1028
1029 #ifdef IEEE80211_DEBUG
1030 #define ieee80211_msg(_vap, _m) ((_vap)->iv_debug & (_m))
1031 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...) do {                     \
1032         if (ieee80211_msg(_vap, _m))                                    \
1033                 ieee80211_note(_vap, _fmt, __VA_ARGS__);                \
1034 } while (0)
1035 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...) do {                   \
1036         if (ieee80211_msg(_vap, _m))                                    \
1037                 ieee80211_note_mac(_vap, (_ni)->ni_macaddr, _fmt, __VA_ARGS__);\
1038 } while (0)
1039 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...) do {              \
1040         if (ieee80211_msg(_vap, _m))                                    \
1041                 ieee80211_note_mac(_vap, _mac, _fmt, __VA_ARGS__);      \
1042 } while (0)
1043 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...) do {             \
1044         if (ieee80211_msg(_vap, _m))                                    \
1045                 ieee80211_note_frame(_vap, _wh, _fmt, __VA_ARGS__);     \
1046 } while (0)
1047 void    ieee80211_note(const struct ieee80211vap *, const char *, ...);
1048 void    ieee80211_note_mac(const struct ieee80211vap *,
1049                 const uint8_t mac[IEEE80211_ADDR_LEN], const char *, ...);
1050 void    ieee80211_note_frame(const struct ieee80211vap *,
1051                 const struct ieee80211_frame *, const char *, ...);
1052 #define ieee80211_msg_debug(_vap) \
1053         ((_vap)->iv_debug & IEEE80211_MSG_DEBUG)
1054 #define ieee80211_msg_dumppkts(_vap) \
1055         ((_vap)->iv_debug & IEEE80211_MSG_DUMPPKTS)
1056 #define ieee80211_msg_input(_vap) \
1057         ((_vap)->iv_debug & IEEE80211_MSG_INPUT)
1058 #define ieee80211_msg_radius(_vap) \
1059         ((_vap)->iv_debug & IEEE80211_MSG_RADIUS)
1060 #define ieee80211_msg_dumpradius(_vap) \
1061         ((_vap)->iv_debug & IEEE80211_MSG_RADDUMP)
1062 #define ieee80211_msg_dumpradkeys(_vap) \
1063         ((_vap)->iv_debug & IEEE80211_MSG_RADKEYS)
1064 #define ieee80211_msg_scan(_vap) \
1065         ((_vap)->iv_debug & IEEE80211_MSG_SCAN)
1066 #define ieee80211_msg_assoc(_vap) \
1067         ((_vap)->iv_debug & IEEE80211_MSG_ASSOC)
1068
1069 /*
1070  * Emit a debug message about discarding a frame or information
1071  * element.  One format is for extracting the mac address from
1072  * the frame header; the other is for when a header is not
1073  * available or otherwise appropriate.
1074  */
1075 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...) do {         \
1076         if ((_vap)->iv_debug & (_m))                                    \
1077                 ieee80211_discard_frame(_vap, _wh, _type,               \
1078                    "%s:%d: " _fmt, __func__, __LINE__, __VA_ARGS__);    \
1079 } while (0)
1080 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...) do {      \
1081         if ((_vap)->iv_debug & (_m))                                    \
1082                 ieee80211_discard_ie(_vap, _wh, _type,                  \
1083                     "%s:%d: " _fmt, __func__, __LINE__, __VA_ARGS__);   \
1084 } while (0)
1085 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...) do {    \
1086         if ((_vap)->iv_debug & (_m))                                    \
1087                 ieee80211_discard_mac(_vap, _mac, _type,                \
1088                     "%s:%d: " _fmt, __func__, __LINE__, __VA_ARGS__);   \
1089 } while (0)
1090
1091 void ieee80211_discard_frame(const struct ieee80211vap *,
1092         const struct ieee80211_frame *, const char *type, const char *fmt, ...);
1093 void ieee80211_discard_ie(const struct ieee80211vap *,
1094         const struct ieee80211_frame *, const char *type, const char *fmt, ...);
1095 void ieee80211_discard_mac(const struct ieee80211vap *,
1096         const uint8_t mac[IEEE80211_ADDR_LEN], const char *type,
1097         const char *fmt, ...);
1098 #else
1099 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...)
1100 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...)
1101 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...)
1102 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...)
1103 #define ieee80211_msg_dumppkts(_vap)    0
1104 #define ieee80211_msg(_vap, _m)         0
1105
1106 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...)
1107 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...)
1108 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...)
1109 #endif
1110
1111 #endif /* _NET80211_IEEE80211_VAR_H_ */