2 * Copyright (c) 2007-2008 Sam Leffler, Errno Consulting
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 * $FreeBSD: head/sys/net80211/ieee80211_ht.h 195377 2009-07-05 17:59:19Z sam $
28 #ifndef _NET80211_IEEE80211_HT_H_
29 #define _NET80211_IEEE80211_HT_H_
32 * 802.11n protocol implementation definitions.
35 #define IEEE80211_AGGR_BAWMAX 64 /* max block ack window size */
36 /* threshold for aging overlapping non-HT bss */
37 #define IEEE80211_NONHT_PRESENT_AGE msecs_to_ticks(60*1000)
39 struct ieee80211_tx_ampdu {
40 struct ieee80211_node *txa_ni; /* back pointer */
42 #define IEEE80211_AGGR_IMMEDIATE 0x0001 /* BA policy */
43 #define IEEE80211_AGGR_XCHGPEND 0x0002 /* ADDBA response pending */
44 #define IEEE80211_AGGR_RUNNING 0x0004 /* ADDBA response received */
45 #define IEEE80211_AGGR_SETUP 0x0008 /* deferred state setup */
46 #define IEEE80211_AGGR_NAK 0x0010 /* peer NAK'd ADDBA request */
47 #define IEEE80211_AGGR_BARPEND 0x0020 /* BAR response pending */
49 uint8_t txa_token; /* dialog token */
50 int txa_lastsample; /* ticks @ last traffic sample */
51 int txa_pkts; /* packets over last sample interval */
52 int txa_avgpps; /* filtered traffic over window */
53 int txa_qbytes; /* data queued (bytes) */
54 short txa_qframes; /* data queued (frames) */
55 ieee80211_seq txa_start; /* BA window left edge */
56 ieee80211_seq txa_seqpending; /* new txa_start pending BAR response */
57 uint16_t txa_wnd; /* BA window size */
58 uint8_t txa_attempts; /* # ADDBA/BAR requests w/o a response*/
59 int txa_nextrequest;/* soonest to make next request */
60 struct callout txa_timer;
61 void *txa_private; /* driver-private storage */
65 /* return non-zero if AMPDU tx for the TID is running */
66 #define IEEE80211_AMPDU_RUNNING(tap) \
67 (((tap)->txa_flags & IEEE80211_AGGR_RUNNING) != 0)
69 /* return non-zero if AMPDU tx for the TID is running or started */
70 #define IEEE80211_AMPDU_REQUESTED(tap) \
71 (((tap)->txa_flags & \
72 (IEEE80211_AGGR_RUNNING|IEEE80211_AGGR_XCHGPEND|IEEE80211_AGGR_NAK)) != 0)
74 #define IEEE80211_AGGR_BITS \
75 "\20\1IMMEDIATE\2XCHGPEND\3RUNNING\4SETUP\5NAK"
78 * Traffic estimator support. We estimate packets/sec for
79 * each AC that is setup for AMPDU or will potentially be
80 * setup for AMPDU. The traffic rate can be used to decide
81 * when AMPDU should be setup (according to a threshold)
82 * and is available for drivers to do things like cache
83 * eviction when only a limited number of BA streams are
84 * available and more streams are requested than available.
88 ieee80211_txampdu_update_pps(struct ieee80211_tx_ampdu *tap)
90 /* NB: scale factor of 2 was picked heuristically */
91 tap->txa_avgpps = ((tap->txa_avgpps << 2) -
92 tap->txa_avgpps + tap->txa_pkts) >> 2;
96 * Count a packet towards the pps estimate.
99 ieee80211_txampdu_count_packet(struct ieee80211_tx_ampdu *tap)
101 /* XXX bound loop/do more crude estimate? */
102 while (ticks - tap->txa_lastsample >= hz) {
103 ieee80211_txampdu_update_pps(tap);
104 /* reset to start new sample interval */
106 if (tap->txa_avgpps == 0) {
107 tap->txa_lastsample = ticks;
110 tap->txa_lastsample += hz;
116 * Get the current pps estimate. If the average is out of
117 * date due to lack of traffic then we decay the estimate
118 * to account for the idle time.
121 ieee80211_txampdu_getpps(struct ieee80211_tx_ampdu *tap)
123 /* XXX bound loop/do more crude estimate? */
124 while (ticks - tap->txa_lastsample >= hz) {
125 ieee80211_txampdu_update_pps(tap);
127 if (tap->txa_avgpps == 0) {
128 tap->txa_lastsample = ticks;
131 tap->txa_lastsample += hz;
133 return tap->txa_avgpps;
136 struct ieee80211_rx_ampdu {
138 int rxa_qbytes; /* data queued (bytes) */
139 short rxa_qframes; /* data queued (frames) */
140 ieee80211_seq rxa_seqstart;
141 ieee80211_seq rxa_start; /* start of current BA window */
142 uint16_t rxa_wnd; /* BA window size */
143 int rxa_age; /* age of oldest frame in window */
144 int rxa_nframes; /* frames since ADDBA */
145 struct mbuf *rxa_m[IEEE80211_AGGR_BAWMAX];
149 void ieee80211_ht_attach(struct ieee80211com *);
150 void ieee80211_ht_detach(struct ieee80211com *);
151 void ieee80211_ht_vattach(struct ieee80211vap *);
152 void ieee80211_ht_vdetach(struct ieee80211vap *);
154 void ieee80211_ht_announce(struct ieee80211com *);
156 struct ieee80211_mcs_rates {
157 uint16_t ht20_rate_800ns;
158 uint16_t ht20_rate_400ns;
159 uint16_t ht40_rate_800ns;
160 uint16_t ht40_rate_400ns;
162 extern const struct ieee80211_mcs_rates ieee80211_htrates[16];
163 const struct ieee80211_htrateset *ieee80211_get_suphtrates(
164 struct ieee80211com *, const struct ieee80211_channel *);
166 struct ieee80211_node;
167 int ieee80211_setup_htrates(struct ieee80211_node *,
168 const uint8_t *htcap, int flags);
169 void ieee80211_setup_basic_htrates(struct ieee80211_node *,
170 const uint8_t *htinfo);
171 struct mbuf *ieee80211_decap_amsdu(struct ieee80211_node *, struct mbuf *);
172 int ieee80211_ampdu_reorder(struct ieee80211_node *, struct mbuf *);
173 void ieee80211_recv_bar(struct ieee80211_node *, struct mbuf *);
174 void ieee80211_ht_node_init(struct ieee80211_node *);
175 void ieee80211_ht_node_cleanup(struct ieee80211_node *);
176 void ieee80211_ht_node_age(struct ieee80211_node *);
178 struct ieee80211_channel *ieee80211_ht_adjust_channel(struct ieee80211com *,
179 struct ieee80211_channel *, int);
180 void ieee80211_ht_wds_init(struct ieee80211_node *);
181 void ieee80211_ht_node_join(struct ieee80211_node *);
182 void ieee80211_ht_node_leave(struct ieee80211_node *);
183 void ieee80211_htprot_update(struct ieee80211com *, int protmode);
184 void ieee80211_ht_timeout(struct ieee80211com *);
185 void ieee80211_parse_htcap(struct ieee80211_node *, const uint8_t *);
186 void ieee80211_parse_htinfo(struct ieee80211_node *, const uint8_t *);
187 void ieee80211_ht_updateparams(struct ieee80211_node *, const uint8_t *,
189 void ieee80211_ht_updatehtcap(struct ieee80211_node *, const uint8_t *);
190 int ieee80211_ampdu_request(struct ieee80211_node *,
191 struct ieee80211_tx_ampdu *);
192 void ieee80211_ampdu_stop(struct ieee80211_node *,
193 struct ieee80211_tx_ampdu *, int);
194 int ieee80211_send_bar(struct ieee80211_node *, struct ieee80211_tx_ampdu *,
196 uint8_t *ieee80211_add_htcap(uint8_t *, struct ieee80211_node *);
197 uint8_t *ieee80211_add_htcap_vendor(uint8_t *, struct ieee80211_node *);
198 uint8_t *ieee80211_add_htinfo(uint8_t *, struct ieee80211_node *);
199 uint8_t *ieee80211_add_htinfo_vendor(uint8_t *, struct ieee80211_node *);
200 struct ieee80211_beacon_offsets;
201 void ieee80211_ht_update_beacon(struct ieee80211vap *,
202 struct ieee80211_beacon_offsets *);
203 #endif /* _NET80211_IEEE80211_HT_H_ */