osal_ops.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __OSAL_OPS_H__
#define __OSAL_OPS_H__
 
#include "osal_structs.h"
 
 
struct nrf_wifi_osal_ops {
        void *(*mem_alloc)(size_t size);
 
        void *(*mem_zalloc)(size_t size);
 
        void (*mem_free)(void *buf);
 
        void *(*data_mem_zalloc)(size_t size);
 
        void (*data_mem_free)(void *buf);
 
        void *(*mem_cpy)(void *dest, const void *src, size_t count);
 
        void *(*mem_set)(void *start, int val, size_t size);
 
        int (*mem_cmp)(const void *addr1, const void *addr2, size_t size);
 
        void *(*iomem_mmap)(unsigned long addr, unsigned long size);
 
        void (*iomem_unmap)(volatile void *addr);
 
        unsigned int (*iomem_read_reg32)(const volatile void *addr);
 
        void (*iomem_write_reg32)(volatile void *addr, unsigned int val);
 
        void (*iomem_cpy_from)(void *dest, const volatile void *src, size_t count);
 
        void (*iomem_cpy_to)(volatile void *dest, const void *src, size_t count);
 
        unsigned int (*qspi_read_reg32)(void *priv, unsigned long addr);
 
        void (*qspi_write_reg32)(void *priv, unsigned long addr, unsigned int val);
 
        void (*qspi_cpy_from)(void *priv, void *dest, unsigned long addr, size_t count);
 
        void (*qspi_cpy_to)(void *priv, unsigned long addr, const void *src, size_t count);
 
        unsigned int (*spi_read_reg32)(void *priv, unsigned long addr);
 
        void (*spi_write_reg32)(void *priv, unsigned long addr, unsigned int val);
 
        void (*spi_cpy_from)(void *priv, void *dest, unsigned long addr, size_t count);
 
        void (*spi_cpy_to)(void *priv, unsigned long addr, const void *src, size_t count);
 
        void *(*spinlock_alloc)(void);
 
        void (*spinlock_free)(void *lock);
 
        void (*spinlock_init)(void *lock);
 
        void (*spinlock_take)(void *lock);
 
        void (*spinlock_rel)(void *lock);
 
        void (*spinlock_irq_take)(void *lock, unsigned long *flags);
 
        void (*spinlock_irq_rel)(void *lock, unsigned long *flags);
 
        int (*log_dbg)(const char *fmt, va_list args);
 
        int (*log_info)(const char *fmt, va_list args);
 
        int (*log_err)(const char *fmt, va_list args);
 
        void *(*llist_node_alloc)(void);
 
         void *(*ctrl_llist_node_alloc)(void);
 
        void (*llist_node_free)(void *node);
 
         void (*ctrl_llist_node_free)(void *node);
 
        void *(*llist_node_data_get)(void *node);
 
        void (*llist_node_data_set)(void *node, void *data);
 
        void *(*llist_alloc)(void);
 
        void *(*ctrl_llist_alloc)(void);
 
        void (*llist_free)(void *llist);
 
        void (*ctrl_llist_free)(void *llist);
 
        void (*llist_init)(void *llist);
 
        void (*llist_add_node_tail)(void *llist, void *llist_node);
 
        void (*llist_add_node_head)(void *llist, void *llist_node);
 
        void *(*llist_get_node_head)(void *llist);
 
        void *(*llist_get_node_nxt)(void *llist, void *llist_node);
 
        void (*llist_del_node)(void *llist, void *llist_node);
 
        unsigned int (*llist_len)(void *llist);
 
        void *(*nbuf_alloc)(unsigned int size);
 
        void (*nbuf_free)(void *nbuf);
 
        void (*nbuf_headroom_res)(void *nbuf, unsigned int size);
 
        unsigned int (*nbuf_headroom_get)(void *nbuf);
 
        unsigned int (*nbuf_data_size)(void *nbuf);
 
        void *(*nbuf_data_get)(void *nbuf);
 
        void *(*nbuf_data_put)(void *nbuf, unsigned int size);
 
        void *(*nbuf_data_push)(void *nbuf, unsigned int size);
 
        void *(*nbuf_data_pull)(void *nbuf, unsigned int size);
 
        unsigned char (*nbuf_get_priority)(void *nbuf);
 
        unsigned char (*nbuf_get_chksum_done)(void *nbuf);
 
        void (*nbuf_set_chksum_done)(void *nbuf, unsigned char chksum_done);
#if defined(NRF70_RAW_DATA_TX) || defined(__DOXYGEN__)
        void *(*nbuf_set_raw_tx_hdr)(void *nbuf, unsigned short raw_hdr_len);
        void *(*nbuf_get_raw_tx_hdr)(void *nbuf);
 
        bool (*nbuf_is_raw_tx)(void *nbuf);
#endif /* NRF70_RAW_DATA_TX || __DOXYGEN__ */
        void *(*tasklet_alloc)(int type);
 
        void (*tasklet_free)(void *tasklet);
 
        void (*tasklet_init)(void *tasklet, void (*callback)(unsigned long), unsigned long data);
 
        void (*tasklet_schedule)(void *tasklet);
 
        void (*tasklet_kill)(void *tasklet);
 
        int (*sleep_ms)(int msecs);
 
        int (*delay_us)(int usecs);
 
        unsigned long (*time_get_curr_us)(void);
 
        unsigned int (*time_elapsed_us)(unsigned long start_time);
 
        unsigned long (*time_get_curr_ms)(void);
 
        unsigned int (*time_elapsed_ms)(unsigned long start_time_us);
 
        void *(*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 (*bus_pcie_deinit)(void *os_pcie_priv);
 
        void *(*bus_pcie_dev_add)(void *pcie_priv,
                                                          void *osal_pcie_dev_ctx);
 
        void (*bus_pcie_dev_rem)(void *os_pcie_dev_ctx);
 
        enum nrf_wifi_status (*bus_pcie_dev_init)(void *os_pcie_dev_ctx);
 
        void (*bus_pcie_dev_deinit)(void *os_pcie_dev_ctx);
 
        enum nrf_wifi_status (*bus_pcie_dev_intr_reg)(void *os_pcie_dev_ctx,
                        void *callbk_data,
                        int (*callback_fn)(void *callbk_data));
 
        void (*bus_pcie_dev_intr_unreg)(void *os_pcie_dev_ctx);
 
        void *(*bus_pcie_dev_dma_map)(void *os_pcie_dev_ctx,
                                                                  void *virt_addr,
                                                                  size_t size,
                                                                  enum nrf_wifi_osal_dma_dir dir);
 
        void (*bus_pcie_dev_dma_unmap)(void *os_pcie_dev_ctx,
                                                                   void *dma_addr,
                                                                   size_t size,
                                                                   enum nrf_wifi_osal_dma_dir dir);
 
        void (*bus_pcie_dev_host_map_get)(void *os_pcie_dev_ctx,
                        struct nrf_wifi_osal_host_map *host_map);
 
        void *(*bus_qspi_init)(void);
 
        void (*bus_qspi_deinit)(void *os_qspi_priv);
 
        void *(*bus_qspi_dev_add)(void *qspi_priv,
                                                          void *osal_qspi_dev_ctx);
 
        void (*bus_qspi_dev_rem)(void *os_qspi_dev_ctx);
 
        enum nrf_wifi_status (*bus_qspi_dev_init)(void *os_qspi_dev_ctx);
 
        void (*bus_qspi_dev_deinit)(void *os_qspi_dev_ctx);
 
        enum nrf_wifi_status (*bus_qspi_dev_intr_reg)(void *os_qspi_dev_ctx,
                        void *callbk_data,
                        int (*callback_fn)(void *callbk_data));
 
        void (*bus_qspi_dev_intr_unreg)(void *os_qspi_dev_ctx);
 
        void (*bus_qspi_dev_host_map_get)(void *os_qspi_dev_ctx,
                        struct nrf_wifi_osal_host_map *host_map);
 
        void *(*bus_spi_init)(void);
 
        void (*bus_spi_deinit)(void *os_spi_priv);
 
        void *(*bus_spi_dev_add)(void *spi_priv,
                                                         void *osal_spi_dev_ctx);
 
        void (*bus_spi_dev_rem)(void *os_spi_dev_ctx);
 
        enum nrf_wifi_status (*bus_spi_dev_init)(void *os_spi_dev_ctx);
 
        void (*bus_spi_dev_deinit)(void *os_spi_dev_ctx);
 
        enum nrf_wifi_status (*bus_spi_dev_intr_reg)(void *os_spi_dev_ctx,
                        void *callbk_data,
                        int (*callback_fn)(void *callbk_data));
 
        void (*bus_spi_dev_intr_unreg)(void *os_spi_dev_ctx);
 
        void (*bus_spi_dev_host_map_get)(void *os_spi_dev_ctx,
                        struct nrf_wifi_osal_host_map *host_map);
 
        #if defined(NRF_WIFI_LOW_POWER) || defined(__DOXYGEN__)
        void *(*timer_alloc)(void);
 
        void (*timer_free)(void *timer);
 
        void (*timer_init)(void *timer,
                                           void (*callback)(unsigned long),
                                           unsigned long data);
 
        void (*timer_schedule)(void *timer, unsigned long duration);
 
        void (*timer_kill)(void *timer);
 
        int (*bus_qspi_ps_sleep)(void *os_qspi_priv);
 
        int (*bus_qspi_ps_wake)(void *os_qspi_priv);
 
        int (*bus_qspi_ps_status)(void *os_qspi_priv);
        #endif /* NRF_WIFI_LOW_POWER */
 
        void (*assert)(int test_val,
                                   int val,
                                   enum nrf_wifi_assert_op_type op,
                                   char *assert_msg);
 
        unsigned int (*strlen)(const void *str);
 
        unsigned char (*rand8_get)(void);
};
#endif /* __OSAL_OPS_H__ */