[mirror_ubuntu-focal-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	75	/* ewma weighting factor [%] */
#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 * (100 - weight) + old * weight) / 100;
}


struct minstrel_rate {
	int bitrate;
	int rix;

	unsigned int perfect_tx_time;
	unsigned int ack_time;

	int sample_limit;
	unsigned int retry_count;
	unsigned int retry_count_cts;
	unsigned int retry_count_rtscts;
	unsigned int adjusted_retry_count;

	u32 success;
	u32 attempts;
	u32 last_attempts;
	u32 last_success;
	u8 sample_skipped;

	/* parts per thousand */
	u32 cur_prob;
	u32 probability;

	/* per-rate throughput */
	u32 cur_tp;

	u64 succ_hist;
	u64 att_hist;
};

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