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