osal_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __OSAL_API_H__
#define __OSAL_API_H__
 
#include "osal_structs.h"
 
/* Have to match zephyr/include/zephyr/logging/log_core.h */
#define NRF_WIFI_LOG_LEVEL_ERR 1U
#define NRF_WIFI_LOG_LEVEL_INF 3U
#define NRF_WIFI_LOG_LEVEL_DBG 4U
 
#ifndef NRF70_LOG_VERBOSE
#define __func__ "<snipped>"
#endif /* NRF70_LOG_VERBOSE */
 
void nrf_wifi_osal_init(const struct nrf_wifi_osal_ops *ops);
 
void nrf_wifi_osal_deinit(void);
 
void *nrf_wifi_osal_mem_alloc(size_t size);
 
void *nrf_wifi_osal_mem_zalloc(size_t size);
 
void *nrf_wifi_osal_data_mem_zalloc(size_t size);
 
void nrf_wifi_osal_mem_free(void *buf);
 
void nrf_wifi_osal_data_mem_free(void *buf);
 
void *nrf_wifi_osal_mem_cpy(void *dest,
                            const void *src,
                            size_t count);
 
void *nrf_wifi_osal_mem_set(void *start,
                            int val,
                            size_t size);
 
 
void *nrf_wifi_osal_iomem_mmap(unsigned long addr,
                               unsigned long size);
 
void nrf_wifi_osal_iomem_unmap(volatile void *addr);
 
unsigned int nrf_wifi_osal_iomem_read_reg32(const volatile void *addr);
 
void nrf_wifi_osal_iomem_write_reg32(volatile void *addr,
                                     unsigned int val);
 
void nrf_wifi_osal_iomem_cpy_from(void *dest,
                                  const volatile void *src,
                                  size_t count);
 
void nrf_wifi_osal_iomem_cpy_to(volatile void *dest,
                                const void *src,
                                size_t count);
 
 
void *nrf_wifi_osal_spinlock_alloc(void);
 
void nrf_wifi_osal_spinlock_free(void *lock);
 
 
void nrf_wifi_osal_spinlock_init(void *lock);
 
 
void nrf_wifi_osal_spinlock_take(void *lock);
 
 
void nrf_wifi_osal_spinlock_rel(void *lock);
 
 
void nrf_wifi_osal_spinlock_irq_take(void *lock,
                                     unsigned long *flags);
 
 
void nrf_wifi_osal_spinlock_irq_rel(void *lock,
                                    unsigned long *flags);
 
 
#if WIFI_NRF70_LOG_LEVEL >= NRF_WIFI_LOG_LEVEL_DBG
int nrf_wifi_osal_log_dbg(const char *fmt, ...);
#else
#define nrf_wifi_osal_log_dbg(fmt, ...)
#endif
 
#if WIFI_NRF70_LOG_LEVEL >= NRF_WIFI_LOG_LEVEL_INF
int nrf_wifi_osal_log_info(const char *fmt, ...);
#else
#define nrf_wifi_osal_log_info(fmt, ...)
#endif
 
#if WIFI_NRF70_LOG_LEVEL >= NRF_WIFI_LOG_LEVEL_ERR
int nrf_wifi_osal_log_err(const char *fmt, ...);
#else
#define nrf_wifi_osal_log_err(fmt, ...)
#endif
 
void *nrf_wifi_osal_llist_node_alloc(void);
 
 void *nrf_wifi_osal_ctrl_llist_node_alloc(void);
 
void nrf_wifi_osal_llist_node_free(void *node);
 
void nrf_wifi_osal_ctrl_llist_node_free(void *node);
 
void *nrf_wifi_osal_llist_node_data_get(void *node);
 
 
void nrf_wifi_osal_llist_node_data_set(void *node,
                                       void *data);
 
 
void *nrf_wifi_osal_llist_alloc(void);
 
void nrf_wifi_osal_llist_free(void *llist);
 
void *nrf_wifi_osal_ctrl_llist_alloc(void);
 
void nrf_wifi_osal_ctrl_llist_free(void *llist);
 
void nrf_wifi_osal_llist_init(void *llist);
 
 
void nrf_wifi_osal_llist_add_node_tail(void *llist,
                                       void *llist_node);
 
 
void nrf_wifi_osal_llist_add_node_head(void *llist,
                                       void *llist_node);
void *nrf_wifi_osal_llist_get_node_head(void *llist);
 
 
void *nrf_wifi_osal_llist_get_node_nxt(void *llist,
                                       void *llist_node);
 
 
void nrf_wifi_osal_llist_del_node(void *llist,
                                  void *llist_node);
 
 
unsigned int nrf_wifi_osal_llist_len(void *llist);
 
 
void *nrf_wifi_osal_nbuf_alloc(unsigned int size);
 
 
void nrf_wifi_osal_nbuf_free(void *nbuf);
 
 
void nrf_wifi_osal_nbuf_headroom_res(void *nbuf,
                                     unsigned int size);
 
 
 
unsigned int nrf_wifi_osal_nbuf_headroom_get(void *nbuf);
 
unsigned int nrf_wifi_osal_nbuf_data_size(void *nbuf);
 
 
void *nrf_wifi_osal_nbuf_data_get(void *nbuf);
 
 
void *nrf_wifi_osal_nbuf_data_put(void *nbuf,
                                  unsigned int size);
 
 
void *nrf_wifi_osal_nbuf_data_push(void *nbuf,
                                   unsigned int size);
 
 
void *nrf_wifi_osal_nbuf_data_pull(void *nbuf,
                                   unsigned int size);
 
 
unsigned char nrf_wifi_osal_nbuf_get_priority(void *nbuf);
 
unsigned char nrf_wifi_osal_nbuf_get_chksum_done(void *nbuf);
 
void nrf_wifi_osal_nbuf_set_chksum_done(void *nbuf,
                                        unsigned char chksum_done);
 
#if defined(CONFIG_NRF70_RAW_DATA_TX) || defined(__DOXYGEN__)
void *nrf_wifi_osal_nbuf_set_raw_tx_hdr(void *nbuf,
                                        unsigned short raw_hdr_len);
 
void *nrf_wifi_osal_nbuf_get_raw_tx_hdr(void *nbuf);
 
bool nrf_wifi_osal_nbuf_is_raw_tx(void *nbuf);
#endif /* CONFIG_NRF70_RAW_DATA_TX || __DOXYGEN__ */
 
void *nrf_wifi_osal_tasklet_alloc(int type);
 
void nrf_wifi_osal_tasklet_free(void *tasklet);
 
 
void nrf_wifi_osal_tasklet_init(void *tasklet,
                                void (*callbk_fn)(unsigned long),
                                unsigned long data);
 
 
void nrf_wifi_osal_tasklet_schedule(void *tasklet);
 
 
void nrf_wifi_osal_tasklet_kill(void *tasklet);
 
 
void nrf_wifi_osal_sleep_ms(unsigned int msecs);
 
 
void nrf_wifi_osal_delay_us(unsigned long usecs);
 
 
unsigned long nrf_wifi_osal_time_get_curr_us(void);
 
unsigned int nrf_wifi_osal_time_elapsed_us(unsigned long start_time_us);
 
unsigned long nrf_wifi_osal_time_get_curr_ms(void);
 
unsigned int nrf_wifi_osal_time_elapsed_ms(unsigned long start_time_ms);
 
void *nrf_wifi_osal_bus_pcie_init(const char *dev_name,
                                  unsigned int vendor_id,
                                  unsigned int sub_vendor_id,
                                  unsigned int device_id,
                                  unsigned int sub_device_id);
 
 
void nrf_wifi_osal_bus_pcie_deinit(void *os_pcie_priv);
 
 
void *nrf_wifi_osal_bus_pcie_dev_add(void *os_pcie_priv,
                                     void *osal_pcie_dev_ctx);
 
 
void nrf_wifi_osal_bus_pcie_dev_rem(void *os_pcie_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_osal_bus_pcie_dev_init(void *os_pcie_dev_ctx);
 
 
void nrf_wifi_osal_bus_pcie_dev_deinit(void *os_pcie_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_osal_bus_pcie_dev_intr_reg(void *os_pcie_dev_ctx,
                                                         void *callbk_data,
                                                         int (*callbk_fn)(void *callbk_data));
 
 
void nrf_wifi_osal_bus_pcie_dev_intr_unreg(void *os_pcie_dev_ctx);
 
 
void *nrf_wifi_osal_bus_pcie_dev_dma_map(void *os_pcie_dev_ctx,
                                         void *virt_addr,
                                         size_t size,
                                         enum nrf_wifi_osal_dma_dir dir);
 
 
void nrf_wifi_osal_bus_pcie_dev_dma_unmap(void *os_pcie_dev_ctx,
                                          void *dma_addr,
                                          size_t size,
                                          enum nrf_wifi_osal_dma_dir dir);
 
 
void nrf_wifi_osal_bus_pcie_dev_host_map_get(void *os_pcie_dev_ctx,
                                             struct nrf_wifi_osal_host_map *host_map);
 
 
 
 
void *nrf_wifi_osal_bus_qspi_init(void);
 
void nrf_wifi_osal_bus_qspi_deinit(void *os_qspi_priv);
 
 
void *nrf_wifi_osal_bus_qspi_dev_add(void *os_qspi_priv,
                                     void *osal_qspi_dev_ctx);
 
 
void nrf_wifi_osal_bus_qspi_dev_rem(void *os_qspi_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_osal_bus_qspi_dev_init(void *os_qspi_dev_ctx);
 
 
void nrf_wifi_osal_bus_qspi_dev_deinit(void *os_qspi_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_osal_bus_qspi_dev_intr_reg(void *os_qspi_dev_ctx,
                                                         void *callbk_data,
                                                         int (*callbk_fn)(void *callbk_data));
 
 
void nrf_wifi_osal_bus_qspi_dev_intr_unreg(void *os_qspi_dev_ctx);
 
 
void nrf_wifi_osal_bus_qspi_dev_host_map_get(void *os_qspi_dev_ctx,
                                             struct nrf_wifi_osal_host_map *host_map);
 
unsigned int nrf_wifi_osal_qspi_read_reg32(void *priv,
                                           unsigned long addr);
 
void nrf_wifi_osal_qspi_write_reg32(void *priv,
                                    unsigned long addr,
                                    unsigned int val);
 
void nrf_wifi_osal_qspi_cpy_from(void *priv,
                                 void *dest,
                                 unsigned long addr,
                                 size_t count);
 
void nrf_wifi_osal_qspi_cpy_to(void *priv,
                               unsigned long addr,
                               const void *src,
                               size_t count);
 
void *nrf_wifi_osal_bus_spi_init(void);
 
void nrf_wifi_osal_bus_spi_deinit(void *os_spi_priv);
 
 
void *nrf_wifi_osal_bus_spi_dev_add(void *os_spi_priv,
                                    void *osal_spi_dev_ctx);
 
 
void nrf_wifi_osal_bus_spi_dev_rem(void *os_spi_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_osal_bus_spi_dev_init(void *os_spi_dev_ctx);
 
 
void nrf_wifi_osal_bus_spi_dev_deinit(void *os_spi_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_osal_bus_spi_dev_intr_reg(void *os_spi_dev_ctx,
                                                        void *callbk_data,
                                                        int (*callbk_fn)(void *callbk_data));
 
 
void nrf_wifi_osal_bus_spi_dev_intr_unreg(void *os_spi_dev_ctx);
 
 
void nrf_wifi_osal_bus_spi_dev_host_map_get(void *os_spi_dev_ctx,
                                            struct nrf_wifi_osal_host_map *host_map);
 
unsigned int nrf_wifi_osal_spi_read_reg32(void *priv,
                                          unsigned long addr);
 
void nrf_wifi_osal_spi_write_reg32(void *priv,
                                   unsigned long addr,
                                   unsigned int val);
 
void nrf_wifi_osal_spi_cpy_from(void *priv,
                                void *dest,
                                unsigned long addr,
                                size_t count);
 
void nrf_wifi_osal_spi_cpy_to(void *priv,
                              unsigned long addr,
                              const void *src,
                              size_t count);
 
 
#if defined(NRF_WIFI_LOW_POWER) || defined(__DOXYGEN__)
void *nrf_wifi_osal_timer_alloc(void);
 
void nrf_wifi_osal_timer_free(void *timer);
 
 
void nrf_wifi_osal_timer_init(void *timer,
                              void (*callbk_fn)(unsigned long),
                              unsigned long data);
 
 
void nrf_wifi_osal_timer_schedule(void *timer,
                                  unsigned long duration);
 
 
void nrf_wifi_osal_timer_kill(void *timer);
 
int nrf_wifi_osal_bus_qspi_ps_sleep(void *os_qspi_priv);
 
int nrf_wifi_osal_bus_qspi_ps_wake(void *os_qspi_priv);
 
int nrf_wifi_osal_bus_qspi_ps_status(void *os_qspi_priv);
#endif /* NRF_WIFI_LOW_POWER */
 
void nrf_wifi_osal_assert(int test,
                          int val,
                          enum nrf_wifi_assert_op_type op,
                          char *msg);
 
unsigned int nrf_wifi_osal_strlen(const void *str);
 
int nrf_wifi_osal_mem_cmp(const void *addr1,
                          const void *addr2,
                          size_t count);
 
unsigned char nrf_wifi_osal_rand8_get(void);
 
 
#endif /* __OSAL_API_H__ */