[mirror_ubuntu-zesty-kernel.git] / net / mac80211 / rc80211_minstrel.h

/*
 * 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.
 */

#ifndef __RC_MINSTREL_H
#define __RC_MINSTREL_H

#define EWMA_LEVEL	96	/* ewma weighting factor [/EWMA_DIV] */
#define EWMA_DIV	128
#define SAMPLE_COLUMNS	10	/* number of columns in sample table */


/* scaled fraction values */
#define MINSTREL_SCALE  16
#define MINSTREL_FRAC(val, div) (((val) << MINSTREL_SCALE) / div)
#define MINSTREL_TRUNC(val) ((val) >> MINSTREL_SCALE)

/* number of highest throughput rates to consider*/
#define MAX_THR_RATES 4

/*
 * Perform EWMA (Exponentially Weighted Moving Average) calculation
  */
static inline int
minstrel_ewma(int old, int new, int weight)
{
	return (new * (EWMA_DIV - weight) + old * weight) / EWMA_DIV;
}

struct minstrel_rate_stats {
	/* current / last sampling period attempts/success counters */
	unsigned int attempts, last_attempts;
	unsigned int success, last_success;

	/* total attempts/success counters */
	u64 att_hist, succ_hist;

	/* current throughput */
	unsigned int cur_tp;

	/* packet delivery probabilities */
	unsigned int cur_prob, probability;

	/* maximum retry counts */
	unsigned int retry_count;
	unsigned int retry_count_rtscts;

	u8 sample_skipped;
	bool retry_updated;
};

struct minstrel_rate {
	int bitrate;
	int rix;

	unsigned int perfect_tx_time;
	unsigned int ack_time;

	int sample_limit;
	unsigned int retry_count_cts;
	unsigned int adjusted_retry_count;

	struct minstrel_rate_stats stats;
};

struct minstrel_sta_info {
	struct ieee80211_sta *sta;

	unsigned long stats_update;
	unsigned int sp_ack_dur;
	unsigned int rate_avg;

	unsigned int lowest_rix;

	u8 max_tp_rate[MAX_THR_RATES];
	u8 max_prob_rate;
	unsigned int total_packets;
	unsigned int sample_packets;
	int sample_deferred;

	unsigned int sample_row;
	unsigned int sample_column;

	int n_rates;
	struct minstrel_rate *r;
	bool prev_sample;

	/* sampling table */
	u8 *sample_table;

#ifdef CONFIG_MAC80211_DEBUGFS
	struct dentry *dbg_stats;
#endif
};

struct minstrel_priv {
	struct ieee80211_hw *hw;
	bool has_mrr;
	unsigned int cw_min;
	unsigned int cw_max;
	unsigned int max_retry;
	unsigned int segment_size;
	unsigned int update_interval;
	unsigned int lookaround_rate;
	unsigned int lookaround_rate_mrr;

	u8 cck_rates[4];

#ifdef CONFIG_MAC80211_DEBUGFS
	/*
	 * enable fixed rate processing per RC
	 *   - write static index to debugfs:ieee80211/phyX/rc/fixed_rate_idx
	 *   - write -1 to enable RC processing again
	 *   - setting will be applied on next update
	 */
	u32 fixed_rate_idx;
	struct dentry *dbg_fixed_rate;
#endif

};

struct minstrel_debugfs_info {
	size_t len;
	char buf[];
};

extern const struct rate_control_ops mac80211_minstrel;
void minstrel_add_sta_debugfs(void *priv, void *priv_sta, struct dentry *dir);
void minstrel_remove_sta_debugfs(void *priv, void *priv_sta);

/* debugfs */
int minstrel_stats_open(struct inode *inode, struct file *file);
ssize_t minstrel_stats_read(struct file *file, char __user *buf, size_t len, loff_t *ppos);
int minstrel_stats_release(struct inode *inode, struct file *file);

#endif
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
	9	#ifndef __RC_MINSTREL_H
	10	#define __RC_MINSTREL_H
	11
eea85999 KB	12	#define EWMA_LEVEL 96 /* ewma weighting factor [/EWMA_DIV] */
eea85999 KB	13	#define EWMA_DIV 128
f744bf81 TH	14	#define SAMPLE_COLUMNS 10 /* number of columns in sample table */
f744bf81 TH	15
a512d4b5	16
c8ca8c2f TH	17	/* scaled fraction values */
	18	#define MINSTREL_SCALE 16
	19	#define MINSTREL_FRAC(val, div) (((val) << MINSTREL_SCALE) / div)
	20	#define MINSTREL_TRUNC(val) ((val) >> MINSTREL_SCALE)
	21
2ff2b690 TH	22	/* number of highest throughput rates to consider*/
	23	#define MAX_THR_RATES 4
	24
a512d4b5 TH	25	/*
	26	* Perform EWMA (Exponentially Weighted Moving Average) calculation
	27	*/
	28	static inline int
	29	minstrel_ewma(int old, int new, int weight)
	30	{
eea85999	31	return (new * (EWMA_DIV - weight) + old * weight) / EWMA_DIV;
a512d4b5 TH	32	}
a512d4b5 TH	33
ca12c0c8 TH	34	struct minstrel_rate_stats {
	35	/* current / last sampling period attempts/success counters */
	36	unsigned int attempts, last_attempts;
	37	unsigned int success, last_success;
	38
	39	/* total attempts/success counters */
	40	u64 att_hist, succ_hist;
	41
	42	/* current throughput */
	43	unsigned int cur_tp;
	44
	45	/* packet delivery probabilities */
	46	unsigned int cur_prob, probability;
	47
	48	/* maximum retry counts */
	49	unsigned int retry_count;
	50	unsigned int retry_count_rtscts;
	51
	52	u8 sample_skipped;
	53	bool retry_updated;
	54	};
a512d4b5	55
cccf129f FF	56	struct minstrel_rate {
	57	int bitrate;
	58	int rix;
	59
	60	unsigned int perfect_tx_time;
	61	unsigned int ack_time;
	62
f4a8cd94	63	int sample_limit;
cccf129f	64	unsigned int retry_count_cts;
cccf129f FF	65	unsigned int adjusted_retry_count;
cccf129f FF	66
ca12c0c8	67	struct minstrel_rate_stats stats;
cccf129f FF	68	};
	69
	70	struct minstrel_sta_info {
06d961a8 FF	71	struct ieee80211_sta *sta;
06d961a8 FF	72
cccf129f FF	73	unsigned long stats_update;
	74	unsigned int sp_ack_dur;
	75	unsigned int rate_avg;
	76
	77	unsigned int lowest_rix;
	78
2ff2b690 TH	79	u8 max_tp_rate[MAX_THR_RATES];
2ff2b690 TH	80	u8 max_prob_rate;
ca12c0c8 TH	81	unsigned int total_packets;
ca12c0c8 TH	82	unsigned int sample_packets;
cccf129f FF	83	int sample_deferred;
cccf129f FF	84
8f157611	85	unsigned int sample_row;
cccf129f FF	86	unsigned int sample_column;
	87
	88	int n_rates;
	89	struct minstrel_rate *r;
f4a8cd94	90	bool prev_sample;
cccf129f FF	91
	92	/* sampling table */
	93	u8 *sample_table;
	94
	95	#ifdef CONFIG_MAC80211_DEBUGFS
	96	struct dentry *dbg_stats;
	97	#endif
	98	};
	99
	100	struct minstrel_priv {
	101	struct ieee80211_hw *hw;
	102	bool has_mrr;
	103	unsigned int cw_min;
	104	unsigned int cw_max;
	105	unsigned int max_retry;
cccf129f FF	106	unsigned int segment_size;
	107	unsigned int update_interval;
	108	unsigned int lookaround_rate;
	109	unsigned int lookaround_rate_mrr;
24f7580e	110
a0497f9f FF	111	u8 cck_rates[4];
a0497f9f FF	112
24f7580e ZK	113	#ifdef CONFIG_MAC80211_DEBUGFS
	114	/*
	115	* enable fixed rate processing per RC
	116	* - write static index to debugfs:ieee80211/phyX/rc/fixed_rate_idx
	117	* - write -1 to enable RC processing again
	118	* - setting will be applied on next update
	119	*/
	120	u32 fixed_rate_idx;
	121	struct dentry *dbg_fixed_rate;
	122	#endif
	123
cccf129f FF	124	};
cccf129f FF	125
44ac91ea FF	126	struct minstrel_debugfs_info {
	127	size_t len;
	128	char buf[];
	129	};
	130
631ad703	131	extern const struct rate_control_ops mac80211_minstrel;
cccf129f FF	132	void minstrel_add_sta_debugfs(void priv, void priv_sta, struct dentry *dir);
	133	void minstrel_remove_sta_debugfs(void priv, void priv_sta);
	134
eae44756 FF	135	/* debugfs */
	136	int minstrel_stats_open(struct inode inode, struct file file);
	137	ssize_t minstrel_stats_read(struct file file, char __user buf, size_t len, loff_t *ppos);
	138	int minstrel_stats_release(struct inode inode, struct file file);
	139
cccf129f	140	#endif