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