2 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
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.
9 * Copyright (C) 2005-2007 Derek Smithies <derek@indranet.co.nz>
10 * Sponsored by Indranet Technologies Ltd
13 * Copyright (c) 2005 John Bicket
14 * All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
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.
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.
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.
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>
56 #include "rc80211_minstrel.h"
58 #define SAMPLE_TBL(_mi, _idx, _col) \
59 _mi->sample_table[(_idx * SAMPLE_COLUMNS) + _col]
61 /* convert mac80211 rate index to local array index */
63 rix_to_ndx(struct minstrel_sta_info *mi, int rix)
66 for (i = rix; i >= 0; i--)
67 if (mi->r[i].rix == rix)
72 /* find & sort topmost throughput rates */
74 minstrel_sort_best_tp_rates(struct minstrel_sta_info *mi, int i, u8 *tp_list)
76 int j = MAX_THR_RATES;
78 while (j > 0 && mi->r[i].stats.cur_tp > mi->r[tp_list[j - 1]].stats.cur_tp)
80 if (j < MAX_THR_RATES - 1)
81 memmove(&tp_list[j + 1], &tp_list[j], MAX_THR_RATES - (j + 1));
82 if (j < MAX_THR_RATES)
87 minstrel_set_rate(struct minstrel_sta_info *mi, struct ieee80211_sta_rates *ratetbl,
90 struct minstrel_rate *r = &mi->r[idx];
92 ratetbl->rate[offset].idx = r->rix;
93 ratetbl->rate[offset].count = r->adjusted_retry_count;
94 ratetbl->rate[offset].count_cts = r->retry_count_cts;
95 ratetbl->rate[offset].count_rts = r->stats.retry_count_rtscts;
99 minstrel_update_rates(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
101 struct ieee80211_sta_rates *ratetbl;
104 ratetbl = kzalloc(sizeof(*ratetbl), GFP_ATOMIC);
108 /* Start with max_tp_rate */
109 minstrel_set_rate(mi, ratetbl, i++, mi->max_tp_rate[0]);
111 if (mp->hw->max_rates >= 3) {
112 /* At least 3 tx rates supported, use max_tp_rate2 next */
113 minstrel_set_rate(mi, ratetbl, i++, mi->max_tp_rate[1]);
116 if (mp->hw->max_rates >= 2) {
117 /* At least 2 tx rates supported, use max_prob_rate next */
118 minstrel_set_rate(mi, ratetbl, i++, mi->max_prob_rate);
121 /* Use lowest rate last */
122 ratetbl->rate[i].idx = mi->lowest_rix;
123 ratetbl->rate[i].count = mp->max_retry;
124 ratetbl->rate[i].count_cts = mp->max_retry;
125 ratetbl->rate[i].count_rts = mp->max_retry;
127 rate_control_set_rates(mp->hw, mi->sta, ratetbl);
131 minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
133 u8 tmp_tp_rate[MAX_THR_RATES];
134 u8 tmp_prob_rate = 0;
138 for (i = 0; i < MAX_THR_RATES; i++)
141 for (i = 0; i < mi->n_rates; i++) {
142 struct minstrel_rate *mr = &mi->r[i];
143 struct minstrel_rate_stats *mrs = &mi->r[i].stats;
145 usecs = mr->perfect_tx_time;
149 if (unlikely(mrs->attempts > 0)) {
150 mrs->sample_skipped = 0;
151 mrs->cur_prob = MINSTREL_FRAC(mrs->success,
153 mrs->succ_hist += mrs->success;
154 mrs->att_hist += mrs->attempts;
155 mrs->probability = minstrel_ewma(mrs->probability,
159 mrs->sample_skipped++;
161 mrs->last_success = mrs->success;
162 mrs->last_attempts = mrs->attempts;
166 /* Update throughput per rate, reset thr. below 10% success */
167 if (mrs->probability < MINSTREL_FRAC(10, 100))
170 mrs->cur_tp = mrs->probability * (1000000 / usecs);
172 /* Sample less often below the 10% chance of success.
173 * Sample less often above the 95% chance of success. */
174 if (mrs->probability > MINSTREL_FRAC(95, 100) ||
175 mrs->probability < MINSTREL_FRAC(10, 100)) {
176 mr->adjusted_retry_count = mrs->retry_count >> 1;
177 if (mr->adjusted_retry_count > 2)
178 mr->adjusted_retry_count = 2;
179 mr->sample_limit = 4;
181 mr->sample_limit = -1;
182 mr->adjusted_retry_count = mrs->retry_count;
184 if (!mr->adjusted_retry_count)
185 mr->adjusted_retry_count = 2;
187 minstrel_sort_best_tp_rates(mi, i, tmp_tp_rate);
189 /* To determine the most robust rate (max_prob_rate) used at
190 * 3rd mmr stage we distinct between two cases:
191 * (1) if any success probabilitiy >= 95%, out of those rates
192 * choose the maximum throughput rate as max_prob_rate
193 * (2) if all success probabilities < 95%, the rate with
194 * highest success probability is chosen as max_prob_rate */
195 if (mrs->probability >= MINSTREL_FRAC(95, 100)) {
196 if (mrs->cur_tp >= mi->r[tmp_prob_rate].stats.cur_tp)
199 if (mrs->probability >= mi->r[tmp_prob_rate].stats.probability)
204 /* Assign the new rate set */
205 memcpy(mi->max_tp_rate, tmp_tp_rate, sizeof(mi->max_tp_rate));
206 mi->max_prob_rate = tmp_prob_rate;
208 #ifdef CONFIG_MAC80211_DEBUGFS
209 /* use fixed index if set */
210 if (mp->fixed_rate_idx != -1) {
211 mi->max_tp_rate[0] = mp->fixed_rate_idx;
212 mi->max_tp_rate[1] = mp->fixed_rate_idx;
213 mi->max_prob_rate = mp->fixed_rate_idx;
217 /* Reset update timer */
218 mi->stats_update = jiffies;
220 minstrel_update_rates(mp, mi);
224 minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
225 struct ieee80211_sta *sta, void *priv_sta,
226 struct ieee80211_tx_info *info)
228 struct minstrel_priv *mp = priv;
229 struct minstrel_sta_info *mi = priv_sta;
230 struct ieee80211_tx_rate *ar = info->status.rates;
234 success = !!(info->flags & IEEE80211_TX_STAT_ACK);
236 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
240 ndx = rix_to_ndx(mi, ar[i].idx);
244 mi->r[ndx].stats.attempts += ar[i].count;
246 if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
247 mi->r[ndx].stats.success += success;
250 if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
251 mi->sample_packets++;
253 if (mi->sample_deferred > 0)
254 mi->sample_deferred--;
256 if (time_after(jiffies, mi->stats_update +
257 (mp->update_interval * HZ) / 1000))
258 minstrel_update_stats(mp, mi);
262 static inline unsigned int
263 minstrel_get_retry_count(struct minstrel_rate *mr,
264 struct ieee80211_tx_info *info)
266 u8 retry = mr->adjusted_retry_count;
268 if (info->control.use_rts)
269 retry = max_t(u8, 2, min(mr->stats.retry_count_rtscts, retry));
270 else if (info->control.use_cts_prot)
271 retry = max_t(u8, 2, min(mr->retry_count_cts, retry));
277 minstrel_get_next_sample(struct minstrel_sta_info *mi)
279 unsigned int sample_ndx;
280 sample_ndx = SAMPLE_TBL(mi, mi->sample_row, mi->sample_column);
282 if ((int) mi->sample_row >= mi->n_rates) {
285 if (mi->sample_column >= SAMPLE_COLUMNS)
286 mi->sample_column = 0;
292 minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
293 void *priv_sta, struct ieee80211_tx_rate_control *txrc)
295 struct sk_buff *skb = txrc->skb;
296 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
297 struct minstrel_sta_info *mi = priv_sta;
298 struct minstrel_priv *mp = priv;
299 struct ieee80211_tx_rate *rate = &info->control.rates[0];
300 struct minstrel_rate *msr, *mr;
307 /* management/no-ack frames do not use rate control */
308 if (rate_control_send_low(sta, priv_sta, txrc))
311 /* check multi-rate-retry capabilities & adjust lookaround_rate */
312 mrr_capable = mp->has_mrr &&
314 !txrc->bss_conf->use_cts_prot;
316 sampling_ratio = mp->lookaround_rate_mrr;
318 sampling_ratio = mp->lookaround_rate;
320 /* increase sum packet counter */
323 #ifdef CONFIG_MAC80211_DEBUGFS
324 if (mp->fixed_rate_idx != -1)
328 delta = (mi->total_packets * sampling_ratio / 100) -
329 (mi->sample_packets + mi->sample_deferred / 2);
331 /* delta < 0: no sampling required */
332 prev_sample = mi->prev_sample;
333 mi->prev_sample = false;
334 if (delta < 0 || (!mrr_capable && prev_sample))
337 if (mi->total_packets >= 10000) {
338 mi->sample_deferred = 0;
339 mi->sample_packets = 0;
340 mi->total_packets = 0;
341 } else if (delta > mi->n_rates * 2) {
342 /* With multi-rate retry, not every planned sample
343 * attempt actually gets used, due to the way the retry
344 * chain is set up - [max_tp,sample,prob,lowest] for
345 * sample_rate < max_tp.
347 * If there's too much sampling backlog and the link
348 * starts getting worse, minstrel would start bursting
349 * out lots of sampling frames, which would result
350 * in a large throughput loss. */
351 mi->sample_packets += (delta - mi->n_rates * 2);
354 /* get next random rate sample */
355 ndx = minstrel_get_next_sample(mi);
357 mr = &mi->r[mi->max_tp_rate[0]];
359 /* Decide if direct ( 1st mrr stage) or indirect (2nd mrr stage)
360 * rate sampling method should be used.
361 * Respect such rates that are not sampled for 20 interations.
364 msr->perfect_tx_time > mr->perfect_tx_time &&
365 msr->stats.sample_skipped < 20) {
366 /* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
367 * packets that have the sampling rate deferred to the
368 * second MRR stage. Increase the sample counter only
369 * if the deferred sample rate was actually used.
370 * Use the sample_deferred counter to make sure that
371 * the sampling is not done in large bursts */
372 info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
374 mi->sample_deferred++;
376 if (!msr->sample_limit != 0)
379 mi->sample_packets++;
380 if (msr->sample_limit > 0)
384 /* If we're not using MRR and the sampling rate already
385 * has a probability of >95%, we shouldn't be attempting
386 * to use it, as this only wastes precious airtime */
388 (mi->r[ndx].stats.probability > MINSTREL_FRAC(95, 100)))
391 mi->prev_sample = true;
393 rate->idx = mi->r[ndx].rix;
394 rate->count = minstrel_get_retry_count(&mi->r[ndx], info);
399 calc_rate_durations(enum ieee80211_band band,
400 struct minstrel_rate *d,
401 struct ieee80211_rate *rate,
402 struct cfg80211_chan_def *chandef)
404 int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
405 int shift = ieee80211_chandef_get_shift(chandef);
407 d->perfect_tx_time = ieee80211_frame_duration(band, 1200,
408 DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
410 d->ack_time = ieee80211_frame_duration(band, 10,
411 DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
416 init_sample_table(struct minstrel_sta_info *mi)
418 unsigned int i, col, new_idx;
421 mi->sample_column = 0;
423 memset(mi->sample_table, 0xff, SAMPLE_COLUMNS * mi->n_rates);
425 for (col = 0; col < SAMPLE_COLUMNS; col++) {
426 prandom_bytes(rnd, sizeof(rnd));
427 for (i = 0; i < mi->n_rates; i++) {
428 new_idx = (i + rnd[i & 7]) % mi->n_rates;
429 while (SAMPLE_TBL(mi, new_idx, col) != 0xff)
430 new_idx = (new_idx + 1) % mi->n_rates;
432 SAMPLE_TBL(mi, new_idx, col) = i;
438 minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
439 struct cfg80211_chan_def *chandef,
440 struct ieee80211_sta *sta, void *priv_sta)
442 struct minstrel_sta_info *mi = priv_sta;
443 struct minstrel_priv *mp = priv;
444 struct ieee80211_rate *ctl_rate;
445 unsigned int i, n = 0;
446 unsigned int t_slot = 9; /* FIXME: get real slot time */
450 mi->lowest_rix = rate_lowest_index(sband, sta);
451 ctl_rate = &sband->bitrates[mi->lowest_rix];
452 mi->sp_ack_dur = ieee80211_frame_duration(sband->band, 10,
454 !!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1,
455 ieee80211_chandef_get_shift(chandef));
457 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
458 memset(mi->max_tp_rate, 0, sizeof(mi->max_tp_rate));
459 mi->max_prob_rate = 0;
461 for (i = 0; i < sband->n_bitrates; i++) {
462 struct minstrel_rate *mr = &mi->r[n];
463 struct minstrel_rate_stats *mrs = &mi->r[n].stats;
464 unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
465 unsigned int tx_time_single;
466 unsigned int cw = mp->cw_min;
469 if (!rate_supported(sta, sband->band, i))
471 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
475 memset(mr, 0, sizeof(*mr));
476 memset(mrs, 0, sizeof(*mrs));
479 shift = ieee80211_chandef_get_shift(chandef);
480 mr->bitrate = DIV_ROUND_UP(sband->bitrates[i].bitrate,
482 calc_rate_durations(sband->band, mr, &sband->bitrates[i],
485 /* calculate maximum number of retransmissions before
486 * fallback (based on maximum segment size) */
487 mr->sample_limit = -1;
488 mrs->retry_count = 1;
489 mr->retry_count_cts = 1;
490 mrs->retry_count_rtscts = 1;
491 tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
493 /* add one retransmission */
494 tx_time_single = mr->ack_time + mr->perfect_tx_time;
496 /* contention window */
497 tx_time_single += (t_slot * cw) >> 1;
498 cw = min((cw << 1) | 1, mp->cw_max);
500 tx_time += tx_time_single;
501 tx_time_cts += tx_time_single + mi->sp_ack_dur;
502 tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
503 if ((tx_time_cts < mp->segment_size) &&
504 (mr->retry_count_cts < mp->max_retry))
505 mr->retry_count_cts++;
506 if ((tx_time_rtscts < mp->segment_size) &&
507 (mrs->retry_count_rtscts < mp->max_retry))
508 mrs->retry_count_rtscts++;
509 } while ((tx_time < mp->segment_size) &&
510 (++mr->stats.retry_count < mp->max_retry));
511 mr->adjusted_retry_count = mrs->retry_count;
512 if (!(sband->bitrates[i].flags & IEEE80211_RATE_ERP_G))
513 mr->retry_count_cts = mrs->retry_count;
516 for (i = n; i < sband->n_bitrates; i++) {
517 struct minstrel_rate *mr = &mi->r[i];
522 mi->stats_update = jiffies;
524 init_sample_table(mi);
525 minstrel_update_rates(mp, mi);
529 minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
531 struct ieee80211_supported_band *sband;
532 struct minstrel_sta_info *mi;
533 struct minstrel_priv *mp = priv;
534 struct ieee80211_hw *hw = mp->hw;
538 mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
542 for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
543 sband = hw->wiphy->bands[i];
544 if (sband && sband->n_bitrates > max_rates)
545 max_rates = sband->n_bitrates;
548 mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
552 mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
553 if (!mi->sample_table)
556 mi->stats_update = jiffies;
567 minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
569 struct minstrel_sta_info *mi = priv_sta;
571 kfree(mi->sample_table);
577 minstrel_init_cck_rates(struct minstrel_priv *mp)
579 static const int bitrates[4] = { 10, 20, 55, 110 };
580 struct ieee80211_supported_band *sband;
581 u32 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
584 sband = mp->hw->wiphy->bands[IEEE80211_BAND_2GHZ];
588 for (i = 0, j = 0; i < sband->n_bitrates; i++) {
589 struct ieee80211_rate *rate = &sband->bitrates[i];
591 if (rate->flags & IEEE80211_RATE_ERP_G)
594 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
597 for (j = 0; j < ARRAY_SIZE(bitrates); j++) {
598 if (rate->bitrate != bitrates[j])
601 mp->cck_rates[j] = i;
608 minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
610 struct minstrel_priv *mp;
612 mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
616 /* contention window settings
617 * Just an approximation. Using the per-queue values would complicate
618 * the calculations and is probably unnecessary */
622 /* number of packets (in %) to use for sampling other rates
623 * sample less often for non-mrr packets, because the overhead
624 * is much higher than with mrr */
625 mp->lookaround_rate = 5;
626 mp->lookaround_rate_mrr = 10;
628 /* maximum time that the hw is allowed to stay in one MRR segment */
629 mp->segment_size = 6000;
631 if (hw->max_rate_tries > 0)
632 mp->max_retry = hw->max_rate_tries;
634 /* safe default, does not necessarily have to match hw properties */
637 if (hw->max_rates >= 4)
641 mp->update_interval = 100;
643 #ifdef CONFIG_MAC80211_DEBUGFS
644 mp->fixed_rate_idx = (u32) -1;
645 mp->dbg_fixed_rate = debugfs_create_u32("fixed_rate_idx",
646 S_IRUGO | S_IWUGO, debugfsdir, &mp->fixed_rate_idx);
649 minstrel_init_cck_rates(mp);
655 minstrel_free(void *priv)
657 #ifdef CONFIG_MAC80211_DEBUGFS
658 debugfs_remove(((struct minstrel_priv *)priv)->dbg_fixed_rate);
663 static u32 minstrel_get_expected_throughput(void *priv_sta)
665 struct minstrel_sta_info *mi = priv_sta;
666 int idx = mi->max_tp_rate[0];
668 /* convert pkt per sec in kbps (1200 is the average pkt size used for
671 return MINSTREL_TRUNC(mi->r[idx].stats.cur_tp) * 1200 * 8 / 1024;
674 const struct rate_control_ops mac80211_minstrel = {
676 .tx_status_noskb = minstrel_tx_status,
677 .get_rate = minstrel_get_rate,
678 .rate_init = minstrel_rate_init,
679 .alloc = minstrel_alloc,
680 .free = minstrel_free,
681 .alloc_sta = minstrel_alloc_sta,
682 .free_sta = minstrel_free_sta,
683 #ifdef CONFIG_MAC80211_DEBUGFS
684 .add_sta_debugfs = minstrel_add_sta_debugfs,
685 .remove_sta_debugfs = minstrel_remove_sta_debugfs,
687 .get_expected_throughput = minstrel_get_expected_throughput,
691 rc80211_minstrel_init(void)
693 return ieee80211_rate_control_register(&mac80211_minstrel);
697 rc80211_minstrel_exit(void)
699 ieee80211_rate_control_unregister(&mac80211_minstrel);