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