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