ieee80211_proto.h revision 199187
1126274Sdes/*- 2126274Sdes * Copyright (c) 2001 Atsushi Onoe 3124208Sdes * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting 498937Sdes * All rights reserved. 598937Sdes * 698937Sdes * Redistribution and use in source and binary forms, with or without 798937Sdes * modification, are permitted provided that the following conditions 8124208Sdes * are met: 9124208Sdes * 1. Redistributions of source code must retain the above copyright 10124208Sdes * notice, this list of conditions and the following disclaimer. 1198937Sdes * 2. Redistributions in binary form must reproduce the above copyright 12124208Sdes * notice, this list of conditions and the following disclaimer in the 13124208Sdes * documentation and/or other materials provided with the distribution. 14124208Sdes * 15124208Sdes * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16124208Sdes * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17124208Sdes * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18124208Sdes * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 1998937Sdes * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2098937Sdes * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21106121Sdes * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2298937Sdes * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2398937Sdes * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2498937Sdes * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25124208Sdes * 2698937Sdes * $FreeBSD: head/sys/net80211/ieee80211_proto.h 199187 2009-11-11 15:00:56Z antoine $ 2798937Sdes */ 2898937Sdes#ifndef _NET80211_IEEE80211_PROTO_H_ 2998937Sdes#define _NET80211_IEEE80211_PROTO_H_ 3098937Sdes 3198937Sdes/* 3298937Sdes * 802.11 protocol implementation definitions. 3398937Sdes */ 3498937Sdes 3598937Sdesenum ieee80211_state { 3698937Sdes IEEE80211_S_INIT = 0, /* default state */ 3798937Sdes IEEE80211_S_SCAN = 1, /* scanning */ 3898937Sdes IEEE80211_S_AUTH = 2, /* try to authenticate */ 39124208Sdes IEEE80211_S_ASSOC = 3, /* try to assoc */ 4098937Sdes IEEE80211_S_CAC = 4, /* doing channel availability check */ 4198937Sdes IEEE80211_S_RUN = 5, /* operational (e.g. associated) */ 4298937Sdes IEEE80211_S_CSA = 6, /* channel switch announce pending */ 4398937Sdes IEEE80211_S_SLEEP = 7, /* power save */ 4498937Sdes}; 4598937Sdes#define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1) 4698937Sdes 4798937Sdes#define IEEE80211_SEND_MGMT(_ni,_type,_arg) \ 4898937Sdes ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg)) 4998937Sdes 5098937Sdesextern const char *ieee80211_mgt_subtype_name[]; 5198937Sdesextern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX]; 5298937Sdesextern const int ieee80211_opcap[IEEE80211_OPMODE_MAX]; 5398937Sdes 5498937Sdesvoid ieee80211_proto_attach(struct ieee80211com *); 5598937Sdesvoid ieee80211_proto_detach(struct ieee80211com *); 5698937Sdesvoid ieee80211_proto_vattach(struct ieee80211vap *); 5798937Sdesvoid ieee80211_proto_vdetach(struct ieee80211vap *); 5898937Sdes 5998937Sdesvoid ieee80211_syncifflag_locked(struct ieee80211com *, int flag); 6098937Sdesvoid ieee80211_syncflag(struct ieee80211vap *, int flag); 6198937Sdesvoid ieee80211_syncflag_ht(struct ieee80211vap *, int flag); 6298937Sdesvoid ieee80211_syncflag_ext(struct ieee80211vap *, int flag); 6398937Sdes 6498937Sdes#define ieee80211_input(ni, m, rssi, nf) \ 6598937Sdes ((ni)->ni_vap->iv_input(ni, m, rssi, nf)) 6698937Sdesint ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int); 67struct ieee80211_bpf_params; 68int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int, 69 struct ieee80211_bpf_params *); 70int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *, 71 const struct ieee80211_bpf_params *); 72int ieee80211_output(struct ifnet *, struct mbuf *, 73 struct sockaddr *, struct route *ro); 74void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int, 75 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN], 76 const uint8_t [IEEE80211_ADDR_LEN]); 77void ieee80211_start(struct ifnet *); 78int ieee80211_send_nulldata(struct ieee80211_node *); 79int ieee80211_classify(struct ieee80211_node *, struct mbuf *m); 80struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int, 81 struct ieee80211_key *, struct mbuf *); 82struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *, 83 struct mbuf *); 84int ieee80211_send_mgmt(struct ieee80211_node *, int, int); 85struct ieee80211_appie; 86int ieee80211_send_probereq(struct ieee80211_node *ni, 87 const uint8_t sa[IEEE80211_ADDR_LEN], 88 const uint8_t da[IEEE80211_ADDR_LEN], 89 const uint8_t bssid[IEEE80211_ADDR_LEN], 90 const uint8_t *ssid, size_t ssidlen); 91/* 92 * The formation of ProbeResponse frames requires guidance to 93 * deal with legacy clients. When the client is identified as 94 * "legacy 11b" ieee80211_send_proberesp is passed this token. 95 */ 96#define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */ 97#define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */ 98#define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */ 99struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int); 100int ieee80211_send_proberesp(struct ieee80211vap *, 101 const uint8_t da[IEEE80211_ADDR_LEN], int); 102struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic, 103 const uint8_t [IEEE80211_ADDR_LEN], 104 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 105struct mbuf *ieee80211_alloc_cts(struct ieee80211com *, 106 const uint8_t [IEEE80211_ADDR_LEN], uint16_t); 107 108uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *); 109uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *); 110uint16_t ieee80211_getcapinfo(struct ieee80211vap *, 111 struct ieee80211_channel *); 112 113void ieee80211_reset_erp(struct ieee80211com *); 114void ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 115int ieee80211_iserp_rateset(const struct ieee80211_rateset *); 116void ieee80211_setbasicrates(struct ieee80211_rateset *, 117 enum ieee80211_phymode); 118void ieee80211_addbasicrates(struct ieee80211_rateset *, 119 enum ieee80211_phymode); 120 121/* 122 * Return the size of the 802.11 header for a management or data frame. 123 */ 124static __inline int 125ieee80211_hdrsize(const void *data) 126{ 127 const struct ieee80211_frame *wh = data; 128 int size = sizeof(struct ieee80211_frame); 129 130 /* NB: we don't handle control frames */ 131 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL, 132 ("%s: control frame", __func__)); 133 if (IEEE80211_IS_DSTODS(wh)) 134 size += IEEE80211_ADDR_LEN; 135 if (IEEE80211_QOS_HAS_SEQ(wh)) 136 size += sizeof(uint16_t); 137 return size; 138} 139 140/* 141 * Like ieee80211_hdrsize, but handles any type of frame. 142 */ 143static __inline int 144ieee80211_anyhdrsize(const void *data) 145{ 146 const struct ieee80211_frame *wh = data; 147 148 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) { 149 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) { 150 case IEEE80211_FC0_SUBTYPE_CTS: 151 case IEEE80211_FC0_SUBTYPE_ACK: 152 return sizeof(struct ieee80211_frame_ack); 153 case IEEE80211_FC0_SUBTYPE_BAR: 154 return sizeof(struct ieee80211_frame_bar); 155 } 156 return sizeof(struct ieee80211_frame_min); 157 } else 158 return ieee80211_hdrsize(data); 159} 160 161/* 162 * Template for an in-kernel authenticator. Authenticators 163 * register with the protocol code and are typically loaded 164 * as separate modules as needed. One special authenticator 165 * is xauth; it intercepts requests so that protocols like 166 * WPA can be handled in user space. 167 */ 168struct ieee80211_authenticator { 169 const char *ia_name; /* printable name */ 170 int (*ia_attach)(struct ieee80211vap *); 171 void (*ia_detach)(struct ieee80211vap *); 172 void (*ia_node_join)(struct ieee80211_node *); 173 void (*ia_node_leave)(struct ieee80211_node *); 174}; 175void ieee80211_authenticator_register(int type, 176 const struct ieee80211_authenticator *); 177void ieee80211_authenticator_unregister(int type); 178const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 179 180struct ieee80211req; 181/* 182 * Template for an MAC ACL policy module. Such modules 183 * register with the protocol code and are passed the sender's 184 * address of each received auth frame for validation. 185 */ 186struct ieee80211_aclator { 187 const char *iac_name; /* printable name */ 188 int (*iac_attach)(struct ieee80211vap *); 189 void (*iac_detach)(struct ieee80211vap *); 190 int (*iac_check)(struct ieee80211vap *, 191 const uint8_t mac[IEEE80211_ADDR_LEN]); 192 int (*iac_add)(struct ieee80211vap *, 193 const uint8_t mac[IEEE80211_ADDR_LEN]); 194 int (*iac_remove)(struct ieee80211vap *, 195 const uint8_t mac[IEEE80211_ADDR_LEN]); 196 int (*iac_flush)(struct ieee80211vap *); 197 int (*iac_setpolicy)(struct ieee80211vap *, int); 198 int (*iac_getpolicy)(struct ieee80211vap *); 199 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *); 200 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *); 201}; 202void ieee80211_aclator_register(const struct ieee80211_aclator *); 203void ieee80211_aclator_unregister(const struct ieee80211_aclator *); 204const struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 205 206/* flags for ieee80211_fix_rate() */ 207#define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 208#define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */ 209#define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 210#define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 211#define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */ 212#define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */ 213#define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */ 214int ieee80211_fix_rate(struct ieee80211_node *, 215 struct ieee80211_rateset *, int); 216 217/* 218 * WME/WMM support. 219 */ 220struct wmeParams { 221 uint8_t wmep_acm; 222 uint8_t wmep_aifsn; 223 uint8_t wmep_logcwmin; /* log2(cwmin) */ 224 uint8_t wmep_logcwmax; /* log2(cwmax) */ 225 uint8_t wmep_txopLimit; 226 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */ 227}; 228#define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 229#define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 230 231struct chanAccParams { 232 uint8_t cap_info; /* version of the current set */ 233 struct wmeParams cap_wmeParams[WME_NUM_AC]; 234}; 235 236struct ieee80211_wme_state { 237 u_int wme_flags; 238#define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 239 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 240 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 241 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 242 243 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/ 244 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */ 245 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */ 246 struct chanAccParams wme_chanParams; /* params applied to self */ 247 struct chanAccParams wme_bssChanParams; /* params bcast to stations */ 248 249 int (*wme_update)(struct ieee80211com *); 250}; 251 252void ieee80211_wme_initparams(struct ieee80211vap *); 253void ieee80211_wme_updateparams(struct ieee80211vap *); 254void ieee80211_wme_updateparams_locked(struct ieee80211vap *); 255 256/* 257 * Return the WME TID from a QoS frame. If no TID 258 * is present return the index for the "non-QoS" entry. 259 */ 260static __inline uint8_t 261ieee80211_gettid(const struct ieee80211_frame *wh) 262{ 263 uint8_t tid; 264 265 if (IEEE80211_QOS_HAS_SEQ(wh)) { 266 if (IEEE80211_IS_DSTODS(wh)) 267 tid = ((const struct ieee80211_qosframe_addr4 *)wh)-> 268 i_qos[0]; 269 else 270 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0]; 271 tid &= IEEE80211_QOS_TID; 272 } else 273 tid = IEEE80211_NONQOS_TID; 274 return tid; 275} 276 277void ieee80211_waitfor_parent(struct ieee80211com *); 278void ieee80211_start_locked(struct ieee80211vap *); 279void ieee80211_init(void *); 280void ieee80211_start_all(struct ieee80211com *); 281void ieee80211_stop_locked(struct ieee80211vap *); 282void ieee80211_stop(struct ieee80211vap *); 283void ieee80211_stop_all(struct ieee80211com *); 284void ieee80211_suspend_all(struct ieee80211com *); 285void ieee80211_resume_all(struct ieee80211com *); 286void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags); 287void ieee80211_swbmiss(void *arg); 288void ieee80211_beacon_miss(struct ieee80211com *); 289int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int); 290void ieee80211_print_essid(const uint8_t *, int); 291void ieee80211_dump_pkt(struct ieee80211com *, 292 const uint8_t *, int, int, int); 293 294extern const char *ieee80211_opmode_name[]; 295extern const char *ieee80211_state_name[IEEE80211_S_MAX]; 296extern const char *ieee80211_wme_acnames[]; 297 298/* 299 * Beacon frames constructed by ieee80211_beacon_alloc 300 * have the following structure filled in so drivers 301 * can update the frame later w/ minimal overhead. 302 */ 303struct ieee80211_beacon_offsets { 304 uint8_t bo_flags[4]; /* update/state flags */ 305 uint16_t *bo_caps; /* capabilities */ 306 uint8_t *bo_cfp; /* start of CFParms element */ 307 uint8_t *bo_tim; /* start of atim/dtim */ 308 uint8_t *bo_wme; /* start of WME parameters */ 309 uint8_t *bo_tdma; /* start of TDMA parameters */ 310 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */ 311 uint16_t bo_tim_len; /* atim/dtim length in bytes */ 312 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */ 313 uint8_t *bo_erp; /* start of ERP element */ 314 uint8_t *bo_htinfo; /* start of HT info element */ 315 uint8_t *bo_ath; /* start of ATH parameters */ 316 uint8_t *bo_appie; /* start of AppIE element */ 317 uint16_t bo_appie_len; /* AppIE length in bytes */ 318 uint16_t bo_csa_trailer_len; 319 uint8_t *bo_csa; /* start of CSA element */ 320 uint8_t *bo_meshconf; /* start of MESHCONF element */ 321 uint8_t *bo_spare[3]; 322}; 323struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *, 324 struct ieee80211_beacon_offsets *); 325 326/* 327 * Beacon frame updates are signaled through calls to iv_update_beacon 328 * with one of the IEEE80211_BEACON_* tokens defined below. For devices 329 * that construct beacon frames on the host this can trigger a rebuild 330 * or defer the processing. For devices that offload beacon frame 331 * handling this callback can be used to signal a rebuild. The bo_flags 332 * array in the ieee80211_beacon_offsets structure is intended to record 333 * deferred processing requirements; ieee80211_beacon_update uses the 334 * state to optimize work. Since this structure is owned by the driver 335 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon 336 * callback that marks the flag bits and schedules (as necessary) an update. 337 */ 338enum { 339 IEEE80211_BEACON_CAPS = 0, /* capabilities */ 340 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */ 341 IEEE80211_BEACON_WME = 2, 342 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */ 343 IEEE80211_BEACON_HTINFO = 4, /* HT Information */ 344 IEEE80211_BEACON_APPIE = 5, /* Application IE's */ 345 IEEE80211_BEACON_CFP = 6, /* CFParms */ 346 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */ 347 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */ 348 IEEE80211_BEACON_ATH = 10, /* ATH parameters */ 349 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */ 350}; 351int ieee80211_beacon_update(struct ieee80211_node *, 352 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast); 353 354void ieee80211_csa_startswitch(struct ieee80211com *, 355 struct ieee80211_channel *, int mode, int count); 356void ieee80211_csa_completeswitch(struct ieee80211com *); 357void ieee80211_csa_cancelswitch(struct ieee80211com *); 358void ieee80211_cac_completeswitch(struct ieee80211vap *); 359 360/* 361 * Notification methods called from the 802.11 state machine. 362 * Note that while these are defined here, their implementation 363 * is OS-specific. 364 */ 365void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc); 366void ieee80211_notify_node_leave(struct ieee80211_node *); 367void ieee80211_notify_scan_done(struct ieee80211vap *); 368void ieee80211_notify_wds_discover(struct ieee80211_node *); 369void ieee80211_notify_csa(struct ieee80211com *, 370 const struct ieee80211_channel *, int mode, int count); 371void ieee80211_notify_radar(struct ieee80211com *, 372 const struct ieee80211_channel *); 373enum ieee80211_notify_cac_event { 374 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */ 375 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */ 376 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */ 377 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */ 378}; 379void ieee80211_notify_cac(struct ieee80211com *, 380 const struct ieee80211_channel *, 381 enum ieee80211_notify_cac_event); 382void ieee80211_notify_node_deauth(struct ieee80211_node *); 383void ieee80211_notify_node_auth(struct ieee80211_node *); 384void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [], 385 const uint8_t cc[2]); 386void ieee80211_notify_radio(struct ieee80211com *, int); 387#endif /* _NET80211_IEEE80211_PROTO_H_ */ 388