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);
144 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
145 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
146 uint8_t *ieee80211_add_ssid(uint8_t *, const uint8_t *, u_int);
147 uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *);
148 uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *);
149 uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *);
150 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
151 struct ieee80211_channel *);
152 struct ieee80211_wme_state;
153 uint8_t * ieee80211_add_wme_info(uint8_t *frm, struct ieee80211_wme_state *wme);
155 void ieee80211_reset_erp(struct ieee80211com *);
156 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
157 int ieee80211_iserp_rateset(const struct ieee80211_rateset *);
158 void ieee80211_setbasicrates(struct ieee80211_rateset *,
159 enum ieee80211_phymode);
160 void ieee80211_addbasicrates(struct ieee80211_rateset *,
161 enum ieee80211_phymode);
164 * Return the size of the 802.11 header for a management or data frame.
167 ieee80211_hdrsize(const void *data)
169 const struct ieee80211_frame *wh = data;
170 int size = sizeof(struct ieee80211_frame);
172 /* NB: we don't handle control frames */
173 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
174 ("%s: control frame", __func__));
175 if (IEEE80211_IS_DSTODS(wh))
176 size += IEEE80211_ADDR_LEN;
177 if (IEEE80211_QOS_HAS_SEQ(wh))
178 size += sizeof(uint16_t);
183 * Like ieee80211_hdrsize, but handles any type of frame.
186 ieee80211_anyhdrsize(const void *data)
188 const struct ieee80211_frame *wh = data;
190 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
191 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
192 case IEEE80211_FC0_SUBTYPE_CTS:
193 case IEEE80211_FC0_SUBTYPE_ACK:
194 return sizeof(struct ieee80211_frame_ack);
195 case IEEE80211_FC0_SUBTYPE_BAR:
196 return sizeof(struct ieee80211_frame_bar);
198 return sizeof(struct ieee80211_frame_min);
200 return ieee80211_hdrsize(data);
204 * Template for an in-kernel authenticator. Authenticators
205 * register with the protocol code and are typically loaded
206 * as separate modules as needed. One special authenticator
207 * is xauth; it intercepts requests so that protocols like
208 * WPA can be handled in user space.
210 struct ieee80211_authenticator {
211 const char *ia_name; /* printable name */
212 int (*ia_attach)(struct ieee80211vap *);
213 void (*ia_detach)(struct ieee80211vap *);
214 void (*ia_node_join)(struct ieee80211_node *);
215 void (*ia_node_leave)(struct ieee80211_node *);
217 void ieee80211_authenticator_register(int type,
218 const struct ieee80211_authenticator *);
219 void ieee80211_authenticator_unregister(int type);
220 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
224 * Template for an MAC ACL policy module. Such modules
225 * register with the protocol code and are passed the sender's
226 * address of each received auth frame for validation.
228 struct ieee80211_aclator {
229 const char *iac_name; /* printable name */
230 int (*iac_attach)(struct ieee80211vap *);
231 void (*iac_detach)(struct ieee80211vap *);
232 int (*iac_check)(struct ieee80211vap *,
233 const struct ieee80211_frame *wh);
234 int (*iac_add)(struct ieee80211vap *,
235 const uint8_t mac[IEEE80211_ADDR_LEN]);
236 int (*iac_remove)(struct ieee80211vap *,
237 const uint8_t mac[IEEE80211_ADDR_LEN]);
238 int (*iac_flush)(struct ieee80211vap *);
239 int (*iac_setpolicy)(struct ieee80211vap *, int);
240 int (*iac_getpolicy)(struct ieee80211vap *);
241 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
242 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
244 void ieee80211_aclator_register(const struct ieee80211_aclator *);
245 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
246 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
248 /* flags for ieee80211_fix_rate() */
249 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
250 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */
251 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
252 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
253 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
254 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
255 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */
256 int ieee80211_fix_rate(struct ieee80211_node *,
257 struct ieee80211_rateset *, int);
265 uint8_t wmep_logcwmin; /* log2(cwmin) */
266 uint8_t wmep_logcwmax; /* log2(cwmax) */
267 uint8_t wmep_txopLimit;
268 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
270 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
271 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
273 struct chanAccParams {
274 uint8_t cap_info; /* version of the current set */
275 struct wmeParams cap_wmeParams[WME_NUM_AC];
278 struct ieee80211_wme_state {
280 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME aggressive mode */
281 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
282 u_int wme_hipri_switch_thresh;/* aggressive mode switch thresh */
283 u_int wme_hipri_switch_hysteresis;/* aggressive mode switch hysteresis */
285 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
286 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
287 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
288 struct chanAccParams wme_chanParams; /* params applied to self */
289 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
291 int (*wme_update)(struct ieee80211com *);
294 void ieee80211_wme_initparams(struct ieee80211vap *);
295 void ieee80211_wme_updateparams(struct ieee80211vap *);
296 void ieee80211_wme_updateparams_locked(struct ieee80211vap *);
297 void ieee80211_wme_vap_getparams(struct ieee80211vap *vap,
298 struct chanAccParams *);
299 void ieee80211_wme_ic_getparams(struct ieee80211com *ic,
300 struct chanAccParams *);
301 int ieee80211_wme_vap_ac_is_noack(struct ieee80211vap *vap, int ac);
304 * Return the WME TID from a QoS frame. If no TID
305 * is present return the index for the "non-QoS" entry.
307 static __inline uint8_t
308 ieee80211_gettid(const struct ieee80211_frame *wh)
312 if (IEEE80211_QOS_HAS_SEQ(wh)) {
313 if (IEEE80211_IS_DSTODS(wh))
314 tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
317 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
318 tid &= IEEE80211_QOS_TID;
320 tid = IEEE80211_NONQOS_TID;
324 void ieee80211_waitfor_parent(struct ieee80211com *);
325 void ieee80211_start_locked(struct ieee80211vap *);
326 void ieee80211_init(void *);
327 void ieee80211_start_all(struct ieee80211com *);
328 void ieee80211_stop_locked(struct ieee80211vap *);
329 void ieee80211_stop(struct ieee80211vap *);
330 void ieee80211_stop_all(struct ieee80211com *);
331 void ieee80211_suspend_all(struct ieee80211com *);
332 void ieee80211_resume_all(struct ieee80211com *);
333 void ieee80211_restart_all(struct ieee80211com *);
334 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
335 void ieee80211_swbmiss(void *arg);
336 void ieee80211_beacon_miss(struct ieee80211com *);
337 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
338 int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state,
340 void ieee80211_print_essid(const uint8_t *, int);
341 void ieee80211_dump_pkt(struct ieee80211com *,
342 const uint8_t *, int, int, int);
344 extern const char *ieee80211_opmode_name[];
345 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
346 extern const char *ieee80211_wme_acnames[];
349 * Beacon frames constructed by ieee80211_beacon_alloc
350 * have the following structure filled in so drivers
351 * can update the frame later w/ minimal overhead.
353 struct ieee80211_beacon_offsets {
354 uint8_t bo_flags[4]; /* update/state flags */
355 uint16_t *bo_caps; /* capabilities */
356 uint8_t *bo_cfp; /* start of CFParms element */
357 uint8_t *bo_tim; /* start of atim/dtim */
358 uint8_t *bo_wme; /* start of WME parameters */
359 uint8_t *bo_tdma; /* start of TDMA parameters */
360 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
361 uint16_t bo_tim_len; /* atim/dtim length in bytes */
362 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
363 uint8_t *bo_erp; /* start of ERP element */
364 uint8_t *bo_htinfo; /* start of HT info element */
365 uint8_t *bo_ath; /* start of ATH parameters */
366 uint8_t *bo_appie; /* start of AppIE element */
367 uint16_t bo_appie_len; /* AppIE length in bytes */
368 uint16_t bo_csa_trailer_len;
369 uint8_t *bo_csa; /* start of CSA element */
370 uint8_t *bo_quiet; /* start of Quiet element */
371 uint8_t *bo_meshconf; /* start of MESHCONF element */
372 uint8_t *bo_vhtinfo; /* start of VHT info element (XXX VHTCAP?) */
373 uint8_t *bo_spare[2];
375 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *);
378 * Beacon frame updates are signaled through calls to iv_update_beacon
379 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
380 * that construct beacon frames on the host this can trigger a rebuild
381 * or defer the processing. For devices that offload beacon frame
382 * handling this callback can be used to signal a rebuild. The bo_flags
383 * array in the ieee80211_beacon_offsets structure is intended to record
384 * deferred processing requirements; ieee80211_beacon_update uses the
385 * state to optimize work. Since this structure is owned by the driver
386 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
387 * callback that marks the flag bits and schedules (as necessary) an update.
390 IEEE80211_BEACON_CAPS = 0, /* capabilities */
391 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
392 IEEE80211_BEACON_WME = 2,
393 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
394 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
395 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
396 IEEE80211_BEACON_CFP = 6, /* CFParms */
397 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
398 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */
399 IEEE80211_BEACON_ATH = 10, /* ATH parameters */
400 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
401 IEEE80211_BEACON_QUIET = 12, /* Quiet time IE */
402 IEEE80211_BEACON_VHTINFO = 13, /* VHT information */
404 int ieee80211_beacon_update(struct ieee80211_node *,
405 struct mbuf *, int mcast);
407 void ieee80211_csa_startswitch(struct ieee80211com *,
408 struct ieee80211_channel *, int mode, int count);
409 void ieee80211_csa_completeswitch(struct ieee80211com *);
410 void ieee80211_csa_cancelswitch(struct ieee80211com *);
411 void ieee80211_cac_completeswitch(struct ieee80211vap *);
414 * Notification methods called from the 802.11 state machine.
415 * Note that while these are defined here, their implementation
418 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
419 void ieee80211_notify_node_leave(struct ieee80211_node *);
420 void ieee80211_notify_scan_done(struct ieee80211vap *);
421 void ieee80211_notify_wds_discover(struct ieee80211_node *);
422 void ieee80211_notify_csa(struct ieee80211com *,
423 const struct ieee80211_channel *, int mode, int count);
424 void ieee80211_notify_radar(struct ieee80211com *,
425 const struct ieee80211_channel *);
426 enum ieee80211_notify_cac_event {
427 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */
428 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */
429 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */
430 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
432 void ieee80211_notify_cac(struct ieee80211com *,
433 const struct ieee80211_channel *,
434 enum ieee80211_notify_cac_event);
435 void ieee80211_notify_node_deauth(struct ieee80211_node *);
436 void ieee80211_notify_node_auth(struct ieee80211_node *);
437 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
438 const uint8_t cc[2]);
439 void ieee80211_notify_radio(struct ieee80211com *, int);
440 #endif /* _NET80211_IEEE80211_PROTO_H_ */