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

Go to the documentation of this file.

#ifndef _MM_TASK_H_
#define _MM_TASK_H_

/*
 * INCLUDE FILES
 ****************************************************************************************
 */
#include "co_int.h"
#include "co_bool.h"

// inclusion to retrieve the task index
#include "ke_task.h"
// for MAC related elements (mac_addr, mac_ssid...)
#include "mac.h"
#include "phy.h"

/*
 * DEFINES
 ****************************************************************************************
 */
#define MM_IDX_MAX 1

enum mm_state_tag
{
    MM_IDLE,
    MM_ACTIVE,
    MM_GOING_TO_IDLE,
    MM_HOST_BYPASSED,
    MM_NO_IDLE,
    MM_STATE_MAX
};

enum mm_remain_on_channel_op
{
    MM_ROC_OP_START = 0,
    MM_ROC_OP_CANCEL,

    MM_ROC_OP_MAX,
};

enum mm_msg_tag
{
    MM_RESET_REQ = KE_FIRST_MSG(TASK_MM),
    MM_RESET_CFM,
    MM_START_REQ,
    MM_START_CFM,
    MM_VERSION_REQ,
    MM_VERSION_CFM,
    MM_ADD_IF_REQ,
    MM_ADD_IF_CFM,
    MM_REMOVE_IF_REQ,
    MM_REMOVE_IF_CFM,
    MM_STA_ADD_REQ,
    MM_STA_ADD_CFM,
    MM_STA_DEL_REQ,
    MM_STA_DEL_CFM,
    MM_SET_FILTER_REQ,
    MM_SET_FILTER_CFM,
    MM_SET_CHANNEL_REQ,
    MM_SET_CHANNEL_CFM,
    MM_SET_DTIM_REQ,
    MM_SET_DTIM_CFM,
    MM_SET_BEACON_INT_REQ,
    MM_SET_BEACON_INT_CFM,
    MM_SET_BASIC_RATES_REQ,
    MM_SET_BASIC_RATES_CFM,
    MM_SET_BSSID_REQ,
    MM_SET_BSSID_CFM,
    MM_SET_EDCA_REQ,
    MM_SET_EDCA_CFM,
    MM_SET_MODE_REQ,
    MM_SET_MODE_CFM,
    MM_SET_VIF_STATE_REQ,
    MM_SET_VIF_STATE_CFM,
    MM_SET_SLOTTIME_REQ,
    MM_SET_SLOTTIME_CFM,
    MM_SET_IDLE_REQ,
    MM_SET_IDLE_CFM,
    MM_KEY_ADD_REQ,
    MM_KEY_ADD_CFM,
    MM_KEY_DEL_REQ,
    MM_KEY_DEL_CFM,
    MM_BA_ADD_REQ,
    MM_BA_ADD_CFM,
    MM_BA_DEL_REQ,
    MM_BA_DEL_CFM,
    MM_PRIMARY_TBTT_IND,
    MM_SECONDARY_TBTT_IND,
    MM_SET_POWER_REQ,
    MM_SET_POWER_CFM,
    MM_DBG_TRIGGER_REQ,
    MM_SET_PS_MODE_REQ,
    MM_SET_PS_MODE_CFM,
    MM_CHAN_CTXT_ADD_REQ,
    MM_CHAN_CTXT_ADD_CFM,
    MM_CHAN_CTXT_DEL_REQ,
    MM_CHAN_CTXT_DEL_CFM,
    MM_CHAN_CTXT_LINK_REQ,
    MM_CHAN_CTXT_LINK_CFM,
    MM_CHAN_CTXT_UNLINK_REQ,
    MM_CHAN_CTXT_UNLINK_CFM,
    MM_CHAN_CTXT_UPDATE_REQ,
    MM_CHAN_CTXT_UPDATE_CFM,
    MM_CHAN_CTXT_SCHED_REQ,
    MM_CHAN_CTXT_SCHED_CFM,
    MM_BCN_CHANGE_REQ,
    MM_BCN_CHANGE_CFM,
    MM_TIM_UPDATE_REQ,
    MM_TIM_UPDATE_CFM,
    MM_CONNECTION_LOSS_IND,
    MM_CHANNEL_SWITCH_IND,
    MM_CHANNEL_PRE_SWITCH_IND,
    MM_REMAIN_ON_CHANNEL_REQ,
    MM_REMAIN_ON_CHANNEL_CFM,
    MM_REMAIN_ON_CHANNEL_EXP_IND,
    MM_PS_CHANGE_IND,
    MM_TRAFFIC_REQ_IND,
    MM_SET_PS_OPTIONS_REQ,
    MM_SET_PS_OPTIONS_CFM,
    MM_P2P_VIF_PS_CHANGE_IND,
    MM_CSA_COUNTER_IND,
    MM_CHANNEL_SURVEY_IND,
    MM_BFMER_ENABLE_REQ,
    MM_SET_P2P_NOA_REQ,
    MM_SET_P2P_OPPPS_REQ,
    MM_SET_P2P_NOA_CFM,
    MM_SET_P2P_OPPPS_CFM,
    MM_P2P_NOA_UPD_IND,
    MM_CFG_RSSI_REQ,
    MM_RSSI_STATUS_IND,
    MM_CSA_FINISH_IND,
    MM_CSA_TRAFFIC_IND,
    MM_MU_GROUP_UPDATE_REQ,
    MM_MU_GROUP_UPDATE_CFM,
    MM_ANT_DIV_INIT_REQ,
    MM_ANT_DIV_STOP_REQ,
    MM_ANT_DIV_UPDATE_REQ,
    MM_SWITCH_ANTENNA_REQ,
    MM_PKTLOSS_IND,
    MM_SET_MU_EDCA_REQ,
    MM_SET_MU_EDCA_CFM,
    MM_SET_UORA_REQ,
    MM_SET_UORA_CFM,
    MM_SET_TXOP_RTS_THRES_REQ,
    MM_SET_TXOP_RTS_THRES_CFM,
    MM_SET_BSS_COLOR_REQ,
    MM_SET_BSS_COLOR_CFM,

    /*
     * Section of internal MM messages. No MM API messages should be defined below this point
     */
    MM_FORCE_IDLE_REQ,
    MM_SCAN_CHANNEL_START_IND,
    MM_SCAN_CHANNEL_END_IND,
    MM_TBTT_MOVE_REQ,

    MM_MAX,
};

struct mm_start_req
{
    struct phy_cfg_tag phy_cfg;
    uint32_t uapsd_timeout;
    uint16_t lp_clk_accuracy;
};

struct mm_set_channel_req
{
    struct mac_chan_op chan;
    uint8_t index;
};

struct mm_set_channel_cfm
{
    uint8_t radio_idx;
    int8_t power;
};

struct mm_set_dtim_req
{
    uint8_t dtim_period;
};

struct mm_set_power_req
{
    uint8_t inst_nbr;
    int8_t power;
};

struct mm_set_power_cfm
{
    uint8_t radio_idx;
    int8_t power;
};

struct mm_set_beacon_int_req
{
    uint16_t beacon_int;
    uint8_t inst_nbr;
};

struct mm_set_basic_rates_req
{
    uint32_t rates;
    uint8_t inst_nbr;
    uint8_t band;
};

struct mm_set_bssid_req
{
    struct mac_addr bssid;
    uint8_t inst_nbr;
};

struct mm_set_filter_req
{
    uint32_t filter;
};

struct mm_add_if_req
{
    uint8_t type;
    struct mac_addr addr;
    bool p2p;
};

struct mm_set_edca_req
{
    uint32_t ac_param;
    bool uapsd;
    uint8_t hw_queue;
    uint8_t inst_nbr;
};

struct mm_set_mu_edca_req
{
    uint32_t param[AC_MAX];
};

struct mm_set_uora_req
{
    uint8_t eocw_min;
    uint8_t eocw_max;
};

struct mm_set_txop_rts_thres_req
{
    uint16_t txop_dur_rts_thres;
    uint8_t inst_nbr;
};

struct mm_set_bss_color_req
{
    uint32_t bss_color;
};

struct mm_set_slottime_req
{
    uint8_t slottime;
};

struct mm_set_mode_req
{
    uint8_t abgnmode;
};

struct mm_set_vif_state_req
{
    uint16_t aid;
    bool active;
    uint8_t inst_nbr;
};

struct mm_add_if_cfm
{
    uint8_t status;
    uint8_t inst_nbr;
};

struct mm_remove_if_req
{
    uint8_t inst_nbr;
};

struct mm_version_cfm
{
    uint32_t version_lmac;
    uint32_t version_machw_1;
    uint32_t version_machw_2;
    uint32_t version_phy_1;
    uint32_t version_phy_2;
    uint32_t features;
    uint16_t max_sta_nb;
    uint8_t max_vif_nb;
};

struct mm_sta_add_req
{
    uint32_t ampdu_size_max_he;
    uint32_t ampdu_size_max_vht;
    uint32_t paid_gid;
    uint16_t ampdu_size_max_ht;
    struct mac_addr mac_addr;
    uint8_t ampdu_spacing_min;
    uint8_t inst_nbr;
    bool tdls_sta;
    bool tdls_initiator;
    bool tdls_chsw_allowed;
    uint8_t bssid_index;
    uint8_t max_bssid_ind;
};

struct mm_sta_add_cfm
{
    uint8_t status;
    uint8_t sta_idx;
    uint8_t hw_sta_idx;
};

struct mm_sta_del_req
{
    uint8_t sta_idx;
};

struct mm_sta_del_cfm
{
    uint8_t     status;
};

struct mm_set_idle_req
{
    uint8_t hw_idle;
};

struct mm_key_add_req
{
    uint8_t key_idx;
    uint8_t sta_idx;
    struct mac_sec_key  key;
    uint8_t cipher_suite;
    uint8_t inst_nbr;
    uint8_t spp;
    bool pairwise;
};

struct mm_key_add_cfm
{
    uint8_t status;
    uint8_t hw_key_idx;
};

struct mm_key_del_req
{
    uint8_t hw_key_idx;
};

struct mm_ba_add_req
{
    uint8_t  type;
    uint8_t  sta_idx;
    uint8_t  tid;
    uint8_t  bufsz;
    uint16_t ssn;
};

struct mm_ba_add_cfm
{
    uint8_t sta_idx;
    uint8_t tid;
    uint8_t status;
};

#if (NX_AMPDU_TX || NX_REORD)
struct mm_ba_del_req
{
    uint8_t type;
    uint8_t sta_idx;
    uint8_t tid;
};

struct mm_ba_del_cfm
{
    uint8_t sta_idx;
    uint8_t tid;
    uint8_t status;
};
#endif //NX_AMPDU_TX || NX_REORD

struct mm_channel_switch_ind
{
    uint8_t chan_index;
    bool roc;
    uint8_t vif_index;
    bool roc_tdls;
};

struct mm_channel_pre_switch_ind
{
    uint8_t chan_index;
};

struct mm_connection_loss_ind
{
    uint8_t inst_nbr;
};

struct mm_dbg_trigger_req
{
    char error[64];
};

#if NX_POWERSAVE
struct mm_set_ps_mode_req
{
    uint8_t  new_state;
};
#endif

struct mm_chan_ctxt_add_req
{
    struct mac_chan_op chan;
};

struct mm_chan_ctxt_add_cfm
{
    uint8_t status;
    uint8_t index;
};


struct mm_chan_ctxt_del_req
{
    uint8_t index;
};


struct mm_chan_ctxt_link_req
{
    uint8_t vif_index;
    uint8_t chan_index;
    uint8_t chan_switch;
};

struct mm_chan_ctxt_unlink_req
{
    uint8_t vif_index;
};

struct mm_chan_ctxt_update_req
{
    uint8_t chan_index;
    struct mac_chan_op chan;
};

struct mm_chan_ctxt_sched_req
{
    uint8_t vif_index;
    uint8_t chan_index;
    uint8_t type;
};

#define BCN_MAX_CSA_CPT 2
struct mm_bcn_change_req
{
    uint32_t bcn_ptr;
    uint16_t bcn_len;
    uint16_t tim_oft;
    uint8_t tim_len;
    uint8_t inst_nbr;
    uint8_t csa_oft[BCN_MAX_CSA_CPT];
};

struct mm_tim_update_req
{
    uint16_t aid;
    uint8_t tx_avail;
    uint8_t inst_nbr;
};

struct mm_ps_change_ind
{
    uint8_t sta_idx;
    uint8_t ps_state;
};

struct mm_p2p_vif_ps_change_ind
{
    uint8_t vif_index;
    uint8_t ps_state;
};

struct mm_traffic_req_ind
{
    uint8_t sta_idx;
    uint8_t pkt_cnt;
    bool uapsd;
};


struct mm_remain_on_channel_req
{
    uint8_t op_code;
    uint8_t vif_index;
    struct mac_chan_op chan;
    uint32_t duration_ms;
};

struct mm_remain_on_channel_cfm
{
    uint8_t op_code;
    uint8_t status;
    uint8_t chan_ctxt_index;
};

struct mm_remain_on_channel_exp_ind
{
    uint8_t vif_index;
    uint8_t chan_ctxt_index;
};

struct mm_set_ps_options_req
{
    uint8_t vif_index;
    uint16_t listen_interval;
    bool dont_listen_bc_mc;
};

struct mm_csa_counter_ind
{
    uint8_t vif_index;
    uint8_t csa_count;
};

struct mm_channel_survey_ind
{
    uint16_t freq;
    int8_t noise_dbm;
    uint32_t chan_time_ms;
    uint32_t chan_time_busy_ms;
};

struct mm_bfmer_enable_req
{
    uint32_t host_bfr_addr;
    uint16_t host_bfr_size;
    uint16_t aid;
    uint8_t sta_idx;
    uint8_t rx_nss;
    bool vht_mu_bfmee;
};

struct mm_cfg_rssi_req
{
    uint8_t vif_index;
    int8_t rssi_thold;
    uint8_t rssi_hyst;
};

struct mm_rssi_status_ind
{
    uint8_t vif_index;
    bool rssi_status;
    int8_t rssi;
};

struct mm_pktloss_ind
{
    uint8_t vif_index;
    struct mac_addr mac_addr;
    uint32_t num_packets;
};

struct mm_csa_finish_ind
{
    uint8_t vif_index;
    uint8_t status;
    uint8_t chan_idx;
};

struct mm_csa_traffic_ind
{
    uint8_t vif_index;
    bool enable;
};

typedef void (*cb_idle_func_ptr)(void);

struct mm_force_idle_req
{
    cb_idle_func_ptr cb;
};

struct mm_tbtt_move_req
{
    int32_t offset;
};

struct mm_set_p2p_noa_req
{
    uint8_t vif_index;
    uint8_t noa_inst_nb;
    uint8_t count;
    bool dyn_noa;
    uint32_t duration_us;
    uint32_t interval_us;
    uint32_t start_offset;
};

struct mm_set_p2p_oppps_req
{
    uint8_t vif_index;
    uint8_t ctwindow;
};

struct mm_set_p2p_noa_cfm
{
    uint8_t status;
};

struct mm_set_p2p_oppps_cfm
{
    uint8_t status;
};

struct mm_p2p_noa_upd_ind
{
    uint8_t vif_index;
    uint8_t noa_inst_nb;
    uint8_t noa_type;
    uint8_t count;
    uint32_t duration_us;
    uint32_t interval_us;
    uint32_t start_time;
};

struct mm_mu_group_update_req
{
    uint8_t sta_idx;
    uint8_t group_cnt;
    struct
    {
        uint8_t group_id;
        uint8_t user_pos;
    } groups[0];
};

struct mm_ant_div_init_req
{
    bool enable;
};

/*
 * TASK DESCRIPTOR DECLARATIONS
 ****************************************************************************************
 */
extern const struct ke_state_handler mm_state_handler[MM_STATE_MAX];

extern const struct ke_state_handler mm_default_handler;

extern ke_state_t mm_state[MM_IDX_MAX];


#endif // _MM_TASK_H_

---