ieee80211_proto.h revision 286437
1/*- 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD: head/sys/net80211/ieee80211_proto.h 286437 2015-08-08 01:10:17Z adrian $ 27 */ 28#ifndef _NET80211_IEEE80211_PROTO_H_ 29#define _NET80211_IEEE80211_PROTO_H_ 30 31/* 32 * 802.11 protocol implementation definitions. 33 */ 34 35enum ieee80211_state { 36 IEEE80211_S_INIT = 0, /* default state */ 37 IEEE80211_S_SCAN = 1, /* scanning */ 38 IEEE80211_S_AUTH = 2, /* try to authenticate */ 39 IEEE80211_S_ASSOC = 3, /* try to assoc */ 40 IEEE80211_S_CAC = 4, /* doing channel availability check */ 41 IEEE80211_S_RUN = 5, /* operational (e.g. associated) */ 42 IEEE80211_S_CSA = 6, /* channel switch announce pending */ 43 IEEE80211_S_SLEEP = 7, /* power save */ 44}; 45#define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1) 46 47#define IEEE80211_SEND_MGMT(_ni,_type,_arg) \ 48 ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg)) 49 50extern const char *ieee80211_mgt_subtype_name[]; 51extern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX]; 52extern const int ieee80211_opcap[IEEE80211_OPMODE_MAX]; 53 54void ieee80211_proto_attach(struct ieee80211com *); 55void ieee80211_proto_detach(struct ieee80211com *); 56void ieee80211_proto_vattach(struct ieee80211vap *); 57void ieee80211_proto_vdetach(struct ieee80211vap *); 58 59void ieee80211_syncifflag_locked(struct ieee80211com *, int flag); 60void ieee80211_syncflag(struct ieee80211vap *, int flag); 61void ieee80211_syncflag_ht(struct ieee80211vap *, int flag); 62void ieee80211_syncflag_ext(struct ieee80211vap *, int flag); 63 64#define IEEE80211_R_NF 0x0000001 /* global NF value valid */ 65#define IEEE80211_R_RSSI 0x0000002 /* global RSSI value valid */ 66#define IEEE80211_R_C_CHAIN 0x0000004 /* RX chain count valid */ 67#define IEEE80211_R_C_NF 0x0000008 /* per-chain NF value valid */ 68#define IEEE80211_R_C_RSSI 0x0000010 /* per-chain RSSI value valid */ 69#define IEEE80211_R_C_EVM 0x0000020 /* per-chain EVM valid */ 70#define IEEE80211_R_C_HT40 0x0000040 /* RX'ed packet is 40mhz, pilots 4,5 valid */ 71#define IEEE80211_R_FREQ 0x0000080 /* Freq value populated, MHz */ 72#define IEEE80211_R_IEEE 0x0000100 /* IEEE value populated */ 73#define IEEE80211_R_BAND 0x0000200 /* Frequency band populated */ 74 75struct ieee80211_rx_stats { 76 uint32_t r_flags; /* IEEE80211_R_* flags */ 77 uint8_t c_chain; /* number of RX chains involved */ 78 int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 79 int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 80 int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 81 int16_t c_rssi_ext[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 82 uint8_t nf; /* global NF */ 83 uint8_t rssi; /* global RSSI */ 84 uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS]; 85 /* per-chain, per-pilot EVM values */ 86 uint16_t c_freq; 87 uint8_t c_ieee; 88}; 89 90#define ieee80211_input(ni, m, rssi, nf) \ 91 ((ni)->ni_vap->iv_input(ni, m, NULL, rssi, nf)) 92int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int); 93 94int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *, 95 struct ieee80211_rx_stats *); 96int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *, 97 struct ieee80211_rx_stats *); 98 99struct ieee80211_bpf_params; 100int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int, 101 struct ieee80211_bpf_params *); 102int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *, 103 const struct ieee80211_bpf_params *); 104int ieee80211_output(struct ifnet *, struct mbuf *, 105 const struct sockaddr *, struct route *ro); 106int ieee80211_vap_pkt_send_dest(struct ieee80211vap *, struct mbuf *, 107 struct ieee80211_node *); 108int ieee80211_raw_output(struct ieee80211vap *, struct ieee80211_node *, 109 struct mbuf *, const struct ieee80211_bpf_params *); 110void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int, 111 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN], 112 const uint8_t [IEEE80211_ADDR_LEN]); 113int ieee80211_vap_transmit(struct ifnet *ifp, struct mbuf *m); 114void ieee80211_vap_qflush(struct ifnet *ifp); 115int ieee80211_send_nulldata(struct ieee80211_node *); 116int ieee80211_classify(struct ieee80211_node *, struct mbuf *m); 117struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int, 118 struct ieee80211_key *, struct mbuf *); 119struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *, 120 struct mbuf *); 121int ieee80211_send_mgmt(struct ieee80211_node *, int, int); 122struct ieee80211_appie; 123int ieee80211_send_probereq(struct ieee80211_node *ni, 124 const uint8_t sa[IEEE80211_ADDR_LEN], 125 const uint8_t da[IEEE80211_ADDR_LEN], 126 const uint8_t bssid[IEEE80211_ADDR_LEN], 127 const uint8_t *ssid, size_t ssidlen); 128struct mbuf * ieee80211_ff_encap1(struct ieee80211vap *, struct mbuf *, 129 const struct ether_header *); 130void ieee80211_tx_complete(struct ieee80211_node *, 131 struct mbuf *, int); 132 133/* 134 * The formation of ProbeResponse frames requires guidance to 135 * deal with legacy clients. When the client is identified as 136 * "legacy 11b" ieee80211_send_proberesp is passed this token. 137 */ 138#define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */ 139#define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */ 140#define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */ 141struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int); 142int ieee80211_send_proberesp(struct ieee80211vap *, 143 const uint8_t da[IEEE80211_ADDR_LEN], int); 144struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic, 145 const uint8_t [IEEE80211_ADDR_LEN], 146 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 147struct mbuf *ieee80211_alloc_cts(struct ieee80211com *, 148 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 149 150uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *); 151uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *); 152uint8_t *ieee80211_add_ssid(uint8_t *, const uint8_t *, u_int); 153uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *); 154uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *); 155uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *); 156uint16_t ieee80211_getcapinfo(struct ieee80211vap *, 157 struct ieee80211_channel *); 158 159void ieee80211_reset_erp(struct ieee80211com *); 160void ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 161int ieee80211_iserp_rateset(const struct ieee80211_rateset *); 162void ieee80211_setbasicrates(struct ieee80211_rateset *, 163 enum ieee80211_phymode); 164void ieee80211_addbasicrates(struct ieee80211_rateset *, 165 enum ieee80211_phymode); 166 167/* 168 * Return the size of the 802.11 header for a management or data frame. 169 */ 170static __inline int 171ieee80211_hdrsize(const void *data) 172{ 173 const struct ieee80211_frame *wh = data; 174 int size = sizeof(struct ieee80211_frame); 175 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); 183 return size; 184} 185 186/* 187 * Like ieee80211_hdrsize, but handles any type of frame. 188 */ 189static __inline int 190ieee80211_anyhdrsize(const void *data) 191{ 192 const struct ieee80211_frame *wh = data; 193 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); 201 } 202 return sizeof(struct ieee80211_frame_min); 203 } else 204 return ieee80211_hdrsize(data); 205} 206 207/* 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. 213 */ 214struct 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 *); 220}; 221void ieee80211_authenticator_register(int type, 222 const struct ieee80211_authenticator *); 223void ieee80211_authenticator_unregister(int type); 224const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 225 226struct ieee80211req; 227/* 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. 231 */ 232struct 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 *); 247}; 248void ieee80211_aclator_register(const struct ieee80211_aclator *); 249void ieee80211_aclator_unregister(const struct ieee80211_aclator *); 250const struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 251 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 */ 260int ieee80211_fix_rate(struct ieee80211_node *, 261 struct ieee80211_rateset *, int); 262 263/* 264 * WME/WMM support. 265 */ 266struct wmeParams { 267 uint8_t wmep_acm; 268 uint8_t wmep_aifsn; 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) */ 273}; 274#define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 275#define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 276 277struct chanAccParams { 278 uint8_t cap_info; /* version of the current set */ 279 struct wmeParams cap_wmeParams[WME_NUM_AC]; 280}; 281 282struct ieee80211_wme_state { 283 u_int wme_flags; 284#define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 285 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 286 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 287 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 288 289 struct wmeParams wme_params[4]; /* 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 */ 294 295 int (*wme_update)(struct ieee80211com *); 296}; 297 298void ieee80211_wme_initparams(struct ieee80211vap *); 299void ieee80211_wme_updateparams(struct ieee80211vap *); 300void ieee80211_wme_updateparams_locked(struct ieee80211vap *); 301 302/* 303 * Return the WME TID from a QoS frame. If no TID 304 * is present return the index for the "non-QoS" entry. 305 */ 306static __inline uint8_t 307ieee80211_gettid(const struct ieee80211_frame *wh) 308{ 309 uint8_t tid; 310 311 if (IEEE80211_QOS_HAS_SEQ(wh)) { 312 if (IEEE80211_IS_DSTODS(wh)) 313 tid = ((const struct ieee80211_qosframe_addr4 *)wh)-> 314 i_qos[0]; 315 else 316 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0]; 317 tid &= IEEE80211_QOS_TID; 318 } else 319 tid = IEEE80211_NONQOS_TID; 320 return tid; 321} 322 323void ieee80211_waitfor_parent(struct ieee80211com *); 324void ieee80211_start_locked(struct ieee80211vap *); 325void ieee80211_init(void *); 326void ieee80211_start_all(struct ieee80211com *); 327void ieee80211_stop_locked(struct ieee80211vap *); 328void ieee80211_stop(struct ieee80211vap *); 329void ieee80211_stop_all(struct ieee80211com *); 330void ieee80211_suspend_all(struct ieee80211com *); 331void ieee80211_resume_all(struct ieee80211com *); 332void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags); 333void ieee80211_swbmiss(void *arg); 334void ieee80211_beacon_miss(struct ieee80211com *); 335int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int); 336int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state, 337 int); 338void ieee80211_print_essid(const uint8_t *, int); 339void ieee80211_dump_pkt(struct ieee80211com *, 340 const uint8_t *, int, int, int); 341 342extern const char *ieee80211_opmode_name[]; 343extern const char *ieee80211_state_name[IEEE80211_S_MAX]; 344extern const char *ieee80211_wme_acnames[]; 345 346/* 347 * Beacon frames constructed by ieee80211_beacon_alloc 348 * have the following structure filled in so drivers 349 * can update the frame later w/ minimal overhead. 350 */ 351struct ieee80211_beacon_offsets { 352 uint8_t bo_flags[4]; /* update/state flags */ 353 uint16_t *bo_caps; /* capabilities */ 354 uint8_t *bo_cfp; /* start of CFParms element */ 355 uint8_t *bo_tim; /* start of atim/dtim */ 356 uint8_t *bo_wme; /* start of WME parameters */ 357 uint8_t *bo_tdma; /* start of TDMA parameters */ 358 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */ 359 uint16_t bo_tim_len; /* atim/dtim length in bytes */ 360 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */ 361 uint8_t *bo_erp; /* start of ERP element */ 362 uint8_t *bo_htinfo; /* start of HT info element */ 363 uint8_t *bo_ath; /* start of ATH parameters */ 364 uint8_t *bo_appie; /* start of AppIE element */ 365 uint16_t bo_appie_len; /* AppIE length in bytes */ 366 uint16_t bo_csa_trailer_len; 367 uint8_t *bo_csa; /* start of CSA element */ 368 uint8_t *bo_quiet; /* start of Quiet element */ 369 uint8_t *bo_meshconf; /* start of MESHCONF element */ 370 uint8_t *bo_spare[3]; 371}; 372struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *, 373 struct ieee80211_beacon_offsets *); 374 375/* 376 * Beacon frame updates are signaled through calls to iv_update_beacon 377 * with one of the IEEE80211_BEACON_* tokens defined below. For devices 378 * that construct beacon frames on the host this can trigger a rebuild 379 * or defer the processing. For devices that offload beacon frame 380 * handling this callback can be used to signal a rebuild. The bo_flags 381 * array in the ieee80211_beacon_offsets structure is intended to record 382 * deferred processing requirements; ieee80211_beacon_update uses the 383 * state to optimize work. Since this structure is owned by the driver 384 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon 385 * callback that marks the flag bits and schedules (as necessary) an update. 386 */ 387enum { 388 IEEE80211_BEACON_CAPS = 0, /* capabilities */ 389 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */ 390 IEEE80211_BEACON_WME = 2, 391 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */ 392 IEEE80211_BEACON_HTINFO = 4, /* HT Information */ 393 IEEE80211_BEACON_APPIE = 5, /* Application IE's */ 394 IEEE80211_BEACON_CFP = 6, /* CFParms */ 395 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */ 396 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */ 397 IEEE80211_BEACON_ATH = 10, /* ATH parameters */ 398 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */ 399}; 400int ieee80211_beacon_update(struct ieee80211_node *, 401 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast); 402 403void ieee80211_csa_startswitch(struct ieee80211com *, 404 struct ieee80211_channel *, int mode, int count); 405void ieee80211_csa_completeswitch(struct ieee80211com *); 406void ieee80211_csa_cancelswitch(struct ieee80211com *); 407void ieee80211_cac_completeswitch(struct ieee80211vap *); 408 409/* 410 * Notification methods called from the 802.11 state machine. 411 * Note that while these are defined here, their implementation 412 * is OS-specific. 413 */ 414void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc); 415void ieee80211_notify_node_leave(struct ieee80211_node *); 416void ieee80211_notify_scan_done(struct ieee80211vap *); 417void ieee80211_notify_wds_discover(struct ieee80211_node *); 418void ieee80211_notify_csa(struct ieee80211com *, 419 const struct ieee80211_channel *, int mode, int count); 420void ieee80211_notify_radar(struct ieee80211com *, 421 const struct ieee80211_channel *); 422enum ieee80211_notify_cac_event { 423 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */ 424 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */ 425 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */ 426 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */ 427}; 428void ieee80211_notify_cac(struct ieee80211com *, 429 const struct ieee80211_channel *, 430 enum ieee80211_notify_cac_event); 431void ieee80211_notify_node_deauth(struct ieee80211_node *); 432void ieee80211_notify_node_auth(struct ieee80211_node *); 433void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [], 434 const uint8_t cc[2]); 435void ieee80211_notify_radio(struct ieee80211com *, int); 436#endif /* _NET80211_IEEE80211_PROTO_H_ */ 437