1/*-
2 * Copyright (c) 2007-2008 Sam Leffler, Errno Consulting
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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.
24 *
25 * $FreeBSD: head/sys/net80211/ieee80211_ht.h 193239 2009-06-01 16:36:28Z sam $
26 */
27#ifndef _NET80211_IEEE80211_HT_H_
28#define _NET80211_IEEE80211_HT_H_
29
30/*
31 * 802.11n protocol implementation definitions.
32 */
33
34#define IEEE80211_AGGR_BAWMAX 64 /* max block ack window size */
35/* threshold for aging overlapping non-HT bss */
36#define IEEE80211_NONHT_PRESENT_AGE msecs_to_ticks(60*1000)
37
38struct ieee80211_tx_ampdu {
39 struct ieee80211_node *txa_ni; /* back pointer */
40 u_short txa_flags;
41#define IEEE80211_AGGR_IMMEDIATE 0x0001 /* BA policy */
42#define IEEE80211_AGGR_XCHGPEND 0x0002 /* ADDBA response pending */
43#define IEEE80211_AGGR_RUNNING 0x0004 /* ADDBA response received */
44#define IEEE80211_AGGR_SETUP 0x0008 /* deferred state setup */
45#define IEEE80211_AGGR_NAK 0x0010 /* peer NAK'd ADDBA request */
46#define IEEE80211_AGGR_BARPEND 0x0020 /* BAR response pending */
47 uint8_t txa_ac;
48 uint8_t txa_token; /* dialog token */
49 int txa_lastsample; /* ticks @ last traffic sample */
50 int txa_pkts; /* packets over last sample interval */
51 int txa_avgpps; /* filtered traffic over window */
52 int txa_qbytes; /* data queued (bytes) */
53 short txa_qframes; /* data queued (frames) */
54 ieee80211_seq txa_start; /* BA window left edge */
55 ieee80211_seq txa_seqpending; /* new txa_start pending BAR response */
56 uint16_t txa_wnd; /* BA window size */
57 uint8_t txa_attempts; /* # ADDBA/BAR requests w/o a response*/
58 int txa_nextrequest;/* soonest to make next request */
59 struct callout txa_timer;
60 void *txa_private; /* driver-private storage */
61 uint64_t txa_pad[4];
62};
63
64/* return non-zero if AMPDU tx for the TID is running */
65#define IEEE80211_AMPDU_RUNNING(tap) \
66 (((tap)->txa_flags & IEEE80211_AGGR_RUNNING) != 0)
67
68/* return non-zero if AMPDU tx for the TID is running or started */
69#define IEEE80211_AMPDU_REQUESTED(tap) \
70 (((tap)->txa_flags & \
71 (IEEE80211_AGGR_RUNNING|IEEE80211_AGGR_XCHGPEND|IEEE80211_AGGR_NAK)) != 0)
72
73#define IEEE80211_AGGR_BITS \
74 "\20\1IMMEDIATE\2XCHGPEND\3RUNNING\4SETUP\5NAK"
75
76/*
77 * Traffic estimator support. We estimate packets/sec for
78 * each AC that is setup for AMPDU or will potentially be
79 * setup for AMPDU. The traffic rate can be used to decide
80 * when AMPDU should be setup (according to a threshold)
81 * and is available for drivers to do things like cache
82 * eviction when only a limited number of BA streams are
83 * available and more streams are requested than available.
84 */
85
86static __inline void
87ieee80211_txampdu_update_pps(struct ieee80211_tx_ampdu *tap)
88{
89 /* NB: scale factor of 2 was picked heuristically */
90 tap->txa_avgpps = ((tap->txa_avgpps << 2) -
91 tap->txa_avgpps + tap->txa_pkts) >> 2;
92}
93
94/*
95 * Count a packet towards the pps estimate.
96 */
97static __inline void
98ieee80211_txampdu_count_packet(struct ieee80211_tx_ampdu *tap)
99{
100 /* XXX bound loop/do more crude estimate? */
101 while (ticks - tap->txa_lastsample >= hz) {
102 ieee80211_txampdu_update_pps(tap);
103 /* reset to start new sample interval */
104 tap->txa_pkts = 0;
105 if (tap->txa_avgpps == 0) {
106 tap->txa_lastsample = ticks;
107 break;
108 }
109 tap->txa_lastsample += hz;
110 }
111 tap->txa_pkts++;
112}
113
114/*
115 * Get the current pps estimate. If the average is out of
116 * date due to lack of traffic then we decay the estimate
117 * to account for the idle time.
118 */
119static __inline int
120ieee80211_txampdu_getpps(struct ieee80211_tx_ampdu *tap)
121{
122 /* XXX bound loop/do more crude estimate? */
123 while (ticks - tap->txa_lastsample >= hz) {
124 ieee80211_txampdu_update_pps(tap);
125 tap->txa_pkts = 0;
126 if (tap->txa_avgpps == 0) {
127 tap->txa_lastsample = ticks;
128 break;
129 }
130 tap->txa_lastsample += hz;
131 }
132 return tap->txa_avgpps;
133}
134
135struct ieee80211_rx_ampdu {
136 int rxa_flags;
137 int rxa_qbytes; /* data queued (bytes) */
138 short rxa_qframes; /* data queued (frames) */
139 ieee80211_seq rxa_seqstart;
140 ieee80211_seq rxa_start; /* start of current BA window */
141 uint16_t rxa_wnd; /* BA window size */
142 int rxa_age; /* age of oldest frame in window */
143 int rxa_nframes; /* frames since ADDBA */
144 struct mbuf *rxa_m[IEEE80211_AGGR_BAWMAX];
145 uint64_t rxa_pad[4];
146};
147
148void ieee80211_ht_attach(struct ieee80211com *);
149void ieee80211_ht_detach(struct ieee80211com *);
150void ieee80211_ht_vattach(struct ieee80211vap *);
151void ieee80211_ht_vdetach(struct ieee80211vap *);
152
153void ieee80211_ht_announce(struct ieee80211com *);
154
155struct ieee80211_mcs_rates {
156 uint16_t ht20_rate_800ns;
157 uint16_t ht20_rate_400ns;
158 uint16_t ht40_rate_800ns;
159 uint16_t ht40_rate_400ns;
160};
161extern const struct ieee80211_mcs_rates ieee80211_htrates[16];
162const struct ieee80211_htrateset *ieee80211_get_suphtrates(
163 struct ieee80211com *, const struct ieee80211_channel *);
164
165struct ieee80211_node;
166int ieee80211_setup_htrates(struct ieee80211_node *,
167 const uint8_t *htcap, int flags);
168void ieee80211_setup_basic_htrates(struct ieee80211_node *,
169 const uint8_t *htinfo);
170struct mbuf *ieee80211_decap_amsdu(struct ieee80211_node *, struct mbuf *);
171int ieee80211_ampdu_reorder(struct ieee80211_node *, struct mbuf *);
172void ieee80211_recv_bar(struct ieee80211_node *, struct mbuf *);
173void ieee80211_ht_node_init(struct ieee80211_node *);
174void ieee80211_ht_node_cleanup(struct ieee80211_node *);
175void ieee80211_ht_node_age(struct ieee80211_node *);
176
177struct ieee80211_channel *ieee80211_ht_adjust_channel(struct ieee80211com *,
178 struct ieee80211_channel *, int);
179void ieee80211_ht_wds_init(struct ieee80211_node *);
180void ieee80211_ht_node_join(struct ieee80211_node *);
181void ieee80211_ht_node_leave(struct ieee80211_node *);
182void ieee80211_htprot_update(struct ieee80211com *, int protmode);
183void ieee80211_ht_timeout(struct ieee80211com *);
184void ieee80211_parse_htcap(struct ieee80211_node *, const uint8_t *);
185void ieee80211_parse_htinfo(struct ieee80211_node *, const uint8_t *);
186void ieee80211_ht_updateparams(struct ieee80211_node *, const uint8_t *,
187 const uint8_t *);
188void ieee80211_ht_updatehtcap(struct ieee80211_node *, const uint8_t *);
189void ieee80211_recv_action(struct ieee80211_node *,
190 const uint8_t *, const uint8_t *);
191int ieee80211_ampdu_request(struct ieee80211_node *,
192 struct ieee80211_tx_ampdu *);
193void ieee80211_ampdu_stop(struct ieee80211_node *,
194 struct ieee80211_tx_ampdu *, int);
195int ieee80211_send_bar(struct ieee80211_node *, struct ieee80211_tx_ampdu *,
196 ieee80211_seq);
197int ieee80211_send_action(struct ieee80211_node *,
198 int, int, uint16_t [4]);
199uint8_t *ieee80211_add_htcap(uint8_t *, struct ieee80211_node *);
200uint8_t *ieee80211_add_htcap_vendor(uint8_t *, struct ieee80211_node *);
201uint8_t *ieee80211_add_htinfo(uint8_t *, struct ieee80211_node *);
202uint8_t *ieee80211_add_htinfo_vendor(uint8_t *, struct ieee80211_node *);
203struct ieee80211_beacon_offsets;
204void ieee80211_ht_update_beacon(struct ieee80211vap *,
205 struct ieee80211_beacon_offsets *);
206#endif /* _NET80211_IEEE80211_HT_H_ */