ieee80211_proto.h revision 1.11 1 /* $NetBSD: ieee80211_proto.h,v 1.11 2005/06/27 05:49:13 dyoung 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.9 2005/01/24 20:38:26 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 (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 void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
64 struct ieee80211_node *, int, int, u_int32_t);
65 int ieee80211_send_nulldata(struct ieee80211com *, struct ieee80211_node *);
66 int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
67 int, int);
68 int ieee80211_classify(struct ieee80211com *, struct mbuf *,
69 struct ieee80211_node *);
70 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
71 struct ieee80211_node *);
72 void ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *,
73 struct mbuf *);
74
75 void ieee80211_reset_erp(struct ieee80211com *);
76 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
77 int ieee80211_iserp_rateset(struct ieee80211com *,
78 struct ieee80211_rateset *);
79 void ieee80211_set11gbasicrates(struct ieee80211_rateset *,
80 enum ieee80211_phymode);
81
82 /*
83 * Return the size of the 802.11 header for a management or data frame.
84 */
85 static __inline int
86 ieee80211_hdrsize(const void *data)
87 {
88 const struct ieee80211_frame *wh = data;
89 int size = sizeof(struct ieee80211_frame);
90
91 /* NB: we don't handle control frames */
92 IASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
93 ("%s: control frame", __func__));
94 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
95 size += IEEE80211_ADDR_LEN;
96 if (IEEE80211_QOS_HAS_SEQ(wh))
97 size += sizeof(u_int16_t);
98 return size;
99 }
100
101 /*
102 * Return the size of the 802.11 header; handles any type of frame.
103 */
104 static __inline int
105 ieee80211_anyhdrsize(const void *data)
106 {
107 const struct ieee80211_frame *wh = data;
108
109 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
110 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
111 case IEEE80211_FC0_SUBTYPE_CTS:
112 case IEEE80211_FC0_SUBTYPE_ACK:
113 return sizeof(struct ieee80211_frame_ack);
114 }
115 return sizeof(struct ieee80211_frame_min);
116 } else
117 return ieee80211_hdrsize(data);
118 }
119
120 /*
121 * Template for an in-kernel authenticator. Authenticators
122 * register with the protocol code and are typically loaded
123 * as separate modules as needed.
124 */
125 struct ieee80211_authenticator {
126 const char *ia_name; /* printable name */
127 int (*ia_attach)(struct ieee80211com *);
128 void (*ia_detach)(struct ieee80211com *);
129 void (*ia_node_join)(struct ieee80211com *,
130 struct ieee80211_node *);
131 void (*ia_node_leave)(struct ieee80211com *,
132 struct ieee80211_node *);
133 };
134 void ieee80211_authenticator_register(int type,
135 const struct ieee80211_authenticator *);
136 void ieee80211_authenticator_unregister(int type);
137 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
138
139 /*
140 * Template for an MAC ACL policy module. Such modules
141 * register with the protocol code and are passed the sender's
142 * address of each received frame for validation.
143 */
144 struct ieee80211_aclator {
145 const char *iac_name; /* printable name */
146 int (*iac_attach)(struct ieee80211com *);
147 void (*iac_detach)(struct ieee80211com *);
148 int (*iac_check)(struct ieee80211com *,
149 const u_int8_t mac[IEEE80211_ADDR_LEN]);
150 int (*iac_add)(struct ieee80211com *,
151 const u_int8_t mac[IEEE80211_ADDR_LEN]);
152 int (*iac_remove)(struct ieee80211com *,
153 const u_int8_t mac[IEEE80211_ADDR_LEN]);
154 int (*iac_flush)(struct ieee80211com *);
155 int (*iac_setpolicy)(struct ieee80211com *, int);
156 int (*iac_getpolicy)(struct ieee80211com *);
157 };
158 void ieee80211_aclator_register(const struct ieee80211_aclator *);
159 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
160 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
161
162 /* flags for ieee80211_fix_rate() */
163 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
164 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
165 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
166 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
167 int ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int);
168
169 /*
170 * WME/WMM support.
171 */
172 struct wmeParams {
173 u_int8_t wmep_acm;
174 u_int8_t wmep_aifsn;
175 u_int8_t wmep_logcwmin; /* log2(cwmin) */
176 u_int8_t wmep_logcwmax; /* log2(cwmax) */
177 u_int8_t wmep_txopLimit;
178 u_int8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
179 };
180 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
181 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
182
183 struct chanAccParams {
184 u_int8_t cap_info; /* version of the current set */
185 struct wmeParams cap_wmeParams[WME_NUM_AC];
186 };
187
188 struct ieee80211_wme_state {
189 u_int wme_flags;
190 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
191 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
192 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
193 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
194
195 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
196 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
197 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
198 struct chanAccParams wme_chanParams; /* params applied to self */
199 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
200
201 int (*wme_update)(struct ieee80211com *);
202 };
203
204 void ieee80211_wme_initparams(struct ieee80211com *);
205 void ieee80211_wme_updateparams(struct ieee80211com *);
206 void ieee80211_wme_updateparams_locked(struct ieee80211com *);
207
208 #define ieee80211_new_state(_ic, _nstate, _arg) \
209 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
210 extern int ieee80211_compute_duration(struct ieee80211_frame_min *, int,
211 uint32_t, int, int, struct ieee80211_duration *,
212 struct ieee80211_duration *, int *, int);
213 void ieee80211_print_essid(const u_int8_t *, int);
214 void ieee80211_dump_pkt(const u_int8_t *, int, int, int);
215
216 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
217 extern const char *ieee80211_wme_acnames[];
218
219 /*
220 * Beacon frames constructed by ieee80211_beacon_alloc
221 * have the following structure filled in so drivers
222 * can update the frame later w/ minimal overhead.
223 */
224 struct ieee80211_beacon_offsets {
225 u_int16_t *bo_caps; /* capabilities */
226 u_int8_t *bo_tim; /* start of atim/dtim */
227 u_int8_t *bo_wme; /* start of WME parameters */
228 u_int8_t *bo_trailer; /* start of fixed-size trailer */
229 u_int16_t bo_tim_len; /* atim/dtim length in bytes */
230 u_int16_t bo_trailer_len; /* trailer length in bytes */
231 };
232 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
233 struct ieee80211_node *, struct ieee80211_beacon_offsets *);
234 int ieee80211_beacon_update(struct ieee80211com *,
235 struct ieee80211_node *, struct ieee80211_beacon_offsets *,
236 struct mbuf *, int broadcast);
237
238 /*
239 * Notification methods called from the 802.11 state machine.
240 * Note that while these are defined here, their implementation
241 * is OS-specific.
242 */
243 void ieee80211_notify_node_join(struct ieee80211com *,
244 struct ieee80211_node *, int newassoc);
245 void ieee80211_notify_node_leave(struct ieee80211com *,
246 struct ieee80211_node *);
247 void ieee80211_notify_scan_done(struct ieee80211com *);
248 #endif /* _NET80211_IEEE80211_PROTO_H_ */
249