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