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