ieee80211_proto.h revision 286410
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 286410 2015-08-07 11:43:14Z glebius $ 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_promisc(struct ieee80211vap *, bool); 60void ieee80211_allmulti(struct ieee80211vap *, bool); 61void ieee80211_syncflag(struct ieee80211vap *, int flag); 62void ieee80211_syncflag_ht(struct ieee80211vap *, int flag); 63void ieee80211_syncflag_ext(struct ieee80211vap *, int flag); 64 65#define IEEE80211_R_NF 0x0000001 /* global NF value valid */ 66#define IEEE80211_R_RSSI 0x0000002 /* global RSSI value valid */ 67#define IEEE80211_R_C_CHAIN 0x0000004 /* RX chain count valid */ 68#define IEEE80211_R_C_NF 0x0000008 /* per-chain NF value valid */ 69#define IEEE80211_R_C_RSSI 0x0000010 /* per-chain RSSI value valid */ 70#define IEEE80211_R_C_EVM 0x0000020 /* per-chain EVM valid */ 71#define IEEE80211_R_C_HT40 0x0000040 /* RX'ed packet is 40mhz, pilots 4,5 valid */ 72#define IEEE80211_R_FREQ 0x0000080 /* Freq value populated, MHz */ 73#define IEEE80211_R_IEEE 0x0000100 /* IEEE value populated */ 74#define IEEE80211_R_BAND 0x0000200 /* Frequency band populated */ 75 76struct ieee80211_rx_stats { 77 uint32_t r_flags; /* IEEE80211_R_* flags */ 78 uint8_t c_chain; /* number of RX chains involved */ 79 int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 80 int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 81 int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 82 int16_t c_rssi_ext[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 83 uint8_t nf; /* global NF */ 84 uint8_t rssi; /* global RSSI */ 85 uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS]; 86 /* per-chain, per-pilot EVM values */ 87 uint16_t c_freq; 88 uint8_t c_ieee; 89}; 90 91#define ieee80211_input(ni, m, rssi, nf) \ 92 ((ni)->ni_vap->iv_input(ni, m, NULL, rssi, nf)) 93int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int); 94 95int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *, 96 struct ieee80211_rx_stats *); 97int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *, 98 struct ieee80211_rx_stats *); 99 100struct ieee80211_bpf_params; 101int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int, 102 struct ieee80211_bpf_params *); 103int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *, 104 const struct ieee80211_bpf_params *); 105int ieee80211_output(struct ifnet *, struct mbuf *, 106 const struct sockaddr *, struct route *ro); 107int ieee80211_vap_pkt_send_dest(struct ieee80211vap *, struct mbuf *, 108 struct ieee80211_node *); 109int ieee80211_raw_output(struct ieee80211vap *, struct ieee80211_node *, 110 struct mbuf *, const struct ieee80211_bpf_params *); 111void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int, 112 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN], 113 const uint8_t [IEEE80211_ADDR_LEN]); 114int ieee80211_vap_transmit(struct ifnet *ifp, struct mbuf *m); 115void ieee80211_vap_qflush(struct ifnet *ifp); 116int ieee80211_send_nulldata(struct ieee80211_node *); 117int ieee80211_classify(struct ieee80211_node *, struct mbuf *m); 118struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int, 119 struct ieee80211_key *, struct mbuf *); 120struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *, 121 struct mbuf *); 122int ieee80211_send_mgmt(struct ieee80211_node *, int, int); 123struct ieee80211_appie; 124int ieee80211_send_probereq(struct ieee80211_node *ni, 125 const uint8_t sa[IEEE80211_ADDR_LEN], 126 const uint8_t da[IEEE80211_ADDR_LEN], 127 const uint8_t bssid[IEEE80211_ADDR_LEN], 128 const uint8_t *ssid, size_t ssidlen); 129struct mbuf * ieee80211_ff_encap1(struct ieee80211vap *, struct mbuf *, 130 const struct ether_header *); 131void ieee80211_tx_complete(struct ieee80211_node *, 132 struct mbuf *, int); 133 134/* 135 * The formation of ProbeResponse frames requires guidance to 136 * deal with legacy clients. When the client is identified as 137 * "legacy 11b" ieee80211_send_proberesp is passed this token. 138 */ 139#define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */ 140#define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */ 141#define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */ 142struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int); 143int ieee80211_send_proberesp(struct ieee80211vap *, 144 const uint8_t da[IEEE80211_ADDR_LEN], int); 145struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic, 146 const uint8_t [IEEE80211_ADDR_LEN], 147 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 148struct mbuf *ieee80211_alloc_cts(struct ieee80211com *, 149 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 150 151uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *); 152uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *); 153uint8_t *ieee80211_add_ssid(uint8_t *, const uint8_t *, u_int); 154uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *); 155uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *); 156uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *); 157uint16_t ieee80211_getcapinfo(struct ieee80211vap *, 158 struct ieee80211_channel *); 159 160void ieee80211_reset_erp(struct ieee80211com *); 161void ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 162int ieee80211_iserp_rateset(const struct ieee80211_rateset *); 163void ieee80211_setbasicrates(struct ieee80211_rateset *, 164 enum ieee80211_phymode); 165void ieee80211_addbasicrates(struct ieee80211_rateset *, 166 enum ieee80211_phymode); 167 168/* 169 * Return the size of the 802.11 header for a management or data frame. 170 */ 171static __inline int 172ieee80211_hdrsize(const void *data) 173{ 174 const struct ieee80211_frame *wh = data; 175 int size = sizeof(struct ieee80211_frame); 176 177 /* NB: we don't handle control frames */ 178 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL, 179 ("%s: control frame", __func__)); 180 if (IEEE80211_IS_DSTODS(wh)) 181 size += IEEE80211_ADDR_LEN; 182 if (IEEE80211_QOS_HAS_SEQ(wh)) 183 size += sizeof(uint16_t); 184 return size; 185} 186 187/* 188 * Like ieee80211_hdrsize, but handles any type of frame. 189 */ 190static __inline int 191ieee80211_anyhdrsize(const void *data) 192{ 193 const struct ieee80211_frame *wh = data; 194 195 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) { 196 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) { 197 case IEEE80211_FC0_SUBTYPE_CTS: 198 case IEEE80211_FC0_SUBTYPE_ACK: 199 return sizeof(struct ieee80211_frame_ack); 200 case IEEE80211_FC0_SUBTYPE_BAR: 201 return sizeof(struct ieee80211_frame_bar); 202 } 203 return sizeof(struct ieee80211_frame_min); 204 } else 205 return ieee80211_hdrsize(data); 206} 207 208/* 209 * Template for an in-kernel authenticator. Authenticators 210 * register with the protocol code and are typically loaded 211 * as separate modules as needed. One special authenticator 212 * is xauth; it intercepts requests so that protocols like 213 * WPA can be handled in user space. 214 */ 215struct ieee80211_authenticator { 216 const char *ia_name; /* printable name */ 217 int (*ia_attach)(struct ieee80211vap *); 218 void (*ia_detach)(struct ieee80211vap *); 219 void (*ia_node_join)(struct ieee80211_node *); 220 void (*ia_node_leave)(struct ieee80211_node *); 221}; 222void ieee80211_authenticator_register(int type, 223 const struct ieee80211_authenticator *); 224void ieee80211_authenticator_unregister(int type); 225const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 226 227struct ieee80211req; 228/* 229 * Template for an MAC ACL policy module. Such modules 230 * register with the protocol code and are passed the sender's 231 * address of each received auth frame for validation. 232 */ 233struct ieee80211_aclator { 234 const char *iac_name; /* printable name */ 235 int (*iac_attach)(struct ieee80211vap *); 236 void (*iac_detach)(struct ieee80211vap *); 237 int (*iac_check)(struct ieee80211vap *, 238 const struct ieee80211_frame *wh); 239 int (*iac_add)(struct ieee80211vap *, 240 const uint8_t mac[IEEE80211_ADDR_LEN]); 241 int (*iac_remove)(struct ieee80211vap *, 242 const uint8_t mac[IEEE80211_ADDR_LEN]); 243 int (*iac_flush)(struct ieee80211vap *); 244 int (*iac_setpolicy)(struct ieee80211vap *, int); 245 int (*iac_getpolicy)(struct ieee80211vap *); 246 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *); 247 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *); 248}; 249void ieee80211_aclator_register(const struct ieee80211_aclator *); 250void ieee80211_aclator_unregister(const struct ieee80211_aclator *); 251const struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 252 253/* flags for ieee80211_fix_rate() */ 254#define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 255#define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */ 256#define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 257#define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 258#define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */ 259#define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */ 260#define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */ 261int ieee80211_fix_rate(struct ieee80211_node *, 262 struct ieee80211_rateset *, int); 263 264/* 265 * WME/WMM support. 266 */ 267struct wmeParams { 268 uint8_t wmep_acm; 269 uint8_t wmep_aifsn; 270 uint8_t wmep_logcwmin; /* log2(cwmin) */ 271 uint8_t wmep_logcwmax; /* log2(cwmax) */ 272 uint8_t wmep_txopLimit; 273 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */ 274}; 275#define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 276#define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 277 278struct chanAccParams { 279 uint8_t cap_info; /* version of the current set */ 280 struct wmeParams cap_wmeParams[WME_NUM_AC]; 281}; 282 283struct ieee80211_wme_state { 284 u_int wme_flags; 285#define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 286 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 287 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 288 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 289 290 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/ 291 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */ 292 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */ 293 struct chanAccParams wme_chanParams; /* params applied to self */ 294 struct chanAccParams wme_bssChanParams; /* params bcast to stations */ 295 296 int (*wme_update)(struct ieee80211com *); 297}; 298 299void ieee80211_wme_initparams(struct ieee80211vap *); 300void ieee80211_wme_updateparams(struct ieee80211vap *); 301void ieee80211_wme_updateparams_locked(struct ieee80211vap *); 302 303/* 304 * Return the WME TID from a QoS frame. If no TID 305 * is present return the index for the "non-QoS" entry. 306 */ 307static __inline uint8_t 308ieee80211_gettid(const struct ieee80211_frame *wh) 309{ 310 uint8_t tid; 311 312 if (IEEE80211_QOS_HAS_SEQ(wh)) { 313 if (IEEE80211_IS_DSTODS(wh)) 314 tid = ((const struct ieee80211_qosframe_addr4 *)wh)-> 315 i_qos[0]; 316 else 317 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0]; 318 tid &= IEEE80211_QOS_TID; 319 } else 320 tid = IEEE80211_NONQOS_TID; 321 return tid; 322} 323 324void ieee80211_waitfor_parent(struct ieee80211com *); 325void ieee80211_start_locked(struct ieee80211vap *); 326void ieee80211_init(void *); 327void ieee80211_start_all(struct ieee80211com *); 328void ieee80211_stop_locked(struct ieee80211vap *); 329void ieee80211_stop(struct ieee80211vap *); 330void ieee80211_stop_all(struct ieee80211com *); 331void ieee80211_suspend_all(struct ieee80211com *); 332void ieee80211_resume_all(struct ieee80211com *); 333void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags); 334void ieee80211_swbmiss(void *arg); 335void ieee80211_beacon_miss(struct ieee80211com *); 336int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int); 337int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state, 338 int); 339void ieee80211_print_essid(const uint8_t *, int); 340void ieee80211_dump_pkt(struct ieee80211com *, 341 const uint8_t *, int, int, int); 342 343extern const char *ieee80211_opmode_name[]; 344extern const char *ieee80211_state_name[IEEE80211_S_MAX]; 345extern const char *ieee80211_wme_acnames[]; 346 347/* 348 * Beacon frames constructed by ieee80211_beacon_alloc 349 * have the following structure filled in so drivers 350 * can update the frame later w/ minimal overhead. 351 */ 352struct ieee80211_beacon_offsets { 353 uint8_t bo_flags[4]; /* update/state flags */ 354 uint16_t *bo_caps; /* capabilities */ 355 uint8_t *bo_cfp; /* start of CFParms element */ 356 uint8_t *bo_tim; /* start of atim/dtim */ 357 uint8_t *bo_wme; /* start of WME parameters */ 358 uint8_t *bo_tdma; /* start of TDMA parameters */ 359 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */ 360 uint16_t bo_tim_len; /* atim/dtim length in bytes */ 361 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */ 362 uint8_t *bo_erp; /* start of ERP element */ 363 uint8_t *bo_htinfo; /* start of HT info element */ 364 uint8_t *bo_ath; /* start of ATH parameters */ 365 uint8_t *bo_appie; /* start of AppIE element */ 366 uint16_t bo_appie_len; /* AppIE length in bytes */ 367 uint16_t bo_csa_trailer_len; 368 uint8_t *bo_csa; /* start of CSA element */ 369 uint8_t *bo_quiet; /* start of Quiet element */ 370 uint8_t *bo_meshconf; /* start of MESHCONF element */ 371 uint8_t *bo_spare[3]; 372}; 373struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *, 374 struct ieee80211_beacon_offsets *); 375 376/* 377 * Beacon frame updates are signaled through calls to iv_update_beacon 378 * with one of the IEEE80211_BEACON_* tokens defined below. For devices 379 * that construct beacon frames on the host this can trigger a rebuild 380 * or defer the processing. For devices that offload beacon frame 381 * handling this callback can be used to signal a rebuild. The bo_flags 382 * array in the ieee80211_beacon_offsets structure is intended to record 383 * deferred processing requirements; ieee80211_beacon_update uses the 384 * state to optimize work. Since this structure is owned by the driver 385 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon 386 * callback that marks the flag bits and schedules (as necessary) an update. 387 */ 388enum { 389 IEEE80211_BEACON_CAPS = 0, /* capabilities */ 390 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */ 391 IEEE80211_BEACON_WME = 2, 392 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */ 393 IEEE80211_BEACON_HTINFO = 4, /* HT Information */ 394 IEEE80211_BEACON_APPIE = 5, /* Application IE's */ 395 IEEE80211_BEACON_CFP = 6, /* CFParms */ 396 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */ 397 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */ 398 IEEE80211_BEACON_ATH = 10, /* ATH parameters */ 399 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */ 400}; 401int ieee80211_beacon_update(struct ieee80211_node *, 402 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast); 403 404void ieee80211_csa_startswitch(struct ieee80211com *, 405 struct ieee80211_channel *, int mode, int count); 406void ieee80211_csa_completeswitch(struct ieee80211com *); 407void ieee80211_csa_cancelswitch(struct ieee80211com *); 408void ieee80211_cac_completeswitch(struct ieee80211vap *); 409 410/* 411 * Notification methods called from the 802.11 state machine. 412 * Note that while these are defined here, their implementation 413 * is OS-specific. 414 */ 415void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc); 416void ieee80211_notify_node_leave(struct ieee80211_node *); 417void ieee80211_notify_scan_done(struct ieee80211vap *); 418void ieee80211_notify_wds_discover(struct ieee80211_node *); 419void ieee80211_notify_csa(struct ieee80211com *, 420 const struct ieee80211_channel *, int mode, int count); 421void ieee80211_notify_radar(struct ieee80211com *, 422 const struct ieee80211_channel *); 423enum ieee80211_notify_cac_event { 424 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */ 425 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */ 426 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */ 427 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */ 428}; 429void ieee80211_notify_cac(struct ieee80211com *, 430 const struct ieee80211_channel *, 431 enum ieee80211_notify_cac_event); 432void ieee80211_notify_node_deauth(struct ieee80211_node *); 433void ieee80211_notify_node_auth(struct ieee80211_node *); 434void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [], 435 const uint8_t cc[2]); 436void ieee80211_notify_radio(struct ieee80211com *, int); 437#endif /* _NET80211_IEEE80211_PROTO_H_ */ 438