]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/net80211/ieee80211_var.h
THIS BRANCH IS OBSOLETE, PLEASE READ:
[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         /* Protection mode for net80211 driven channel NICs */
237         enum ieee80211_protmode ic_protmode;    /* 802.11g protection mode */
238         enum ieee80211_protmode ic_htprotmode;  /* HT protection mode */
239         uint8_t                 ic_curhtprotmode;/* HTINFO bss state */
240
241         uint8_t                 ic_rxstream;    /* # RX streams */
242         uint8_t                 ic_txstream;    /* # TX streams */
243
244         /* VHT information */
245         uint32_t                ic_vhtcaps;     /* VHT capabilities */
246         uint32_t                ic_vhtextcaps;  /* VHT extended capabilities (TODO) */
247         struct ieee80211_vht_mcs_info   ic_vht_mcsinfo; /* Support TX/RX VHT MCS */
248         uint32_t                ic_flags_vht;   /* VHT state flags */
249         uint32_t                ic_vht_spare[3];
250
251         /* optional state for Atheros SuperG protocol extensions */
252         struct ieee80211_superg *ic_superg;
253
254         /* radiotap handling */
255         struct ieee80211_radiotap_header *ic_th;/* tx radiotap headers */
256         void                    *ic_txchan;     /* channel state in ic_th */
257         struct ieee80211_radiotap_header *ic_rh;/* rx radiotap headers */
258         void                    *ic_rxchan;     /* channel state in ic_rh */
259         int                     ic_montaps;     /* active monitor mode taps */
260
261         /* virtual ap create/delete */
262         struct ieee80211vap*    (*ic_vap_create)(struct ieee80211com *,
263                                     const char [IFNAMSIZ], int,
264                                     enum ieee80211_opmode, int,
265                                     const uint8_t [IEEE80211_ADDR_LEN],
266                                     const uint8_t [IEEE80211_ADDR_LEN]);
267         void                    (*ic_vap_delete)(struct ieee80211vap *);
268         /* device specific ioctls */
269         int                     (*ic_ioctl)(struct ieee80211com *,
270                                     u_long, void *);
271         /* start/stop device */
272         void                    (*ic_parent)(struct ieee80211com *);
273         /* operating mode attachment */
274         ieee80211vap_attach     ic_vattach[IEEE80211_OPMODE_MAX];
275         /* return hardware/radio capabilities */
276         void                    (*ic_getradiocaps)(struct ieee80211com *,
277                                     int, int *, struct ieee80211_channel []);
278         /* check and/or prepare regdomain state change */
279         int                     (*ic_setregdomain)(struct ieee80211com *,
280                                     struct ieee80211_regdomain *,
281                                     int, struct ieee80211_channel []);
282
283         int                     (*ic_set_quiet)(struct ieee80211_node *,
284                                     u_int8_t *quiet_elm);
285
286         /* regular transmit */
287         int                     (*ic_transmit)(struct ieee80211com *,
288                                     struct mbuf *);
289         /* send/recv 802.11 management frame */
290         int                     (*ic_send_mgmt)(struct ieee80211_node *,
291                                      int, int);
292         /* send raw 802.11 frame */
293         int                     (*ic_raw_xmit)(struct ieee80211_node *,
294                                     struct mbuf *,
295                                     const struct ieee80211_bpf_params *);
296         /* update device state for 802.11 slot time change */
297         void                    (*ic_updateslot)(struct ieee80211com *);
298         /* handle multicast state changes */
299         void                    (*ic_update_mcast)(struct ieee80211com *);
300         /* handle promiscuous mode changes */
301         void                    (*ic_update_promisc)(struct ieee80211com *);
302         /* new station association callback/notification */
303         void                    (*ic_newassoc)(struct ieee80211_node *, int);
304         /* TDMA update notification */
305         void                    (*ic_tdma_update)(struct ieee80211_node *,
306                                     const struct ieee80211_tdma_param *, int);
307
308         /* Node state management */
309
310         /* Allocate a new node */
311         struct ieee80211_node*  (*ic_node_alloc)(struct ieee80211vap *,
312                                     const uint8_t [IEEE80211_ADDR_LEN]);
313
314         /* Driver node initialisation after net80211 setup */
315         int                     (*ic_node_init)(struct ieee80211_node *);
316
317         /* Driver node deallocation */
318         void                    (*ic_node_free)(struct ieee80211_node *);
319
320         /* Driver node state cleanup before deallocation */
321         void                    (*ic_node_cleanup)(struct ieee80211_node *);
322
323         void                    (*ic_node_age)(struct ieee80211_node *);
324         void                    (*ic_node_drain)(struct ieee80211_node *);
325         int8_t                  (*ic_node_getrssi)(const struct ieee80211_node*);
326         void                    (*ic_node_getsignal)(const struct ieee80211_node*,
327                                     int8_t *, int8_t *);
328         void                    (*ic_node_getmimoinfo)(
329                                     const struct ieee80211_node*,
330                                     struct ieee80211_mimo_info *);
331         /* scanning support */
332         void                    (*ic_scan_start)(struct ieee80211com *);
333         void                    (*ic_scan_end)(struct ieee80211com *);
334         void                    (*ic_set_channel)(struct ieee80211com *);
335         void                    (*ic_scan_curchan)(struct ieee80211_scan_state *,
336                                     unsigned long);
337         void                    (*ic_scan_mindwell)(struct ieee80211_scan_state *);
338
339         /*
340          * 802.11n ADDBA support.  A simple/generic implementation
341          * of A-MPDU tx aggregation is provided; the driver may
342          * override these methods to provide their own support.
343          * A-MPDU rx re-ordering happens automatically if the
344          * driver passes out-of-order frames to ieee80211_input
345          * from an assocated HT station.
346          */
347         int                     (*ic_recv_action)(struct ieee80211_node *,
348                                     const struct ieee80211_frame *,
349                                     const uint8_t *frm, const uint8_t *efrm);
350         int                     (*ic_send_action)(struct ieee80211_node *,
351                                     int category, int action, void *);
352         /* check if A-MPDU should be enabled this station+ac */
353         int                     (*ic_ampdu_enable)(struct ieee80211_node *,
354                                     struct ieee80211_tx_ampdu *);
355         /* start/stop doing A-MPDU tx aggregation for a station */
356         int                     (*ic_addba_request)(struct ieee80211_node *,
357                                     struct ieee80211_tx_ampdu *,
358                                     int dialogtoken, int baparamset,
359                                     int batimeout);
360         int                     (*ic_addba_response)(struct ieee80211_node *,
361                                     struct ieee80211_tx_ampdu *,
362                                     int status, int baparamset, int batimeout);
363         void                    (*ic_addba_stop)(struct ieee80211_node *,
364                                     struct ieee80211_tx_ampdu *);
365         void                    (*ic_addba_response_timeout)(struct ieee80211_node *,
366                                     struct ieee80211_tx_ampdu *);
367         /* BAR response received */
368         void                    (*ic_bar_response)(struct ieee80211_node *,
369                                     struct ieee80211_tx_ampdu *, int status);
370         /* start/stop doing A-MPDU rx processing for a station */
371         int                     (*ic_ampdu_rx_start)(struct ieee80211_node *,
372                                     struct ieee80211_rx_ampdu *, int baparamset,
373                                     int batimeout, int baseqctl);
374         void                    (*ic_ampdu_rx_stop)(struct ieee80211_node *,
375                                     struct ieee80211_rx_ampdu *);
376
377         /* The channel width has changed (20<->2040) */
378         void                    (*ic_update_chw)(struct ieee80211com *);
379
380         const struct debugnet80211_methods      *ic_debugnet_meth;
381         uint64_t                ic_spare[7];
382 };
383
384 struct ieee80211_aclator;
385 struct ieee80211_tdma_state;
386 struct ieee80211_mesh_state;
387 struct ieee80211_hwmp_state;
388 struct ieee80211_rx_histogram;
389 struct ieee80211_tx_histogram;
390
391 struct ieee80211vap {
392         struct ifmedia          iv_media;       /* interface media config */
393         struct ifnet            *iv_ifp;        /* associated device */
394         struct bpf_if           *iv_rawbpf;     /* packet filter structure */
395         struct sysctl_ctx_list  *iv_sysctl;     /* dynamic sysctl context */
396         struct sysctl_oid       *iv_oid;        /* net.wlan.X sysctl oid */
397
398         TAILQ_ENTRY(ieee80211vap) iv_next;      /* list of vap instances */
399         struct ieee80211com     *iv_ic;         /* back ptr to common state */
400         /* MAC address: ifp or ic */
401         uint8_t                 iv_myaddr[IEEE80211_ADDR_LEN];
402         uint32_t                iv_debug;       /* debug msg flags */
403         struct ieee80211_stats  iv_stats;       /* statistics */
404
405         uint32_t                iv_flags;       /* state flags */
406         uint32_t                iv_flags_ext;   /* extended state flags */
407         uint32_t                iv_flags_ht;    /* HT state flags */
408         uint32_t                iv_flags_ven;   /* vendor state flags */
409         uint32_t                iv_ifflags;     /* ifnet flags */
410         uint32_t                iv_caps;        /* capabilities */
411         uint32_t                iv_htcaps;      /* HT capabilities */
412         uint32_t                iv_htextcaps;   /* HT extended capabilities */
413         uint32_t                iv_com_state;   /* com usage / detached flag */
414         enum ieee80211_opmode   iv_opmode;      /* operation mode */
415         enum ieee80211_state    iv_state;       /* state machine state */
416         enum ieee80211_state    iv_nstate;      /* pending state */
417         int                     iv_nstate_arg;  /* pending state arg */
418         struct task             iv_nstate_task; /* deferred state processing */
419         struct task             iv_swbmiss_task;/* deferred iv_bmiss call */
420         struct callout          iv_mgtsend;     /* mgmt frame response timer */
421                                                 /* inactivity timer settings */
422         int                     iv_inact_init;  /* setting for new station */
423         int                     iv_inact_auth;  /* auth but not assoc setting */
424         int                     iv_inact_run;   /* authorized setting */
425         int                     iv_inact_probe; /* inactive probe time */
426
427         /* VHT flags */
428         uint32_t                iv_flags_vht;   /* VHT state flags */
429         uint32_t                iv_vhtcaps;     /* VHT capabilities */
430         uint32_t                iv_vhtextcaps;  /* VHT extended capabilities (TODO) */
431         struct ieee80211_vht_mcs_info   iv_vht_mcsinfo;
432         uint32_t                iv_vht_spare[4];
433
434         int                     iv_des_nssid;   /* # desired ssids */
435         struct ieee80211_scan_ssid iv_des_ssid[1];/* desired ssid table */
436         uint8_t                 iv_des_bssid[IEEE80211_ADDR_LEN];
437         struct ieee80211_channel *iv_des_chan;  /* desired channel */
438         uint16_t                iv_des_mode;    /* desired mode */
439         int                     iv_nicknamelen; /* XXX junk */
440         uint8_t                 iv_nickname[IEEE80211_NWID_LEN];
441         u_int                   iv_bgscanidle;  /* bg scan idle threshold */
442         u_int                   iv_bgscanintvl; /* bg scan min interval */
443         u_int                   iv_scanvalid;   /* scan cache valid threshold */
444         u_int                   iv_scanreq_duration;
445         u_int                   iv_scanreq_mindwell;
446         u_int                   iv_scanreq_maxdwell;
447         uint16_t                iv_scanreq_flags;/* held scan request params */
448         uint8_t                 iv_scanreq_nssid;
449         struct ieee80211_scan_ssid iv_scanreq_ssid[IEEE80211_SCAN_MAX_SSID];
450         /* sta-mode roaming state */
451         enum ieee80211_roamingmode iv_roaming;  /* roaming mode */
452         struct ieee80211_roamparam iv_roamparms[IEEE80211_MODE_MAX];
453
454         uint8_t                 iv_bmissthreshold;
455         uint8_t                 iv_bmiss_count; /* current beacon miss count */
456         int                     iv_bmiss_max;   /* max bmiss before scan */
457         uint16_t                iv_swbmiss_count;/* beacons in last period */
458         uint16_t                iv_swbmiss_period;/* s/w bmiss period */
459         struct callout          iv_swbmiss;     /* s/w beacon miss timer */
460
461         int                     iv_ampdu_rxmax; /* A-MPDU rx limit (bytes) */
462         int                     iv_ampdu_density;/* A-MPDU density */
463         int                     iv_ampdu_limit; /* A-MPDU tx limit (bytes) */
464         int                     iv_amsdu_limit; /* A-MSDU tx limit (bytes) */
465         u_int                   iv_ampdu_mintraffic[WME_NUM_AC];
466
467         struct ieee80211_beacon_offsets iv_bcn_off;
468         uint32_t                *iv_aid_bitmap; /* association id map */
469         uint16_t                iv_max_aid;
470         uint16_t                iv_sta_assoc;   /* stations associated */
471         uint16_t                iv_ps_sta;      /* stations in power save */
472         uint16_t                iv_ps_pending;  /* ps sta's w/ pending frames */
473         uint16_t                iv_txseq;       /* mcast xmit seq# space */
474         uint16_t                iv_tim_len;     /* ic_tim_bitmap size (bytes) */
475         uint8_t                 *iv_tim_bitmap; /* power-save stations w/ data*/
476         uint8_t                 iv_dtim_period; /* DTIM period */
477         uint8_t                 iv_dtim_count;  /* DTIM count from last bcn */
478                                                 /* set/unset aid pwrsav state */
479         uint8_t                 iv_quiet;       /* Quiet Element */
480         uint8_t                 iv_quiet_count; /* constant count for Quiet Element */
481         uint8_t                 iv_quiet_count_value;   /* variable count for Quiet Element */
482         uint8_t                 iv_quiet_period;        /* period for Quiet Element */
483         uint16_t                iv_quiet_duration;      /* duration for Quiet Element */
484         uint16_t                iv_quiet_offset;        /* offset for Quiet Element */
485         int                     iv_csa_count;   /* count for doing CSA */
486
487         struct ieee80211_node   *iv_bss;        /* information for this node */
488         struct ieee80211_txparam iv_txparms[IEEE80211_MODE_MAX];
489         uint16_t                iv_rtsthreshold;
490         uint16_t                iv_fragthreshold;
491         int                     iv_inact_timer; /* inactivity timer wait */
492         /* application-specified IE's to attach to mgt frames */
493         struct ieee80211_appie  *iv_appie_beacon;
494         struct ieee80211_appie  *iv_appie_probereq;
495         struct ieee80211_appie  *iv_appie_proberesp;
496         struct ieee80211_appie  *iv_appie_assocreq;
497         struct ieee80211_appie  *iv_appie_assocresp;
498         struct ieee80211_appie  *iv_appie_wpa;
499         uint8_t                 *iv_wpa_ie;
500         uint8_t                 *iv_rsn_ie;
501
502         /* Key management */
503         uint16_t                iv_max_keyix;   /* max h/w key index */
504         ieee80211_keyix         iv_def_txkey;   /* default/group tx key index */
505         struct ieee80211_key    iv_nw_keys[IEEE80211_WEP_NKID];
506         int                     (*iv_key_alloc)(struct ieee80211vap *,
507                                     struct ieee80211_key *,
508                                     ieee80211_keyix *, ieee80211_keyix *);
509         int                     (*iv_key_delete)(struct ieee80211vap *, 
510                                     const struct ieee80211_key *);
511         int                     (*iv_key_set)(struct ieee80211vap *,
512                                     const struct ieee80211_key *);
513         void                    (*iv_key_update_begin)(struct ieee80211vap *);
514         void                    (*iv_key_update_end)(struct ieee80211vap *);
515         void                    (*iv_update_deftxkey)(struct ieee80211vap *,
516                                     ieee80211_keyix deftxkey);
517
518         const struct ieee80211_authenticator *iv_auth; /* authenticator glue */
519         void                    *iv_ec;         /* private auth state */
520
521         const struct ieee80211_aclator *iv_acl; /* acl glue */
522         void                    *iv_as;         /* private aclator state */
523
524         const struct ieee80211_ratectl *iv_rate;
525         void                    *iv_rs;         /* private ratectl state */
526
527         struct ieee80211_tdma_state *iv_tdma;   /* tdma state */
528         struct ieee80211_mesh_state *iv_mesh;   /* MBSS state */
529         struct ieee80211_hwmp_state *iv_hwmp;   /* HWMP state */
530
531         /* operate-mode detach hook */
532         void                    (*iv_opdetach)(struct ieee80211vap *);
533         /* receive processing */
534         int                     (*iv_input)(struct ieee80211_node *,
535                                     struct mbuf *,
536                                     const struct ieee80211_rx_stats *,
537                                     int, int);
538         void                    (*iv_recv_mgmt)(struct ieee80211_node *,
539                                     struct mbuf *, int,
540                                     const struct ieee80211_rx_stats *,
541                                     int, int);
542         void                    (*iv_recv_ctl)(struct ieee80211_node *,
543                                     struct mbuf *, int);
544         void                    (*iv_deliver_data)(struct ieee80211vap *,
545                                     struct ieee80211_node *, struct mbuf *);
546 #if 0
547         /* send processing */
548         int                     (*iv_send_mgmt)(struct ieee80211_node *,
549                                      int, int);
550 #endif
551         /* beacon miss processing */
552         void                    (*iv_bmiss)(struct ieee80211vap *);
553         /* reset device state after 802.11 parameter/state change */
554         int                     (*iv_reset)(struct ieee80211vap *, u_long);
555         /* [schedule] beacon frame update */
556         void                    (*iv_update_beacon)(struct ieee80211vap *, int);
557         /* power save handling */
558         void                    (*iv_update_ps)(struct ieee80211vap *, int);
559         int                     (*iv_set_tim)(struct ieee80211_node *, int);
560         void                    (*iv_node_ps)(struct ieee80211_node *, int);
561         void                    (*iv_sta_ps)(struct ieee80211vap *, int);
562         void                    (*iv_recv_pspoll)(struct ieee80211_node *,
563                                     struct mbuf *);
564
565         /* state machine processing */
566         int                     (*iv_newstate)(struct ieee80211vap *,
567                                     enum ieee80211_state, int);
568         /* 802.3 output method for raw frame xmit */
569         int                     (*iv_output)(struct ifnet *, struct mbuf *,
570                                     const struct sockaddr *, struct route *);
571
572         int                     (*iv_wme_update)(struct ieee80211vap *,
573                                     const struct wmeParams *wme_params);
574         struct task             iv_wme_task;    /* deferred VAP WME update */
575
576         /* associated state; protection mode */
577         enum ieee80211_protmode iv_protmode;    /* 802.11g protection mode */
578         enum ieee80211_protmode iv_htprotmode;  /* HT protection mode */
579         uint8_t                 iv_curhtprotmode;/* HTINFO bss state */
580
581         uint16_t                iv_nonerpsta;   /* # non-ERP stations */
582         uint16_t                iv_longslotsta; /* # long slot time stations */
583         uint16_t                iv_ht_sta_assoc;/* HT stations associated */
584         uint16_t                iv_ht40_sta_assoc;/* HT40 stations associated */
585         int                     iv_lastnonerp;  /* last time non-ERP sta noted*/
586         int                     iv_lastnonht;   /* last time non-HT sta noted */
587
588         /* update device state for 802.11 slot time change */
589         void                    (*iv_updateslot)(struct ieee80211vap *);
590         struct task             iv_slot_task;   /* deferred slot time update */
591
592         struct task             iv_erp_protmode_task;   /* deferred ERP protmode update */
593         void                    (*iv_erp_protmode_update)(struct ieee80211vap *);
594
595         struct task             iv_preamble_task;       /* deferred short/barker preamble update */
596         void                    (*iv_preamble_update)(struct ieee80211vap *);
597
598         struct task             iv_ht_protmode_task;    /* deferred HT protmode update */
599         void                    (*iv_ht_protmode_update)(struct ieee80211vap *);
600
601         /* per-vap U-APSD state */
602         uint8_t                 iv_uapsdinfo;   /* sta mode QoS Info flags */
603
604         /* Optional transmit/receive histogram statistics */
605         struct ieee80211_rx_histogram   *rx_histogram;
606         struct ieee80211_tx_histogram   *tx_histogram;
607
608         uint64_t                iv_spare[6];
609 };
610 MALLOC_DECLARE(M_80211_VAP);
611
612 #define IEEE80211_ADDR_EQ(a1,a2)        (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
613 #define IEEE80211_ADDR_COPY(dst,src)    memcpy(dst,src,IEEE80211_ADDR_LEN)
614
615 /* ic_flags/iv_flags */
616 #define IEEE80211_F_TURBOP      0x00000001      /* CONF: ATH Turbo enabled*/
617 #define IEEE80211_F_COMP        0x00000002      /* CONF: ATH comp enabled */
618 #define IEEE80211_F_FF          0x00000004      /* CONF: ATH FF enabled */
619 #define IEEE80211_F_BURST       0x00000008      /* CONF: bursting enabled */
620 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
621 #define IEEE80211_F_PRIVACY     0x00000010      /* CONF: privacy enabled */
622 #define IEEE80211_F_PUREG       0x00000020      /* CONF: 11g w/o 11b sta's */
623 #define IEEE80211_F_SCAN        0x00000080      /* STATUS: scanning */
624 /* 0x00000300 reserved */
625 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
626 #define IEEE80211_F_SHSLOT      0x00000400      /* STATUS: use short slot time*/
627 #define IEEE80211_F_PMGTON      0x00000800      /* CONF: Power mgmt enable */
628 #define IEEE80211_F_DESBSSID    0x00001000      /* CONF: des_bssid is set */
629 #define IEEE80211_F_WME         0x00002000      /* CONF: enable WME use */
630 #define IEEE80211_F_BGSCAN      0x00004000      /* CONF: bg scan enabled (???)*/
631 #define IEEE80211_F_SWRETRY     0x00008000      /* CONF: sw tx retry enabled */
632 /* 0x00030000 reserved */
633 #define IEEE80211_F_SHPREAMBLE  0x00040000      /* STATUS: use short preamble */
634 #define IEEE80211_F_DATAPAD     0x00080000      /* CONF: do alignment pad */
635 #define IEEE80211_F_USEPROT     0x00100000      /* STATUS: protection enabled */
636 #define IEEE80211_F_USEBARKER   0x00200000      /* STATUS: use barker preamble*/
637 #define IEEE80211_F_CSAPENDING  0x00400000      /* STATUS: chan switch pending*/
638 #define IEEE80211_F_WPA1        0x00800000      /* CONF: WPA enabled */
639 #define IEEE80211_F_WPA2        0x01000000      /* CONF: WPA2 enabled */
640 #define IEEE80211_F_WPA         0x01800000      /* CONF: WPA/WPA2 enabled */
641 #define IEEE80211_F_DROPUNENC   0x02000000      /* CONF: drop unencrypted */
642 #define IEEE80211_F_COUNTERM    0x04000000      /* CONF: TKIP countermeasures */
643 #define IEEE80211_F_HIDESSID    0x08000000      /* CONF: hide SSID in beacon */
644 #define IEEE80211_F_NOBRIDGE    0x10000000      /* CONF: dis. internal bridge */
645 #define IEEE80211_F_PCF         0x20000000      /* CONF: PCF enabled */
646 #define IEEE80211_F_DOTH        0x40000000      /* CONF: 11h enabled */
647 #define IEEE80211_F_DWDS        0x80000000      /* CONF: Dynamic WDS enabled */
648
649 #define IEEE80211_F_BITS \
650         "\20\1TURBOP\2COMP\3FF\4BURST\5PRIVACY\6PUREG\10SCAN" \
651         "\13SHSLOT\14PMGTON\15DESBSSID\16WME\17BGSCAN\20SWRETRY" \
652         "\23SHPREAMBLE\24DATAPAD\25USEPROT\26USERBARKER\27CSAPENDING" \
653         "\30WPA1\31WPA2\32DROPUNENC\33COUNTERM\34HIDESSID\35NOBRIDG\36PCF" \
654         "\37DOTH\40DWDS"
655
656 /* Atheros protocol-specific flags */
657 #define IEEE80211_F_ATHEROS \
658         (IEEE80211_F_FF | IEEE80211_F_COMP | IEEE80211_F_TURBOP)
659 /* Check if an Atheros capability was negotiated for use */
660 #define IEEE80211_ATH_CAP(vap, ni, bit) \
661         ((vap)->iv_flags & (ni)->ni_ath_flags & (bit))
662
663 /* ic_flags_ext/iv_flags_ext */
664 #define IEEE80211_FEXT_INACT     0x00000002     /* CONF: sta inact handling */
665 #define IEEE80211_FEXT_SCANWAIT  0x00000004     /* STATUS: awaiting scan */
666 /* 0x00000006 reserved */
667 #define IEEE80211_FEXT_BGSCAN    0x00000008     /* STATUS: complete bgscan */
668 #define IEEE80211_FEXT_WPS       0x00000010     /* CONF: WPS enabled */
669 #define IEEE80211_FEXT_TSN       0x00000020     /* CONF: TSN enabled */
670 #define IEEE80211_FEXT_SCANREQ   0x00000040     /* STATUS: scan req params */
671 #define IEEE80211_FEXT_RESUME    0x00000080     /* STATUS: start on resume */
672 #define IEEE80211_FEXT_4ADDR     0x00000100     /* CONF: apply 4-addr encap */
673 #define IEEE80211_FEXT_NONERP_PR 0x00000200     /* STATUS: non-ERP sta present*/
674 #define IEEE80211_FEXT_SWBMISS   0x00000400     /* CONF: do bmiss in s/w */
675 #define IEEE80211_FEXT_DFS       0x00000800     /* CONF: DFS enabled */
676 #define IEEE80211_FEXT_DOTD      0x00001000     /* CONF: 11d enabled */
677 #define IEEE80211_FEXT_STATEWAIT 0x00002000     /* STATUS: awaiting state chg */
678 #define IEEE80211_FEXT_REINIT    0x00004000     /* STATUS: INIT state first */
679 #define IEEE80211_FEXT_BPF       0x00008000     /* STATUS: BPF tap present */
680 /* NB: immutable: should be set only when creating a vap */
681 #define IEEE80211_FEXT_WDSLEGACY 0x00010000     /* CONF: legacy WDS operation */
682 #define IEEE80211_FEXT_PROBECHAN 0x00020000     /* CONF: probe passive channel*/
683 #define IEEE80211_FEXT_UNIQMAC   0x00040000     /* CONF: user or computed mac */
684 #define IEEE80211_FEXT_SCAN_OFFLOAD     0x00080000      /* CONF: scan is fully offloaded */
685 #define IEEE80211_FEXT_SEQNO_OFFLOAD    0x00100000      /* CONF: driver does seqno insertion/allocation */
686 #define IEEE80211_FEXT_FRAG_OFFLOAD     0x00200000      /* CONF: hardware does 802.11 fragmentation + assignment */
687 #define IEEE80211_FEXT_VHT      0x00400000      /* CONF: VHT support */
688 #define IEEE80211_FEXT_QUIET_IE 0x00800000      /* STATUS: quiet IE in a beacon has been added */
689 #define IEEE80211_FEXT_UAPSD    0x01000000      /* CONF: enable U-APSD */
690
691 #define IEEE80211_FEXT_BITS \
692         "\20\2INACT\3SCANWAIT\4BGSCAN\5WPS\6TSN\7SCANREQ\10RESUME" \
693         "\0114ADDR\12NONEPR_PR\13SWBMISS\14DFS\15DOTD\16STATEWAIT\17REINIT" \
694         "\20BPF\21WDSLEGACY\22PROBECHAN\23UNIQMAC\24SCAN_OFFLOAD\25SEQNO_OFFLOAD" \
695         "\26VHT\27QUIET_IE"
696
697 /* ic_flags_ht/iv_flags_ht */
698 #define IEEE80211_FHT_NONHT_PR   0x00000001     /* STATUS: non-HT sta present */
699 #define IEEE80211_FHT_LDPC_TX    0x00010000     /* CONF: LDPC tx enabled */
700 #define IEEE80211_FHT_LDPC_RX    0x00020000     /* CONF: LDPC rx enabled */
701 #define IEEE80211_FHT_GF         0x00040000     /* CONF: Greenfield enabled */
702 #define IEEE80211_FHT_HT         0x00080000     /* CONF: HT supported */
703 #define IEEE80211_FHT_AMPDU_TX   0x00100000     /* CONF: A-MPDU tx supported */
704 #define IEEE80211_FHT_AMPDU_RX   0x00200000     /* CONF: A-MPDU rx supported */
705 #define IEEE80211_FHT_AMSDU_TX   0x00400000     /* CONF: A-MSDU tx supported */
706 #define IEEE80211_FHT_AMSDU_RX   0x00800000     /* CONF: A-MSDU rx supported */
707 #define IEEE80211_FHT_USEHT40    0x01000000     /* CONF: 20/40 use enabled */
708 #define IEEE80211_FHT_PUREN      0x02000000     /* CONF: 11n w/o legacy sta's */
709 #define IEEE80211_FHT_SHORTGI20  0x04000000     /* CONF: short GI in HT20 */
710 #define IEEE80211_FHT_SHORTGI40  0x08000000     /* CONF: short GI in HT40 */
711 #define IEEE80211_FHT_HTCOMPAT   0x10000000     /* CONF: HT vendor OUI's */
712 #define IEEE80211_FHT_RIFS       0x20000000     /* CONF: RIFS enabled */
713 #define IEEE80211_FHT_STBC_TX    0x40000000     /* CONF: STBC tx enabled */
714 #define IEEE80211_FHT_STBC_RX    0x80000000     /* CONF: STBC rx enabled */
715
716 #define IEEE80211_FHT_BITS \
717         "\20\1NONHT_PR" \
718         "\23GF\24HT\25AMPDU_TX\26AMPDU_TX" \
719         "\27AMSDU_TX\30AMSDU_RX\31USEHT40\32PUREN\33SHORTGI20\34SHORTGI40" \
720         "\35HTCOMPAT\36RIFS\37STBC_TX\40STBC_RX"
721
722 #define IEEE80211_FVEN_BITS     "\20"
723
724 #define IEEE80211_FVHT_VHT      0x000000001     /* CONF: VHT supported */
725 #define IEEE80211_FVHT_USEVHT40 0x000000002     /* CONF: Use VHT40 */
726 #define IEEE80211_FVHT_USEVHT80 0x000000004     /* CONF: Use VHT80 */
727 #define IEEE80211_FVHT_USEVHT160        0x000000008     /* CONF: Use VHT160 */
728 #define IEEE80211_FVHT_USEVHT80P80      0x000000010     /* CONF: Use VHT 80+80 */
729 #define IEEE80211_FVHT_MASK                                             \
730         (IEEE80211_FVHT_VHT | IEEE80211_FVHT_USEVHT40 |                 \
731         IEEE80211_FVHT_USEVHT80 | IEEE80211_FVHT_USEVHT160 |            \
732         IEEE80211_FVHT_USEVHT80P80)
733 #define IEEE80211_VFHT_BITS \
734         "\20\1VHT\2VHT40\3VHT80\4VHT160\5VHT80P80"
735
736 #define IEEE80211_COM_DETACHED  0x00000001      /* ieee80211_ifdetach called */
737 #define IEEE80211_COM_REF_ADD   0x00000002      /* add / remove reference */
738 #define IEEE80211_COM_REF       0xfffffffe      /* reference counter bits */
739 #define IEEE80211_COM_REF_S     1
740 #define IEEE80211_COM_REF_MAX   (IEEE80211_COM_REF >> IEEE80211_COM_REF_S)
741
742 int     ic_printf(struct ieee80211com *, const char *, ...) __printflike(2, 3);
743 void    ieee80211_ifattach(struct ieee80211com *);
744 void    ieee80211_ifdetach(struct ieee80211com *);
745 int     ieee80211_vap_setup(struct ieee80211com *, struct ieee80211vap *,
746                 const char name[IFNAMSIZ], int unit,
747                 enum ieee80211_opmode opmode, int flags,
748                 const uint8_t bssid[IEEE80211_ADDR_LEN]);
749 int     ieee80211_vap_attach(struct ieee80211vap *,
750                 ifm_change_cb_t, ifm_stat_cb_t,
751                 const uint8_t macaddr[IEEE80211_ADDR_LEN]);
752 void    ieee80211_vap_detach(struct ieee80211vap *);
753 const struct ieee80211_rateset *ieee80211_get_suprates(struct ieee80211com *ic,
754                 const struct ieee80211_channel *);
755 const struct ieee80211_htrateset *ieee80211_get_suphtrates(
756                 struct ieee80211com *, const struct ieee80211_channel *);
757 void    ieee80211_announce(struct ieee80211com *);
758 void    ieee80211_announce_channels(struct ieee80211com *);
759 void    ieee80211_drain(struct ieee80211com *);
760 void    ieee80211_chan_init(struct ieee80211com *);
761 struct ieee80211com *ieee80211_find_vap(const uint8_t mac[IEEE80211_ADDR_LEN]);
762 struct ieee80211com *ieee80211_find_com(const char *name);
763 typedef void ieee80211_com_iter_func(void *, struct ieee80211com *);
764 void    ieee80211_iterate_coms(ieee80211_com_iter_func *, void *);
765 int     ieee80211_media_change(struct ifnet *);
766 void    ieee80211_media_status(struct ifnet *, struct ifmediareq *);
767 int     ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
768 int     ieee80211_rate2media(struct ieee80211com *, int,
769                 enum ieee80211_phymode);
770 int     ieee80211_media2rate(int);
771 int     ieee80211_mhz2ieee(u_int, u_int);
772 int     ieee80211_chan2ieee(struct ieee80211com *,
773                 const struct ieee80211_channel *);
774 u_int   ieee80211_ieee2mhz(u_int, u_int);
775 int     ieee80211_add_channel_cbw(struct ieee80211_channel[], int, int *,
776             uint8_t, uint16_t, int8_t, uint32_t, const uint8_t[], int);
777 int     ieee80211_add_channel(struct ieee80211_channel[], int, int *,
778             uint8_t, uint16_t, int8_t, uint32_t, const uint8_t[]);
779 int     ieee80211_add_channel_ht40(struct ieee80211_channel[], int, int *,
780             uint8_t, int8_t, uint32_t);
781 uint32_t ieee80211_get_channel_center_freq(const struct ieee80211_channel *);
782 uint32_t ieee80211_get_channel_center_freq1(const struct ieee80211_channel *);
783 uint32_t ieee80211_get_channel_center_freq2(const struct ieee80211_channel *);
784 #define NET80211_CBW_FLAG_HT40          0x01
785 #define NET80211_CBW_FLAG_VHT80         0x02
786 #define NET80211_CBW_FLAG_VHT160        0x04
787 #define NET80211_CBW_FLAG_VHT80P80      0x08
788 int     ieee80211_add_channel_list_2ghz(struct ieee80211_channel[], int, int *,
789             const uint8_t[], int, const uint8_t[], int);
790 int     ieee80211_add_channels_default_2ghz(struct ieee80211_channel[], int,
791             int *, const uint8_t[], int);
792 int     ieee80211_add_channel_list_5ghz(struct ieee80211_channel[], int, int *,
793             const uint8_t[], int, const uint8_t[], int);
794 struct ieee80211_channel *ieee80211_find_channel(struct ieee80211com *,
795                 int freq, int flags);
796 struct ieee80211_channel *ieee80211_find_channel_byieee(struct ieee80211com *,
797                 int ieee, int flags);
798 struct ieee80211_channel *ieee80211_lookup_channel_rxstatus(struct ieee80211vap *,
799                 const struct ieee80211_rx_stats *);
800 int     ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
801 enum ieee80211_phymode ieee80211_chan2mode(const struct ieee80211_channel *);
802 uint32_t ieee80211_mac_hash(const struct ieee80211com *,
803                 const uint8_t addr[IEEE80211_ADDR_LEN]);
804 char    ieee80211_channel_type_char(const struct ieee80211_channel *c);
805
806 #define ieee80211_get_current_channel(_ic)      ((_ic)->ic_curchan)
807 #define ieee80211_get_home_channel(_ic)         ((_ic)->ic_bsschan)
808 #define ieee80211_get_vap_desired_channel(_iv)  ((_iv)->iv_des_chan)
809
810 void    ieee80211_radiotap_attach(struct ieee80211com *,
811             struct ieee80211_radiotap_header *th, int tlen,
812                 uint32_t tx_radiotap,
813             struct ieee80211_radiotap_header *rh, int rlen,
814                 uint32_t rx_radiotap);
815 void    ieee80211_radiotap_attachv(struct ieee80211com *,
816             struct ieee80211_radiotap_header *th,
817             int tlen, int n_tx_v, uint32_t tx_radiotap,
818             struct ieee80211_radiotap_header *rh,
819             int rlen, int n_rx_v, uint32_t rx_radiotap);
820 void    ieee80211_radiotap_detach(struct ieee80211com *);
821 void    ieee80211_radiotap_vattach(struct ieee80211vap *);
822 void    ieee80211_radiotap_vdetach(struct ieee80211vap *);
823 void    ieee80211_radiotap_chan_change(struct ieee80211com *);
824 void    ieee80211_radiotap_tx(struct ieee80211vap *, struct mbuf *);
825 void    ieee80211_radiotap_rx(struct ieee80211vap *, struct mbuf *);
826 void    ieee80211_radiotap_rx_all(struct ieee80211com *, struct mbuf *);
827
828 static __inline int
829 ieee80211_radiotap_active(const struct ieee80211com *ic)
830 {
831         return (ic->ic_flags_ext & IEEE80211_FEXT_BPF) != 0;
832 }
833
834 static __inline int
835 ieee80211_radiotap_active_vap(const struct ieee80211vap *vap)
836 {
837         return (vap->iv_flags_ext & IEEE80211_FEXT_BPF) ||
838             vap->iv_ic->ic_montaps != 0;
839 }
840
841 /*
842  * Enqueue a task on the state thread.
843  */
844 static __inline void
845 ieee80211_runtask(struct ieee80211com *ic, struct task *task)
846 {
847         taskqueue_enqueue(ic->ic_tq, task);
848 }
849
850 /*
851  * Wait for a queued task to complete.
852  */
853 static __inline void
854 ieee80211_draintask(struct ieee80211com *ic, struct task *task)
855 {
856         taskqueue_drain(ic->ic_tq, task);
857 }
858
859 /* 
860  * Key update synchronization methods.  XXX should not be visible.
861  */
862 static __inline void
863 ieee80211_key_update_begin(struct ieee80211vap *vap)
864 {
865         vap->iv_key_update_begin(vap);
866 }
867 static __inline void
868 ieee80211_key_update_end(struct ieee80211vap *vap)
869 {
870         vap->iv_key_update_end(vap);
871 }
872
873 /*
874  * XXX these need to be here for IEEE80211_F_DATAPAD
875  */
876
877 /*
878  * Return the space occupied by the 802.11 header and any
879  * padding required by the driver.  This works for a
880  * management or data frame.
881  */
882 static __inline int
883 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
884 {
885         int size = ieee80211_hdrsize(data);
886         if (ic->ic_flags & IEEE80211_F_DATAPAD)
887                 size = roundup(size, sizeof(uint32_t));
888         return size;
889 }
890
891 /*
892  * Like ieee80211_hdrspace, but handles any type of frame.
893  */
894 static __inline int
895 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
896 {
897         int size = ieee80211_anyhdrsize(data);
898         if (ic->ic_flags & IEEE80211_F_DATAPAD)
899                 size = roundup(size, sizeof(uint32_t));
900         return size;
901 }
902
903 /*
904  * Notify a vap that beacon state has been updated.
905  */
906 static __inline void
907 ieee80211_beacon_notify(struct ieee80211vap *vap, int what)
908 {
909         if (vap->iv_state == IEEE80211_S_RUN)
910                 vap->iv_update_beacon(vap, what);
911 }
912
913 /*
914  * Calculate HT channel promotion flags for a channel.
915  * XXX belongs in ieee80211_ht.h but needs IEEE80211_FHT_*
916  */
917 static __inline int
918 ieee80211_htchanflags(const struct ieee80211_channel *c)
919 {
920         return IEEE80211_IS_CHAN_HT40(c) ?
921             IEEE80211_FHT_HT | IEEE80211_FHT_USEHT40 :
922             IEEE80211_IS_CHAN_HT(c) ?  IEEE80211_FHT_HT : 0;
923 }
924
925 /*
926  * Calculate VHT channel promotion flags for a channel.
927  * XXX belongs in ieee80211_vht.h but needs IEEE80211_FVHT_*
928  */
929 static __inline int
930 ieee80211_vhtchanflags(const struct ieee80211_channel *c)
931 {
932
933         if (IEEE80211_IS_CHAN_VHT80P80(c))
934                 return IEEE80211_FVHT_USEVHT80P80;
935         if (IEEE80211_IS_CHAN_VHT160(c))
936                 return IEEE80211_FVHT_USEVHT160;
937         if (IEEE80211_IS_CHAN_VHT80(c))
938                 return IEEE80211_FVHT_USEVHT80;
939         if (IEEE80211_IS_CHAN_VHT40(c))
940                 return IEEE80211_FVHT_USEVHT40;
941         if (IEEE80211_IS_CHAN_VHT(c))
942                 return IEEE80211_FVHT_VHT;
943         return (0);
944 }
945
946 /*
947  * Fetch the current TX power (cap) for the given node.
948  *
949  * This includes the node and ic/vap TX power limit as needed,
950  * but it doesn't take into account any per-rate limit.
951  */
952 static __inline uint16_t
953 ieee80211_get_node_txpower(struct ieee80211_node *ni)
954 {
955         struct ieee80211com *ic = ni->ni_ic;
956         uint16_t txpower;
957
958         txpower = ni->ni_txpower;
959         txpower = MIN(txpower, ic->ic_txpowlimit);
960         if (ic->ic_curchan != NULL) {
961                 txpower = MIN(txpower, 2 * ic->ic_curchan->ic_maxregpower);
962                 txpower = MIN(txpower, ic->ic_curchan->ic_maxpower);
963         }
964
965         return (txpower);
966 }
967
968 /*
969  * Debugging facilities compiled in when IEEE80211_DEBUG is defined.
970  *
971  * The intent is that any problem in the net80211 layer can be
972  * diagnosed by inspecting the statistics (dumped by the wlanstats
973  * program) and/or the msgs generated by net80211.  Messages are
974  * broken into functional classes and can be controlled with the
975  * wlandebug program.  Certain of these msg groups are for facilities
976  * that are no longer part of net80211 (e.g. IEEE80211_MSG_DOT1XSM).
977  */
978 #define IEEE80211_MSG_11N       0x80000000      /* 11n mode debug */
979 #define IEEE80211_MSG_DEBUG     0x40000000      /* IFF_DEBUG equivalent */
980 #define IEEE80211_MSG_DUMPPKTS  0x20000000      /* IFF_LINK2 equivalant */
981 #define IEEE80211_MSG_CRYPTO    0x10000000      /* crypto work */
982 #define IEEE80211_MSG_INPUT     0x08000000      /* input handling */
983 #define IEEE80211_MSG_XRATE     0x04000000      /* rate set handling */
984 #define IEEE80211_MSG_ELEMID    0x02000000      /* element id parsing */
985 #define IEEE80211_MSG_NODE      0x01000000      /* node handling */
986 #define IEEE80211_MSG_ASSOC     0x00800000      /* association handling */
987 #define IEEE80211_MSG_AUTH      0x00400000      /* authentication handling */
988 #define IEEE80211_MSG_SCAN      0x00200000      /* scanning */
989 #define IEEE80211_MSG_OUTPUT    0x00100000      /* output handling */
990 #define IEEE80211_MSG_STATE     0x00080000      /* state machine */
991 #define IEEE80211_MSG_POWER     0x00040000      /* power save handling */
992 #define IEEE80211_MSG_HWMP      0x00020000      /* hybrid mesh protocol */
993 #define IEEE80211_MSG_DOT1XSM   0x00010000      /* 802.1x state machine */
994 #define IEEE80211_MSG_RADIUS    0x00008000      /* 802.1x radius client */
995 #define IEEE80211_MSG_RADDUMP   0x00004000      /* dump 802.1x radius packets */
996 #define IEEE80211_MSG_MESH      0x00002000      /* mesh networking */
997 #define IEEE80211_MSG_WPA       0x00001000      /* WPA/RSN protocol */
998 #define IEEE80211_MSG_ACL       0x00000800      /* ACL handling */
999 #define IEEE80211_MSG_WME       0x00000400      /* WME protocol */
1000 #define IEEE80211_MSG_SUPERG    0x00000200      /* Atheros SuperG protocol */
1001 #define IEEE80211_MSG_DOTH      0x00000100      /* 802.11h support */
1002 #define IEEE80211_MSG_INACT     0x00000080      /* inactivity handling */
1003 #define IEEE80211_MSG_ROAM      0x00000040      /* sta-mode roaming */
1004 #define IEEE80211_MSG_RATECTL   0x00000020      /* tx rate control */
1005 #define IEEE80211_MSG_ACTION    0x00000010      /* action frame handling */
1006 #define IEEE80211_MSG_WDS       0x00000008      /* WDS handling */
1007 #define IEEE80211_MSG_IOCTL     0x00000004      /* ioctl handling */
1008 #define IEEE80211_MSG_TDMA      0x00000002      /* TDMA handling */
1009
1010 #define IEEE80211_MSG_ANY       0xffffffff      /* anything */
1011
1012 #define IEEE80211_MSG_BITS \
1013         "\20\2TDMA\3IOCTL\4WDS\5ACTION\6RATECTL\7ROAM\10INACT\11DOTH\12SUPERG" \
1014         "\13WME\14ACL\15WPA\16RADKEYS\17RADDUMP\20RADIUS\21DOT1XSM\22HWMP" \
1015         "\23POWER\24STATE\25OUTPUT\26SCAN\27AUTH\30ASSOC\31NODE\32ELEMID" \
1016         "\33XRATE\34INPUT\35CRYPTO\36DUPMPKTS\37DEBUG\04011N"
1017
1018 /* Helper macros unified. */
1019 #define _IEEE80211_MASKSHIFT(_v, _f)    (((_v) & _f) >> _f##_S)
1020 #define _IEEE80211_SHIFTMASK(_v, _f)    (((_v) << _f##_S) & _f)
1021
1022 #ifdef IEEE80211_DEBUG
1023 #define ieee80211_msg(_vap, _m) ((_vap)->iv_debug & (_m))
1024 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...) do {                     \
1025         if (ieee80211_msg(_vap, _m))                                    \
1026                 ieee80211_note(_vap, _fmt, __VA_ARGS__);                \
1027 } while (0)
1028 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...) do {                   \
1029         if (ieee80211_msg(_vap, _m))                                    \
1030                 ieee80211_note_mac(_vap, (_ni)->ni_macaddr, _fmt, __VA_ARGS__);\
1031 } while (0)
1032 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...) do {              \
1033         if (ieee80211_msg(_vap, _m))                                    \
1034                 ieee80211_note_mac(_vap, _mac, _fmt, __VA_ARGS__);      \
1035 } while (0)
1036 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...) do {             \
1037         if (ieee80211_msg(_vap, _m))                                    \
1038                 ieee80211_note_frame(_vap, _wh, _fmt, __VA_ARGS__);     \
1039 } while (0)
1040 void    ieee80211_note(const struct ieee80211vap *, const char *, ...);
1041 void    ieee80211_note_mac(const struct ieee80211vap *,
1042                 const uint8_t mac[IEEE80211_ADDR_LEN], const char *, ...);
1043 void    ieee80211_note_frame(const struct ieee80211vap *,
1044                 const struct ieee80211_frame *, const char *, ...);
1045 #define ieee80211_msg_debug(_vap) \
1046         ((_vap)->iv_debug & IEEE80211_MSG_DEBUG)
1047 #define ieee80211_msg_dumppkts(_vap) \
1048         ((_vap)->iv_debug & IEEE80211_MSG_DUMPPKTS)
1049 #define ieee80211_msg_input(_vap) \
1050         ((_vap)->iv_debug & IEEE80211_MSG_INPUT)
1051 #define ieee80211_msg_radius(_vap) \
1052         ((_vap)->iv_debug & IEEE80211_MSG_RADIUS)
1053 #define ieee80211_msg_dumpradius(_vap) \
1054         ((_vap)->iv_debug & IEEE80211_MSG_RADDUMP)
1055 #define ieee80211_msg_dumpradkeys(_vap) \
1056         ((_vap)->iv_debug & IEEE80211_MSG_RADKEYS)
1057 #define ieee80211_msg_scan(_vap) \
1058         ((_vap)->iv_debug & IEEE80211_MSG_SCAN)
1059 #define ieee80211_msg_assoc(_vap) \
1060         ((_vap)->iv_debug & IEEE80211_MSG_ASSOC)
1061
1062 /*
1063  * Emit a debug message about discarding a frame or information
1064  * element.  One format is for extracting the mac address from
1065  * the frame header; the other is for when a header is not
1066  * available or otherwise appropriate.
1067  */
1068 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...) do {         \
1069         if ((_vap)->iv_debug & (_m))                                    \
1070                 ieee80211_discard_frame(_vap, _wh, _type, _fmt, __VA_ARGS__);\
1071 } while (0)
1072 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...) do {      \
1073         if ((_vap)->iv_debug & (_m))                                    \
1074                 ieee80211_discard_ie(_vap, _wh, _type, _fmt, __VA_ARGS__);\
1075 } while (0)
1076 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...) do {    \
1077         if ((_vap)->iv_debug & (_m))                                    \
1078                 ieee80211_discard_mac(_vap, _mac, _type, _fmt, __VA_ARGS__);\
1079 } while (0)
1080
1081 void ieee80211_discard_frame(const struct ieee80211vap *,
1082         const struct ieee80211_frame *, const char *type, const char *fmt, ...);
1083 void ieee80211_discard_ie(const struct ieee80211vap *,
1084         const struct ieee80211_frame *, const char *type, const char *fmt, ...);
1085 void ieee80211_discard_mac(const struct ieee80211vap *,
1086         const uint8_t mac[IEEE80211_ADDR_LEN], const char *type,
1087         const char *fmt, ...);
1088 #else
1089 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...)
1090 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...)
1091 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...)
1092 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...)
1093 #define ieee80211_msg_dumppkts(_vap)    0
1094 #define ieee80211_msg(_vap, _m)         0
1095
1096 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...)
1097 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...)
1098 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...)
1099 #endif
1100
1101 #endif /* _NET80211_IEEE80211_VAR_H_ */