ieee80211_proto.h revision 1.23.16.3 1 /* $NetBSD: ieee80211_proto.h,v 1.23.16.3 2018/07/12 16:35:34 phil Exp $ */
2
3 /*-
4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 *
6 * Copyright (c) 2001 Atsushi Onoe
7 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32 #ifndef _NET80211_IEEE80211_PROTO_H_
33 #define _NET80211_IEEE80211_PROTO_H_
34
35 /*
36 * 802.11 protocol implementation definitions.
37 */
38
39 enum ieee80211_state {
40 IEEE80211_S_INIT = 0, /* default state */
41 IEEE80211_S_SCAN = 1, /* scanning */
42 IEEE80211_S_AUTH = 2, /* try to authenticate */
43 IEEE80211_S_ASSOC = 3, /* try to assoc */
44 IEEE80211_S_CAC = 4, /* doing channel availability check */
45 IEEE80211_S_RUN = 5, /* operational (e.g. associated) */
46 IEEE80211_S_CSA = 6, /* channel switch announce pending */
47 IEEE80211_S_SLEEP = 7, /* power save */
48 };
49 #define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1)
50
51 #define IEEE80211_SEND_MGMT(_ni,_type,_arg) \
52 ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg))
53
54 extern const char *mgt_subtype_name[];
55 extern const char *ctl_subtype_name[];
56 extern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX];
57 extern const int ieee80211_opcap[IEEE80211_OPMODE_MAX];
58
59 static __inline const char *
60 ieee80211_mgt_subtype_name(uint8_t subtype)
61 {
62 return mgt_subtype_name[(subtype & IEEE80211_FC0_SUBTYPE_MASK) >>
63 IEEE80211_FC0_SUBTYPE_SHIFT];
64 }
65
66 static __inline const char *
67 ieee80211_ctl_subtype_name(uint8_t subtype)
68 {
69 return ctl_subtype_name[(subtype & IEEE80211_FC0_SUBTYPE_MASK) >>
70 IEEE80211_FC0_SUBTYPE_SHIFT];
71 }
72
73 const char *ieee80211_reason_to_string(uint16_t);
74
75 void ieee80211_proto_attach(struct ieee80211com *);
76 void ieee80211_proto_detach(struct ieee80211com *);
77 void ieee80211_proto_vattach(struct ieee80211vap *);
78 void ieee80211_proto_vdetach(struct ieee80211vap *);
79
80 void ieee80211_promisc(struct ieee80211vap *, bool);
81 void ieee80211_allmulti(struct ieee80211vap *, bool);
82 void ieee80211_syncflag(struct ieee80211vap *, int flag);
83 void ieee80211_syncflag_ht(struct ieee80211vap *, int flag);
84 void ieee80211_syncflag_vht(struct ieee80211vap *, int flag);
85 void ieee80211_syncflag_ext(struct ieee80211vap *, int flag);
86
87 #define ieee80211_input(ni, m, rssi, nf) \
88 ((ni)->ni_vap->iv_input(ni, m, NULL, rssi, nf))
89 int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
90
91 int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *);
92 int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *);
93
94 struct ieee80211_bpf_params;
95 int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
96 struct ieee80211_bpf_params *);
97 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
98 const struct ieee80211_bpf_params *);
99 int ieee80211_output(struct ifnet *, struct mbuf *,
100 const struct sockaddr *, struct route *ro);
101 int ieee80211_vap_pkt_send_dest(struct ieee80211vap *, struct mbuf *,
102 struct ieee80211_node *);
103 int ieee80211_raw_output(struct ieee80211vap *, struct ieee80211_node *,
104 struct mbuf *, const struct ieee80211_bpf_params *);
105 void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int,
106 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN],
107 const uint8_t [IEEE80211_ADDR_LEN]);
108 int ieee80211_vap_transmit(struct ifnet *ifp, struct mbuf *m);
109 void ieee80211_vap_qflush(struct ifnet *ifp);
110 int ieee80211_send_nulldata(struct ieee80211_node *);
111 int ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
112 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
113 struct ieee80211_key *, struct mbuf *);
114 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
115 struct mbuf *);
116 void ieee80211_free_mbuf(struct mbuf *);
117 int ieee80211_send_mgmt(struct ieee80211_node *, int, int);
118 struct ieee80211_appie;
119 int ieee80211_send_probereq(struct ieee80211_node *ni,
120 const uint8_t sa[IEEE80211_ADDR_LEN],
121 const uint8_t da[IEEE80211_ADDR_LEN],
122 const uint8_t bssid[IEEE80211_ADDR_LEN],
123 const uint8_t *ssid, size_t ssidlen);
124 struct mbuf * ieee80211_ff_encap1(struct ieee80211vap *, struct mbuf *,
125 const struct ether_header *);
126 void ieee80211_tx_complete(struct ieee80211_node *,
127 struct mbuf *, int);
128
129 /*
130 * The formation of ProbeResponse frames requires guidance to
131 * deal with legacy clients. When the client is identified as
132 * "legacy 11b" ieee80211_send_proberesp is passed this token.
133 */
134 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */
135 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */
136 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */
137 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
138 int ieee80211_send_proberesp(struct ieee80211vap *,
139 const uint8_t da[IEEE80211_ADDR_LEN], int);
140 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
141 const uint8_t [IEEE80211_ADDR_LEN],
142 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
143 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
144 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
145 struct mbuf *ieee80211_alloc_prot(struct ieee80211_node *,
146 const struct mbuf *, uint8_t, int);
147
148 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
149 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
150 uint8_t *ieee80211_add_ssid(uint8_t *, const uint8_t *, u_int);
151 uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *);
152 uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *);
153 uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *);
154 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
155 struct ieee80211_channel *);
156 struct ieee80211_wme_state;
157 uint8_t * ieee80211_add_wme_info(uint8_t *frm, struct ieee80211_wme_state *wme);
158
159 void ieee80211_reset_erp(struct ieee80211com *);
160 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
161 int ieee80211_iserp_rateset(const struct ieee80211_rateset *);
162 void ieee80211_setbasicrates(struct ieee80211_rateset *,
163 enum ieee80211_phymode);
164 void ieee80211_addbasicrates(struct ieee80211_rateset *,
165 enum ieee80211_phymode);
166
167 /*
168 * Return the size of the 802.11 header for a management or data frame.
169 */
170 static __inline int
171 ieee80211_hdrsize(const void *data)
172 {
173 const struct ieee80211_frame *wh = data;
174 int size = sizeof(struct ieee80211_frame);
175
176 /* NB: we don't handle control frames */
177 #if __FreeBSD__
178 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
179 ("%s: control frame", __func__));
180 #elif __NetBSD__
181 FBSDKASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
182 ("%s: control frame", __func__));
183 #else
184 #error
185 #endif
186 if (IEEE80211_IS_DSTODS(wh))
187 size += IEEE80211_ADDR_LEN;
188 if (IEEE80211_QOS_HAS_SEQ(wh))
189 size += sizeof(uint16_t);
190 return size;
191 }
192
193 /*
194 * Like ieee80211_hdrsize, but handles any type of frame.
195 */
196 static __inline int
197 ieee80211_anyhdrsize(const void *data)
198 {
199 const struct ieee80211_frame *wh = data;
200
201 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
202 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
203 case IEEE80211_FC0_SUBTYPE_CTS:
204 case IEEE80211_FC0_SUBTYPE_ACK:
205 return sizeof(struct ieee80211_frame_ack);
206 case IEEE80211_FC0_SUBTYPE_BAR:
207 return sizeof(struct ieee80211_frame_bar);
208 }
209 return sizeof(struct ieee80211_frame_min);
210 } else
211 return ieee80211_hdrsize(data);
212 }
213
214 /*
215 * Template for an in-kernel authenticator. Authenticators
216 * register with the protocol code and are typically loaded
217 * as separate modules as needed. One special authenticator
218 * is xauth; it intercepts requests so that protocols like
219 * WPA can be handled in user space.
220 */
221 struct ieee80211_authenticator {
222 const char *ia_name; /* printable name */
223 int (*ia_attach)(struct ieee80211vap *);
224 void (*ia_detach)(struct ieee80211vap *);
225 void (*ia_node_join)(struct ieee80211_node *);
226 void (*ia_node_leave)(struct ieee80211_node *);
227 };
228 void ieee80211_authenticator_register(int type,
229 const struct ieee80211_authenticator *);
230 void ieee80211_authenticator_unregister(int type);
231 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
232
233 struct ieee80211req;
234 /*
235 * Template for an MAC ACL policy module. Such modules
236 * register with the protocol code and are passed the sender's
237 * address of each received auth frame for validation.
238 */
239 struct ieee80211_aclator {
240 const char *iac_name; /* printable name */
241 int (*iac_attach)(struct ieee80211vap *);
242 void (*iac_detach)(struct ieee80211vap *);
243 int (*iac_check)(struct ieee80211vap *,
244 const struct ieee80211_frame *wh);
245 int (*iac_add)(struct ieee80211vap *,
246 const uint8_t mac[IEEE80211_ADDR_LEN]);
247 int (*iac_remove)(struct ieee80211vap *,
248 const uint8_t mac[IEEE80211_ADDR_LEN]);
249 int (*iac_flush)(struct ieee80211vap *);
250 int (*iac_setpolicy)(struct ieee80211vap *, int);
251 int (*iac_getpolicy)(struct ieee80211vap *);
252 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
253 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
254 };
255 void ieee80211_aclator_register(const struct ieee80211_aclator *);
256 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
257 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
258
259 /* flags for ieee80211_fix_rate() */
260 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
261 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */
262 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
263 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
264 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
265 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
266 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */
267 int ieee80211_fix_rate(struct ieee80211_node *,
268 struct ieee80211_rateset *, int);
269
270 /*
271 * WME/WMM support.
272 */
273 struct wmeParams {
274 uint8_t wmep_acm;
275 uint8_t wmep_aifsn;
276 uint8_t wmep_logcwmin; /* log2(cwmin) */
277 uint8_t wmep_logcwmax; /* log2(cwmax) */
278 uint8_t wmep_txopLimit;
279 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
280 };
281 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
282 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
283
284 struct chanAccParams {
285 uint8_t cap_info; /* version of the current set */
286 struct wmeParams cap_wmeParams[WME_NUM_AC];
287 };
288
289 struct ieee80211_wme_state {
290 u_int wme_flags;
291 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME aggressive mode */
292 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
293 u_int wme_hipri_switch_thresh;/* aggressive mode switch thresh */
294 u_int wme_hipri_switch_hysteresis;/* aggressive mode switch hysteresis */
295
296 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
297 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
298 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
299 struct chanAccParams wme_chanParams; /* params applied to self */
300 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
301
302 int (*wme_update)(struct ieee80211com *);
303 };
304
305 void ieee80211_wme_initparams(struct ieee80211vap *);
306 void ieee80211_wme_updateparams(struct ieee80211vap *);
307 void ieee80211_wme_updateparams_locked(struct ieee80211vap *);
308 void ieee80211_wme_vap_getparams(struct ieee80211vap *vap,
309 struct chanAccParams *);
310 void ieee80211_wme_ic_getparams(struct ieee80211com *ic,
311 struct chanAccParams *);
312 int ieee80211_wme_vap_ac_is_noack(struct ieee80211vap *vap, int ac);
313
314 /*
315 * Return the WME TID from a QoS frame. If no TID
316 * is present return the index for the "non-QoS" entry.
317 */
318 static __inline uint8_t
319 ieee80211_gettid(const struct ieee80211_frame *wh)
320 {
321 uint8_t tid;
322
323 if (IEEE80211_QOS_HAS_SEQ(wh)) {
324 if (IEEE80211_IS_DSTODS(wh))
325 tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
326 i_qos[0];
327 else
328 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
329 tid &= IEEE80211_QOS_TID;
330 } else
331 tid = IEEE80211_NONQOS_TID;
332 return tid;
333 }
334
335 void ieee80211_waitfor_parent(struct ieee80211com *);
336 void ieee80211_start_locked(struct ieee80211vap *);
337 void ieee80211_init(void *);
338 void ieee80211_start_all(struct ieee80211com *);
339 void ieee80211_stop_locked(struct ieee80211vap *);
340 void ieee80211_stop(struct ieee80211vap *);
341 void ieee80211_stop_all(struct ieee80211com *);
342 void ieee80211_suspend_all(struct ieee80211com *);
343 void ieee80211_resume_all(struct ieee80211com *);
344 void ieee80211_restart_all(struct ieee80211com *);
345 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
346 void ieee80211_swbmiss(void *arg);
347 void ieee80211_beacon_miss(struct ieee80211com *);
348 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
349 int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state,
350 int);
351 void ieee80211_print_essid(const uint8_t *, int);
352 void ieee80211_dump_pkt(struct ieee80211com *,
353 const uint8_t *, int, int, int);
354
355 extern const char *ieee80211_opmode_name[];
356 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
357 extern const char *ieee80211_wme_acnames[];
358
359 /*
360 * Beacon frames constructed by ieee80211_beacon_alloc
361 * have the following structure filled in so drivers
362 * can update the frame later w/ minimal overhead.
363 */
364 struct ieee80211_beacon_offsets {
365 uint8_t bo_flags[4]; /* update/state flags */
366 uint16_t *bo_caps; /* capabilities */
367 uint8_t *bo_cfp; /* start of CFParms element */
368 uint8_t *bo_tim; /* start of atim/dtim */
369 uint8_t *bo_wme; /* start of WME parameters */
370 uint8_t *bo_tdma; /* start of TDMA parameters */
371 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
372 uint16_t bo_tim_len; /* atim/dtim length in bytes */
373 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
374 uint8_t *bo_erp; /* start of ERP element */
375 uint8_t *bo_htinfo; /* start of HT info element */
376 uint8_t *bo_ath; /* start of ATH parameters */
377 uint8_t *bo_appie; /* start of AppIE element */
378 uint16_t bo_appie_len; /* AppIE length in bytes */
379 uint16_t bo_csa_trailer_len;
380 uint8_t *bo_csa; /* start of CSA element */
381 uint8_t *bo_quiet; /* start of Quiet element */
382 uint8_t *bo_meshconf; /* start of MESHCONF element */
383 uint8_t *bo_vhtinfo; /* start of VHT info element (XXX VHTCAP?) */
384 uint8_t *bo_spare[2];
385 };
386 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *);
387
388 /*
389 * Beacon frame updates are signaled through calls to iv_update_beacon
390 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
391 * that construct beacon frames on the host this can trigger a rebuild
392 * or defer the processing. For devices that offload beacon frame
393 * handling this callback can be used to signal a rebuild. The bo_flags
394 * array in the ieee80211_beacon_offsets structure is intended to record
395 * deferred processing requirements; ieee80211_beacon_update uses the
396 * state to optimize work. Since this structure is owned by the driver
397 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
398 * callback that marks the flag bits and schedules (as necessary) an update.
399 */
400 enum {
401 IEEE80211_BEACON_CAPS = 0, /* capabilities */
402 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
403 IEEE80211_BEACON_WME = 2,
404 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
405 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
406 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
407 IEEE80211_BEACON_CFP = 6, /* CFParms */
408 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
409 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */
410 IEEE80211_BEACON_ATH = 10, /* ATH parameters */
411 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
412 IEEE80211_BEACON_QUIET = 12, /* Quiet time IE */
413 IEEE80211_BEACON_VHTINFO = 13, /* VHT information */
414 };
415 int ieee80211_beacon_update(struct ieee80211_node *,
416 struct mbuf *, int mcast);
417
418 void ieee80211_csa_startswitch(struct ieee80211com *,
419 struct ieee80211_channel *, int mode, int count);
420 void ieee80211_csa_completeswitch(struct ieee80211com *);
421 void ieee80211_csa_cancelswitch(struct ieee80211com *);
422 void ieee80211_cac_completeswitch(struct ieee80211vap *);
423
424 /*
425 * Notification methods called from the 802.11 state machine.
426 * Note that while these are defined here, their implementation
427 * is OS-specific.
428 */
429 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
430 void ieee80211_notify_node_leave(struct ieee80211_node *);
431 void ieee80211_notify_scan_done(struct ieee80211vap *);
432 void ieee80211_notify_wds_discover(struct ieee80211_node *);
433 void ieee80211_notify_csa(struct ieee80211com *,
434 const struct ieee80211_channel *, int mode, int count);
435 void ieee80211_notify_radar(struct ieee80211com *,
436 const struct ieee80211_channel *);
437 enum ieee80211_notify_cac_event {
438 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */
439 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */
440 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */
441 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
442 };
443 void ieee80211_notify_cac(struct ieee80211com *,
444 const struct ieee80211_channel *,
445 enum ieee80211_notify_cac_event);
446 void ieee80211_notify_node_deauth(struct ieee80211_node *);
447 void ieee80211_notify_node_auth(struct ieee80211_node *);
448 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
449 const uint8_t cc[2]);
450 void ieee80211_notify_radio(struct ieee80211com *, int);
451 #endif /* _NET80211_IEEE80211_PROTO_H_ */
452