sys/dev/netif/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: src/sys/dev/ath/ath_rate/sample/sample.h,v 1.3.2.1 2006/02/24 19:51:11 sam Exp $
  37  * $DragonFly: src/sys/dev/netif/ath/rate_sample/sample.h,v 1.1 2006/07/13 09:15:22 sephe Exp $
  38  */
  39
  40 /*
  41  * Defintions for the Atheros Wireless LAN controller driver.
  42  */
  43 #ifndef _DEV_ATH_RATE_SAMPLE_H
  44 #define _DEV_ATH_RATE_SAMPLE_H
  45
  46 /* per-device state */
  47 struct sample_softc {
  48         struct ath_ratectrl arc;        /* base state */
  49         int     ath_smoothing_rate;     /* ewma percentage (out of 100) */
  50         int     ath_sample_rate;        /* send a different bit-rate 1/X packets */
  51 };
  52 #define ATH_SOFTC_SAMPLE(sc)    ((struct sample_softc *)sc->sc_rc)
  53
  54 struct rate_info {
  55         int rate;
  56         int rix;
  57         int rateCode;
  58         int shortPreambleRateCode;
  59 };
  60
  61
  62 struct rate_stats {
  63         unsigned average_tx_time;
  64         int successive_failures;
  65         int tries;
  66         int total_packets;
  67         int packets_acked;
  68         unsigned perfect_tx_time; /* transmit time for 0 retries */
  69         int last_tx;
  70 };
  71
  72 /*
  73  * for now, we track performance for three different packet
  74  * size buckets
  75  */
  76 #define NUM_PACKET_SIZE_BINS 3
  77 static int packet_size_bins[NUM_PACKET_SIZE_BINS] = {250, 1600, 3000};
  78
  79 /* per-node state */
  80 struct sample_node {
  81         int static_rate_ndx;
  82         int num_rates;
  83
  84         struct rate_info rates[IEEE80211_RATE_MAXSIZE];
  85
  86         struct rate_stats stats[NUM_PACKET_SIZE_BINS][IEEE80211_RATE_MAXSIZE];
  87         int last_sample_ndx[NUM_PACKET_SIZE_BINS];
  88
  89         int current_sample_ndx[NUM_PACKET_SIZE_BINS];
  90         int packets_sent[NUM_PACKET_SIZE_BINS];
  91
  92         int current_rate[NUM_PACKET_SIZE_BINS];
  93         int packets_since_switch[NUM_PACKET_SIZE_BINS];
  94         unsigned ticks_since_switch[NUM_PACKET_SIZE_BINS];
  95
  96         int packets_since_sample[NUM_PACKET_SIZE_BINS];
  97         unsigned sample_tt[NUM_PACKET_SIZE_BINS];
  98 };
  99 #define ATH_NODE_SAMPLE(an)     ((struct sample_node *)&an[1])
 100
 101 #ifndef MIN
 102 #define MIN(a,b)        ((a) < (b) ? (a) : (b))
 103 #endif
 104 #ifndef MAX
 105 #define MAX(a,b)        ((a) > (b) ? (a) : (b))
 106 #endif
 107
 108 #define WIFI_CW_MIN 31
 109 #define WIFI_CW_MAX 1023
 110
 111 struct ar5212_desc {
 112         /*
 113          * tx_control_0
 114          */
 115         uint32_t        frame_len:12;
 116         uint32_t        reserved_12_15:4;
 117         uint32_t        xmit_power:6;
 118         uint32_t        rts_cts_enable:1;
 119         uint32_t        veol:1;
 120         uint32_t        clear_dest_mask:1;
 121         uint32_t        ant_mode_xmit:4;
 122         uint32_t        inter_req:1;
 123         uint32_t        encrypt_key_valid:1;
 124         uint32_t        cts_enable:1;
 125
 126         /*
 127          * tx_control_1
 128          */
 129         uint32_t        buf_len:12;
 130         uint32_t        more:1;
 131         uint32_t        encrypt_key_index:7;
 132         uint32_t        frame_type:4;
 133         uint32_t        no_ack:1;
 134         uint32_t        comp_proc:2;
 135         uint32_t        comp_iv_len:2;
 136         uint32_t        comp_icv_len:2;
 137         uint32_t        reserved_31:1;
 138
 139         /*
 140          * tx_control_2
 141          */
 142         uint32_t        rts_duration:15;
 143         uint32_t        duration_update_enable:1;
 144         uint32_t        xmit_tries0:4;
 145         uint32_t        xmit_tries1:4;
 146         uint32_t        xmit_tries2:4;
 147         uint32_t        xmit_tries3:4;
 148
 149         /*
 150          * tx_control_3
 151          */
 152         uint32_t        xmit_rate0:5;
 153         uint32_t        xmit_rate1:5;
 154         uint32_t        xmit_rate2:5;
 155         uint32_t        xmit_rate3:5;
 156         uint32_t        rts_cts_rate:5;
 157         uint32_t        reserved_25_31:7;
 158
 159         /*
 160          * tx_status_0
 161          */
 162         uint32_t        frame_xmit_ok:1;
 163         uint32_t        excessive_retries:1;
 164         uint32_t        fifo_underrun:1;
 165         uint32_t        filtered:1;
 166         uint32_t        rts_fail_count:4;
 167         uint32_t        data_fail_count:4;
 168         uint32_t        virt_coll_count:4;
 169         uint32_t        send_timestamp:16;
 170
 171         /*
 172          * tx_status_1
 173          */
 174         uint32_t        done:1;
 175         uint32_t        seq_num:12;
 176         uint32_t        ack_sig_strength:8;
 177         uint32_t        final_ts_index:2;
 178         uint32_t        comp_success:1;
 179         uint32_t        xmit_antenna:1;
 180         uint32_t        reserved_25_31_x:7;
 181 } __packed;
 182
 183 /*
 184  * Calculate the transmit duration of a frame.
 185  */
 186 static unsigned calc_usecs_unicast_packet(struct ath_softc *sc,
 187                                 int length,
 188                                 int rix, int short_retries, int long_retries) {
 189         const HAL_RATE_TABLE *rt = sc->sc_currates;
 190         int rts, cts;
 191
 192         unsigned t_slot = 20;
 193         unsigned t_difs = 50;
 194         unsigned t_sifs = 10;
 195         struct ieee80211com *ic = &sc->sc_ic;
 196         int tt = 0;
 197         int x = 0;
 198         int cw = WIFI_CW_MIN;
 199         int cix = rt->info[rix].controlRate;
 200
 201         KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
 202
 203         if (!rt->info[rix].rateKbps) {
 204                 printf("rix %d (%d) bad ratekbps %d mode %u",
 205                        rix, rt->info[rix].dot11Rate,
 206                        rt->info[rix].rateKbps,
 207                        sc->sc_curmode);
 208
 209                 return 0;
 210         }
 211         /*
 212          * XXX getting mac/phy level timings should be fixed for turbo
 213          * rates, and there is probably a way to get this from the
 214          * hal...
 215          */
 216         switch (rt->info[rix].phy) {
 217         case IEEE80211_T_OFDM:
 218                 t_slot = 9;
 219                 t_sifs = 16;
 220                 t_difs = 28;
 221                 /* fall through */
 222         case IEEE80211_T_TURBO:
 223                 t_slot = 9;
 224                 t_sifs = 8;
 225                 t_difs = 28;
 226                 break;
 227         case IEEE80211_T_DS:
 228                 /* fall through to default */
 229         default:
 230                 /* pg 205 ieee.802.11.pdf */
 231                 t_slot = 20;
 232                 t_difs = 50;
 233                 t_sifs = 10;
 234         }
 235
 236         rts = cts = 0;
 237
 238         if ((ic->ic_flags & IEEE80211_F_USEPROT) &&
 239             rt->info[rix].phy == IEEE80211_T_OFDM) {
 240                 if (ic->ic_protmode == IEEE80211_PROT_RTSCTS)
 241                         rts = 1;
 242                 else if (ic->ic_protmode == IEEE80211_PROT_CTSONLY)
 243                         cts = 1;
 244
 245                 cix = rt->info[sc->sc_protrix].controlRate;
 246
 247         }
 248
 249         if (0 /*length > ic->ic_rtsthreshold */) {
 250                 rts = 1;
 251         }
 252
 253         if (rts || cts) {
 254                 int ctsrate = rt->info[cix].rateCode;
 255                 int ctsduration = 0;
 256
 257                 if (!rt->info[cix].rateKbps) {
 258                         printf("cix %d (%d) bad ratekbps %d mode %u",
 259                                cix, rt->info[cix].dot11Rate,
 260                                rt->info[cix].rateKbps,
 261                                sc->sc_curmode);
 262                         return 0;
 263                 }
 264
 265                 ctsrate |= rt->info[cix].shortPreamble;
 266                 if (rts)                /* SIFS + CTS */
 267                         ctsduration += rt->info[cix].spAckDuration;
 268
 269                 ctsduration += ath_hal_computetxtime(sc->sc_ah,
 270                                                      rt, length, rix, AH_TRUE);
 271
 272                 if (cts)        /* SIFS + ACK */
 273                         ctsduration += rt->info[cix].spAckDuration;
 274
 275                 tt += (short_retries + 1) * ctsduration;
 276         }
 277         tt += t_difs;
 278         tt += (long_retries+1)*(t_sifs + rt->info[rix].spAckDuration);
 279         tt += (long_retries+1)*ath_hal_computetxtime(sc->sc_ah, rt, length,
 280                                                 rix, AH_TRUE);
 281         for (x = 0; x <= short_retries + long_retries; x++) {
 282                 cw = MIN(WIFI_CW_MAX, (cw + 1) * 2);
 283                 tt += (t_slot * cw/2);
 284         }
 285         return tt;
 286 }
 287 #endif /* _DEV_ATH_RATE_SAMPLE_H */