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

Go to the documentation of this file.

#ifndef _BAM_H_
#define _BAM_H_

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

#include "co_status.h"
#include "mac.h"
#include "mac_frame.h"
#include "ke_task.h"

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

#if NX_AMPDU_TX || NX_REORD
#define BAM_IDX_MAX           (NX_MAX_BA_TX + NX_REORD)
#else
#define BAM_IDX_MAX            1
#endif
#define BAM_FIRST_RX_IDX       0
#define BAM_NB_RX_IDX          NX_REORD
#define BAM_FIRST_TX_IDX       BAM_NB_RX_IDX
#define BAM_NB_TX_IDX          NX_MAX_BA_TX
#define BAM_INVALID_TASK_IDX   (BAM_IDX_MAX + 1)

#define BAM_BA_AGG_TX_CNT_THRES    2
#define BAM_RESPONSE_TO_DURATION   500
#define BAM_INACTIVITY_TO_DURATION 2000
#define BAM_ADDBA_REQ_INTERVAL     1000000


#define BAM_ADDBAREQ_BA_PARAM_OFFSET       (3)
#define BAM_ADDBAREQ_BA_TIMEOUT_OFFSET     (5)
#define BAM_ADDBAREQ_BA_SSC_OFFSET         (7)


#define BAM_ADDBARSP_STATUS_OFFSET         (3)
#define BAM_ADDBARSP_BA_PARAM_OFFSET       (5)
#define BAM_ADDBARSP_BA_TIMEOUT_OFFSET     (7)


#define BAM_DELBA_PARAM_OFFSET             (2)
#define BAM_DELBA_REASON_OFFSET            (4)


#define BAM_ADDBAREQ_LENGTH     (9)
#define BAM_ADDBARSP_LENGTH     (9)
#define BAM_DELBA_LENGTH        (6)


#define BAM_BA_PARAM_AMSDU_SUP_OFFSET   (0)
#define BAM_BA_PARAM_AMSDU_SUP_MASK     (0x0001)
#define BAM_BA_PARAM_BA_POL_OFFSET      (1)
#define BAM_BA_PARAM_BA_POL_MASK        (0x0002)
#define BAM_BA_PARAM_TID_OFFSET         (2)
#define BAM_BA_PARAM_TID_MASK           (0x003C)
#define BAM_BA_PARAM_BUFF_SIZE_OFFSET   (6)
#define BAM_BA_PARAM_BUFF_SIZE_MASK     (0xFFC0)


#define BAM_DELBA_PARAM_INITIATOR_OFFSET     (11)
#define BAM_DELBA_PARAM_INITIATOR_MASK       (0x0800)
#define BAM_DELBA_PARAM_TID_OFFSET           (12)
#define BAM_DELBA_PARAM_TID_MASK             (0xF000)


#define BAM_BA_CTRL_POLICY_OFFSET       (0)
#define BAM_BA_CTRL_POLICY_MASK         (0x0001)
#define BAM_BA_CTRL_MULTI_TID_OFFSET    (1)
#define BAM_BA_CTRL_MULTI_TID_MASK      (0x0002)
#define BAM_BA_CTRL_COMP_BITMAP_OFFSET  (2)
#define BAM_BA_CTRL_COMP_BITMAP_MASK    (0x0004)
#define BAM_BA_CTRL_COMP_BITMAP_OFFSET  (2)
#define BAM_BA_CTRL_COMP_BITMAP_MASK    (0x0004)
#define BAM_BA_CTRL_TID_INFO_OFFSET     (11)
#define BAM_BA_CTRL_TID_INFO_MASK       (0xF000)


#define BAM_BASIC_SSC_FN_OFFSET         (0)
#define BAM_BASIC_SSC_FN_MASK           (0x000F)
#define BAM_BASIC_SSC_SSN_OFFSET        (4)
#define BAM_BASIC_SSC_SSN_MASK          (0xFFF0)

#define BAM_MAX_TX_WIN_SIZE             64

#define BAM_DELBA_MAX_TRY 3

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

enum bam_ba_type
{
    BA_RESPONDER = 0,
    BA_ORIGINATOR ,
    BA_DEV_NONE
};

enum bam_ba_policy
{
    BAM_BA_POL_IMMEDIATE = 1,
    BAM_BA_POL_DELAYED,
};

enum bam_pkt_policy
{
    // Send packet as a singleton, BA Agg no yet established
    BAM_PKT_POL_SINGLETON = 0,
    // Send packet as part of an A-MPDU
    BAM_PKT_POL_AMPDU
};

enum bam_baw_state
{
    BAW_FREE,
    BAW_PENDING,
    BAW_CONFIRMED,
};

/*
 * MACROS
 ****************************************************************************************
 */

#define BAM_BA_PARAM_GET(ba_param, field)                            \
            ((ba_param & BAM_BA_PARAM_ ## field ## _MASK)            \
                            >> BAM_BA_PARAM_ ## field ## _OFFSET)

#define BAM_DELBA_PARAM_GET(delba_param, field)                      \
            ((delba_param & BAM_DELBA_PARAM_ ## field ## _MASK)       \
                            >> BAM_DELBA_PARAM_ ## field ## _OFFSET)

/*
 * TYPE DEFINITIONS
 ****************************************************************************************
 */
// Forward declarations
struct txdesc;
struct bam_baw;

typedef unsigned int (*bam_baw_index_func_ptr)(struct bam_baw *, unsigned int);

struct bam_addba_req
{
    uint8_t category;
    uint8_t action;
    uint8_t dialog_token;
    uint16_t ba_param_set;
    uint16_t ba_timeout;
    uint16_t ba_start_sc;
};

struct bam_addba_rsp
{
    uint8_t category;
    uint8_t action;
    uint8_t dialog_token;
    uint16_t status_code;
    uint16_t ba_param_set;
    uint16_t ba_timeout;
};

struct bam_delba
{
    uint8_t category;
    uint8_t action;
    uint16_t delba_param;
    uint16_t reason_code;
};

/*
 * GLOBAL STRUCTURES
 ****************************************************************************************
 */
struct bam_baw {
    bam_baw_index_func_ptr idx_compute;
    uint16_t fsn;
    uint8_t states[BAM_MAX_TX_WIN_SIZE];
    uint8_t fsn_idx;
    uint8_t buf_size;
    uint8_t mask;
};

struct bam_env_tag
{
    uint32_t pkt_cnt;
    uint32_t last_activity_time;
    uint16_t ssn;
    uint16_t ba_timeout;
    uint8_t  sta_idx;
    uint8_t  dev_type;
    uint8_t  ba_policy;
    uint8_t  buffer_size;
    uint8_t  tid;
    uint8_t  dialog_token;
    uint8_t amsdu;
    uint8_t delba_count;
    struct bam_baw *baw;
};

/*
 * GLOBAL VARIABLES DEFINITION
 ****************************************************************************************
 */
extern struct bam_env_tag bam_env[BAM_IDX_MAX];

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

// Used to build the BA parameters
__INLINE uint16_t bam_build_baparamset(struct bam_env_tag *bam_env)
{
    uint16_t value = 0;

    /* The Block Ack Parameter Set field
     *
     *******************************************************************
     *  B0              *  B1               * (B2 -> B5)*  (B6->B15)   *
     *  A-MSD Supported *  Block Ack Policy * TID       *  Buffer Size *
     *******************************************************************
     *
     */
    #if !NX_FULLY_HOSTED
    // Fill the A-MSDU Supported bit
    value |= MAC_BA_PARAMSET_AMSDU_MASK;
    #endif
    // Fill the Block Ack Policy bit
    value |= (bam_env->ba_policy << MAC_BA_PARAMSET_POLICY_OFT);
    // Fill the TID bits
    value |= (bam_env->tid << MAC_BA_PARAMSET_TID_OFT);
    // Fill the Buffer Size bits
    value |= (bam_env->buffer_size << MAC_BA_PARAMSET_BUFFER_OFT);

    return (value);
}

void bam_init(void);

#if NX_AMPDU_TX || NX_REORD

void bam_param_sta_info_tab_reset(uint16_t bam_idx);

uint16_t bam_alloc_new_task(bool tx);

void bam_delete_ba_agg(uint8_t bam_idx);

void bam_delete_all_ba_agg(uint8_t sta_idx);

void bam_start_inactivity_timer(uint16_t  bam_task_idx);

void bam_send_mm_ba_add_req(uint16_t sta_idx, uint16_t bam_idx);
void bam_send_mm_ba_del_req(uint16_t sta_idx, uint16_t bam_idx);
#endif

void bam_send_air_action_frame(uint8_t sta_idx,
                               struct bam_env_tag *bam_env,
                               uint8_t action,
                               uint8_t dialog_token,
                               uint16_t param,
                               uint16_t status_code,
                               void (*cfm_func)(void *, uint32_t));

#if NX_AMPDU_TX

void bam_check_ba_agg(struct txdesc *txdesc);

int8_t bam_tx_cfm(struct txdesc *txdesc, bool success);

void bam_baw_init(struct bam_env_tag *bam_env);

int8_t bam_flush_baw(struct bam_baw *baw);
#endif

#if NX_REORD

void bam_rx_active(uint8_t sta_idx, uint8_t tid);

void bam_send_del_ba_agg(uint8_t sta_idx, uint8_t tid);
#endif




#endif // _BAM_H_

---