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