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