sys/net80211/ieee80211_ht.h

   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$
  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
  38 struct 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 #define IEEE80211_AGGR_WAITRX           0x0040  /* Wait for first RX frame to define BAW */
  48         uint8_t         txa_tid;
  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 */
  62         uint64_t        txa_pad[4];
  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 was NACKed */
  70 #define IEEE80211_AMPDU_NACKED(tap)\
  71         (!! ((tap)->txa_flags & IEEE80211_AGGR_NAK))
  72
  73 /* return non-zero if AMPDU tx for the TID is running or started */
  74 #define IEEE80211_AMPDU_REQUESTED(tap) \
  75         (((tap)->txa_flags & \
  76          (IEEE80211_AGGR_RUNNING|IEEE80211_AGGR_XCHGPEND|IEEE80211_AGGR_NAK)) != 0)
  77
  78 #define IEEE80211_AGGR_BITS \
  79         "\20\1IMMEDIATE\2XCHGPEND\3RUNNING\4SETUP\5NAK"
  80
  81 /*
  82  * Traffic estimator support.  We estimate packets/sec for
  83  * each AC that is setup for AMPDU or will potentially be
  84  * setup for AMPDU.  The traffic rate can be used to decide
  85  * when AMPDU should be setup (according to a threshold)
  86  * and is available for drivers to do things like cache
  87  * eviction when only a limited number of BA streams are
  88  * available and more streams are requested than available.
  89  */
  90
  91 static __inline void
  92 ieee80211_txampdu_init_pps(struct ieee80211_tx_ampdu *tap)
  93 {
  94         /*
  95          * Reset packet estimate.
  96          */
  97         tap->txa_lastsample = ticks;
  98         tap->txa_avgpps = 0;
  99 }
 100
 101 static __inline void
 102 ieee80211_txampdu_update_pps(struct ieee80211_tx_ampdu *tap)
 103 {
 104
 105         /* NB: scale factor of 2 was picked heuristically */
 106         tap->txa_avgpps = ((tap->txa_avgpps << 2) -
 107              tap->txa_avgpps + tap->txa_pkts) >> 2;
 108 }
 109
 110 /*
 111  * Count a packet towards the pps estimate.
 112  */
 113 static __inline void
 114 ieee80211_txampdu_count_packet(struct ieee80211_tx_ampdu *tap)
 115 {
 116
 117         /* XXX bound loop/do more crude estimate? */
 118         while (ticks - tap->txa_lastsample >= hz) {
 119                 ieee80211_txampdu_update_pps(tap);
 120                 /* reset to start new sample interval */
 121                 tap->txa_pkts = 0;
 122                 if (tap->txa_avgpps == 0) {
 123                         tap->txa_lastsample = ticks;
 124                         break;
 125                 }
 126                 tap->txa_lastsample += hz;
 127         }
 128         tap->txa_pkts++;
 129 }
 130
 131 /*
 132  * Get the current pps estimate.  If the average is out of
 133  * date due to lack of traffic then we decay the estimate
 134  * to account for the idle time.
 135  */
 136 static __inline int
 137 ieee80211_txampdu_getpps(struct ieee80211_tx_ampdu *tap)
 138 {
 139         /* XXX bound loop/do more crude estimate? */
 140         while (ticks - tap->txa_lastsample >= hz) {
 141                 ieee80211_txampdu_update_pps(tap);
 142                 tap->txa_pkts = 0;
 143                 if (tap->txa_avgpps == 0) {
 144                         tap->txa_lastsample = ticks;
 145                         break;
 146                 }
 147                 tap->txa_lastsample += hz;
 148         }
 149         return tap->txa_avgpps;
 150 }
 151
 152 struct ieee80211_rx_ampdu {
 153         int             rxa_flags;
 154         int             rxa_qbytes;     /* data queued (bytes) */
 155         short           rxa_qframes;    /* data queued (frames) */
 156         ieee80211_seq   rxa_seqstart;
 157         ieee80211_seq   rxa_start;      /* start of current BA window */
 158         uint16_t        rxa_wnd;        /* BA window size */
 159         int             rxa_age;        /* age of oldest frame in window */
 160         int             rxa_nframes;    /* frames since ADDBA */
 161         struct mbuf *rxa_m[IEEE80211_AGGR_BAWMAX];
 162         void            *rxa_private;
 163         uint64_t        rxa_pad[3];
 164 };
 165
 166 void    ieee80211_ht_attach(struct ieee80211com *);
 167 void    ieee80211_ht_detach(struct ieee80211com *);
 168 void    ieee80211_ht_vattach(struct ieee80211vap *);
 169 void    ieee80211_ht_vdetach(struct ieee80211vap *);
 170
 171 void    ieee80211_ht_announce(struct ieee80211com *);
 172
 173 struct ieee80211_mcs_rates {
 174         uint16_t        ht20_rate_800ns;
 175         uint16_t        ht20_rate_400ns;
 176         uint16_t        ht40_rate_800ns;
 177         uint16_t        ht40_rate_400ns;
 178 };
 179 extern const struct ieee80211_mcs_rates ieee80211_htrates[];
 180 void    ieee80211_init_suphtrates(struct ieee80211com *);
 181
 182 struct ieee80211_node;
 183 int     ieee80211_setup_htrates(struct ieee80211_node *,
 184                 const uint8_t *htcap, int flags);
 185 void    ieee80211_setup_basic_htrates(struct ieee80211_node *,
 186                 const uint8_t *htinfo);
 187 struct mbuf *ieee80211_decap_amsdu(struct ieee80211_node *, struct mbuf *);
 188 int     ieee80211_ampdu_reorder(struct ieee80211_node *, struct mbuf *,
 189             const struct ieee80211_rx_stats *);
 190 void    ieee80211_recv_bar(struct ieee80211_node *, struct mbuf *);
 191 void    ieee80211_ht_node_init(struct ieee80211_node *);
 192 void    ieee80211_ht_node_cleanup(struct ieee80211_node *);
 193 void    ieee80211_ht_node_age(struct ieee80211_node *);
 194
 195 struct ieee80211_channel *ieee80211_ht_adjust_channel(struct ieee80211com *,
 196                 struct ieee80211_channel *, int);
 197 void    ieee80211_ht_wds_init(struct ieee80211_node *);
 198 void    ieee80211_ht_node_join(struct ieee80211_node *);
 199 void    ieee80211_ht_node_leave(struct ieee80211_node *);
 200 void    ieee80211_htprot_update(struct ieee80211com *, int protmode);
 201 void    ieee80211_ht_timeout(struct ieee80211com *);
 202 void    ieee80211_parse_htcap(struct ieee80211_node *, const uint8_t *);
 203 void    ieee80211_parse_htinfo(struct ieee80211_node *, const uint8_t *);
 204 void    ieee80211_ht_updateparams(struct ieee80211_node *, const uint8_t *,
 205                 const uint8_t *);
 206 int     ieee80211_ht_updateparams_final(struct ieee80211_node *,
 207             const uint8_t *, const uint8_t *);
 208 void    ieee80211_ht_updatehtcap(struct ieee80211_node *, const uint8_t *);
 209 void    ieee80211_ht_updatehtcap_final(struct ieee80211_node *);
 210 int     ieee80211_ampdu_request(struct ieee80211_node *,
 211                 struct ieee80211_tx_ampdu *);
 212 void    ieee80211_ampdu_stop(struct ieee80211_node *,
 213                 struct ieee80211_tx_ampdu *, int);
 214 int     ieee80211_send_bar(struct ieee80211_node *, struct ieee80211_tx_ampdu *,
 215                 ieee80211_seq);
 216 uint8_t *ieee80211_add_htcap(uint8_t *, struct ieee80211_node *);
 217 uint8_t *ieee80211_add_htcap_ch(uint8_t *, struct ieee80211vap *,
 218             struct ieee80211_channel *);
 219 uint8_t *ieee80211_add_htcap_vendor(uint8_t *, struct ieee80211_node *);
 220 uint8_t *ieee80211_add_htinfo(uint8_t *, struct ieee80211_node *);
 221 uint8_t *ieee80211_add_htinfo_vendor(uint8_t *, struct ieee80211_node *);
 222 struct ieee80211_beacon_offsets;
 223 void    ieee80211_ht_update_beacon(struct ieee80211vap *,
 224                 struct ieee80211_beacon_offsets *);
 225 int     ieee80211_ampdu_rx_start_ext(struct ieee80211_node *ni, int tid,
 226             int seq, int baw);
 227 void    ieee80211_ampdu_rx_stop_ext(struct ieee80211_node *ni, int tid);
 228 int     ieee80211_ampdu_tx_request_ext(struct ieee80211_node *ni, int tid);
 229 int     ieee80211_ampdu_tx_request_active_ext(struct ieee80211_node *ni,
 230             int tid, int status);
 231
 232 #endif /* _NET80211_IEEE80211_HT_H_ */