2 * Copyright (c) 2001 Atsushi Onoe
3 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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.
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.
34 #ifndef _NET80211_IEEE80211_PROTO_H_
35 #define _NET80211_IEEE80211_PROTO_H_
38 * 802.11 protocol implementation definitions.
41 enum 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 */
48 #define IEEE80211_S_MAX (IEEE80211_S_RUN+1)
50 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
51 ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
53 extern const char *ieee80211_mgt_subtype_name[];
54 extern const char *ieee80211_phymode_name[];
56 void ieee80211_proto_attach(struct ieee80211com *);
57 void ieee80211_proto_detach(struct ieee80211com *);
59 struct ieee80211_node;
60 int ieee80211_input(struct ieee80211com *, struct mbuf *,
61 struct ieee80211_node *, int, u_int32_t);
62 int ieee80211_setup_rates(struct ieee80211_node *ni,
63 const u_int8_t *rates, const u_int8_t *xrates, int flags);
64 void ieee80211_saveie(u_int8_t **, const u_int8_t *);
65 void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
66 struct ieee80211_node *, int, int, u_int32_t);
67 struct ieee80211_bpf_params;
68 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
69 const struct ieee80211_bpf_params *);
70 int ieee80211_output(struct ifnet *, struct mbuf *,
71 struct sockaddr *, struct rtentry *);
72 int ieee80211_send_nulldata(struct ieee80211_node *);
73 int ieee80211_send_probereq(struct ieee80211_node *ni,
74 const u_int8_t sa[IEEE80211_ADDR_LEN],
75 const u_int8_t da[IEEE80211_ADDR_LEN],
76 const u_int8_t bssid[IEEE80211_ADDR_LEN],
77 const u_int8_t *ssid, size_t ssidlen,
78 const void *optie, size_t optielen);
79 int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
81 int ieee80211_classify(struct ieee80211com *, struct mbuf *,
82 struct ieee80211_node *);
83 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
84 struct ieee80211_node *);
85 void ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *,
88 void ieee80211_reset_erp(struct ieee80211com *);
89 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
90 int ieee80211_iserp_rateset(struct ieee80211com *,
91 struct ieee80211_rateset *);
92 void ieee80211_set11gbasicrates(struct ieee80211_rateset *,
93 enum ieee80211_phymode);
96 * Return the size of the 802.11 header for a management or data frame.
99 ieee80211_hdrsize(const void *data)
101 const struct ieee80211_frame *wh = data;
102 int size = sizeof(struct ieee80211_frame);
104 /* NB: we don't handle control frames */
105 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
106 ("%s: control frame", __func__));
107 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
108 size += IEEE80211_ADDR_LEN;
109 if (IEEE80211_QOS_HAS_SEQ(wh))
110 size += sizeof(u_int16_t);
115 * Return the size of the 802.11 header; handles any type of frame.
118 ieee80211_anyhdrsize(const void *data)
120 const struct ieee80211_frame *wh = data;
122 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
123 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
124 case IEEE80211_FC0_SUBTYPE_CTS:
125 case IEEE80211_FC0_SUBTYPE_ACK:
126 return sizeof(struct ieee80211_frame_ack);
128 return sizeof(struct ieee80211_frame_min);
130 return ieee80211_hdrsize(data);
134 * Template for an in-kernel authenticator. Authenticators
135 * register with the protocol code and are typically loaded
136 * as separate modules as needed.
138 struct ieee80211_authenticator {
139 const char *ia_name; /* printable name */
140 int (*ia_attach)(struct ieee80211com *);
141 void (*ia_detach)(struct ieee80211com *);
142 void (*ia_node_join)(struct ieee80211com *,
143 struct ieee80211_node *);
144 void (*ia_node_leave)(struct ieee80211com *,
145 struct ieee80211_node *);
147 void ieee80211_authenticator_register(int type,
148 const struct ieee80211_authenticator *);
149 void ieee80211_authenticator_unregister(int type);
150 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
154 * Template for an MAC ACL policy module. Such modules
155 * register with the protocol code and are passed the sender's
156 * address of each received frame for validation.
158 struct ieee80211_aclator {
159 const char *iac_name; /* printable name */
160 int (*iac_attach)(struct ieee80211com *);
161 void (*iac_detach)(struct ieee80211com *);
162 int (*iac_check)(struct ieee80211com *,
163 const u_int8_t mac[IEEE80211_ADDR_LEN]);
164 int (*iac_add)(struct ieee80211com *,
165 const u_int8_t mac[IEEE80211_ADDR_LEN]);
166 int (*iac_remove)(struct ieee80211com *,
167 const u_int8_t mac[IEEE80211_ADDR_LEN]);
168 int (*iac_flush)(struct ieee80211com *);
169 int (*iac_setpolicy)(struct ieee80211com *, int);
170 int (*iac_getpolicy)(struct ieee80211com *);
171 int (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
172 int (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
174 void ieee80211_aclator_register(const struct ieee80211_aclator *);
175 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
176 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
178 /* flags for ieee80211_fix_rate() */
179 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
180 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
181 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
182 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
183 #define IEEE80211_F_JOIN 0x00000010 /* sta joining our bss */
184 int ieee80211_fix_rate(struct ieee80211_node *,
185 struct ieee80211_rateset *, int);
193 u_int8_t wmep_logcwmin; /* log2(cwmin) */
194 u_int8_t wmep_logcwmax; /* log2(cwmax) */
195 u_int8_t wmep_txopLimit;
196 u_int8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
198 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
199 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
201 struct chanAccParams {
202 u_int8_t cap_info; /* version of the current set */
203 struct wmeParams cap_wmeParams[WME_NUM_AC];
206 struct ieee80211_wme_state {
208 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
209 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
210 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
211 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
213 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
214 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
215 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
216 struct chanAccParams wme_chanParams; /* params applied to self */
217 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
219 int (*wme_update)(struct ieee80211com *);
222 void ieee80211_wme_initparams(struct ieee80211com *);
223 void ieee80211_wme_updateparams(struct ieee80211com *);
224 void ieee80211_wme_updateparams_locked(struct ieee80211com *);
226 #define ieee80211_new_state(_ic, _nstate, _arg) \
227 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
228 void ieee80211_beacon_miss(struct ieee80211com *);
229 void ieee80211_print_essid(const u_int8_t *, int);
230 void ieee80211_dump_pkt(const u_int8_t *, int, int, int);
232 extern const char *ieee80211_opmode_name[];
233 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
234 extern const char *ieee80211_wme_acnames[];
237 * Beacon frames constructed by ieee80211_beacon_alloc
238 * have the following structure filled in so drivers
239 * can update the frame later w/ minimal overhead.
241 struct ieee80211_beacon_offsets {
242 u_int16_t *bo_caps; /* capabilities */
243 u_int8_t *bo_tim; /* start of atim/dtim */
244 u_int8_t *bo_wme; /* start of WME parameters */
245 u_int8_t *bo_trailer; /* start of fixed-size trailer */
246 u_int16_t bo_tim_len; /* atim/dtim length in bytes */
247 u_int16_t bo_trailer_len; /* trailer length in bytes */
248 u_int8_t *bo_erp; /* start of ERP element */
250 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
251 struct ieee80211_node *, struct ieee80211_beacon_offsets *);
252 int ieee80211_beacon_update(struct ieee80211com *,
253 struct ieee80211_node *, struct ieee80211_beacon_offsets *,
254 struct mbuf *, int broadcast);
257 * Notification methods called from the 802.11 state machine.
258 * Note that while these are defined here, their implementation
261 void ieee80211_notify_node_join(struct ieee80211com *,
262 struct ieee80211_node *, int newassoc);
263 void ieee80211_notify_node_leave(struct ieee80211com *,
264 struct ieee80211_node *);
265 void ieee80211_notify_scan_done(struct ieee80211com *);
266 #endif /* _NET80211_IEEE80211_PROTO_H_ */