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