blob: 61a857bca971fb888f2323f66052d991b658c4eb [file] [log] [blame]
Felix Fietkaucccf1292008-10-05 18:07:45 +02001/*
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090053#include <linux/slab.h>
Felix Fietkaucccf1292008-10-05 18:07:45 +020054#include <net/mac80211.h>
55#include "rate.h"
56#include "rc80211_minstrel.h"
57
Felix Fietkaucccf1292008-10-05 18:07:45 +020058#define SAMPLE_TBL(_mi, _idx, _col) \
59 _mi->sample_table[(_idx * SAMPLE_COLUMNS) + _col]
60
61/* convert mac80211 rate index to local array index */
62static inline int
63rix_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;
Felix Fietkaucccf1292008-10-05 18:07:45 +020069 return i;
70}
71
Thomas Huehn6a27b2c2015-03-24 21:09:40 +010072/* return current EMWA throughput */
73int minstrel_get_tp_avg(struct minstrel_rate *mr)
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 else
85 return MINSTREL_TRUNC(mr->stats.prob_ewma * (100000 / usecs));
86}
87
Thomas Huehn2ff2b692013-03-04 23:30:07 +010088/* find & sort topmost throughput rates */
89static inline void
90minstrel_sort_best_tp_rates(struct minstrel_sta_info *mi, int i, u8 *tp_list)
91{
92 int j = MAX_THR_RATES;
93
Thomas Huehn6a27b2c2015-03-24 21:09:40 +010094 while (j > 0 && (minstrel_get_tp_avg(&mi->r[i]) >
95 minstrel_get_tp_avg(&mi->r[tp_list[j - 1]])))
Thomas Huehn2ff2b692013-03-04 23:30:07 +010096 j--;
Thomas Huehn6a27b2c2015-03-24 21:09:40 +010097
Thomas Huehn2ff2b692013-03-04 23:30:07 +010098 if (j < MAX_THR_RATES - 1)
99 memmove(&tp_list[j + 1], &tp_list[j], MAX_THR_RATES - (j + 1));
100 if (j < MAX_THR_RATES)
101 tp_list[j] = i;
102}
103
Felix Fietkaucccf1292008-10-05 18:07:45 +0200104static void
Felix Fietkau06d961a2013-04-22 16:14:43 +0200105minstrel_set_rate(struct minstrel_sta_info *mi, struct ieee80211_sta_rates *ratetbl,
106 int offset, int idx)
107{
108 struct minstrel_rate *r = &mi->r[idx];
109
110 ratetbl->rate[offset].idx = r->rix;
111 ratetbl->rate[offset].count = r->adjusted_retry_count;
112 ratetbl->rate[offset].count_cts = r->retry_count_cts;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200113 ratetbl->rate[offset].count_rts = r->stats.retry_count_rtscts;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200114}
115
116static void
117minstrel_update_rates(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
118{
119 struct ieee80211_sta_rates *ratetbl;
120 int i = 0;
121
122 ratetbl = kzalloc(sizeof(*ratetbl), GFP_ATOMIC);
123 if (!ratetbl)
124 return;
125
126 /* Start with max_tp_rate */
127 minstrel_set_rate(mi, ratetbl, i++, mi->max_tp_rate[0]);
128
129 if (mp->hw->max_rates >= 3) {
130 /* At least 3 tx rates supported, use max_tp_rate2 next */
131 minstrel_set_rate(mi, ratetbl, i++, mi->max_tp_rate[1]);
132 }
133
134 if (mp->hw->max_rates >= 2) {
135 /* At least 2 tx rates supported, use max_prob_rate next */
136 minstrel_set_rate(mi, ratetbl, i++, mi->max_prob_rate);
137 }
138
139 /* Use lowest rate last */
140 ratetbl->rate[i].idx = mi->lowest_rix;
141 ratetbl->rate[i].count = mp->max_retry;
142 ratetbl->rate[i].count_cts = mp->max_retry;
143 ratetbl->rate[i].count_rts = mp->max_retry;
144
145 rate_control_set_rates(mp->hw, mi->sta, ratetbl);
146}
147
Thomas Huehnf62838b2015-03-24 21:09:38 +0100148/*
149* Recalculate success probabilities and counters for a given rate using EWMA
150*/
151void
152minstrel_calc_rate_stats(struct minstrel_rate_stats *mrs)
153{
154 if (unlikely(mrs->attempts > 0)) {
155 mrs->sample_skipped = 0;
156 mrs->cur_prob = MINSTREL_FRAC(mrs->success, mrs->attempts);
157 if (unlikely(!mrs->att_hist))
Thomas Huehn91340732015-03-24 21:09:39 +0100158 mrs->prob_ewma = mrs->cur_prob;
Thomas Huehnf62838b2015-03-24 21:09:38 +0100159 else
Thomas Huehn91340732015-03-24 21:09:39 +0100160 mrs->prob_ewma = minstrel_ewma(mrs->prob_ewma,
Thomas Huehnf62838b2015-03-24 21:09:38 +0100161 mrs->cur_prob, EWMA_LEVEL);
162 mrs->att_hist += mrs->attempts;
163 mrs->succ_hist += mrs->success;
164 } else {
165 mrs->sample_skipped++;
166 }
167
168 mrs->last_success = mrs->success;
169 mrs->last_attempts = mrs->attempts;
170 mrs->success = 0;
171 mrs->attempts = 0;
172}
173
Felix Fietkau06d961a2013-04-22 16:14:43 +0200174static void
Felix Fietkaucccf1292008-10-05 18:07:45 +0200175minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
176{
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100177 u8 tmp_tp_rate[MAX_THR_RATES];
178 u8 tmp_prob_rate = 0;
Thomas Huehn6a27b2c2015-03-24 21:09:40 +0100179 int i, tmp_cur_tp, tmp_prob_tp;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200180
Weilong Chenf359d3f2013-12-18 15:44:16 +0800181 for (i = 0; i < MAX_THR_RATES; i++)
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100182 tmp_tp_rate[i] = 0;
183
Felix Fietkaucccf1292008-10-05 18:07:45 +0200184 for (i = 0; i < mi->n_rates; i++) {
185 struct minstrel_rate *mr = &mi->r[i];
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200186 struct minstrel_rate_stats *mrs = &mi->r[i].stats;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200187
Thomas Huehnf62838b2015-03-24 21:09:38 +0100188 /* Update success probabilities per rate */
189 minstrel_calc_rate_stats(mrs);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200190
191 /* Sample less often below the 10% chance of success.
192 * Sample less often above the 95% chance of success. */
Thomas Huehn91340732015-03-24 21:09:39 +0100193 if (mrs->prob_ewma > MINSTREL_FRAC(95, 100) ||
194 mrs->prob_ewma < MINSTREL_FRAC(10, 100)) {
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200195 mr->adjusted_retry_count = mrs->retry_count >> 1;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200196 if (mr->adjusted_retry_count > 2)
197 mr->adjusted_retry_count = 2;
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200198 mr->sample_limit = 4;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200199 } else {
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200200 mr->sample_limit = -1;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200201 mr->adjusted_retry_count = mrs->retry_count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200202 }
203 if (!mr->adjusted_retry_count)
204 mr->adjusted_retry_count = 2;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200205
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100206 minstrel_sort_best_tp_rates(mi, i, tmp_tp_rate);
207
208 /* To determine the most robust rate (max_prob_rate) used at
209 * 3rd mmr stage we distinct between two cases:
210 * (1) if any success probabilitiy >= 95%, out of those rates
211 * choose the maximum throughput rate as max_prob_rate
212 * (2) if all success probabilities < 95%, the rate with
Stephen Hemmingerd070f912014-10-29 22:55:58 -0700213 * highest success probability is chosen as max_prob_rate */
Thomas Huehn91340732015-03-24 21:09:39 +0100214 if (mrs->prob_ewma >= MINSTREL_FRAC(95, 100)) {
Thomas Huehn6a27b2c2015-03-24 21:09:40 +0100215 tmp_cur_tp = minstrel_get_tp_avg(mr);
216 tmp_prob_tp = minstrel_get_tp_avg(&mi->r[tmp_prob_rate]);
217 if (tmp_cur_tp >= tmp_prob_tp)
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100218 tmp_prob_rate = i;
219 } else {
Thomas Huehn91340732015-03-24 21:09:39 +0100220 if (mrs->prob_ewma >= mi->r[tmp_prob_rate].stats.prob_ewma)
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100221 tmp_prob_rate = i;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200222 }
223 }
224
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100225 /* Assign the new rate set */
226 memcpy(mi->max_tp_rate, tmp_tp_rate, sizeof(mi->max_tp_rate));
227 mi->max_prob_rate = tmp_prob_rate;
Thomas Huehn8f157612013-03-04 23:30:03 +0100228
Lorenzo Bianconi45966ae2013-08-27 16:59:46 +0200229#ifdef CONFIG_MAC80211_DEBUGFS
230 /* use fixed index if set */
231 if (mp->fixed_rate_idx != -1) {
232 mi->max_tp_rate[0] = mp->fixed_rate_idx;
233 mi->max_tp_rate[1] = mp->fixed_rate_idx;
234 mi->max_prob_rate = mp->fixed_rate_idx;
235 }
236#endif
237
Thomas Huehn8f157612013-03-04 23:30:03 +0100238 /* Reset update timer */
Thomas Huehn91340732015-03-24 21:09:39 +0100239 mi->last_stats_update = jiffies;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200240
241 minstrel_update_rates(mp, mi);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200242}
243
244static void
245minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
Weilong Chenf359d3f2013-12-18 15:44:16 +0800246 struct ieee80211_sta *sta, void *priv_sta,
Felix Fietkaufb7acfb2014-11-19 20:08:09 +0100247 struct ieee80211_tx_info *info)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200248{
Johannes Berg8acbcdd2012-11-15 18:27:56 +0100249 struct minstrel_priv *mp = priv;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200250 struct minstrel_sta_info *mi = priv_sta;
Johannes Berge6a98542008-10-21 12:40:02 +0200251 struct ieee80211_tx_rate *ar = info->status.rates;
252 int i, ndx;
253 int success;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200254
Johannes Berge6a98542008-10-21 12:40:02 +0200255 success = !!(info->flags & IEEE80211_TX_STAT_ACK);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200256
Johannes Berge6a98542008-10-21 12:40:02 +0200257 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
258 if (ar[i].idx < 0)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200259 break;
260
Johannes Berge6a98542008-10-21 12:40:02 +0200261 ndx = rix_to_ndx(mi, ar[i].idx);
Luciano Coelho3938b452009-07-03 08:25:08 +0300262 if (ndx < 0)
263 continue;
264
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200265 mi->r[ndx].stats.attempts += ar[i].count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200266
Javier Cardonabfc32e62009-08-17 17:15:55 -0700267 if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200268 mi->r[ndx].stats.success += success;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200269 }
270
271 if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200272 mi->sample_packets++;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200273
274 if (mi->sample_deferred > 0)
275 mi->sample_deferred--;
Johannes Berg8acbcdd2012-11-15 18:27:56 +0100276
Thomas Huehn91340732015-03-24 21:09:39 +0100277 if (time_after(jiffies, mi->last_stats_update +
Johannes Berg8acbcdd2012-11-15 18:27:56 +0100278 (mp->update_interval * HZ) / 1000))
279 minstrel_update_stats(mp, mi);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200280}
281
282
283static inline unsigned int
284minstrel_get_retry_count(struct minstrel_rate *mr,
Weilong Chenf359d3f2013-12-18 15:44:16 +0800285 struct ieee80211_tx_info *info)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200286{
Felix Fietkau8d819a92014-12-17 13:38:34 +0100287 u8 retry = mr->adjusted_retry_count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200288
Felix Fietkau991fec02013-04-16 13:38:43 +0200289 if (info->control.use_rts)
Felix Fietkau8d819a92014-12-17 13:38:34 +0100290 retry = max_t(u8, 2, min(mr->stats.retry_count_rtscts, retry));
Felix Fietkau991fec02013-04-16 13:38:43 +0200291 else if (info->control.use_cts_prot)
Felix Fietkau8d819a92014-12-17 13:38:34 +0100292 retry = max_t(u8, 2, min(mr->retry_count_cts, retry));
Felix Fietkaucccf1292008-10-05 18:07:45 +0200293 return retry;
294}
295
296
297static int
298minstrel_get_next_sample(struct minstrel_sta_info *mi)
299{
300 unsigned int sample_ndx;
Thomas Huehn8f157612013-03-04 23:30:03 +0100301 sample_ndx = SAMPLE_TBL(mi, mi->sample_row, mi->sample_column);
302 mi->sample_row++;
Thomas Huehnf744bf82013-03-04 23:30:05 +0100303 if ((int) mi->sample_row >= mi->n_rates) {
Thomas Huehn8f157612013-03-04 23:30:03 +0100304 mi->sample_row = 0;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200305 mi->sample_column++;
306 if (mi->sample_column >= SAMPLE_COLUMNS)
307 mi->sample_column = 0;
308 }
309 return sample_ndx;
310}
311
Johannes Berg2df78162008-10-28 16:49:41 +0100312static void
Johannes Berge6a98542008-10-21 12:40:02 +0200313minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
314 void *priv_sta, struct ieee80211_tx_rate_control *txrc)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200315{
Johannes Berge6a98542008-10-21 12:40:02 +0200316 struct sk_buff *skb = txrc->skb;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200317 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
318 struct minstrel_sta_info *mi = priv_sta;
319 struct minstrel_priv *mp = priv;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200320 struct ieee80211_tx_rate *rate = &info->control.rates[0];
321 struct minstrel_rate *msr, *mr;
322 unsigned int ndx;
Thomas Huehn8f157612013-03-04 23:30:03 +0100323 bool mrr_capable;
Felix Fietkau5c9fc932013-07-15 14:35:06 +0200324 bool prev_sample;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200325 int delta;
Thomas Huehn8f157612013-03-04 23:30:03 +0100326 int sampling_ratio;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200327
Thomas Huehn8f157612013-03-04 23:30:03 +0100328 /* management/no-ack frames do not use rate control */
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -0700329 if (rate_control_send_low(sta, priv_sta, txrc))
Felix Fietkaucccf1292008-10-05 18:07:45 +0200330 return;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200331
Thomas Huehn8f157612013-03-04 23:30:03 +0100332 /* check multi-rate-retry capabilities & adjust lookaround_rate */
333 mrr_capable = mp->has_mrr &&
334 !txrc->rts &&
335 !txrc->bss_conf->use_cts_prot;
336 if (mrr_capable)
337 sampling_ratio = mp->lookaround_rate_mrr;
338 else
339 sampling_ratio = mp->lookaround_rate;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200340
Thomas Huehn8f157612013-03-04 23:30:03 +0100341 /* increase sum packet counter */
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200342 mi->total_packets++;
Thomas Huehn8f157612013-03-04 23:30:03 +0100343
Lorenzo Bianconi45966ae2013-08-27 16:59:46 +0200344#ifdef CONFIG_MAC80211_DEBUGFS
345 if (mp->fixed_rate_idx != -1)
346 return;
347#endif
348
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200349 delta = (mi->total_packets * sampling_ratio / 100) -
350 (mi->sample_packets + mi->sample_deferred / 2);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200351
Felix Fietkau06d961a2013-04-22 16:14:43 +0200352 /* delta < 0: no sampling required */
Felix Fietkau5c9fc932013-07-15 14:35:06 +0200353 prev_sample = mi->prev_sample;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200354 mi->prev_sample = false;
355 if (delta < 0 || (!mrr_capable && prev_sample))
356 return;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200357
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200358 if (mi->total_packets >= 10000) {
Felix Fietkau06d961a2013-04-22 16:14:43 +0200359 mi->sample_deferred = 0;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200360 mi->sample_packets = 0;
361 mi->total_packets = 0;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200362 } else if (delta > mi->n_rates * 2) {
363 /* With multi-rate retry, not every planned sample
364 * attempt actually gets used, due to the way the retry
365 * chain is set up - [max_tp,sample,prob,lowest] for
366 * sample_rate < max_tp.
367 *
368 * If there's too much sampling backlog and the link
369 * starts getting worse, minstrel would start bursting
370 * out lots of sampling frames, which would result
371 * in a large throughput loss. */
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200372 mi->sample_packets += (delta - mi->n_rates * 2);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200373 }
Felix Fietkau06d961a2013-04-22 16:14:43 +0200374
375 /* get next random rate sample */
376 ndx = minstrel_get_next_sample(mi);
377 msr = &mi->r[ndx];
378 mr = &mi->r[mi->max_tp_rate[0]];
379
380 /* Decide if direct ( 1st mrr stage) or indirect (2nd mrr stage)
381 * rate sampling method should be used.
382 * Respect such rates that are not sampled for 20 interations.
383 */
384 if (mrr_capable &&
385 msr->perfect_tx_time > mr->perfect_tx_time &&
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200386 msr->stats.sample_skipped < 20) {
Felix Fietkau06d961a2013-04-22 16:14:43 +0200387 /* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
388 * packets that have the sampling rate deferred to the
389 * second MRR stage. Increase the sample counter only
390 * if the deferred sample rate was actually used.
391 * Use the sample_deferred counter to make sure that
392 * the sampling is not done in large bursts */
393 info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
394 rate++;
395 mi->sample_deferred++;
396 } else {
Jiri Slaby17dce152015-02-19 12:57:40 +0100397 if (!msr->sample_limit)
Felix Fietkau06d961a2013-04-22 16:14:43 +0200398 return;
399
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200400 mi->sample_packets++;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200401 if (msr->sample_limit > 0)
402 msr->sample_limit--;
403 }
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200404
405 /* If we're not using MRR and the sampling rate already
406 * has a probability of >95%, we shouldn't be attempting
407 * to use it, as this only wastes precious airtime */
Felix Fietkau06d961a2013-04-22 16:14:43 +0200408 if (!mrr_capable &&
Thomas Huehn91340732015-03-24 21:09:39 +0100409 (mi->r[ndx].stats.prob_ewma > MINSTREL_FRAC(95, 100)))
Felix Fietkaucccf1292008-10-05 18:07:45 +0200410 return;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200411
Felix Fietkau06d961a2013-04-22 16:14:43 +0200412 mi->prev_sample = true;
Thomas Huehn8f157612013-03-04 23:30:03 +0100413
Felix Fietkau06d961a2013-04-22 16:14:43 +0200414 rate->idx = mi->r[ndx].rix;
415 rate->count = minstrel_get_retry_count(&mi->r[ndx], info);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200416}
417
418
419static void
Michal Kazior4ee73f32012-04-11 08:47:56 +0200420calc_rate_durations(enum ieee80211_band band,
421 struct minstrel_rate *d,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200422 struct ieee80211_rate *rate,
423 struct cfg80211_chan_def *chandef)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200424{
425 int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200426 int shift = ieee80211_chandef_get_shift(chandef);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200427
Michal Kazior4ee73f32012-04-11 08:47:56 +0200428 d->perfect_tx_time = ieee80211_frame_duration(band, 1200,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200429 DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
430 shift);
Michal Kazior4ee73f32012-04-11 08:47:56 +0200431 d->ack_time = ieee80211_frame_duration(band, 10,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200432 DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
433 shift);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200434}
435
436static void
437init_sample_table(struct minstrel_sta_info *mi)
438{
439 unsigned int i, col, new_idx;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200440 u8 rnd[8];
441
442 mi->sample_column = 0;
Thomas Huehn8f157612013-03-04 23:30:03 +0100443 mi->sample_row = 0;
Thomas Huehnf744bf82013-03-04 23:30:05 +0100444 memset(mi->sample_table, 0xff, SAMPLE_COLUMNS * mi->n_rates);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200445
446 for (col = 0; col < SAMPLE_COLUMNS; col++) {
Karl Beldanf7d8ad82013-11-13 10:54:19 +0100447 prandom_bytes(rnd, sizeof(rnd));
Thomas Huehnf744bf82013-03-04 23:30:05 +0100448 for (i = 0; i < mi->n_rates; i++) {
Thomas Huehnf744bf82013-03-04 23:30:05 +0100449 new_idx = (i + rnd[i & 7]) % mi->n_rates;
Thomas Huehnf744bf82013-03-04 23:30:05 +0100450 while (SAMPLE_TBL(mi, new_idx, col) != 0xff)
451 new_idx = (new_idx + 1) % mi->n_rates;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200452
Thomas Huehnf744bf82013-03-04 23:30:05 +0100453 SAMPLE_TBL(mi, new_idx, col) = i;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200454 }
455 }
456}
457
458static void
459minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +0200460 struct cfg80211_chan_def *chandef,
461 struct ieee80211_sta *sta, void *priv_sta)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200462{
463 struct minstrel_sta_info *mi = priv_sta;
464 struct minstrel_priv *mp = priv;
Christian Lamparterd57854b2008-12-22 15:35:31 +0100465 struct ieee80211_rate *ctl_rate;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200466 unsigned int i, n = 0;
467 unsigned int t_slot = 9; /* FIXME: get real slot time */
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200468 u32 rate_flags;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200469
Felix Fietkau06d961a2013-04-22 16:14:43 +0200470 mi->sta = sta;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200471 mi->lowest_rix = rate_lowest_index(sband, sta);
Christian Lamparterd57854b2008-12-22 15:35:31 +0100472 ctl_rate = &sband->bitrates[mi->lowest_rix];
Michal Kazior4ee73f32012-04-11 08:47:56 +0200473 mi->sp_ack_dur = ieee80211_frame_duration(sband->band, 10,
474 ctl_rate->bitrate,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200475 !!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1,
476 ieee80211_chandef_get_shift(chandef));
Felix Fietkaucccf1292008-10-05 18:07:45 +0200477
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200478 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
Felix Fietkau06d961a2013-04-22 16:14:43 +0200479 memset(mi->max_tp_rate, 0, sizeof(mi->max_tp_rate));
480 mi->max_prob_rate = 0;
481
Felix Fietkaucccf1292008-10-05 18:07:45 +0200482 for (i = 0; i < sband->n_bitrates; i++) {
483 struct minstrel_rate *mr = &mi->r[n];
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200484 struct minstrel_rate_stats *mrs = &mi->r[n].stats;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200485 unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
486 unsigned int tx_time_single;
487 unsigned int cw = mp->cw_min;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200488 int shift;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200489
490 if (!rate_supported(sta, sband->band, i))
491 continue;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200492 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
493 continue;
494
Felix Fietkaucccf1292008-10-05 18:07:45 +0200495 n++;
496 memset(mr, 0, sizeof(*mr));
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200497 memset(mrs, 0, sizeof(*mrs));
Felix Fietkaucccf1292008-10-05 18:07:45 +0200498
499 mr->rix = i;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200500 shift = ieee80211_chandef_get_shift(chandef);
501 mr->bitrate = DIV_ROUND_UP(sband->bitrates[i].bitrate,
502 (1 << shift) * 5);
503 calc_rate_durations(sband->band, mr, &sband->bitrates[i],
504 chandef);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200505
506 /* calculate maximum number of retransmissions before
507 * fallback (based on maximum segment size) */
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200508 mr->sample_limit = -1;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200509 mrs->retry_count = 1;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200510 mr->retry_count_cts = 1;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200511 mrs->retry_count_rtscts = 1;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200512 tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
513 do {
514 /* add one retransmission */
515 tx_time_single = mr->ack_time + mr->perfect_tx_time;
516
517 /* contention window */
Daniel Halperin8fddddf2011-05-10 19:00:45 -0700518 tx_time_single += (t_slot * cw) >> 1;
519 cw = min((cw << 1) | 1, mp->cw_max);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200520
521 tx_time += tx_time_single;
522 tx_time_cts += tx_time_single + mi->sp_ack_dur;
523 tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
524 if ((tx_time_cts < mp->segment_size) &&
525 (mr->retry_count_cts < mp->max_retry))
526 mr->retry_count_cts++;
527 if ((tx_time_rtscts < mp->segment_size) &&
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200528 (mrs->retry_count_rtscts < mp->max_retry))
529 mrs->retry_count_rtscts++;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200530 } while ((tx_time < mp->segment_size) &&
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200531 (++mr->stats.retry_count < mp->max_retry));
532 mr->adjusted_retry_count = mrs->retry_count;
Felix Fietkau991fec02013-04-16 13:38:43 +0200533 if (!(sband->bitrates[i].flags & IEEE80211_RATE_ERP_G))
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200534 mr->retry_count_cts = mrs->retry_count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200535 }
536
537 for (i = n; i < sband->n_bitrates; i++) {
538 struct minstrel_rate *mr = &mi->r[i];
539 mr->rix = -1;
540 }
541
542 mi->n_rates = n;
Thomas Huehn91340732015-03-24 21:09:39 +0100543 mi->last_stats_update = jiffies;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200544
545 init_sample_table(mi);
Felix Fietkau06d961a2013-04-22 16:14:43 +0200546 minstrel_update_rates(mp, mi);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200547}
548
549static void *
550minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
551{
552 struct ieee80211_supported_band *sband;
553 struct minstrel_sta_info *mi;
554 struct minstrel_priv *mp = priv;
555 struct ieee80211_hw *hw = mp->hw;
556 int max_rates = 0;
557 int i;
558
559 mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
560 if (!mi)
561 return NULL;
562
563 for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
Jiri Slaby8e532172009-05-04 18:04:55 +0200564 sband = hw->wiphy->bands[i];
John W. Linville621ad7c2009-05-05 15:18:26 -0400565 if (sband && sband->n_bitrates > max_rates)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200566 max_rates = sband->n_bitrates;
567 }
568
569 mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
570 if (!mi->r)
571 goto error;
572
573 mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
574 if (!mi->sample_table)
575 goto error1;
576
Thomas Huehn91340732015-03-24 21:09:39 +0100577 mi->last_stats_update = jiffies;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200578 return mi;
579
580error1:
581 kfree(mi->r);
582error:
583 kfree(mi);
584 return NULL;
585}
586
587static void
588minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
589{
590 struct minstrel_sta_info *mi = priv_sta;
591
592 kfree(mi->sample_table);
593 kfree(mi->r);
594 kfree(mi);
595}
596
Felix Fietkaua0497f92013-02-13 10:51:08 +0100597static void
598minstrel_init_cck_rates(struct minstrel_priv *mp)
599{
600 static const int bitrates[4] = { 10, 20, 55, 110 };
601 struct ieee80211_supported_band *sband;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200602 u32 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
Felix Fietkaua0497f92013-02-13 10:51:08 +0100603 int i, j;
604
605 sband = mp->hw->wiphy->bands[IEEE80211_BAND_2GHZ];
606 if (!sband)
607 return;
608
609 for (i = 0, j = 0; i < sband->n_bitrates; i++) {
610 struct ieee80211_rate *rate = &sband->bitrates[i];
611
612 if (rate->flags & IEEE80211_RATE_ERP_G)
613 continue;
614
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200615 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
616 continue;
617
Felix Fietkaua0497f92013-02-13 10:51:08 +0100618 for (j = 0; j < ARRAY_SIZE(bitrates); j++) {
619 if (rate->bitrate != bitrates[j])
620 continue;
621
622 mp->cck_rates[j] = i;
623 break;
624 }
625 }
626}
627
Felix Fietkaucccf1292008-10-05 18:07:45 +0200628static void *
629minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
630{
631 struct minstrel_priv *mp;
632
633 mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
634 if (!mp)
635 return NULL;
636
637 /* contention window settings
638 * Just an approximation. Using the per-queue values would complicate
639 * the calculations and is probably unnecessary */
640 mp->cw_min = 15;
641 mp->cw_max = 1023;
642
643 /* number of packets (in %) to use for sampling other rates
644 * sample less often for non-mrr packets, because the overhead
645 * is much higher than with mrr */
646 mp->lookaround_rate = 5;
647 mp->lookaround_rate_mrr = 10;
648
Felix Fietkaucccf1292008-10-05 18:07:45 +0200649 /* maximum time that the hw is allowed to stay in one MRR segment */
650 mp->segment_size = 6000;
651
Johannes Berge6a98542008-10-21 12:40:02 +0200652 if (hw->max_rate_tries > 0)
653 mp->max_retry = hw->max_rate_tries;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200654 else
655 /* safe default, does not necessarily have to match hw properties */
656 mp->max_retry = 7;
657
Johannes Berge6a98542008-10-21 12:40:02 +0200658 if (hw->max_rates >= 4)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200659 mp->has_mrr = true;
660
661 mp->hw = hw;
662 mp->update_interval = 100;
663
Zefir Kurtisi24f75802011-05-20 20:29:17 +0200664#ifdef CONFIG_MAC80211_DEBUGFS
665 mp->fixed_rate_idx = (u32) -1;
666 mp->dbg_fixed_rate = debugfs_create_u32("fixed_rate_idx",
667 S_IRUGO | S_IWUGO, debugfsdir, &mp->fixed_rate_idx);
668#endif
669
Felix Fietkaua0497f92013-02-13 10:51:08 +0100670 minstrel_init_cck_rates(mp);
671
Felix Fietkaucccf1292008-10-05 18:07:45 +0200672 return mp;
673}
674
675static void
676minstrel_free(void *priv)
677{
Zefir Kurtisi24f75802011-05-20 20:29:17 +0200678#ifdef CONFIG_MAC80211_DEBUGFS
679 debugfs_remove(((struct minstrel_priv *)priv)->dbg_fixed_rate);
680#endif
Felix Fietkaucccf1292008-10-05 18:07:45 +0200681 kfree(priv);
682}
683
Antonio Quartullicca674d2014-05-19 21:53:20 +0200684static u32 minstrel_get_expected_throughput(void *priv_sta)
685{
686 struct minstrel_sta_info *mi = priv_sta;
687 int idx = mi->max_tp_rate[0];
Thomas Huehn6a27b2c2015-03-24 21:09:40 +0100688 int tmp_cur_tp;
Antonio Quartullicca674d2014-05-19 21:53:20 +0200689
690 /* convert pkt per sec in kbps (1200 is the average pkt size used for
691 * computing cur_tp
692 */
Thomas Huehn6a27b2c2015-03-24 21:09:40 +0100693 tmp_cur_tp = minstrel_get_tp_avg(&mi->r[idx]);
694 tmp_cur_tp = tmp_cur_tp * 1200 * 8 / 1024;
695
696 return tmp_cur_tp;
Antonio Quartullicca674d2014-05-19 21:53:20 +0200697}
698
Johannes Berg631ad702014-01-20 23:29:34 +0100699const struct rate_control_ops mac80211_minstrel = {
Felix Fietkaucccf1292008-10-05 18:07:45 +0200700 .name = "minstrel",
Felix Fietkaufb7acfb2014-11-19 20:08:09 +0100701 .tx_status_noskb = minstrel_tx_status,
Felix Fietkaucccf1292008-10-05 18:07:45 +0200702 .get_rate = minstrel_get_rate,
703 .rate_init = minstrel_rate_init,
Felix Fietkaucccf1292008-10-05 18:07:45 +0200704 .alloc = minstrel_alloc,
705 .free = minstrel_free,
706 .alloc_sta = minstrel_alloc_sta,
707 .free_sta = minstrel_free_sta,
708#ifdef CONFIG_MAC80211_DEBUGFS
709 .add_sta_debugfs = minstrel_add_sta_debugfs,
710 .remove_sta_debugfs = minstrel_remove_sta_debugfs,
711#endif
Antonio Quartullicca674d2014-05-19 21:53:20 +0200712 .get_expected_throughput = minstrel_get_expected_throughput,
Felix Fietkaucccf1292008-10-05 18:07:45 +0200713};
714
715int __init
716rc80211_minstrel_init(void)
717{
718 return ieee80211_rate_control_register(&mac80211_minstrel);
719}
720
721void
722rc80211_minstrel_exit(void)
723{
724 ieee80211_rate_control_unregister(&mac80211_minstrel);
725}
726