ieee80211_proto.h revision 178354
1/*- 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002-2008 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 178354 2008-04-20 20:35:46Z sam $ 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[]; 52 53void ieee80211_proto_attach(struct ieee80211com *); 54void ieee80211_proto_detach(struct ieee80211com *); 55void ieee80211_proto_vattach(struct ieee80211vap *); 56void ieee80211_proto_vdetach(struct ieee80211vap *); 57 58void ieee80211_syncifflag_locked(struct ieee80211com *, int flag); 59void ieee80211_syncflag(struct ieee80211vap *, int flag); 60void ieee80211_syncflag_ext(struct ieee80211vap *, int flag); 61 62#define ieee80211_input(ni, m, rssi, noise, rstamp) \ 63 ((ni)->ni_vap->iv_input(ni, m, rssi, noise, rstamp)) 64int ieee80211_input_all(struct ieee80211com *, struct mbuf *, 65 int, int, uint32_t); 66int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int); 67struct ieee80211_bpf_params; 68int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *, 69 const struct ieee80211_bpf_params *); 70int ieee80211_output(struct ifnet *, struct mbuf *, 71 struct sockaddr *, struct rtentry *); 72void ieee80211_start(struct ifnet *); 73int ieee80211_send_nulldata(struct ieee80211_node *); 74int ieee80211_classify(struct ieee80211_node *, struct mbuf *m); 75struct mbuf *ieee80211_encap(struct ieee80211_node *, struct mbuf *); 76int ieee80211_send_mgmt(struct ieee80211_node *, int, int); 77struct ieee80211_appie; 78int ieee80211_send_probereq(struct ieee80211_node *ni, 79 const uint8_t sa[IEEE80211_ADDR_LEN], 80 const uint8_t da[IEEE80211_ADDR_LEN], 81 const uint8_t bssid[IEEE80211_ADDR_LEN], 82 const uint8_t *ssid, size_t ssidlen); 83/* 84 * The formation of ProbeResponse frames requires guidance to 85 * deal with legacy clients. When the client is identified as 86 * "legacy 11b" ieee80211_send_proberesp is passed this token. 87 */ 88#define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */ 89#define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */ 90#define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */ 91struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int); 92int ieee80211_send_proberesp(struct ieee80211vap *, 93 const uint8_t da[IEEE80211_ADDR_LEN], int); 94struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic, 95 const uint8_t [IEEE80211_ADDR_LEN], 96 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 97struct mbuf *ieee80211_alloc_cts(struct ieee80211com *, 98 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 99 100void ieee80211_reset_erp(struct ieee80211com *); 101void ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 102int ieee80211_iserp_rateset(const struct ieee80211_rateset *); 103void ieee80211_setbasicrates(struct ieee80211_rateset *, 104 enum ieee80211_phymode); 105void ieee80211_addbasicrates(struct ieee80211_rateset *, 106 enum ieee80211_phymode); 107 108/* 109 * Return the size of the 802.11 header for a management or data frame. 110 */ 111static __inline int 112ieee80211_hdrsize(const void *data) 113{ 114 const struct ieee80211_frame *wh = data; 115 int size = sizeof(struct ieee80211_frame); 116 117 /* NB: we don't handle control frames */ 118 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL, 119 ("%s: control frame", __func__)); 120 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS) 121 size += IEEE80211_ADDR_LEN; 122 if (IEEE80211_QOS_HAS_SEQ(wh)) 123 size += sizeof(uint16_t); 124 return size; 125} 126 127/* 128 * Like ieee80211_hdrsize, but handles any type of frame. 129 */ 130static __inline int 131ieee80211_anyhdrsize(const void *data) 132{ 133 const struct ieee80211_frame *wh = data; 134 135 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) { 136 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) { 137 case IEEE80211_FC0_SUBTYPE_CTS: 138 case IEEE80211_FC0_SUBTYPE_ACK: 139 return sizeof(struct ieee80211_frame_ack); 140 case IEEE80211_FC0_SUBTYPE_BAR: 141 return sizeof(struct ieee80211_frame_bar); 142 } 143 return sizeof(struct ieee80211_frame_min); 144 } else 145 return ieee80211_hdrsize(data); 146} 147 148/* 149 * Template for an in-kernel authenticator. Authenticators 150 * register with the protocol code and are typically loaded 151 * as separate modules as needed. One special authenticator 152 * is xauth; it intercepts requests so that protocols like 153 * WPA can be handled in user space. 154 */ 155struct ieee80211_authenticator { 156 const char *ia_name; /* printable name */ 157 int (*ia_attach)(struct ieee80211vap *); 158 void (*ia_detach)(struct ieee80211vap *); 159 void (*ia_node_join)(struct ieee80211_node *); 160 void (*ia_node_leave)(struct ieee80211_node *); 161}; 162void ieee80211_authenticator_register(int type, 163 const struct ieee80211_authenticator *); 164void ieee80211_authenticator_unregister(int type); 165const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 166 167struct ieee80211req; 168/* 169 * Template for an MAC ACL policy module. Such modules 170 * register with the protocol code and are passed the sender's 171 * address of each received auth frame for validation. 172 */ 173struct ieee80211_aclator { 174 const char *iac_name; /* printable name */ 175 int (*iac_attach)(struct ieee80211vap *); 176 void (*iac_detach)(struct ieee80211vap *); 177 int (*iac_check)(struct ieee80211vap *, 178 const uint8_t mac[IEEE80211_ADDR_LEN]); 179 int (*iac_add)(struct ieee80211vap *, 180 const uint8_t mac[IEEE80211_ADDR_LEN]); 181 int (*iac_remove)(struct ieee80211vap *, 182 const uint8_t mac[IEEE80211_ADDR_LEN]); 183 int (*iac_flush)(struct ieee80211vap *); 184 int (*iac_setpolicy)(struct ieee80211vap *, int); 185 int (*iac_getpolicy)(struct ieee80211vap *); 186 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *); 187 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *); 188}; 189void ieee80211_aclator_register(const struct ieee80211_aclator *); 190void ieee80211_aclator_unregister(const struct ieee80211_aclator *); 191const struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 192 193/* flags for ieee80211_fix_rate() */ 194#define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 195#define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */ 196#define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 197#define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 198#define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */ 199#define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */ 200#define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */ 201int ieee80211_fix_rate(struct ieee80211_node *, 202 struct ieee80211_rateset *, int); 203 204/* 205 * WME/WMM support. 206 */ 207struct wmeParams { 208 uint8_t wmep_acm; 209 uint8_t wmep_aifsn; 210 uint8_t wmep_logcwmin; /* log2(cwmin) */ 211 uint8_t wmep_logcwmax; /* log2(cwmax) */ 212 uint8_t wmep_txopLimit; 213 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */ 214}; 215#define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 216#define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 217 218struct chanAccParams { 219 uint8_t cap_info; /* version of the current set */ 220 struct wmeParams cap_wmeParams[WME_NUM_AC]; 221}; 222 223struct ieee80211_wme_state { 224 u_int wme_flags; 225#define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 226 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 227 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 228 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 229 230 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/ 231 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */ 232 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */ 233 struct chanAccParams wme_chanParams; /* params applied to self */ 234 struct chanAccParams wme_bssChanParams; /* params bcast to stations */ 235 236 int (*wme_update)(struct ieee80211com *); 237}; 238 239void ieee80211_wme_initparams(struct ieee80211vap *); 240void ieee80211_wme_updateparams(struct ieee80211vap *); 241void ieee80211_wme_updateparams_locked(struct ieee80211vap *); 242 243/* 244 * Return the WME TID from a QoS frame. If no TID 245 * is present return the index for the "non-QoS" entry. 246 */ 247static __inline uint8_t 248ieee80211_gettid(const struct ieee80211_frame *wh) 249{ 250 uint8_t tid; 251 252 if (IEEE80211_QOS_HAS_SEQ(wh)) { 253 tid = ((const struct ieee80211_qosframe *)wh)-> 254 i_qos[0] & IEEE80211_QOS_TID; 255 tid++; 256 } else 257 tid = IEEE80211_NONQOS_TID; 258 return tid; 259} 260 261void ieee80211_start_locked(struct ieee80211vap *); 262void ieee80211_init(void *); 263void ieee80211_start_all(struct ieee80211com *); 264void ieee80211_stop_locked(struct ieee80211vap *); 265void ieee80211_stop(struct ieee80211vap *); 266void ieee80211_stop_all(struct ieee80211com *); 267void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags); 268void ieee80211_swbmiss(void *arg); 269void ieee80211_beacon_miss(struct ieee80211com *); 270int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int); 271void ieee80211_print_essid(const uint8_t *, int); 272void ieee80211_dump_pkt(struct ieee80211com *, 273 const uint8_t *, int, int, int); 274 275extern const char *ieee80211_opmode_name[]; 276extern const char *ieee80211_state_name[IEEE80211_S_MAX]; 277extern const char *ieee80211_wme_acnames[]; 278 279/* 280 * Beacon frames constructed by ieee80211_beacon_alloc 281 * have the following structure filled in so drivers 282 * can update the frame later w/ minimal overhead. 283 */ 284struct ieee80211_beacon_offsets { 285 uint8_t bo_flags[4]; /* update/state flags */ 286 uint16_t *bo_caps; /* capabilities */ 287 uint8_t *bo_cfp; /* start of CFParms element */ 288 uint8_t *bo_tim; /* start of atim/dtim */ 289 uint8_t *bo_wme; /* start of WME parameters */ 290 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */ 291 uint16_t bo_tim_len; /* atim/dtim length in bytes */ 292 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */ 293 uint8_t *bo_erp; /* start of ERP element */ 294 uint8_t *bo_htinfo; /* start of HT info element */ 295 uint8_t *bo_appie; /* start of AppIE element */ 296 uint16_t bo_appie_len; /* AppIE length in bytes */ 297 uint16_t bo_csa_trailer_len;; 298 uint8_t *bo_csa; /* start of CSA element */ 299}; 300struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *, 301 struct ieee80211_beacon_offsets *); 302 303/* 304 * Beacon frame updates are signaled through calls to iv_update_beacon 305 * with one of the IEEE80211_BEACON_* tokens defined below. For devices 306 * that construct beacon frames on the host this can trigger a rebuild 307 * or defer the processing. For devices that offload beacon frame 308 * handling this callback can be used to signal a rebuild. The bo_flags 309 * array in the ieee80211_beacon_offsets structure is intended to record 310 * deferred processing requirements; ieee80211_beacon_update uses the 311 * state to optimize work. Since this structure is owned by the driver 312 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon 313 * callback that marks the flag bits and schedules (as necessary) an update. 314 */ 315enum { 316 IEEE80211_BEACON_CAPS = 0, /* capabilities */ 317 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */ 318 IEEE80211_BEACON_WME = 2, 319 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */ 320 IEEE80211_BEACON_HTINFO = 4, /* HT Information */ 321 IEEE80211_BEACON_APPIE = 5, /* Application IE's */ 322 IEEE80211_BEACON_CFP = 6, /* CFParms */ 323 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */ 324}; 325int ieee80211_beacon_update(struct ieee80211_node *, 326 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast); 327 328void ieee80211_csa_startswitch(struct ieee80211com *, 329 struct ieee80211_channel *, int mode, int count); 330void ieee80211_csa_completeswitch(struct ieee80211com *); 331void ieee80211_cac_completeswitch(struct ieee80211vap *); 332 333/* 334 * Notification methods called from the 802.11 state machine. 335 * Note that while these are defined here, their implementation 336 * is OS-specific. 337 */ 338void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc); 339void ieee80211_notify_node_leave(struct ieee80211_node *); 340void ieee80211_notify_scan_done(struct ieee80211vap *); 341void ieee80211_notify_wds_discover(struct ieee80211_node *); 342void ieee80211_notify_csa(struct ieee80211com *, 343 const struct ieee80211_channel *, int mode, int count); 344void ieee80211_notify_radar(struct ieee80211com *, 345 const struct ieee80211_channel *); 346enum ieee80211_notify_cac_event { 347 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */ 348 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */ 349 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */ 350 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */ 351}; 352void ieee80211_notify_cac(struct ieee80211com *, 353 const struct ieee80211_channel *, 354 enum ieee80211_notify_cac_event); 355void ieee80211_notify_node_deauth(struct ieee80211_node *); 356void ieee80211_notify_node_auth(struct ieee80211_node *); 357void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [], 358 const uint8_t cc[2]); 359void ieee80211_notify_radio(struct ieee80211com *, int); 360#endif /* _NET80211_IEEE80211_PROTO_H_ */ 361