1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #ifndef __RC_MINSTREL_H
7*4882a593Smuzhiyun #define __RC_MINSTREL_H
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #define EWMA_LEVEL 96 /* ewma weighting factor [/EWMA_DIV] */
10*4882a593Smuzhiyun #define EWMA_DIV 128
11*4882a593Smuzhiyun #define SAMPLE_COLUMNS 10 /* number of columns in sample table */
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun /* scaled fraction values */
14*4882a593Smuzhiyun #define MINSTREL_SCALE 12
15*4882a593Smuzhiyun #define MINSTREL_FRAC(val, div) (((val) << MINSTREL_SCALE) / div)
16*4882a593Smuzhiyun #define MINSTREL_TRUNC(val) ((val) >> MINSTREL_SCALE)
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun /* number of highest throughput rates to consider*/
19*4882a593Smuzhiyun #define MAX_THR_RATES 4
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun /*
22*4882a593Smuzhiyun * Coefficients for moving average with noise filter (period=16),
23*4882a593Smuzhiyun * scaled by 10 bits
24*4882a593Smuzhiyun *
25*4882a593Smuzhiyun * a1 = exp(-pi * sqrt(2) / period)
26*4882a593Smuzhiyun * coeff2 = 2 * a1 * cos(sqrt(2) * 2 * pi / period)
27*4882a593Smuzhiyun * coeff3 = -sqr(a1)
28*4882a593Smuzhiyun * coeff1 = 1 - coeff2 - coeff3
29*4882a593Smuzhiyun */
30*4882a593Smuzhiyun #define MINSTREL_AVG_COEFF1 (MINSTREL_FRAC(1, 1) - \
31*4882a593Smuzhiyun MINSTREL_AVG_COEFF2 - \
32*4882a593Smuzhiyun MINSTREL_AVG_COEFF3)
33*4882a593Smuzhiyun #define MINSTREL_AVG_COEFF2 0x00001499
34*4882a593Smuzhiyun #define MINSTREL_AVG_COEFF3 -0x0000092e
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun /*
37*4882a593Smuzhiyun * Perform EWMA (Exponentially Weighted Moving Average) calculation
38*4882a593Smuzhiyun */
39*4882a593Smuzhiyun static inline int
minstrel_ewma(int old,int new,int weight)40*4882a593Smuzhiyun minstrel_ewma(int old, int new, int weight)
41*4882a593Smuzhiyun {
42*4882a593Smuzhiyun int diff, incr;
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun diff = new - old;
45*4882a593Smuzhiyun incr = (EWMA_DIV - weight) * diff / EWMA_DIV;
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun return old + incr;
48*4882a593Smuzhiyun }
49*4882a593Smuzhiyun
minstrel_filter_avg_add(u16 * prev_1,u16 * prev_2,s32 in)50*4882a593Smuzhiyun static inline int minstrel_filter_avg_add(u16 *prev_1, u16 *prev_2, s32 in)
51*4882a593Smuzhiyun {
52*4882a593Smuzhiyun s32 out_1 = *prev_1;
53*4882a593Smuzhiyun s32 out_2 = *prev_2;
54*4882a593Smuzhiyun s32 val;
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun if (!in)
57*4882a593Smuzhiyun in += 1;
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun if (!out_1) {
60*4882a593Smuzhiyun val = out_1 = in;
61*4882a593Smuzhiyun goto out;
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun val = MINSTREL_AVG_COEFF1 * in;
65*4882a593Smuzhiyun val += MINSTREL_AVG_COEFF2 * out_1;
66*4882a593Smuzhiyun val += MINSTREL_AVG_COEFF3 * out_2;
67*4882a593Smuzhiyun val >>= MINSTREL_SCALE;
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun if (val > 1 << MINSTREL_SCALE)
70*4882a593Smuzhiyun val = 1 << MINSTREL_SCALE;
71*4882a593Smuzhiyun if (val < 0)
72*4882a593Smuzhiyun val = 1;
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun out:
75*4882a593Smuzhiyun *prev_2 = out_1;
76*4882a593Smuzhiyun *prev_1 = val;
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun return val;
79*4882a593Smuzhiyun }
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun struct minstrel_rate_stats {
82*4882a593Smuzhiyun /* current / last sampling period attempts/success counters */
83*4882a593Smuzhiyun u16 attempts, last_attempts;
84*4882a593Smuzhiyun u16 success, last_success;
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun /* total attempts/success counters */
87*4882a593Smuzhiyun u32 att_hist, succ_hist;
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun /* prob_avg - moving average of prob */
90*4882a593Smuzhiyun u16 prob_avg;
91*4882a593Smuzhiyun u16 prob_avg_1;
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun /* maximum retry counts */
94*4882a593Smuzhiyun u8 retry_count;
95*4882a593Smuzhiyun u8 retry_count_rtscts;
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun u8 sample_skipped;
98*4882a593Smuzhiyun bool retry_updated;
99*4882a593Smuzhiyun };
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun struct minstrel_rate {
102*4882a593Smuzhiyun int bitrate;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun s8 rix;
105*4882a593Smuzhiyun u8 retry_count_cts;
106*4882a593Smuzhiyun u8 adjusted_retry_count;
107*4882a593Smuzhiyun
108*4882a593Smuzhiyun unsigned int perfect_tx_time;
109*4882a593Smuzhiyun unsigned int ack_time;
110*4882a593Smuzhiyun
111*4882a593Smuzhiyun int sample_limit;
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun struct minstrel_rate_stats stats;
114*4882a593Smuzhiyun };
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun struct minstrel_sta_info {
117*4882a593Smuzhiyun struct ieee80211_sta *sta;
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun unsigned long last_stats_update;
120*4882a593Smuzhiyun unsigned int sp_ack_dur;
121*4882a593Smuzhiyun unsigned int rate_avg;
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun unsigned int lowest_rix;
124*4882a593Smuzhiyun
125*4882a593Smuzhiyun u8 max_tp_rate[MAX_THR_RATES];
126*4882a593Smuzhiyun u8 max_prob_rate;
127*4882a593Smuzhiyun unsigned int total_packets;
128*4882a593Smuzhiyun unsigned int sample_packets;
129*4882a593Smuzhiyun
130*4882a593Smuzhiyun unsigned int sample_row;
131*4882a593Smuzhiyun unsigned int sample_column;
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun int n_rates;
134*4882a593Smuzhiyun struct minstrel_rate *r;
135*4882a593Smuzhiyun bool prev_sample;
136*4882a593Smuzhiyun
137*4882a593Smuzhiyun /* sampling table */
138*4882a593Smuzhiyun u8 *sample_table;
139*4882a593Smuzhiyun };
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun struct minstrel_priv {
142*4882a593Smuzhiyun struct ieee80211_hw *hw;
143*4882a593Smuzhiyun bool has_mrr;
144*4882a593Smuzhiyun bool new_avg;
145*4882a593Smuzhiyun u32 sample_switch;
146*4882a593Smuzhiyun unsigned int cw_min;
147*4882a593Smuzhiyun unsigned int cw_max;
148*4882a593Smuzhiyun unsigned int max_retry;
149*4882a593Smuzhiyun unsigned int segment_size;
150*4882a593Smuzhiyun unsigned int update_interval;
151*4882a593Smuzhiyun unsigned int lookaround_rate;
152*4882a593Smuzhiyun unsigned int lookaround_rate_mrr;
153*4882a593Smuzhiyun
154*4882a593Smuzhiyun u8 cck_rates[4];
155*4882a593Smuzhiyun
156*4882a593Smuzhiyun #ifdef CONFIG_MAC80211_DEBUGFS
157*4882a593Smuzhiyun /*
158*4882a593Smuzhiyun * enable fixed rate processing per RC
159*4882a593Smuzhiyun * - write static index to debugfs:ieee80211/phyX/rc/fixed_rate_idx
160*4882a593Smuzhiyun * - write -1 to enable RC processing again
161*4882a593Smuzhiyun * - setting will be applied on next update
162*4882a593Smuzhiyun */
163*4882a593Smuzhiyun u32 fixed_rate_idx;
164*4882a593Smuzhiyun #endif
165*4882a593Smuzhiyun };
166*4882a593Smuzhiyun
167*4882a593Smuzhiyun struct minstrel_debugfs_info {
168*4882a593Smuzhiyun size_t len;
169*4882a593Smuzhiyun char buf[];
170*4882a593Smuzhiyun };
171*4882a593Smuzhiyun
172*4882a593Smuzhiyun extern const struct rate_control_ops mac80211_minstrel;
173*4882a593Smuzhiyun void minstrel_add_sta_debugfs(void *priv, void *priv_sta, struct dentry *dir);
174*4882a593Smuzhiyun
175*4882a593Smuzhiyun /* Recalculate success probabilities and counters for a given rate using EWMA */
176*4882a593Smuzhiyun void minstrel_calc_rate_stats(struct minstrel_priv *mp,
177*4882a593Smuzhiyun struct minstrel_rate_stats *mrs);
178*4882a593Smuzhiyun int minstrel_get_tp_avg(struct minstrel_rate *mr, int prob_avg);
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun /* debugfs */
181*4882a593Smuzhiyun int minstrel_stats_open(struct inode *inode, struct file *file);
182*4882a593Smuzhiyun int minstrel_stats_csv_open(struct inode *inode, struct file *file);
183*4882a593Smuzhiyun
184*4882a593Smuzhiyun #endif
185