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_PROTO_H_
31 #define _NET80211_IEEE80211_PROTO_H_
34 * 802.11 protocol implementation definitions.
37 enum ieee80211_state {
38 IEEE80211_S_INIT = 0, /* default state */
39 IEEE80211_S_SCAN = 1, /* scanning */
40 IEEE80211_S_AUTH = 2, /* try to authenticate */
41 IEEE80211_S_ASSOC = 3, /* try to assoc */
42 IEEE80211_S_CAC = 4, /* doing channel availability check */
43 IEEE80211_S_RUN = 5, /* operational (e.g. associated) */
44 IEEE80211_S_CSA = 6, /* channel switch announce pending */
45 IEEE80211_S_SLEEP = 7, /* power save */
47 #define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1)
49 #define IEEE80211_SEND_MGMT(_ni,_type,_arg) \
50 ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg))
52 extern const char *mgt_subtype_name[];
53 extern const char *ctl_subtype_name[];
54 extern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX];
55 extern const int ieee80211_opcap[IEEE80211_OPMODE_MAX];
57 static __inline const char *
58 ieee80211_mgt_subtype_name(uint8_t subtype)
60 return mgt_subtype_name[(subtype & IEEE80211_FC0_SUBTYPE_MASK) >>
61 IEEE80211_FC0_SUBTYPE_SHIFT];
64 static __inline const char *
65 ieee80211_ctl_subtype_name(uint8_t subtype)
67 return ctl_subtype_name[(subtype & IEEE80211_FC0_SUBTYPE_MASK) >>
68 IEEE80211_FC0_SUBTYPE_SHIFT];
71 const char *ieee80211_reason_to_string(uint16_t);
73 void ieee80211_proto_attach(struct ieee80211com *);
74 void ieee80211_proto_detach(struct ieee80211com *);
75 void ieee80211_proto_vattach(struct ieee80211vap *);
76 void ieee80211_proto_vdetach(struct ieee80211vap *);
78 void ieee80211_promisc(struct ieee80211vap *, bool);
79 void ieee80211_allmulti(struct ieee80211vap *, bool);
80 void ieee80211_syncflag(struct ieee80211vap *, int flag);
81 void ieee80211_syncflag_ht(struct ieee80211vap *, int flag);
82 void ieee80211_syncflag_vht(struct ieee80211vap *, int flag);
83 void ieee80211_syncflag_ext(struct ieee80211vap *, int flag);
85 #define ieee80211_input(ni, m, rssi, nf) \
86 ((ni)->ni_vap->iv_input(ni, m, NULL, rssi, nf))
87 int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
89 int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *);
90 int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *);
92 struct ieee80211_bpf_params;
93 int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
94 struct ieee80211_bpf_params *);
95 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
96 const struct ieee80211_bpf_params *);
97 int ieee80211_output(struct ifnet *, struct mbuf *,
98 const struct sockaddr *, struct route *ro);
99 int ieee80211_vap_pkt_send_dest(struct ieee80211vap *, struct mbuf *,
100 struct ieee80211_node *);
101 int ieee80211_raw_output(struct ieee80211vap *, struct ieee80211_node *,
102 struct mbuf *, const struct ieee80211_bpf_params *);
103 void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int,
104 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN],
105 const uint8_t [IEEE80211_ADDR_LEN]);
106 int ieee80211_vap_transmit(struct ifnet *ifp, struct mbuf *m);
107 void ieee80211_vap_qflush(struct ifnet *ifp);
108 int ieee80211_send_nulldata(struct ieee80211_node *);
109 int ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
110 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
111 struct ieee80211_key *, struct mbuf *);
112 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
114 void ieee80211_free_mbuf(struct mbuf *);
115 int ieee80211_send_mgmt(struct ieee80211_node *, int, int);
116 struct ieee80211_appie;
117 int ieee80211_send_probereq(struct ieee80211_node *ni,
118 const uint8_t sa[IEEE80211_ADDR_LEN],
119 const uint8_t da[IEEE80211_ADDR_LEN],
120 const uint8_t bssid[IEEE80211_ADDR_LEN],
121 const uint8_t *ssid, size_t ssidlen);
122 struct mbuf * ieee80211_ff_encap1(struct ieee80211vap *, struct mbuf *,
123 const struct ether_header *);
124 void ieee80211_tx_complete(struct ieee80211_node *,
128 * The formation of ProbeResponse frames requires guidance to
129 * deal with legacy clients. When the client is identified as
130 * "legacy 11b" ieee80211_send_proberesp is passed this token.
132 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */
133 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */
134 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */
135 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
136 int ieee80211_send_proberesp(struct ieee80211vap *,
137 const uint8_t da[IEEE80211_ADDR_LEN], int);
138 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
139 const uint8_t [IEEE80211_ADDR_LEN],
140 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
141 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
142 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
143 struct mbuf *ieee80211_alloc_prot(struct ieee80211_node *,
144 const struct mbuf *, uint8_t, int);
146 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
147 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
148 uint8_t *ieee80211_add_ssid(uint8_t *, const uint8_t *, u_int);
149 uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *);
150 uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *);
151 uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *);
152 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
153 struct ieee80211_channel *);
154 struct ieee80211_wme_state;
155 uint8_t * ieee80211_add_wme_info(uint8_t *frm, struct ieee80211_wme_state *wme,
156 struct ieee80211_node *ni);
158 void ieee80211_vap_reset_erp(struct ieee80211vap *);
159 void ieee80211_reset_erp(struct ieee80211com *);
160 void ieee80211_vap_set_shortslottime(struct ieee80211vap *, int onoff);
161 int ieee80211_iserp_rateset(const struct ieee80211_rateset *);
162 void ieee80211_setbasicrates(struct ieee80211_rateset *,
163 enum ieee80211_phymode);
164 void ieee80211_addbasicrates(struct ieee80211_rateset *,
165 enum ieee80211_phymode);
168 * Return the size of the 802.11 header for a management or data frame.
171 ieee80211_hdrsize(const void *data)
173 const struct ieee80211_frame *wh = data;
174 int size = sizeof(struct ieee80211_frame);
176 /* NB: we don't handle control frames */
177 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
178 ("%s: control frame", __func__));
179 if (IEEE80211_IS_DSTODS(wh))
180 size += IEEE80211_ADDR_LEN;
181 if (IEEE80211_QOS_HAS_SEQ(wh))
182 size += sizeof(uint16_t);
187 * Like ieee80211_hdrsize, but handles any type of frame.
190 ieee80211_anyhdrsize(const void *data)
192 const struct ieee80211_frame *wh = data;
194 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
195 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
196 case IEEE80211_FC0_SUBTYPE_CTS:
197 case IEEE80211_FC0_SUBTYPE_ACK:
198 return sizeof(struct ieee80211_frame_ack);
199 case IEEE80211_FC0_SUBTYPE_BAR:
200 return sizeof(struct ieee80211_frame_bar);
202 return sizeof(struct ieee80211_frame_min);
204 return ieee80211_hdrsize(data);
208 * Template for an in-kernel authenticator. Authenticators
209 * register with the protocol code and are typically loaded
210 * as separate modules as needed. One special authenticator
211 * is xauth; it intercepts requests so that protocols like
212 * WPA can be handled in user space.
214 struct ieee80211_authenticator {
215 const char *ia_name; /* printable name */
216 int (*ia_attach)(struct ieee80211vap *);
217 void (*ia_detach)(struct ieee80211vap *);
218 void (*ia_node_join)(struct ieee80211_node *);
219 void (*ia_node_leave)(struct ieee80211_node *);
221 void ieee80211_authenticator_register(int type,
222 const struct ieee80211_authenticator *);
223 void ieee80211_authenticator_unregister(int type);
224 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
228 * Template for an MAC ACL policy module. Such modules
229 * register with the protocol code and are passed the sender's
230 * address of each received auth frame for validation.
232 struct ieee80211_aclator {
233 const char *iac_name; /* printable name */
234 int (*iac_attach)(struct ieee80211vap *);
235 void (*iac_detach)(struct ieee80211vap *);
236 int (*iac_check)(struct ieee80211vap *,
237 const struct ieee80211_frame *wh);
238 int (*iac_add)(struct ieee80211vap *,
239 const uint8_t mac[IEEE80211_ADDR_LEN]);
240 int (*iac_remove)(struct ieee80211vap *,
241 const uint8_t mac[IEEE80211_ADDR_LEN]);
242 int (*iac_flush)(struct ieee80211vap *);
243 int (*iac_setpolicy)(struct ieee80211vap *, int);
244 int (*iac_getpolicy)(struct ieee80211vap *);
245 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
246 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
248 void ieee80211_aclator_register(const struct ieee80211_aclator *);
249 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
250 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
252 /* flags for ieee80211_fix_rate() */
253 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
254 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */
255 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
256 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
257 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
258 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
259 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */
260 int ieee80211_fix_rate(struct ieee80211_node *,
261 struct ieee80211_rateset *, int);
269 uint8_t wmep_logcwmin; /* log2(cwmin) */
270 uint8_t wmep_logcwmax; /* log2(cwmax) */
271 uint8_t wmep_txopLimit;
272 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
274 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
275 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
277 struct chanAccParams {
278 uint8_t cap_info; /* version of the current set */
279 struct wmeParams cap_wmeParams[WME_NUM_AC];
282 struct ieee80211_wme_state {
284 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME aggressive mode */
285 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
286 u_int wme_hipri_switch_thresh;/* aggressive mode switch thresh */
287 u_int wme_hipri_switch_hysteresis;/* aggressive mode switch hysteresis */
289 struct wmeParams wme_params[WME_NUM_AC]; /* from assoc resp for each AC */
290 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
291 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
292 struct chanAccParams wme_chanParams; /* params applied to self */
293 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
295 int (*wme_update)(struct ieee80211com *);
298 void ieee80211_wme_initparams(struct ieee80211vap *);
299 void ieee80211_wme_updateparams(struct ieee80211vap *);
300 void ieee80211_wme_updateparams_locked(struct ieee80211vap *);
301 void ieee80211_wme_vap_getparams(struct ieee80211vap *vap,
302 struct chanAccParams *);
303 void ieee80211_wme_ic_getparams(struct ieee80211com *ic,
304 struct chanAccParams *);
305 int ieee80211_wme_vap_ac_is_noack(struct ieee80211vap *vap, int ac);
306 void ieee80211_vap_update_preamble(struct ieee80211vap *vap);
307 void ieee80211_vap_update_erp_protmode(struct ieee80211vap *vap);
308 void ieee80211_vap_update_ht_protmode(struct ieee80211vap *vap);
311 * Return pointer to the QoS field from a Qos frame.
313 static __inline uint8_t *
314 ieee80211_getqos(void *data)
316 struct ieee80211_frame *wh = data;
318 KASSERT(IEEE80211_QOS_HAS_SEQ(wh), ("QoS field is absent!"));
320 if (IEEE80211_IS_DSTODS(wh))
321 return (((struct ieee80211_qosframe_addr4 *)wh)->i_qos);
323 return (((struct ieee80211_qosframe *)wh)->i_qos);
327 * Return the WME TID from a QoS frame. If no TID
328 * is present return the index for the "non-QoS" entry.
330 static __inline uint8_t
331 ieee80211_gettid(const struct ieee80211_frame *wh)
335 if (IEEE80211_QOS_HAS_SEQ(wh)) {
336 if (IEEE80211_IS_DSTODS(wh))
337 tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
340 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
341 tid &= IEEE80211_QOS_TID;
343 tid = IEEE80211_NONQOS_TID;
347 void ieee80211_waitfor_parent(struct ieee80211com *);
348 void ieee80211_start_locked(struct ieee80211vap *);
349 void ieee80211_init(void *);
350 void ieee80211_start_all(struct ieee80211com *);
351 void ieee80211_stop_locked(struct ieee80211vap *);
352 void ieee80211_stop(struct ieee80211vap *);
353 void ieee80211_stop_all(struct ieee80211com *);
354 void ieee80211_suspend_all(struct ieee80211com *);
355 void ieee80211_resume_all(struct ieee80211com *);
356 void ieee80211_restart_all(struct ieee80211com *);
357 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
358 void ieee80211_swbmiss(void *arg);
359 void ieee80211_beacon_miss(struct ieee80211com *);
360 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
361 int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state,
363 void ieee80211_print_essid(const uint8_t *, int);
364 void ieee80211_dump_pkt(struct ieee80211com *,
365 const uint8_t *, int, int, int);
367 extern const char *ieee80211_opmode_name[];
368 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
369 extern const char *ieee80211_wme_acnames[];
372 * Beacon frames constructed by ieee80211_beacon_alloc
373 * have the following structure filled in so drivers
374 * can update the frame later w/ minimal overhead.
376 struct ieee80211_beacon_offsets {
377 uint8_t bo_flags[4]; /* update/state flags */
378 uint16_t *bo_caps; /* capabilities */
379 uint8_t *bo_cfp; /* start of CFParms element */
380 uint8_t *bo_tim; /* start of atim/dtim */
381 uint8_t *bo_wme; /* start of WME parameters */
382 uint8_t *bo_tdma; /* start of TDMA parameters */
383 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
384 uint16_t bo_tim_len; /* atim/dtim length in bytes */
385 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
386 uint8_t *bo_erp; /* start of ERP element */
387 uint8_t *bo_htinfo; /* start of HT info element */
388 uint8_t *bo_ath; /* start of ATH parameters */
389 uint8_t *bo_appie; /* start of AppIE element */
390 uint16_t bo_appie_len; /* AppIE length in bytes */
391 uint16_t bo_csa_trailer_len;
392 uint8_t *bo_csa; /* start of CSA element */
393 uint8_t *bo_quiet; /* start of Quiet element */
394 uint8_t *bo_meshconf; /* start of MESHCONF element */
395 uint8_t *bo_vhtinfo; /* start of VHT info element (XXX VHTCAP?) */
396 uint8_t *bo_spare[2];
398 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *);
401 * Beacon frame updates are signaled through calls to iv_update_beacon
402 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
403 * that construct beacon frames on the host this can trigger a rebuild
404 * or defer the processing. For devices that offload beacon frame
405 * handling this callback can be used to signal a rebuild. The bo_flags
406 * array in the ieee80211_beacon_offsets structure is intended to record
407 * deferred processing requirements; ieee80211_beacon_update uses the
408 * state to optimize work. Since this structure is owned by the driver
409 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
410 * callback that marks the flag bits and schedules (as necessary) an update.
413 IEEE80211_BEACON_CAPS = 0, /* capabilities */
414 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
415 IEEE80211_BEACON_WME = 2,
416 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
417 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
418 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
419 IEEE80211_BEACON_CFP = 6, /* CFParms */
420 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
421 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */
422 IEEE80211_BEACON_ATH = 10, /* ATH parameters */
423 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
424 IEEE80211_BEACON_QUIET = 12, /* Quiet time IE */
425 IEEE80211_BEACON_VHTINFO = 13, /* VHT information */
427 int ieee80211_beacon_update(struct ieee80211_node *,
428 struct mbuf *, int mcast);
430 void ieee80211_csa_startswitch(struct ieee80211com *,
431 struct ieee80211_channel *, int mode, int count);
432 void ieee80211_csa_completeswitch(struct ieee80211com *);
433 void ieee80211_csa_cancelswitch(struct ieee80211com *);
434 void ieee80211_cac_completeswitch(struct ieee80211vap *);
437 * Notification methods called from the 802.11 state machine.
438 * Note that while these are defined here, their implementation
441 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
442 void ieee80211_notify_node_leave(struct ieee80211_node *);
443 void ieee80211_notify_scan_done(struct ieee80211vap *);
444 void ieee80211_notify_wds_discover(struct ieee80211_node *);
445 void ieee80211_notify_csa(struct ieee80211com *,
446 const struct ieee80211_channel *, int mode, int count);
447 void ieee80211_notify_radar(struct ieee80211com *,
448 const struct ieee80211_channel *);
449 enum ieee80211_notify_cac_event {
450 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */
451 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */
452 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */
453 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
455 void ieee80211_notify_cac(struct ieee80211com *,
456 const struct ieee80211_channel *,
457 enum ieee80211_notify_cac_event);
458 void ieee80211_notify_node_deauth(struct ieee80211_node *);
459 void ieee80211_notify_node_auth(struct ieee80211_node *);
460 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
461 const uint8_t cc[2]);
462 void ieee80211_notify_radio(struct ieee80211com *, int);
463 void ieee80211_notify_ifnet_change(struct ieee80211vap *);
464 #endif /* _NET80211_IEEE80211_PROTO_H_ */