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