blob: 9766c1cc4b0a5d59ae4c71aea92921391a1576b3 [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 Huehn6a27b2c402015-03-24 21:09:40 +010072/* return current EMWA throughput */
Thomas Huehn50e55a82015-03-24 21:09:41 +010073int minstrel_get_tp_avg(struct minstrel_rate *mr, int prob_ewma)
Thomas Huehn6a27b2c402015-03-24 21:09:40 +010074{
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;
Thomas Huehn50e55a82015-03-24 21:09:41 +010084
85 if (prob_ewma > MINSTREL_FRAC(90, 100))
86 return MINSTREL_TRUNC(100000 * (MINSTREL_FRAC(90, 100) / usecs));
Thomas Huehn6a27b2c402015-03-24 21:09:40 +010087 else
Thomas Huehn50e55a82015-03-24 21:09:41 +010088 return MINSTREL_TRUNC(100000 * (prob_ewma / usecs));
Thomas Huehn6a27b2c402015-03-24 21:09:40 +010089}
90
Thomas Huehn2ff2b692013-03-04 23:30:07 +010091/* find & sort topmost throughput rates */
92static inline void
93minstrel_sort_best_tp_rates(struct minstrel_sta_info *mi, int i, u8 *tp_list)
94{
Adrien Schildknechtf5eeb5f2015-07-28 10:30:16 +020095 int j;
96 struct minstrel_rate_stats *tmp_mrs;
Thomas Huehn50e55a82015-03-24 21:09:41 +010097 struct minstrel_rate_stats *cur_mrs = &mi->r[i].stats;
Thomas Huehn2ff2b692013-03-04 23:30:07 +010098
Adrien Schildknechtf5eeb5f2015-07-28 10:30:16 +020099 for (j = MAX_THR_RATES; j > 0; --j) {
Thomas Huehn50e55a82015-03-24 21:09:41 +0100100 tmp_mrs = &mi->r[tp_list[j - 1]].stats;
Adrien Schildknechtf5eeb5f2015-07-28 10:30:16 +0200101 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;
Thomas Huehn50e55a82015-03-24 21:09:41 +0100104 }
Thomas Huehn6a27b2c402015-03-24 21:09:40 +0100105
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100106 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
Felix Fietkaucccf1292008-10-05 18:07:45 +0200112static void
Felix Fietkau06d961a2013-04-22 16:14:43 +0200113minstrel_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;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200121 ratetbl->rate[offset].count_rts = r->stats.retry_count_rtscts;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200122}
123
124static void
125minstrel_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
Thomas Huehnf62838b2015-03-24 21:09:38 +0100156/*
Thomas Huehn5f919ab2015-03-24 21:09:43 +0100157* Recalculate statistics and counters of a given rate
Thomas Huehnf62838b2015-03-24 21:09:38 +0100158*/
159void
160minstrel_calc_rate_stats(struct minstrel_rate_stats *mrs)
161{
Felix Fietkau1109dc32016-12-14 20:46:58 +0100162 unsigned int cur_prob;
163
Thomas Huehnf62838b2015-03-24 21:09:38 +0100164 if (unlikely(mrs->attempts > 0)) {
165 mrs->sample_skipped = 0;
Felix Fietkau1109dc32016-12-14 20:46:58 +0100166 cur_prob = MINSTREL_FRAC(mrs->success, mrs->attempts);
Thomas Huehn5f919ab2015-03-24 21:09:43 +0100167 if (unlikely(!mrs->att_hist)) {
Felix Fietkau1109dc32016-12-14 20:46:58 +0100168 mrs->prob_ewma = cur_prob;
Thomas Huehn5f919ab2015-03-24 21:09:43 +0100169 } else {
170 /* update exponential weighted moving variance */
Felix Fietkau4f0bc9c2016-12-14 20:47:00 +0100171 mrs->prob_ewmv = minstrel_ewmv(mrs->prob_ewmv,
172 cur_prob,
173 mrs->prob_ewma,
174 EWMA_LEVEL);
Thomas Huehn5f919ab2015-03-24 21:09:43 +0100175
176 /*update exponential weighted moving avarage */
Thomas Huehn91340732015-03-24 21:09:39 +0100177 mrs->prob_ewma = minstrel_ewma(mrs->prob_ewma,
Felix Fietkau1109dc32016-12-14 20:46:58 +0100178 cur_prob,
Thomas Huehn5f919ab2015-03-24 21:09:43 +0100179 EWMA_LEVEL);
180 }
Thomas Huehnf62838b2015-03-24 21:09:38 +0100181 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
Felix Fietkau06d961a2013-04-22 16:14:43 +0200193static void
Felix Fietkaucccf1292008-10-05 18:07:45 +0200194minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
195{
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100196 u8 tmp_tp_rate[MAX_THR_RATES];
197 u8 tmp_prob_rate = 0;
Thomas Huehn6a27b2c402015-03-24 21:09:40 +0100198 int i, tmp_cur_tp, tmp_prob_tp;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200199
Weilong Chenf359d3f2013-12-18 15:44:16 +0800200 for (i = 0; i < MAX_THR_RATES; i++)
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100201 tmp_tp_rate[i] = 0;
202
Felix Fietkaucccf1292008-10-05 18:07:45 +0200203 for (i = 0; i < mi->n_rates; i++) {
204 struct minstrel_rate *mr = &mi->r[i];
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200205 struct minstrel_rate_stats *mrs = &mi->r[i].stats;
Thomas Huehn50e55a82015-03-24 21:09:41 +0100206 struct minstrel_rate_stats *tmp_mrs = &mi->r[tmp_prob_rate].stats;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200207
Thomas Huehn5f919ab2015-03-24 21:09:43 +0100208 /* Update statistics of success probability per rate */
Thomas Huehnf62838b2015-03-24 21:09:38 +0100209 minstrel_calc_rate_stats(mrs);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200210
211 /* Sample less often below the 10% chance of success.
212 * Sample less often above the 95% chance of success. */
Thomas Huehn91340732015-03-24 21:09:39 +0100213 if (mrs->prob_ewma > MINSTREL_FRAC(95, 100) ||
214 mrs->prob_ewma < MINSTREL_FRAC(10, 100)) {
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200215 mr->adjusted_retry_count = mrs->retry_count >> 1;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200216 if (mr->adjusted_retry_count > 2)
217 mr->adjusted_retry_count = 2;
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200218 mr->sample_limit = 4;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200219 } else {
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200220 mr->sample_limit = -1;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200221 mr->adjusted_retry_count = mrs->retry_count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200222 }
223 if (!mr->adjusted_retry_count)
224 mr->adjusted_retry_count = 2;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200225
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100226 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
Stephen Hemmingerd070f912014-10-29 22:55:58 -0700233 * highest success probability is chosen as max_prob_rate */
Thomas Huehn91340732015-03-24 21:09:39 +0100234 if (mrs->prob_ewma >= MINSTREL_FRAC(95, 100)) {
Thomas Huehn50e55a82015-03-24 21:09:41 +0100235 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);
Thomas Huehn6a27b2c402015-03-24 21:09:40 +0100238 if (tmp_cur_tp >= tmp_prob_tp)
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100239 tmp_prob_rate = i;
240 } else {
Thomas Huehn50e55a82015-03-24 21:09:41 +0100241 if (mrs->prob_ewma >= tmp_mrs->prob_ewma)
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100242 tmp_prob_rate = i;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200243 }
244 }
245
Thomas Huehn2ff2b692013-03-04 23:30:07 +0100246 /* 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;
Thomas Huehn8f157612013-03-04 23:30:03 +0100249
Lorenzo Bianconi45966ae2013-08-27 16:59:46 +0200250#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
Thomas Huehn8f157612013-03-04 23:30:03 +0100259 /* Reset update timer */
Thomas Huehn91340732015-03-24 21:09:39 +0100260 mi->last_stats_update = jiffies;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200261
262 minstrel_update_rates(mp, mi);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200263}
264
265static void
266minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
Felix Fietkau18fb84d2017-04-26 17:11:35 +0200267 void *priv_sta, struct ieee80211_tx_status *st)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200268{
Felix Fietkau18fb84d2017-04-26 17:11:35 +0200269 struct ieee80211_tx_info *info = st->info;
Johannes Berg8acbcdd2012-11-15 18:27:56 +0100270 struct minstrel_priv *mp = priv;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200271 struct minstrel_sta_info *mi = priv_sta;
Johannes Berge6a98542008-10-21 12:40:02 +0200272 struct ieee80211_tx_rate *ar = info->status.rates;
273 int i, ndx;
274 int success;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200275
Johannes Berge6a98542008-10-21 12:40:02 +0200276 success = !!(info->flags & IEEE80211_TX_STAT_ACK);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200277
Johannes Berge6a98542008-10-21 12:40:02 +0200278 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
279 if (ar[i].idx < 0)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200280 break;
281
Johannes Berge6a98542008-10-21 12:40:02 +0200282 ndx = rix_to_ndx(mi, ar[i].idx);
Luciano Coelho3938b452009-07-03 08:25:08 +0300283 if (ndx < 0)
284 continue;
285
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200286 mi->r[ndx].stats.attempts += ar[i].count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200287
Javier Cardonabfc32e62009-08-17 17:15:55 -0700288 if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200289 mi->r[ndx].stats.success += success;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200290 }
291
292 if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200293 mi->sample_packets++;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200294
295 if (mi->sample_deferred > 0)
296 mi->sample_deferred--;
Johannes Berg8acbcdd2012-11-15 18:27:56 +0100297
Thomas Huehn91340732015-03-24 21:09:39 +0100298 if (time_after(jiffies, mi->last_stats_update +
Johannes Berg8acbcdd2012-11-15 18:27:56 +0100299 (mp->update_interval * HZ) / 1000))
300 minstrel_update_stats(mp, mi);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200301}
302
303
304static inline unsigned int
305minstrel_get_retry_count(struct minstrel_rate *mr,
Weilong Chenf359d3f2013-12-18 15:44:16 +0800306 struct ieee80211_tx_info *info)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200307{
Felix Fietkau8d819a92014-12-17 13:38:34 +0100308 u8 retry = mr->adjusted_retry_count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200309
Felix Fietkau991fec02013-04-16 13:38:43 +0200310 if (info->control.use_rts)
Felix Fietkau8d819a92014-12-17 13:38:34 +0100311 retry = max_t(u8, 2, min(mr->stats.retry_count_rtscts, retry));
Felix Fietkau991fec02013-04-16 13:38:43 +0200312 else if (info->control.use_cts_prot)
Felix Fietkau8d819a92014-12-17 13:38:34 +0100313 retry = max_t(u8, 2, min(mr->retry_count_cts, retry));
Felix Fietkaucccf1292008-10-05 18:07:45 +0200314 return retry;
315}
316
317
318static int
319minstrel_get_next_sample(struct minstrel_sta_info *mi)
320{
321 unsigned int sample_ndx;
Thomas Huehn8f157612013-03-04 23:30:03 +0100322 sample_ndx = SAMPLE_TBL(mi, mi->sample_row, mi->sample_column);
323 mi->sample_row++;
Thomas Huehnf744bf82013-03-04 23:30:05 +0100324 if ((int) mi->sample_row >= mi->n_rates) {
Thomas Huehn8f157612013-03-04 23:30:03 +0100325 mi->sample_row = 0;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200326 mi->sample_column++;
327 if (mi->sample_column >= SAMPLE_COLUMNS)
328 mi->sample_column = 0;
329 }
330 return sample_ndx;
331}
332
Johannes Berg2df78162008-10-28 16:49:41 +0100333static void
Johannes Berge6a98542008-10-21 12:40:02 +0200334minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
335 void *priv_sta, struct ieee80211_tx_rate_control *txrc)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200336{
Johannes Berge6a98542008-10-21 12:40:02 +0200337 struct sk_buff *skb = txrc->skb;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200338 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
339 struct minstrel_sta_info *mi = priv_sta;
340 struct minstrel_priv *mp = priv;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200341 struct ieee80211_tx_rate *rate = &info->control.rates[0];
342 struct minstrel_rate *msr, *mr;
343 unsigned int ndx;
Thomas Huehn8f157612013-03-04 23:30:03 +0100344 bool mrr_capable;
Felix Fietkau5c9fc932013-07-15 14:35:06 +0200345 bool prev_sample;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200346 int delta;
Thomas Huehn8f157612013-03-04 23:30:03 +0100347 int sampling_ratio;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200348
Thomas Huehn8f157612013-03-04 23:30:03 +0100349 /* management/no-ack frames do not use rate control */
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -0700350 if (rate_control_send_low(sta, priv_sta, txrc))
Felix Fietkaucccf1292008-10-05 18:07:45 +0200351 return;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200352
Thomas Huehn8f157612013-03-04 23:30:03 +0100353 /* check multi-rate-retry capabilities & adjust lookaround_rate */
354 mrr_capable = mp->has_mrr &&
355 !txrc->rts &&
356 !txrc->bss_conf->use_cts_prot;
357 if (mrr_capable)
358 sampling_ratio = mp->lookaround_rate_mrr;
359 else
360 sampling_ratio = mp->lookaround_rate;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200361
Thomas Huehn8f157612013-03-04 23:30:03 +0100362 /* increase sum packet counter */
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200363 mi->total_packets++;
Thomas Huehn8f157612013-03-04 23:30:03 +0100364
Lorenzo Bianconi45966ae2013-08-27 16:59:46 +0200365#ifdef CONFIG_MAC80211_DEBUGFS
366 if (mp->fixed_rate_idx != -1)
367 return;
368#endif
369
Thomas Huehn38252e92016-12-14 20:47:03 +0100370 /* Don't use EAPOL frames for sampling on non-mrr hw */
371 if (mp->hw->max_rates == 1 &&
372 (info->control.flags & IEEE80211_TX_CTRL_PORT_CTRL_PROTO))
373 return;
374
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200375 delta = (mi->total_packets * sampling_ratio / 100) -
376 (mi->sample_packets + mi->sample_deferred / 2);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200377
Felix Fietkau06d961a2013-04-22 16:14:43 +0200378 /* delta < 0: no sampling required */
Felix Fietkau5c9fc932013-07-15 14:35:06 +0200379 prev_sample = mi->prev_sample;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200380 mi->prev_sample = false;
381 if (delta < 0 || (!mrr_capable && prev_sample))
382 return;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200383
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200384 if (mi->total_packets >= 10000) {
Felix Fietkau06d961a2013-04-22 16:14:43 +0200385 mi->sample_deferred = 0;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200386 mi->sample_packets = 0;
387 mi->total_packets = 0;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200388 } else if (delta > mi->n_rates * 2) {
389 /* With multi-rate retry, not every planned sample
390 * attempt actually gets used, due to the way the retry
391 * chain is set up - [max_tp,sample,prob,lowest] for
392 * sample_rate < max_tp.
393 *
394 * If there's too much sampling backlog and the link
395 * starts getting worse, minstrel would start bursting
396 * out lots of sampling frames, which would result
397 * in a large throughput loss. */
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200398 mi->sample_packets += (delta - mi->n_rates * 2);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200399 }
Felix Fietkau06d961a2013-04-22 16:14:43 +0200400
401 /* get next random rate sample */
402 ndx = minstrel_get_next_sample(mi);
403 msr = &mi->r[ndx];
404 mr = &mi->r[mi->max_tp_rate[0]];
405
406 /* Decide if direct ( 1st mrr stage) or indirect (2nd mrr stage)
407 * rate sampling method should be used.
408 * Respect such rates that are not sampled for 20 interations.
409 */
410 if (mrr_capable &&
411 msr->perfect_tx_time > mr->perfect_tx_time &&
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200412 msr->stats.sample_skipped < 20) {
Felix Fietkau06d961a2013-04-22 16:14:43 +0200413 /* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
414 * packets that have the sampling rate deferred to the
415 * second MRR stage. Increase the sample counter only
416 * if the deferred sample rate was actually used.
417 * Use the sample_deferred counter to make sure that
418 * the sampling is not done in large bursts */
419 info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
420 rate++;
421 mi->sample_deferred++;
422 } else {
Jiri Slaby17dce152015-02-19 12:57:40 +0100423 if (!msr->sample_limit)
Felix Fietkau06d961a2013-04-22 16:14:43 +0200424 return;
425
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200426 mi->sample_packets++;
Felix Fietkau06d961a2013-04-22 16:14:43 +0200427 if (msr->sample_limit > 0)
428 msr->sample_limit--;
429 }
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200430
431 /* If we're not using MRR and the sampling rate already
432 * has a probability of >95%, we shouldn't be attempting
433 * to use it, as this only wastes precious airtime */
Felix Fietkau06d961a2013-04-22 16:14:43 +0200434 if (!mrr_capable &&
Thomas Huehn91340732015-03-24 21:09:39 +0100435 (mi->r[ndx].stats.prob_ewma > MINSTREL_FRAC(95, 100)))
Felix Fietkaucccf1292008-10-05 18:07:45 +0200436 return;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200437
Felix Fietkau06d961a2013-04-22 16:14:43 +0200438 mi->prev_sample = true;
Thomas Huehn8f157612013-03-04 23:30:03 +0100439
Felix Fietkau06d961a2013-04-22 16:14:43 +0200440 rate->idx = mi->r[ndx].rix;
441 rate->count = minstrel_get_retry_count(&mi->r[ndx], info);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200442}
443
444
445static void
Johannes Berg57fbcce2016-04-12 15:56:15 +0200446calc_rate_durations(enum nl80211_band band,
Michal Kazior4ee73f32012-04-11 08:47:56 +0200447 struct minstrel_rate *d,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200448 struct ieee80211_rate *rate,
449 struct cfg80211_chan_def *chandef)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200450{
451 int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200452 int shift = ieee80211_chandef_get_shift(chandef);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200453
Michal Kazior4ee73f32012-04-11 08:47:56 +0200454 d->perfect_tx_time = ieee80211_frame_duration(band, 1200,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200455 DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
456 shift);
Michal Kazior4ee73f32012-04-11 08:47:56 +0200457 d->ack_time = ieee80211_frame_duration(band, 10,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200458 DIV_ROUND_UP(rate->bitrate, 1 << shift), erp, 1,
459 shift);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200460}
461
462static void
463init_sample_table(struct minstrel_sta_info *mi)
464{
465 unsigned int i, col, new_idx;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200466 u8 rnd[8];
467
468 mi->sample_column = 0;
Thomas Huehn8f157612013-03-04 23:30:03 +0100469 mi->sample_row = 0;
Thomas Huehnf744bf82013-03-04 23:30:05 +0100470 memset(mi->sample_table, 0xff, SAMPLE_COLUMNS * mi->n_rates);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200471
472 for (col = 0; col < SAMPLE_COLUMNS; col++) {
Karl Beldanf7d8ad82013-11-13 10:54:19 +0100473 prandom_bytes(rnd, sizeof(rnd));
Thomas Huehnf744bf82013-03-04 23:30:05 +0100474 for (i = 0; i < mi->n_rates; i++) {
Thomas Huehnf744bf82013-03-04 23:30:05 +0100475 new_idx = (i + rnd[i & 7]) % mi->n_rates;
Thomas Huehnf744bf82013-03-04 23:30:05 +0100476 while (SAMPLE_TBL(mi, new_idx, col) != 0xff)
477 new_idx = (new_idx + 1) % mi->n_rates;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200478
Thomas Huehnf744bf82013-03-04 23:30:05 +0100479 SAMPLE_TBL(mi, new_idx, col) = i;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200480 }
481 }
482}
483
484static void
485minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +0200486 struct cfg80211_chan_def *chandef,
487 struct ieee80211_sta *sta, void *priv_sta)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200488{
489 struct minstrel_sta_info *mi = priv_sta;
490 struct minstrel_priv *mp = priv;
Christian Lamparterd57854b2008-12-22 15:35:31 +0100491 struct ieee80211_rate *ctl_rate;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200492 unsigned int i, n = 0;
493 unsigned int t_slot = 9; /* FIXME: get real slot time */
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200494 u32 rate_flags;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200495
Felix Fietkau06d961a2013-04-22 16:14:43 +0200496 mi->sta = sta;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200497 mi->lowest_rix = rate_lowest_index(sband, sta);
Christian Lamparterd57854b2008-12-22 15:35:31 +0100498 ctl_rate = &sband->bitrates[mi->lowest_rix];
Michal Kazior4ee73f32012-04-11 08:47:56 +0200499 mi->sp_ack_dur = ieee80211_frame_duration(sband->band, 10,
500 ctl_rate->bitrate,
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200501 !!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1,
502 ieee80211_chandef_get_shift(chandef));
Felix Fietkaucccf1292008-10-05 18:07:45 +0200503
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200504 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
Felix Fietkau06d961a2013-04-22 16:14:43 +0200505 memset(mi->max_tp_rate, 0, sizeof(mi->max_tp_rate));
506 mi->max_prob_rate = 0;
507
Felix Fietkaucccf1292008-10-05 18:07:45 +0200508 for (i = 0; i < sband->n_bitrates; i++) {
509 struct minstrel_rate *mr = &mi->r[n];
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200510 struct minstrel_rate_stats *mrs = &mi->r[n].stats;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200511 unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
512 unsigned int tx_time_single;
513 unsigned int cw = mp->cw_min;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200514 int shift;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200515
516 if (!rate_supported(sta, sband->band, i))
517 continue;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200518 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
519 continue;
520
Felix Fietkaucccf1292008-10-05 18:07:45 +0200521 n++;
522 memset(mr, 0, sizeof(*mr));
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200523 memset(mrs, 0, sizeof(*mrs));
Felix Fietkaucccf1292008-10-05 18:07:45 +0200524
525 mr->rix = i;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200526 shift = ieee80211_chandef_get_shift(chandef);
527 mr->bitrate = DIV_ROUND_UP(sband->bitrates[i].bitrate,
528 (1 << shift) * 5);
529 calc_rate_durations(sband->band, mr, &sband->bitrates[i],
530 chandef);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200531
532 /* calculate maximum number of retransmissions before
533 * fallback (based on maximum segment size) */
Felix Fietkauf4a8cd92008-10-15 19:13:59 +0200534 mr->sample_limit = -1;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200535 mrs->retry_count = 1;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200536 mr->retry_count_cts = 1;
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200537 mrs->retry_count_rtscts = 1;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200538 tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
539 do {
540 /* add one retransmission */
541 tx_time_single = mr->ack_time + mr->perfect_tx_time;
542
543 /* contention window */
Daniel Halperin8fddddf2011-05-10 19:00:45 -0700544 tx_time_single += (t_slot * cw) >> 1;
545 cw = min((cw << 1) | 1, mp->cw_max);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200546
547 tx_time += tx_time_single;
548 tx_time_cts += tx_time_single + mi->sp_ack_dur;
549 tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
550 if ((tx_time_cts < mp->segment_size) &&
551 (mr->retry_count_cts < mp->max_retry))
552 mr->retry_count_cts++;
553 if ((tx_time_rtscts < mp->segment_size) &&
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200554 (mrs->retry_count_rtscts < mp->max_retry))
555 mrs->retry_count_rtscts++;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200556 } while ((tx_time < mp->segment_size) &&
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200557 (++mr->stats.retry_count < mp->max_retry));
558 mr->adjusted_retry_count = mrs->retry_count;
Felix Fietkau991fec02013-04-16 13:38:43 +0200559 if (!(sband->bitrates[i].flags & IEEE80211_RATE_ERP_G))
Thomas Huehnca12c0c2014-09-09 23:22:13 +0200560 mr->retry_count_cts = mrs->retry_count;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200561 }
562
563 for (i = n; i < sband->n_bitrates; i++) {
564 struct minstrel_rate *mr = &mi->r[i];
565 mr->rix = -1;
566 }
567
568 mi->n_rates = n;
Thomas Huehn91340732015-03-24 21:09:39 +0100569 mi->last_stats_update = jiffies;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200570
571 init_sample_table(mi);
Felix Fietkau06d961a2013-04-22 16:14:43 +0200572 minstrel_update_rates(mp, mi);
Felix Fietkaucccf1292008-10-05 18:07:45 +0200573}
574
575static void *
576minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
577{
578 struct ieee80211_supported_band *sband;
579 struct minstrel_sta_info *mi;
580 struct minstrel_priv *mp = priv;
581 struct ieee80211_hw *hw = mp->hw;
582 int max_rates = 0;
583 int i;
584
585 mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
586 if (!mi)
587 return NULL;
588
Johannes Berg57fbcce2016-04-12 15:56:15 +0200589 for (i = 0; i < NUM_NL80211_BANDS; i++) {
Jiri Slaby8e532172009-05-04 18:04:55 +0200590 sband = hw->wiphy->bands[i];
John W. Linville621ad7c2009-05-05 15:18:26 -0400591 if (sband && sband->n_bitrates > max_rates)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200592 max_rates = sband->n_bitrates;
593 }
594
595 mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
596 if (!mi->r)
597 goto error;
598
599 mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
600 if (!mi->sample_table)
601 goto error1;
602
Thomas Huehn91340732015-03-24 21:09:39 +0100603 mi->last_stats_update = jiffies;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200604 return mi;
605
606error1:
607 kfree(mi->r);
608error:
609 kfree(mi);
610 return NULL;
611}
612
613static void
614minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
615{
616 struct minstrel_sta_info *mi = priv_sta;
617
618 kfree(mi->sample_table);
619 kfree(mi->r);
620 kfree(mi);
621}
622
Felix Fietkaua0497f92013-02-13 10:51:08 +0100623static void
624minstrel_init_cck_rates(struct minstrel_priv *mp)
625{
626 static const int bitrates[4] = { 10, 20, 55, 110 };
627 struct ieee80211_supported_band *sband;
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200628 u32 rate_flags = ieee80211_chandef_rate_flags(&mp->hw->conf.chandef);
Felix Fietkaua0497f92013-02-13 10:51:08 +0100629 int i, j;
630
Johannes Berg57fbcce2016-04-12 15:56:15 +0200631 sband = mp->hw->wiphy->bands[NL80211_BAND_2GHZ];
Felix Fietkaua0497f92013-02-13 10:51:08 +0100632 if (!sband)
633 return;
634
635 for (i = 0, j = 0; i < sband->n_bitrates; i++) {
636 struct ieee80211_rate *rate = &sband->bitrates[i];
637
638 if (rate->flags & IEEE80211_RATE_ERP_G)
639 continue;
640
Simon Wunderlich438b61b2013-07-08 16:55:51 +0200641 if ((rate_flags & sband->bitrates[i].flags) != rate_flags)
642 continue;
643
Felix Fietkaua0497f92013-02-13 10:51:08 +0100644 for (j = 0; j < ARRAY_SIZE(bitrates); j++) {
645 if (rate->bitrate != bitrates[j])
646 continue;
647
648 mp->cck_rates[j] = i;
649 break;
650 }
651 }
652}
653
Felix Fietkaucccf1292008-10-05 18:07:45 +0200654static void *
655minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
656{
657 struct minstrel_priv *mp;
658
659 mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
660 if (!mp)
661 return NULL;
662
663 /* contention window settings
664 * Just an approximation. Using the per-queue values would complicate
665 * the calculations and is probably unnecessary */
666 mp->cw_min = 15;
667 mp->cw_max = 1023;
668
669 /* number of packets (in %) to use for sampling other rates
670 * sample less often for non-mrr packets, because the overhead
671 * is much higher than with mrr */
672 mp->lookaround_rate = 5;
673 mp->lookaround_rate_mrr = 10;
674
Felix Fietkaucccf1292008-10-05 18:07:45 +0200675 /* maximum time that the hw is allowed to stay in one MRR segment */
676 mp->segment_size = 6000;
677
Johannes Berge6a98542008-10-21 12:40:02 +0200678 if (hw->max_rate_tries > 0)
679 mp->max_retry = hw->max_rate_tries;
Felix Fietkaucccf1292008-10-05 18:07:45 +0200680 else
681 /* safe default, does not necessarily have to match hw properties */
682 mp->max_retry = 7;
683
Johannes Berge6a98542008-10-21 12:40:02 +0200684 if (hw->max_rates >= 4)
Felix Fietkaucccf1292008-10-05 18:07:45 +0200685 mp->has_mrr = true;
686
687 mp->hw = hw;
688 mp->update_interval = 100;
689
Zefir Kurtisi24f75802011-05-20 20:29:17 +0200690#ifdef CONFIG_MAC80211_DEBUGFS
691 mp->fixed_rate_idx = (u32) -1;
692 mp->dbg_fixed_rate = debugfs_create_u32("fixed_rate_idx",
693 S_IRUGO | S_IWUGO, debugfsdir, &mp->fixed_rate_idx);
694#endif
695
Felix Fietkaua0497f92013-02-13 10:51:08 +0100696 minstrel_init_cck_rates(mp);
697
Felix Fietkaucccf1292008-10-05 18:07:45 +0200698 return mp;
699}
700
701static void
702minstrel_free(void *priv)
703{
Zefir Kurtisi24f75802011-05-20 20:29:17 +0200704#ifdef CONFIG_MAC80211_DEBUGFS
705 debugfs_remove(((struct minstrel_priv *)priv)->dbg_fixed_rate);
706#endif
Felix Fietkaucccf1292008-10-05 18:07:45 +0200707 kfree(priv);
708}
709
Antonio Quartullicca674d2014-05-19 21:53:20 +0200710static u32 minstrel_get_expected_throughput(void *priv_sta)
711{
712 struct minstrel_sta_info *mi = priv_sta;
Thomas Huehn50e55a82015-03-24 21:09:41 +0100713 struct minstrel_rate_stats *tmp_mrs;
Antonio Quartullicca674d2014-05-19 21:53:20 +0200714 int idx = mi->max_tp_rate[0];
Thomas Huehn6a27b2c402015-03-24 21:09:40 +0100715 int tmp_cur_tp;
Antonio Quartullicca674d2014-05-19 21:53:20 +0200716
717 /* convert pkt per sec in kbps (1200 is the average pkt size used for
718 * computing cur_tp
719 */
Thomas Huehn50e55a82015-03-24 21:09:41 +0100720 tmp_mrs = &mi->r[idx].stats;
Sven Eckelmann212c5a52016-02-02 08:12:26 +0100721 tmp_cur_tp = minstrel_get_tp_avg(&mi->r[idx], tmp_mrs->prob_ewma) * 10;
Thomas Huehn6a27b2c402015-03-24 21:09:40 +0100722 tmp_cur_tp = tmp_cur_tp * 1200 * 8 / 1024;
723
724 return tmp_cur_tp;
Antonio Quartullicca674d2014-05-19 21:53:20 +0200725}
726
Johannes Berg631ad702014-01-20 23:29:34 +0100727const struct rate_control_ops mac80211_minstrel = {
Felix Fietkaucccf1292008-10-05 18:07:45 +0200728 .name = "minstrel",
Felix Fietkau18fb84d2017-04-26 17:11:35 +0200729 .tx_status_ext = minstrel_tx_status,
Felix Fietkaucccf1292008-10-05 18:07:45 +0200730 .get_rate = minstrel_get_rate,
731 .rate_init = minstrel_rate_init,
Felix Fietkaucccf1292008-10-05 18:07:45 +0200732 .alloc = minstrel_alloc,
733 .free = minstrel_free,
734 .alloc_sta = minstrel_alloc_sta,
735 .free_sta = minstrel_free_sta,
736#ifdef CONFIG_MAC80211_DEBUGFS
737 .add_sta_debugfs = minstrel_add_sta_debugfs,
738 .remove_sta_debugfs = minstrel_remove_sta_debugfs,
739#endif
Antonio Quartullicca674d2014-05-19 21:53:20 +0200740 .get_expected_throughput = minstrel_get_expected_throughput,
Felix Fietkaucccf1292008-10-05 18:07:45 +0200741};
742
743int __init
744rc80211_minstrel_init(void)
745{
746 return ieee80211_rate_control_register(&mac80211_minstrel);
747}
748
749void
750rc80211_minstrel_exit(void)
751{
752 ieee80211_rate_control_unregister(&mac80211_minstrel);
753}
754