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.
32 * $FreeBSD: src/sys/net80211/ieee80211_proto.h,v 1.11.2.5 2006/02/12 19:00:39 sam Exp $
33 * $DragonFly: src/sys/netproto/802_11/ieee80211_proto.h,v 1.3 2006/11/25 13:11:30 sephe Exp $
35 #ifndef _NET80211_IEEE80211_PROTO_H_
36 #define _NET80211_IEEE80211_PROTO_H_
39 * 802.11 protocol implementation definitions.
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 */
49 #define IEEE80211_S_MAX (IEEE80211_S_RUN+1)
51 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
52 ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
54 extern const char *ieee80211_mgt_subtype_name[];
55 extern const char *ieee80211_phymode_name[];
57 void ieee80211_proto_attach(struct ieee80211com *);
58 void ieee80211_proto_detach(struct ieee80211com *);
60 struct ieee80211_node;
61 int ieee80211_input(struct ieee80211com *, struct mbuf *,
62 struct ieee80211_node *, int, uint32_t);
63 int ieee80211_setup_rates(struct ieee80211_node *ni,
64 const uint8_t *rates, const uint8_t *xrates, int flags);
65 void ieee80211_saveie(uint8_t **, const uint8_t *);
66 void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
67 struct ieee80211_node *, int, int, uint32_t);
68 int ieee80211_send_nulldata(struct ieee80211_node *);
69 int ieee80211_send_probereq(struct ieee80211_node *ni,
70 const uint8_t sa[IEEE80211_ADDR_LEN],
71 const uint8_t da[IEEE80211_ADDR_LEN],
72 const uint8_t bssid[IEEE80211_ADDR_LEN],
73 const uint8_t *ssid, size_t ssidlen,
74 const void *optie, size_t optielen);
75 int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
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 *,
84 void ieee80211_reset_erp(struct ieee80211com *);
85 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
86 void ieee80211_set_shortpreamble(struct ieee80211com *,
87 const struct ieee80211_node *);
88 int ieee80211_iserp_rateset(struct ieee80211com *,
89 struct ieee80211_rateset *);
90 void ieee80211_set11gbasicrates(struct ieee80211_rateset *,
91 enum ieee80211_phymode);
94 * Return the size of the 802.11 header for a management or data frame.
97 ieee80211_hdrsize(const void *data)
99 const struct ieee80211_frame *wh = data;
100 int size = sizeof(struct ieee80211_frame);
102 /* NB: we don't handle control frames */
103 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
104 ("%s: control frame", __func__));
105 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
106 size += IEEE80211_ADDR_LEN;
107 if (IEEE80211_QOS_HAS_SEQ(wh))
108 size += sizeof(uint16_t);
113 * Return the size of the 802.11 header; handles any type of frame.
116 ieee80211_anyhdrsize(const void *data)
118 const struct ieee80211_frame *wh = data;
120 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
121 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
122 case IEEE80211_FC0_SUBTYPE_CTS:
123 case IEEE80211_FC0_SUBTYPE_ACK:
124 return sizeof(struct ieee80211_frame_ack);
126 return sizeof(struct ieee80211_frame_min);
128 return ieee80211_hdrsize(data);
132 * Template for an in-kernel authenticator. Authenticators
133 * register with the protocol code and are typically loaded
134 * as separate modules as needed.
136 struct ieee80211_authenticator {
137 const char *ia_name; /* printable name */
138 int (*ia_attach)(struct ieee80211com *);
139 void (*ia_detach)(struct ieee80211com *);
140 void (*ia_node_join)(struct ieee80211com *,
141 struct ieee80211_node *);
142 void (*ia_node_leave)(struct ieee80211com *,
143 struct ieee80211_node *);
145 void ieee80211_authenticator_register(int type,
146 const struct ieee80211_authenticator *);
147 void ieee80211_authenticator_unregister(int type);
148 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
152 * Template for an MAC ACL policy module. Such modules
153 * register with the protocol code and are passed the sender's
154 * address of each received frame for validation.
156 struct ieee80211_aclator {
157 const char *iac_name; /* printable name */
158 int (*iac_attach)(struct ieee80211com *);
159 void (*iac_detach)(struct ieee80211com *);
160 int (*iac_check)(struct ieee80211com *,
161 const uint8_t mac[IEEE80211_ADDR_LEN]);
162 int (*iac_add)(struct ieee80211com *,
163 const uint8_t mac[IEEE80211_ADDR_LEN]);
164 int (*iac_remove)(struct ieee80211com *,
165 const uint8_t mac[IEEE80211_ADDR_LEN]);
166 int (*iac_flush)(struct ieee80211com *);
167 int (*iac_setpolicy)(struct ieee80211com *, int);
168 int (*iac_getpolicy)(struct ieee80211com *);
169 int (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
170 int (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
172 void ieee80211_aclator_register(const struct ieee80211_aclator *);
173 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
174 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
176 /* flags for ieee80211_fix_rate() */
177 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
178 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
179 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
180 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
181 int ieee80211_fix_rate(struct ieee80211_node *, int);
189 uint8_t wmep_logcwmin; /* log2(cwmin) */
190 uint8_t wmep_logcwmax; /* log2(cwmax) */
191 uint8_t wmep_txopLimit;
192 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
194 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
195 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
197 struct chanAccParams {
198 uint8_t cap_info; /* version of the current set */
199 struct wmeParams cap_wmeParams[WME_NUM_AC];
202 struct ieee80211_wme_state {
204 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
205 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
206 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
207 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
209 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
210 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
211 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
212 struct chanAccParams wme_chanParams; /* params applied to self */
213 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
215 int (*wme_update)(struct ieee80211com *);
218 void ieee80211_wme_initparams(struct ieee80211com *);
219 void ieee80211_wme_updateparams(struct ieee80211com *);
221 #define ieee80211_new_state(_ic, _nstate, _arg) \
222 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
223 void ieee80211_beacon_miss(struct ieee80211com *);
224 void ieee80211_print_essid(const uint8_t *, int);
225 void ieee80211_dump_pkt(const uint8_t *, int, int, int);
227 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
228 extern const char *ieee80211_wme_acnames[];
231 * Beacon frames constructed by ieee80211_beacon_alloc
232 * have the following structure filled in so drivers
233 * can update the frame later w/ minimal overhead.
235 struct ieee80211_beacon_offsets {
236 uint16_t *bo_caps; /* capabilities */
237 uint8_t *bo_tim; /* start of atim/dtim */
238 uint8_t *bo_wme; /* start of WME parameters */
239 uint8_t *bo_trailer; /* start of fixed-size trailer */
240 uint16_t bo_tim_len; /* atim/dtim length in bytes */
241 uint16_t bo_trailer_len; /* trailer length in bytes */
242 uint8_t *bo_erp; /* start of ERP element */
243 void *bo_pad[8]; /* future expansion */
245 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
246 struct ieee80211_node *, struct ieee80211_beacon_offsets *);
247 int ieee80211_beacon_update(struct ieee80211com *,
248 struct ieee80211_node *, struct ieee80211_beacon_offsets *,
249 struct mbuf *, int broadcast);
252 * Notification methods called from the 802.11 state machine.
253 * Note that while these are defined here, their implementation
256 void ieee80211_notify_node_join(struct ieee80211com *,
257 struct ieee80211_node *, int newassoc);
258 void ieee80211_notify_node_leave(struct ieee80211com *,
259 struct ieee80211_node *);
260 void ieee80211_notify_scan_done(struct ieee80211com *);
261 #endif /* _NET80211_IEEE80211_PROTO_H_ */