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