hal_structs_common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __HAL_STRUCTS_COMMON_H__
#define __HAL_STRUCTS_COMMON_H__
 
#include "lmac_if_common.h"
#include "host_rpu_common_if.h"
#include "osal_api.h"
#include "bal_api.h"
 
#define MAX_HAL_RPU_READY_WAIT (1 * 1000 * 1000)
 
#if defined(NRF_WIFI_LOW_POWER) || defined(__DOXYGEN__)
#define RPU_PS_WAKE_INTERVAL_MS 1
#define RPU_PS_WAKE_TIMEOUT_S 1
#endif /* NRF_WIFI_LOW_POWER */
 
enum RPU_PROC_TYPE {
        RPU_PROC_TYPE_MCU_LMAC = 0,
        RPU_PROC_TYPE_MCU_UMAC,
        RPU_PROC_TYPE_MAX
};
 
static inline const char *rpu_proc_to_str(enum RPU_PROC_TYPE proc)
{
        switch (proc) {
        case RPU_PROC_TYPE_MCU_LMAC:
                return "LMAC";
        case RPU_PROC_TYPE_MCU_UMAC:
                return "UMAC";
        default:
                return "UNKNOWN";
        }
};
enum NRF_WIFI_REGION_TYPE {
        NRF_WIFI_REGION_TYPE_GRAM,
        NRF_WIFI_REGION_TYPE_PKTRAM,
        NRF_WIFI_REGION_TYPE_SYSBUS,
        NRF_WIFI_REGION_TYPE_PBUS,
};
 
enum NRF_WIFI_HAL_MSG_TYPE {
        NRF_WIFI_HAL_MSG_TYPE_CMD_CTRL,
        NRF_WIFI_HAL_MSG_TYPE_EVENT,
        NRF_WIFI_HAL_MSG_TYPE_CMD_DATA_RX,
        NRF_WIFI_HAL_MSG_TYPE_CMD_DATA_MGMT,
        NRF_WIFI_HAL_MSG_TYPE_CMD_DATA_TX,
        NRF_WIFI_HAL_MSG_TYPE_MAX,
};
 
#if defined(NRF_WIFI_LOW_POWER)  || defined(__DOXYGEN__)
enum RPU_PS_STATE {
        RPU_PS_STATE_ASLEEP,
        RPU_PS_STATE_AWAKE,
        RPU_PS_STATE_MAX
};
#endif /* NRF_WIFI_LOW_POWER */
 
enum NRF_WIFI_HAL_STATUS {
        NRF_WIFI_HAL_STATUS_ENABLED,
        NRF_WIFI_HAL_STATUS_DISABLED,
};
 
struct nrf_wifi_hal_info {
        struct host_rpu_hpqm_info hpqm_info;
        unsigned int rx_cmd_base;
        unsigned int tx_cmd_base;
};
 
struct nrf_wifi_hal_buf_map_info {
        bool mapped;
        unsigned long virt_addr;
        unsigned long phy_addr;
        unsigned int buf_len;
};
 
struct nrf_wifi_hal_cfg_params {
        unsigned int max_cmd_size;
        unsigned int max_event_size;
        unsigned char rx_buf_headroom_sz;
        unsigned char tx_buf_headroom_sz;
#if defined(NRF70_DATA_TX)  || defined(__DOXYGEN__)
        unsigned int max_tx_frms;
#endif /* CONFIG_NRF70_DATA_TX */
        struct rx_buf_pool_params rx_buf_pool[MAX_NUM_OF_RX_QUEUES];
        unsigned int max_tx_frm_sz;
        unsigned int max_ampdu_len_per_token;
};
 
 
struct nrf_wifi_hal_priv {
        struct nrf_wifi_bal_priv *bpriv;
        unsigned char num_devs;
        void *add_dev_callbk_data;
        void *(*add_dev_callbk_fn)(void *add_dev_callbk_data,
                                   void *hal_dev_ctx);
        void (*rem_dev_callbk_fn)(void *mac_ctx);
        enum nrf_wifi_status (*init_dev_callbk_fn)(void *mac_ctx);
        void (*deinit_dev_callbk_fn)(void *mac_ctx);
        enum nrf_wifi_status (*intr_callbk_fn)(void *mac_ctx,
                                               void *event_data,
                                               unsigned int len);
        enum nrf_wifi_status (*rpu_recovery_callbk_fn)(void *mac_ctx,
                                                       void *event_data,
                                                       unsigned int len);
        struct nrf_wifi_hal_cfg_params cfg_params;
        unsigned long addr_pktram_base;
};
 
struct nrf_wifi_hal_dev_ctx {
        struct nrf_wifi_hal_priv *hpriv;
        void *mac_dev_ctx;
        void *bal_dev_ctx;
        unsigned char idx;
        struct nrf_wifi_hal_info rpu_info;
        unsigned int num_cmds;
        void *cmd_q;
        void *event_q;
        enum RPU_PROC_TYPE curr_proc;
        void *lock_hal;
        void *event_tasklet;
        void *lock_rx;
        struct nrf_wifi_hal_buf_map_info *rx_buf_info[MAX_NUM_OF_RX_QUEUES];
        struct nrf_wifi_hal_buf_map_info *tx_buf_info;
        unsigned long addr_rpu_pktram_base;
        unsigned long addr_rpu_pktram_base_tx;
        unsigned long addr_rpu_pktram_base_rx;
        unsigned long addr_rpu_pktram_base_rx_pool[MAX_NUM_OF_RX_QUEUES];
        unsigned long tx_frame_offset;
#if defined(NRF_WIFI_RPU_RECOVERY)  || defined(__DOXYGEN__)
        bool is_wakeup_now_asserted;
        unsigned long last_wakeup_now_asserted_time_ms;
        unsigned long last_wakeup_now_deasserted_time_ms;
        unsigned long last_rpu_sleep_opp_time_ms;
        int wdt_irq_received;
        int wdt_irq_ignored;
#endif /* NRF_WIFI_RPU_RECOVERY */
#if defined(NRF_WIFI_LOW_POWER)  || defined(__DOXYGEN__)
        enum RPU_PS_STATE rpu_ps_state;
        void *rpu_ps_timer;
        void *rpu_ps_lock;
        bool dbg_enable;
        bool irq_ctx;
        bool rpu_fw_booted;
#endif /* NRF_WIFI_LOW_POWER */
        char *event_data;
        char *event_data_curr;
        unsigned int event_data_len;
        unsigned int event_data_pending;
        unsigned int event_resubmit;
        enum NRF_WIFI_HAL_STATUS hal_status;
        void *recovery_tasklet;
        void *lock_recovery;
};
 
struct nrf_wifi_hal_msg {
        unsigned int len;
        char data[0];
};
#endif /* __HAL_STRUCTS_COMMON_H__ */