[deliverable/linux.git] / net / mac80211 / rc80211_minstrel.c

/*
 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Based on minstrel.c:
 *   Copyright (C) 2005-2007 Derek Smithies <derek@indranet.co.nz>
 *   Sponsored by Indranet Technologies Ltd
 *
 * Based on sample.c:
 *   Copyright (c) 2005 John Bicket
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer,
 *      without modification.
 *   2. Redistributions in binary form must reproduce at minimum a disclaimer
 *      similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
 *      redistribution must be conditioned upon including a substantially
 *      similar Disclaimer requirement for further binary redistribution.
 *   3. Neither the names of the above-listed copyright holders nor the names
 *      of any contributors may be used to endorse or promote products derived
 *      from this software without specific prior written permission.
 *
 *   Alternatively, this software may be distributed under the terms of the
 *   GNU General Public License ("GPL") version 2 as published by the Free
 *   Software Foundation.
 *
 *   NO WARRANTY
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
 *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 *   THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
 *   OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 *   IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 *   THE POSSIBILITY OF SUCH DAMAGES.
 */
#include <linux/netdevice.h>
#include <linux/types.h>
#include <linux/skbuff.h>
#include <linux/debugfs.h>
#include <linux/random.h>
#include <linux/ieee80211.h>
#include <net/mac80211.h>
#include "rate.h"
#include "rc80211_minstrel.h"

#define SAMPLE_COLUMNS	10
#define SAMPLE_TBL(_mi, _idx, _col) \
		_mi->sample_table[(_idx * SAMPLE_COLUMNS) + _col]

/* convert mac80211 rate index to local array index */
static inline int
rix_to_ndx(struct minstrel_sta_info *mi, int rix)
{
	int i = rix;
	for (i = rix; i >= 0; i--)
		if (mi->r[i].rix == rix)
			break;
	WARN_ON(i < 0);
	return i;
}

static inline bool
use_low_rate(struct sk_buff *skb)
{
	struct ieee80211_hdr *hdr = (struct ieee80211_hdr *) skb->data;
	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
	__le16 fc;

	fc = hdr->frame_control;

	return ((info->flags & IEEE80211_TX_CTL_NO_ACK) || !ieee80211_is_data(fc));
}


static void
minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
{
	u32 max_tp = 0, index_max_tp = 0, index_max_tp2 = 0;
	u32 max_prob = 0, index_max_prob = 0;
	u32 usecs;
	u32 p;
	int i;

	mi->stats_update = jiffies;
	for (i = 0; i < mi->n_rates; i++) {
		struct minstrel_rate *mr = &mi->r[i];

		usecs = mr->perfect_tx_time;
		if (!usecs)
			usecs = 1000000;

		/* To avoid rounding issues, probabilities scale from 0 (0%)
		 * to 18000 (100%) */
		if (mr->attempts) {
			p = (mr->success * 18000) / mr->attempts;
			mr->succ_hist += mr->success;
			mr->att_hist += mr->attempts;
			mr->cur_prob = p;
			p = ((p * (100 - mp->ewma_level)) + (mr->probability *
				mp->ewma_level)) / 100;
			mr->probability = p;
			mr->cur_tp = p * (1000000 / usecs);
		}

		mr->last_success = mr->success;
		mr->last_attempts = mr->attempts;
		mr->success = 0;
		mr->attempts = 0;

		/* Sample less often below the 10% chance of success.
		 * Sample less often above the 95% chance of success. */
		if ((mr->probability > 17100) || (mr->probability < 1800)) {
			mr->adjusted_retry_count = mr->retry_count >> 1;
			if (mr->adjusted_retry_count > 2)
				mr->adjusted_retry_count = 2;
			mr->sample_limit = 4;
		} else {
			mr->sample_limit = -1;
			mr->adjusted_retry_count = mr->retry_count;
		}
		if (!mr->adjusted_retry_count)
			mr->adjusted_retry_count = 2;
	}

	for (i = 0; i < mi->n_rates; i++) {
		struct minstrel_rate *mr = &mi->r[i];
		if (max_tp < mr->cur_tp) {
			index_max_tp = i;
			max_tp = mr->cur_tp;
		}
		if (max_prob < mr->probability) {
			index_max_prob = i;
			max_prob = mr->probability;
		}
	}

	max_tp = 0;
	for (i = 0; i < mi->n_rates; i++) {
		struct minstrel_rate *mr = &mi->r[i];

		if (i == index_max_tp)
			continue;

		if (max_tp < mr->cur_tp) {
			index_max_tp2 = i;
			max_tp = mr->cur_tp;
		}
	}
	mi->max_tp_rate = index_max_tp;
	mi->max_tp_rate2 = index_max_tp2;
	mi->max_prob_rate = index_max_prob;
}

static void
minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
                   struct ieee80211_sta *sta, void *priv_sta,
		   struct sk_buff *skb)
{
	struct minstrel_sta_info *mi = priv_sta;
	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
	struct ieee80211_tx_rate *ar = info->status.rates;
	int i, ndx;
	int success;

	success = !!(info->flags & IEEE80211_TX_STAT_ACK);

	for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
		if (ar[i].idx < 0)
			break;

		ndx = rix_to_ndx(mi, ar[i].idx);
		if (ndx < 0)
			continue;

		mi->r[ndx].attempts += ar[i].count;

		if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
			mi->r[ndx].success += success;
	}

	if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
		mi->sample_count++;

	if (mi->sample_deferred > 0)
		mi->sample_deferred--;
}


static inline unsigned int
minstrel_get_retry_count(struct minstrel_rate *mr,
                         struct ieee80211_tx_info *info)
{
	unsigned int retry = mr->adjusted_retry_count;

	if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_RTS_CTS)
		retry = max(2U, min(mr->retry_count_rtscts, retry));
	else if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_CTS_PROTECT)
		retry = max(2U, min(mr->retry_count_cts, retry));
	return retry;
}


static int
minstrel_get_next_sample(struct minstrel_sta_info *mi)
{
	unsigned int sample_ndx;
	sample_ndx = SAMPLE_TBL(mi, mi->sample_idx, mi->sample_column);
	mi->sample_idx++;
	if ((int) mi->sample_idx > (mi->n_rates - 2)) {
		mi->sample_idx = 0;
		mi->sample_column++;
		if (mi->sample_column >= SAMPLE_COLUMNS)
			mi->sample_column = 0;
	}
	return sample_ndx;
}

static void
minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
		  void *priv_sta, struct ieee80211_tx_rate_control *txrc)
{
	struct sk_buff *skb = txrc->skb;
	struct ieee80211_supported_band *sband = txrc->sband;
	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
	struct minstrel_sta_info *mi = priv_sta;
	struct minstrel_priv *mp = priv;
	struct ieee80211_tx_rate *ar = info->control.rates;
	unsigned int ndx, sample_ndx = 0;
	bool mrr;
	bool sample_slower = false;
	bool sample = false;
	int i, delta;
	int mrr_ndx[3];
	int sample_rate;

	if (!sta || !mi || use_low_rate(skb)) {
		ar[0].idx = rate_lowest_index(sband, sta);
		if (info->flags & IEEE80211_TX_CTL_NO_ACK)
			ar[0].count = 1;
		else
			ar[0].count = mp->max_retry;
		return;
	}

	mrr = mp->has_mrr && !txrc->rts && !txrc->bss_conf->use_cts_prot;

	if (time_after(jiffies, mi->stats_update + (mp->update_interval *
			HZ) / 1000))
		minstrel_update_stats(mp, mi);

	ndx = mi->max_tp_rate;

	if (mrr)
		sample_rate = mp->lookaround_rate_mrr;
	else
		sample_rate = mp->lookaround_rate;

	mi->packet_count++;
	delta = (mi->packet_count * sample_rate / 100) -
			(mi->sample_count + mi->sample_deferred / 2);

	/* delta > 0: sampling required */
	if ((delta > 0) && (mrr || !mi->prev_sample)) {
		struct minstrel_rate *msr;
		if (mi->packet_count >= 10000) {
			mi->sample_deferred = 0;
			mi->sample_count = 0;
			mi->packet_count = 0;
		} else if (delta > mi->n_rates * 2) {
			/* With multi-rate retry, not every planned sample
			 * attempt actually gets used, due to the way the retry
			 * chain is set up - [max_tp,sample,prob,lowest] for
			 * sample_rate < max_tp.
			 *
			 * If there's too much sampling backlog and the link
			 * starts getting worse, minstrel would start bursting
			 * out lots of sampling frames, which would result
			 * in a large throughput loss. */
			mi->sample_count += (delta - mi->n_rates * 2);
		}

		sample_ndx = minstrel_get_next_sample(mi);
		msr = &mi->r[sample_ndx];
		sample = true;
		sample_slower = mrr && (msr->perfect_tx_time >
			mi->r[ndx].perfect_tx_time);

		if (!sample_slower) {
			if (msr->sample_limit != 0) {
				ndx = sample_ndx;
				mi->sample_count++;
				if (msr->sample_limit > 0)
					msr->sample_limit--;
			} else {
				sample = false;
			}
		} else {
			/* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
			 * packets that have the sampling rate deferred to the
			 * second MRR stage. Increase the sample counter only
			 * if the deferred sample rate was actually used.
			 * Use the sample_deferred counter to make sure that
			 * the sampling is not done in large bursts */
			info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
			mi->sample_deferred++;
		}
	}
	mi->prev_sample = sample;

	/* If we're not using MRR and the sampling rate already
	 * has a probability of >95%, we shouldn't be attempting
	 * to use it, as this only wastes precious airtime */
	if (!mrr && sample && (mi->r[ndx].probability > 17100))
		ndx = mi->max_tp_rate;

	ar[0].idx = mi->r[ndx].rix;
	ar[0].count = minstrel_get_retry_count(&mi->r[ndx], info);

	if (!mrr) {
		if (!sample)
			ar[0].count = mp->max_retry;
		ar[1].idx = mi->lowest_rix;
		ar[1].count = mp->max_retry;
		return;
	}

	/* MRR setup */
	if (sample) {
		if (sample_slower)
			mrr_ndx[0] = sample_ndx;
		else
			mrr_ndx[0] = mi->max_tp_rate;
	} else {
		mrr_ndx[0] = mi->max_tp_rate2;
	}
	mrr_ndx[1] = mi->max_prob_rate;
	mrr_ndx[2] = 0;
	for (i = 1; i < 4; i++) {
		ar[i].idx = mi->r[mrr_ndx[i - 1]].rix;
		ar[i].count = mi->r[mrr_ndx[i - 1]].adjusted_retry_count;
	}
}


static void
calc_rate_durations(struct minstrel_sta_info *mi, struct ieee80211_local *local,
                    struct minstrel_rate *d, struct ieee80211_rate *rate)
{
	int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);

	d->perfect_tx_time = ieee80211_frame_duration(local, 1200,
			rate->bitrate, erp, 1);
	d->ack_time = ieee80211_frame_duration(local, 10,
			rate->bitrate, erp, 1);
}

static void
init_sample_table(struct minstrel_sta_info *mi)
{
	unsigned int i, col, new_idx;
	unsigned int n_srates = mi->n_rates - 1;
	u8 rnd[8];

	mi->sample_column = 0;
	mi->sample_idx = 0;
	memset(mi->sample_table, 0, SAMPLE_COLUMNS * mi->n_rates);

	for (col = 0; col < SAMPLE_COLUMNS; col++) {
		for (i = 0; i < n_srates; i++) {
			get_random_bytes(rnd, sizeof(rnd));
			new_idx = (i + rnd[i & 7]) % n_srates;

			while (SAMPLE_TBL(mi, new_idx, col) != 0)
				new_idx = (new_idx + 1) % n_srates;

			/* Don't sample the slowest rate (i.e. slowest base
			 * rate). We must presume that the slowest rate works
			 * fine, or else other management frames will also be
			 * failing and the link will break */
			SAMPLE_TBL(mi, new_idx, col) = i + 1;
		}
	}
}

static void
minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
               struct ieee80211_sta *sta, void *priv_sta)
{
	struct minstrel_sta_info *mi = priv_sta;
	struct minstrel_priv *mp = priv;
	struct ieee80211_local *local = hw_to_local(mp->hw);
	struct ieee80211_rate *ctl_rate;
	unsigned int i, n = 0;
	unsigned int t_slot = 9; /* FIXME: get real slot time */

	mi->lowest_rix = rate_lowest_index(sband, sta);
	ctl_rate = &sband->bitrates[mi->lowest_rix];
	mi->sp_ack_dur = ieee80211_frame_duration(local, 10, ctl_rate->bitrate,
				!!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1);

	for (i = 0; i < sband->n_bitrates; i++) {
		struct minstrel_rate *mr = &mi->r[n];
		unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
		unsigned int tx_time_single;
		unsigned int cw = mp->cw_min;

		if (!rate_supported(sta, sband->band, i))
			continue;
		n++;
		memset(mr, 0, sizeof(*mr));

		mr->rix = i;
		mr->bitrate = sband->bitrates[i].bitrate / 5;
		calc_rate_durations(mi, local, mr,
				&sband->bitrates[i]);

		/* calculate maximum number of retransmissions before
		 * fallback (based on maximum segment size) */
		mr->sample_limit = -1;
		mr->retry_count = 1;
		mr->retry_count_cts = 1;
		mr->retry_count_rtscts = 1;
		tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
		do {
			/* add one retransmission */
			tx_time_single = mr->ack_time + mr->perfect_tx_time;

			/* contention window */
			tx_time_single += t_slot + min(cw, mp->cw_max);
			cw = (cw + 1) << 1;

			tx_time += tx_time_single;
			tx_time_cts += tx_time_single + mi->sp_ack_dur;
			tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
			if ((tx_time_cts < mp->segment_size) &&
				(mr->retry_count_cts < mp->max_retry))
				mr->retry_count_cts++;
			if ((tx_time_rtscts < mp->segment_size) &&
				(mr->retry_count_rtscts < mp->max_retry))
				mr->retry_count_rtscts++;
		} while ((tx_time < mp->segment_size) &&
				(++mr->retry_count < mp->max_retry));
		mr->adjusted_retry_count = mr->retry_count;
	}

	for (i = n; i < sband->n_bitrates; i++) {
		struct minstrel_rate *mr = &mi->r[i];
		mr->rix = -1;
	}

	mi->n_rates = n;
	mi->stats_update = jiffies;

	init_sample_table(mi);
}

static void *
minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
{
	struct ieee80211_supported_band *sband;
	struct minstrel_sta_info *mi;
	struct minstrel_priv *mp = priv;
	struct ieee80211_hw *hw = mp->hw;
	int max_rates = 0;
	int i;

	mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
	if (!mi)
		return NULL;

	for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
		sband = hw->wiphy->bands[i];
		if (sband && sband->n_bitrates > max_rates)
			max_rates = sband->n_bitrates;
	}

	mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
	if (!mi->r)
		goto error;

	mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
	if (!mi->sample_table)
		goto error1;

	mi->stats_update = jiffies;
	return mi;

error1:
	kfree(mi->r);
error:
	kfree(mi);
	return NULL;
}

static void
minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
{
	struct minstrel_sta_info *mi = priv_sta;

	kfree(mi->sample_table);
	kfree(mi->r);
	kfree(mi);
}

static void *
minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
{
	struct minstrel_priv *mp;

	mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
	if (!mp)
		return NULL;

	/* contention window settings
	 * Just an approximation. Using the per-queue values would complicate
	 * the calculations and is probably unnecessary */
	mp->cw_min = 15;
	mp->cw_max = 1023;

	/* number of packets (in %) to use for sampling other rates
	 * sample less often for non-mrr packets, because the overhead
	 * is much higher than with mrr */
	mp->lookaround_rate = 5;
	mp->lookaround_rate_mrr = 10;

	/* moving average weight for EWMA */
	mp->ewma_level = 75;

	/* maximum time that the hw is allowed to stay in one MRR segment */
	mp->segment_size = 6000;

	if (hw->max_rate_tries > 0)
		mp->max_retry = hw->max_rate_tries;
	else
		/* safe default, does not necessarily have to match hw properties */
		mp->max_retry = 7;

	if (hw->max_rates >= 4)
		mp->has_mrr = true;

	mp->hw = hw;
	mp->update_interval = 100;

	return mp;
}

static void
minstrel_free(void *priv)
{
	kfree(priv);
}

static struct rate_control_ops mac80211_minstrel = {
	.name = "minstrel",
	.tx_status = minstrel_tx_status,
	.get_rate = minstrel_get_rate,
	.rate_init = minstrel_rate_init,
	.alloc = minstrel_alloc,
	.free = minstrel_free,
	.alloc_sta = minstrel_alloc_sta,
	.free_sta = minstrel_free_sta,
#ifdef CONFIG_MAC80211_DEBUGFS
	.add_sta_debugfs = minstrel_add_sta_debugfs,
	.remove_sta_debugfs = minstrel_remove_sta_debugfs,
#endif
};

int __init
rc80211_minstrel_init(void)
{
	return ieee80211_rate_control_register(&mac80211_minstrel);
}

void
rc80211_minstrel_exit(void)
{
	ieee80211_rate_control_unregister(&mac80211_minstrel);
}
Commit	Line	Data
cccf129f FF	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 <net/mac80211.h>
	54	#include "rate.h"
	55	#include "rc80211_minstrel.h"
	56
	57	#define SAMPLE_COLUMNS 10
	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;
3938b45c	69	WARN_ON(i < 0);
cccf129f FF	70	return i;
	71	}
	72
	73	static inline bool
	74	use_low_rate(struct sk_buff *skb)
	75	{
	76	struct ieee80211_hdr hdr = (struct ieee80211_hdr ) skb->data;
	77	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
e8986436	78	__le16 fc;
cccf129f	79
e8986436	80	fc = hdr->frame_control;
cccf129f	81
e8986436	82	return ((info->flags & IEEE80211_TX_CTL_NO_ACK) \|\| !ieee80211_is_data(fc));
cccf129f FF	83	}
	84
	85
	86	static void
	87	minstrel_update_stats(struct minstrel_priv mp, struct minstrel_sta_info mi)
	88	{
	89	u32 max_tp = 0, index_max_tp = 0, index_max_tp2 = 0;
	90	u32 max_prob = 0, index_max_prob = 0;
	91	u32 usecs;
	92	u32 p;
	93	int i;
	94
	95	mi->stats_update = jiffies;
	96	for (i = 0; i < mi->n_rates; i++) {
	97	struct minstrel_rate *mr = &mi->r[i];
	98
	99	usecs = mr->perfect_tx_time;
	100	if (!usecs)
	101	usecs = 1000000;
	102
	103	/* To avoid rounding issues, probabilities scale from 0 (0%)
	104	* to 18000 (100%) */
	105	if (mr->attempts) {
	106	p = (mr->success * 18000) / mr->attempts;
	107	mr->succ_hist += mr->success;
	108	mr->att_hist += mr->attempts;
	109	mr->cur_prob = p;
	110	p = ((p * (100 - mp->ewma_level)) + (mr->probability *
	111	mp->ewma_level)) / 100;
	112	mr->probability = p;
	113	mr->cur_tp = p * (1000000 / usecs);
	114	}
	115
	116	mr->last_success = mr->success;
	117	mr->last_attempts = mr->attempts;
	118	mr->success = 0;
	119	mr->attempts = 0;
	120
	121	/* Sample less often below the 10% chance of success.
	122	* Sample less often above the 95% chance of success. */
	123	if ((mr->probability > 17100) \|\| (mr->probability < 1800)) {
	124	mr->adjusted_retry_count = mr->retry_count >> 1;
	125	if (mr->adjusted_retry_count > 2)
	126	mr->adjusted_retry_count = 2;
f4a8cd94	127	mr->sample_limit = 4;
cccf129f	128	} else {
f4a8cd94	129	mr->sample_limit = -1;
cccf129f FF	130	mr->adjusted_retry_count = mr->retry_count;
	131	}
	132	if (!mr->adjusted_retry_count)
	133	mr->adjusted_retry_count = 2;
	134	}
	135
	136	for (i = 0; i < mi->n_rates; i++) {
	137	struct minstrel_rate *mr = &mi->r[i];
	138	if (max_tp < mr->cur_tp) {
	139	index_max_tp = i;
	140	max_tp = mr->cur_tp;
	141	}
	142	if (max_prob < mr->probability) {
	143	index_max_prob = i;
	144	max_prob = mr->probability;
	145	}
	146	}
	147
	148	max_tp = 0;
	149	for (i = 0; i < mi->n_rates; i++) {
	150	struct minstrel_rate *mr = &mi->r[i];
	151
	152	if (i == index_max_tp)
	153	continue;
	154
	155	if (max_tp < mr->cur_tp) {
	156	index_max_tp2 = i;
	157	max_tp = mr->cur_tp;
	158	}
	159	}
	160	mi->max_tp_rate = index_max_tp;
	161	mi->max_tp_rate2 = index_max_tp2;
	162	mi->max_prob_rate = index_max_prob;
	163	}
	164
	165	static void
	166	minstrel_tx_status(void priv, struct ieee80211_supported_band sband,
	167	struct ieee80211_sta sta, void priv_sta,
	168	struct sk_buff *skb)
	169	{
	170	struct minstrel_sta_info *mi = priv_sta;
	171	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
e6a9854b JB	172	struct ieee80211_tx_rate *ar = info->status.rates;
	173	int i, ndx;
	174	int success;
cccf129f	175
e6a9854b	176	success = !!(info->flags & IEEE80211_TX_STAT_ACK);
cccf129f	177
e6a9854b JB	178	for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
e6a9854b JB	179	if (ar[i].idx < 0)
cccf129f FF	180	break;
cccf129f FF	181
e6a9854b	182	ndx = rix_to_ndx(mi, ar[i].idx);
3938b45c LC	183	if (ndx < 0)
	184	continue;
	185
e6a9854b	186	mi->r[ndx].attempts += ar[i].count;
cccf129f	187
e6a9854b	188	if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
cccf129f FF	189	mi->r[ndx].success += success;
	190	}
	191
	192	if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
	193	mi->sample_count++;
	194
	195	if (mi->sample_deferred > 0)
	196	mi->sample_deferred--;
	197	}
	198
	199
	200	static inline unsigned int
	201	minstrel_get_retry_count(struct minstrel_rate *mr,
	202	struct ieee80211_tx_info *info)
	203	{
	204	unsigned int retry = mr->adjusted_retry_count;
	205
e6a9854b	206	if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_RTS_CTS)
cccf129f	207	retry = max(2U, min(mr->retry_count_rtscts, retry));
e6a9854b	208	else if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_CTS_PROTECT)
cccf129f FF	209	retry = max(2U, min(mr->retry_count_cts, retry));
	210	return retry;
	211	}
	212
	213
	214	static int
	215	minstrel_get_next_sample(struct minstrel_sta_info *mi)
	216	{
	217	unsigned int sample_ndx;
	218	sample_ndx = SAMPLE_TBL(mi, mi->sample_idx, mi->sample_column);
	219	mi->sample_idx++;
5ee58d7e	220	if ((int) mi->sample_idx > (mi->n_rates - 2)) {
cccf129f FF	221	mi->sample_idx = 0;
	222	mi->sample_column++;
	223	if (mi->sample_column >= SAMPLE_COLUMNS)
	224	mi->sample_column = 0;
	225	}
	226	return sample_ndx;
	227	}
	228
2df78167	229	static void
e6a9854b JB	230	minstrel_get_rate(void priv, struct ieee80211_sta sta,
e6a9854b JB	231	void priv_sta, struct ieee80211_tx_rate_control txrc)
cccf129f	232	{
e6a9854b JB	233	struct sk_buff *skb = txrc->skb;
e6a9854b JB	234	struct ieee80211_supported_band *sband = txrc->sband;
cccf129f FF	235	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
	236	struct minstrel_sta_info *mi = priv_sta;
	237	struct minstrel_priv *mp = priv;
e6a9854b	238	struct ieee80211_tx_rate *ar = info->control.rates;
cccf129f FF	239	unsigned int ndx, sample_ndx = 0;
	240	bool mrr;
	241	bool sample_slower = false;
	242	bool sample = false;
	243	int i, delta;
	244	int mrr_ndx[3];
	245	int sample_rate;
	246
	247	if (!sta \|\| !mi \|\| use_low_rate(skb)) {
e6a9854b	248	ar[0].idx = rate_lowest_index(sband, sta);
4edf040a GS	249	if (info->flags & IEEE80211_TX_CTL_NO_ACK)
	250	ar[0].count = 1;
	251	else
	252	ar[0].count = mp->max_retry;
cccf129f FF	253	return;
	254	}
	255
e6a9854b	256	mrr = mp->has_mrr && !txrc->rts && !txrc->bss_conf->use_cts_prot;
cccf129f FF	257
	258	if (time_after(jiffies, mi->stats_update + (mp->update_interval *
	259	HZ) / 1000))
	260	minstrel_update_stats(mp, mi);
	261
	262	ndx = mi->max_tp_rate;
	263
	264	if (mrr)
	265	sample_rate = mp->lookaround_rate_mrr;
	266	else
	267	sample_rate = mp->lookaround_rate;
	268
	269	mi->packet_count++;
	270	delta = (mi->packet_count * sample_rate / 100) -
	271	(mi->sample_count + mi->sample_deferred / 2);
	272
	273	/* delta > 0: sampling required */
f4a8cd94 FF	274	if ((delta > 0) && (mrr \|\| !mi->prev_sample)) {
f4a8cd94 FF	275	struct minstrel_rate *msr;
cccf129f FF	276	if (mi->packet_count >= 10000) {
	277	mi->sample_deferred = 0;
	278	mi->sample_count = 0;
	279	mi->packet_count = 0;
	280	} else if (delta > mi->n_rates * 2) {
	281	/* With multi-rate retry, not every planned sample
	282	* attempt actually gets used, due to the way the retry
	283	* chain is set up - [max_tp,sample,prob,lowest] for
	284	* sample_rate < max_tp.
	285	*
	286	* If there's too much sampling backlog and the link
	287	* starts getting worse, minstrel would start bursting
	288	* out lots of sampling frames, which would result
	289	* in a large throughput loss. */
	290	mi->sample_count += (delta - mi->n_rates * 2);
	291	}
	292
	293	sample_ndx = minstrel_get_next_sample(mi);
f4a8cd94	294	msr = &mi->r[sample_ndx];
cccf129f	295	sample = true;
f4a8cd94	296	sample_slower = mrr && (msr->perfect_tx_time >
cccf129f FF	297	mi->r[ndx].perfect_tx_time);
	298
	299	if (!sample_slower) {
f4a8cd94 FF	300	if (msr->sample_limit != 0) {
	301	ndx = sample_ndx;
	302	mi->sample_count++;
	303	if (msr->sample_limit > 0)
	304	msr->sample_limit--;
	305	} else {
	306	sample = false;
	307	}
cccf129f FF	308	} else {
	309	/* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
	310	* packets that have the sampling rate deferred to the
	311	* second MRR stage. Increase the sample counter only
	312	* if the deferred sample rate was actually used.
	313	* Use the sample_deferred counter to make sure that
	314	* the sampling is not done in large bursts */
	315	info->flags \|= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
	316	mi->sample_deferred++;
	317	}
	318	}
f4a8cd94 FF	319	mi->prev_sample = sample;
	320
	321	/* If we're not using MRR and the sampling rate already
	322	* has a probability of >95%, we shouldn't be attempting
	323	* to use it, as this only wastes precious airtime */
	324	if (!mrr && sample && (mi->r[ndx].probability > 17100))
	325	ndx = mi->max_tp_rate;
	326
e6a9854b JB	327	ar[0].idx = mi->r[ndx].rix;
e6a9854b JB	328	ar[0].count = minstrel_get_retry_count(&mi->r[ndx], info);
cccf129f FF	329
cccf129f FF	330	if (!mrr) {
f4a8cd94 FF	331	if (!sample)
f4a8cd94 FF	332	ar[0].count = mp->max_retry;
e6a9854b JB	333	ar[1].idx = mi->lowest_rix;
e6a9854b JB	334	ar[1].count = mp->max_retry;
cccf129f FF	335	return;
	336	}
	337
	338	/* MRR setup */
	339	if (sample) {
	340	if (sample_slower)
	341	mrr_ndx[0] = sample_ndx;
	342	else
	343	mrr_ndx[0] = mi->max_tp_rate;
	344	} else {
	345	mrr_ndx[0] = mi->max_tp_rate2;
	346	}
	347	mrr_ndx[1] = mi->max_prob_rate;
	348	mrr_ndx[2] = 0;
e6a9854b JB	349	for (i = 1; i < 4; i++) {
	350	ar[i].idx = mi->r[mrr_ndx[i - 1]].rix;
	351	ar[i].count = mi->r[mrr_ndx[i - 1]].adjusted_retry_count;
cccf129f FF	352	}
	353	}
	354
	355
	356	static void
	357	calc_rate_durations(struct minstrel_sta_info mi, struct ieee80211_local local,
	358	struct minstrel_rate d, struct ieee80211_rate rate)
	359	{
	360	int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
	361
	362	d->perfect_tx_time = ieee80211_frame_duration(local, 1200,
	363	rate->bitrate, erp, 1);
	364	d->ack_time = ieee80211_frame_duration(local, 10,
	365	rate->bitrate, erp, 1);
	366	}
	367
	368	static void
	369	init_sample_table(struct minstrel_sta_info *mi)
	370	{
	371	unsigned int i, col, new_idx;
	372	unsigned int n_srates = mi->n_rates - 1;
	373	u8 rnd[8];
	374
	375	mi->sample_column = 0;
	376	mi->sample_idx = 0;
	377	memset(mi->sample_table, 0, SAMPLE_COLUMNS * mi->n_rates);
	378
	379	for (col = 0; col < SAMPLE_COLUMNS; col++) {
	380	for (i = 0; i < n_srates; i++) {
	381	get_random_bytes(rnd, sizeof(rnd));
	382	new_idx = (i + rnd[i & 7]) % n_srates;
	383
	384	while (SAMPLE_TBL(mi, new_idx, col) != 0)
	385	new_idx = (new_idx + 1) % n_srates;
	386
	387	/* Don't sample the slowest rate (i.e. slowest base
	388	* rate). We must presume that the slowest rate works
	389	* fine, or else other management frames will also be
	390	* failing and the link will break */
	391	SAMPLE_TBL(mi, new_idx, col) = i + 1;
	392	}
	393	}
	394	}
	395
	396	static void
	397	minstrel_rate_init(void priv, struct ieee80211_supported_band sband,
	398	struct ieee80211_sta sta, void priv_sta)
	399	{
	400	struct minstrel_sta_info *mi = priv_sta;
	401	struct minstrel_priv *mp = priv;
d57854bb CL	402	struct ieee80211_local *local = hw_to_local(mp->hw);
d57854bb CL	403	struct ieee80211_rate *ctl_rate;
cccf129f FF	404	unsigned int i, n = 0;
	405	unsigned int t_slot = 9; /* FIXME: get real slot time */
	406
	407	mi->lowest_rix = rate_lowest_index(sband, sta);
d57854bb CL	408	ctl_rate = &sband->bitrates[mi->lowest_rix];
	409	mi->sp_ack_dur = ieee80211_frame_duration(local, 10, ctl_rate->bitrate,
	410	!!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1);
cccf129f FF	411
	412	for (i = 0; i < sband->n_bitrates; i++) {
	413	struct minstrel_rate *mr = &mi->r[n];
	414	unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
	415	unsigned int tx_time_single;
	416	unsigned int cw = mp->cw_min;
	417
	418	if (!rate_supported(sta, sband->band, i))
	419	continue;
	420	n++;
	421	memset(mr, 0, sizeof(*mr));
	422
	423	mr->rix = i;
	424	mr->bitrate = sband->bitrates[i].bitrate / 5;
d57854bb	425	calc_rate_durations(mi, local, mr,
cccf129f FF	426	&sband->bitrates[i]);
	427
	428	/* calculate maximum number of retransmissions before
	429	* fallback (based on maximum segment size) */
f4a8cd94	430	mr->sample_limit = -1;
cccf129f FF	431	mr->retry_count = 1;
	432	mr->retry_count_cts = 1;
	433	mr->retry_count_rtscts = 1;
	434	tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
	435	do {
	436	/* add one retransmission */
	437	tx_time_single = mr->ack_time + mr->perfect_tx_time;
	438
	439	/* contention window */
	440	tx_time_single += t_slot + min(cw, mp->cw_max);
	441	cw = (cw + 1) << 1;
	442
	443	tx_time += tx_time_single;
	444	tx_time_cts += tx_time_single + mi->sp_ack_dur;
	445	tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
	446	if ((tx_time_cts < mp->segment_size) &&
	447	(mr->retry_count_cts < mp->max_retry))
	448	mr->retry_count_cts++;
	449	if ((tx_time_rtscts < mp->segment_size) &&
	450	(mr->retry_count_rtscts < mp->max_retry))
	451	mr->retry_count_rtscts++;
	452	} while ((tx_time < mp->segment_size) &&
	453	(++mr->retry_count < mp->max_retry));
	454	mr->adjusted_retry_count = mr->retry_count;
	455	}
	456
	457	for (i = n; i < sband->n_bitrates; i++) {
	458	struct minstrel_rate *mr = &mi->r[i];
	459	mr->rix = -1;
	460	}
	461
	462	mi->n_rates = n;
	463	mi->stats_update = jiffies;
	464
	465	init_sample_table(mi);
	466	}
	467
	468	static void *
	469	minstrel_alloc_sta(void priv, struct ieee80211_sta sta, gfp_t gfp)
	470	{
	471	struct ieee80211_supported_band *sband;
	472	struct minstrel_sta_info *mi;
	473	struct minstrel_priv *mp = priv;
	474	struct ieee80211_hw *hw = mp->hw;
	475	int max_rates = 0;
	476	int i;
	477
	478	mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
	479	if (!mi)
	480	return NULL;
	481
	482	for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
8e532175	483	sband = hw->wiphy->bands[i];
621ad7c9	484	if (sband && sband->n_bitrates > max_rates)
cccf129f FF	485	max_rates = sband->n_bitrates;
	486	}
	487
	488	mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
	489	if (!mi->r)
	490	goto error;
	491
	492	mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
	493	if (!mi->sample_table)
	494	goto error1;
	495
	496	mi->stats_update = jiffies;
	497	return mi;
	498
	499	error1:
	500	kfree(mi->r);
	501	error:
	502	kfree(mi);
	503	return NULL;
	504	}
	505
	506	static void
	507	minstrel_free_sta(void priv, struct ieee80211_sta sta, void *priv_sta)
	508	{
	509	struct minstrel_sta_info *mi = priv_sta;
	510
	511	kfree(mi->sample_table);
	512	kfree(mi->r);
	513	kfree(mi);
	514	}
	515
cccf129f FF	516	static void *
	517	minstrel_alloc(struct ieee80211_hw hw, struct dentry debugfsdir)
	518	{
	519	struct minstrel_priv *mp;
	520
	521	mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
	522	if (!mp)
	523	return NULL;
	524
	525	/* contention window settings
	526	* Just an approximation. Using the per-queue values would complicate
	527	* the calculations and is probably unnecessary */
	528	mp->cw_min = 15;
	529	mp->cw_max = 1023;
	530
	531	/* number of packets (in %) to use for sampling other rates
	532	* sample less often for non-mrr packets, because the overhead
	533	* is much higher than with mrr */
	534	mp->lookaround_rate = 5;
	535	mp->lookaround_rate_mrr = 10;
	536
	537	/* moving average weight for EWMA */
	538	mp->ewma_level = 75;
	539
	540	/* maximum time that the hw is allowed to stay in one MRR segment */
	541	mp->segment_size = 6000;
	542
e6a9854b JB	543	if (hw->max_rate_tries > 0)
e6a9854b JB	544	mp->max_retry = hw->max_rate_tries;
cccf129f FF	545	else
	546	/* safe default, does not necessarily have to match hw properties */
	547	mp->max_retry = 7;
	548
e6a9854b	549	if (hw->max_rates >= 4)
cccf129f FF	550	mp->has_mrr = true;
	551
	552	mp->hw = hw;
	553	mp->update_interval = 100;
	554
	555	return mp;
	556	}
	557
	558	static void
	559	minstrel_free(void *priv)
	560	{
	561	kfree(priv);
	562	}
	563
	564	static struct rate_control_ops mac80211_minstrel = {
	565	.name = "minstrel",
	566	.tx_status = minstrel_tx_status,
	567	.get_rate = minstrel_get_rate,
	568	.rate_init = minstrel_rate_init,
cccf129f FF	569	.alloc = minstrel_alloc,
	570	.free = minstrel_free,
	571	.alloc_sta = minstrel_alloc_sta,
	572	.free_sta = minstrel_free_sta,
	573	#ifdef CONFIG_MAC80211_DEBUGFS
	574	.add_sta_debugfs = minstrel_add_sta_debugfs,
	575	.remove_sta_debugfs = minstrel_remove_sta_debugfs,
	576	#endif
	577	};
	578
	579	int __init
	580	rc80211_minstrel_init(void)
	581	{
	582	return ieee80211_rate_control_register(&mac80211_minstrel);
	583	}
	584
	585	void
	586	rc80211_minstrel_exit(void)
	587	{
	588	ieee80211_rate_control_unregister(&mac80211_minstrel);
	589	}
	590