ieee80211_ht.h revision 187797
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 187797 2009-01-27 23:00:38Z 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 38typedef uint16_t ieee80211_seq; 39 40struct 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 uint8_t txa_ac; 50 uint8_t txa_token; /* dialog token */ 51 int txa_lastsample; /* ticks @ last traffic sample */ 52 int txa_pkts; /* packets over last sample interval */ 53 int txa_avgpps; /* filtered traffic over window */ 54 int txa_qbytes; /* data queued (bytes) */ 55 short txa_qframes; /* data queued (frames) */ 56 ieee80211_seq txa_start; /* BA window left edge */ 57 ieee80211_seq txa_seqpending; /* new txa_start pending BAR response */ 58 uint16_t txa_wnd; /* BA window size */ 59 uint8_t txa_attempts; /* # ADDBA/BAR requests w/o a response*/ 60 int txa_nextrequest;/* soonest to make next request */ 61 struct callout txa_timer; 62 void *txa_private; /* driver-private storage */ 63}; 64 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) 68 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) 73 74#define IEEE80211_AGGR_BITS \ 75 "\20\1IMMEDIATE\2XCHGPEND\3RUNNING\4SETUP\5NAK" 76 77/* 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. 85 */ 86 87static __inline void 88ieee80211_txampdu_update_pps(struct ieee80211_tx_ampdu *tap) 89{ 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; 93} 94 95/* 96 * Count a packet towards the pps estimate. 97 */ 98static __inline void 99ieee80211_txampdu_count_packet(struct ieee80211_tx_ampdu *tap) 100{ 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 */ 105 tap->txa_pkts = 0; 106 if (tap->txa_avgpps == 0) { 107 tap->txa_lastsample = ticks; 108 break; 109 } 110 tap->txa_lastsample += hz; 111 } 112 tap->txa_pkts++; 113} 114 115/* 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. 119 */ 120static __inline int 121ieee80211_txampdu_getpps(struct ieee80211_tx_ampdu *tap) 122{ 123 /* XXX bound loop/do more crude estimate? */ 124 while (ticks - tap->txa_lastsample >= hz) { 125 ieee80211_txampdu_update_pps(tap); 126 tap->txa_pkts = 0; 127 if (tap->txa_avgpps == 0) { 128 tap->txa_lastsample = ticks; 129 break; 130 } 131 tap->txa_lastsample += hz; 132 } 133 return tap->txa_avgpps; 134} 135 136struct ieee80211_rx_ampdu { 137 int rxa_flags; 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]; 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_ */ 207