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