xref: /freebsd/sys/net80211/ieee80211_ioctl.h (revision 2d4583c462a5d7904e2bb4c77f521d16fd2e7140)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Atsushi Onoe
5  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef _NET80211_IEEE80211_IOCTL_H_
29 #define _NET80211_IEEE80211_IOCTL_H_
30 
31 /*
32  * IEEE 802.11 ioctls.
33  */
34 #include <net80211/_ieee80211.h>
35 #include <net80211/ieee80211.h>
36 #include <net80211/ieee80211_crypto.h>
37 
38 /*
39  * Per/node (station) statistics.
40  */
41 struct ieee80211_nodestats {
42 	uint32_t	ns_rx_data;		/* rx data frames */
43 	uint32_t	ns_rx_mgmt;		/* rx management frames */
44 	uint32_t	ns_rx_ctrl;		/* rx control frames */
45 	uint32_t	ns_rx_ucast;		/* rx unicast frames */
46 	uint32_t	ns_rx_mcast;		/* rx multi/broadcast frames */
47 	uint64_t	ns_rx_bytes;		/* rx data count (bytes) */
48 	uint64_t	ns_rx_beacons;		/* rx beacon frames */
49 	uint32_t	ns_rx_proberesp;	/* rx probe response frames */
50 
51 	uint32_t	ns_rx_dup;		/* rx discard 'cuz dup */
52 	uint32_t	ns_rx_noprivacy;	/* rx w/ wep but privacy off */
53 	uint32_t	ns_rx_wepfail;		/* rx wep processing failed */
54 	uint32_t	ns_rx_demicfail;	/* rx demic failed */
55 	uint32_t	ns_rx_decap;		/* rx decapsulation failed */
56 	uint32_t	ns_rx_defrag;		/* rx defragmentation failed */
57 	uint32_t	ns_rx_disassoc;		/* rx disassociation */
58 	uint32_t	ns_rx_deauth;		/* rx deauthentication */
59 	uint32_t	ns_rx_action;		/* rx action */
60 	uint32_t	ns_rx_decryptcrc;	/* rx decrypt failed on crc */
61 	uint32_t	ns_rx_unauth;		/* rx on unauthorized port */
62 	uint32_t	ns_rx_unencrypted;	/* rx unecrypted w/ privacy */
63 	uint32_t	ns_rx_drop;		/* rx discard other reason */
64 
65 	uint32_t	ns_tx_data;		/* tx data frames */
66 	uint32_t	ns_tx_mgmt;		/* tx management frames */
67 	uint32_t	ns_tx_ctrl;		/* tx control frames */
68 	uint32_t	ns_tx_ucast;		/* tx unicast frames */
69 	uint32_t	ns_tx_mcast;		/* tx multi/broadcast frames */
70 	uint64_t	ns_tx_bytes;		/* tx data count (bytes) */
71 	uint32_t	ns_tx_probereq;		/* tx probe request frames */
72 
73 	uint32_t	ns_tx_novlantag;	/* tx discard 'cuz no tag */
74 	uint32_t	ns_tx_vlanmismatch;	/* tx discard 'cuz bad tag */
75 
76 	uint32_t	ns_ps_discard;		/* ps discard 'cuz of age */
77 
78 	/* MIB-related state */
79 	uint32_t	ns_tx_assoc;		/* [re]associations */
80 	uint32_t	ns_tx_assoc_fail;	/* [re]association failures */
81 	uint32_t	ns_tx_auth;		/* [re]authentications */
82 	uint32_t	ns_tx_auth_fail;	/* [re]authentication failures*/
83 	uint32_t	ns_tx_deauth;		/* deauthentications */
84 	uint32_t	ns_tx_deauth_code;	/* last deauth reason */
85 	uint32_t	ns_tx_disassoc;		/* disassociations */
86 	uint32_t	ns_tx_disassoc_code;	/* last disassociation reason */
87 
88 	/* Hardware A-MSDU decode */
89 	uint32_t	ns_rx_amsdu_more;	/* RX decap A-MSDU, more coming from A-MSDU */
90 	uint32_t	ns_rx_amsdu_more_end;	/* RX decap A-MSDU (or any other frame), no more coming */
91 	uint32_t	ns_spare[6];
92 };
93 
94 /*
95  * Summary statistics.
96  */
97 struct ieee80211_stats {
98 	uint32_t	is_rx_badversion;	/* rx frame with bad version */
99 	uint32_t	is_rx_tooshort;		/* rx frame too short */
100 	uint32_t	is_rx_wrongbss;		/* rx from wrong bssid */
101 	uint32_t	is_rx_dup;		/* rx discard 'cuz dup */
102 	uint32_t	is_rx_wrongdir;		/* rx w/ wrong direction */
103 	uint32_t	is_rx_mcastecho;	/* rx discard 'cuz mcast echo */
104 	uint32_t	is_rx_notassoc;		/* rx discard 'cuz sta !assoc */
105 	uint32_t	is_rx_noprivacy;	/* rx w/ wep but privacy off */
106 	uint32_t	is_rx_unencrypted;	/* rx w/o wep and privacy on */
107 	uint32_t	is_rx_wepfail;		/* rx wep processing failed */
108 	uint32_t	is_rx_decap;		/* rx decapsulation failed */
109 	uint32_t	is_rx_mgtdiscard;	/* rx discard mgt frames */
110 	uint32_t	is_rx_ctl;		/* rx ctrl frames */
111 	uint32_t	is_rx_beacon;		/* rx beacon frames */
112 	uint32_t	is_rx_rstoobig;		/* rx rate set truncated */
113 	uint32_t	is_rx_elem_missing;	/* rx required element missing*/
114 	uint32_t	is_rx_elem_toobig;	/* rx element too big */
115 	uint32_t	is_rx_elem_toosmall;	/* rx element too small */
116 	uint32_t	is_rx_elem_unknown;	/* rx element unknown */
117 	uint32_t	is_rx_badchan;		/* rx frame w/ invalid chan */
118 	uint32_t	is_rx_chanmismatch;	/* rx frame chan mismatch */
119 	uint32_t	is_rx_nodealloc;	/* rx frame dropped */
120 	uint32_t	is_rx_ssidmismatch;	/* rx frame ssid mismatch  */
121 	uint32_t	is_rx_auth_unsupported;	/* rx w/ unsupported auth alg */
122 	uint32_t	is_rx_auth_fail;	/* rx sta auth failure */
123 	uint32_t	is_rx_auth_countermeasures;/* rx auth discard 'cuz CM */
124 	uint32_t	is_rx_assoc_bss;	/* rx assoc from wrong bssid */
125 	uint32_t	is_rx_assoc_notauth;	/* rx assoc w/o auth */
126 	uint32_t	is_rx_assoc_capmismatch;/* rx assoc w/ cap mismatch */
127 	uint32_t	is_rx_assoc_norate;	/* rx assoc w/ no rate match */
128 	uint32_t	is_rx_assoc_badwpaie;	/* rx assoc w/ bad WPA IE */
129 	uint32_t	is_rx_deauth;		/* rx deauthentication */
130 	uint32_t	is_rx_disassoc;		/* rx disassociation */
131 	uint32_t	is_rx_badsubtype;	/* rx frame w/ unknown subtype*/
132 	uint32_t	is_rx_nobuf;		/* rx failed for lack of buf */
133 	uint32_t	is_rx_decryptcrc;	/* rx decrypt failed on crc */
134 	uint32_t	is_rx_ahdemo_mgt;	/* rx discard ahdemo mgt frame*/
135 	uint32_t	is_rx_bad_auth;		/* rx bad auth request */
136 	uint32_t	is_rx_unauth;		/* rx on unauthorized port */
137 	uint32_t	is_rx_badkeyid;		/* rx w/ incorrect keyid */
138 	uint32_t	is_rx_ccmpreplay;	/* rx seq# violation (CCMP) */
139 	uint32_t	is_rx_ccmpformat;	/* rx format bad (CCMP) */
140 	uint32_t	is_rx_ccmpmic;		/* rx MIC check failed (CCMP) */
141 	uint32_t	is_rx_tkipreplay;	/* rx seq# violation (TKIP) */
142 	uint32_t	is_rx_tkipformat;	/* rx format bad (TKIP) */
143 	uint32_t	is_rx_tkipmic;		/* rx MIC check failed (TKIP) */
144 	uint32_t	is_rx_tkipicv;		/* rx ICV check failed (TKIP) */
145 	uint32_t	is_rx_badcipher;	/* rx failed 'cuz key type */
146 	uint32_t	is_rx_nocipherctx;	/* rx failed 'cuz key !setup */
147 	uint32_t	is_rx_acl;		/* rx discard 'cuz acl policy */
148 	uint32_t	is_tx_nobuf;		/* tx failed for lack of buf */
149 	uint32_t	is_tx_nonode;		/* tx failed for no node */
150 	uint32_t	is_tx_unknownmgt;	/* tx of unknown mgt frame */
151 	uint32_t	is_tx_badcipher;	/* tx failed 'cuz key type */
152 	uint32_t	is_tx_nodefkey;		/* tx failed 'cuz no defkey */
153 	uint32_t	is_tx_noheadroom;	/* tx failed 'cuz no space */
154 	uint32_t	is_tx_fragframes;	/* tx frames fragmented */
155 	uint32_t	is_tx_frags;		/* tx fragments created */
156 	uint32_t	is_scan_active;		/* active scans started */
157 	uint32_t	is_scan_passive;	/* passive scans started */
158 	uint32_t	is_node_timeout;	/* nodes timed out inactivity */
159 	uint32_t	is_crypto_nomem;	/* no memory for crypto ctx */
160 	uint32_t	is_crypto_tkip;		/* tkip crypto done in s/w */
161 	uint32_t	is_crypto_tkipenmic;	/* tkip en-MIC done in s/w */
162 	uint32_t	is_crypto_tkipdemic;	/* tkip de-MIC done in s/w */
163 	uint32_t	is_crypto_tkipcm;	/* tkip counter measures */
164 	uint32_t	is_crypto_ccmp;		/* ccmp crypto done in s/w */
165 	uint32_t	is_crypto_wep;		/* wep crypto done in s/w */
166 	uint32_t	is_crypto_setkey_cipher;/* cipher rejected key */
167 	uint32_t	is_crypto_setkey_nokey;	/* no key index for setkey */
168 	uint32_t	is_crypto_delkey;	/* driver key delete failed */
169 	uint32_t	is_crypto_badcipher;	/* unknown cipher */
170 	uint32_t	is_crypto_nocipher;	/* cipher not available */
171 	uint32_t	is_crypto_attachfail;	/* cipher attach failed */
172 	uint32_t	is_crypto_swfallback;	/* cipher fallback to s/w */
173 	uint32_t	is_crypto_keyfail;	/* driver key alloc failed */
174 	uint32_t	is_crypto_enmicfail;	/* en-MIC failed */
175 	uint32_t	is_ibss_capmismatch;	/* merge failed-cap mismatch */
176 	uint32_t	is_ibss_norate;		/* merge failed-rate mismatch */
177 	uint32_t	is_ps_unassoc;		/* ps-poll for unassoc. sta */
178 	uint32_t	is_ps_badaid;		/* ps-poll w/ incorrect aid */
179 	uint32_t	is_ps_qempty;		/* ps-poll w/ nothing to send */
180 	uint32_t	is_ff_badhdr;		/* fast frame rx'd w/ bad hdr */
181 	uint32_t	is_ff_tooshort;		/* fast frame rx decap error */
182 	uint32_t	is_ff_split;		/* fast frame rx split error */
183 	uint32_t	is_ff_decap;		/* fast frames decap'd */
184 	uint32_t	is_ff_encap;		/* fast frames encap'd for tx */
185 	uint32_t	is_rx_badbintval;	/* rx frame w/ bogus bintval */
186 	uint32_t	is_rx_demicfail;	/* rx demic failed */
187 	uint32_t	is_rx_defrag;		/* rx defragmentation failed */
188 	uint32_t	is_rx_mgmt;		/* rx management frames */
189 	uint32_t	is_rx_action;		/* rx action mgt frames */
190 	uint32_t	is_amsdu_tooshort;	/* A-MSDU rx decap error */
191 	uint32_t	is_amsdu_split;		/* A-MSDU rx split error */
192 	uint32_t	is_amsdu_decap;		/* A-MSDU decap'd */
193 	uint32_t	is_amsdu_encap;		/* A-MSDU encap'd for tx */
194 	uint32_t	is_ampdu_bar_bad;	/* A-MPDU BAR out of window */
195 	uint32_t	is_ampdu_bar_oow;	/* A-MPDU BAR before ADDBA */
196 	uint32_t	is_ampdu_bar_move;	/* A-MPDU BAR moved window */
197 	uint32_t	is_ampdu_bar_rx;	/* A-MPDU BAR frames handled */
198 	uint32_t	is_ampdu_rx_flush;	/* A-MPDU frames flushed */
199 	uint32_t	is_ampdu_rx_oor;	/* A-MPDU frames out-of-order */
200 	uint32_t	is_ampdu_rx_copy;	/* A-MPDU frames copied down */
201 	uint32_t	is_ampdu_rx_drop;	/* A-MPDU frames dropped */
202 	uint32_t	is_tx_badstate;		/* tx discard state != RUN */
203 	uint32_t	is_tx_notassoc;		/* tx failed, sta not assoc */
204 	uint32_t	is_tx_classify;		/* tx classification failed */
205 	uint32_t	is_dwds_mcast;		/* discard mcast over dwds */
206 	uint32_t	is_dwds_qdrop;		/* dwds pending frame q full */
207 	uint32_t	is_ht_assoc_nohtcap;	/* non-HT sta rejected */
208 	uint32_t	is_ht_assoc_downgrade;	/* HT sta forced to legacy */
209 	uint32_t	is_ht_assoc_norate;	/* HT assoc w/ rate mismatch */
210 	uint32_t	is_ampdu_rx_age;	/* A-MPDU sent up 'cuz of age */
211 	uint32_t	is_ampdu_rx_move;	/* A-MPDU MSDU moved window */
212 	uint32_t	is_addba_reject;	/* ADDBA reject 'cuz disabled */
213 	uint32_t	is_addba_norequest;	/* ADDBA response w/o ADDBA */
214 	uint32_t	is_addba_badtoken;	/* ADDBA response w/ wrong
215 						   dialogtoken */
216 	uint32_t	is_addba_badpolicy;	/* ADDBA resp w/ wrong policy */
217 	uint32_t	is_ampdu_stop;		/* A-MPDU stream stopped */
218 	uint32_t	is_ampdu_stop_failed;	/* A-MPDU stream not running */
219 	uint32_t	is_ampdu_rx_reorder;	/* A-MPDU held for rx reorder */
220 	uint32_t	is_scan_bg;		/* background scans started */
221 	uint8_t		is_rx_deauth_code;	/* last rx'd deauth reason */
222 	uint8_t		is_rx_disassoc_code;	/* last rx'd disassoc reason */
223 	uint8_t		is_rx_authfail_code;	/* last rx'd auth fail reason */
224 	uint32_t	is_beacon_miss;		/* beacon miss notification */
225 	uint32_t	is_rx_badstate;		/* rx discard state != RUN */
226 	uint32_t	is_ff_flush;		/* ff's flush'd from stageq */
227 	uint32_t	is_tx_ctl;		/* tx ctrl frames */
228 	uint32_t	is_ampdu_rexmt;		/* A-MPDU frames rexmt ok */
229 	uint32_t	is_ampdu_rexmt_fail;	/* A-MPDU frames rexmt fail */
230 
231 	uint32_t	is_mesh_wrongmesh;	/* dropped 'cuz not mesh sta*/
232 	uint32_t	is_mesh_nolink;		/* dropped 'cuz link not estab*/
233 	uint32_t	is_mesh_fwd_ttl;	/* mesh not fwd'd 'cuz ttl 0 */
234 	uint32_t	is_mesh_fwd_nobuf;	/* mesh not fwd'd 'cuz no mbuf*/
235 	uint32_t	is_mesh_fwd_tooshort;	/* mesh not fwd'd 'cuz no hdr */
236 	uint32_t	is_mesh_fwd_disabled;	/* mesh not fwd'd 'cuz disabled */
237 	uint32_t	is_mesh_fwd_nopath;	/* mesh not fwd'd 'cuz path unknown */
238 
239 	uint32_t	is_hwmp_wrongseq;	/* wrong hwmp seq no. */
240 	uint32_t	is_hwmp_rootreqs;	/* root PREQs sent */
241 	uint32_t	is_hwmp_rootrann;	/* root RANNs sent */
242 
243 	uint32_t	is_mesh_badae;		/* dropped 'cuz invalid AE */
244 	uint32_t	is_mesh_rtaddfailed;	/* route add failed */
245 	uint32_t	is_mesh_notproxy;	/* dropped 'cuz not proxying */
246 	uint32_t	is_rx_badalign;		/* dropped 'cuz misaligned */
247 	uint32_t	is_hwmp_proxy;		/* PREP for proxy route */
248 	uint32_t	is_beacon_bad;		/* Number of bad beacons */
249 	uint32_t	is_ampdu_bar_tx;	/* A-MPDU BAR frames TXed */
250 	uint32_t	is_ampdu_bar_tx_retry;	/* A-MPDU BAR frames TX rtry */
251 	uint32_t	is_ampdu_bar_tx_fail;	/* A-MPDU BAR frames TX fail */
252 
253 	uint32_t	is_ff_encapfail;	/* failed FF encap */
254 	uint32_t	is_amsdu_encapfail;	/* failed A-MSDU encap */
255 
256 	uint32_t	is_crypto_gcmp;		/* gcmp crypto done in s/w */
257 	uint32_t	is_rx_gcmpreplay;	/* rx seq# violation (GCMP) */
258 	uint32_t	is_rx_gcmpformat;	/* rx format bad (GCMP) */
259 	uint32_t	is_rx_gcmpmic;		/* rx MIC check failed (GCMP) */
260 	uint32_t	is_crypto_gcmp_nomem;	/* gcmp crypto failed; no mem */
261 	uint32_t	is_crypto_gcmp_nospc;	/* gcmp crypto failed; no mbuf space */
262 
263 	uint32_t	is_spare[5];
264 };
265 
266 /*
267  * Max size of optional information elements.  We artificially
268  * constrain this; it's limited only by the max frame size (and
269  * the max parameter size of the wireless extensions).
270  */
271 #define	IEEE80211_MAX_OPT_IE	256
272 
273 /*
274  * WPA/RSN get/set key request.  Specify the key/cipher
275  * type and whether the key is to be used for sending and/or
276  * receiving.  The key index should be set only when working
277  * with global keys (use IEEE80211_KEYIX_NONE for ``no index'').
278  * Otherwise a unicast/pairwise key is specified by the bssid
279  * (on a station) or mac address (on an ap).  They key length
280  * must include any MIC key data; otherwise it should be no
281  * more than IEEE80211_KEYBUF_SIZE.
282  */
283 struct ieee80211req_key {
284 	uint8_t		ik_type;	/* key/cipher type */
285 	uint8_t		ik_pad;
286 	uint16_t	ik_keyix;	/* key index */
287 	uint8_t		ik_keylen;	/* key length in bytes */
288 	uint8_t		ik_flags;
289 /* NB: IEEE80211_KEY_XMIT and IEEE80211_KEY_RECV defined elsewhere */
290 #define	IEEE80211_KEY_DEFAULT	0x80	/* default xmit key */
291 	uint8_t		ik_macaddr[IEEE80211_ADDR_LEN];
292 	uint64_t	ik_keyrsc;	/* key receive sequence counter */
293 	uint64_t	ik_keytsc;	/* key transmit sequence counter */
294 	uint8_t		ik_keydata[IEEE80211_KEYBUF_SIZE+IEEE80211_MICBUF_SIZE];
295 };
296 
297 /*
298  * Delete a key either by index or address.  Set the index
299  * to IEEE80211_KEYIX_NONE when deleting a unicast key.
300  */
301 struct ieee80211req_del_key {
302 	uint8_t		idk_keyix;	/* key index */
303 	uint8_t		idk_macaddr[IEEE80211_ADDR_LEN];
304 };
305 
306 /*
307  * MLME state manipulation request.  IEEE80211_MLME_ASSOC
308  * only makes sense when operating as a station.  The other
309  * requests can be used when operating as a station or an
310  * ap (to effect a station).
311  */
312 struct ieee80211req_mlme {
313 	uint8_t		im_op;		/* operation to perform */
314 #define	IEEE80211_MLME_ASSOC		1	/* associate station */
315 #define	IEEE80211_MLME_DISASSOC		2	/* disassociate station */
316 #define	IEEE80211_MLME_DEAUTH		3	/* deauthenticate station */
317 #define	IEEE80211_MLME_AUTHORIZE	4	/* authorize station */
318 #define	IEEE80211_MLME_UNAUTHORIZE	5	/* unauthorize station */
319 #define	IEEE80211_MLME_AUTH		6	/* authenticate station */
320 	uint8_t		im_ssid_len;	/* length of optional ssid */
321 	uint16_t	im_reason;	/* 802.11 reason code */
322 	uint8_t		im_macaddr[IEEE80211_ADDR_LEN];
323 	uint8_t		im_ssid[IEEE80211_NWID_LEN];
324 };
325 
326 /*
327  * MAC ACL operations.
328  */
329 enum {
330 	IEEE80211_MACCMD_POLICY_OPEN	= 0,	/* set policy: no ACL's */
331 	IEEE80211_MACCMD_POLICY_ALLOW	= 1,	/* set policy: allow traffic */
332 	IEEE80211_MACCMD_POLICY_DENY	= 2,	/* set policy: deny traffic */
333 	IEEE80211_MACCMD_FLUSH		= 3,	/* flush ACL database */
334 	IEEE80211_MACCMD_DETACH		= 4,	/* detach ACL policy */
335 	IEEE80211_MACCMD_POLICY		= 5,	/* get ACL policy */
336 	IEEE80211_MACCMD_LIST		= 6,	/* get ACL database */
337 	IEEE80211_MACCMD_POLICY_RADIUS	= 7,	/* set policy: RADIUS managed */
338 };
339 
340 struct ieee80211req_maclist {
341 	uint8_t		ml_macaddr[IEEE80211_ADDR_LEN];
342 } __packed;
343 
344 /*
345  * Mesh Routing Table Operations.
346  */
347 enum {
348 	IEEE80211_MESH_RTCMD_LIST   = 0, /* list HWMP routing table */
349 	IEEE80211_MESH_RTCMD_FLUSH  = 1, /* flush HWMP routing table */
350 	IEEE80211_MESH_RTCMD_ADD    = 2, /* add entry to the table */
351 	IEEE80211_MESH_RTCMD_DELETE = 3, /* delete an entry from the table */
352 };
353 
354 struct ieee80211req_mesh_route {
355 	uint8_t		imr_flags;
356 #define	IEEE80211_MESHRT_FLAGS_DISCOVER	0x01
357 #define	IEEE80211_MESHRT_FLAGS_VALID	0x02
358 #define	IEEE80211_MESHRT_FLAGS_PROXY	0x04
359 #define	IEEE80211_MESHRT_FLAGS_GATE	0x08
360 	uint8_t		imr_dest[IEEE80211_ADDR_LEN];
361 	uint8_t		imr_nexthop[IEEE80211_ADDR_LEN];
362 	uint16_t	imr_nhops;
363 	uint8_t		imr_pad;
364 	uint32_t	imr_metric;
365 	uint32_t	imr_lifetime;
366 	uint32_t	imr_lastmseq;
367 };
368 
369 /*
370  * HWMP root modes
371  */
372 enum {
373 	IEEE80211_HWMP_ROOTMODE_DISABLED	= 0, 	/* disabled */
374 	IEEE80211_HWMP_ROOTMODE_NORMAL		= 1,	/* normal PREPs */
375 	IEEE80211_HWMP_ROOTMODE_PROACTIVE	= 2,	/* proactive PREPS */
376 	IEEE80211_HWMP_ROOTMODE_RANN		= 3,	/* use RANN elemid */
377 };
378 
379 /*
380  * Set the active channel list by IEEE channel #: each channel
381  * to be marked active is set in a bit vector.  Note this list is
382  * intersected with the available channel list in calculating
383  * the set of channels actually used in scanning.
384  */
385 struct ieee80211req_chanlist {
386 	uint8_t		ic_channels[32];	/* NB: can be variable length */
387 };
388 
389 /*
390  * Get the active channel list info.
391  */
392 struct ieee80211req_chaninfo {
393 	u_int	ic_nchans;
394 	struct ieee80211_channel ic_chans[1];	/* NB: variable length */
395 };
396 #define	IEEE80211_CHANINFO_SIZE(_nchan) \
397 	(sizeof(struct ieee80211req_chaninfo) + \
398 	 (((_nchan)-1) * sizeof(struct ieee80211_channel)))
399 #define	IEEE80211_CHANINFO_SPACE(_ci) \
400 	IEEE80211_CHANINFO_SIZE((_ci)->ic_nchans)
401 
402 /*
403  * Retrieve the WPA/RSN information element for an associated station.
404  */
405 struct ieee80211req_wpaie {	/* old version w/ only one ie */
406 	uint8_t		wpa_macaddr[IEEE80211_ADDR_LEN];
407 	uint8_t		wpa_ie[IEEE80211_MAX_OPT_IE];
408 };
409 struct ieee80211req_wpaie2 {
410 	uint8_t		wpa_macaddr[IEEE80211_ADDR_LEN];
411 	uint8_t		wpa_ie[IEEE80211_MAX_OPT_IE];
412 	uint8_t		rsn_ie[IEEE80211_MAX_OPT_IE];
413 };
414 
415 /*
416  * Retrieve per-node statistics.
417  */
418 struct ieee80211req_sta_stats {
419 	union {
420 		/* NB: explicitly force 64-bit alignment */
421 		uint8_t		macaddr[IEEE80211_ADDR_LEN];
422 		uint64_t	pad;
423 	} is_u;
424 	struct ieee80211_nodestats is_stats;
425 };
426 
427 /*
428  * Station information block; the mac address is used
429  * to retrieve other data like stats, unicast key, etc.
430  */
431 struct ieee80211req_sta_info {
432 	uint16_t	isi_len;		/* total length (mult of 4) */
433 	uint16_t	isi_ie_off;		/* offset to IE data */
434 	uint16_t	isi_ie_len;		/* IE length */
435 	uint16_t	isi_freq;		/* MHz */
436 	uint32_t	isi_flags;		/* channel flags */
437 	uint32_t	isi_state;		/* state flags */
438 	uint8_t		isi_authmode;		/* authentication algorithm */
439 	int8_t		isi_rssi;		/* receive signal strength */
440 	int8_t		isi_noise;		/* noise floor */
441 	uint8_t		isi_capinfo;		/* capabilities */
442 	uint8_t		isi_erp;		/* ERP element */
443 	uint8_t		isi_macaddr[IEEE80211_ADDR_LEN];
444 	uint8_t		isi_nrates;
445 						/* negotiated rates */
446 	uint8_t		isi_rates[IEEE80211_RATE_MAXSIZE];
447 	uint8_t		isi_txrate;		/* legacy/IEEE rate or MCS */
448 	uint16_t	isi_associd;		/* assoc response */
449 	uint16_t	isi_txpower;		/* current tx power */
450 	uint16_t	isi_vlan;		/* vlan tag */
451 	/* NB: [IEEE80211_NONQOS_TID] holds seq#'s for non-QoS stations */
452 	uint16_t	isi_txseqs[IEEE80211_TID_SIZE];/* tx seq #/TID */
453 	uint16_t	isi_rxseqs[IEEE80211_TID_SIZE];/* rx seq#/TID */
454 	uint16_t	isi_inact;		/* inactivity timer */
455 	uint16_t	isi_txmbps;		/* current tx rate in .5 Mb/s */
456 	uint16_t	isi_pad;
457 	uint32_t	isi_jointime;		/* time of assoc/join */
458 	struct ieee80211_mimo_info isi_mimo;	/* MIMO info for 11n sta's */
459 	/* 11s info */
460 	uint16_t	isi_peerid;
461 	uint16_t	isi_localid;
462 	uint8_t		isi_peerstate;
463 	/* XXX frag state? */
464 	/* variable length IE data */
465 };
466 
467 /*
468  * Retrieve per-station information; to retrieve all
469  * specify a mac address of ff:ff:ff:ff:ff:ff.
470  */
471 struct ieee80211req_sta_req {
472 	union {
473 		/* NB: explicitly force 64-bit alignment */
474 		uint8_t		macaddr[IEEE80211_ADDR_LEN];
475 		uint64_t	pad;
476 	} is_u;
477 	struct ieee80211req_sta_info info[1];	/* variable length */
478 };
479 
480 /*
481  * Get/set per-station tx power cap.
482  */
483 struct ieee80211req_sta_txpow {
484 	uint8_t		it_macaddr[IEEE80211_ADDR_LEN];
485 	uint8_t		it_txpow;
486 };
487 
488 /*
489  * WME parameters manipulated with IEEE80211_IOC_WME_CWMIN
490  * through IEEE80211_IOC_WME_ACKPOLICY are set and return
491  * using i_val and i_len.  i_val holds the value itself.
492  * i_len specifies the AC and, as appropriate, then high bit
493  * specifies whether the operation is to be applied to the
494  * BSS or ourself.
495  */
496 #define	IEEE80211_WMEPARAM_SELF	0x0000		/* parameter applies to self */
497 #define	IEEE80211_WMEPARAM_BSS	0x8000		/* parameter applies to BSS */
498 #define	IEEE80211_WMEPARAM_VAL	0x7fff		/* parameter value */
499 
500 /*
501  * Application Information Elements can be appended to a variety
502  * of frames with the IEE80211_IOC_APPIE request.  This request
503  * piggybacks on a normal ieee80211req; the frame type is passed
504  * in i_val as the 802.11 FC0 bytes and the length of the IE data
505  * is passed in i_len.  The data is referenced in i_data.  If i_len
506  * is zero then any previously configured IE data is removed.  At
507  * most IEEE80211_MAX_APPIE data be appened.  Note that multiple
508  * IE's can be supplied; the data is treated opaquely.
509  */
510 #define	IEEE80211_MAX_APPIE	1024		/* max app IE data */
511 /*
512  * Hack: the WPA authenticator uses this mechanism to specify WPA
513  * ie's that are used instead of the ones normally constructed using
514  * the cipher state setup with separate ioctls.  This avoids issues
515  * like the authenticator ordering ie data differently than the
516  * net80211 layer and needing to keep separate state for WPA and RSN.
517  */
518 #define	IEEE80211_APPIE_WPA \
519 	(IEEE80211_FC0_TYPE_MGT | IEEE80211_FC0_SUBTYPE_BEACON | \
520 	 IEEE80211_FC0_SUBTYPE_PROBE_RESP)
521 
522 /*
523  * Station mode roaming parameters.  These are maintained
524  * per band/mode and control the roaming algorithm.
525  */
526 struct ieee80211_roamparams_req {
527 	struct ieee80211_roamparam params[IEEE80211_MODE_MAX];
528 };
529 
530 /*
531  * Transmit parameters.  These can be used to set fixed transmit
532  * rate for each operating mode when operating as client or on a
533  * per-client basis according to the capabilities of the client
534  * (e.g. an 11b client associated to an 11g ap) when operating as
535  * an ap.
536  *
537  * MCS are distinguished from legacy rates by or'ing in 0x80.
538  */
539 struct ieee80211_txparams_req {
540 	struct ieee80211_txparam params[IEEE80211_MODE_MAX];
541 };
542 
543 /*
544  * Set regulatory domain state with IEEE80211_IOC_REGDOMAIN.
545  * Note this is both the regulatory description and the channel
546  * list.  The get request for IEEE80211_IOC_REGDOMAIN returns
547  * only the regdomain info; the channel list is obtained
548  * separately with IEEE80211_IOC_CHANINFO.
549  */
550 struct ieee80211_regdomain_req {
551 	struct ieee80211_regdomain	rd;
552 	struct ieee80211req_chaninfo	chaninfo;
553 };
554 #define	IEEE80211_REGDOMAIN_SIZE(_nchan) \
555 	(sizeof(struct ieee80211_regdomain_req) + \
556 	 (((_nchan)-1) * sizeof(struct ieee80211_channel)))
557 #define	IEEE80211_REGDOMAIN_SPACE(_req) \
558 	IEEE80211_REGDOMAIN_SIZE((_req)->chaninfo.ic_nchans)
559 
560 /*
561  * Get driver capabilities.  Driver, hardware/software crypto, and
562  * HT/802.11n capabilities, and a table that describes what
563  * the radio can do.
564  */
565 struct ieee80211_devcaps_req {
566 	uint32_t	dc_drivercaps;		/* general driver caps */
567 	uint32_t	dc_cryptocaps;		/* software + hardware crypto support */
568 	uint32_t	dc_htcaps;		/* HT/802.11n support */
569 	uint32_t	dc_vhtcaps;		/* VHT/802.11ac capabilities */
570 	struct ieee80211req_chaninfo dc_chaninfo;
571 };
572 #define	IEEE80211_DEVCAPS_SIZE(_nchan) \
573 	(sizeof(struct ieee80211_devcaps_req) + \
574 	 (((_nchan)-1) * sizeof(struct ieee80211_channel)))
575 #define	IEEE80211_DEVCAPS_SPACE(_dc) \
576 	IEEE80211_DEVCAPS_SIZE((_dc)->dc_chaninfo.ic_nchans)
577 
578 struct ieee80211_chanswitch_req {
579 	struct ieee80211_channel csa_chan;	/* new channel */
580 	int		csa_mode;		/* CSA mode */
581 	int		csa_count;		/* beacon count to switch */
582 };
583 
584 /*
585  * Get/set per-station vlan tag.
586  */
587 struct ieee80211req_sta_vlan {
588 	uint8_t		sv_macaddr[IEEE80211_ADDR_LEN];
589 	uint16_t	sv_vlan;
590 };
591 
592 #ifdef __FreeBSD__
593 /*
594  * FreeBSD-style ioctls.
595  */
596 /* the first member must be matched with struct ifreq */
597 struct ieee80211req {
598 	char		i_name[IFNAMSIZ];	/* if_name, e.g. "wi0" */
599 	uint16_t	i_type;			/* req type */
600 	int16_t		i_val;			/* Index or simple value */
601 	uint16_t	i_len;			/* Index or simple value */
602 	void		*i_data;		/* Extra data */
603 };
604 #define	SIOCS80211		 _IOW('i', 234, struct ieee80211req)
605 #define	SIOCG80211		_IOWR('i', 235, struct ieee80211req)
606 #define	SIOCG80211STATS		_IOWR('i', 236, struct ifreq)
607 
608 #define IEEE80211_IOC_SSID		1
609 #define IEEE80211_IOC_NUMSSIDS		2
610 #define IEEE80211_IOC_WEP		3
611 #define 	IEEE80211_WEP_NOSUP	-1
612 #define 	IEEE80211_WEP_OFF	0
613 #define 	IEEE80211_WEP_ON	1
614 #define 	IEEE80211_WEP_MIXED	2
615 #define IEEE80211_IOC_WEPKEY		4
616 #define IEEE80211_IOC_NUMWEPKEYS	5
617 #define IEEE80211_IOC_WEPTXKEY		6
618 #define IEEE80211_IOC_AUTHMODE		7
619 #define IEEE80211_IOC_STATIONNAME	8
620 #define IEEE80211_IOC_CHANNEL		9
621 #define IEEE80211_IOC_POWERSAVE		10
622 #define 	IEEE80211_POWERSAVE_NOSUP	-1
623 #define 	IEEE80211_POWERSAVE_OFF		0
624 #define 	IEEE80211_POWERSAVE_CAM		1
625 #define 	IEEE80211_POWERSAVE_PSP		2
626 #define 	IEEE80211_POWERSAVE_PSP_CAM	3
627 #define 	IEEE80211_POWERSAVE_ON		IEEE80211_POWERSAVE_CAM
628 #define IEEE80211_IOC_POWERSAVESLEEP	11
629 #define	IEEE80211_IOC_RTSTHRESHOLD	12
630 #define IEEE80211_IOC_PROTMODE		13
631 #define 	IEEE80211_PROTMODE_OFF		0
632 #define 	IEEE80211_PROTMODE_CTS		1
633 #define 	IEEE80211_PROTMODE_RTSCTS	2
634 #define	IEEE80211_IOC_TXPOWER		14	/* global tx power limit */
635 #define	IEEE80211_IOC_BSSID		15
636 #define	IEEE80211_IOC_ROAMING		16	/* roaming mode */
637 #define	IEEE80211_IOC_PRIVACY		17	/* privacy invoked */
638 #define	IEEE80211_IOC_DROPUNENCRYPTED	18	/* discard unencrypted frames */
639 #define	IEEE80211_IOC_WPAKEY		19
640 #define	IEEE80211_IOC_DELKEY		20
641 #define	IEEE80211_IOC_MLME		21
642 /* 22 was IEEE80211_IOC_OPTIE, replaced by IEEE80211_IOC_APPIE */
643 /* 23 was IEEE80211_IOC_SCAN_REQ */
644 /* 24 was IEEE80211_IOC_SCAN_RESULTS */
645 #define	IEEE80211_IOC_COUNTERMEASURES	25	/* WPA/TKIP countermeasures */
646 #define	IEEE80211_IOC_WPA		26	/* WPA mode (0,1,2) */
647 #define	IEEE80211_IOC_CHANLIST		27	/* channel list */
648 #define	IEEE80211_IOC_WME		28	/* WME mode (on, off) */
649 #define	IEEE80211_IOC_HIDESSID		29	/* hide SSID mode (on, off) */
650 #define	IEEE80211_IOC_APBRIDGE		30	/* AP inter-sta bridging */
651 /* 31-35,37-38 were for WPA authenticator settings */
652 /* 36 was IEEE80211_IOC_DRIVER_CAPS */
653 #define	IEEE80211_IOC_WPAIE		39	/* WPA information element */
654 #define	IEEE80211_IOC_STA_STATS		40	/* per-station statistics */
655 #define	IEEE80211_IOC_MACCMD		41	/* MAC ACL operation */
656 #define	IEEE80211_IOC_CHANINFO		42	/* channel info list */
657 #define	IEEE80211_IOC_TXPOWMAX		43	/* max tx power for channel */
658 #define	IEEE80211_IOC_STA_TXPOW		44	/* per-station tx power limit */
659 /* 45 was IEEE80211_IOC_STA_INFO */
660 #define	IEEE80211_IOC_WME_CWMIN		46	/* WME: ECWmin */
661 #define	IEEE80211_IOC_WME_CWMAX		47	/* WME: ECWmax */
662 #define	IEEE80211_IOC_WME_AIFS		48	/* WME: AIFSN */
663 #define	IEEE80211_IOC_WME_TXOPLIMIT	49	/* WME: txops limit */
664 #define	IEEE80211_IOC_WME_ACM		50	/* WME: ACM (bss only) */
665 #define	IEEE80211_IOC_WME_ACKPOLICY	51	/* WME: ACK policy (!bss only)*/
666 #define	IEEE80211_IOC_DTIM_PERIOD	52	/* DTIM period (beacons) */
667 #define	IEEE80211_IOC_BEACON_INTERVAL	53	/* beacon interval (ms) */
668 #define	IEEE80211_IOC_ADDMAC		54	/* add sta to MAC ACL table */
669 #define	IEEE80211_IOC_DELMAC		55	/* del sta from MAC ACL table */
670 #define	IEEE80211_IOC_PUREG		56	/* pure 11g (no 11b stations) */
671 #define	IEEE80211_IOC_FF		57	/* ATH fast frames (on, off) */
672 #define	IEEE80211_IOC_TURBOP		58	/* ATH turbo' (on, off) */
673 #define	IEEE80211_IOC_BGSCAN		59	/* bg scanning (on, off) */
674 #define	IEEE80211_IOC_BGSCAN_IDLE	60	/* bg scan idle threshold */
675 #define	IEEE80211_IOC_BGSCAN_INTERVAL	61	/* bg scan interval */
676 #define	IEEE80211_IOC_SCANVALID		65	/* scan cache valid threshold */
677 /* 66-72 were IEEE80211_IOC_ROAM_* and IEEE80211_IOC_MCAST_RATE */
678 #define	IEEE80211_IOC_FRAGTHRESHOLD	73	/* tx fragmentation threshold */
679 #define	IEEE80211_IOC_BURST		75	/* packet bursting */
680 #define	IEEE80211_IOC_SCAN_RESULTS	76	/* get scan results */
681 #define	IEEE80211_IOC_BMISSTHRESHOLD	77	/* beacon miss threshold */
682 #define	IEEE80211_IOC_STA_INFO		78	/* station/neighbor info */
683 #define	IEEE80211_IOC_WPAIE2		79	/* WPA+RSN info elements */
684 #define	IEEE80211_IOC_CURCHAN		80	/* current channel */
685 #define	IEEE80211_IOC_SHORTGI		81	/* 802.11n half GI */
686 #define	IEEE80211_IOC_AMPDU		82	/* 802.11n A-MPDU (on, off) */
687 #define	IEEE80211_IOC_AMPDU_LIMIT	83	/* A-MPDU length limit */
688 #define	IEEE80211_IOC_AMPDU_DENSITY	84	/* A-MPDU density */
689 #define	IEEE80211_IOC_AMSDU		85	/* 802.11n A-MSDU (on, off) */
690 #define	IEEE80211_IOC_AMSDU_LIMIT	86	/* A-MSDU length limit */
691 #define	IEEE80211_IOC_PUREN		87	/* pure 11n (no legacy sta's) */
692 #define	IEEE80211_IOC_DOTH		88	/* 802.11h (on, off) */
693 /* 89-91 were regulatory items */
694 #define	IEEE80211_IOC_HTCOMPAT		92	/* support pre-D1.10 HT ie's */
695 #define	IEEE80211_IOC_DWDS		93	/* DWDS/4-address handling */
696 #define	IEEE80211_IOC_INACTIVITY	94	/* sta inactivity handling */
697 #define	IEEE80211_IOC_APPIE		95	/* application IE's */
698 #define	IEEE80211_IOC_WPS		96	/* WPS operation */
699 #define	IEEE80211_IOC_TSN		97	/* TSN operation */
700 #define	IEEE80211_IOC_DEVCAPS		98	/* driver+device capabilities */
701 #define	IEEE80211_IOC_CHANSWITCH	99	/* start 11h channel switch */
702 #define	IEEE80211_IOC_DFS		100	/* DFS (on, off) */
703 #define	IEEE80211_IOC_DOTD		101	/* 802.11d (on, off) */
704 #define IEEE80211_IOC_HTPROTMODE	102	/* HT protection (off, rts) */
705 #define	IEEE80211_IOC_SCAN_REQ		103	/* scan w/ specified params */
706 #define	IEEE80211_IOC_SCAN_CANCEL	104	/* cancel ongoing scan */
707 #define	IEEE80211_IOC_HTCONF		105	/* HT config (off, HT20, HT40)*/
708 #define	IEEE80211_IOC_REGDOMAIN		106	/* regulatory domain info */
709 #define	IEEE80211_IOC_ROAM		107	/* roaming params en masse */
710 #define	IEEE80211_IOC_TXPARAMS		108	/* tx parameters */
711 #define	IEEE80211_IOC_STA_VLAN		109	/* per-station vlan tag */
712 #define	IEEE80211_IOC_SMPS		110	/* MIMO power save */
713 #define	IEEE80211_IOC_RIFS		111	/* RIFS config (on, off) */
714 #define	IEEE80211_IOC_GREENFIELD	112	/* Greenfield (on, off) */
715 #define	IEEE80211_IOC_STBC		113	/* STBC Tx/RX (on, off) */
716 #define	IEEE80211_IOC_LDPC		114	/* LDPC Tx/RX (on, off) */
717 #define	IEEE80211_IOC_UAPSD		115	/* UAPSD (on, off) */
718 #define	IEEE80211_IOC_UAPSD_INFO	116	/* UAPSD (SP, per-AC enable) */
719 
720 /* VHT */
721 #define	IEEE80211_IOC_VHTCONF		130	/* VHT config (off, on; widths) */
722 
723 #define	IEEE80211_IOC_MESH_ID		170	/* mesh identifier */
724 #define	IEEE80211_IOC_MESH_AP		171	/* accepting peerings */
725 #define	IEEE80211_IOC_MESH_FWRD		172	/* forward frames */
726 #define	IEEE80211_IOC_MESH_PROTO	173	/* mesh protocols */
727 #define	IEEE80211_IOC_MESH_TTL		174	/* mesh TTL */
728 #define	IEEE80211_IOC_MESH_RTCMD	175	/* mesh routing table commands*/
729 #define	IEEE80211_IOC_MESH_PR_METRIC	176	/* mesh metric protocol */
730 #define	IEEE80211_IOC_MESH_PR_PATH	177	/* mesh path protocol */
731 #define	IEEE80211_IOC_MESH_PR_SIG	178	/* mesh sig protocol */
732 #define	IEEE80211_IOC_MESH_PR_CC	179	/* mesh congestion protocol */
733 #define	IEEE80211_IOC_MESH_PR_AUTH	180	/* mesh auth protocol */
734 #define	IEEE80211_IOC_MESH_GATE		181	/* mesh gate XXX: 173? */
735 
736 #define	IEEE80211_IOC_HWMP_ROOTMODE	190	/* HWMP root mode */
737 #define	IEEE80211_IOC_HWMP_MAXHOPS	191	/* number of hops before drop */
738 #define	IEEE80211_IOC_HWMP_TTL		192	/* HWMP TTL */
739 
740 #define	IEEE80211_IOC_TDMA_SLOT		201	/* TDMA: assigned slot */
741 #define	IEEE80211_IOC_TDMA_SLOTCNT	202	/* TDMA: slots in bss */
742 #define	IEEE80211_IOC_TDMA_SLOTLEN	203	/* TDMA: slot length (usecs) */
743 #define	IEEE80211_IOC_TDMA_BINTERVAL	204	/* TDMA: beacon intvl (slots) */
744 
745 #define	IEEE80211_IOC_QUIET		205	/* Quiet Enable/Disable */
746 #define	IEEE80211_IOC_QUIET_PERIOD	206	/* Quiet Period */
747 #define	IEEE80211_IOC_QUIET_OFFSET	207	/* Quiet Offset */
748 #define	IEEE80211_IOC_QUIET_DUR		208	/* Quiet Duration */
749 #define	IEEE80211_IOC_QUIET_COUNT	209	/* Quiet Count */
750 
751 #define	IEEE80211_IOC_IC_NAME		210	/* HW device name. */
752 
753 /*
754  * Parameters for controlling a scan requested with
755  * IEEE80211_IOC_SCAN_REQ.
756  *
757  * Active scans cause ProbeRequest frames to be issued for each
758  * specified ssid and, by default, a broadcast ProbeRequest frame.
759  * The set of ssid's is specified in the request.
760  *
761  * By default the scan will cause a BSS to be joined (in station/adhoc
762  * mode) or a channel to be selected for operation (hostap mode).
763  * To disable that specify IEEE80211_IOC_SCAN_NOPICK and if the
764  *
765  * If the station is currently associated to an AP then a scan request
766  * will cause the station to leave the current channel and potentially
767  * miss frames from the AP.  Alternatively the station may notify the
768  * AP that it is going into power save mode before it leaves the channel.
769  * This ensures frames for the station are buffered by the AP.  This is
770  * termed a ``bg scan'' and is requested with the IEEE80211_IOC_SCAN_BGSCAN
771  * flag.  Background scans may take longer than foreground scans and may
772  * be preempted by traffic.  If a station is not associated to an AP
773  * then a request for a background scan is automatically done in the
774  * foreground.
775  *
776  * The results of the scan request are cached by the system.  This
777  * information is aged out and/or invalidated based on events like not
778  * being able to associated to an AP.  To flush the current cache
779  * contents before doing a scan the IEEE80211_IOC_SCAN_FLUSH flag may
780  * be specified.
781  *
782  * By default the scan will be done until a suitable AP is located
783  * or a channel is found for use.  A scan can also be constrained
784  * to be done once (IEEE80211_IOC_SCAN_ONCE) or to last for no more
785  * than a specified duration.
786  */
787 struct ieee80211_scan_req {
788 	int		sr_flags;
789 #define	IEEE80211_IOC_SCAN_NOPICK	0x00001	/* scan only, no selection */
790 #define	IEEE80211_IOC_SCAN_ACTIVE	0x00002	/* active scan (probe req) */
791 #define	IEEE80211_IOC_SCAN_PICK1ST	0x00004	/* ``hey sailor'' mode */
792 #define	IEEE80211_IOC_SCAN_BGSCAN	0x00008	/* bg scan, exit ps at end */
793 #define	IEEE80211_IOC_SCAN_ONCE		0x00010	/* do one complete pass */
794 #define	IEEE80211_IOC_SCAN_NOBCAST	0x00020	/* don't send bcast probe req */
795 #define	IEEE80211_IOC_SCAN_NOJOIN	0x00040	/* no auto-sequencing */
796 #define	IEEE80211_IOC_SCAN_FLUSH	0x10000	/* flush scan cache first */
797 #define	IEEE80211_IOC_SCAN_CHECK	0x20000	/* check scan cache first */
798 	u_int		sr_duration;		/* duration (ms) */
799 #define	IEEE80211_IOC_SCAN_DURATION_MIN	1
800 #define	IEEE80211_IOC_SCAN_DURATION_MAX	0x7fffffff
801 #define	IEEE80211_IOC_SCAN_FOREVER	IEEE80211_IOC_SCAN_DURATION_MAX
802 	u_int		sr_mindwell;		/* min channel dwelltime (ms) */
803 	u_int		sr_maxdwell;		/* max channel dwelltime (ms) */
804 	int		sr_nssid;
805 #define	IEEE80211_IOC_SCAN_MAX_SSID	3
806 	struct {
807 		int	 len;				/* length in bytes */
808 		uint8_t ssid[IEEE80211_NWID_LEN];	/* ssid contents */
809 	} sr_ssid[IEEE80211_IOC_SCAN_MAX_SSID];
810 };
811 
812 /*
813  * Scan result data returned for IEEE80211_IOC_SCAN_RESULTS.
814  * Each result is a fixed size structure followed by a variable
815  * length SSID and one or more variable length information elements.
816  * The size of each variable length item is found in the fixed
817  * size structure and the entire length of the record is specified
818  * in isr_len.  Result records are rounded to a multiple of 4 bytes.
819  */
820 struct ieee80211req_scan_result {
821 	uint16_t	isr_len;		/* total length (mult of 4) */
822 	uint16_t	isr_ie_off;		/* offset to SSID+IE data */
823 	uint16_t	isr_ie_len;		/* IE length */
824 	uint16_t	isr_freq;		/* MHz */
825 	uint16_t	isr_flags;		/* channel flags */
826 	int8_t		isr_noise;
827 	int8_t		isr_rssi;
828 	uint16_t	isr_intval;		/* beacon interval */
829 	uint8_t		isr_capinfo;		/* capabilities */
830 	uint8_t		isr_erp;		/* ERP element */
831 	uint8_t		isr_bssid[IEEE80211_ADDR_LEN];
832 	uint8_t		isr_nrates;
833 	uint8_t		isr_rates[IEEE80211_RATE_MAXSIZE];
834 	uint8_t		isr_ssid_len;		/* SSID length */
835 	uint8_t		isr_meshid_len;		/* MESH ID length */
836 	/* variable length SSID, followed by variable length MESH ID,
837 	  followed by IE data */
838 };
839 
840 /*
841  * Virtual AP cloning parameters.  The parent device must
842  * be a vap-capable device.  All parameters specified with
843  * the clone request are fixed for the lifetime of the vap.
844  *
845  * There are two flavors of WDS vaps: legacy and dynamic.
846  * Legacy WDS operation implements a static binding between
847  * two stations encapsulating traffic in 4-address frames.
848  * Dynamic WDS vaps are created when a station associates to
849  * an AP and sends a 4-address frame.  If the AP vap is
850  * configured to support WDS then this will generate an
851  * event to user programs listening on the routing socket
852  * and a Dynamic WDS vap will be created to handle traffic
853  * to/from that station.  In both cases the bssid of the
854  * peer must be specified when creating the vap.
855  *
856  * By default a vap will inherit the mac address/bssid of
857  * the underlying device.  To request a unique address the
858  * IEEE80211_CLONE_BSSID flag should be supplied.  This is
859  * meaningless for WDS vaps as they share the bssid of an
860  * AP vap that must otherwise exist.  Note that some devices
861  * may not be able to support multiple addresses.
862  *
863  * Station mode vap's normally depend on the device to notice
864  * when the AP stops sending beacon frames.  If IEEE80211_CLONE_NOBEACONS
865  * is specified the net80211 layer will do this in s/w.  This
866  * is mostly useful when setting up a WDS repeater/extender where
867  * an AP vap is combined with a sta vap and the device isn't able
868  * to track beacon frames in hardware.
869  */
870 struct ieee80211_clone_params {
871 	char	icp_parent[IFNAMSIZ];		/* parent device */
872 	uint16_t icp_opmode;			/* operating mode */
873 	uint16_t icp_flags;			/* see below */
874 	uint8_t	icp_bssid[IEEE80211_ADDR_LEN];	/* for WDS links */
875 	uint8_t	icp_macaddr[IEEE80211_ADDR_LEN];/* local address */
876 };
877 #define	IEEE80211_CLONE_BSSID		0x0001	/* allocate unique mac/bssid */
878 #define	IEEE80211_CLONE_NOBEACONS	0x0002	/* don't setup beacon timers */
879 #define	IEEE80211_CLONE_WDSLEGACY	0x0004	/* legacy WDS processing */
880 #define	IEEE80211_CLONE_MACADDR		0x0008	/* use specified mac addr */
881 #define	IEEE80211_CLONE_TDMA		0x0010	/* operate in TDMA mode */
882 #endif /* __FreeBSD__ */
883 
884 #endif /* _NET80211_IEEE80211_IOCTL_H_ */
885