ieee80211_proto.h revision 1.16.62.1 1 /* $NetBSD: ieee80211_proto.h,v 1.16.62.1 2008/02/22 16:50:25 skrll Exp $ */
2 /*-
3 * Copyright (c) 2001 Atsushi Onoe
4 * Copyright (c) 2002-2007 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 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD: src/sys/net80211/ieee80211_proto.h,v 1.27 2007/11/02 05:22:25 sam Exp $
28 */
29 #ifndef _NET80211_IEEE80211_PROTO_H_
30 #define _NET80211_IEEE80211_PROTO_H_
31
32 /*
33 * 802.11 protocol implementation definitions.
34 */
35
36 enum ieee80211_state {
37 IEEE80211_S_INIT = 0, /* default state */
38 IEEE80211_S_SCAN = 1, /* scanning */
39 IEEE80211_S_AUTH = 2, /* try to authenticate */
40 IEEE80211_S_ASSOC = 3, /* try to assoc */
41 IEEE80211_S_CAC = 4, /* doing channel availability check */
42 IEEE80211_S_RUN = 5, /* operational (e.g. associated) */
43 IEEE80211_S_CSA = 6, /* channel switch announce pending */
44 IEEE80211_S_SLEEP = 7, /* power save */
45 };
46 #define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1)
47
48 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
49 ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
50
51 /*
52 * The formation of some management frames requires guidance to
53 * deal with legacy clients. When the client is identified as
54 * "legacy 11b" this parameter can be passed in the arg param of a
55 * IEEE80211_SEND_MGMT call.
56 */
57 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */
58 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */
59 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */
60
61 extern const char *ieee80211_mgt_subtype_name[];
62 extern const char *ieee80211_phymode_name[];
63
64 void ieee80211_proto_attach(struct ieee80211com *);
65 void ieee80211_proto_detach(struct ieee80211com *);
66
67 struct ieee80211_node;
68 int ieee80211_input(struct ieee80211com *, struct mbuf *,
69 struct ieee80211_node *, int, int, uint32_t);
70 void ieee80211_deliver_data(struct ieee80211com *,
71 struct ieee80211_node *, struct mbuf *);
72 struct mbuf *ieee80211_decap1(struct mbuf *, int *);
73 int ieee80211_setup_rates(struct ieee80211_node *ni,
74 const uint8_t *rates, const uint8_t *xrates, int flags);
75 void ieee80211_saveie(uint8_t **, const uint8_t *);
76 void ieee80211_saveath(struct ieee80211_node *, uint8_t *);
77 void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
78 struct ieee80211_node *, int, int, int, uint32_t);
79 int ieee80211_mgmt_output(struct ieee80211com *, struct ieee80211_node *,
80 struct mbuf *, int type);
81 struct ieee80211_bpf_params;
82 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
83 const struct ieee80211_bpf_params *);
84 int ieee80211_output(struct ifnet *, struct mbuf *,
85 const struct sockaddr *, struct rtentry *);
86 int ieee80211_send_nulldata(struct ieee80211_node *);
87 int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
88 int, int);
89 int ieee80211_send_probereq(struct ieee80211_node *ni,
90 const uint8_t sa[IEEE80211_ADDR_LEN],
91 const uint8_t da[IEEE80211_ADDR_LEN],
92 const uint8_t bssid[IEEE80211_ADDR_LEN],
93 const uint8_t *ssid, size_t ssidlen,
94 const void *optie, size_t optielen);
95 int ieee80211_classify(struct ieee80211com *, struct mbuf *,
96 struct ieee80211_node *);
97 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
98 struct ieee80211_node *);
99
100 void ieee80211_reset_erp(struct ieee80211com *);
101 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
102 int ieee80211_iserp_rateset(struct ieee80211com *,
103 struct ieee80211_rateset *);
104 void ieee80211_set11gbasicrates(struct ieee80211_rateset *,
105 enum ieee80211_phymode);
106
107 /*
108 * Return the size of the 802.11 header for a management or data frame.
109 */
110 static __inline int
111 ieee80211_hdrsize(const void *data)
112 {
113 const struct ieee80211_frame *wh = data;
114 int size = sizeof(struct ieee80211_frame);
115
116 /* NB: we don't handle control frames */
117 IASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
118 ("%s: control frame", __func__));
119 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
120 size += IEEE80211_ADDR_LEN;
121 if (IEEE80211_QOS_HAS_SEQ(wh))
122 size += sizeof(uint16_t);
123 return size;
124 }
125
126 /*
127 * Like ieee80211_hdrsize, but handles any type of frame.
128 */
129 static __inline int
130 ieee80211_anyhdrsize(const void *data)
131 {
132 const struct ieee80211_frame *wh = data;
133
134 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
135 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
136 case IEEE80211_FC0_SUBTYPE_CTS:
137 case IEEE80211_FC0_SUBTYPE_ACK:
138 return sizeof(struct ieee80211_frame_ack);
139 case IEEE80211_FC0_SUBTYPE_BAR:
140 return sizeof(struct ieee80211_frame_bar);
141 }
142 return sizeof(struct ieee80211_frame_min);
143 } else
144 return ieee80211_hdrsize(data);
145 }
146
147 /*
148 * Template for an in-kernel authenticator. Authenticators
149 * register with the protocol code and are typically loaded
150 * as separate modules as needed.
151 */
152 struct ieee80211_authenticator {
153 const char *ia_name; /* printable name */
154 int (*ia_attach)(struct ieee80211com *);
155 void (*ia_detach)(struct ieee80211com *);
156 void (*ia_node_join)(struct ieee80211com *,
157 struct ieee80211_node *);
158 void (*ia_node_leave)(struct ieee80211com *,
159 struct ieee80211_node *);
160 };
161 void ieee80211_authenticator_register(int type,
162 const struct ieee80211_authenticator *);
163 void ieee80211_authenticator_unregister(int type);
164 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
165
166 struct ieee80211req;
167 /*
168 * Template for an MAC ACL policy module. Such modules
169 * register with the protocol code and are passed the sender's
170 * address of each received frame for validation.
171 */
172 struct ieee80211_aclator {
173 const char *iac_name; /* printable name */
174 int (*iac_attach)(struct ieee80211com *);
175 void (*iac_detach)(struct ieee80211com *);
176 int (*iac_check)(struct ieee80211com *,
177 const uint8_t mac[IEEE80211_ADDR_LEN]);
178 int (*iac_add)(struct ieee80211com *,
179 const uint8_t mac[IEEE80211_ADDR_LEN]);
180 int (*iac_remove)(struct ieee80211com *,
181 const uint8_t mac[IEEE80211_ADDR_LEN]);
182 int (*iac_flush)(struct ieee80211com *);
183 int (*iac_setpolicy)(struct ieee80211com *, int);
184 int (*iac_getpolicy)(struct ieee80211com *);
185 int (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
186 int (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
187 };
188 void ieee80211_aclator_register(const struct ieee80211_aclator *);
189 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
190 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
191
192 /* flags for ieee80211_fix_rate() */
193 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
194 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
195 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
196 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
197 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
198 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
199 int ieee80211_fix_rate(struct ieee80211_node *,
200 struct ieee80211_rateset *, int);
201
202 /*
203 * WME/WMM support.
204 */
205 struct wmeParams {
206 uint8_t wmep_acm;
207 uint8_t wmep_aifsn;
208 uint8_t wmep_logcwmin; /* log2(cwmin) */
209 uint8_t wmep_logcwmax; /* log2(cwmax) */
210 uint8_t wmep_txopLimit;
211 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
212 };
213 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
214 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
215
216 struct chanAccParams {
217 uint8_t cap_info; /* version of the current set */
218 struct wmeParams cap_wmeParams[WME_NUM_AC];
219 };
220
221 struct ieee80211_wme_state {
222 u_int wme_flags;
223 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
224 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
225 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
226 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
227
228 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
229 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
230 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
231 struct chanAccParams wme_chanParams; /* params applied to self */
232 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
233
234 int (*wme_update)(struct ieee80211com *);
235 };
236
237 void ieee80211_wme_initparams(struct ieee80211com *);
238 void ieee80211_wme_updateparams(struct ieee80211com *);
239 void ieee80211_wme_updateparams_locked(struct ieee80211com *);
240
241 #define ieee80211_new_state(_ic, _nstate, _arg) \
242 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
243 int ieee80211_init(struct ieee80211com *, int forcescan);
244 void ieee80211_dturbo_switch(struct ieee80211com *, int newflags);
245 void ieee80211_beacon_miss(struct ieee80211com *);
246 void ieee80211_print_essid(const uint8_t *, int);
247 void ieee80211_dump_pkt(struct ieee80211com *,
248 const uint8_t *, int, int, int);
249
250 int ieee80211_compute_duration(const struct ieee80211_frame_min *,
251 const struct ieee80211_key *, int, uint32_t, int, int,
252 struct ieee80211_duration *, struct ieee80211_duration *, int *, int);
253
254
255 extern const char *ieee80211_opmode_name[];
256 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
257 extern const char *ieee80211_wme_acnames[];
258
259 /*
260 * Beacon frames constructed by ieee80211_beacon_alloc
261 * have the following structure filled in so drivers
262 * can update the frame later w/ minimal overhead.
263 */
264 struct ieee80211_beacon_offsets {
265 uint8_t bo_flags[4]; /* update/state flags */
266 uint16_t *bo_caps; /* capabilities */
267 uint8_t *bo_cfp; /* start of CFParms element */
268 uint8_t *bo_tim; /* start of atim/dtim */
269 uint8_t *bo_wme; /* start of WME parameters */
270 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
271 uint16_t bo_tim_len; /* atim/dtim length in bytes */
272 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
273 uint8_t *bo_erp; /* start of ERP element */
274 uint8_t *bo_htinfo; /* start of HT info element */
275 uint8_t *bo_appie; /* start of AppIE element */
276 uint16_t bo_appie_len; /* AppIE length in bytes */
277 uint16_t bo_csa_trailer_len;;
278 uint8_t *bo_csa; /* start of CSA element */
279 };
280 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
281 struct ieee80211_beacon_offsets *);
282
283 /*
284 * Beacon frame updates are signaled through calls to ic_update_beacon
285 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
286 * that construct beacon frames on the host this can trigger a rebuild
287 * or defer the processing. For devices that offload beacon frame
288 * handling this callback can be used to signal a rebuild. The bo_flags
289 * array in the ieee80211_beacon_offsets structure is intended to record
290 * deferred processing requirements; ieee80211_beacon_update uses the
291 * state to optimize work. Since this structure is owned by the driver
292 * and not visible to the 802.11 layer drivers must supply an ic_update_beacon
293 * callback that marks the flag bits and schedules (as necessary) an update.
294 */
295 enum {
296 IEEE80211_BEACON_CAPS = 0, /* capabilities */
297 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
298 IEEE80211_BEACON_WME = 2,
299 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
300 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
301 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
302 IEEE80211_BEACON_CFP = 6, /* CFParms */
303 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
304 };
305 int ieee80211_beacon_update(struct ieee80211_node *,
306 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
307
308 /*
309 * Notification methods called from the 802.11 state machine.
310 * Note that while these are defined here, their implementation
311 * is OS-specific.
312 */
313 void ieee80211_notify_node_join(struct ieee80211com *,
314 struct ieee80211_node *, int newassoc);
315 void ieee80211_notify_node_leave(struct ieee80211com *,
316 struct ieee80211_node *);
317 void ieee80211_notify_scan_done(struct ieee80211com *);
318 #endif /* !_NET80211_IEEE80211_PROTO_H_ */
319