net/mac80211/rc80211_minstrel.c

   1 /*
   2  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * Based on minstrel.c:
   9  *   Copyright (C) 2005-2007 Derek Smithies <derek@indranet.co.nz>
  10  *   Sponsored by Indranet Technologies Ltd
  11  *
  12  * Based on sample.c:
  13  *   Copyright (c) 2005 John Bicket
  14  *   All rights reserved.
  15  *
  16  *   Redistribution and use in source and binary forms, with or without
  17  *   modification, are permitted provided that the following conditions
  18  *   are met:
  19  *   1. Redistributions of source code must retain the above copyright
  20  *      notice, this list of conditions and the following disclaimer,
  21  *      without modification.
  22  *   2. Redistributions in binary form must reproduce at minimum a disclaimer
  23  *      similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  24  *      redistribution must be conditioned upon including a substantially
  25  *      similar Disclaimer requirement for further binary redistribution.
  26  *   3. Neither the names of the above-listed copyright holders nor the names
  27  *      of any contributors may be used to endorse or promote products derived
  28  *      from this software without specific prior written permission.
  29  *
  30  *   Alternatively, this software may be distributed under the terms of the
  31  *   GNU General Public License ("GPL") version 2 as published by the Free
  32  *   Software Foundation.
  33  *
  34  *   NO WARRANTY
  35  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  36  *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  *   LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  38  *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  39  *   THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  40  *   OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  41  *   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  42  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  43  *   IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  44  *   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  45  *   THE POSSIBILITY OF SUCH DAMAGES.
  46  */
  47 #include <linux/netdevice.h>
  48 #include <linux/types.h>
  49 #include <linux/skbuff.h>
  50 #include <linux/debugfs.h>
  51 #include <linux/random.h>
  52 #include <linux/ieee80211.h>
  53 #include <linux/slab.h>
  54 #include <net/mac80211.h>
  55 #include "rate.h"
  56 #include "rc80211_minstrel.h"
  57
  58 #define SAMPLE_TBL(_mi, _idx, _col) \
  59                 _mi->sample_table[(_idx * SAMPLE_COLUMNS) + _col]
  60
  61 /* convert mac80211 rate index to local array index */
  62 static inline int
  63 rix_to_ndx(struct minstrel_sta_info *mi, int rix)
  64 {
  65         int i = rix;
  66         for (i = rix; i >= 0; i--)
  67                 if (mi->r[i].rix == rix)
  68                         break;
  69         return i;
  70 }
  71
  72 /* return current EMWA throughput */
  73 int minstrel_get_tp_avg(struct minstrel_rate *mr, int prob_ewma)
  74 {
  75         int usecs;
  76
  77         usecs = mr->perfect_tx_time;
  78         if (!usecs)
  79                 usecs = 1000000;
  80
  81         /* reset thr. below 10% success */
  82         if (mr->stats.prob_ewma < MINSTREL_FRAC(10, 100))
  83                 return 0;
  84
  85         if (prob_ewma > MINSTREL_FRAC(90, 100))
  86                 return MINSTREL_TRUNC(100000 * (MINSTREL_FRAC(90, 100) / usecs));
  87         else
  88                 return MINSTREL_TRUNC(100000 * (prob_ewma / usecs));
  89 }
  90
  91 /* find & sort topmost throughput rates */
  92 static inline void
  93 minstrel_sort_best_tp_rates(struct minstrel_sta_info *mi, int i, u8 *tp_list)
  94 {
  95         int j;
  96         struct minstrel_rate_stats *tmp_mrs;
  97         struct minstrel_rate_stats *cur_mrs = &mi->r[i].stats;
  98
  99         for (j = MAX_THR_RATES; j > 0; --j) {
 100                 tmp_mrs = &mi->r[tp_list[j - 1]].stats;
 101                 if (minstrel_get_tp_avg(&mi->r[i], cur_mrs->prob_ewma) <=
 102                     minstrel_get_tp_avg(&mi->r[tp_list[j - 1]], tmp_mrs->prob_ewma))
 103                         break;
 104         }
 105
 106         if (j < MAX_THR_RATES - 1)
 107                 memmove(&tp_list[j + 1], &tp_list[j], MAX_THR_RATES - (j + 1));
 108         if (j < MAX_THR_RATES)
 109                 tp_list[j] = i;
 110 }
 111
 112 static void
 113 minstrel_set_rate(struct minstrel_sta_info *mi, struct ieee80211_sta_rates *ratetbl,
 114                   int offset, int idx)
 115 {
 116         struct minstrel_rate *r = &mi->r[idx];
 117
 118         ratetbl->rate[offset].idx = r->rix;
 119         ratetbl->rate[offset].count = r->adjusted_retry_count;
 120         ratetbl->rate[offset].count_cts = r->retry_count_cts;
 121         ratetbl->rate[offset].count_rts = r->stats.retry_count_rtscts;
 122 }
 123
 124 static void
 125 minstrel_update_rates(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
 126 {
 127         struct ieee80211_sta_rates *ratetbl;
 128         int i = 0;
 129
 130         ratetbl = kzalloc(sizeof(*ratetbl), GFP_ATOMIC);
 131         if (!ratetbl)
 132                 return;
 133
 134         /* Start with max_tp_rate */
 135         minstrel_set_rate(mi, ratetbl, i++, mi->max_tp_rate[0]);
 136
 137         if (mp->hw->max_rates >= 3) {
 138                 /* At least 3 tx rates supported, use max_tp_rate2 next */
 139                 minstrel_set_rate(mi, ratetbl, i++, mi->max_tp_rate[1]);
 140         }
 141
 142         if (mp->hw->max_rates >= 2) {
 143                 /* At least 2 tx rates supported, use max_prob_rate next */
 144                 minstrel_set_rate(mi, ratetbl, i++, mi->max_prob_rate);
 145         }
 146
 147         /* Use lowest rate last */
 148         ratetbl->rate[i].idx = mi->lowest_rix;
 149         ratetbl->rate[i].count = mp->max_retry;
 150         ratetbl->rate[i].count_cts = mp->max_retry;
 151         ratetbl->rate[i].count_rts = mp->max_retry;
 152
 153         rate_control_set_rates(mp->hw, mi->sta, ratetbl);
 154 }
 155
 156 /*
 157 * Recalculate statistics and counters of a given rate
 158 */
 159 void
 160 minstrel_calc_rate_stats(struct minstrel_rate_stats *mrs)
 161 {
 162         unsigned int cur_prob;
 163
 164         if (unlikely(mrs->attempts > 0)) {
 165                 mrs->sample_skipped = 0;
 166                 cur_prob = MINSTREL_FRAC(mrs->success, mrs->attempts);
 167                 if (unlikely(!mrs->att_hist)) {
 168                         mrs->prob_ewma = cur_prob;
 169                 } else {
 170                         /* update exponential weighted moving variance */
 171                         mrs->prob_ewmv = minstrel_ewmv(mrs->prob_ewmv,
 172                                                         cur_prob,
 173                                                         mrs->prob_ewma,
 174                                                         EWMA_LEVEL);
 175
 176                         /*update exponential weighted moving avarage */
 177                         mrs->prob_ewma = minstrel_ewma(mrs->prob_ewma,
 178                                                        cur_prob,
 179                                                        EWMA_LEVEL);
 180                 }
 181                 mrs->att_hist += mrs->attempts;
 182                 mrs->succ_hist += mrs->success;
 183         } else {
 184                 mrs->sample_skipped++;
 185         }
 186
 187         mrs->last_success = mrs->success;
 188         mrs->last_attempts = mrs->attempts;
 189         mrs->success = 0;
 190         mrs->attempts = 0;
 191 }
 192
 193 static void
 194 minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
 195 {
 196         u8 tmp_tp_rate[MAX_THR_RATES];
 197         u8 tmp_prob_rate = 0;
 198         int i, tmp_cur_tp, tmp_prob_tp;
 199
 200         for (i = 0; i < MAX_THR_RATES; i++)
 201             tmp_tp_rate[i] = 0;
 202
 203         for (i = 0; i < mi->n_rates; i++) {
 204                 struct minstrel_rate *mr = &mi->r[i];
 205                 struct minstrel_rate_stats *mrs = &mi->r[i].stats;
 206                 struct minstrel_rate_stats *tmp_mrs = &mi->r[tmp_prob_rate].stats;
 207
 208                 /* Update statistics of success probability per rate */
 209                 minstrel_calc_rate_stats(mrs);
 210
 211                 /* Sample less often below the 10% chance of success.
 212                  * Sample less often above the 95% chance of success. */
 213                 if (mrs->prob_ewma > MINSTREL_FRAC(95, 100) ||
 214                     mrs->prob_ewma < MINSTREL_FRAC(10, 100)) {
 215                         mr->adjusted_retry_count = mrs->retry_count >> 1;
 216                         if (mr->adjusted_retry_count > 2)
 217                                 mr->adjusted_retry_count = 2;
 218                         mr->sample_limit = 4;
 219                 } else {
 220                         mr->sample_limit = -1;
 221                         mr->adjusted_retry_count = mrs->retry_count;
 222                 }
 223                 if (!mr->adjusted_retry_count)
 224                         mr->adjusted_retry_count = 2;
 225
 226                 minstrel_sort_best_tp_rates(mi, i, tmp_tp_rate);
 227
 228                 /* To determine the most robust rate (max_prob_rate) used at
 229                  * 3rd mmr stage we distinct between two cases:
 230                  * (1) if any success probabilitiy >= 95%, out of those rates
 231                  * choose the maximum throughput rate as max_prob_rate
 232                  * (2) if all success probabilities < 95%, the rate with
 233                  * highest success probability is chosen as max_prob_rate */
 234                 if (mrs->prob_ewma >= MINSTREL_FRAC(95, 100)) {
 235                         tmp_cur_tp = minstrel_get_tp_avg(mr, mrs->prob_ewma);
 236                         tmp_prob_tp = minstrel_get_tp_avg(&mi->r[tmp_prob_rate],
 237                                                           tmp_mrs->prob_ewma);
 238                         if (tmp_cur_tp >= tmp_prob_tp)
 239                                 tmp_prob_rate = i;
 240                 } else {
 241                         if (mrs->prob_ewma >= tmp_mrs->prob_ewma)
 242                                 tmp_prob_rate = i;
 243                 }
 244         }
 245
 246         /* Assign the new rate set */
 247         memcpy(mi->max_tp_rate, tmp_tp_rate, sizeof(mi->max_tp_rate));
 248         mi->max_prob_rate = tmp_prob_rate;
 249
 250 #ifdef CONFIG_MAC80211_DEBUGFS
 251         /* use fixed index if set */
 252         if (mp->fixed_rate_idx != -1) {
 253                 mi->max_tp_rate[0] = mp->fixed_rate_idx;
 254                 mi->max_tp_rate[1] = mp->fixed_rate_idx;
 255                 mi->max_prob_rate = mp->fixed_rate_idx;
 256         }
 257 #endif
 258
 259         /* Reset update timer */
 260         mi->last_stats_update = jiffies;
 261
 262         minstrel_update_rates(mp, mi);
 263 }
 264
 265 static void
 266 minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
 267                    void *priv_sta, struct ieee80211_tx_status *st)
 268 {
 269         struct ieee80211_tx_info *info = st->info;
 270         struct minstrel_priv *mp = priv;
 271         struct minstrel_sta_info *mi = priv_sta;
 272         struct ieee80211_tx_rate *ar = info->status.rates;
 273         int i, ndx;
 274         int success;
 275
 276         success = !!(info->flags & IEEE80211_TX_STAT_ACK);
 277
 278         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
 279                 if (ar[i].idx < 0 || !ar[i].count)
 280                         break;
 281
 282                 ndx = rix_to_ndx(mi, ar[i].idx);
 283                 if (ndx < 0)
 284                         continue;
 285
 286                 mi->r[ndx].stats.attempts += ar[i].count;
 287
 288                 if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
 289                         mi->r[ndx].stats.success += success;
 290         }
 291
 292         if (time_after(jiffies, mi->last_stats_update +
 293                                 (mp->update_interval * HZ) / 1000))
 294                 minstrel_update_stats(mp, mi);
 295 }
 296
 297
 298 static inline unsigned int
 299 minstrel_get_retry_count(struct minstrel_rate *mr,
 300                          struct ieee80211_tx_info *info)
 301 {
 302         u8 retry = mr->adjusted_retry_count;
 303
 304         if (info->control.use_rts)
 305                 retry = max_t(u8, 2, min(mr->stats.retry_count_rtscts, retry));
 306         else if (info->control.use_cts_prot)
 307                 retry = max_t(u8, 2, min(mr->retry_count_cts, retry));
 308         return retry;
 309 }
 310
 311
 312 static int
 313 minstrel_get_next_sample(struct minstrel_sta_info *mi)
 314 {
 315         unsigned int sample_ndx;
 316         sample_ndx = SAMPLE_TBL(mi, mi->sample_row, mi->sample_column);
 317         mi->sample_row++;
 318         if ((int) mi->sample_row >= mi->n_rates) {
 319                 mi->sample_row = 0;
 320                 mi->sample_column++;
 321                 if (mi->sample_column >= SAMPLE_COLUMNS)
 322                         mi->sample_column = 0;
 323         }
 324         return sample_ndx;
 325 }
 326
 327 static void
 328 minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
 329                   void *priv_sta, struct ieee80211_tx_rate_control *txrc)
 330 {
 331         struct sk_buff *skb = txrc->skb;
 332         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
 333         struct minstrel_sta_info *mi = priv_sta;
 334         struct minstrel_priv *mp = priv;
 335         struct ieee80211_tx_rate *rate = &info->control.rates[0];
 336         struct minstrel_rate *msr, *mr;
 337         unsigned int ndx;
 338         bool mrr_capable;
 339         bool prev_sample;
 340         int delta;
 341         int sampling_ratio;
 342
 343         /* management/no-ack frames do not use rate control */
 344         if (rate_control_send_low(sta, priv_sta, txrc))
 345                 return;
 346
 347         /* check multi-rate-retry capabilities & adjust lookaround_rate */
 348         mrr_capable = mp->has_mrr &&
 349                       !txrc->rts &&
 350                       !txrc->bss_conf->use_cts_prot;
 351         if (mrr_capable)
 352                 sampling_ratio = mp->lookaround_rate_mrr;
 353         else
 354                 sampling_ratio = mp->lookaround_rate;
 355
 356         /* increase sum packet counter */
 357         mi->total_packets++;
 358
 359 #ifdef CONFIG_MAC80211_DEBUGFS
 360         if (mp->fixed_rate_idx != -1)
 361                 return;
 362 #endif
 363
 364         /* Don't use EAPOL frames for sampling on non-mrr hw */
 365         if (mp->hw->max_rates == 1 &&
 366             (info->control.flags & IEEE80211_TX_CTRL_PORT_CTRL_PROTO))
 367                 return;
 368
 369         delta = (mi->total_packets * sampling_ratio / 100) -
 370                         mi->sample_packets;
 371
 372         /* delta < 0: no sampling required */
 373         prev_sample = mi->prev_sample;
 374         mi->prev_sample = false;
 375         if (delta < 0 || (!mrr_capable && prev_sample))
 376                 return;
 377
 378         if (mi->total_packets >= 10000) {
 379                 mi->sample_packets = 0;
 380                 mi->total_packets = 0;
 381         } else if (delta > mi->n_rates * 2) {
 382                 /* With multi-rate retry, not every planned sample
 383                  * attempt actually gets used, due to the way the retry
 384                  * chain is set up - [max_tp,sample,prob,lowest] for
 385                  * sample_rate < max_tp.
 386                  *
 387                  * If there's too much sampling backlog and the link
 388                  * starts getting worse, minstrel would start bursting
 389                  * out lots of sampling frames, which would result
 390                  * in a large throughput loss. */
 391                 mi->sample_packets += (delta - mi->n_rates * 2);
 392         }
 393
 394         /* get next random rate sample */
 395         ndx = minstrel_get_next_sample(mi);
 396         msr = &mi->r[ndx];
 397         mr = &mi->r[mi->max_tp_rate[0]];
 398
 399         /* Decide if direct ( 1st mrr stage) or indirect (2nd mrr stage)
 400          * rate sampling method should be used.
 401          * Respect such rates that are not sampled for 20 interations.
 402          */
 403         if (msr->perfect_tx_time < mr->perfect_tx_time ||
 404             msr->stats.sample_skipped >= 20) {
 405                 if (!msr->sample_limit)
 406                         return;
 407
 408                 mi->sample_packets++;
 409                 if (msr->sample_limit > 0)
 410                         msr->sample_limit--;
 411         }
 412
 413         /* If we're not using MRR and the sampling rate already
 414          * has a probability of >95%, we shouldn't be attempting
 415          * to use it, as this only wastes precious airtime */
 416         if (!mrr_capable &&
 417            (mi->r[ndx].stats.prob_ewma > MINSTREL_FRAC(95, 100)))
 418                 return;
 419
 420         mi->prev_sample = true;
 421
 422         rate->idx = mi->r[ndx].rix;
 423         rate->count = minstrel_get_retry_count(&mi->r[ndx], info);
 424         info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
 425 }
 426
 427
 428 static void
 429 calc_rate_durations(enum nl80211_band band,
 430                     struct minstrel_rate *d,
 431                     struct ieee80211_rate *rate,
 432                     struct cfg80211_chan_def *chandef)
 433 {
 434         int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
 435         int shift = ieee80211_chandef_get_shift(chandef);
 436
 437         d->perfect_tx_time = ieee80211_frame_duration(band, 1200,
 438                         DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
 439                         shift);
 440         d->ack_time = ieee80211_frame_duration(band, 10,
 441                         DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
 442                         shift);
 443 }
 444
 445 static void
 446 init_sample_table(struct minstrel_sta_info *mi)
 447 {
 448         unsigned int i, col, new_idx;
 449         u8 rnd[8];
 450
 451         mi->sample_column = 0;
 452         mi->sample_row = 0;
 453         memset(mi->sample_table, 0xff, SAMPLE_COLUMNS * mi->n_rates);
 454
 455         for (col = 0; col < SAMPLE_COLUMNS; col++) {
 456                 prandom_bytes(rnd, sizeof(rnd));
 457                 for (i = 0; i < mi->n_rates; i++) {
 458                         new_idx = (i + rnd[i & 7]) % mi->n_rates;
 459                         while (SAMPLE_TBL(mi, new_idx, col) != 0xff)
 460                                 new_idx = (new_idx + 1) % mi->n_rates;
 461
 462                         SAMPLE_TBL(mi, new_idx, col) = i;
 463                 }
 464         }
 465 }
 466
 467 static void
 468 minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
 469                    struct cfg80211_chan_def *chandef,
 470                    struct ieee80211_sta *sta, void *priv_sta)
 471 {
 472         struct minstrel_sta_info *mi = priv_sta;
 473         struct minstrel_priv *mp = priv;
 474         struct ieee80211_rate *ctl_rate;
 475         unsigned int i, n = 0;
 476         unsigned int t_slot = 9; /* FIXME: get real slot time */
 477         u32 rate_flags;
 478
 479         mi->sta = sta;
 480         mi->lowest_rix = rate_lowest_index(sband, sta);
 481         ctl_rate = &sband->bitrates[mi->lowest_rix];
 482         mi->sp_ack_dur = ieee80211_frame_duration(sband->band, 10,
 483                                 ctl_rate->bitrate,
 484                                 !!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1,
 485                                 ieee80211_chandef_get_shift(chandef));
 486
 487         rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
 488         memset(mi->max_tp_rate, 0, sizeof(mi->max_tp_rate));
 489         mi->max_prob_rate = 0;
 490
 491         for (i = 0; i < sband->n_bitrates; i++) {
 492                 struct minstrel_rate *mr = &mi->r[n];
 493                 struct minstrel_rate_stats *mrs = &mi->r[n].stats;
 494                 unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
 495                 unsigned int tx_time_single;
 496                 unsigned int cw = mp->cw_min;
 497                 int shift;
 498
 499                 if (!rate_supported(sta, sband->band, i))
 500                         continue;
 501                 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
 502                         continue;
 503
 504                 n++;
 505                 memset(mr, 0, sizeof(*mr));
 506                 memset(mrs, 0, sizeof(*mrs));
 507
 508                 mr->rix = i;
 509                 shift = ieee80211_chandef_get_shift(chandef);
 510                 mr->bitrate = DIV_ROUND_UP(sband->bitrates[i].bitrate,
 511                                            (1 << shift) * 5);
 512                 calc_rate_durations(sband->band, mr, &sband->bitrates[i],
 513                                     chandef);
 514
 515                 /* calculate maximum number of retransmissions before
 516                  * fallback (based on maximum segment size) */
 517                 mr->sample_limit = -1;
 518                 mrs->retry_count = 1;
 519                 mr->retry_count_cts = 1;
 520                 mrs->retry_count_rtscts = 1;
 521                 tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
 522                 do {
 523                         /* add one retransmission */
 524                         tx_time_single = mr->ack_time + mr->perfect_tx_time;
 525
 526                         /* contention window */
 527                         tx_time_single += (t_slot * cw) >> 1;
 528                         cw = min((cw << 1) | 1, mp->cw_max);
 529
 530                         tx_time += tx_time_single;
 531                         tx_time_cts += tx_time_single + mi->sp_ack_dur;
 532                         tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
 533                         if ((tx_time_cts < mp->segment_size) &&
 534                                 (mr->retry_count_cts < mp->max_retry))
 535                                 mr->retry_count_cts++;
 536                         if ((tx_time_rtscts < mp->segment_size) &&
 537                                 (mrs->retry_count_rtscts < mp->max_retry))
 538                                 mrs->retry_count_rtscts++;
 539                 } while ((tx_time < mp->segment_size) &&
 540                                 (++mr->stats.retry_count < mp->max_retry));
 541                 mr->adjusted_retry_count = mrs->retry_count;
 542                 if (!(sband->bitrates[i].flags & IEEE80211_RATE_ERP_G))
 543                         mr->retry_count_cts = mrs->retry_count;
 544         }
 545
 546         for (i = n; i < sband->n_bitrates; i++) {
 547                 struct minstrel_rate *mr = &mi->r[i];
 548                 mr->rix = -1;
 549         }
 550
 551         mi->n_rates = n;
 552         mi->last_stats_update = jiffies;
 553
 554         init_sample_table(mi);
 555         minstrel_update_rates(mp, mi);
 556 }
 557
 558 static void *
 559 minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
 560 {
 561         struct ieee80211_supported_band *sband;
 562         struct minstrel_sta_info *mi;
 563         struct minstrel_priv *mp = priv;
 564         struct ieee80211_hw *hw = mp->hw;
 565         int max_rates = 0;
 566         int i;
 567
 568         mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
 569         if (!mi)
 570                 return NULL;
 571
 572         for (i = 0; i < NUM_NL80211_BANDS; i++) {
 573                 sband = hw->wiphy->bands[i];
 574                 if (sband && sband->n_bitrates > max_rates)
 575                         max_rates = sband->n_bitrates;
 576         }
 577
 578         mi->r = kcalloc(max_rates, sizeof(struct minstrel_rate), gfp);
 579         if (!mi->r)
 580                 goto error;
 581
 582         mi->sample_table = kmalloc_array(max_rates, SAMPLE_COLUMNS, gfp);
 583         if (!mi->sample_table)
 584                 goto error1;
 585
 586         mi->last_stats_update = jiffies;
 587         return mi;
 588
 589 error1:
 590         kfree(mi->r);
 591 error:
 592         kfree(mi);
 593         return NULL;
 594 }
 595
 596 static void
 597 minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
 598 {
 599         struct minstrel_sta_info *mi = priv_sta;
 600
 601         kfree(mi->sample_table);
 602         kfree(mi->r);
 603         kfree(mi);
 604 }
 605
 606 static void
 607 minstrel_init_cck_rates(struct minstrel_priv *mp)
 608 {
 609         static const int bitrates[4] = { 10, 20, 55, 110 };
 610         struct ieee80211_supported_band *sband;
 611         u32 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
 612         int i, j;
 613
 614         sband = mp->hw->wiphy->bands[NL80211_BAND_2GHZ];
 615         if (!sband)
 616                 return;
 617
 618         for (i = 0, j = 0; i < sband->n_bitrates; i++) {
 619                 struct ieee80211_rate *rate = &sband->bitrates[i];
 620
 621                 if (rate->flags & IEEE80211_RATE_ERP_G)
 622                         continue;
 623
 624                 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
 625                         continue;
 626
 627                 for (j = 0; j < ARRAY_SIZE(bitrates); j++) {
 628                         if (rate->bitrate != bitrates[j])
 629                                 continue;
 630
 631                         mp->cck_rates[j] = i;
 632                         break;
 633                 }
 634         }
 635 }
 636
 637 static void *
 638 minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
 639 {
 640         struct minstrel_priv *mp;
 641
 642         mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
 643         if (!mp)
 644                 return NULL;
 645
 646         /* contention window settings
 647          * Just an approximation. Using the per-queue values would complicate
 648          * the calculations and is probably unnecessary */
 649         mp->cw_min = 15;
 650         mp->cw_max = 1023;
 651
 652         /* number of packets (in %) to use for sampling other rates
 653          * sample less often for non-mrr packets, because the overhead
 654          * is much higher than with mrr */
 655         mp->lookaround_rate = 5;
 656         mp->lookaround_rate_mrr = 10;
 657
 658         /* maximum time that the hw is allowed to stay in one MRR segment */
 659         mp->segment_size = 6000;
 660
 661         if (hw->max_rate_tries > 0)
 662                 mp->max_retry = hw->max_rate_tries;
 663         else
 664                 /* safe default, does not necessarily have to match hw properties */
 665                 mp->max_retry = 7;
 666
 667         if (hw->max_rates >= 4)
 668                 mp->has_mrr = true;
 669
 670         mp->hw = hw;
 671         mp->update_interval = 100;
 672
 673 #ifdef CONFIG_MAC80211_DEBUGFS
 674         mp->fixed_rate_idx = (u32) -1;
 675         mp->dbg_fixed_rate = debugfs_create_u32("fixed_rate_idx",
 676                         0666, debugfsdir, &mp->fixed_rate_idx);
 677 #endif
 678
 679         minstrel_init_cck_rates(mp);
 680
 681         return mp;
 682 }
 683
 684 static void
 685 minstrel_free(void *priv)
 686 {
 687 #ifdef CONFIG_MAC80211_DEBUGFS
 688         debugfs_remove(((struct minstrel_priv *)priv)->dbg_fixed_rate);
 689 #endif
 690         kfree(priv);
 691 }
 692
 693 static u32 minstrel_get_expected_throughput(void *priv_sta)
 694 {
 695         struct minstrel_sta_info *mi = priv_sta;
 696         struct minstrel_rate_stats *tmp_mrs;
 697         int idx = mi->max_tp_rate[0];
 698         int tmp_cur_tp;
 699
 700         /* convert pkt per sec in kbps (1200 is the average pkt size used for
 701          * computing cur_tp
 702          */
 703         tmp_mrs = &mi->r[idx].stats;
 704         tmp_cur_tp = minstrel_get_tp_avg(&mi->r[idx], tmp_mrs->prob_ewma) * 10;
 705         tmp_cur_tp = tmp_cur_tp * 1200 * 8 / 1024;
 706
 707         return tmp_cur_tp;
 708 }
 709
 710 const struct rate_control_ops mac80211_minstrel = {
 711         .name = "minstrel",
 712         .tx_status_ext = minstrel_tx_status,
 713         .get_rate = minstrel_get_rate,
 714         .rate_init = minstrel_rate_init,
 715         .alloc = minstrel_alloc,
 716         .free = minstrel_free,
 717         .alloc_sta = minstrel_alloc_sta,
 718         .free_sta = minstrel_free_sta,
 719 #ifdef CONFIG_MAC80211_DEBUGFS
 720         .add_sta_debugfs = minstrel_add_sta_debugfs,
 721         .remove_sta_debugfs = minstrel_remove_sta_debugfs,
 722 #endif
 723         .get_expected_throughput = minstrel_get_expected_throughput,
 724 };
 725
 726 int __init
 727 rc80211_minstrel_init(void)
 728 {
 729         return ieee80211_rate_control_register(&mac80211_minstrel);
 730 }
 731
 732 void
 733 rc80211_minstrel_exit(void)
 734 {
 735         ieee80211_rate_control_unregister(&mac80211_minstrel);
 736 }