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