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