2 * Copyright (c) 2001 Atsushi Onoe
3 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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.
28 #ifndef _NET80211_IEEE80211_VAR_H_
29 #define _NET80211_IEEE80211_VAR_H_
32 * Definitions for IEEE 802.11 drivers.
34 /* NB: portability glue must go first */
36 #include <net80211/ieee80211_netbsd.h>
38 #include <net80211/ieee80211_freebsd.h>
40 #include <net80211/ieee80211_linux.h>
42 #error "No support for your operating system!"
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_phy.h>
51 #include <net80211/ieee80211_power.h>
52 #include <net80211/ieee80211_node.h>
53 #include <net80211/ieee80211_proto.h>
54 #include <net80211/ieee80211_scan.h>
56 #define IEEE80211_TXPOWER_MAX 100 /* .5 dbM (XXX units?) */
57 #define IEEE80211_TXPOWER_MIN 0 /* kill radio */
59 #define IEEE80211_DTIM_DEFAULT 1 /* default DTIM period */
60 #define IEEE80211_BINTVAL_DEFAULT 100 /* default beacon interval (TU's) */
62 #define IEEE80211_BMISS_MAX 2 /* maximum consecutive bmiss allowed */
63 #define IEEE80211_HWBMISS_DEFAULT 7 /* h/w bmiss threshold (beacons) */
65 #define IEEE80211_BGSCAN_INTVAL_MIN 15 /* min bg scan intvl (secs) */
66 #define IEEE80211_BGSCAN_INTVAL_DEFAULT (5*60) /* default bg scan intvl */
68 #define IEEE80211_BGSCAN_IDLE_MIN 100 /* min idle time (ms) */
69 #define IEEE80211_BGSCAN_IDLE_DEFAULT 250 /* default idle time (ms) */
71 #define IEEE80211_SCAN_VALID_MIN 10 /* min scan valid time (secs) */
72 #define IEEE80211_SCAN_VALID_DEFAULT 60 /* default scan valid time */
74 #define IEEE80211_PS_SLEEP 0x1 /* STA is in power saving mode */
75 #define IEEE80211_PS_MAX_QUEUE 50 /* maximum saved packets */
77 #define IEEE80211_FIXED_RATE_NONE 0xff
78 #define IEEE80211_TXMAX_DEFAULT 6 /* default ucast max retries */
80 #define IEEE80211_RTS_DEFAULT IEEE80211_RTS_MAX
81 #define IEEE80211_FRAG_DEFAULT IEEE80211_FRAG_MAX
83 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
84 #define IEEE80211_TU_TO_MS(x) (((x) * 1024) / 1000)
85 #define IEEE80211_TU_TO_TICKS(x)(((x) * 1024 * hz) / (1000 * 1000))
88 * 802.11 control state is split into a common portion that maps
89 * 1-1 to a physical device and one or more "Virtual AP's" (VAP)
90 * that are bound to an ieee80211com instance and share a single
91 * underlying device. Each VAP has a corresponding OS device
92 * entity through which traffic flows and that applications use
93 * for issuing ioctls, etc.
97 * Data common to one or more virtual AP's. State shared by
98 * the underlying device and the net80211 layer is exposed here;
99 * e.g. device-specific callbacks.
102 typedef void (*ieee80211vap_attach)(struct ieee80211vap *);
104 struct ieee80211_appie {
105 uint16_t ie_len; /* size of ie_data */
106 uint8_t ie_data[]; /* user-specified IE's */
109 struct ieee80211_tdma_param;
110 struct ieee80211_rate_table;
111 struct ieee80211_tx_ampdu;
112 struct ieee80211_rx_ampdu;
113 struct ieee80211_superg;
115 struct ieee80211com {
116 struct ifnet *ic_ifp; /* associated device */
117 ieee80211_com_lock_t ic_comlock; /* state update lock */
118 TAILQ_HEAD(, ieee80211vap) ic_vaps; /* list of vap instances */
119 int ic_headroom; /* driver tx headroom needs */
120 enum ieee80211_phytype ic_phytype; /* XXX wrong for multi-mode */
121 enum ieee80211_opmode ic_opmode; /* operation mode */
122 struct ifmedia ic_media; /* interface media config */
123 struct callout ic_inact; /* inactivity processing */
124 struct taskqueue *ic_tq; /* deferred state thread */
125 struct task ic_parent_task; /* deferred parent processing */
126 struct task ic_promisc_task;/* deferred promisc update */
127 struct task ic_mcast_task; /* deferred mcast update */
128 struct task ic_chan_task; /* deferred channel change */
129 struct task ic_bmiss_task; /* deferred beacon miss hndlr */
131 uint32_t ic_flags; /* state flags */
132 uint32_t ic_flags_ext; /* extended state flags */
133 uint32_t ic_flags_ven; /* vendor state flags */
134 uint32_t ic_caps; /* capabilities */
135 uint32_t ic_htcaps; /* HT capabilities */
136 uint32_t ic_cryptocaps; /* crypto capabilities */
137 uint8_t ic_modecaps[2]; /* set of mode capabilities */
138 uint8_t ic_promisc; /* vap's needing promisc mode */
139 uint8_t ic_allmulti; /* vap's needing all multicast*/
140 uint8_t ic_nrunning; /* vap's marked running */
141 uint8_t ic_curmode; /* current mode */
142 uint16_t ic_bintval; /* beacon interval */
143 uint16_t ic_lintval; /* listen interval */
144 uint16_t ic_holdover; /* PM hold over duration */
145 uint16_t ic_txpowlimit; /* global tx power limit */
146 struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
151 * ic_channels is the set of available channels for the device;
152 * it is setup by the driver
153 * ic_nchans is the number of valid entries in ic_channels
154 * ic_chan_avail is a bit vector of these channels used to check
155 * whether a channel is available w/o searching the channel table.
156 * ic_chan_active is a (potentially) constrained subset of
157 * ic_chan_avail that reflects any mode setting or user-specified
158 * limit on the set of channels to use/scan
159 * ic_curchan is the current channel the device is set to; it may
160 * be different from ic_bsschan when we are off-channel scanning
161 * or otherwise doing background work
162 * ic_bsschan is the channel selected for operation; it may
163 * be undefined (IEEE80211_CHAN_ANYC)
164 * ic_prevchan is a cached ``previous channel'' used to optimize
165 * lookups when switching back+forth between two channels
166 * (e.g. for dynamic turbo)
168 int ic_nchans; /* # entries in ic_channels */
169 struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX];
170 uint8_t ic_chan_avail[IEEE80211_CHAN_BYTES];
171 uint8_t ic_chan_active[IEEE80211_CHAN_BYTES];
172 uint8_t ic_chan_scan[IEEE80211_CHAN_BYTES];
173 struct ieee80211_channel *ic_curchan; /* current channel */
174 const struct ieee80211_rate_table *ic_rt; /* table for ic_curchan */
175 struct ieee80211_channel *ic_bsschan; /* bss channel */
176 struct ieee80211_channel *ic_prevchan; /* previous channel */
177 struct ieee80211_regdomain ic_regdomain;/* regulatory data */
178 struct ieee80211_appie *ic_countryie; /* calculated country ie */
179 struct ieee80211_channel *ic_countryie_chan;
181 /* 802.11h/DFS state */
182 struct ieee80211_channel *ic_csa_newchan;/* channel for doing CSA */
183 int ic_csa_count; /* count for doing CSA */
184 struct ieee80211_dfs_state ic_dfs; /* DFS state */
186 struct ieee80211_scan_state *ic_scan; /* scan state */
187 int ic_lastdata; /* time of last data frame */
188 int ic_lastscan; /* time last scan completed */
190 /* NB: this is the union of all vap stations/neighbors */
191 int ic_max_keyix; /* max h/w key index */
192 struct ieee80211_node_table ic_sta; /* stations/neighbors */
194 /* XXX multi-bss: split out common/vap parts */
195 struct ieee80211_wme_state ic_wme; /* WME/WMM state */
197 /* XXX multi-bss: can per-vap be done/make sense? */
198 enum ieee80211_protmode ic_protmode; /* 802.11g protection mode */
199 uint16_t ic_nonerpsta; /* # non-ERP stations */
200 uint16_t ic_longslotsta; /* # long slot time stations */
201 uint16_t ic_sta_assoc; /* stations associated */
202 uint16_t ic_ht_sta_assoc;/* HT stations associated */
203 uint16_t ic_ht40_sta_assoc;/* HT40 stations associated */
204 uint8_t ic_curhtprotmode;/* HTINFO bss state */
205 enum ieee80211_protmode ic_htprotmode; /* HT protection mode */
206 int ic_lastnonerp; /* last time non-ERP sta noted*/
207 int ic_lastnonht; /* last time non-HT sta noted */
209 /* optional state for Atheros SuperG protocol extensions */
210 struct ieee80211_superg *ic_superg;
212 /* virtual ap create/delete */
213 struct ieee80211vap* (*ic_vap_create)(struct ieee80211com *,
214 const char name[IFNAMSIZ], int unit,
215 int opmode, int flags,
216 const uint8_t bssid[IEEE80211_ADDR_LEN],
217 const uint8_t macaddr[IEEE80211_ADDR_LEN]);
218 void (*ic_vap_delete)(struct ieee80211vap *);
219 /* operating mode attachment */
220 ieee80211vap_attach ic_vattach[IEEE80211_OPMODE_MAX];
221 /* return hardware/radio capabilities */
222 void (*ic_getradiocaps)(struct ieee80211com *,
223 int, int *, struct ieee80211_channel []);
224 /* check and/or prepare regdomain state change */
225 int (*ic_setregdomain)(struct ieee80211com *,
226 struct ieee80211_regdomain *,
227 int, struct ieee80211_channel []);
228 /* send/recv 802.11 management frame */
229 int (*ic_send_mgmt)(struct ieee80211_node *,
231 /* send raw 802.11 frame */
232 int (*ic_raw_xmit)(struct ieee80211_node *,
234 const struct ieee80211_bpf_params *);
235 /* update device state for 802.11 slot time change */
236 void (*ic_updateslot)(struct ifnet *);
237 /* handle multicast state changes */
238 void (*ic_update_mcast)(struct ifnet *);
239 /* handle promiscuous mode changes */
240 void (*ic_update_promisc)(struct ifnet *);
241 /* new station association callback/notification */
242 void (*ic_newassoc)(struct ieee80211_node *, int);
243 /* TDMA update notification */
244 void (*ic_tdma_update)(struct ieee80211_node *,
245 const struct ieee80211_tdma_param *, int);
246 /* node state management */
247 struct ieee80211_node* (*ic_node_alloc)(struct ieee80211vap *,
248 const uint8_t [IEEE80211_ADDR_LEN]);
249 void (*ic_node_free)(struct ieee80211_node *);
250 void (*ic_node_cleanup)(struct ieee80211_node *);
251 void (*ic_node_age)(struct ieee80211_node *);
252 void (*ic_node_drain)(struct ieee80211_node *);
253 int8_t (*ic_node_getrssi)(const struct ieee80211_node*);
254 void (*ic_node_getsignal)(const struct ieee80211_node*,
256 void (*ic_node_getmimoinfo)(
257 const struct ieee80211_node*,
258 struct ieee80211_mimo_info *);
259 /* scanning support */
260 void (*ic_scan_start)(struct ieee80211com *);
261 void (*ic_scan_end)(struct ieee80211com *);
262 void (*ic_set_channel)(struct ieee80211com *);
263 void (*ic_scan_curchan)(struct ieee80211_scan_state *,
265 void (*ic_scan_mindwell)(struct ieee80211_scan_state *);
268 * 802.11n ADDBA support. A simple/generic implementation
269 * of A-MPDU tx aggregation is provided; the driver may
270 * override these methods to provide their own support.
271 * A-MPDU rx re-ordering happens automatically if the
272 * driver passes out-of-order frames to ieee80211_input
273 * from an assocated HT station.
275 void (*ic_recv_action)(struct ieee80211_node *,
276 const uint8_t *frm, const uint8_t *efrm);
277 int (*ic_send_action)(struct ieee80211_node *,
278 int category, int action,
280 /* check if A-MPDU should be enabled this station+ac */
281 int (*ic_ampdu_enable)(struct ieee80211_node *,
282 struct ieee80211_tx_ampdu *);
283 /* start/stop doing A-MPDU tx aggregation for a station */
284 int (*ic_addba_request)(struct ieee80211_node *,
285 struct ieee80211_tx_ampdu *,
286 int dialogtoken, int baparamset,
288 int (*ic_addba_response)(struct ieee80211_node *,
289 struct ieee80211_tx_ampdu *,
290 int status, int baparamset, int batimeout);
291 void (*ic_addba_stop)(struct ieee80211_node *,
292 struct ieee80211_tx_ampdu *);
293 /* BAR response received */
294 void (*ic_bar_response)(struct ieee80211_node *,
295 struct ieee80211_tx_ampdu *, int status);
296 /* start/stop doing A-MPDU rx processing for a station */
297 int (*ic_ampdu_rx_start)(struct ieee80211_node *,
298 struct ieee80211_rx_ampdu *, int baparamset,
299 int batimeout, int baseqctl);
300 void (*ic_ampdu_rx_stop)(struct ieee80211_node *,
301 struct ieee80211_rx_ampdu *);
304 struct ieee80211_aclator;
305 struct ieee80211_tdma_state;
307 struct ieee80211vap {
308 struct ifmedia iv_media; /* interface media config */
309 struct ifnet *iv_ifp; /* associated device */
310 struct bpf_if *iv_rawbpf; /* packet filter structure */
311 struct sysctl_ctx_list *iv_sysctl; /* dynamic sysctl context */
312 struct sysctl_oid *iv_oid; /* net.wlan.X sysctl oid */
314 TAILQ_ENTRY(ieee80211vap) iv_next; /* list of vap instances */
315 struct ieee80211com *iv_ic; /* back ptr to common state */
316 uint32_t iv_debug; /* debug msg flags */
317 struct ieee80211_stats iv_stats; /* statistics */
319 uint8_t iv_myaddr[IEEE80211_ADDR_LEN];
320 uint32_t iv_flags; /* state flags */
321 uint32_t iv_flags_ext; /* extended state flags */
322 uint32_t iv_flags_ven; /* vendor state flags */
323 uint32_t iv_caps; /* capabilities */
324 uint32_t iv_htcaps; /* HT capabilities */
325 enum ieee80211_opmode iv_opmode; /* operation mode */
326 enum ieee80211_state iv_state; /* state machine state */
327 enum ieee80211_state iv_nstate; /* pending state */
328 int iv_nstate_arg; /* pending state arg */
329 struct task iv_nstate_task; /* deferred state processing */
330 struct task iv_swbmiss_task;/* deferred iv_bmiss call */
331 struct callout iv_mgtsend; /* mgmt frame response timer */
332 /* inactivity timer settings */
333 int iv_inact_init; /* setting for new station */
334 int iv_inact_auth; /* auth but not assoc setting */
335 int iv_inact_run; /* authorized setting */
336 int iv_inact_probe; /* inactive probe time */
338 int iv_des_nssid; /* # desired ssids */
339 struct ieee80211_scan_ssid iv_des_ssid[1];/* desired ssid table */
340 uint8_t iv_des_bssid[IEEE80211_ADDR_LEN];
341 struct ieee80211_channel *iv_des_chan; /* desired channel */
342 uint16_t iv_des_mode; /* desired mode */
343 int iv_nicknamelen; /* XXX junk */
344 uint8_t iv_nickname[IEEE80211_NWID_LEN];
345 u_int iv_bgscanidle; /* bg scan idle threshold */
346 u_int iv_bgscanintvl; /* bg scan min interval */
347 u_int iv_scanvalid; /* scan cache valid threshold */
348 u_int iv_scanreq_duration;
349 u_int iv_scanreq_mindwell;
350 u_int iv_scanreq_maxdwell;
351 uint16_t iv_scanreq_flags;/* held scan request params */
352 uint8_t iv_scanreq_nssid;
353 struct ieee80211_scan_ssid iv_scanreq_ssid[IEEE80211_SCAN_MAX_SSID];
354 /* sta-mode roaming state */
355 enum ieee80211_roamingmode iv_roaming; /* roaming mode */
356 struct ieee80211_roamparam iv_roamparms[IEEE80211_MODE_MAX];
358 uint8_t iv_bmissthreshold;
359 uint8_t iv_bmiss_count; /* current beacon miss count */
360 int iv_bmiss_max; /* max bmiss before scan */
361 uint16_t iv_swbmiss_count;/* beacons in last period */
362 uint16_t iv_swbmiss_period;/* s/w bmiss period */
363 struct callout iv_swbmiss; /* s/w beacon miss timer */
365 int iv_ampdu_rxmax; /* A-MPDU rx limit (bytes) */
366 int iv_ampdu_density;/* A-MPDU density */
367 int iv_ampdu_limit; /* A-MPDU tx limit (bytes) */
368 int iv_amsdu_limit; /* A-MSDU tx limit (bytes) */
369 u_int iv_ampdu_mintraffic[WME_NUM_AC];
371 uint32_t *iv_aid_bitmap; /* association id map */
373 uint16_t iv_sta_assoc; /* stations associated */
374 uint16_t iv_ps_sta; /* stations in power save */
375 uint16_t iv_ps_pending; /* ps sta's w/ pending frames */
376 uint16_t iv_txseq; /* mcast xmit seq# space */
377 uint16_t iv_tim_len; /* ic_tim_bitmap size (bytes) */
378 uint8_t *iv_tim_bitmap; /* power-save stations w/ data*/
379 uint8_t iv_dtim_period; /* DTIM period */
380 uint8_t iv_dtim_count; /* DTIM count from last bcn */
381 /* set/unset aid pwrsav state */
382 int iv_csa_count; /* count for doing CSA */
384 struct ieee80211_node *iv_bss; /* information for this node */
385 struct ieee80211_txparam iv_txparms[IEEE80211_MODE_MAX];
386 uint16_t iv_rtsthreshold;
387 uint16_t iv_fragthreshold;
388 int iv_inact_timer; /* inactivity timer wait */
389 /* application-specified IE's to attach to mgt frames */
390 struct ieee80211_appie *iv_appie_beacon;
391 struct ieee80211_appie *iv_appie_probereq;
392 struct ieee80211_appie *iv_appie_proberesp;
393 struct ieee80211_appie *iv_appie_assocreq;
394 struct ieee80211_appie *iv_appie_assocresp;
395 struct ieee80211_appie *iv_appie_wpa;
398 uint16_t iv_max_keyix; /* max h/w key index */
399 ieee80211_keyix iv_def_txkey; /* default/group tx key index */
400 struct ieee80211_key iv_nw_keys[IEEE80211_WEP_NKID];
401 int (*iv_key_alloc)(struct ieee80211vap *,
402 struct ieee80211_key *,
403 ieee80211_keyix *, ieee80211_keyix *);
404 int (*iv_key_delete)(struct ieee80211vap *,
405 const struct ieee80211_key *);
406 int (*iv_key_set)(struct ieee80211vap *,
407 const struct ieee80211_key *,
408 const uint8_t mac[IEEE80211_ADDR_LEN]);
409 void (*iv_key_update_begin)(struct ieee80211vap *);
410 void (*iv_key_update_end)(struct ieee80211vap *);
412 const struct ieee80211_authenticator *iv_auth; /* authenticator glue */
413 void *iv_ec; /* private auth state */
415 const struct ieee80211_aclator *iv_acl; /* acl glue */
416 void *iv_as; /* private aclator state */
418 struct ieee80211_tdma_state *iv_tdma; /* tdma state */
420 /* operate-mode detach hook */
421 void (*iv_opdetach)(struct ieee80211vap *);
422 /* receive processing */
423 int (*iv_input)(struct ieee80211_node *,
424 struct mbuf *, int rssi, int noise,
426 void (*iv_recv_mgmt)(struct ieee80211_node *,
427 struct mbuf *, int, int, int, uint32_t);
428 void (*iv_recv_ctl)(struct ieee80211_node *,
430 void (*iv_deliver_data)(struct ieee80211vap *,
431 struct ieee80211_node *, struct mbuf *);
433 /* send processing */
434 int (*iv_send_mgmt)(struct ieee80211_node *,
437 /* beacon miss processing */
438 void (*iv_bmiss)(struct ieee80211vap *);
439 /* reset device state after 802.11 parameter/state change */
440 int (*iv_reset)(struct ieee80211vap *, u_long);
441 /* [schedule] beacon frame update */
442 void (*iv_update_beacon)(struct ieee80211vap *, int);
443 /* power save handling */
444 void (*iv_update_ps)(struct ieee80211vap *, int);
445 int (*iv_set_tim)(struct ieee80211_node *, int);
446 /* state machine processing */
447 int (*iv_newstate)(struct ieee80211vap *,
448 enum ieee80211_state, int);
449 /* 802.3 output method for raw frame xmit */
450 int (*iv_output)(struct ifnet *, struct mbuf *,
451 struct sockaddr *, struct route *);
453 MALLOC_DECLARE(M_80211_VAP);
455 #define IEEE80211_ADDR_EQ(a1,a2) (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
456 #define IEEE80211_ADDR_COPY(dst,src) memcpy(dst,src,IEEE80211_ADDR_LEN)
458 /* ic_flags/iv_flags */
459 #define IEEE80211_F_TURBOP 0x00000001 /* CONF: ATH Turbo enabled*/
460 #define IEEE80211_F_COMP 0x00000002 /* CONF: ATH comp enabled */
461 #define IEEE80211_F_FF 0x00000004 /* CONF: ATH FF enabled */
462 #define IEEE80211_F_BURST 0x00000008 /* CONF: bursting enabled */
463 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
464 #define IEEE80211_F_PRIVACY 0x00000010 /* CONF: privacy enabled */
465 #define IEEE80211_F_PUREG 0x00000020 /* CONF: 11g w/o 11b sta's */
466 #define IEEE80211_F_SCAN 0x00000080 /* STATUS: scanning */
467 #define IEEE80211_F_ASCAN 0x00000100 /* STATUS: active scan */
468 #define IEEE80211_F_SIBSS 0x00000200 /* STATUS: start IBSS */
469 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
470 #define IEEE80211_F_SHSLOT 0x00000400 /* STATUS: use short slot time*/
471 #define IEEE80211_F_PMGTON 0x00000800 /* CONF: Power mgmt enable */
472 #define IEEE80211_F_DESBSSID 0x00001000 /* CONF: des_bssid is set */
473 #define IEEE80211_F_WME 0x00002000 /* CONF: enable WME use */
474 #define IEEE80211_F_BGSCAN 0x00004000 /* CONF: bg scan enabled (???)*/
475 #define IEEE80211_F_SWRETRY 0x00008000 /* CONF: sw tx retry enabled */
476 #define IEEE80211_F_TXPOW_FIXED 0x00010000 /* TX Power: fixed rate */
477 #define IEEE80211_F_IBSSON 0x00020000 /* CONF: IBSS creation enable */
478 #define IEEE80211_F_SHPREAMBLE 0x00040000 /* STATUS: use short preamble */
479 #define IEEE80211_F_DATAPAD 0x00080000 /* CONF: do alignment pad */
480 #define IEEE80211_F_USEPROT 0x00100000 /* STATUS: protection enabled */
481 #define IEEE80211_F_USEBARKER 0x00200000 /* STATUS: use barker preamble*/
482 #define IEEE80211_F_CSAPENDING 0x00400000 /* STATUS: chan switch pending*/
483 #define IEEE80211_F_WPA1 0x00800000 /* CONF: WPA enabled */
484 #define IEEE80211_F_WPA2 0x01000000 /* CONF: WPA2 enabled */
485 #define IEEE80211_F_WPA 0x01800000 /* CONF: WPA/WPA2 enabled */
486 #define IEEE80211_F_DROPUNENC 0x02000000 /* CONF: drop unencrypted */
487 #define IEEE80211_F_COUNTERM 0x04000000 /* CONF: TKIP countermeasures */
488 #define IEEE80211_F_HIDESSID 0x08000000 /* CONF: hide SSID in beacon */
489 #define IEEE80211_F_NOBRIDGE 0x10000000 /* CONF: dis. internal bridge */
490 #define IEEE80211_F_PCF 0x20000000 /* CONF: PCF enabled */
491 #define IEEE80211_F_DOTH 0x40000000 /* CONF: 11h enabled */
492 #define IEEE80211_F_DWDS 0x80000000 /* CONF: Dynamic WDS enabled */
494 #define IEEE80211_F_BITS \
495 "\20\1TURBOP\2COMP\3FF\4BURST\5PRIVACY\6PUREG\10SCAN\11ASCAN\12SIBSS" \
496 "\13SHSLOT\14PMGTON\15DESBSSID\16WME\17BGSCAN\20SWRETRY\21TXPOW_FIXED" \
497 "\22IBSSON\23SHPREAMBLE\24DATAPAD\25USEPROT\26USERBARKER\27CSAPENDING" \
498 "\30WPA1\31WPA2\32DROPUNENC\33COUNTERM\34HIDESSID\35NOBRIDG\36PCF" \
501 /* Atheros protocol-specific flags */
502 #define IEEE80211_F_ATHEROS \
503 (IEEE80211_F_FF | IEEE80211_F_COMP | IEEE80211_F_TURBOP)
504 /* Check if an Atheros capability was negotiated for use */
505 #define IEEE80211_ATH_CAP(vap, ni, bit) \
506 ((vap)->iv_flags & (ni)->ni_ath_flags & (bit))
508 /* ic_flags_ext/iv_flags_ext */
509 #define IEEE80211_FEXT_NONHT_PR 0x00000001 /* STATUS: non-HT sta present */
510 #define IEEE80211_FEXT_INACT 0x00000002 /* CONF: sta inact handling */
511 #define IEEE80211_FEXT_SCANWAIT 0x00000004 /* STATUS: awaiting scan */
512 /* 0x00000006 reserved */
513 #define IEEE80211_FEXT_BGSCAN 0x00000008 /* STATUS: complete bgscan */
514 #define IEEE80211_FEXT_WPS 0x00000010 /* CONF: WPS enabled */
515 #define IEEE80211_FEXT_TSN 0x00000020 /* CONF: TSN enabled */
516 #define IEEE80211_FEXT_SCANREQ 0x00000040 /* STATUS: scan req params */
517 #define IEEE80211_FEXT_RESUME 0x00000080 /* STATUS: start on resume */
518 #define IEEE80211_FEXT_4ADDR 0x00000100 /* CONF: apply 4-addr encap */
519 #define IEEE80211_FEXT_NONERP_PR 0x00000200 /* STATUS: non-ERP sta present*/
520 #define IEEE80211_FEXT_SWBMISS 0x00000400 /* CONF: do bmiss in s/w */
521 #define IEEE80211_FEXT_DFS 0x00000800 /* CONF: DFS enabled */
522 #define IEEE80211_FEXT_DOTD 0x00001000 /* CONF: 11d enabled */
523 #define IEEE80211_FEXT_STATEWAIT 0x00002000 /* STATUS: awaiting state chg */
524 #define IEEE80211_FEXT_REINIT 0x00004000 /* STATUS: INIT state first */
525 /* NB: immutable: should be set only when creating a vap */
526 #define IEEE80211_FEXT_WDSLEGACY 0x00010000 /* CONF: legacy WDS operation */
527 #define IEEE80211_FEXT_PROBECHAN 0x00020000 /* CONF: probe passive channel*/
528 #define IEEE80211_FEXT_HT 0x00080000 /* CONF: HT supported */
529 #define IEEE80211_FEXT_AMPDU_TX 0x00100000 /* CONF: A-MPDU tx supported */
530 #define IEEE80211_FEXT_AMPDU_RX 0x00200000 /* CONF: A-MPDU tx supported */
531 #define IEEE80211_FEXT_AMSDU_TX 0x00400000 /* CONF: A-MSDU tx supported */
532 #define IEEE80211_FEXT_AMSDU_RX 0x00800000 /* CONF: A-MSDU tx supported */
533 #define IEEE80211_FEXT_USEHT40 0x01000000 /* CONF: 20/40 use enabled */
534 #define IEEE80211_FEXT_PUREN 0x02000000 /* CONF: 11n w/o legacy sta's */
535 #define IEEE80211_FEXT_SHORTGI20 0x04000000 /* CONF: short GI in HT20 */
536 #define IEEE80211_FEXT_SHORTGI40 0x08000000 /* CONF: short GI in HT40 */
537 #define IEEE80211_FEXT_HTCOMPAT 0x10000000 /* CONF: HT vendor OUI's */
538 #define IEEE80211_FEXT_RIFS 0x20000000 /* CONF: RIFS enabled */
540 #define IEEE80211_FEXT_BITS \
541 "\20\1NONHT_PR\2INACT\3SCANWAIT\4BGSCAN\5WPS\6TSN\7SCANREQ\10RESUME" \
542 "\0114ADDR\12NONEPR_PR\13SWBMISS\14DFS\15DOTD\16STATEWAIT\17REINIT" \
543 "\22WDSLEGACY\23PROBECHAN\24HT\25AMDPU_TX\26AMPDU_TX\27AMSDU_TX" \
544 "\30AMSDU_RX\31USEHT40\32PUREN\33SHORTGI20\34SHORTGI40\35HTCOMPAT" \
547 #define IEEE80211_FVEN_BITS "\20"
549 /* ic_caps/iv_caps: device driver capabilities */
551 #define IEEE80211_C_STA 0x00000001 /* CAPABILITY: STA available */
552 #define IEEE80211_C_8023ENCAP 0x00000002 /* CAPABILITY: 802.3 encap */
553 #define IEEE80211_C_FF 0x00000040 /* CAPABILITY: ATH FF avail */
554 #define IEEE80211_C_TURBOP 0x00000080 /* CAPABILITY: ATH Turbo avail*/
555 #define IEEE80211_C_IBSS 0x00000100 /* CAPABILITY: IBSS available */
556 #define IEEE80211_C_PMGT 0x00000200 /* CAPABILITY: Power mgmt */
557 #define IEEE80211_C_HOSTAP 0x00000400 /* CAPABILITY: HOSTAP avail */
558 #define IEEE80211_C_AHDEMO 0x00000800 /* CAPABILITY: Old Adhoc Demo */
559 #define IEEE80211_C_SWRETRY 0x00001000 /* CAPABILITY: sw tx retry */
560 #define IEEE80211_C_TXPMGT 0x00002000 /* CAPABILITY: tx power mgmt */
561 #define IEEE80211_C_SHSLOT 0x00004000 /* CAPABILITY: short slottime */
562 #define IEEE80211_C_SHPREAMBLE 0x00008000 /* CAPABILITY: short preamble */
563 #define IEEE80211_C_MONITOR 0x00010000 /* CAPABILITY: monitor mode */
564 #define IEEE80211_C_DFS 0x00020000 /* CAPABILITY: DFS/radar avail*/
565 /* 0x7c0000 available */
566 #define IEEE80211_C_WPA1 0x00800000 /* CAPABILITY: WPA1 avail */
567 #define IEEE80211_C_WPA2 0x01000000 /* CAPABILITY: WPA2 avail */
568 #define IEEE80211_C_WPA 0x01800000 /* CAPABILITY: WPA1+WPA2 avail*/
569 #define IEEE80211_C_BURST 0x02000000 /* CAPABILITY: frame bursting */
570 #define IEEE80211_C_WME 0x04000000 /* CAPABILITY: WME avail */
571 #define IEEE80211_C_WDS 0x08000000 /* CAPABILITY: 4-addr support */
572 /* 0x10000000 reserved */
573 #define IEEE80211_C_BGSCAN 0x20000000 /* CAPABILITY: bg scanning */
574 #define IEEE80211_C_TXFRAG 0x40000000 /* CAPABILITY: tx fragments */
575 #define IEEE80211_C_TDMA 0x80000000 /* CAPABILITY: TDMA avail */
576 /* XXX protection/barker? */
578 #define IEEE80211_C_OPMODE \
579 (IEEE80211_C_STA | IEEE80211_C_IBSS | IEEE80211_C_HOSTAP | \
580 IEEE80211_C_AHDEMO | IEEE80211_C_MONITOR | IEEE80211_C_WDS | \
583 #define IEEE80211_C_BITS \
584 "\20\1STA\002803ENCAP\7FF\10TURBOP\11IBSS\12PMGT" \
585 "\13HOSTAP\14AHDEMO\15SWRETRY\16TXPMGT\17SHSLOT\20SHPREAMBLE" \
586 "\21MONITOR\22DFS\30WPA1\31WPA2\32BURST\33WME\34WDS\36BGSCAN" \
590 * ic_htcaps/iv_htcaps: HT-specific device/driver capabilities
592 * NB: the low 16-bits are the 802.11 definitions, the upper
593 * 16-bits are used to define s/w/driver capabilities.
595 #define IEEE80211_HTC_AMPDU 0x00010000 /* CAPABILITY: A-MPDU tx */
596 #define IEEE80211_HTC_AMSDU 0x00020000 /* CAPABILITY: A-MSDU tx */
597 /* NB: HT40 is implied by IEEE80211_HTCAP_CHWIDTH40 */
598 #define IEEE80211_HTC_HT 0x00040000 /* CAPABILITY: HT operation */
599 #define IEEE80211_HTC_SMPS 0x00080000 /* CAPABILITY: MIMO power save*/
600 #define IEEE80211_HTC_RIFS 0x00100000 /* CAPABILITY: RIFS support */
602 #define IEEE80211_C_HTCAP_BITS \
603 "\20\1LDPC\2CHWIDTH40\5GREENFIELD\6SHORTGI20\7SHORTGI40\10TXSTBC" \
604 "\21AMPDU\22AMSDU\23HT\24SMPS\25RIFS"
606 void ieee80211_ifattach(struct ieee80211com *,
607 const uint8_t macaddr[IEEE80211_ADDR_LEN]);
608 void ieee80211_ifdetach(struct ieee80211com *);
609 int ieee80211_vap_setup(struct ieee80211com *, struct ieee80211vap *,
610 const char name[IFNAMSIZ], int unit, int opmode, int flags,
611 const uint8_t bssid[IEEE80211_ADDR_LEN],
612 const uint8_t macaddr[IEEE80211_ADDR_LEN]);
613 int ieee80211_vap_attach(struct ieee80211vap *,
614 ifm_change_cb_t, ifm_stat_cb_t);
615 void ieee80211_vap_detach(struct ieee80211vap *);
616 const struct ieee80211_rateset *ieee80211_get_suprates(struct ieee80211com *ic,
617 const struct ieee80211_channel *);
618 void ieee80211_announce(struct ieee80211com *);
619 void ieee80211_announce_channels(struct ieee80211com *);
620 void ieee80211_drain(struct ieee80211com *);
621 void ieee80211_media_init(struct ieee80211com *);
622 struct ieee80211com *ieee80211_find_vap(const uint8_t mac[IEEE80211_ADDR_LEN]);
623 int ieee80211_media_change(struct ifnet *);
624 void ieee80211_media_status(struct ifnet *, struct ifmediareq *);
625 int ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
626 int ieee80211_rate2media(struct ieee80211com *, int,
627 enum ieee80211_phymode);
628 int ieee80211_media2rate(int);
629 int ieee80211_mhz2ieee(u_int, u_int);
630 int ieee80211_chan2ieee(struct ieee80211com *,
631 const struct ieee80211_channel *);
632 u_int ieee80211_ieee2mhz(u_int, u_int);
633 struct ieee80211_channel *ieee80211_find_channel(struct ieee80211com *,
634 int freq, int flags);
635 struct ieee80211_channel *ieee80211_find_channel_byieee(struct ieee80211com *,
636 int ieee, int flags);
637 int ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
638 enum ieee80211_phymode ieee80211_chan2mode(const struct ieee80211_channel *);
641 * Enqueue a task on the state thread.
644 ieee80211_runtask(struct ieee80211com *ic, struct task *task)
646 taskqueue_enqueue(ic->ic_tq, task);
650 * Wait for a queued task to complete.
653 ieee80211_draintask(struct ieee80211com *ic, struct task *task)
655 taskqueue_drain(ic->ic_tq, task);
659 * Key update synchronization methods. XXX should not be visible.
662 ieee80211_key_update_begin(struct ieee80211vap *vap)
664 vap->iv_key_update_begin(vap);
667 ieee80211_key_update_end(struct ieee80211vap *vap)
669 vap->iv_key_update_end(vap);
673 * XXX these need to be here for IEEE80211_F_DATAPAD
677 * Return the space occupied by the 802.11 header and any
678 * padding required by the driver. This works for a
679 * management or data frame.
682 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
684 int size = ieee80211_hdrsize(data);
685 if (ic->ic_flags & IEEE80211_F_DATAPAD)
686 size = roundup(size, sizeof(uint32_t));
691 * Like ieee80211_hdrspace, but handles any type of frame.
694 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
696 int size = ieee80211_anyhdrsize(data);
697 if (ic->ic_flags & IEEE80211_F_DATAPAD)
698 size = roundup(size, sizeof(uint32_t));
703 * Notify a vap that beacon state has been updated.
706 ieee80211_beacon_notify(struct ieee80211vap *vap, int what)
708 if (vap->iv_state == IEEE80211_S_RUN)
709 vap->iv_update_beacon(vap, what);
713 * Calculate HT channel promotion flags for a channel.
714 * XXX belongs in ieee80211_ht.h but needs IEEE80211_FEXT_*
717 ieee80211_htchanflags(const struct ieee80211_channel *c)
719 return IEEE80211_IS_CHAN_HT40(c) ?
720 IEEE80211_FEXT_HT | IEEE80211_FEXT_USEHT40 :
721 IEEE80211_IS_CHAN_HT(c) ? IEEE80211_FEXT_HT : 0;
725 * Debugging facilities compiled in when IEEE80211_DEBUG is defined.
727 * The intent is that any problem in the net80211 layer can be
728 * diagnosed by inspecting the statistics (dumped by the wlanstats
729 * program) and/or the msgs generated by net80211. Messages are
730 * broken into functional classes and can be controlled with the
731 * wlandebug program. Certain of these msg groups are for facilities
732 * that are no longer part of net80211 (e.g. IEEE80211_MSG_DOT1X).
734 #define IEEE80211_MSG_11N 0x80000000 /* 11n mode debug */
735 #define IEEE80211_MSG_DEBUG 0x40000000 /* IFF_DEBUG equivalent */
736 #define IEEE80211_MSG_DUMPPKTS 0x20000000 /* IFF_LINK2 equivalant */
737 #define IEEE80211_MSG_CRYPTO 0x10000000 /* crypto work */
738 #define IEEE80211_MSG_INPUT 0x08000000 /* input handling */
739 #define IEEE80211_MSG_XRATE 0x04000000 /* rate set handling */
740 #define IEEE80211_MSG_ELEMID 0x02000000 /* element id parsing */
741 #define IEEE80211_MSG_NODE 0x01000000 /* node handling */
742 #define IEEE80211_MSG_ASSOC 0x00800000 /* association handling */
743 #define IEEE80211_MSG_AUTH 0x00400000 /* authentication handling */
744 #define IEEE80211_MSG_SCAN 0x00200000 /* scanning */
745 #define IEEE80211_MSG_OUTPUT 0x00100000 /* output handling */
746 #define IEEE80211_MSG_STATE 0x00080000 /* state machine */
747 #define IEEE80211_MSG_POWER 0x00040000 /* power save handling */
748 #define IEEE80211_MSG_DOT1X 0x00020000 /* 802.1x authenticator */
749 #define IEEE80211_MSG_DOT1XSM 0x00010000 /* 802.1x state machine */
750 #define IEEE80211_MSG_RADIUS 0x00008000 /* 802.1x radius client */
751 #define IEEE80211_MSG_RADDUMP 0x00004000 /* dump 802.1x radius packets */
752 #define IEEE80211_MSG_MESH 0x00002000 /* mesh networking */
753 #define IEEE80211_MSG_WPA 0x00001000 /* WPA/RSN protocol */
754 #define IEEE80211_MSG_ACL 0x00000800 /* ACL handling */
755 #define IEEE80211_MSG_WME 0x00000400 /* WME protocol */
756 #define IEEE80211_MSG_SUPERG 0x00000200 /* Atheros SuperG protocol */
757 #define IEEE80211_MSG_DOTH 0x00000100 /* 802.11h support */
758 #define IEEE80211_MSG_INACT 0x00000080 /* inactivity handling */
759 #define IEEE80211_MSG_ROAM 0x00000040 /* sta-mode roaming */
760 #define IEEE80211_MSG_RATECTL 0x00000020 /* tx rate control */
761 #define IEEE80211_MSG_ACTION 0x00000010 /* action frame handling */
762 #define IEEE80211_MSG_WDS 0x00000008 /* WDS handling */
763 #define IEEE80211_MSG_IOCTL 0x00000004 /* ioctl handling */
764 #define IEEE80211_MSG_TDMA 0x00000002 /* TDMA handling */
766 #define IEEE80211_MSG_ANY 0xffffffff /* anything */
768 #define IEEE80211_MSG_BITS \
769 "\20\2TDMA\3IOCTL\4WDS\5ACTION\6RATECTL\7ROAM\10INACT\11DOTH\12SUPERG" \
770 "\13WME\14ACL\15WPA\16RADKEYS\17RADDUMP\20RADIUS\21DOT1XSM\22DOT1X" \
771 "\23POWER\24STATE\25OUTPUT\26SCAN\27AUTH\30ASSOC\31NODE\32ELEMID" \
772 "\33XRATE\34INPUT\35CRYPTO\36DUPMPKTS\37DEBUG\04011N"
774 #ifdef IEEE80211_DEBUG
775 #define ieee80211_msg(_vap, _m) ((_vap)->iv_debug & (_m))
776 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...) do { \
777 if (ieee80211_msg(_vap, _m)) \
778 ieee80211_note(_vap, _fmt, __VA_ARGS__); \
780 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...) do { \
781 if (ieee80211_msg(_vap, _m)) \
782 ieee80211_note_mac(_vap, (_ni)->ni_macaddr, _fmt, __VA_ARGS__);\
784 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...) do { \
785 if (ieee80211_msg(_vap, _m)) \
786 ieee80211_note_mac(_vap, _mac, _fmt, __VA_ARGS__); \
788 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...) do { \
789 if (ieee80211_msg(_vap, _m)) \
790 ieee80211_note_frame(_vap, _wh, _fmt, __VA_ARGS__); \
792 void ieee80211_note(struct ieee80211vap *, const char *, ...);
793 void ieee80211_note_mac(struct ieee80211vap *,
794 const uint8_t mac[IEEE80211_ADDR_LEN], const char *, ...);
795 void ieee80211_note_frame(struct ieee80211vap *,
796 const struct ieee80211_frame *, const char *, ...);
797 #define ieee80211_msg_debug(_vap) \
798 ((_vap)->iv_debug & IEEE80211_MSG_DEBUG)
799 #define ieee80211_msg_dumppkts(_vap) \
800 ((_vap)->iv_debug & IEEE80211_MSG_DUMPPKTS)
801 #define ieee80211_msg_input(_vap) \
802 ((_vap)->iv_debug & IEEE80211_MSG_INPUT)
803 #define ieee80211_msg_radius(_vap) \
804 ((_vap)->iv_debug & IEEE80211_MSG_RADIUS)
805 #define ieee80211_msg_dumpradius(_vap) \
806 ((_vap)->iv_debug & IEEE80211_MSG_RADDUMP)
807 #define ieee80211_msg_dumpradkeys(_vap) \
808 ((_vap)->iv_debug & IEEE80211_MSG_RADKEYS)
809 #define ieee80211_msg_scan(_vap) \
810 ((_vap)->iv_debug & IEEE80211_MSG_SCAN)
811 #define ieee80211_msg_assoc(_vap) \
812 ((_vap)->iv_debug & IEEE80211_MSG_ASSOC)
815 * Emit a debug message about discarding a frame or information
816 * element. One format is for extracting the mac address from
817 * the frame header; the other is for when a header is not
818 * available or otherwise appropriate.
820 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...) do { \
821 if ((_vap)->iv_debug & (_m)) \
822 ieee80211_discard_frame(_vap, _wh, _type, _fmt, __VA_ARGS__);\
824 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...) do { \
825 if ((_vap)->iv_debug & (_m)) \
826 ieee80211_discard_ie(_vap, _wh, _type, _fmt, __VA_ARGS__);\
828 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...) do { \
829 if ((_vap)->iv_debug & (_m)) \
830 ieee80211_discard_mac(_vap, _mac, _type, _fmt, __VA_ARGS__);\
833 void ieee80211_discard_frame(struct ieee80211vap *,
834 const struct ieee80211_frame *, const char *type, const char *fmt, ...);
835 void ieee80211_discard_ie(struct ieee80211vap *,
836 const struct ieee80211_frame *, const char *type, const char *fmt, ...);
837 void ieee80211_discard_mac(struct ieee80211vap *,
838 const uint8_t mac[IEEE80211_ADDR_LEN], const char *type,
839 const char *fmt, ...);
841 #define IEEE80211_DPRINTF(_vap, _m, _fmt, ...)
842 #define IEEE80211_NOTE(_vap, _m, _ni, _fmt, ...)
843 #define IEEE80211_NOTE_FRAME(_vap, _m, _wh, _fmt, ...)
844 #define IEEE80211_NOTE_MAC(_vap, _m, _mac, _fmt, ...)
845 #define ieee80211_msg_dumppkts(_vap) 0
846 #define ieee80211_msg(_vap, _m) 0
848 #define IEEE80211_DISCARD(_vap, _m, _wh, _type, _fmt, ...)
849 #define IEEE80211_DISCARD_IE(_vap, _m, _wh, _type, _fmt, ...)
850 #define IEEE80211_DISCARD_MAC(_vap, _m, _mac, _type, _fmt, ...)
853 #endif /* _NET80211_IEEE80211_VAR_H_ */