net/mac80211/rc80211_minstrel_ht.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2010 Felix Fietkau <nbd@openwrt.org>
   4  */
   5
   6 #ifndef __RC_MINSTREL_HT_H
   7 #define __RC_MINSTREL_HT_H
   8
   9 #include <linux/bitfield.h>
  10
  11 /* number of highest throughput rates to consider*/
  12 #define MAX_THR_RATES 4
  13 #define SAMPLE_COLUMNS  10      /* number of columns in sample table */
  14
  15 /* scaled fraction values */
  16 #define MINSTREL_SCALE  12
  17 #define MINSTREL_FRAC(val, div) (((val) << MINSTREL_SCALE) / div)
  18 #define MINSTREL_TRUNC(val) ((val) >> MINSTREL_SCALE)
  19
  20 #define EWMA_LEVEL      96      /* ewma weighting factor [/EWMA_DIV] */
  21 #define EWMA_DIV        128
  22
  23 /*
  24  * Coefficients for moving average with noise filter (period=16),
  25  * scaled by 10 bits
  26  *
  27  * a1 = exp(-pi * sqrt(2) / period)
  28  * coeff2 = 2 * a1 * cos(sqrt(2) * 2 * pi / period)
  29  * coeff3 = -sqr(a1)
  30  * coeff1 = 1 - coeff2 - coeff3
  31  */
  32 #define MINSTREL_AVG_COEFF1             (MINSTREL_FRAC(1, 1) - \
  33                                          MINSTREL_AVG_COEFF2 - \
  34                                          MINSTREL_AVG_COEFF3)
  35 #define MINSTREL_AVG_COEFF2             0x00001499
  36 #define MINSTREL_AVG_COEFF3             -0x0000092e
  37
  38 /*
  39  * The number of streams can be changed to 2 to reduce code
  40  * size and memory footprint.
  41  */
  42 #define MINSTREL_MAX_STREAMS            4
  43 #define MINSTREL_HT_STREAM_GROUPS       4 /* BW(=2) * SGI(=2) */
  44 #define MINSTREL_VHT_STREAM_GROUPS      6 /* BW(=3) * SGI(=2) */
  45
  46 #define MINSTREL_HT_GROUPS_NB   (MINSTREL_MAX_STREAMS *         \
  47                                  MINSTREL_HT_STREAM_GROUPS)
  48 #define MINSTREL_VHT_GROUPS_NB  (MINSTREL_MAX_STREAMS *         \
  49                                  MINSTREL_VHT_STREAM_GROUPS)
  50 #define MINSTREL_LEGACY_GROUPS_NB       2
  51 #define MINSTREL_GROUPS_NB      (MINSTREL_HT_GROUPS_NB +        \
  52                                  MINSTREL_VHT_GROUPS_NB +       \
  53                                  MINSTREL_LEGACY_GROUPS_NB)
  54
  55 #define MINSTREL_HT_GROUP_0     0
  56 #define MINSTREL_CCK_GROUP      (MINSTREL_HT_GROUP_0 + MINSTREL_HT_GROUPS_NB)
  57 #define MINSTREL_OFDM_GROUP     (MINSTREL_CCK_GROUP + 1)
  58 #define MINSTREL_VHT_GROUP_0    (MINSTREL_OFDM_GROUP + 1)
  59
  60 #define MCS_GROUP_RATES         10
  61
  62 #define MI_RATE_IDX_MASK        GENMASK(3, 0)
  63 #define MI_RATE_GROUP_MASK      GENMASK(15, 4)
  64
  65 #define MI_RATE(_group, _idx)                           \
  66         (FIELD_PREP(MI_RATE_GROUP_MASK, _group) |       \
  67          FIELD_PREP(MI_RATE_IDX_MASK, _idx))
  68
  69 #define MI_RATE_IDX(_rate) FIELD_GET(MI_RATE_IDX_MASK, _rate)
  70 #define MI_RATE_GROUP(_rate) FIELD_GET(MI_RATE_GROUP_MASK, _rate)
  71
  72 #define MINSTREL_SAMPLE_RATES           5 /* rates per sample type */
  73 #define MINSTREL_SAMPLE_INTERVAL        (HZ / 50)
  74
  75 struct minstrel_priv {
  76         struct ieee80211_hw *hw;
  77         bool has_mrr;
  78         u32 sample_switch;
  79         unsigned int cw_min;
  80         unsigned int cw_max;
  81         unsigned int max_retry;
  82         unsigned int segment_size;
  83         unsigned int update_interval;
  84
  85         u8 cck_rates[4];
  86         u8 ofdm_rates[NUM_NL80211_BANDS][8];
  87
  88 #ifdef CONFIG_MAC80211_DEBUGFS
  89         /*
  90          * enable fixed rate processing per RC
  91          *   - write static index to debugfs:ieee80211/phyX/rc/fixed_rate_idx
  92          *   - write -1 to enable RC processing again
  93          *   - setting will be applied on next update
  94          */
  95         u32 fixed_rate_idx;
  96 #endif
  97 };
  98
  99
 100 struct mcs_group {
 101         u16 flags;
 102         u8 streams;
 103         u8 shift;
 104         u8 bw;
 105         u16 duration[MCS_GROUP_RATES];
 106 };
 107
 108 extern const s16 minstrel_cck_bitrates[4];
 109 extern const s16 minstrel_ofdm_bitrates[8];
 110 extern const struct mcs_group minstrel_mcs_groups[];
 111
 112 struct minstrel_rate_stats {
 113         /* current / last sampling period attempts/success counters */
 114         u16 attempts, last_attempts;
 115         u16 success, last_success;
 116
 117         /* total attempts/success counters */
 118         u32 att_hist, succ_hist;
 119
 120         /* prob_avg - moving average of prob */
 121         u16 prob_avg;
 122         u16 prob_avg_1;
 123
 124         /* maximum retry counts */
 125         u8 retry_count;
 126         u8 retry_count_rtscts;
 127
 128         bool retry_updated;
 129 };
 130
 131 enum minstrel_sample_type {
 132         MINSTREL_SAMPLE_TYPE_INC,
 133         MINSTREL_SAMPLE_TYPE_JUMP,
 134         MINSTREL_SAMPLE_TYPE_SLOW,
 135         __MINSTREL_SAMPLE_TYPE_MAX
 136 };
 137
 138 struct minstrel_mcs_group_data {
 139         u8 index;
 140         u8 column;
 141
 142         /* sorted rate set within a MCS group*/
 143         u16 max_group_tp_rate[MAX_THR_RATES];
 144         u16 max_group_prob_rate;
 145
 146         /* MCS rate statistics */
 147         struct minstrel_rate_stats rates[MCS_GROUP_RATES];
 148 };
 149
 150 enum minstrel_sample_mode {
 151         MINSTREL_SAMPLE_IDLE,
 152         MINSTREL_SAMPLE_ACTIVE,
 153         MINSTREL_SAMPLE_PENDING,
 154 };
 155
 156 struct minstrel_sample_category {
 157         u8 sample_group;
 158         u16 sample_rates[MINSTREL_SAMPLE_RATES];
 159         u16 cur_sample_rates[MINSTREL_SAMPLE_RATES];
 160 };
 161
 162 struct minstrel_ht_sta {
 163         struct ieee80211_sta *sta;
 164
 165         /* ampdu length (average, per sampling interval) */
 166         unsigned int ampdu_len;
 167         unsigned int ampdu_packets;
 168
 169         /* ampdu length (EWMA) */
 170         unsigned int avg_ampdu_len;
 171
 172         /* overall sorted rate set */
 173         u16 max_tp_rate[MAX_THR_RATES];
 174         u16 max_prob_rate;
 175
 176         /* time of last status update */
 177         unsigned long last_stats_update;
 178
 179         /* overhead time in usec for each frame */
 180         unsigned int overhead;
 181         unsigned int overhead_rtscts;
 182         unsigned int overhead_legacy;
 183         unsigned int overhead_legacy_rtscts;
 184
 185         unsigned int total_packets_last;
 186         unsigned int total_packets_cur;
 187         unsigned int total_packets;
 188         unsigned int sample_packets;
 189
 190         /* tx flags to add for frames for this sta */
 191         u32 tx_flags;
 192
 193         unsigned long sample_time;
 194         struct minstrel_sample_category sample[__MINSTREL_SAMPLE_TYPE_MAX];
 195
 196         u8 sample_seq;
 197
 198         enum minstrel_sample_mode sample_mode;
 199         u16 sample_rate;
 200
 201         u8 band;
 202
 203         /* Bitfield of supported MCS rates of all groups */
 204         u16 supported[MINSTREL_GROUPS_NB];
 205
 206         /* MCS rate group info and statistics */
 207         struct minstrel_mcs_group_data groups[MINSTREL_GROUPS_NB];
 208 };
 209
 210 void minstrel_ht_add_sta_debugfs(void *priv, void *priv_sta, struct dentry *dir);
 211 int minstrel_ht_get_tp_avg(struct minstrel_ht_sta *mi, int group, int rate,
 212                            int prob_avg);
 213
 214 #endif