/space/home/slher/rel/Beken/v6_4_5/macsw/ip/umac/src/rc/rc.h

Go to the documentation of this file.

#ifndef _RC_ENABLE_H_
#define _RC_ENABLE_H_

/*
 * INCLUDE FILES
 ****************************************************************************************
 */
// standard includes
#include "co_int.h"

// for number of rate control steps
#include "hal_desc.h"
// for struct sta_pol_tbl_cntl and struct sta_info_tag
#include "sta_mgmt.h"

/*
 * DEFINES
 ****************************************************************************************
 */
#define RC_USE_MAX_BW         0
#define RC_MAX_NUM_RETRY         (2)
#define RC_PERIOD_TOUT           (100000)
#if RC_PERIOD_TOUT > 200000
#error "RC_PERIOD_TOUT shall be 200ms maximum"
#endif

#define RC_TRIAL_PERIOD          (10)
#define RC_MAX_N_SAMPLE          (10)
#define RC_HE_STATS_IDX          RC_MAX_N_SAMPLE

#define RC_SCALE                 (16)
#define EWMA_LEVEL               (96)
#define EWMA_DIV                 (128)

#define RC_FRAC(val, div)        (((val) << RC_SCALE) / (div))

#define RC_TRUNC(val)            ((val) >> RC_SCALE)

#define DIV_ROUND_UP(n, d)       (((n) + (d) - 1) / (d))

#define RC_FIXED_RATE_NOT_SET    (0xFFFF)

#define RC_AGG_TX_MASK           CO_BIT(1)
#define RC_AGG_ALLOWED_OFT       (2)
#define RC_AGG_ALLOWED_MASK      CO_BIT(RC_AGG_ALLOWED_OFT)
#define RC_FIX_RATE_STATUS_OFT   (4)
#define RC_FIX_RATE_STATUS_MASK  (3 << RC_FIX_RATE_STATUS_OFT)
#define RC_FIX_RATE_NOTEN_MASK   (0 << RC_FIX_RATE_STATUS_OFT)
#define RC_FIX_RATE_REQ_MASK     (1 << RC_FIX_RATE_STATUS_OFT)
#define RC_FIX_RATE_EN_MASK      (2 << RC_FIX_RATE_STATUS_OFT)
#define RC_SS_UPD_REQ_MASK       CO_BIT(6)
#define RC_FIX_RATE_UPD_SS_REQ_MASK   CO_BIT(7)

#define RC_SW_RETRY_STEP_OFT     0
#define RC_SW_RETRY_STEP_MSK     (0x03 << RC_SW_RETRY_STEP_OFT)
#define RC_RETRY_CHAIN_VER_OFT   2
#define RC_RETRY_CHAIN_VER_MSK   (0x03 << RC_RETRY_CHAIN_VER_OFT)
#define RC_CONTROL_GET(rc_control, field) (((rc_control) & RC_##field##_MSK) >> RC_##field##_OFT)

#define RC_TRIAL_STATUS_WAIT       (0)
#define RC_TRIAL_STATUS_WAIT_CFM   (1)


/*
 * STRUCTURES/TYPES DEFINITION
 ****************************************************************************************
 */

struct rc_rate_stats
{
    uint16_t attempts;
    uint16_t success;
    uint16_t probability;
    uint16_t rate_config;
    union
    {
        struct {
            uint8_t  sample_skipped;
            bool  old_prob_available;
            bool rate_allowed;
        };
        struct {
            uint16_t ru_and_length;
        };
    };
};

struct rc_sta_stats
{
    uint32_t last_rc_time;
    struct rc_rate_stats rate_stats[RC_MAX_N_SAMPLE + NX_HE];
    uint16_t retry_step_idx[RATE_CONTROL_STEPS];
    uint16_t ampdu_len;
    uint16_t ampdu_packets;
    uint32_t avg_ampdu_len;
    uint16_t sample_wait;
    uint8_t sample_slow;
    uint8_t trial_status;
    uint32_t trial_rate;
    uint8_t trial_idx;
    uint8_t info;
    uint8_t retry_chain_ver;
    uint8_t sw_retry_step;
    uint8_t format_mod;
    union
    {
        uint8_t     ht[4];
        #if NX_VHT
        uint16_t    vht;
        #endif
        #if NX_HE
        uint16_t    he;
        #endif
    } rate_map;
    uint16_t rate_map_l;
    uint8_t mcs_max;
    uint8_t r_idx_min;
    uint8_t r_idx_max;
    uint8_t bw_max;
    uint8_t no_ss;
    uint8_t short_gi;
    uint8_t type;
    uint16_t no_samples;
    uint16_t max_amsdu_len;
    uint16_t curr_amsdu_len;
    uint16_t fixed_rate_cfg;
};

/*
 * GLOBAL VARIABLES
 ****************************************************************************************
 */

/*
 * FUNCTION PROTOTYPES
 ****************************************************************************************
 */

__INLINE uint16_t rc_get_max_amsdu_len(struct sta_info_tag *sta)
{
    struct sta_pol_tbl_cntl *pt = &sta->pol_tbl;
    struct rc_sta_stats *rc_ss = pt->sta_stats;

    return rc_ss->curr_amsdu_len;
}

__INLINE struct rc_sta_stats* rc_get_sta_stats(uint8_t sta_idx)
{
    struct sta_info_tag *sta = &sta_info_tab[sta_idx];
    struct sta_pol_tbl_cntl *rc = &sta->pol_tbl;
    struct rc_sta_stats *rc_ss = rc->sta_stats;
    ASSERT_ERR(rc_ss != NULL);

    return rc_ss;
}

__INLINE bool rc_check_aggregation(struct sta_info_tag *sta)
{
    struct sta_pol_tbl_cntl *pt = &sta->pol_tbl;
    struct rc_sta_stats *rc_ss = pt->sta_stats;

    return ((rc_ss->info & RC_AGG_ALLOWED_MASK) >> RC_AGG_ALLOWED_OFT);
}

void rc_init(struct sta_info_tag *sta);

uint32_t rc_get_duration(struct rc_rate_stats *rate_stats);

void rc_cfm_singleton(struct txdesc *txdesc);

void rc_cfm_ampdu(struct txdesc *txdesc, uint32_t txed, uint32_t txok);

void rc_check(struct txdesc *txdesc);

void rc_update_bw_nss_max(uint8_t sta_idx, uint8_t bw_max, uint8_t nss_max);

void rc_update_preamble_type(uint8_t sta_idx, uint8_t preamble_type);

void rc_init_bcmc_rate(struct sta_info_tag *sta, uint8_t basic_rate_idx);

uint32_t rc_calc_tp(struct rc_sta_stats *rc_ss, uint8_t sample_idx);

bool rc_check_fixed_rate_config(struct rc_sta_stats *rc_ss, uint16_t fixed_rate_config);

void rc_trial_check_bfm_stbc_htc(struct txl_buffer_control *buf_ctrl, uint32_t trial_rate,
                                 bool can_use_bfm, bool use_stbc, uint8_t stbc_nss,
                                 uint8_t nc, uint8_t ntx, bool can_use_htc);

void rc_update_sample_table(uint8_t sta_idx);


#endif /* _RC_ENABLE_H_ */

---