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