xref: /freebsd/sys/net80211/ieee80211_var.h (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Atsushi Onoe
5  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $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 	struct ieee80211_node *	(*iv_update_bss)(struct ieee80211vap *,
569 				    struct ieee80211_node *);
570 
571 	/* 802.3 output method for raw frame xmit */
572 	int			(*iv_output)(struct ifnet *, struct mbuf *,
573 				    const struct sockaddr *, struct route *);
574 
575 	int			(*iv_wme_update)(struct ieee80211vap *,
576 				    const struct wmeParams *wme_params);
577 	struct task		iv_wme_task;	/* deferred VAP WME update */
578 
579 	/* associated state; protection mode */
580 	enum ieee80211_protmode	iv_protmode;	/* 802.11g protection mode */
581 	enum ieee80211_protmode	iv_htprotmode;	/* HT protection mode */
582 	uint8_t			iv_curhtprotmode;/* HTINFO bss state */
583 
584 	uint16_t		iv_nonerpsta;	/* # non-ERP stations */
585 	uint16_t		iv_longslotsta;	/* # long slot time stations */
586 	uint16_t		iv_ht_sta_assoc;/* HT stations associated */
587 	uint16_t		iv_ht40_sta_assoc;/* HT40 stations associated */
588 	int			iv_lastnonerp;	/* last time non-ERP sta noted*/
589 	int			iv_lastnonht;	/* last time non-HT sta noted */
590 
591 	/* update device state for 802.11 slot time change */
592 	void			(*iv_updateslot)(struct ieee80211vap *);
593 	struct task		iv_slot_task;	/* deferred slot time update */
594 
595 	struct task		iv_erp_protmode_task;	/* deferred ERP protmode update */
596 	void			(*iv_erp_protmode_update)(struct ieee80211vap *);
597 
598 	struct task		iv_preamble_task;	/* deferred short/barker preamble update */
599 	void			(*iv_preamble_update)(struct ieee80211vap *);
600 
601 	struct task		iv_ht_protmode_task;	/* deferred HT protmode update */
602 	void			(*iv_ht_protmode_update)(struct ieee80211vap *);
603 
604 	/* per-vap U-APSD state */
605 	uint8_t			iv_uapsdinfo;	/* sta mode QoS Info flags */
606 
607 	/* Optional transmit/receive histogram statistics */
608 	struct ieee80211_rx_histogram	*rx_histogram;
609 	struct ieee80211_tx_histogram	*tx_histogram;
610 
611 	uint64_t		iv_spare[6];
612 };
613 MALLOC_DECLARE(M_80211_VAP);
614 
615 #define	IEEE80211_ADDR_EQ(a1,a2)	(memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
616 #define	IEEE80211_ADDR_COPY(dst,src)	memcpy(dst,src,IEEE80211_ADDR_LEN)
617 
618 /* ic_flags/iv_flags */
619 #define	IEEE80211_F_TURBOP	0x00000001	/* CONF: ATH Turbo enabled*/
620 #define	IEEE80211_F_COMP	0x00000002	/* CONF: ATH comp enabled */
621 #define	IEEE80211_F_FF		0x00000004	/* CONF: ATH FF enabled */
622 #define	IEEE80211_F_BURST	0x00000008	/* CONF: bursting enabled */
623 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
624 #define	IEEE80211_F_PRIVACY	0x00000010	/* CONF: privacy enabled */
625 #define	IEEE80211_F_PUREG	0x00000020	/* CONF: 11g w/o 11b sta's */
626 #define	IEEE80211_F_SCAN	0x00000080	/* STATUS: scanning */
627 /* 0x00000300 reserved */
628 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
629 #define	IEEE80211_F_SHSLOT	0x00000400	/* STATUS: use short slot time*/
630 #define	IEEE80211_F_PMGTON	0x00000800	/* CONF: Power mgmt enable */
631 #define	IEEE80211_F_DESBSSID	0x00001000	/* CONF: des_bssid is set */
632 #define	IEEE80211_F_WME		0x00002000	/* CONF: enable WME use */
633 #define	IEEE80211_F_BGSCAN	0x00004000	/* CONF: bg scan enabled (???)*/
634 #define	IEEE80211_F_SWRETRY	0x00008000	/* CONF: sw tx retry enabled */
635 /* 0x00030000 reserved */
636 #define	IEEE80211_F_SHPREAMBLE	0x00040000	/* STATUS: use short preamble */
637 #define	IEEE80211_F_DATAPAD	0x00080000	/* CONF: do alignment pad */
638 #define	IEEE80211_F_USEPROT	0x00100000	/* STATUS: protection enabled */
639 #define	IEEE80211_F_USEBARKER	0x00200000	/* STATUS: use barker preamble*/
640 #define	IEEE80211_F_CSAPENDING	0x00400000	/* STATUS: chan switch pending*/
641 #define	IEEE80211_F_WPA1	0x00800000	/* CONF: WPA enabled */
642 #define	IEEE80211_F_WPA2	0x01000000	/* CONF: WPA2 enabled */
643 #define	IEEE80211_F_WPA		0x01800000	/* CONF: WPA/WPA2 enabled */
644 #define	IEEE80211_F_DROPUNENC	0x02000000	/* CONF: drop unencrypted */
645 #define	IEEE80211_F_COUNTERM	0x04000000	/* CONF: TKIP countermeasures */
646 #define	IEEE80211_F_HIDESSID	0x08000000	/* CONF: hide SSID in beacon */
647 #define	IEEE80211_F_NOBRIDGE	0x10000000	/* CONF: dis. internal bridge */
648 #define	IEEE80211_F_PCF		0x20000000	/* CONF: PCF enabled */
649 #define	IEEE80211_F_DOTH	0x40000000	/* CONF: 11h enabled */
650 #define	IEEE80211_F_DWDS	0x80000000	/* CONF: Dynamic WDS enabled */
651 
652 #define	IEEE80211_F_BITS \
653 	"\20\1TURBOP\2COMP\3FF\4BURST\5PRIVACY\6PUREG\10SCAN" \
654 	"\13SHSLOT\14PMGTON\15DESBSSID\16WME\17BGSCAN\20SWRETRY" \
655 	"\23SHPREAMBLE\24DATAPAD\25USEPROT\26USERBARKER\27CSAPENDING" \
656 	"\30WPA1\31WPA2\32DROPUNENC\33COUNTERM\34HIDESSID\35NOBRIDG\36PCF" \
657 	"\37DOTH\40DWDS"
658 
659 /* Atheros protocol-specific flags */
660 #define	IEEE80211_F_ATHEROS \
661 	(IEEE80211_F_FF | IEEE80211_F_COMP | IEEE80211_F_TURBOP)
662 /* Check if an Atheros capability was negotiated for use */
663 #define	IEEE80211_ATH_CAP(vap, ni, bit) \
664 	((vap)->iv_flags & (ni)->ni_ath_flags & (bit))
665 
666 /* ic_flags_ext/iv_flags_ext */
667 #define	IEEE80211_FEXT_INACT	 0x00000002	/* CONF: sta inact handling */
668 #define	IEEE80211_FEXT_SCANWAIT	 0x00000004	/* STATUS: awaiting scan */
669 /* 0x00000006 reserved */
670 #define	IEEE80211_FEXT_BGSCAN	 0x00000008	/* STATUS: complete bgscan */
671 #define	IEEE80211_FEXT_WPS	 0x00000010	/* CONF: WPS enabled */
672 #define	IEEE80211_FEXT_TSN 	 0x00000020	/* CONF: TSN enabled */
673 #define	IEEE80211_FEXT_SCANREQ	 0x00000040	/* STATUS: scan req params */
674 #define	IEEE80211_FEXT_RESUME	 0x00000080	/* STATUS: start on resume */
675 #define	IEEE80211_FEXT_4ADDR	 0x00000100	/* CONF: apply 4-addr encap */
676 #define	IEEE80211_FEXT_NONERP_PR 0x00000200	/* STATUS: non-ERP sta present*/
677 #define	IEEE80211_FEXT_SWBMISS	 0x00000400	/* CONF: do bmiss in s/w */
678 #define	IEEE80211_FEXT_DFS	 0x00000800	/* CONF: DFS enabled */
679 #define	IEEE80211_FEXT_DOTD	 0x00001000	/* CONF: 11d enabled */
680 #define	IEEE80211_FEXT_STATEWAIT 0x00002000	/* STATUS: awaiting state chg */
681 #define	IEEE80211_FEXT_REINIT	 0x00004000	/* STATUS: INIT state first */
682 #define	IEEE80211_FEXT_BPF	 0x00008000	/* STATUS: BPF tap present */
683 /* NB: immutable: should be set only when creating a vap */
684 #define	IEEE80211_FEXT_WDSLEGACY 0x00010000	/* CONF: legacy WDS operation */
685 #define	IEEE80211_FEXT_PROBECHAN 0x00020000	/* CONF: probe passive channel*/
686 #define	IEEE80211_FEXT_UNIQMAC	 0x00040000	/* CONF: user or computed mac */
687 #define	IEEE80211_FEXT_SCAN_OFFLOAD	0x00080000	/* CONF: scan is fully offloaded */
688 #define	IEEE80211_FEXT_SEQNO_OFFLOAD	0x00100000	/* CONF: driver does seqno insertion/allocation */
689 #define	IEEE80211_FEXT_FRAG_OFFLOAD	0x00200000	/* CONF: hardware does 802.11 fragmentation + assignment */
690 #define	IEEE80211_FEXT_VHT	0x00400000	/* CONF: VHT support */
691 #define	IEEE80211_FEXT_QUIET_IE	0x00800000	/* STATUS: quiet IE in a beacon has been added */
692 #define	IEEE80211_FEXT_UAPSD	0x01000000	/* CONF: enable U-APSD */
693 
694 #define	IEEE80211_FEXT_BITS \
695 	"\20\2INACT\3SCANWAIT\4BGSCAN\5WPS\6TSN\7SCANREQ\10RESUME" \
696 	"\0114ADDR\12NONEPR_PR\13SWBMISS\14DFS\15DOTD\16STATEWAIT\17REINIT" \
697 	"\20BPF\21WDSLEGACY\22PROBECHAN\23UNIQMAC\24SCAN_OFFLOAD\25SEQNO_OFFLOAD" \
698 	    "\26FRAG_OFFLOAD\27VHT" \
699 	"\30QUIET_IE\31UAPSD"
700 
701 /* ic_flags_ht/iv_flags_ht */
702 #define	IEEE80211_FHT_NONHT_PR	 0x00000001	/* STATUS: non-HT sta present */
703 #define	IEEE80211_FHT_LDPC_TX	 0x00010000	/* CONF: LDPC tx enabled */
704 #define	IEEE80211_FHT_LDPC_RX	 0x00020000	/* CONF: LDPC rx enabled */
705 #define	IEEE80211_FHT_GF  	 0x00040000	/* CONF: Greenfield enabled */
706 #define	IEEE80211_FHT_HT	 0x00080000	/* CONF: HT supported */
707 #define	IEEE80211_FHT_AMPDU_TX	 0x00100000	/* CONF: A-MPDU tx supported */
708 #define	IEEE80211_FHT_AMPDU_RX	 0x00200000	/* CONF: A-MPDU rx supported */
709 #define	IEEE80211_FHT_AMSDU_TX	 0x00400000	/* CONF: A-MSDU tx supported */
710 #define	IEEE80211_FHT_AMSDU_RX	 0x00800000	/* CONF: A-MSDU rx supported */
711 #define	IEEE80211_FHT_USEHT40	 0x01000000	/* CONF: 20/40 use enabled */
712 #define	IEEE80211_FHT_PUREN	 0x02000000	/* CONF: 11n w/o legacy sta's */
713 #define	IEEE80211_FHT_SHORTGI20	 0x04000000	/* CONF: short GI in HT20 */
714 #define	IEEE80211_FHT_SHORTGI40	 0x08000000	/* CONF: short GI in HT40 */
715 #define	IEEE80211_FHT_HTCOMPAT 	 0x10000000	/* CONF: HT vendor OUI's */
716 #define	IEEE80211_FHT_RIFS  	 0x20000000	/* CONF: RIFS enabled */
717 #define	IEEE80211_FHT_STBC_TX 	 0x40000000	/* CONF: STBC tx enabled */
718 #define	IEEE80211_FHT_STBC_RX 	 0x80000000	/* CONF: STBC rx enabled */
719 
720 #define	IEEE80211_FHT_BITS \
721 	"\20\1NONHT_PR" \
722 	"\23GF\24HT\25AMPDU_TX\26AMPDU_TX" \
723 	"\27AMSDU_TX\30AMSDU_RX\31USEHT40\32PUREN\33SHORTGI20\34SHORTGI40" \
724 	"\35HTCOMPAT\36RIFS\37STBC_TX\40STBC_RX"
725 
726 #define	IEEE80211_FVEN_BITS	"\20"
727 
728 #define	IEEE80211_FVHT_VHT	0x000000001	/* CONF: VHT supported */
729 #define	IEEE80211_FVHT_USEVHT40	0x000000002	/* CONF: Use VHT40 */
730 #define	IEEE80211_FVHT_USEVHT80	0x000000004	/* CONF: Use VHT80 */
731 #define	IEEE80211_FVHT_USEVHT160	0x000000008	/* CONF: Use VHT160 */
732 #define	IEEE80211_FVHT_USEVHT80P80	0x000000010	/* CONF: Use VHT 80+80 */
733 #define	IEEE80211_FVHT_MASK						\
734 	(IEEE80211_FVHT_VHT | IEEE80211_FVHT_USEVHT40 |			\
735 	IEEE80211_FVHT_USEVHT80 | IEEE80211_FVHT_USEVHT160 |		\
736 	IEEE80211_FVHT_USEVHT80P80)
737 #define	IEEE80211_VFHT_BITS \
738 	"\20\1VHT\2VHT40\3VHT80\4VHT160\5VHT80P80"
739 
740 #define	IEEE80211_COM_DETACHED	0x00000001	/* ieee80211_ifdetach called */
741 #define	IEEE80211_COM_REF_ADD	0x00000002	/* add / remove reference */
742 #define	IEEE80211_COM_REF	0xfffffffe	/* reference counter bits */
743 #define	IEEE80211_COM_REF_S	1
744 #define	IEEE80211_COM_REF_MAX	(IEEE80211_COM_REF >> IEEE80211_COM_REF_S)
745 
746 int	ic_printf(struct ieee80211com *, const char *, ...) __printflike(2, 3);
747 void	ieee80211_ifattach(struct ieee80211com *);
748 void	ieee80211_ifdetach(struct ieee80211com *);
749 int	ieee80211_vap_setup(struct ieee80211com *, struct ieee80211vap *,
750 		const char name[IFNAMSIZ], int unit,
751 		enum ieee80211_opmode opmode, int flags,
752 		const uint8_t bssid[IEEE80211_ADDR_LEN]);
753 int	ieee80211_vap_attach(struct ieee80211vap *,
754 		ifm_change_cb_t, ifm_stat_cb_t,
755 		const uint8_t macaddr[IEEE80211_ADDR_LEN]);
756 void	ieee80211_vap_detach(struct ieee80211vap *);
757 const struct ieee80211_rateset *ieee80211_get_suprates(struct ieee80211com *ic,
758 		const struct ieee80211_channel *);
759 const struct ieee80211_htrateset *ieee80211_get_suphtrates(
760 		struct ieee80211com *, const struct ieee80211_channel *);
761 void	ieee80211_announce(struct ieee80211com *);
762 void	ieee80211_announce_channels(struct ieee80211com *);
763 void	ieee80211_drain(struct ieee80211com *);
764 void	ieee80211_chan_init(struct ieee80211com *);
765 struct ieee80211com *ieee80211_find_vap(const uint8_t mac[IEEE80211_ADDR_LEN]);
766 struct ieee80211com *ieee80211_find_com(const char *name);
767 typedef void ieee80211_com_iter_func(void *, struct ieee80211com *);
768 void	ieee80211_iterate_coms(ieee80211_com_iter_func *, void *);
769 int	ieee80211_media_change(struct ifnet *);
770 void	ieee80211_media_status(struct ifnet *, struct ifmediareq *);
771 int	ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
772 int	ieee80211_rate2media(struct ieee80211com *, int,
773 		enum ieee80211_phymode);
774 int	ieee80211_media2rate(int);
775 int	ieee80211_mhz2ieee(u_int, u_int);
776 int	ieee80211_chan2ieee(struct ieee80211com *,
777 		const struct ieee80211_channel *);
778 u_int	ieee80211_ieee2mhz(u_int, u_int);
779 int	ieee80211_add_channel_cbw(struct ieee80211_channel[], int, int *,
780 	    uint8_t, uint16_t, int8_t, uint32_t, const uint8_t[], int);
781 int	ieee80211_add_channel(struct ieee80211_channel[], int, int *,
782 	    uint8_t, uint16_t, int8_t, uint32_t, const uint8_t[]);
783 int	ieee80211_add_channel_ht40(struct ieee80211_channel[], int, int *,
784 	    uint8_t, int8_t, uint32_t);
785 uint32_t ieee80211_get_channel_center_freq(const struct ieee80211_channel *);
786 uint32_t ieee80211_get_channel_center_freq1(const struct ieee80211_channel *);
787 uint32_t ieee80211_get_channel_center_freq2(const struct ieee80211_channel *);
788 #define	NET80211_CBW_FLAG_HT40		0x01
789 #define	NET80211_CBW_FLAG_VHT80		0x02
790 #define	NET80211_CBW_FLAG_VHT160	0x04
791 #define	NET80211_CBW_FLAG_VHT80P80	0x08
792 int	ieee80211_add_channel_list_2ghz(struct ieee80211_channel[], int, int *,
793 	    const uint8_t[], int, const uint8_t[], int);
794 int	ieee80211_add_channels_default_2ghz(struct ieee80211_channel[], int,
795 	    int *, const uint8_t[], int);
796 int	ieee80211_add_channel_list_5ghz(struct ieee80211_channel[], int, int *,
797 	    const uint8_t[], int, const uint8_t[], int);
798 struct ieee80211_channel *ieee80211_find_channel(struct ieee80211com *,
799 		int freq, int flags);
800 struct ieee80211_channel *ieee80211_find_channel_byieee(struct ieee80211com *,
801 		int ieee, int flags);
802 struct ieee80211_channel *ieee80211_lookup_channel_rxstatus(struct ieee80211vap *,
803 		const struct ieee80211_rx_stats *);
804 int	ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
805 enum ieee80211_phymode ieee80211_chan2mode(const struct ieee80211_channel *);
806 uint32_t ieee80211_mac_hash(const struct ieee80211com *,
807 		const uint8_t addr[IEEE80211_ADDR_LEN]);
808 char	ieee80211_channel_type_char(const struct ieee80211_channel *c);
809 
810 #define	ieee80211_get_current_channel(_ic)	((_ic)->ic_curchan)
811 #define	ieee80211_get_home_channel(_ic)		((_ic)->ic_bsschan)
812 #define	ieee80211_get_vap_desired_channel(_iv)	((_iv)->iv_des_chan)
813 
814 void	ieee80211_radiotap_attach(struct ieee80211com *,
815 	    struct ieee80211_radiotap_header *th, int tlen,
816 		uint32_t tx_radiotap,
817 	    struct ieee80211_radiotap_header *rh, int rlen,
818 		uint32_t rx_radiotap);
819 void	ieee80211_radiotap_attachv(struct ieee80211com *,
820 	    struct ieee80211_radiotap_header *th,
821 	    int tlen, int n_tx_v, uint32_t tx_radiotap,
822 	    struct ieee80211_radiotap_header *rh,
823 	    int rlen, int n_rx_v, uint32_t rx_radiotap);
824 void	ieee80211_radiotap_detach(struct ieee80211com *);
825 void	ieee80211_radiotap_vattach(struct ieee80211vap *);
826 void	ieee80211_radiotap_vdetach(struct ieee80211vap *);
827 void	ieee80211_radiotap_chan_change(struct ieee80211com *);
828 void	ieee80211_radiotap_tx(struct ieee80211vap *, struct mbuf *);
829 void	ieee80211_radiotap_rx(struct ieee80211vap *, struct mbuf *);
830 void	ieee80211_radiotap_rx_all(struct ieee80211com *, struct mbuf *);
831 
832 static __inline int
833 ieee80211_radiotap_active(const struct ieee80211com *ic)
834 {
835 	return (ic->ic_flags_ext & IEEE80211_FEXT_BPF) != 0;
836 }
837 
838 static __inline int
839 ieee80211_radiotap_active_vap(const struct ieee80211vap *vap)
840 {
841 	return (vap->iv_flags_ext & IEEE80211_FEXT_BPF) ||
842 	    vap->iv_ic->ic_montaps != 0;
843 }
844 
845 /*
846  * Enqueue a task on the state thread.
847  */
848 static __inline void
849 ieee80211_runtask(struct ieee80211com *ic, struct task *task)
850 {
851 	taskqueue_enqueue(ic->ic_tq, task);
852 }
853 
854 /*
855  * Wait for a queued task to complete.
856  */
857 static __inline void
858 ieee80211_draintask(struct ieee80211com *ic, struct task *task)
859 {
860 	taskqueue_drain(ic->ic_tq, task);
861 }
862 
863 /*
864  * Key update synchronization methods.  XXX should not be visible.
865  */
866 static __inline void
867 ieee80211_key_update_begin(struct ieee80211vap *vap)
868 {
869 	vap->iv_key_update_begin(vap);
870 }
871 static __inline void
872 ieee80211_key_update_end(struct ieee80211vap *vap)
873 {
874 	vap->iv_key_update_end(vap);
875 }
876 
877 /*
878  * XXX these need to be here for IEEE80211_F_DATAPAD
879  */
880 
881 /*
882  * Return the space occupied by the 802.11 header and any
883  * padding required by the driver.  This works for a
884  * management or data frame.
885  */
886 static __inline int
887 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
888 {
889 	int size = ieee80211_hdrsize(data);
890 	if (ic->ic_flags & IEEE80211_F_DATAPAD)
891 		size = roundup(size, sizeof(uint32_t));
892 	return size;
893 }
894 
895 /*
896  * Like ieee80211_hdrspace, but handles any type of frame.
897  */
898 static __inline int
899 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
900 {
901 	int size = ieee80211_anyhdrsize(data);
902 	if (ic->ic_flags & IEEE80211_F_DATAPAD)
903 		size = roundup(size, sizeof(uint32_t));
904 	return size;
905 }
906 
907 /*
908  * Notify a vap that beacon state has been updated.
909  */
910 static __inline void
911 ieee80211_beacon_notify(struct ieee80211vap *vap, int what)
912 {
913 	if (vap->iv_state == IEEE80211_S_RUN)
914 		vap->iv_update_beacon(vap, what);
915 }
916 
917 /*
918  * Calculate HT channel promotion flags for a channel.
919  * XXX belongs in ieee80211_ht.h but needs IEEE80211_FHT_*
920  */
921 static __inline int
922 ieee80211_htchanflags(const struct ieee80211_channel *c)
923 {
924 	return IEEE80211_IS_CHAN_HT40(c) ?
925 	    IEEE80211_FHT_HT | IEEE80211_FHT_USEHT40 :
926 	    IEEE80211_IS_CHAN_HT(c) ?  IEEE80211_FHT_HT : 0;
927 }
928 
929 /*
930  * Calculate VHT channel promotion flags for a channel.
931  * XXX belongs in ieee80211_vht.h but needs IEEE80211_FVHT_*
932  */
933 static __inline int
934 ieee80211_vhtchanflags(const struct ieee80211_channel *c)
935 {
936 
937 	if (IEEE80211_IS_CHAN_VHT160(c))
938 		return IEEE80211_FVHT_USEVHT160;
939 	if (IEEE80211_IS_CHAN_VHT80P80(c))
940 		return IEEE80211_FVHT_USEVHT80P80;
941 	if (IEEE80211_IS_CHAN_VHT80(c))
942 		return IEEE80211_FVHT_USEVHT80;
943 	if (IEEE80211_IS_CHAN_VHT40(c))
944 		return IEEE80211_FVHT_USEVHT40;
945 	if (IEEE80211_IS_CHAN_VHT(c))
946 		return IEEE80211_FVHT_VHT;
947 	return (0);
948 }
949 
950 /*
951  * Fetch the current TX power (cap) for the given node.
952  *
953  * This includes the node and ic/vap TX power limit as needed,
954  * but it doesn't take into account any per-rate limit.
955  */
956 static __inline uint16_t
957 ieee80211_get_node_txpower(struct ieee80211_node *ni)
958 {
959 	struct ieee80211com *ic = ni->ni_ic;
960 	uint16_t txpower;
961 
962 	txpower = ni->ni_txpower;
963 	txpower = MIN(txpower, ic->ic_txpowlimit);
964 	if (ic->ic_curchan != NULL) {
965 		txpower = MIN(txpower, 2 * ic->ic_curchan->ic_maxregpower);
966 		txpower = MIN(txpower, ic->ic_curchan->ic_maxpower);
967 	}
968 
969 	return (txpower);
970 }
971 
972 /*
973  * Debugging facilities compiled in when IEEE80211_DEBUG is defined.
974  *
975  * The intent is that any problem in the net80211 layer can be
976  * diagnosed by inspecting the statistics (dumped by the wlanstats
977  * program) and/or the msgs generated by net80211.  Messages are
978  * broken into functional classes and can be controlled with the
979  * wlandebug program.  Certain of these msg groups are for facilities
980  * that are no longer part of net80211 (e.g. IEEE80211_MSG_DOT1XSM).
981  */
982 #define	IEEE80211_MSG_11N	0x80000000	/* 11n mode debug */
983 #define	IEEE80211_MSG_DEBUG	0x40000000	/* IFF_DEBUG equivalent */
984 #define	IEEE80211_MSG_DUMPPKTS	0x20000000	/* IFF_LINK2 equivalant */
985 #define	IEEE80211_MSG_CRYPTO	0x10000000	/* crypto work */
986 #define	IEEE80211_MSG_INPUT	0x08000000	/* input handling */
987 #define	IEEE80211_MSG_XRATE	0x04000000	/* rate set handling */
988 #define	IEEE80211_MSG_ELEMID	0x02000000	/* element id parsing */
989 #define	IEEE80211_MSG_NODE	0x01000000	/* node handling */
990 #define	IEEE80211_MSG_ASSOC	0x00800000	/* association handling */
991 #define	IEEE80211_MSG_AUTH	0x00400000	/* authentication handling */
992 #define	IEEE80211_MSG_SCAN	0x00200000	/* scanning */
993 #define	IEEE80211_MSG_OUTPUT	0x00100000	/* output handling */
994 #define	IEEE80211_MSG_STATE	0x00080000	/* state machine */
995 #define	IEEE80211_MSG_POWER	0x00040000	/* power save handling */
996 #define	IEEE80211_MSG_HWMP	0x00020000	/* hybrid mesh protocol */
997 #define	IEEE80211_MSG_DOT1XSM	0x00010000	/* 802.1x state machine */
998 #define	IEEE80211_MSG_RADIUS	0x00008000	/* 802.1x radius client */
999 #define	IEEE80211_MSG_RADDUMP	0x00004000	/* dump 802.1x radius packets */
1000 #define	IEEE80211_MSG_MESH	0x00002000	/* mesh networking */
1001 #define	IEEE80211_MSG_WPA	0x00001000	/* WPA/RSN protocol */
1002 #define	IEEE80211_MSG_ACL	0x00000800	/* ACL handling */
1003 #define	IEEE80211_MSG_WME	0x00000400	/* WME protocol */
1004 #define	IEEE80211_MSG_SUPERG	0x00000200	/* Atheros SuperG protocol */
1005 #define	IEEE80211_MSG_DOTH	0x00000100	/* 802.11h support */
1006 #define	IEEE80211_MSG_INACT	0x00000080	/* inactivity handling */
1007 #define	IEEE80211_MSG_ROAM	0x00000040	/* sta-mode roaming */
1008 #define	IEEE80211_MSG_RATECTL	0x00000020	/* tx rate control */
1009 #define	IEEE80211_MSG_ACTION	0x00000010	/* action frame handling */
1010 #define	IEEE80211_MSG_WDS	0x00000008	/* WDS handling */
1011 #define	IEEE80211_MSG_IOCTL	0x00000004	/* ioctl handling */
1012 #define	IEEE80211_MSG_TDMA	0x00000002	/* TDMA handling */
1013 
1014 #define	IEEE80211_MSG_ANY	0xffffffff	/* anything */
1015 
1016 #define	IEEE80211_MSG_BITS \
1017 	"\20\2TDMA\3IOCTL\4WDS\5ACTION\6RATECTL\7ROAM\10INACT\11DOTH\12SUPERG" \
1018 	"\13WME\14ACL\15WPA\16RADKEYS\17RADDUMP\20RADIUS\21DOT1XSM\22HWMP" \
1019 	"\23POWER\24STATE\25OUTPUT\26SCAN\27AUTH\30ASSOC\31NODE\32ELEMID" \
1020 	"\33XRATE\34INPUT\35CRYPTO\36DUPMPKTS\37DEBUG\04011N"
1021 
1022 /* Helper macros unified. */
1023 #define	_IEEE80211_MASKSHIFT(_v, _f)	(((_v) & _f) >> _f##_S)
1024 #define	_IEEE80211_SHIFTMASK(_v, _f)	(((_v) << _f##_S) & _f)
1025 
1026 #ifdef IEEE80211_DEBUG
1027 #define	ieee80211_msg(_vap, _m)	((_vap)->iv_debug & (_m))
1028 #define	IEEE80211_DPRINTF(_vap, _m, _fmt, ...) do {			\
1029 	if (ieee80211_msg(_vap, _m))					\
1030 		ieee80211_note(_vap, _fmt, __VA_ARGS__);		\
1031 } while (0)
1032 #define	IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...) do {			\
1033 	if (ieee80211_msg(_vap, _m))					\
1034 		ieee80211_note_mac(_vap, (_ni)->ni_macaddr, _fmt, __VA_ARGS__);\
1035 } while (0)
1036 #define	IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...) do {		\
1037 	if (ieee80211_msg(_vap, _m))					\
1038 		ieee80211_note_mac(_vap, _mac, _fmt, __VA_ARGS__);	\
1039 } while (0)
1040 #define	IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...) do {		\
1041 	if (ieee80211_msg(_vap, _m))					\
1042 		ieee80211_note_frame(_vap, _wh, _fmt, __VA_ARGS__);	\
1043 } while (0)
1044 void	ieee80211_note(const struct ieee80211vap *, const char *, ...);
1045 void	ieee80211_note_mac(const struct ieee80211vap *,
1046 		const uint8_t mac[IEEE80211_ADDR_LEN], const char *, ...);
1047 void	ieee80211_note_frame(const struct ieee80211vap *,
1048 		const struct ieee80211_frame *, const char *, ...);
1049 #define	ieee80211_msg_debug(_vap) \
1050 	((_vap)->iv_debug & IEEE80211_MSG_DEBUG)
1051 #define	ieee80211_msg_dumppkts(_vap) \
1052 	((_vap)->iv_debug & IEEE80211_MSG_DUMPPKTS)
1053 #define	ieee80211_msg_input(_vap) \
1054 	((_vap)->iv_debug & IEEE80211_MSG_INPUT)
1055 #define	ieee80211_msg_radius(_vap) \
1056 	((_vap)->iv_debug & IEEE80211_MSG_RADIUS)
1057 #define	ieee80211_msg_dumpradius(_vap) \
1058 	((_vap)->iv_debug & IEEE80211_MSG_RADDUMP)
1059 #define	ieee80211_msg_dumpradkeys(_vap) \
1060 	((_vap)->iv_debug & IEEE80211_MSG_RADKEYS)
1061 #define	ieee80211_msg_scan(_vap) \
1062 	((_vap)->iv_debug & IEEE80211_MSG_SCAN)
1063 #define	ieee80211_msg_assoc(_vap) \
1064 	((_vap)->iv_debug & IEEE80211_MSG_ASSOC)
1065 
1066 /*
1067  * Emit a debug message about discarding a frame or information
1068  * element.  One format is for extracting the mac address from
1069  * the frame header; the other is for when a header is not
1070  * available or otherwise appropriate.
1071  */
1072 #define	IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...) do {		\
1073 	if ((_vap)->iv_debug & (_m))					\
1074 		ieee80211_discard_frame(_vap, _wh, _type,		\
1075 		   "%s:%d: " _fmt, __func__, __LINE__, __VA_ARGS__);	\
1076 } while (0)
1077 #define	IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...) do {	\
1078 	if ((_vap)->iv_debug & (_m))					\
1079 		ieee80211_discard_ie(_vap, _wh, _type,			\
1080 		    "%s:%d: " _fmt, __func__, __LINE__, __VA_ARGS__);	\
1081 } while (0)
1082 #define	IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...) do {	\
1083 	if ((_vap)->iv_debug & (_m))					\
1084 		ieee80211_discard_mac(_vap, _mac, _type,		\
1085 		    "%s:%d: " _fmt, __func__, __LINE__, __VA_ARGS__);	\
1086 } while (0)
1087 
1088 void ieee80211_discard_frame(const struct ieee80211vap *,
1089 	const struct ieee80211_frame *, const char *type, const char *fmt, ...);
1090 void ieee80211_discard_ie(const struct ieee80211vap *,
1091 	const struct ieee80211_frame *, const char *type, const char *fmt, ...);
1092 void ieee80211_discard_mac(const struct ieee80211vap *,
1093 	const uint8_t mac[IEEE80211_ADDR_LEN], const char *type,
1094 	const char *fmt, ...);
1095 #else
1096 #define	IEEE80211_DPRINTF(_vap, _m, _fmt, ...)
1097 #define	IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...)
1098 #define	IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...)
1099 #define	IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...)
1100 #define	ieee80211_msg_dumppkts(_vap)	0
1101 #define	ieee80211_msg(_vap, _m)		0
1102 
1103 #define	IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...)
1104 #define	IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...)
1105 #define	IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...)
1106 #endif
1107 
1108 #endif /* _NET80211_IEEE80211_VAR_H_ */
1109