/space/home/slher/rel/Beken/v6_4_5/macsw/ip/lmac/src/bfr/bfr.h

Go to the documentation of this file.

#ifndef _BFR_H_
#define _BFR_H_

/*
 * INCLUDE FILES
 ****************************************************************************************
 */

// RW Stack Configuration
#include "rwnx_config.h"

#if (RW_BFMER_EN)

// Linked List Library
#include "co_list.h"
// MAC Frame Definition
#include "mac_frame.h"
// For DMA Descriptor Definition
#include "dma.h"
// For TX Descriptor Definition
#include "tx_swdesc.h"
// For VIF Definition
#include "vif_mgmt.h"

/*
 * DEFINES
 ****************************************************************************************
 */

#define BFR_MEM_REP_NB_MAX      (6)
#define BFR_MEM_BASE_ADDR       (0x60C05000)
//#define BFR_MEM_BASE_ADDR       (0x10E00000)
#define BFM_MEM_PTR_SIZE        (BFR_MEM_REP_NB_MAX * 2)
#define BFR_MEM_START_ADDR      (BFM_MEM_PTR_SIZE)
#define BFR_MEM_NODE_NB         (BFR_MEM_REP_NB_MAX)

#define BFR_NDPA_SU_LEN         (MAC_LONG_CTRLFRAME_LEN + 3)
#define BFR_NDPA_STA_INFO_LEN   (2)
#define BFR_NDPA_TOKEN_MAX      (0x3F)
#define BFR_NPDA_TOKEN_POS      (2)
#define BFR_NDPA_TOKEN_MASK     (BFR_NDPA_TOKEN_MAX << BFR_NPDA_TOKEN_POS)
#define BFR_NPDA_AID12_POS      (0)
#define BFR_NDPA_AID12_MASK     (0xFFF)
#define BFR_NPDA_FBACK_POS      (12)
#define BFR_NDPA_FBACK_MASK     (0x1000)
#define BFR_NPDA_NC_IDX_POS     (13)
#define BFR_NDPA_NC_IDX_MASK    (0xFE00)

#define BFR_NDPA_DIALOG_TOKEN_OFFSET        (16)
#define BFR_NDPA_STA_INFO_OFFSET            (17)
#define BFR_NDPA_STA_INFO_LENGTH            (2)

#define BFR_BRP_LEN             (MAC_LONG_CTRLFRAME_LEN + 1)

#define BFR_BRP_RETX_BITMAP_OFFSET          (16)


#define BFR_MIMO_CTRL_NC_OFFSET         (0)
#define BFR_MIMO_CTRL_NR_OFFSET         (3)
#define BFR_MIMO_CTRL_CHAN_WIDTH_OFFSET (6)
#define BFR_MIMO_CTRL_GROUPING_OFFSET   (8)
#define BFR_MIMO_CTRL_CODEBOOK_OFFSET   (10)
#define BFR_MIMO_CTRL_FEEDBACK_OFFSET   (11)
#define BFR_MIMO_CTRL_REM_SEGM_OFFSET   (12)
#define BFR_MIMO_CTRL_FIRST_SEGM_OFFSET (15)
#define BFR_MIMO_CTRL_RESERVED_OFFSET   (16)
#define BFR_MIMO_CTRL_TOKEN_OFFSET      (18)

#define BFR_MIMO_CTRL_NC_MASK           (0x7)
#define BFR_MIMO_CTRL_NR_MASK           (0x7)
#define BFR_MIMO_CTRL_CHAN_WIDTH_MASK   (0x3)
#define BFR_MIMO_CTRL_GROUPING_MASK     (0x3)
#define BFR_MIMO_CTRL_CODEBOOK_MASK     (0x1)
#define BFR_MIMO_CTRL_FEEDBACK_MASK     (0x1)
#define BFR_MIMO_CTRL_REM_SEGM_MASK     (0x7)
#define BFR_MIMO_CTRL_FIRST_SEGM_MASK   (0x1)
#define BFR_MIMO_CTRL_TOKEN_MASK        (0x3F)


#define BFR_CALIB_TMR_DFLT_DUR          (50000)
#define BFR_CALIB_MAX_DELAY             (500000)
#define BFR_INVALID_SMM_INDEX           (0xFF)

#define BFR_VHT_BFR_CATEGORY_OFFSET         (24)
#define BFR_VHT_BFR_VHT_ACTION_OFFSET       (25)
#define BFR_VHT_BFR_VHT_MIMO_CTRL_OFFSET    (26)
#define BFR_VHT_REPORT_OFFSET               (29)
#define BFR_INVALID_NC                      (0xFF)


/*
 * ENUMERATIONS
 ****************************************************************************************
 */

enum bfr_rx_status
{
    BFR_RX_STATUS_NOT_VALID = 0,
    BFR_RX_STATUS_VALID,
    BFR_RX_STATUS_ERROR,
};

enum bfr_fback_type_val
{
    BFR_SU_TYPE = 0,
    BFR_MU_TYPE,
};

enum bfr_status
{
    BFR_STATUS_IDLE = 0,
    BFR_STATUS_SU_CALIB,
    BFR_STATUS_MU_CALIB,
};

enum bfr_sta_info_status
{
    BFR_STA_MU_CAPABLE = 0,
    BFR_STA_HAS_VALID_REPORT,
    BFR_STA_DOWNLOAD,
    BFR_STA_CALIBRATE,
    BFR_STA_REPORT_UPDATED,
};

/*
 * TYPE DEFINITIONS
 ****************************************************************************************
 */

struct bfr_mem_node
{
    struct co_list_hdr hdr;
    uint16_t start_addr;
    uint16_t length;
    uint8_t idx;
    uint8_t nb_frames;
    uint8_t smm_index;
    uint8_t sta_idx;
};

struct bfr_env_tag
{
    struct co_list free_nodes;
    struct co_list nodes;
    struct co_list bfee_sta_list;
    struct co_list calib_sched;
    struct mm_timer_tag calib_tmr;
    uint32_t calib_tmr_dur;
    uint16_t bfr_mem_eaddr;
    uint8_t nb_reports;
    uint8_t status;
    uint8_t token;
    uint8_t bfer_nss;
    uint8_t nb_used_nodes;
    uint8_t calib_bw;
    bool bfr_enabled;
};

struct bfr_info_sta
{
    struct co_list_hdr hdr;
    struct bfr_mem_node *node;
    uint32_t last_calib_time;
    uint32_t host_report_addr[2];
    uint16_t host_report_len[2];
    uint16_t host_max_report_len;
    uint16_t sta_info;
    uint8_t last_token;
    uint8_t status;
    uint8_t nb_segments;
    uint8_t sta_idx;
    uint8_t vif_idx;
    uint8_t bfee_nss;
    uint8_t last_rx_nc;
    uint8_t host_report_idx;
};

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

extern struct bfr_env_tag bfr_env;

extern struct bfr_info_sta bfr_sta_infos[NX_REMOTE_STA_MAX];


/*
 * INLINED FUNCTIONS
 ****************************************************************************************
 */

__INLINE bool bfr_is_enabled(void)
{
    return (bfr_env.bfr_enabled);
}

__INLINE bool bfr_is_calibrated(uint8_t sta_idx)
{
    // Get BFR information for this STA
    struct bfr_info_sta *bfr = &bfr_sta_infos[sta_idx];

    // Check if STA has a valid report available
    return ((bfr->status & CO_BIT(BFR_STA_HAS_VALID_REPORT)) != 0);
}

__INLINE bool bfr_is_bfmed_sglt_allowed(struct txdesc *txdesc)
{
    #if NX_UMAC_PRESENT
    // Check if the frame can be beamformed as a unicast
    if (txdesc->host.flags & TXU_CNTRL_RC_TRIAL)
    {
        return ((txdesc->umac.buf_control->tx_flags & TX_SWDESC_UMAC_TRIAL_BEAMFORM_BIT) != 0);
    }
    else
    {
        return ((txdesc->umac.buf_control->tx_flags & TX_SWDESC_UMAC_BEAMFORM_BIT) != 0);
    }
    #else
    return ((txdesc->umac.tx_flags & TX_SWDESC_UMAC_BEAMFORM_BIT) != 0);
    #endif
}

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

void bfr_init(void);

void bfr_add_sta_ind(uint8_t sta_idx, bool mu_capable, uint16_t aid, uint32_t host_addr,
                     uint16_t host_length, uint8_t nss);

void bfr_del_sta_ind(uint8_t sta_idx);

uint8_t bfr_rx_frame_ind(uint8_t sta_idx, struct rxdesc *rxdesc, uint8_t *frame);

bool bfr_tx_frame_ind(struct txdesc *txdesc, struct dma_desc *dma_desc_bfr);

void bfr_tx_cfm(struct txdesc *txdesc);

#if (NX_UMAC_PRESENT)

uint8_t bfr_get_last_nc(uint8_t sta_idx);
#endif //(NX_UMAC_PRESENT)

#if RW_MUMIMO_TX_EN

void bfr_group_update_req(struct mm_mu_group_update_req const *param);
#endif //RW_MUMIMO_TX_EN

#endif //(RW_BFMER_EN)


#endif // _BFR_H_

---