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