xref: /freebsd/sys/net80211/ieee80211_ht.h (revision b1879975794772ee51f0b4865753364c7d7626c3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2007-2008 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 #ifndef _NET80211_IEEE80211_HT_H_
28 #define _NET80211_IEEE80211_HT_H_
29 
30 /*
31  * 802.11n protocol implementation definitions.
32  */
33 
34 #include <sys/mbuf.h>
35 
36 #define	IEEE80211_AGGR_BAWMAX	64	/* max block ack window size */
37 /* threshold for aging overlapping non-HT bss */
38 #define	IEEE80211_NONHT_PRESENT_AGE	msecs_to_ticks(60*1000)
39 
40 struct ieee80211_tx_ampdu {
41 	struct ieee80211_node *txa_ni;	/* back pointer */
42 	u_short		txa_flags;
43 #define	IEEE80211_AGGR_IMMEDIATE	0x0001	/* BA policy */
44 #define	IEEE80211_AGGR_XCHGPEND		0x0002	/* ADDBA response pending */
45 #define	IEEE80211_AGGR_RUNNING		0x0004	/* ADDBA response received */
46 #define	IEEE80211_AGGR_SETUP		0x0008	/* deferred state setup */
47 #define	IEEE80211_AGGR_NAK		0x0010	/* peer NAK'd ADDBA request */
48 #define	IEEE80211_AGGR_BARPEND		0x0020	/* BAR response pending */
49 #define	IEEE80211_AGGR_WAITRX		0x0040	/* Wait for first RX frame to define BAW */
50 #define	IEEE80211_AGGR_AMSDU		0x0080	/* A-MSDU in A-MPDU TX allowed */
51 	uint8_t		txa_tid;
52 	uint8_t		txa_token;	/* dialog token */
53 	int		txa_lastsample;	/* ticks @ last traffic sample */
54 	int		txa_pkts;	/* packets over last sample interval */
55 	int		txa_avgpps;	/* filtered traffic over window */
56 	int		txa_qbytes;	/* data queued (bytes) */
57 	short		txa_qframes;	/* data queued (frames) */
58 	ieee80211_seq	txa_start;	/* BA window left edge */
59 	ieee80211_seq	txa_seqpending;	/* new txa_start pending BAR response */
60 	uint16_t	txa_wnd;	/* BA window size */
61 	uint8_t		txa_attempts;	/* # ADDBA/BAR requests w/o a response*/
62 	int		txa_nextrequest;/* soonest to make next request */
63 	struct callout	txa_timer;
64 	void		*txa_private;	/* driver-private storage */
65 	uint64_t	txa_pad[4];
66 };
67 
68 /* return non-zero if AMPDU tx for the TID is running */
69 #define	IEEE80211_AMPDU_RUNNING(tap) \
70 	(((tap)->txa_flags & IEEE80211_AGGR_RUNNING) != 0)
71 
72 /*
73  * Return non-zero if AMPDU tx for the TID is running and we can do
74  * A-MSDU in A-MPDU
75  */
76 #define	IEEE80211_AMPDU_RUNNING_AMSDU(tap) \
77 	(((tap)->txa_flags & (IEEE80211_AGGR_RUNNING | IEEE80211_AGGR_AMSDU)) \
78 	    == (IEEE80211_AGGR_RUNNING | IEEE80211_AGGR_AMSDU))
79 
80 /* return non-zero if AMPDU tx for the TID was NACKed */
81 #define	IEEE80211_AMPDU_NACKED(tap)\
82 	(!! ((tap)->txa_flags & IEEE80211_AGGR_NAK))
83 
84 /* return non-zero if AMPDU tx for the TID is running or started */
85 #define	IEEE80211_AMPDU_REQUESTED(tap) \
86 	(((tap)->txa_flags & \
87 	 (IEEE80211_AGGR_RUNNING|IEEE80211_AGGR_XCHGPEND|IEEE80211_AGGR_NAK)) != 0)
88 
89 #define	IEEE80211_AGGR_BITS \
90 	"\20\1IMMEDIATE\2XCHGPEND\3RUNNING\4SETUP\5NAK" \
91 	"\6BARPEND\7WAITRX\10AMSDU"
92 
93 /*
94  * Traffic estimator support.  We estimate packets/sec for
95  * each AC that is setup for AMPDU or will potentially be
96  * setup for AMPDU.  The traffic rate can be used to decide
97  * when AMPDU should be setup (according to a threshold)
98  * and is available for drivers to do things like cache
99  * eviction when only a limited number of BA streams are
100  * available and more streams are requested than available.
101  */
102 
103 static __inline void
104 ieee80211_txampdu_init_pps(struct ieee80211_tx_ampdu *tap)
105 {
106 	/*
107 	 * Reset packet estimate.
108 	 */
109 	tap->txa_lastsample = ticks;
110 	tap->txa_avgpps = 0;
111 }
112 
113 static __inline void
114 ieee80211_txampdu_update_pps(struct ieee80211_tx_ampdu *tap)
115 {
116 
117 	/* NB: scale factor of 2 was picked heuristically */
118 	tap->txa_avgpps = ((tap->txa_avgpps << 2) -
119 	     tap->txa_avgpps + tap->txa_pkts) >> 2;
120 }
121 
122 /*
123  * Count a packet towards the pps estimate.
124  */
125 static __inline void
126 ieee80211_txampdu_count_packet(struct ieee80211_tx_ampdu *tap)
127 {
128 
129 	/* XXX bound loop/do more crude estimate? */
130 	while (ticks - tap->txa_lastsample >= hz) {
131 		ieee80211_txampdu_update_pps(tap);
132 		/* reset to start new sample interval */
133 		tap->txa_pkts = 0;
134 		if (tap->txa_avgpps == 0) {
135 			tap->txa_lastsample = ticks;
136 			break;
137 		}
138 		tap->txa_lastsample += hz;
139 	}
140 	tap->txa_pkts++;
141 }
142 
143 /*
144  * Get the current pps estimate.  If the average is out of
145  * date due to lack of traffic then we decay the estimate
146  * to account for the idle time.
147  */
148 static __inline int
149 ieee80211_txampdu_getpps(struct ieee80211_tx_ampdu *tap)
150 {
151 	/* XXX bound loop/do more crude estimate? */
152 	while (ticks - tap->txa_lastsample >= hz) {
153 		ieee80211_txampdu_update_pps(tap);
154 		tap->txa_pkts = 0;
155 		if (tap->txa_avgpps == 0) {
156 			tap->txa_lastsample = ticks;
157 			break;
158 		}
159 		tap->txa_lastsample += hz;
160 	}
161 	return tap->txa_avgpps;
162 }
163 
164 struct ieee80211_rx_ampdu {
165 	int		rxa_flags;
166 	int		rxa_qbytes;	/* data queued (bytes) */
167 	short		rxa_qframes;	/* data queued (frames) */
168 	ieee80211_seq	rxa_seqstart;
169 	ieee80211_seq	rxa_start;	/* start of current BA window */
170 	uint16_t	rxa_wnd;	/* BA window size */
171 	int		rxa_age;	/* age of oldest frame in window */
172 	int		rxa_nframes;	/* frames since ADDBA */
173 	struct mbufq rxa_mq[IEEE80211_AGGR_BAWMAX];
174 	void		*rxa_private;
175 	uint64_t	rxa_pad[3];
176 };
177 
178 void	ieee80211_ht_attach(struct ieee80211com *);
179 void	ieee80211_ht_detach(struct ieee80211com *);
180 void	ieee80211_ht_vattach(struct ieee80211vap *);
181 void	ieee80211_ht_vdetach(struct ieee80211vap *);
182 
183 void	ieee80211_ht_announce(struct ieee80211com *);
184 
185 struct ieee80211_mcs_rates {
186 	uint16_t	ht20_rate_800ns;
187 	uint16_t	ht20_rate_400ns;
188 	uint16_t	ht40_rate_800ns;
189 	uint16_t	ht40_rate_400ns;
190 };
191 extern const struct ieee80211_mcs_rates ieee80211_htrates[];
192 void	ieee80211_init_suphtrates(struct ieee80211com *);
193 
194 struct ieee80211_node;
195 int	ieee80211_setup_htrates(struct ieee80211_node *,
196 		const uint8_t *htcap, int flags);
197 void	ieee80211_setup_basic_htrates(struct ieee80211_node *,
198 		const uint8_t *htinfo);
199 struct mbuf *ieee80211_decap_amsdu(struct ieee80211_node *, struct mbuf *);
200 int	ieee80211_ampdu_reorder(struct ieee80211_node *, struct mbuf *,
201 	    const struct ieee80211_rx_stats *);
202 void	ieee80211_recv_bar(struct ieee80211_node *, struct mbuf *);
203 void	ieee80211_ht_node_init(struct ieee80211_node *);
204 void	ieee80211_ht_node_cleanup(struct ieee80211_node *);
205 void	ieee80211_ht_node_age(struct ieee80211_node *);
206 
207 struct ieee80211_channel *ieee80211_ht_adjust_channel(struct ieee80211com *,
208 		struct ieee80211_channel *, int);
209 void	ieee80211_ht_wds_init(struct ieee80211_node *);
210 void	ieee80211_ht_node_join(struct ieee80211_node *);
211 void	ieee80211_ht_node_leave(struct ieee80211_node *);
212 void	ieee80211_htprot_update(struct ieee80211vap *, int protmode);
213 void	ieee80211_ht_timeout(struct ieee80211vap *);
214 void	ieee80211_parse_htcap(struct ieee80211_node *, const uint8_t *);
215 void	ieee80211_parse_htinfo(struct ieee80211_node *, const uint8_t *);
216 void	ieee80211_ht_updateparams(struct ieee80211_node *, const uint8_t *,
217 		const uint8_t *);
218 int	ieee80211_ht_updateparams_final(struct ieee80211_node *,
219 	    const uint8_t *, const uint8_t *);
220 void	ieee80211_ht_updatehtcap(struct ieee80211_node *, const uint8_t *);
221 void	ieee80211_ht_updatehtcap_final(struct ieee80211_node *);
222 int	ieee80211_ampdu_request(struct ieee80211_node *,
223 		struct ieee80211_tx_ampdu *);
224 void	ieee80211_ampdu_stop(struct ieee80211_node *,
225 		struct ieee80211_tx_ampdu *, int);
226 int	ieee80211_send_bar(struct ieee80211_node *, struct ieee80211_tx_ampdu *,
227 		ieee80211_seq);
228 uint8_t	*ieee80211_add_htcap(uint8_t *, struct ieee80211_node *);
229 uint8_t	*ieee80211_add_htcap_ch(uint8_t *, struct ieee80211vap *,
230 	    struct ieee80211_channel *);
231 uint8_t	*ieee80211_add_htcap_vendor(uint8_t *, struct ieee80211_node *);
232 uint8_t	*ieee80211_add_htinfo(uint8_t *, struct ieee80211_node *);
233 uint8_t	*ieee80211_add_htinfo_vendor(uint8_t *, struct ieee80211_node *);
234 struct ieee80211_beacon_offsets;
235 void	ieee80211_ht_update_beacon(struct ieee80211vap *,
236 		struct ieee80211_beacon_offsets *);
237 int	ieee80211_ampdu_rx_start_ext(struct ieee80211_node *ni, int tid,
238 	    int seq, int baw);
239 void	ieee80211_ampdu_rx_stop_ext(struct ieee80211_node *ni, int tid);
240 int	ieee80211_ampdu_tx_request_ext(struct ieee80211_node *ni, int tid);
241 int	ieee80211_ampdu_tx_request_active_ext(struct ieee80211_node *ni,
242 	    int tid, int status);
243 void	ieee80211_htinfo_notify(struct ieee80211vap *vap);
244 int	ieee80211_ht_get_node_ampdu_density(const struct ieee80211_node *ni);
245 int	ieee80211_ht_get_node_ampdu_limit(const struct ieee80211_node *ni);
246 bool	ieee80211_ht_check_tx_shortgi_20(const struct ieee80211_node *ni);
247 bool	ieee80211_ht_check_tx_shortgi_40(const struct ieee80211_node *ni);
248 bool	ieee80211_ht_check_tx_ht40(const struct ieee80211_node *ni);
249 bool	ieee80211_ht_check_tx_ht(const struct ieee80211_node *ht);
250 
251 #endif /* _NET80211_IEEE80211_HT_H_ */
252