hal_api_common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __HAL_API_COMMON_H__
#define __HAL_API_COMMON_H__
 
#include "osal_api.h"
#include "rpu_if.h"
 
#include "bal_api.h"
#include "hal_structs_common.h"
#include "hal_mem.h"
#include "hal_reg.h"
#include "hal_fw_patch_loader.h"
 
#define NRF_WIFI_ADDR_REG_NAME_LEN              16
 
struct nrf70_fw_addr_info {
        enum RPU_PROC_TYPE rpu_proc;
        char name[NRF_WIFI_ADDR_REG_NAME_LEN];
        unsigned int dest_addr;
};
 
extern const struct nrf70_fw_addr_info nrf70_fw_addr_info[];
 
struct nrf_wifi_hal_priv *
nrf_wifi_hal_init(struct nrf_wifi_hal_cfg_params *cfg_params,
                  enum nrf_wifi_status (*intr_callbk_fn)(void *dev_ctx,
                                                         void *event_data,
                                                         unsigned int len),
                  enum nrf_wifi_status (*rpu_recovery_callbk_fn)(void *mac_ctx,
                                                                 void *event_data,
                                                                 unsigned int len));
 
void nrf_wifi_hal_deinit(struct nrf_wifi_hal_priv *hpriv);
 
void nrf_wifi_hal_dev_rem(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
 
enum nrf_wifi_status nrf_wifi_hal_dev_init(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
 
void nrf_wifi_hal_dev_deinit(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
 
void nrf_wifi_hal_enable(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
void nrf_wifi_hal_disable(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
enum NRF_WIFI_HAL_STATUS nrf_wifi_hal_status_unlocked(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
 
enum nrf_wifi_status nrf_wifi_hal_ctrl_cmd_send(struct nrf_wifi_hal_dev_ctx *hal_ctx,
                                                void *cmd,
                                                unsigned int cmd_size);
 
 
enum nrf_wifi_status hal_rpu_eventq_process(struct nrf_wifi_hal_dev_ctx *hal_ctx);
 
 
void nrf_wifi_hal_proc_ctx_set(struct nrf_wifi_hal_dev_ctx *hal_ctx,
                                                           enum RPU_PROC_TYPE proc);
 
enum nrf_wifi_status nrf_wifi_hal_proc_reset(struct nrf_wifi_hal_dev_ctx *hal_ctx,
                        enum RPU_PROC_TYPE rpu_proc);
 
enum nrf_wifi_status nrf_wifi_hal_fw_chk_boot(struct nrf_wifi_hal_dev_ctx *hal_ctx,
                        enum RPU_PROC_TYPE rpu_proc);
 
#if defined(NRF_WIFI_LOW_POWER) || defined(__DOXYGEN__)
enum nrf_wifi_status hal_rpu_ps_wake(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
 
enum nrf_wifi_status nrf_wifi_hal_get_rpu_ps_state(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx,
                        int *rpu_ps_ctrl_state);
#endif /* NRF_WIFI_LOW_POWER */
 
enum nrf_wifi_status nrf_wifi_hal_otp_info_get(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx,
                        struct host_rpu_umac_info *otp_info,
                        unsigned int *otp_flags);
 
enum nrf_wifi_status nrf_wifi_hal_otp_ft_prog_ver_get(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx,
                        unsigned int *ft_prog_ver);
 
enum nrf_wifi_status nrf_wifi_hal_otp_pack_info_get(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx,
                        unsigned int *package_info);
 
enum nrf_wifi_status hal_rpu_ps_init(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx);
 
enum nrf_wifi_status nrf_wifi_hal_irq_handler(void *data);
 
enum nrf_wifi_status hal_rpu_msg_post(struct nrf_wifi_hal_dev_ctx *hal_dev_ctx,
                                      enum NRF_WIFI_HAL_MSG_TYPE msg_type,
                                      unsigned int queue_id,
                                      unsigned int msg_addr);
#endif /* __HAL_API_COMMON_H__ */