ieee80211_ht.h revision 178951
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 178951 2008-05-11 23:18:11Z 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 u_short txa_flags; 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 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_seqstart; 55 ieee80211_seq txa_start; 56 uint16_t txa_wnd; /* BA window size */ 57 uint8_t txa_attempts; /* # ADDBA requests w/o a response */ 58 int txa_nextrequest;/* soonest to make next ADDBA request */ 59 struct ifqueue txa_q; /* packet queue */ 60 struct callout txa_timer; 61 void *txa_private; /* driver-private storage */ 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/* 74 * Traffic estimator support. We estimate packets/sec for 75 * each AC that is setup for AMPDU or will potentially be 76 * setup for AMPDU. The traffic rate can be used to decide 77 * when AMPDU should be setup (according to a threshold) 78 * and is available for drivers to do things like cache 79 * eviction when only a limited number of BA streams are 80 * available and more streams are requested than available. 81 */ 82 83static __inline void 84ieee80211_txampdu_update_pps(struct ieee80211_tx_ampdu *tap) 85{ 86 /* NB: scale factor of 2 was picked heuristically */ 87 tap->txa_avgpps = ((tap->txa_avgpps << 2) - 88 tap->txa_avgpps + tap->txa_pkts) >> 2; 89} 90 91/* 92 * Count a packet towards the pps estimate. 93 */ 94static __inline void 95ieee80211_txampdu_count_packet(struct ieee80211_tx_ampdu *tap) 96{ 97 /* XXX bound loop/do more crude estimate? */ 98 while (ticks - tap->txa_lastsample >= hz) { 99 ieee80211_txampdu_update_pps(tap); 100 /* reset to start new sample interval */ 101 tap->txa_pkts = 0; 102 if (tap->txa_avgpps == 0) { 103 tap->txa_lastsample = ticks; 104 break; 105 } 106 tap->txa_lastsample += hz; 107 } 108 tap->txa_pkts++; 109} 110 111/* 112 * Get the current pps estimate. If the average is out of 113 * date due to lack of traffic then we decay the estimate 114 * to account for the idle time. 115 */ 116static __inline int 117ieee80211_txampdu_getpps(struct ieee80211_tx_ampdu *tap) 118{ 119 /* XXX bound loop/do more crude estimate? */ 120 while (ticks - tap->txa_lastsample >= hz) { 121 ieee80211_txampdu_update_pps(tap); 122 tap->txa_pkts = 0; 123 if (tap->txa_avgpps == 0) { 124 tap->txa_lastsample = ticks; 125 break; 126 } 127 tap->txa_lastsample += hz; 128 } 129 return tap->txa_avgpps; 130} 131 132struct ieee80211_rx_ampdu { 133 int rxa_flags; 134 int rxa_qbytes; /* data queued (bytes) */ 135 short rxa_qframes; /* data queued (frames) */ 136 ieee80211_seq rxa_seqstart; 137 ieee80211_seq rxa_start; /* start of current BA window */ 138 uint16_t rxa_wnd; /* BA window size */ 139 int rxa_age; /* age of oldest frame in window */ 140 int rxa_nframes; /* frames since ADDBA */ 141 struct mbuf *rxa_m[IEEE80211_AGGR_BAWMAX]; 142}; 143 144void ieee80211_ht_attach(struct ieee80211com *); 145void ieee80211_ht_detach(struct ieee80211com *); 146void ieee80211_ht_vattach(struct ieee80211vap *); 147void ieee80211_ht_vdetach(struct ieee80211vap *); 148 149void ieee80211_ht_announce(struct ieee80211com *); 150 151struct ieee80211_mcs_rates { 152 uint16_t ht20_rate_800ns; 153 uint16_t ht20_rate_400ns; 154 uint16_t ht40_rate_800ns; 155 uint16_t ht40_rate_400ns; 156}; 157extern const struct ieee80211_mcs_rates ieee80211_htrates[16]; 158const struct ieee80211_htrateset *ieee80211_get_suphtrates( 159 struct ieee80211com *, const struct ieee80211_channel *); 160 161struct ieee80211_node; 162int ieee80211_setup_htrates(struct ieee80211_node *, 163 const uint8_t *htcap, int flags); 164void ieee80211_setup_basic_htrates(struct ieee80211_node *, 165 const uint8_t *htinfo); 166struct mbuf *ieee80211_decap_amsdu(struct ieee80211_node *, struct mbuf *); 167int ieee80211_ampdu_reorder(struct ieee80211_node *, struct mbuf *); 168void ieee80211_recv_bar(struct ieee80211_node *, struct mbuf *); 169void ieee80211_ht_node_init(struct ieee80211_node *, const uint8_t *); 170void ieee80211_ht_node_cleanup(struct ieee80211_node *); 171void ieee80211_ht_node_age(struct ieee80211_node *); 172 173struct ieee80211_channel *ieee80211_ht_adjust_channel(struct ieee80211com *, 174 struct ieee80211_channel *, int); 175void ieee80211_ht_wds_init(struct ieee80211_node *); 176void ieee80211_ht_node_join(struct ieee80211_node *); 177void ieee80211_ht_node_leave(struct ieee80211_node *); 178void ieee80211_htprot_update(struct ieee80211com *, int protmode); 179void ieee80211_ht_timeout(struct ieee80211com *); 180void ieee80211_parse_htcap(struct ieee80211_node *, const uint8_t *); 181void ieee80211_parse_htinfo(struct ieee80211_node *, const uint8_t *); 182void ieee80211_recv_action(struct ieee80211_node *, 183 const uint8_t *, const uint8_t *); 184int ieee80211_ampdu_request(struct ieee80211_node *, 185 struct ieee80211_tx_ampdu *); 186void ieee80211_ampdu_stop(struct ieee80211_node *, 187 struct ieee80211_tx_ampdu *); 188int ieee80211_send_bar(struct ieee80211_node *, 189 const struct ieee80211_tx_ampdu *); 190int ieee80211_send_action(struct ieee80211_node *, 191 int, int, uint16_t [4]); 192uint8_t *ieee80211_add_htcap(uint8_t *, struct ieee80211_node *); 193uint8_t *ieee80211_add_htcap_vendor(uint8_t *, struct ieee80211_node *); 194uint8_t *ieee80211_add_htinfo(uint8_t *, struct ieee80211_node *); 195uint8_t *ieee80211_add_htinfo_vendor(uint8_t *, struct ieee80211_node *); 196struct ieee80211_beacon_offsets; 197void ieee80211_ht_update_beacon(struct ieee80211vap *, 198 struct ieee80211_beacon_offsets *); 199#endif /* _NET80211_IEEE80211_HT_H_ */ 200