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$ 27 */ 28 #ifndef _FBSD_COMPAT_NET80211_IEEE80211_PROTO_H_ 29 #define _FBSD_COMPAT_NET80211_IEEE80211_PROTO_H_ 30 31 /* 32 * 802.11 protocol implementation definitions. 33 */ 34 35 void ieee80211_auth_setup(void); 36 37 enum ieee80211_state { 38 IEEE80211_S_INIT = 0, /* default state */ 39 IEEE80211_S_SCAN = 1, /* scanning */ 40 IEEE80211_S_AUTH = 2, /* try to authenticate */ 41 IEEE80211_S_ASSOC = 3, /* try to assoc */ 42 IEEE80211_S_CAC = 4, /* doing channel availability check */ 43 IEEE80211_S_RUN = 5, /* operational (e.g. associated) */ 44 IEEE80211_S_CSA = 6, /* channel switch announce pending */ 45 IEEE80211_S_SLEEP = 7, /* power save */ 46 }; 47 #define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1) 48 49 #define IEEE80211_SEND_MGMT(_ni,_type,_arg) \ 50 ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg)) 51 52 extern const char *ieee80211_mgt_subtype_name[]; 53 extern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX]; 54 extern const int ieee80211_opcap[IEEE80211_OPMODE_MAX]; 55 56 void ieee80211_proto_attach(struct ieee80211com *); 57 void ieee80211_proto_detach(struct ieee80211com *); 58 void ieee80211_proto_vattach(struct ieee80211vap *); 59 void ieee80211_proto_vdetach(struct ieee80211vap *); 60 61 void ieee80211_syncifflag_locked(struct ieee80211com *, int flag); 62 void ieee80211_syncflag(struct ieee80211vap *, int flag); 63 void ieee80211_syncflag_ht(struct ieee80211vap *, int flag); 64 void ieee80211_syncflag_ext(struct ieee80211vap *, int flag); 65 66 #define IEEE80211_R_NF 0x0000001 /* global NF value valid */ 67 #define IEEE80211_R_RSSI 0x0000002 /* global RSSI value valid */ 68 #define IEEE80211_R_C_CHAIN 0x0000004 /* RX chain count valid */ 69 #define IEEE80211_R_C_NF 0x0000008 /* per-chain NF value valid */ 70 #define IEEE80211_R_C_RSSI 0x0000010 /* per-chain RSSI value valid */ 71 #define IEEE80211_R_C_EVM 0x0000020 /* per-chain EVM valid */ 72 #define IEEE80211_R_C_HT40 0x0000040 /* RX'ed packet is 40mhz, pilots 4,5 valid */ 73 74 struct ieee80211_rx_stats { 75 uint32_t r_flags; /* IEEE80211_R_* flags */ 76 uint8_t c_chain; /* number of RX chains involved */ 77 int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 78 int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */ 79 int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 80 int16_t c_rssi_ext[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */ 81 uint8_t nf; /* global NF */ 82 uint8_t rssi; /* global RSSI */ 83 uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS]; 84 /* per-chain, per-pilot EVM values */ 85 }; 86 87 #define ieee80211_input(ni, m, rssi, nf) \ 88 ((ni)->ni_vap->iv_input(ni, m, rssi, nf)) 89 int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int); 90 91 int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *, 92 struct ieee80211_rx_stats *); 93 int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *, 94 struct ieee80211_rx_stats *); 95 96 struct ieee80211_bpf_params; 97 int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int, 98 struct ieee80211_bpf_params *); 99 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *, 100 const struct ieee80211_bpf_params *); 101 int ieee80211_output(struct ifnet *, struct mbuf *, 102 struct sockaddr *, struct route *ro); 103 void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int, 104 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN], 105 const uint8_t [IEEE80211_ADDR_LEN]); 106 void ieee80211_start(struct ifnet *); 107 int ieee80211_send_nulldata(struct ieee80211_node *); 108 int ieee80211_classify(struct ieee80211_node *, struct mbuf *m); 109 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int, 110 struct ieee80211_key *, struct mbuf *); 111 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *, 112 struct mbuf *); 113 int ieee80211_send_mgmt(struct ieee80211_node *, int, int); 114 struct ieee80211_appie; 115 int ieee80211_send_probereq(struct ieee80211_node *ni, 116 const uint8_t sa[IEEE80211_ADDR_LEN], 117 const uint8_t da[IEEE80211_ADDR_LEN], 118 const uint8_t bssid[IEEE80211_ADDR_LEN], 119 const uint8_t *ssid, size_t ssidlen); 120 /* 121 * The formation of ProbeResponse frames requires guidance to 122 * deal with legacy clients. When the client is identified as 123 * "legacy 11b" ieee80211_send_proberesp is passed this token. 124 */ 125 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */ 126 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */ 127 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */ 128 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int); 129 int ieee80211_send_proberesp(struct ieee80211vap *, 130 const uint8_t da[IEEE80211_ADDR_LEN], int); 131 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic, 132 const uint8_t [IEEE80211_ADDR_LEN], 133 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 134 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *, 135 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 136 137 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *); 138 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *); 139 uint16_t ieee80211_getcapinfo(struct ieee80211vap *, 140 struct ieee80211_channel *); 141 142 void ieee80211_reset_erp(struct ieee80211com *); 143 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 144 int ieee80211_iserp_rateset(const struct ieee80211_rateset *); 145 void ieee80211_setbasicrates(struct ieee80211_rateset *, 146 enum ieee80211_phymode); 147 void ieee80211_addbasicrates(struct ieee80211_rateset *, 148 enum ieee80211_phymode); 149 150 /* 151 * Return the size of the 802.11 header for a management or data frame. 152 */ 153 static __inline int 154 ieee80211_hdrsize(const void *data) 155 { 156 const struct ieee80211_frame *wh = (const struct ieee80211_frame *)data; 157 int size = sizeof(struct ieee80211_frame); 158 159 /* NB: we don't handle control frames */ 160 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL, 161 ("%s: control frame", __func__)); 162 if (IEEE80211_IS_DSTODS(wh)) 163 size += IEEE80211_ADDR_LEN; 164 if (IEEE80211_QOS_HAS_SEQ(wh)) 165 size += sizeof(uint16_t); 166 return size; 167 } 168 169 /* 170 * Like ieee80211_hdrsize, but handles any type of frame. 171 */ 172 static __inline int 173 ieee80211_anyhdrsize(const void *data) 174 { 175 const struct ieee80211_frame *wh = (const struct ieee80211_frame *)data; 176 177 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) { 178 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) { 179 case IEEE80211_FC0_SUBTYPE_CTS: 180 case IEEE80211_FC0_SUBTYPE_ACK: 181 return sizeof(struct ieee80211_frame_ack); 182 case IEEE80211_FC0_SUBTYPE_BAR: 183 return sizeof(struct ieee80211_frame_bar); 184 } 185 return sizeof(struct ieee80211_frame_min); 186 } else 187 return ieee80211_hdrsize(data); 188 } 189 190 /* 191 * Template for an in-kernel authenticator. Authenticators 192 * register with the protocol code and are typically loaded 193 * as separate modules as needed. One special authenticator 194 * is xauth; it intercepts requests so that protocols like 195 * WPA can be handled in user space. 196 */ 197 struct ieee80211_authenticator { 198 const char *ia_name; /* printable name */ 199 int (*ia_attach)(struct ieee80211vap *); 200 void (*ia_detach)(struct ieee80211vap *); 201 void (*ia_node_join)(struct ieee80211_node *); 202 void (*ia_node_leave)(struct ieee80211_node *); 203 }; 204 void ieee80211_authenticator_register(int type, 205 const struct ieee80211_authenticator *); 206 void ieee80211_authenticator_unregister(int type); 207 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 208 209 struct ieee80211req; 210 /* 211 * Template for an MAC ACL policy module. Such modules 212 * register with the protocol code and are passed the sender's 213 * address of each received auth frame for validation. 214 */ 215 struct ieee80211_aclator { 216 const char *iac_name; /* printable name */ 217 int (*iac_attach)(struct ieee80211vap *); 218 void (*iac_detach)(struct ieee80211vap *); 219 int (*iac_check)(struct ieee80211vap *, 220 const uint8_t mac[IEEE80211_ADDR_LEN]); 221 int (*iac_add)(struct ieee80211vap *, 222 const uint8_t mac[IEEE80211_ADDR_LEN]); 223 int (*iac_remove)(struct ieee80211vap *, 224 const uint8_t mac[IEEE80211_ADDR_LEN]); 225 int (*iac_flush)(struct ieee80211vap *); 226 int (*iac_setpolicy)(struct ieee80211vap *, int); 227 int (*iac_getpolicy)(struct ieee80211vap *); 228 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *); 229 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *); 230 }; 231 void ieee80211_aclator_register(const struct ieee80211_aclator *); 232 void ieee80211_aclator_unregister(const struct ieee80211_aclator *); 233 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 234 235 /* flags for ieee80211_fix_rate() */ 236 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 237 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */ 238 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 239 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 240 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */ 241 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */ 242 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */ 243 int ieee80211_fix_rate(struct ieee80211_node *, 244 struct ieee80211_rateset *, int); 245 246 /* 247 * WME/WMM support. 248 */ 249 struct wmeParams { 250 uint8_t wmep_acm; 251 uint8_t wmep_aifsn; 252 uint8_t wmep_logcwmin; /* log2(cwmin) */ 253 uint8_t wmep_logcwmax; /* log2(cwmax) */ 254 uint8_t wmep_txopLimit; 255 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */ 256 }; 257 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 258 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 259 260 struct chanAccParams { 261 uint8_t cap_info; /* version of the current set */ 262 struct wmeParams cap_wmeParams[WME_NUM_AC]; 263 }; 264 265 struct ieee80211_wme_state { 266 u_int wme_flags; 267 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 268 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 269 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 270 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 271 272 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/ 273 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */ 274 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */ 275 struct chanAccParams wme_chanParams; /* params applied to self */ 276 struct chanAccParams wme_bssChanParams; /* params bcast to stations */ 277 278 int (*wme_update)(struct ieee80211com *); 279 }; 280 281 void ieee80211_wme_initparams(struct ieee80211vap *); 282 void ieee80211_wme_updateparams(struct ieee80211vap *); 283 void ieee80211_wme_updateparams_locked(struct ieee80211vap *); 284 285 /* 286 * Return the WME TID from a QoS frame. If no TID 287 * is present return the index for the "non-QoS" entry. 288 */ 289 static __inline uint8_t 290 ieee80211_gettid(const struct ieee80211_frame *wh) 291 { 292 uint8_t tid; 293 294 if (IEEE80211_QOS_HAS_SEQ(wh)) { 295 if (IEEE80211_IS_DSTODS(wh)) 296 tid = ((const struct ieee80211_qosframe_addr4 *)wh)-> 297 i_qos[0]; 298 else 299 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0]; 300 tid &= IEEE80211_QOS_TID; 301 } else 302 tid = IEEE80211_NONQOS_TID; 303 return tid; 304 } 305 306 void ieee80211_waitfor_parent(struct ieee80211com *); 307 void ieee80211_start_locked(struct ieee80211vap *); 308 void ieee80211_init(void *); 309 void ieee80211_start_all(struct ieee80211com *); 310 void ieee80211_stop_locked(struct ieee80211vap *); 311 void ieee80211_stop(struct ieee80211vap *); 312 void ieee80211_stop_all(struct ieee80211com *); 313 void ieee80211_suspend_all(struct ieee80211com *); 314 void ieee80211_resume_all(struct ieee80211com *); 315 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags); 316 void ieee80211_swbmiss(void *arg); 317 void ieee80211_beacon_miss(struct ieee80211com *); 318 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int); 319 void ieee80211_print_essid(const uint8_t *, int); 320 void ieee80211_dump_pkt(struct ieee80211com *, 321 const uint8_t *, int, int, int); 322 323 extern const char *ieee80211_opmode_name[]; 324 extern const char *ieee80211_state_name[IEEE80211_S_MAX]; 325 extern const char *ieee80211_wme_acnames[]; 326 327 /* 328 * Beacon frames constructed by ieee80211_beacon_alloc 329 * have the following structure filled in so drivers 330 * can update the frame later w/ minimal overhead. 331 */ 332 struct ieee80211_beacon_offsets { 333 uint8_t bo_flags[4]; /* update/state flags */ 334 uint16_t *bo_caps; /* capabilities */ 335 uint8_t *bo_cfp; /* start of CFParms element */ 336 uint8_t *bo_tim; /* start of atim/dtim */ 337 uint8_t *bo_wme; /* start of WME parameters */ 338 uint8_t *bo_tdma; /* start of TDMA parameters */ 339 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */ 340 uint16_t bo_tim_len; /* atim/dtim length in bytes */ 341 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */ 342 uint8_t *bo_erp; /* start of ERP element */ 343 uint8_t *bo_htinfo; /* start of HT info element */ 344 uint8_t *bo_ath; /* start of ATH parameters */ 345 uint8_t *bo_appie; /* start of AppIE element */ 346 uint16_t bo_appie_len; /* AppIE length in bytes */ 347 uint16_t bo_csa_trailer_len; 348 uint8_t *bo_csa; /* start of CSA element */ 349 uint8_t *bo_meshconf; /* start of MESHCONF element */ 350 uint8_t *bo_spare[3]; 351 }; 352 struct 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 */ 367 enum { 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 }; 380 int ieee80211_beacon_update(struct ieee80211_node *, 381 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast); 382 383 void ieee80211_csa_startswitch(struct ieee80211com *, 384 struct ieee80211_channel *, int mode, int count); 385 void ieee80211_csa_completeswitch(struct ieee80211com *); 386 void ieee80211_csa_cancelswitch(struct ieee80211com *); 387 void 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 */ 394 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc); 395 void ieee80211_notify_node_leave(struct ieee80211_node *); 396 void ieee80211_notify_scan_done(struct ieee80211vap *); 397 void ieee80211_notify_wds_discover(struct ieee80211_node *); 398 void ieee80211_notify_csa(struct ieee80211com *, 399 const struct ieee80211_channel *, int mode, int count); 400 void ieee80211_notify_radar(struct ieee80211com *, 401 const struct ieee80211_channel *); 402 enum 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 }; 408 void ieee80211_notify_cac(struct ieee80211com *, 409 const struct ieee80211_channel *, 410 enum ieee80211_notify_cac_event); 411 void ieee80211_notify_node_deauth(struct ieee80211_node *); 412 void ieee80211_notify_node_auth(struct ieee80211_node *); 413 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [], 414 const uint8_t cc[2]); 415 void ieee80211_notify_radio(struct ieee80211com *, int); 416 #endif /* _FBSD_COMPAT_NET80211_IEEE80211_PROTO_H_ */ 417