xref: /freebsd/sys/net80211/ieee80211_var.h (revision 54ebdd631db8c0bba2baab0155f603a8b5cf014a)
1 /*-
2  * Copyright (c) 2001 Atsushi Onoe
3  * Copyright (c) 2002-2008 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 #ifdef __NetBSD__
36 #include <net80211/ieee80211_netbsd.h>
37 #elif __FreeBSD__
38 #include <net80211/ieee80211_freebsd.h>
39 #elif __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_crypto.h>
48 #include <net80211/ieee80211_dfs.h>
49 #include <net80211/ieee80211_ioctl.h>		/* for ieee80211_stats */
50 #include <net80211/ieee80211_power.h>
51 #include <net80211/ieee80211_node.h>
52 #include <net80211/ieee80211_proto.h>
53 #include <net80211/ieee80211_scan.h>
54 
55 #define	IEEE80211_TXPOWER_MAX	100	/* .5 dbM (XXX units?) */
56 #define	IEEE80211_TXPOWER_MIN	0	/* kill radio */
57 
58 #define	IEEE80211_DTIM_DEFAULT	1	/* default DTIM period */
59 #define	IEEE80211_BINTVAL_DEFAULT 100	/* default beacon interval (TU's) */
60 
61 #define	IEEE80211_BMISS_MAX	2	/* maximum consecutive bmiss allowed */
62 #define	IEEE80211_HWBMISS_DEFAULT 7	/* h/w bmiss threshold (beacons) */
63 
64 #define	IEEE80211_BGSCAN_INTVAL_MIN	15	/* min bg scan intvl (secs) */
65 #define	IEEE80211_BGSCAN_INTVAL_DEFAULT	(5*60)	/* default bg scan intvl */
66 
67 #define	IEEE80211_BGSCAN_IDLE_MIN	100	/* min idle time (ms) */
68 #define	IEEE80211_BGSCAN_IDLE_DEFAULT	250	/* default idle time (ms) */
69 
70 #define	IEEE80211_SCAN_VALID_MIN	10	/* min scan valid time (secs) */
71 #define	IEEE80211_SCAN_VALID_DEFAULT	60	/* default scan valid time */
72 
73 #define	IEEE80211_PS_SLEEP	0x1	/* STA is in power saving mode */
74 #define	IEEE80211_PS_MAX_QUEUE	50	/* maximum saved packets */
75 
76 #define	IEEE80211_FIXED_RATE_NONE	0xff
77 #define	IEEE80211_TXMAX_DEFAULT		6	/* default ucast max retries */
78 
79 #define	IEEE80211_RTS_DEFAULT		IEEE80211_RTS_MAX
80 #define	IEEE80211_FRAG_DEFAULT		IEEE80211_FRAG_MAX
81 
82 #define	IEEE80211_MS_TO_TU(x)	(((x) * 1000) / 1024)
83 #define	IEEE80211_TU_TO_MS(x)	(((x) * 1024) / 1000)
84 #define	IEEE80211_TU_TO_TICKS(x)(((x) * 1024 * hz) / (1000 * 1000))
85 
86 /*
87  * 802.11 control state is split into a common portion that maps
88  * 1-1 to a physical device and one or more "Virtual AP's" (VAP)
89  * that are bound to an ieee80211com instance and share a single
90  * underlying device.  Each VAP has a corresponding OS device
91  * entity through which traffic flows and that applications use
92  * for issuing ioctls, etc.
93  */
94 
95 /*
96  * Data common to one or more virtual AP's.  State shared by
97  * the underlying device and the net80211 layer is exposed here;
98  * e.g. device-specific callbacks.
99  */
100 struct ieee80211vap;
101 typedef void (*ieee80211vap_attach)(struct ieee80211vap *);
102 
103 struct ieee80211_appie {
104 	uint16_t		ie_len;		/* size of ie_data */
105 	uint8_t			ie_data[];	/* user-specified IE's */
106 };
107 
108 struct ieee80211com {
109 	struct ifnet		*ic_ifp;	/* associated device */
110 	ieee80211_com_lock_t	ic_comlock;	/* state update lock */
111 	TAILQ_HEAD(, ieee80211vap) ic_vaps;	/* list of vap instances */
112 	struct ieee80211_stats	ic_stats;	/* statistics */
113 	int			ic_headroom;	/* driver tx headroom needs */
114 	enum ieee80211_phytype	ic_phytype;	/* XXX wrong for multi-mode */
115 	enum ieee80211_opmode	ic_opmode;	/* operation mode */
116 	struct ifmedia		ic_media;	/* interface media config */
117 	uint8_t			ic_myaddr[IEEE80211_ADDR_LEN];
118 	struct callout		ic_inact;	/* inactivity processing */
119 	struct task		ic_parent_task;	/* deferred parent processing */
120 
121 	uint32_t		ic_flags;	/* state flags */
122 	uint32_t		ic_flags_ext;	/* extended state flags */
123 	uint32_t		ic_flags_ven;	/* vendor state flags */
124 	uint32_t		ic_caps;	/* capabilities */
125 	uint32_t		ic_htcaps;	/* HT capabilities */
126 	uint32_t		ic_cryptocaps;	/* crypto capabilities */
127 	uint8_t			ic_modecaps[2];	/* set of mode capabilities */
128 	uint8_t			ic_promisc;	/* vap's needing promisc mode */
129 	uint8_t			ic_allmulti;	/* vap's needing all multicast*/
130 	uint8_t			ic_nrunning;	/* vap's marked running */
131 	uint8_t			ic_curmode;	/* current mode */
132 	uint16_t		ic_bintval;	/* beacon interval */
133 	uint16_t		ic_lintval;	/* listen interval */
134 	uint16_t		ic_holdover;	/* PM hold over duration */
135 	uint16_t		ic_txpowlimit;	/* global tx power limit */
136 	struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
137 
138 	/*
139 	 * Channel state:
140 	 *
141 	 * ic_channels is the set of available channels for the device;
142 	 *    it is setup by the driver
143 	 * ic_nchans is the number of valid entries in ic_channels
144 	 * ic_chan_avail is a bit vector of these channels used to check
145 	 *    whether a channel is available w/o searching the channel table.
146 	 * ic_chan_active is a (potentially) constrained subset of
147 	 *    ic_chan_avail that reflects any mode setting or user-specified
148 	 *    limit on the set of channels to use/scan
149 	 * ic_curchan is the current channel the device is set to; it may
150 	 *    be different from ic_bsschan when we are off-channel scanning
151 	 *    or otherwise doing background work
152 	 * ic_bsschan is the channel selected for operation; it may
153 	 *    be undefined (IEEE80211_CHAN_ANYC)
154 	 * ic_prevchan is a cached ``previous channel'' used to optimize
155 	 *    lookups when switching back+forth between two channels
156 	 *    (e.g. for dynamic turbo)
157 	 */
158 	int			ic_nchans;	/* # entries in ic_channels */
159 	struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
160 	uint8_t			ic_chan_avail[IEEE80211_CHAN_BYTES];
161 	uint8_t			ic_chan_active[IEEE80211_CHAN_BYTES];
162 	uint8_t			ic_chan_scan[IEEE80211_CHAN_BYTES];
163 	struct ieee80211_channel *ic_curchan;	/* current channel */
164 	struct ieee80211_channel *ic_bsschan;	/* bss channel */
165 	struct ieee80211_channel *ic_prevchan;	/* previous channel */
166 	struct ieee80211_regdomain ic_regdomain;/* regulatory data */
167 	struct ieee80211_appie	*ic_countryie;	/* calculated country ie */
168 	struct ieee80211_channel *ic_countryie_chan;
169 
170 	/* 802.11h/DFS state */
171 	struct ieee80211_channel *ic_csa_newchan;/* channel for doing CSA */
172 	int			ic_csa_count;	/* count for doing CSA */
173 	struct ieee80211_dfs_state ic_dfs;	/* DFS state */
174 
175 	struct ieee80211_scan_state *ic_scan;	/* scan state */
176 	int			ic_lastdata;	/* time of last data frame */
177 	int			ic_lastscan;	/* time last scan completed */
178 
179 	/* NB: this is the union of all vap stations/neighbors */
180 	int			ic_max_keyix;	/* max h/w key index */
181 	struct ieee80211_node_table ic_sta;	/* stations/neighbors */
182 
183 	/* XXX multi-bss: split out common/vap parts */
184 	struct ieee80211_wme_state ic_wme;	/* WME/WMM state */
185 
186 	/* XXX multi-bss: can per-vap be done/make sense? */
187 	enum ieee80211_protmode	ic_protmode;	/* 802.11g protection mode */
188 	uint16_t		ic_nonerpsta;	/* # non-ERP stations */
189 	uint16_t		ic_longslotsta;	/* # long slot time stations */
190 	uint16_t		ic_sta_assoc;	/* stations associated */
191 	uint16_t		ic_ht_sta_assoc;/* HT stations associated */
192 	uint16_t		ic_ht40_sta_assoc;/* HT40 stations associated */
193 	uint8_t			ic_curhtprotmode;/* HTINFO bss state */
194 	enum ieee80211_protmode	ic_htprotmode;	/* HT protection mode */
195 	int			ic_lastnonerp;	/* last time non-ERP sta noted*/
196 	int			ic_lastnonht;	/* last time non-HT sta noted */
197 
198 	/* virtual ap create/delete */
199 	struct ieee80211vap*	(*ic_vap_create)(struct ieee80211com *,
200 				    const char name[IFNAMSIZ], int unit,
201 				    int opmode, int flags,
202 				    const uint8_t bssid[IEEE80211_ADDR_LEN],
203 				    const uint8_t macaddr[IEEE80211_ADDR_LEN]);
204 	void			(*ic_vap_delete)(struct ieee80211vap *);
205 	/* operating mode attachment */
206 	ieee80211vap_attach	ic_vattach[IEEE80211_OPMODE_MAX];
207 	/* return hardware/radio capabilities */
208 	void			(*ic_getradiocaps)(struct ieee80211com *,
209 				    int *, struct ieee80211_channel []);
210 	/* check and/or prepare regdomain state change */
211 	int			(*ic_setregdomain)(struct ieee80211com *,
212 				    struct ieee80211_regdomain *,
213 				    int, struct ieee80211_channel []);
214 	/* send/recv 802.11 management frame */
215 	int			(*ic_send_mgmt)(struct ieee80211_node *,
216 				     int, int);
217 	/* send raw 802.11 frame */
218 	int			(*ic_raw_xmit)(struct ieee80211_node *,
219 				    struct mbuf *,
220 				    const struct ieee80211_bpf_params *);
221 	/* update device state for 802.11 slot time change */
222 	void			(*ic_updateslot)(struct ifnet *);
223 	/* handle multicast state changes */
224 	void			(*ic_update_mcast)(struct ifnet *);
225 	/* handle promiscuous mode changes */
226 	void			(*ic_update_promisc)(struct ifnet *);
227 	/* new station association callback/notification */
228 	void			(*ic_newassoc)(struct ieee80211_node *, int);
229 	/* node state management */
230 	struct ieee80211_node*	(*ic_node_alloc)(struct ieee80211vap *,
231 				    const uint8_t [IEEE80211_ADDR_LEN]);
232 	void			(*ic_node_free)(struct ieee80211_node *);
233 	void			(*ic_node_cleanup)(struct ieee80211_node *);
234 	void			(*ic_node_age)(struct ieee80211_node *);
235 	void			(*ic_node_drain)(struct ieee80211_node *);
236 	int8_t			(*ic_node_getrssi)(const struct ieee80211_node*);
237 	void			(*ic_node_getsignal)(const struct ieee80211_node*,
238 				    int8_t *, int8_t *);
239 	void			(*ic_node_getmimoinfo)(
240 				    const struct ieee80211_node*,
241 				    struct ieee80211_mimo_info *);
242 	/* scanning support */
243 	void			(*ic_scan_start)(struct ieee80211com *);
244 	void			(*ic_scan_end)(struct ieee80211com *);
245 	void			(*ic_set_channel)(struct ieee80211com *);
246 	void			(*ic_scan_curchan)(struct ieee80211_scan_state *,
247 				    unsigned long);
248 	void			(*ic_scan_mindwell)(struct ieee80211_scan_state *);
249 
250 	/*
251 	 * 802.11n ADDBA support.  A simple/generic implementation
252 	 * of A-MPDU tx aggregation is provided; the driver may
253 	 * override these methods to provide their own support.
254 	 * A-MPDU rx re-ordering happens automatically if the
255 	 * driver passes out-of-order frames to ieee80211_input
256 	 * from an assocated HT station.
257 	 */
258 	void			(*ic_recv_action)(struct ieee80211_node *,
259 				    const uint8_t *frm, const uint8_t *efrm);
260 	int			(*ic_send_action)(struct ieee80211_node *,
261 				    int category, int action,
262 				    uint16_t args[4]);
263 	/* check if A-MPDU should be enabled this station+ac */
264 	int			(*ic_ampdu_enable)(struct ieee80211_node *,
265 				    struct ieee80211_tx_ampdu *);
266 	/* start/stop doing A-MPDU tx aggregation for a station */
267 	int			(*ic_addba_request)(struct ieee80211_node *,
268 				    struct ieee80211_tx_ampdu *,
269 				    int dialogtoken, int baparamset,
270 				    int batimeout);
271 	int			(*ic_addba_response)(struct ieee80211_node *,
272 				    struct ieee80211_tx_ampdu *,
273 				    int status, int baparamset, int batimeout);
274 	void			(*ic_addba_stop)(struct ieee80211_node *,
275 				    struct ieee80211_tx_ampdu *);
276 	/* BAR response received */
277 	void			(*ic_bar_response)(struct ieee80211_node *,
278 				    struct ieee80211_tx_ampdu *, int status);
279 };
280 
281 struct ieee80211_aclator;
282 
283 struct ieee80211vap {
284 	struct ifmedia		iv_media;	/* interface media config */
285 	struct ifnet		*iv_ifp;	/* associated device */
286 	struct bpf_if		*iv_rawbpf;	/* packet filter structure */
287 	struct sysctl_ctx_list	*iv_sysctl;	/* dynamic sysctl context */
288 	struct sysctl_oid	*iv_oid;	/* net.wlan.X sysctl oid */
289 
290 	TAILQ_ENTRY(ieee80211vap) iv_next;	/* list of vap instances */
291 	struct ieee80211com	*iv_ic;		/* back ptr to common state */
292 	uint32_t		iv_debug;	/* debug msg flags */
293 	struct ieee80211_stats	iv_stats;	/* statistics */
294 
295 	uint8_t			iv_myaddr[IEEE80211_ADDR_LEN];
296 	uint32_t		iv_flags;	/* state flags */
297 	uint32_t		iv_flags_ext;	/* extended state flags */
298 	uint32_t		iv_flags_ven;	/* vendor state flags */
299 	uint32_t		iv_caps;	/* capabilities */
300 	uint32_t		iv_htcaps;	/* HT capabilities */
301 	enum ieee80211_opmode	iv_opmode;	/* operation mode */
302 	enum ieee80211_state	iv_state;	/* state machine state */
303 	void			(*iv_newstate_cb)(struct ieee80211vap *,
304 				    enum ieee80211_state, int);
305 	struct callout		iv_mgtsend;	/* mgmt frame response timer */
306 						/* inactivity timer settings */
307 	int			iv_inact_init;	/* setting for new station */
308 	int			iv_inact_auth;	/* auth but not assoc setting */
309 	int			iv_inact_run;	/* authorized setting */
310 	int			iv_inact_probe;	/* inactive probe time */
311 
312 	int			iv_des_nssid;	/* # desired ssids */
313 	struct ieee80211_scan_ssid iv_des_ssid[1];/* desired ssid table */
314 	uint8_t			iv_des_bssid[IEEE80211_ADDR_LEN];
315 	struct ieee80211_channel *iv_des_chan;	/* desired channel */
316 	uint16_t		iv_des_mode;	/* desired mode */
317 	int			iv_nicknamelen;	/* XXX junk */
318 	uint8_t			iv_nickname[IEEE80211_NWID_LEN];
319 	u_int			iv_bgscanidle;	/* bg scan idle threshold */
320 	u_int			iv_bgscanintvl;	/* bg scan min interval */
321 	u_int			iv_scanvalid;	/* scan cache valid threshold */
322 	u_int			iv_scanreq_duration;
323 	u_int			iv_scanreq_mindwell;
324 	u_int			iv_scanreq_maxdwell;
325 	uint16_t		iv_scanreq_flags;/* held scan request params */
326 	uint8_t			iv_scanreq_nssid;
327 	struct ieee80211_scan_ssid iv_scanreq_ssid[IEEE80211_SCAN_MAX_SSID];
328 	/* sta-mode roaming state */
329 	enum ieee80211_roamingmode iv_roaming;	/* roaming mode */
330 	struct ieee80211_roamparam iv_roamparms[IEEE80211_MODE_MAX];
331 
332 	uint8_t			iv_bmissthreshold;
333 	uint8_t			iv_bmiss_count;	/* current beacon miss count */
334 	int			iv_bmiss_max;	/* max bmiss before scan */
335 	uint16_t		iv_swbmiss_count;/* beacons in last period */
336 	uint16_t		iv_swbmiss_period;/* s/w bmiss period */
337 	struct callout		iv_swbmiss;	/* s/w beacon miss timer */
338 
339 	int			iv_ampdu_rxmax;	/* A-MPDU rx limit (bytes) */
340 	int			iv_ampdu_density;/* A-MPDU density */
341 	int			iv_ampdu_limit;	/* A-MPDU tx limit (bytes) */
342 	int			iv_amsdu_limit;	/* A-MSDU tx limit (bytes) */
343 	u_int			iv_ampdu_mintraffic[WME_NUM_AC];
344 
345 	uint32_t		*iv_aid_bitmap;	/* association id map */
346 	uint16_t		iv_max_aid;
347 	uint16_t		iv_sta_assoc;	/* stations associated */
348 	uint16_t		iv_ps_sta;	/* stations in power save */
349 	uint16_t		iv_ps_pending;	/* ps sta's w/ pending frames */
350 	uint16_t		iv_txseq;	/* mcast xmit seq# space */
351 	uint16_t		iv_tim_len;	/* ic_tim_bitmap size (bytes) */
352 	uint8_t			*iv_tim_bitmap;	/* power-save stations w/ data*/
353 	uint8_t			iv_dtim_period;	/* DTIM period */
354 	uint8_t			iv_dtim_count;	/* DTIM count from last bcn */
355 						/* set/unset aid pwrsav state */
356 	int			iv_csa_count;	/* count for doing CSA */
357 
358 	struct ieee80211_node	*iv_bss;	/* information for this node */
359 	struct ieee80211_txparam iv_txparms[IEEE80211_MODE_MAX];
360 	uint16_t		iv_rtsthreshold;
361 	uint16_t		iv_fragthreshold;
362 	int			iv_inact_timer;	/* inactivity timer wait */
363 	/* application-specified IE's to attach to mgt frames */
364 	struct ieee80211_appie	*iv_appie_beacon;
365 	struct ieee80211_appie	*iv_appie_probereq;
366 	struct ieee80211_appie	*iv_appie_proberesp;
367 	struct ieee80211_appie	*iv_appie_assocreq;
368 	struct ieee80211_appie	*iv_appie_assocresp;
369 	struct ieee80211_appie	*iv_appie_wpa;
370 	uint8_t			*iv_wpa_ie;
371 	uint8_t			*iv_rsn_ie;
372 	uint16_t		iv_max_keyix;	/* max h/w key index */
373 	ieee80211_keyix		iv_def_txkey;	/* default/group tx key index */
374 	struct ieee80211_key	iv_nw_keys[IEEE80211_WEP_NKID];
375 	int			(*iv_key_alloc)(struct ieee80211vap *,
376 				    struct ieee80211_key *,
377 				    ieee80211_keyix *, ieee80211_keyix *);
378 	int			(*iv_key_delete)(struct ieee80211vap *,
379 				    const struct ieee80211_key *);
380 	int			(*iv_key_set)(struct ieee80211vap *,
381 				    const struct ieee80211_key *,
382 				    const uint8_t mac[IEEE80211_ADDR_LEN]);
383 	void			(*iv_key_update_begin)(struct ieee80211vap *);
384 	void			(*iv_key_update_end)(struct ieee80211vap *);
385 
386 	const struct ieee80211_authenticator *iv_auth; /* authenticator glue */
387 	void			*iv_ec;		/* private auth state */
388 
389 	const struct ieee80211_aclator *iv_acl;	/* acl glue */
390 	void			*iv_as;		/* private aclator state */
391 
392 	/* operate-mode detach hook */
393 	void			(*iv_opdetach)(struct ieee80211vap *);
394 	/* receive processing */
395 	int			(*iv_input)(struct ieee80211_node *,
396 				    struct mbuf *, int rssi, int noise,
397 				    uint32_t rstamp);
398 	void			(*iv_recv_mgmt)(struct ieee80211_node *,
399 				    struct mbuf *, int, int, int, uint32_t);
400 	void			(*iv_deliver_data)(struct ieee80211vap *,
401 				    struct ieee80211_node *, struct mbuf *);
402 #if 0
403 	/* send processing */
404 	int			(*iv_send_mgmt)(struct ieee80211_node *,
405 				     int, int);
406 #endif
407 	/* beacon miss processing */
408 	void			(*iv_bmiss)(struct ieee80211vap *);
409 	/* reset device state after 802.11 parameter/state change */
410 	int			(*iv_reset)(struct ieee80211vap *, u_long);
411 	/* [schedule] beacon frame update */
412 	void			(*iv_update_beacon)(struct ieee80211vap *, int);
413 	/* power save handling */
414 	void			(*iv_update_ps)(struct ieee80211vap *, int);
415 	int			(*iv_set_tim)(struct ieee80211_node *, int);
416 	/* state machine processing */
417 	int			(*iv_newstate)(struct ieee80211vap *,
418 				    enum ieee80211_state, int);
419 	/* 802.3 output method for raw frame xmit */
420 	int			(*iv_output)(struct ifnet *, struct mbuf *,
421 				    struct sockaddr *, struct rtentry *);
422 };
423 MALLOC_DECLARE(M_80211_VAP);
424 
425 #define	IEEE80211_ADDR_EQ(a1,a2)	(memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
426 #define	IEEE80211_ADDR_COPY(dst,src)	memcpy(dst,src,IEEE80211_ADDR_LEN)
427 
428 /* ic_flags/iv_flags */
429 #define	IEEE80211_F_TURBOP	0x00000001	/* CONF: ATH Turbo enabled*/
430 #define	IEEE80211_F_COMP	0x00000002	/* CONF: ATH comp enabled */
431 #define	IEEE80211_F_FF		0x00000004	/* CONF: ATH FF enabled */
432 #define	IEEE80211_F_BURST	0x00000008	/* CONF: bursting enabled */
433 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
434 #define	IEEE80211_F_PRIVACY	0x00000010	/* CONF: privacy enabled */
435 #define	IEEE80211_F_PUREG	0x00000020	/* CONF: 11g w/o 11b sta's */
436 #define	IEEE80211_F_SCAN	0x00000080	/* STATUS: scanning */
437 #define	IEEE80211_F_ASCAN	0x00000100	/* STATUS: active scan */
438 #define	IEEE80211_F_SIBSS	0x00000200	/* STATUS: start IBSS */
439 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
440 #define	IEEE80211_F_SHSLOT	0x00000400	/* STATUS: use short slot time*/
441 #define	IEEE80211_F_PMGTON	0x00000800	/* CONF: Power mgmt enable */
442 #define	IEEE80211_F_DESBSSID	0x00001000	/* CONF: des_bssid is set */
443 #define	IEEE80211_F_WME		0x00002000	/* CONF: enable WME use */
444 #define	IEEE80211_F_BGSCAN	0x00004000	/* CONF: bg scan enabled (???)*/
445 #define	IEEE80211_F_SWRETRY	0x00008000	/* CONF: sw tx retry enabled */
446 #define IEEE80211_F_TXPOW_FIXED	0x00010000	/* TX Power: fixed rate */
447 #define	IEEE80211_F_IBSSON	0x00020000	/* CONF: IBSS creation enable */
448 #define	IEEE80211_F_SHPREAMBLE	0x00040000	/* STATUS: use short preamble */
449 #define	IEEE80211_F_DATAPAD	0x00080000	/* CONF: do alignment pad */
450 #define	IEEE80211_F_USEPROT	0x00100000	/* STATUS: protection enabled */
451 #define	IEEE80211_F_USEBARKER	0x00200000	/* STATUS: use barker preamble*/
452 #define	IEEE80211_F_CSAPENDING	0x00400000	/* STATUS: chan switch pending*/
453 #define	IEEE80211_F_WPA1	0x00800000	/* CONF: WPA enabled */
454 #define	IEEE80211_F_WPA2	0x01000000	/* CONF: WPA2 enabled */
455 #define	IEEE80211_F_WPA		0x01800000	/* CONF: WPA/WPA2 enabled */
456 #define	IEEE80211_F_DROPUNENC	0x02000000	/* CONF: drop unencrypted */
457 #define	IEEE80211_F_COUNTERM	0x04000000	/* CONF: TKIP countermeasures */
458 #define	IEEE80211_F_HIDESSID	0x08000000	/* CONF: hide SSID in beacon */
459 #define	IEEE80211_F_NOBRIDGE	0x10000000	/* CONF: dis. internal bridge */
460 #define	IEEE80211_F_PCF		0x20000000	/* CONF: PCF enabled */
461 #define	IEEE80211_F_DOTH	0x40000000	/* CONF: 11h enabled */
462 #define	IEEE80211_F_DWDS	0x80000000	/* CONF: Dynamic WDS enabled */
463 
464 /* Atheros protocol-specific flags */
465 #define	IEEE80211_F_ATHEROS \
466 	(IEEE80211_F_FF | IEEE80211_F_COMP | IEEE80211_F_TURBOP)
467 /* Check if an Atheros capability was negotiated for use */
468 #define	IEEE80211_ATH_CAP(vap, ni, bit) \
469 	((vap)->iv_flags & (ni)->ni_ath_flags & (bit))
470 
471 /* ic_flags_ext/iv_flags_ext */
472 #define	IEEE80211_FEXT_NONHT_PR	 0x00000001	/* STATUS: non-HT sta present */
473 #define	IEEE80211_FEXT_INACT	 0x00000002	/* CONF: sta inact handling */
474 #define	IEEE80211_FEXT_SCANWAIT	 0x00000004	/* STATUS: awaiting scan */
475 /* 0x00000006 reserved */
476 #define	IEEE80211_FEXT_BGSCAN	 0x00000008	/* STATUS: complete bgscan */
477 #define	IEEE80211_FEXT_WPS	 0x00000010	/* CONF: WPS enabled */
478 #define	IEEE80211_FEXT_TSN 	 0x00000020	/* CONF: TSN enabled */
479 #define	IEEE80211_FEXT_SCANREQ	 0x00000040	/* STATUS: scan req params */
480 #define	IEEE80211_FEXT_RESUME	 0x00000080	/* STATUS: start on resume */
481 #define	IEEE80211_FEXT_NONERP_PR 0x00000200	/* STATUS: non-ERP sta present*/
482 #define	IEEE80211_FEXT_SWBMISS	 0x00000400	/* CONF: do bmiss in s/w */
483 #define	IEEE80211_FEXT_DFS	 0x00000800	/* CONF: DFS enabled */
484 #define	IEEE80211_FEXT_DOTD	 0x00001000	/* CONF: 11d enabled */
485 /* NB: immutable: should be set only when creating a vap */
486 #define	IEEE80211_FEXT_WDSLEGACY 0x00010000	/* CONF: legacy WDS operation */
487 #define	IEEE80211_FEXT_PROBECHAN 0x00020000	/* CONF: probe passive channel*/
488 #define	IEEE80211_FEXT_HT	 0x00080000	/* CONF: HT supported */
489 #define	IEEE80211_FEXT_AMPDU_TX	 0x00100000	/* CONF: A-MPDU tx supported */
490 #define	IEEE80211_FEXT_AMPDU_RX	 0x00200000	/* CONF: A-MPDU tx supported */
491 #define	IEEE80211_FEXT_AMSDU_TX	 0x00400000	/* CONF: A-MSDU tx supported */
492 #define	IEEE80211_FEXT_AMSDU_RX	 0x00800000	/* CONF: A-MSDU tx supported */
493 #define	IEEE80211_FEXT_USEHT40	 0x01000000	/* CONF: 20/40 use enabled */
494 #define	IEEE80211_FEXT_PUREN	 0x02000000	/* CONF: 11n w/o legacy sta's */
495 #define	IEEE80211_FEXT_SHORTGI20 0x04000000	/* CONF: short GI in HT20 */
496 #define	IEEE80211_FEXT_SHORTGI40 0x08000000	/* CONF: short GI in HT40 */
497 #define	IEEE80211_FEXT_HTCOMPAT  0x10000000	/* CONF: HT vendor OUI's */
498 #define	IEEE80211_FEXT_RIFS  	 0x20000000	/* CONF: RIFS enabled */
499 
500 /* ic_caps/iv_caps: device driver capabilities */
501 /* 0x2f available */
502 #define	IEEE80211_C_STA		0x00000001	/* CAPABILITY: STA available */
503 #define	IEEE80211_C_FF		0x00000040	/* CAPABILITY: ATH FF avail */
504 #define	IEEE80211_C_TURBOP	0x00000080	/* CAPABILITY: ATH Turbo avail*/
505 #define	IEEE80211_C_IBSS	0x00000100	/* CAPABILITY: IBSS available */
506 #define	IEEE80211_C_PMGT	0x00000200	/* CAPABILITY: Power mgmt */
507 #define	IEEE80211_C_HOSTAP	0x00000400	/* CAPABILITY: HOSTAP avail */
508 #define	IEEE80211_C_AHDEMO	0x00000800	/* CAPABILITY: Old Adhoc Demo */
509 #define	IEEE80211_C_SWRETRY	0x00001000	/* CAPABILITY: sw tx retry */
510 #define	IEEE80211_C_TXPMGT	0x00002000	/* CAPABILITY: tx power mgmt */
511 #define	IEEE80211_C_SHSLOT	0x00004000	/* CAPABILITY: short slottime */
512 #define	IEEE80211_C_SHPREAMBLE	0x00008000	/* CAPABILITY: short preamble */
513 #define	IEEE80211_C_MONITOR	0x00010000	/* CAPABILITY: monitor mode */
514 #define	IEEE80211_C_DFS		0x00020000	/* CAPABILITY: DFS/radar avail*/
515 /* 0x7c0000 available */
516 #define	IEEE80211_C_WPA1	0x00800000	/* CAPABILITY: WPA1 avail */
517 #define	IEEE80211_C_WPA2	0x01000000	/* CAPABILITY: WPA2 avail */
518 #define	IEEE80211_C_WPA		0x01800000	/* CAPABILITY: WPA1+WPA2 avail*/
519 #define	IEEE80211_C_BURST	0x02000000	/* CAPABILITY: frame bursting */
520 #define	IEEE80211_C_WME		0x04000000	/* CAPABILITY: WME avail */
521 #define	IEEE80211_C_WDS		0x08000000	/* CAPABILITY: 4-addr support */
522 /* 0x10000000 reserved */
523 #define	IEEE80211_C_BGSCAN	0x20000000	/* CAPABILITY: bg scanning */
524 #define	IEEE80211_C_TXFRAG	0x40000000	/* CAPABILITY: tx fragments */
525 /* XXX protection/barker? */
526 
527 #define	IEEE80211_C_OPMODE \
528 	(IEEE80211_C_STA | IEEE80211_C_IBSS | IEEE80211_C_HOSTAP | \
529 	 IEEE80211_C_AHDEMO | IEEE80211_C_MONITOR | IEEE80211_C_WDS)
530 
531 /*
532  * ic_htcaps/iv_htcaps: HT-specific device/driver capabilities
533  *
534  * NB: the low 16-bits are the 802.11 definitions, the upper
535  *     16-bits are used to define s/w/driver capabilities.
536  */
537 #define	IEEE80211_HTC_AMPDU	0x00010000	/* CAPABILITY: A-MPDU tx */
538 #define	IEEE80211_HTC_AMSDU	0x00020000	/* CAPABILITY: A-MSDU tx */
539 /* NB: HT40 is implied by IEEE80211_HTCAP_CHWIDTH40 */
540 #define	IEEE80211_HTC_HT	0x00040000	/* CAPABILITY: HT operation */
541 #define	IEEE80211_HTC_SMPS	0x00080000	/* CAPABILITY: MIMO power save*/
542 #define	IEEE80211_HTC_RIFS	0x00100000	/* CAPABILITY: RIFS support */
543 
544 void	ieee80211_ifattach(struct ieee80211com *);
545 void	ieee80211_ifdetach(struct ieee80211com *);
546 int	ieee80211_vap_setup(struct ieee80211com *, struct ieee80211vap *,
547 		const char name[IFNAMSIZ], int unit, int opmode, int flags,
548 		const uint8_t bssid[IEEE80211_ADDR_LEN],
549 		const uint8_t macaddr[IEEE80211_ADDR_LEN]);
550 int	ieee80211_vap_attach(struct ieee80211vap *,
551 		ifm_change_cb_t, ifm_stat_cb_t);
552 void	ieee80211_vap_detach(struct ieee80211vap *);
553 const struct ieee80211_rateset *ieee80211_get_suprates(struct ieee80211com *ic,
554 		const struct ieee80211_channel *);
555 void	ieee80211_announce(struct ieee80211com *);
556 void	ieee80211_announce_channels(struct ieee80211com *);
557 void	ieee80211_drain(struct ieee80211com *);
558 void	ieee80211_media_init(struct ieee80211com *);
559 struct ieee80211com *ieee80211_find_vap(const uint8_t mac[IEEE80211_ADDR_LEN]);
560 int	ieee80211_media_change(struct ifnet *);
561 void	ieee80211_media_status(struct ifnet *, struct ifmediareq *);
562 int	ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
563 int	ieee80211_rate2media(struct ieee80211com *, int,
564 		enum ieee80211_phymode);
565 int	ieee80211_media2rate(int);
566 int	ieee80211_mhz2ieee(u_int, u_int);
567 int	ieee80211_chan2ieee(struct ieee80211com *,
568 		const struct ieee80211_channel *);
569 u_int	ieee80211_ieee2mhz(u_int, u_int);
570 struct ieee80211_channel *ieee80211_find_channel(struct ieee80211com *,
571 		int freq, int flags);
572 struct ieee80211_channel *ieee80211_find_channel_byieee(struct ieee80211com *,
573 		int ieee, int flags);
574 int	ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
575 enum ieee80211_phymode ieee80211_chan2mode(const struct ieee80211_channel *);
576 
577 /*
578  * Key update synchronization methods.  XXX should not be visible.
579  */
580 static __inline void
581 ieee80211_key_update_begin(struct ieee80211vap *vap)
582 {
583 	vap->iv_key_update_begin(vap);
584 }
585 static __inline void
586 ieee80211_key_update_end(struct ieee80211vap *vap)
587 {
588 	vap->iv_key_update_end(vap);
589 }
590 
591 /*
592  * XXX these need to be here for IEEE80211_F_DATAPAD
593  */
594 
595 /*
596  * Return the space occupied by the 802.11 header and any
597  * padding required by the driver.  This works for a
598  * management or data frame.
599  */
600 static __inline int
601 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
602 {
603 	int size = ieee80211_hdrsize(data);
604 	if (ic->ic_flags & IEEE80211_F_DATAPAD)
605 		size = roundup(size, sizeof(uint32_t));
606 	return size;
607 }
608 
609 /*
610  * Like ieee80211_hdrspace, but handles any type of frame.
611  */
612 static __inline int
613 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
614 {
615 	int size = ieee80211_anyhdrsize(data);
616 	if (ic->ic_flags & IEEE80211_F_DATAPAD)
617 		size = roundup(size, sizeof(uint32_t));
618 	return size;
619 }
620 
621 /*
622  * Notify a vap that beacon state has been updated.
623  */
624 static __inline void
625 ieee80211_beacon_notify(struct ieee80211vap *vap, int what)
626 {
627 	if (vap->iv_state == IEEE80211_S_RUN)
628 		vap->iv_update_beacon(vap, what);
629 }
630 
631 /*
632  * Calculate HT channel promotion flags for a channel.
633  * XXX belongs in ieee80211_ht.h but needs IEEE80211_FEXT_*
634  */
635 static __inline int
636 ieee80211_htchanflags(const struct ieee80211_channel *c)
637 {
638 	return IEEE80211_IS_CHAN_HT40(c) ?
639 	    IEEE80211_FEXT_HT | IEEE80211_FEXT_USEHT40 :
640 	    IEEE80211_IS_CHAN_HT(c) ?  IEEE80211_FEXT_HT : 0;
641 }
642 
643 /*
644  * Debugging facilities compiled in when IEEE80211_DEBUG is defined.
645  *
646  * The intent is that any problem in the net80211 layer can be
647  * diagnosed by inspecting the statistics (dumped by the wlanstats
648  * program) and/or the msgs generated by net80211.  Messages are
649  * broken into functional classes and can be controlled with the
650  * wlandebug program.  Certain of these msg groups are for facilities
651  * that are no longer part of net80211 (e.g. IEEE80211_MSG_DOT1X).
652  */
653 #define	IEEE80211_MSG_11N	0x80000000	/* 11n mode debug */
654 #define	IEEE80211_MSG_DEBUG	0x40000000	/* IFF_DEBUG equivalent */
655 #define	IEEE80211_MSG_DUMPPKTS	0x20000000	/* IFF_LINK2 equivalant */
656 #define	IEEE80211_MSG_CRYPTO	0x10000000	/* crypto work */
657 #define	IEEE80211_MSG_INPUT	0x08000000	/* input handling */
658 #define	IEEE80211_MSG_XRATE	0x04000000	/* rate set handling */
659 #define	IEEE80211_MSG_ELEMID	0x02000000	/* element id parsing */
660 #define	IEEE80211_MSG_NODE	0x01000000	/* node handling */
661 #define	IEEE80211_MSG_ASSOC	0x00800000	/* association handling */
662 #define	IEEE80211_MSG_AUTH	0x00400000	/* authentication handling */
663 #define	IEEE80211_MSG_SCAN	0x00200000	/* scanning */
664 #define	IEEE80211_MSG_OUTPUT	0x00100000	/* output handling */
665 #define	IEEE80211_MSG_STATE	0x00080000	/* state machine */
666 #define	IEEE80211_MSG_POWER	0x00040000	/* power save handling */
667 #define	IEEE80211_MSG_DOT1X	0x00020000	/* 802.1x authenticator */
668 #define	IEEE80211_MSG_DOT1XSM	0x00010000	/* 802.1x state machine */
669 #define	IEEE80211_MSG_RADIUS	0x00008000	/* 802.1x radius client */
670 #define	IEEE80211_MSG_RADDUMP	0x00004000	/* dump 802.1x radius packets */
671 #define	IEEE80211_MSG_RADKEYS	0x00002000	/* dump 802.1x keys */
672 #define	IEEE80211_MSG_WPA	0x00001000	/* WPA/RSN protocol */
673 #define	IEEE80211_MSG_ACL	0x00000800	/* ACL handling */
674 #define	IEEE80211_MSG_WME	0x00000400	/* WME protocol */
675 #define	IEEE80211_MSG_SUPERG	0x00000200	/* Atheros SuperG protocol */
676 #define	IEEE80211_MSG_DOTH	0x00000100	/* 802.11h support */
677 #define	IEEE80211_MSG_INACT	0x00000080	/* inactivity handling */
678 #define	IEEE80211_MSG_ROAM	0x00000040	/* sta-mode roaming */
679 #define	IEEE80211_MSG_RATECTL	0x00000020	/* tx rate control */
680 #define	IEEE80211_MSG_ACTION	0x00000010	/* action frame handling */
681 #define	IEEE80211_MSG_WDS	0x00000008	/* WDS handling */
682 #define	IEEE80211_MSG_IOCTL	0x00000004	/* ioctl handling */
683 
684 #define	IEEE80211_MSG_ANY	0xffffffff	/* anything */
685 
686 #ifdef IEEE80211_DEBUG
687 #define	ieee80211_msg(_vap, _m)	((_vap)->iv_debug & (_m))
688 #define	IEEE80211_DPRINTF(_vap, _m, _fmt, ...) do {			\
689 	if (ieee80211_msg(_vap, _m))					\
690 		ieee80211_note(_vap, _fmt, __VA_ARGS__);		\
691 } while (0)
692 #define	IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...) do {			\
693 	if (ieee80211_msg(_vap, _m))					\
694 		ieee80211_note_mac(_vap, (_ni)->ni_macaddr, _fmt, __VA_ARGS__);\
695 } while (0)
696 #define	IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...) do {		\
697 	if (ieee80211_msg(_vap, _m))					\
698 		ieee80211_note_mac(_vap, _mac, _fmt, __VA_ARGS__);	\
699 } while (0)
700 #define	IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...) do {		\
701 	if (ieee80211_msg(_vap, _m))					\
702 		ieee80211_note_frame(_vap, _wh, _fmt, __VA_ARGS__);	\
703 } while (0)
704 void	ieee80211_note(struct ieee80211vap *, const char *, ...);
705 void	ieee80211_note_mac(struct ieee80211vap *,
706 		const uint8_t mac[IEEE80211_ADDR_LEN], const char *, ...);
707 void	ieee80211_note_frame(struct ieee80211vap *,
708 		const struct ieee80211_frame *, const char *, ...);
709 #define	ieee80211_msg_debug(_vap) \
710 	((_vap)->iv_debug & IEEE80211_MSG_DEBUG)
711 #define	ieee80211_msg_dumppkts(_vap) \
712 	((_vap)->iv_debug & IEEE80211_MSG_DUMPPKTS)
713 #define	ieee80211_msg_input(_vap) \
714 	((_vap)->iv_debug & IEEE80211_MSG_INPUT)
715 #define	ieee80211_msg_radius(_vap) \
716 	((_vap)->iv_debug & IEEE80211_MSG_RADIUS)
717 #define	ieee80211_msg_dumpradius(_vap) \
718 	((_vap)->iv_debug & IEEE80211_MSG_RADDUMP)
719 #define	ieee80211_msg_dumpradkeys(_vap) \
720 	((_vap)->iv_debug & IEEE80211_MSG_RADKEYS)
721 #define	ieee80211_msg_scan(_vap) \
722 	((_vap)->iv_debug & IEEE80211_MSG_SCAN)
723 #define	ieee80211_msg_assoc(_vap) \
724 	((_vap)->iv_debug & IEEE80211_MSG_ASSOC)
725 
726 /*
727  * Emit a debug message about discarding a frame or information
728  * element.  One format is for extracting the mac address from
729  * the frame header; the other is for when a header is not
730  * available or otherwise appropriate.
731  */
732 #define	IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...) do {		\
733 	if ((_vap)->iv_debug & (_m))					\
734 		ieee80211_discard_frame(_vap, _wh, _type, _fmt, __VA_ARGS__);\
735 } while (0)
736 #define	IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...) do {	\
737 	if ((_vap)->iv_debug & (_m))					\
738 		ieee80211_discard_ie(_vap, _wh, _type, _fmt, __VA_ARGS__);\
739 } while (0)
740 #define	IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...) do {	\
741 	if ((_vap)->iv_debug & (_m))					\
742 		ieee80211_discard_mac(_vap, _mac, _type, _fmt, __VA_ARGS__);\
743 } while (0)
744 
745 void ieee80211_discard_frame(struct ieee80211vap *,
746 	const struct ieee80211_frame *, const char *type, const char *fmt, ...);
747 void ieee80211_discard_ie(struct ieee80211vap *,
748 	const struct ieee80211_frame *, const char *type, const char *fmt, ...);
749 void ieee80211_discard_mac(struct ieee80211vap *,
750 	const uint8_t mac[IEEE80211_ADDR_LEN], const char *type,
751 	const char *fmt, ...);
752 #else
753 #define	IEEE80211_DPRINTF(_vap, _m, _fmt, ...)
754 #define	IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...)
755 #define	IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...)
756 #define	IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...)
757 #define	ieee80211_msg_dumppkts(_vap)	0
758 #define	ieee80211_msg(_vap, _m)		0
759 
760 #define	IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...)
761 #define	IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...)
762 #define	IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...)
763 #endif
764 
765 #endif /* _NET80211_IEEE80211_VAR_H_ */
766