ieee80211_proto.h revision 148315
1/*- 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002-2005 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 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * Alternatively, this software may be distributed under the terms of the 18 * GNU General Public License ("GPL") version 2 as published by the Free 19 * Software Foundation. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 * 32 * $FreeBSD: head/sys/net80211/ieee80211_proto.h 148315 2005-07-22 21:11:26Z sam $ 33 */ 34#ifndef _NET80211_IEEE80211_PROTO_H_ 35#define _NET80211_IEEE80211_PROTO_H_ 36 37/* 38 * 802.11 protocol implementation definitions. 39 */ 40 41enum ieee80211_state { 42 IEEE80211_S_INIT = 0, /* default state */ 43 IEEE80211_S_SCAN = 1, /* scanning */ 44 IEEE80211_S_AUTH = 2, /* try to authenticate */ 45 IEEE80211_S_ASSOC = 3, /* try to assoc */ 46 IEEE80211_S_RUN = 4, /* associated */ 47}; 48#define IEEE80211_S_MAX (IEEE80211_S_RUN+1) 49 50#define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \ 51 ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg)) 52 53extern const char *ieee80211_mgt_subtype_name[]; 54extern const char *ieee80211_phymode_name[]; 55 56void ieee80211_proto_attach(struct ieee80211com *); 57void ieee80211_proto_detach(struct ieee80211com *); 58 59struct ieee80211_node; 60int ieee80211_input(struct ieee80211com *, struct mbuf *, 61 struct ieee80211_node *, int, u_int32_t); 62int ieee80211_setup_rates(struct ieee80211_node *ni, 63 const u_int8_t *rates, const u_int8_t *xrates, int flags); 64void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *, 65 struct ieee80211_node *, int, int, u_int32_t); 66int ieee80211_send_nulldata(struct ieee80211_node *); 67int ieee80211_send_probereq(struct ieee80211_node *ni, 68 const u_int8_t sa[IEEE80211_ADDR_LEN], 69 const u_int8_t da[IEEE80211_ADDR_LEN], 70 const u_int8_t bssid[IEEE80211_ADDR_LEN], 71 const u_int8_t *ssid, size_t ssidlen, 72 const void *optie, size_t optielen); 73int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *, 74 int, int); 75int ieee80211_classify(struct ieee80211com *, struct mbuf *, 76 struct ieee80211_node *); 77struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *, 78 struct ieee80211_node *); 79void ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *, 80 struct mbuf *); 81 82void ieee80211_reset_erp(struct ieee80211com *); 83void ieee80211_set_shortslottime(struct ieee80211com *, int onoff); 84int ieee80211_iserp_rateset(struct ieee80211com *, 85 struct ieee80211_rateset *); 86void ieee80211_set11gbasicrates(struct ieee80211_rateset *, 87 enum ieee80211_phymode); 88 89/* 90 * Return the size of the 802.11 header for a management or data frame. 91 */ 92static __inline int 93ieee80211_hdrsize(const void *data) 94{ 95 const struct ieee80211_frame *wh = data; 96 int size = sizeof(struct ieee80211_frame); 97 98 /* NB: we don't handle control frames */ 99 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL, 100 ("%s: control frame", __func__)); 101 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS) 102 size += IEEE80211_ADDR_LEN; 103 if (IEEE80211_QOS_HAS_SEQ(wh)) 104 size += sizeof(u_int16_t); 105 return size; 106} 107 108/* 109 * Return the size of the 802.11 header; handles any type of frame. 110 */ 111static __inline int 112ieee80211_anyhdrsize(const void *data) 113{ 114 const struct ieee80211_frame *wh = data; 115 116 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) { 117 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) { 118 case IEEE80211_FC0_SUBTYPE_CTS: 119 case IEEE80211_FC0_SUBTYPE_ACK: 120 return sizeof(struct ieee80211_frame_ack); 121 } 122 return sizeof(struct ieee80211_frame_min); 123 } else 124 return ieee80211_hdrsize(data); 125} 126 127/* 128 * Template for an in-kernel authenticator. Authenticators 129 * register with the protocol code and are typically loaded 130 * as separate modules as needed. 131 */ 132struct ieee80211_authenticator { 133 const char *ia_name; /* printable name */ 134 int (*ia_attach)(struct ieee80211com *); 135 void (*ia_detach)(struct ieee80211com *); 136 void (*ia_node_join)(struct ieee80211com *, 137 struct ieee80211_node *); 138 void (*ia_node_leave)(struct ieee80211com *, 139 struct ieee80211_node *); 140}; 141void ieee80211_authenticator_register(int type, 142 const struct ieee80211_authenticator *); 143void ieee80211_authenticator_unregister(int type); 144const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth); 145 146/* 147 * Template for an MAC ACL policy module. Such modules 148 * register with the protocol code and are passed the sender's 149 * address of each received frame for validation. 150 */ 151struct ieee80211_aclator { 152 const char *iac_name; /* printable name */ 153 int (*iac_attach)(struct ieee80211com *); 154 void (*iac_detach)(struct ieee80211com *); 155 int (*iac_check)(struct ieee80211com *, 156 const u_int8_t mac[IEEE80211_ADDR_LEN]); 157 int (*iac_add)(struct ieee80211com *, 158 const u_int8_t mac[IEEE80211_ADDR_LEN]); 159 int (*iac_remove)(struct ieee80211com *, 160 const u_int8_t mac[IEEE80211_ADDR_LEN]); 161 int (*iac_flush)(struct ieee80211com *); 162 int (*iac_setpolicy)(struct ieee80211com *, int); 163 int (*iac_getpolicy)(struct ieee80211com *); 164}; 165void ieee80211_aclator_register(const struct ieee80211_aclator *); 166void ieee80211_aclator_unregister(const struct ieee80211_aclator *); 167const struct ieee80211_aclator *ieee80211_aclator_get(const char *name); 168 169/* flags for ieee80211_fix_rate() */ 170#define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */ 171#define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */ 172#define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */ 173#define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */ 174int ieee80211_fix_rate(struct ieee80211_node *, int); 175 176/* 177 * WME/WMM support. 178 */ 179struct wmeParams { 180 u_int8_t wmep_acm; 181 u_int8_t wmep_aifsn; 182 u_int8_t wmep_logcwmin; /* log2(cwmin) */ 183 u_int8_t wmep_logcwmax; /* log2(cwmax) */ 184 u_int8_t wmep_txopLimit; 185 u_int8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */ 186}; 187#define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5) 188#define IEEE80211_US_TO_TXOP(_us) ((_us)>>5) 189 190struct chanAccParams { 191 u_int8_t cap_info; /* version of the current set */ 192 struct wmeParams cap_wmeParams[WME_NUM_AC]; 193}; 194 195struct ieee80211_wme_state { 196 u_int wme_flags; 197#define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */ 198 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */ 199 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */ 200 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */ 201 202 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/ 203 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */ 204 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */ 205 struct chanAccParams wme_chanParams; /* params applied to self */ 206 struct chanAccParams wme_bssChanParams; /* params bcast to stations */ 207 208 int (*wme_update)(struct ieee80211com *); 209}; 210 211void ieee80211_wme_initparams(struct ieee80211com *); 212void ieee80211_wme_updateparams(struct ieee80211com *); 213void ieee80211_wme_updateparams_locked(struct ieee80211com *); 214 215#define ieee80211_new_state(_ic, _nstate, _arg) \ 216 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg))) 217void ieee80211_print_essid(const u_int8_t *, int); 218void ieee80211_dump_pkt(const u_int8_t *, int, int, int); 219 220extern const char *ieee80211_state_name[IEEE80211_S_MAX]; 221extern const char *ieee80211_wme_acnames[]; 222 223/* 224 * Beacon frames constructed by ieee80211_beacon_alloc 225 * have the following structure filled in so drivers 226 * can update the frame later w/ minimal overhead. 227 */ 228struct ieee80211_beacon_offsets { 229 u_int16_t *bo_caps; /* capabilities */ 230 u_int8_t *bo_tim; /* start of atim/dtim */ 231 u_int8_t *bo_wme; /* start of WME parameters */ 232 u_int8_t *bo_trailer; /* start of fixed-size trailer */ 233 u_int16_t bo_tim_len; /* atim/dtim length in bytes */ 234 u_int16_t bo_trailer_len; /* trailer length in bytes */ 235}; 236struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *, 237 struct ieee80211_node *, struct ieee80211_beacon_offsets *); 238int ieee80211_beacon_update(struct ieee80211com *, 239 struct ieee80211_node *, struct ieee80211_beacon_offsets *, 240 struct mbuf *, int broadcast); 241 242/* 243 * Notification methods called from the 802.11 state machine. 244 * Note that while these are defined here, their implementation 245 * is OS-specific. 246 */ 247void ieee80211_notify_node_join(struct ieee80211com *, 248 struct ieee80211_node *, int newassoc); 249void ieee80211_notify_node_leave(struct ieee80211com *, 250 struct ieee80211_node *); 251void ieee80211_notify_scan_done(struct ieee80211com *); 252#endif /* _NET80211_IEEE80211_PROTO_H_ */ 253