ieee80211_proto.h revision 184287
1116742Ssam/*- 2116904Ssam * Copyright (c) 2001 Atsushi Onoe 3178354Ssam * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting 4116742Ssam * All rights reserved. 5116742Ssam * 6116742Ssam * Redistribution and use in source and binary forms, with or without 7116742Ssam * modification, are permitted provided that the following conditions 8116742Ssam * are met: 9116742Ssam * 1. Redistributions of source code must retain the above copyright 10116742Ssam * notice, this list of conditions and the following disclaimer. 11116742Ssam * 2. Redistributions in binary form must reproduce the above copyright 12116742Ssam * notice, this list of conditions and the following disclaimer in the 13116742Ssam * documentation and/or other materials provided with the distribution. 14116742Ssam * 15116904Ssam * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16116904Ssam * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17116904Ssam * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18116904Ssam * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19116904Ssam * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20116904Ssam * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21116904Ssam * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22116904Ssam * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23116904Ssam * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24116904Ssam * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25116904Ssam * 26116742Ssam * $FreeBSD: head/sys/net80211/ieee80211_proto.h 184287 2008-10-26 01:01:01Z sam $ 27116742Ssam */ 28116742Ssam#ifndef _NET80211_IEEE80211_PROTO_H_ 29116742Ssam#define _NET80211_IEEE80211_PROTO_H_ 30116742Ssam 31116742Ssam/* 32116742Ssam * 802.11 protocol implementation definitions. 33116742Ssam */ 34116742Ssam 35116742Ssamenum ieee80211_state { 36117811Ssam IEEE80211_S_INIT = 0, /* default state */ 37117811Ssam IEEE80211_S_SCAN = 1, /* scanning */ 38117811Ssam IEEE80211_S_AUTH = 2, /* try to authenticate */ 39117811Ssam IEEE80211_S_ASSOC = 3, /* try to assoc */ 40172058Ssam IEEE80211_S_CAC = 4, /* doing channel availability check */ 41172058Ssam IEEE80211_S_RUN = 5, /* operational (e.g. associated) */ 42172058Ssam IEEE80211_S_CSA = 6, /* channel switch announce pending */ 43172058Ssam IEEE80211_S_SLEEP = 7, /* power save */ 44116742Ssam}; 45172058Ssam#define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1) 46116742Ssam 47178354Ssam#define IEEE80211_SEND_MGMT(_ni,_type,_arg) \ 48178354Ssam ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg)) 49116742Ssam 50116742Ssamextern const char *ieee80211_mgt_subtype_name[]; 51178959Ssamextern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX]; 52178957Ssamextern const int ieee80211_opcap[IEEE80211_OPMODE_MAX]; 53116742Ssam 54144618Ssamvoid ieee80211_proto_attach(struct ieee80211com *); 55144618Ssamvoid ieee80211_proto_detach(struct ieee80211com *); 56178354Ssamvoid ieee80211_proto_vattach(struct ieee80211vap *); 57178354Ssamvoid ieee80211_proto_vdetach(struct ieee80211vap *); 58116742Ssam 59178354Ssamvoid ieee80211_syncifflag_locked(struct ieee80211com *, int flag); 60178354Ssamvoid ieee80211_syncflag(struct ieee80211vap *, int flag); 61178354Ssamvoid ieee80211_syncflag_ext(struct ieee80211vap *, int flag); 62178354Ssam 63178354Ssam#define ieee80211_input(ni, m, rssi, noise, rstamp) \ 64178354Ssam ((ni)->ni_vap->iv_input(ni, m, rssi, noise, rstamp)) 65178354Ssamint ieee80211_input_all(struct ieee80211com *, struct mbuf *, 66178354Ssam int, int, uint32_t); 67184287Ssamstruct ieee80211_bpf_params; 68184282Ssamint ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int, 69184282Ssam struct ieee80211_bpf_params *); 70160690Ssamint ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *, 71160690Ssam const struct ieee80211_bpf_params *); 72160690Ssamint ieee80211_output(struct ifnet *, struct mbuf *, 73160690Ssam struct sockaddr *, struct rtentry *); 74178354Ssamvoid ieee80211_start(struct ifnet *); 75148301Ssamint ieee80211_send_nulldata(struct ieee80211_node *); 76178354Ssamint ieee80211_classify(struct ieee80211_node *, struct mbuf *m); 77178354Ssamstruct mbuf *ieee80211_encap(struct ieee80211_node *, struct mbuf *); 78178354Ssamint ieee80211_send_mgmt(struct ieee80211_node *, int, int); 79178354Ssamstruct ieee80211_appie; 80148315Ssamint ieee80211_send_probereq(struct ieee80211_node *ni, 81170530Ssam const uint8_t sa[IEEE80211_ADDR_LEN], 82170530Ssam const uint8_t da[IEEE80211_ADDR_LEN], 83170530Ssam const uint8_t bssid[IEEE80211_ADDR_LEN], 84178354Ssam const uint8_t *ssid, size_t ssidlen); 85178354Ssam/* 86178354Ssam * The formation of ProbeResponse frames requires guidance to 87178354Ssam * deal with legacy clients. When the client is identified as 88178354Ssam * "legacy 11b" ieee80211_send_proberesp is passed this token. 89178354Ssam */ 90178354Ssam#define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */ 91178354Ssam#define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */ 92178354Ssam#define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */ 93178354Ssamstruct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int); 94178354Ssamint ieee80211_send_proberesp(struct ieee80211vap *, 95178354Ssam const uint8_t da[IEEE80211_ADDR_LEN], int); 96178354Ssamstruct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic, 97178354Ssam const uint8_t [IEEE80211_ADDR_LEN], 98178354Ssam const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 99178354Ssamstruct mbuf *ieee80211_alloc_cts(struct ieee80211com *, 100178354Ssam const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 101138568Ssam 102144618Ssamvoid ieee80211_reset_erp(struct ieee80211com *); 103144618Ssamvoid ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 104178354Ssamint ieee80211_iserp_rateset(const struct ieee80211_rateset *); 105178354Ssamvoid ieee80211_setbasicrates(struct ieee80211_rateset *, 106138568Ssam enum ieee80211_phymode); 107178354Ssamvoid ieee80211_addbasicrates(struct ieee80211_rateset *, 108178354Ssam enum ieee80211_phymode); 109138568Ssam 110138568Ssam/* 111138568Ssam * Return the size of the 802.11 header for a management or data frame. 112138568Ssam */ 113139525Ssamstatic __inline int 114138568Ssamieee80211_hdrsize(const void *data) 115138568Ssam{ 116138568Ssam const struct ieee80211_frame *wh = data; 117138568Ssam int size = sizeof(struct ieee80211_frame); 118138568Ssam 119138568Ssam /* NB: we don't handle control frames */ 120138568Ssam KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL, 121138568Ssam ("%s: control frame", __func__)); 122138568Ssam if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS) 123138568Ssam size += IEEE80211_ADDR_LEN; 124138568Ssam if (IEEE80211_QOS_HAS_SEQ(wh)) 125170530Ssam size += sizeof(uint16_t); 126138568Ssam return size; 127138568Ssam} 128138568Ssam 129138568Ssam/* 130170530Ssam * Like ieee80211_hdrsize, but handles any type of frame. 131138568Ssam */ 132139525Ssamstatic __inline int 133138568Ssamieee80211_anyhdrsize(const void *data) 134138568Ssam{ 135138568Ssam const struct ieee80211_frame *wh = data; 136138568Ssam 137138568Ssam if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) { 138138568Ssam switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) { 139138568Ssam case IEEE80211_FC0_SUBTYPE_CTS: 140138568Ssam case IEEE80211_FC0_SUBTYPE_ACK: 141138568Ssam return sizeof(struct ieee80211_frame_ack); 142170530Ssam case IEEE80211_FC0_SUBTYPE_BAR: 143170530Ssam return sizeof(struct ieee80211_frame_bar); 144138568Ssam } 145138568Ssam return sizeof(struct ieee80211_frame_min); 146138568Ssam } else 147138568Ssam return ieee80211_hdrsize(data); 148138568Ssam} 149138568Ssam 150138568Ssam/* 151138568Ssam * Template for an in-kernel authenticator. Authenticators 152138568Ssam * register with the protocol code and are typically loaded 153178354Ssam * as separate modules as needed. One special authenticator 154178354Ssam * is xauth; it intercepts requests so that protocols like 155178354Ssam * WPA can be handled in user space. 156138568Ssam */ 157138568Ssamstruct ieee80211_authenticator { 158138568Ssam const char *ia_name; /* printable name */ 159178354Ssam int (*ia_attach)(struct ieee80211vap *); 160178354Ssam void (*ia_detach)(struct ieee80211vap *); 161178354Ssam void (*ia_node_join)(struct ieee80211_node *); 162178354Ssam void (*ia_node_leave)(struct ieee80211_node *); 163138568Ssam}; 164144618Ssamvoid ieee80211_authenticator_register(int type, 165138568Ssam const struct ieee80211_authenticator *); 166144618Ssamvoid ieee80211_authenticator_unregister(int type); 167144618Ssamconst struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 168138568Ssam 169149028Ssamstruct ieee80211req; 170138568Ssam/* 171138568Ssam * Template for an MAC ACL policy module. Such modules 172138568Ssam * register with the protocol code and are passed the sender's 173178354Ssam * address of each received auth frame for validation. 174138568Ssam */ 175138568Ssamstruct ieee80211_aclator { 176138568Ssam const char *iac_name; /* printable name */ 177178354Ssam int (*iac_attach)(struct ieee80211vap *); 178178354Ssam void (*iac_detach)(struct ieee80211vap *); 179178354Ssam int (*iac_check)(struct ieee80211vap *, 180170530Ssam const uint8_t mac[IEEE80211_ADDR_LEN]); 181178354Ssam int (*iac_add)(struct ieee80211vap *, 182170530Ssam const uint8_t mac[IEEE80211_ADDR_LEN]); 183178354Ssam int (*iac_remove)(struct ieee80211vap *, 184170530Ssam const uint8_t mac[IEEE80211_ADDR_LEN]); 185178354Ssam int (*iac_flush)(struct ieee80211vap *); 186178354Ssam int (*iac_setpolicy)(struct ieee80211vap *, int); 187178354Ssam int (*iac_getpolicy)(struct ieee80211vap *); 188178354Ssam int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *); 189178354Ssam int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *); 190138568Ssam}; 191144618Ssamvoid ieee80211_aclator_register(const struct ieee80211_aclator *); 192144618Ssamvoid ieee80211_aclator_unregister(const struct ieee80211_aclator *); 193144618Ssamconst struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 194138568Ssam 195138568Ssam/* flags for ieee80211_fix_rate() */ 196138568Ssam#define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 197178354Ssam#define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */ 198138568Ssam#define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 199138568Ssam#define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 200170530Ssam#define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */ 201170530Ssam#define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */ 202178354Ssam#define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */ 203167442Ssamint ieee80211_fix_rate(struct ieee80211_node *, 204167442Ssam struct ieee80211_rateset *, int); 205138568Ssam 206138568Ssam/* 207138568Ssam * WME/WMM support. 208138568Ssam */ 209138568Ssamstruct wmeParams { 210170530Ssam uint8_t wmep_acm; 211170530Ssam uint8_t wmep_aifsn; 212170530Ssam uint8_t wmep_logcwmin; /* log2(cwmin) */ 213170530Ssam uint8_t wmep_logcwmax; /* log2(cwmax) */ 214170530Ssam uint8_t wmep_txopLimit; 215170530Ssam uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */ 216138568Ssam}; 217140762Ssam#define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 218140762Ssam#define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 219138568Ssam 220138568Ssamstruct chanAccParams { 221170530Ssam uint8_t cap_info; /* version of the current set */ 222138568Ssam struct wmeParams cap_wmeParams[WME_NUM_AC]; 223138568Ssam}; 224138568Ssam 225138568Ssamstruct ieee80211_wme_state { 226138568Ssam u_int wme_flags; 227138568Ssam#define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 228138568Ssam u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 229138568Ssam u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 230138568Ssam u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 231138568Ssam 232138568Ssam struct wmeParams wme_params[4]; /* from assoc resp for each AC*/ 233138568Ssam struct chanAccParams wme_wmeChanParams; /* WME params applied to self */ 234138568Ssam struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */ 235138568Ssam struct chanAccParams wme_chanParams; /* params applied to self */ 236138568Ssam struct chanAccParams wme_bssChanParams; /* params bcast to stations */ 237138568Ssam 238138568Ssam int (*wme_update)(struct ieee80211com *); 239138568Ssam}; 240138568Ssam 241178354Ssamvoid ieee80211_wme_initparams(struct ieee80211vap *); 242178354Ssamvoid ieee80211_wme_updateparams(struct ieee80211vap *); 243178354Ssamvoid ieee80211_wme_updateparams_locked(struct ieee80211vap *); 244138568Ssam 245178354Ssam/* 246178354Ssam * Return the WME TID from a QoS frame. If no TID 247178354Ssam * is present return the index for the "non-QoS" entry. 248178354Ssam */ 249178354Ssamstatic __inline uint8_t 250178354Ssamieee80211_gettid(const struct ieee80211_frame *wh) 251178354Ssam{ 252178354Ssam uint8_t tid; 253178354Ssam 254178354Ssam if (IEEE80211_QOS_HAS_SEQ(wh)) { 255178354Ssam tid = ((const struct ieee80211_qosframe *)wh)-> 256178354Ssam i_qos[0] & IEEE80211_QOS_TID; 257178354Ssam tid++; 258178354Ssam } else 259178354Ssam tid = IEEE80211_NONQOS_TID; 260178354Ssam return tid; 261178354Ssam} 262178354Ssam 263178354Ssamvoid ieee80211_start_locked(struct ieee80211vap *); 264178354Ssamvoid ieee80211_init(void *); 265178354Ssamvoid ieee80211_start_all(struct ieee80211com *); 266178354Ssamvoid ieee80211_stop_locked(struct ieee80211vap *); 267178354Ssamvoid ieee80211_stop(struct ieee80211vap *); 268178354Ssamvoid ieee80211_stop_all(struct ieee80211com *); 269179391Ssamvoid ieee80211_suspend_all(struct ieee80211com *); 270179391Ssamvoid ieee80211_resume_all(struct ieee80211com *); 271178354Ssamvoid ieee80211_dturbo_switch(struct ieee80211vap *, int newflags); 272178354Ssamvoid ieee80211_swbmiss(void *arg); 273153349Ssamvoid ieee80211_beacon_miss(struct ieee80211com *); 274178354Ssamint ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int); 275170530Ssamvoid ieee80211_print_essid(const uint8_t *, int); 276170530Ssamvoid ieee80211_dump_pkt(struct ieee80211com *, 277170530Ssam const uint8_t *, int, int, int); 278117811Ssam 279167283Ssamextern const char *ieee80211_opmode_name[]; 280117811Ssamextern const char *ieee80211_state_name[IEEE80211_S_MAX]; 281138568Ssamextern const char *ieee80211_wme_acnames[]; 282138568Ssam 283138568Ssam/* 284138568Ssam * Beacon frames constructed by ieee80211_beacon_alloc 285138568Ssam * have the following structure filled in so drivers 286138568Ssam * can update the frame later w/ minimal overhead. 287138568Ssam */ 288138568Ssamstruct ieee80211_beacon_offsets { 289172211Ssam uint8_t bo_flags[4]; /* update/state flags */ 290170530Ssam uint16_t *bo_caps; /* capabilities */ 291172211Ssam uint8_t *bo_cfp; /* start of CFParms element */ 292170530Ssam uint8_t *bo_tim; /* start of atim/dtim */ 293170530Ssam uint8_t *bo_wme; /* start of WME parameters */ 294172211Ssam uint8_t *bo_tim_trailer;/* start of fixed-size trailer */ 295170530Ssam uint16_t bo_tim_len; /* atim/dtim length in bytes */ 296172211Ssam uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */ 297170530Ssam uint8_t *bo_erp; /* start of ERP element */ 298170530Ssam uint8_t *bo_htinfo; /* start of HT info element */ 299172211Ssam uint8_t *bo_appie; /* start of AppIE element */ 300172211Ssam uint16_t bo_appie_len; /* AppIE length in bytes */ 301172211Ssam uint16_t bo_csa_trailer_len;; 302172211Ssam uint8_t *bo_csa; /* start of CSA element */ 303138568Ssam}; 304172211Ssamstruct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *, 305172211Ssam struct ieee80211_beacon_offsets *); 306138568Ssam 307138568Ssam/* 308178354Ssam * Beacon frame updates are signaled through calls to iv_update_beacon 309172211Ssam * with one of the IEEE80211_BEACON_* tokens defined below. For devices 310172211Ssam * that construct beacon frames on the host this can trigger a rebuild 311172211Ssam * or defer the processing. For devices that offload beacon frame 312172211Ssam * handling this callback can be used to signal a rebuild. The bo_flags 313172211Ssam * array in the ieee80211_beacon_offsets structure is intended to record 314172211Ssam * deferred processing requirements; ieee80211_beacon_update uses the 315172211Ssam * state to optimize work. Since this structure is owned by the driver 316178354Ssam * and not visible to the 802.11 layer drivers must supply an iv_update_beacon 317172211Ssam * callback that marks the flag bits and schedules (as necessary) an update. 318172211Ssam */ 319172211Ssamenum { 320172211Ssam IEEE80211_BEACON_CAPS = 0, /* capabilities */ 321172211Ssam IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */ 322172211Ssam IEEE80211_BEACON_WME = 2, 323172211Ssam IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */ 324172211Ssam IEEE80211_BEACON_HTINFO = 4, /* HT Information */ 325172211Ssam IEEE80211_BEACON_APPIE = 5, /* Application IE's */ 326172211Ssam IEEE80211_BEACON_CFP = 6, /* CFParms */ 327172211Ssam IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */ 328172211Ssam}; 329172211Ssamint ieee80211_beacon_update(struct ieee80211_node *, 330172211Ssam struct ieee80211_beacon_offsets *, struct mbuf *, int mcast); 331172211Ssam 332178354Ssamvoid ieee80211_csa_startswitch(struct ieee80211com *, 333178354Ssam struct ieee80211_channel *, int mode, int count); 334178354Ssamvoid ieee80211_csa_completeswitch(struct ieee80211com *); 335178354Ssamvoid ieee80211_cac_completeswitch(struct ieee80211vap *); 336178354Ssam 337172211Ssam/* 338138568Ssam * Notification methods called from the 802.11 state machine. 339138568Ssam * Note that while these are defined here, their implementation 340138568Ssam * is OS-specific. 341138568Ssam */ 342178354Ssamvoid ieee80211_notify_node_join(struct ieee80211_node *, int newassoc); 343178354Ssamvoid ieee80211_notify_node_leave(struct ieee80211_node *); 344178354Ssamvoid ieee80211_notify_scan_done(struct ieee80211vap *); 345178354Ssamvoid ieee80211_notify_wds_discover(struct ieee80211_node *); 346178354Ssamvoid ieee80211_notify_csa(struct ieee80211com *, 347178354Ssam const struct ieee80211_channel *, int mode, int count); 348178354Ssamvoid ieee80211_notify_radar(struct ieee80211com *, 349178354Ssam const struct ieee80211_channel *); 350178354Ssamenum ieee80211_notify_cac_event { 351178354Ssam IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */ 352178354Ssam IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */ 353178354Ssam IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */ 354178354Ssam IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */ 355178354Ssam}; 356178354Ssamvoid ieee80211_notify_cac(struct ieee80211com *, 357178354Ssam const struct ieee80211_channel *, 358178354Ssam enum ieee80211_notify_cac_event); 359178354Ssamvoid ieee80211_notify_node_deauth(struct ieee80211_node *); 360178354Ssamvoid ieee80211_notify_node_auth(struct ieee80211_node *); 361178354Ssamvoid ieee80211_notify_country(struct ieee80211vap *, const uint8_t [], 362178354Ssam const uint8_t cc[2]); 363178354Ssamvoid ieee80211_notify_radio(struct ieee80211com *, int); 364116742Ssam#endif /* _NET80211_IEEE80211_PROTO_H_ */ 365