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