sys/dev/ath/ath_rate/sample/sample.h

   1 /*-
   2  * Copyright (c) 2005 John Bicket
   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  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13  *    redistribution must be conditioned upon including a substantially
  14  *    similar Disclaimer requirement for further binary redistribution.
  15  * 3. Neither the names of the above-listed copyright holders nor the names
  16  *    of any contributors may be used to endorse or promote products derived
  17  *    from this software without specific prior written permission.
  18  *
  19  * Alternatively, this software may be distributed under the terms of the
  20  * GNU General Public License ("GPL") version 2 as published by the Free
  21  * Software Foundation.
  22  *
  23  * NO WARRANTY
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  27  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  28  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  29  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  32  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  34  * THE POSSIBILITY OF SUCH DAMAGES.
  35  *
  36  * $FreeBSD$
  37  */
  38
  39 /*
  40  * Defintions for the Atheros Wireless LAN controller driver.
  41  */
  42 #ifndef _DEV_ATH_RATE_SAMPLE_H
  43 #define _DEV_ATH_RATE_SAMPLE_H
  44
  45 /* per-device state */
  46 struct sample_softc {
  47         struct ath_ratectrl arc;        /* base state */
  48         int     ath_smoothing_rate;     /* ewma percentage (out of 100) */
  49         int     ath_sample_rate;        /* send a different bit-rate 1/X packets */
  50 };
  51 #define ATH_SOFTC_SAMPLE(sc)    ((struct sample_softc *)sc->sc_rc)
  52
  53 struct rate_info {
  54         int rate;
  55         int rix;
  56         int rateCode;
  57         int shortPreambleRateCode;
  58 };
  59
  60
  61 struct rate_stats {
  62         unsigned average_tx_time;
  63         int successive_failures;
  64         int tries;
  65         int total_packets;
  66         int packets_acked;
  67         unsigned perfect_tx_time; /* transmit time for 0 retries */
  68         int last_tx;
  69 };
  70
  71 /*
  72  * for now, we track performance for three different packet
  73  * size buckets
  74  */
  75 #define NUM_PACKET_SIZE_BINS 3
  76 static int packet_size_bins[NUM_PACKET_SIZE_BINS] = {250, 1600, 3000};
  77
  78 /* per-node state */
  79 struct sample_node {
  80         int static_rate_ndx;
  81         int num_rates;
  82
  83         struct rate_info rates[IEEE80211_RATE_MAXSIZE];
  84
  85         struct rate_stats stats[NUM_PACKET_SIZE_BINS][IEEE80211_RATE_MAXSIZE];
  86         int last_sample_ndx[NUM_PACKET_SIZE_BINS];
  87
  88         int current_sample_ndx[NUM_PACKET_SIZE_BINS];
  89         int packets_sent[NUM_PACKET_SIZE_BINS];
  90
  91         int current_rate[NUM_PACKET_SIZE_BINS];
  92         int packets_since_switch[NUM_PACKET_SIZE_BINS];
  93         unsigned ticks_since_switch[NUM_PACKET_SIZE_BINS];
  94
  95         int packets_since_sample[NUM_PACKET_SIZE_BINS];
  96         unsigned sample_tt[NUM_PACKET_SIZE_BINS];
  97 };
  98 #define ATH_NODE_SAMPLE(an)     ((struct sample_node *)&an[1])
  99
 100 #ifndef MIN
 101 #define MIN(a,b)        ((a) < (b) ? (a) : (b))
 102 #endif
 103 #ifndef MAX
 104 #define MAX(a,b)        ((a) > (b) ? (a) : (b))
 105 #endif
 106
 107 #define WIFI_CW_MIN 31
 108 #define WIFI_CW_MAX 1023
 109
 110 /*
 111  * Definitions for pulling the rate and trie counts from
 112  * a 5212 h/w descriptor.  These Don't belong here; the
 113  * driver should record this information so the rate control
 114  * code doesn't go groveling around in the descriptor bits.
 115  */
 116 #define ds_ctl2         ds_hw[0]
 117 #define ds_ctl3         ds_hw[1]
 118
 119 /* TX ds_ctl2 */
 120 #define AR_XmitDataTries0       0x000f0000      /* series 0 max attempts */
 121 #define AR_XmitDataTries0_S     16
 122 #define AR_XmitDataTries1       0x00f00000      /* series 1 max attempts */
 123 #define AR_XmitDataTries1_S     20
 124 #define AR_XmitDataTries2       0x0f000000      /* series 2 max attempts */
 125 #define AR_XmitDataTries2_S     24
 126 #define AR_XmitDataTries3       0xf0000000      /* series 3 max attempts */
 127 #define AR_XmitDataTries3_S     28
 128
 129 /* TX ds_ctl3 */
 130 #define AR_XmitRate0            0x0000001f      /* series 0 tx rate */
 131 #define AR_XmitRate0_S          0
 132 #define AR_XmitRate1            0x000003e0      /* series 1 tx rate */
 133 #define AR_XmitRate1_S          5
 134 #define AR_XmitRate2            0x00007c00      /* series 2 tx rate */
 135 #define AR_XmitRate2_S          10
 136 #define AR_XmitRate3            0x000f8000      /* series 3 tx rate */
 137 #define AR_XmitRate3_S          15
 138
 139 /* TX ds_ctl3 for 5416 */
 140 #define AR5416_XmitRate0        0x000000ff      /* series 0 tx rate */
 141 #define AR5416_XmitRate0_S      0
 142 #define AR5416_XmitRate1        0x0000ff00      /* series 1 tx rate */
 143 #define AR5416_XmitRate1_S      8
 144 #define AR5416_XmitRate2        0x00ff0000      /* series 2 tx rate */
 145 #define AR5416_XmitRate2_S      16
 146 #define AR5416_XmitRate3        0xff000000      /* series 3 tx rate */
 147 #define AR5416_XmitRate3_S      24
 148
 149 #define MS(_v, _f)      (((_v) & (_f)) >> _f##_S)
 150
 151 /*
 152  * Calculate the transmit duration of a frame.
 153  */
 154 static unsigned calc_usecs_unicast_packet(struct ath_softc *sc,
 155                                 int length,
 156                                 int rix, int short_retries, int long_retries) {
 157         const HAL_RATE_TABLE *rt = sc->sc_currates;
 158         int rts, cts;
 159
 160         unsigned t_slot = 20;
 161         unsigned t_difs = 50;
 162         unsigned t_sifs = 10;
 163         struct ieee80211com *ic = &sc->sc_ic;
 164         int tt = 0;
 165         int x = 0;
 166         int cw = WIFI_CW_MIN;
 167         int cix;
 168
 169         KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
 170
 171         if (rix >= rt->rateCount) {
 172                 printf("bogus rix %d, max %u, mode %u\n",
 173                        rix, rt->rateCount, sc->sc_curmode);
 174                 return 0;
 175         }
 176         cix = rt->info[rix].controlRate;
 177         /*
 178          * XXX getting mac/phy level timings should be fixed for turbo
 179          * rates, and there is probably a way to get this from the
 180          * hal...
 181          */
 182         switch (rt->info[rix].phy) {
 183         case IEEE80211_T_OFDM:
 184                 t_slot = 9;
 185                 t_sifs = 16;
 186                 t_difs = 28;
 187                 /* fall through */
 188         case IEEE80211_T_TURBO:
 189                 t_slot = 9;
 190                 t_sifs = 8;
 191                 t_difs = 28;
 192                 break;
 193         case IEEE80211_T_DS:
 194                 /* fall through to default */
 195         default:
 196                 /* pg 205 ieee.802.11.pdf */
 197                 t_slot = 20;
 198                 t_difs = 50;
 199                 t_sifs = 10;
 200         }
 201
 202         rts = cts = 0;
 203
 204         if ((ic->ic_flags & IEEE80211_F_USEPROT) &&
 205             rt->info[rix].phy == IEEE80211_T_OFDM) {
 206                 if (ic->ic_protmode == IEEE80211_PROT_RTSCTS)
 207                         rts = 1;
 208                 else if (ic->ic_protmode == IEEE80211_PROT_CTSONLY)
 209                         cts = 1;
 210
 211                 cix = rt->info[sc->sc_protrix].controlRate;
 212
 213         }
 214
 215         if (0 /*length > ic->ic_rtsthreshold */) {
 216                 rts = 1;
 217         }
 218
 219         if (rts || cts) {
 220                 int ctsrate;
 221                 int ctsduration = 0;
 222
 223                 /* NB: this is intentionally not a runtime check */
 224                 KASSERT(cix < rt->rateCount,
 225                     ("bogus cix %d, max %u, mode %u\n", cix, rt->rateCount,
 226                      sc->sc_curmode));
 227
 228                 ctsrate = rt->info[cix].rateCode | rt->info[cix].shortPreamble;
 229                 if (rts)                /* SIFS + CTS */
 230                         ctsduration += rt->info[cix].spAckDuration;
 231
 232                 ctsduration += ath_hal_computetxtime(sc->sc_ah,
 233                                                      rt, length, rix, AH_TRUE);
 234
 235                 if (cts)        /* SIFS + ACK */
 236                         ctsduration += rt->info[cix].spAckDuration;
 237
 238                 tt += (short_retries + 1) * ctsduration;
 239         }
 240         tt += t_difs;
 241         tt += (long_retries+1)*(t_sifs + rt->info[rix].spAckDuration);
 242         tt += (long_retries+1)*ath_hal_computetxtime(sc->sc_ah, rt, length,
 243                                                 rix, AH_TRUE);
 244         for (x = 0; x <= short_retries + long_retries; x++) {
 245                 cw = MIN(WIFI_CW_MAX, (cw + 1) * 2);
 246                 tt += (t_slot * cw/2);
 247         }
 248         return tt;
 249 }
 250 #endif /* _DEV_ATH_RATE_SAMPLE_H */