osal_api.h File Reference

#include "osal_structs.h"

Go to the source code of this file.

Macros
#define	NRF_WIFI_LOG_LEVEL_ERR   1U
	File containing declarations for the OSAL Layer of the Wi-Fi driver.
#define	NRF_WIFI_LOG_LEVEL_INF   3U
#define	NRF_WIFI_LOG_LEVEL_DBG   4U
#define	nrf_wifi_osal_log_dbg(fmt, ...)
#define	nrf_wifi_osal_log_info(fmt, ...)
#define	nrf_wifi_osal_log_err(fmt, ...)

Functions
void	nrf_wifi_osal_init (const struct nrf_wifi_osal_ops *ops)
	Initialize the OSAL layer.
void	nrf_wifi_osal_deinit (void)
	Deinitialize the OSAL layer.
void *	nrf_wifi_osal_mem_alloc (size_t size)
	Allocate memory.
void *	nrf_wifi_osal_mem_zalloc (size_t size)
	Allocated zero-initialized memory.
void	nrf_wifi_osal_mem_free (void *buf)
	Free previously allocated memory.
void *	nrf_wifi_osal_mem_cpy (void *dest, const void *src, size_t count)
	Copy contents from one memory location to another.
void *	nrf_wifi_osal_mem_set (void *start, int val, size_t size)
	Fill a block of memory with a particular value.
void *	nrf_wifi_osal_iomem_mmap (unsigned long addr, unsigned long size)
	Memory map IO memory into CPU space.
void	nrf_wifi_osal_iomem_unmap (volatile void *addr)
	Unmap previously mapped IO memory from CPU space.
unsigned int	nrf_wifi_osal_iomem_read_reg32 (const volatile void *addr)
	Read value from a 32 bit IO memory mapped register.
void	nrf_wifi_osal_iomem_write_reg32 (volatile void *addr, unsigned int val)
	Write a 32 bit value to a IO memory mapped register.
void	nrf_wifi_osal_iomem_cpy_from (void *dest, const volatile void *src, size_t count)
	Copy data from the memory of a memory mapped IO device to host memory.
void	nrf_wifi_osal_iomem_cpy_to (volatile void *dest, const void *src, size_t count)
	Copy data to the memory of a memory mapped IO device from host memory.
void *	nrf_wifi_osal_spinlock_alloc (void)
	Allocate a busy lock.
void	nrf_wifi_osal_spinlock_free (void *lock)
	Free a busy lock.
void	nrf_wifi_osal_spinlock_init (void *lock)
	Initialize a busy lock.
void	nrf_wifi_osal_spinlock_take (void *lock)
	Acquire a busy lock.
void	nrf_wifi_osal_spinlock_rel (void *lock)
	Releases a busy lock.
void	nrf_wifi_osal_spinlock_irq_take (void *lock, unsigned long *flags)
	Acquire a busy lock and disable interrupts.
void	nrf_wifi_osal_spinlock_irq_rel (void *lock, unsigned long *flags)
	Release a busy lock and enable interrupts.
void *	nrf_wifi_osal_llist_node_alloc (void)
	Allocate a linked list node.
void	nrf_wifi_osal_llist_node_free (void *node)
	Free a linked list node.
void *	nrf_wifi_osal_llist_node_data_get (void *node)
	Get data stored in a linked list node.
void	nrf_wifi_osal_llist_node_data_set (void *node, void *data)
	Set data in a linked list node.
void *	nrf_wifi_osal_llist_alloc (void)
	Allocate a linked list.
void	nrf_wifi_osal_llist_free (void *llist)
	Free a linked list.
void	nrf_wifi_osal_llist_init (void *llist)
	Initialize a linked list.
void	nrf_wifi_osal_llist_add_node_tail (void *llist, void *llist_node)
	Add a node to the tail of a linked list.
void	nrf_wifi_osal_llist_add_node_head (void *llist, void *llist_node)
	Add a node to the head of a linked list.
void *	nrf_wifi_osal_llist_get_node_head (void *llist)
	Get the head of a linked list.
void *	nrf_wifi_osal_llist_get_node_nxt (void *llist, void *llist_node)
	Get the next node in a linked list.
void	nrf_wifi_osal_llist_del_node (void *llist, void *llist_node)
	Delete node from a linked list.
unsigned int	nrf_wifi_osal_llist_len (void *llist)
	Get length of a linked list.
void *	nrf_wifi_osal_nbuf_alloc (unsigned int size)
	Allocate a network buffer.
void	nrf_wifi_osal_nbuf_free (void *nbuf)
	Free a network buffer.
void	nrf_wifi_osal_nbuf_headroom_res (void *nbuf, unsigned int size)
	Reserve headroom space in a network buffer.
unsigned int	nrf_wifi_osal_nbuf_headroom_get (void *nbuf)
	Get the size of the headroom in a network buffer.
unsigned int	nrf_wifi_osal_nbuf_data_size (void *nbuf)
	Get the size of data in a network buffer.
void *	nrf_wifi_osal_nbuf_data_get (void *nbuf)
	Get a handle to the data in a network buffer.
void *	nrf_wifi_osal_nbuf_data_put (void *nbuf, unsigned int size)
	Extend the tail portion of the data in a network buffer.
void *	nrf_wifi_osal_nbuf_data_push (void *nbuf, unsigned int size)
	Extend the head portion of the data in a network buffer.
void *	nrf_wifi_osal_nbuf_data_pull (void *nbuf, unsigned int size)
	Reduce the head portion of the data in a network buffer.
unsigned char	nrf_wifi_osal_nbuf_get_priority (void *nbuf)
	Get the priority of a network buffer.
unsigned char	nrf_wifi_osal_nbuf_get_chksum_done (void *nbuf)
	Get the checksum status of a network buffer.
void	nrf_wifi_osal_nbuf_set_chksum_done (void *nbuf, unsigned char chksum_done)
	Set the checksum status of a network buffer.
void *	nrf_wifi_osal_tasklet_alloc (int type)
	Allocate a tasklet.
void	nrf_wifi_osal_tasklet_free (void *tasklet)
	Free a tasklet.
void	nrf_wifi_osal_tasklet_init (void *tasklet, void(*callbk_fn)(unsigned long), unsigned long data)
	Initialize a tasklet.
void	nrf_wifi_osal_tasklet_schedule (void *tasklet)
	Schedule a tasklet.
void	nrf_wifi_osal_tasklet_kill (void *tasklet)
	Terminate a tasklet.
void	nrf_wifi_osal_sleep_ms (unsigned int msecs)
	Sleep for a specified duration in milliseconds.
void	nrf_wifi_osal_delay_us (unsigned long usecs)
	Delay for a specified duration in microseconds.
unsigned long	nrf_wifi_osal_time_get_curr_us (void)
	Get current system uptime in microseconds.
unsigned int	nrf_wifi_osal_time_elapsed_us (unsigned long start_time_us)
	Get elapsed time in microseconds.
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)
	Initialize a PCIe driver.
void	nrf_wifi_osal_bus_pcie_deinit (void *os_pcie_priv)
	Deinitialize a PCIe device driver.
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)
	Remove a PCIe device instance.
enum nrf_wifi_status	nrf_wifi_osal_bus_pcie_dev_init (void *os_pcie_dev_ctx)
	Initialize a PCIe device instance.
void	nrf_wifi_osal_bus_pcie_dev_deinit (void *os_pcie_dev_ctx)
	Deinitialize a PCIe device instance.
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))
	Register an interrupt handler for a PCIe device.
void	nrf_wifi_osal_bus_pcie_dev_intr_unreg (void *os_pcie_dev_ctx)
	Unregister an interrupt handler for a PCIe device.
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)
	Unmap DMA mapped host memory.
void	nrf_wifi_osal_bus_pcie_dev_host_map_get (void *os_pcie_dev_ctx, struct nrf_wifi_osal_host_map *host_map)
	Get host mapped address for a PCIe device.
void *	nrf_wifi_osal_bus_qspi_init (void)
	Initialize a qspi driver.
void	nrf_wifi_osal_bus_qspi_deinit (void *os_qspi_priv)
	Deinitialize a qspi device driver.
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)
	Initialize a qspi device instance.
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)
	Get host mapped address for a qspi device.
unsigned int	nrf_wifi_osal_qspi_read_reg32 (void *priv, unsigned long addr)
	Read value from a 32 bit register on a QSPI slave device.
void	nrf_wifi_osal_qspi_write_reg32 (void *priv, unsigned long addr, unsigned int val)
	Writes a 32 bit value to a 32 bit device register on a QSPI slave device.
void	nrf_wifi_osal_qspi_cpy_from (void *priv, void *dest, unsigned long addr, size_t count)
	Copies data from a QSPI slave device to a destination buffer.
void	nrf_wifi_osal_qspi_cpy_to (void *priv, unsigned long addr, const void *src, size_t count)
	Copies data from a source buffer to a QSPI slave device.
void *	nrf_wifi_osal_bus_spi_init (void)
	Initialize a spi driver.
void	nrf_wifi_osal_bus_spi_deinit (void *os_spi_priv)
	Deinitialize a spi device driver.
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)
	Remove a spi device instance.
enum nrf_wifi_status	nrf_wifi_osal_bus_spi_dev_init (void *os_spi_dev_ctx)
	Initialize a spi device instance.
void	nrf_wifi_osal_bus_spi_dev_deinit (void *os_spi_dev_ctx)
	Deinitialize a spi device instance.
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))
	Register a interrupt handler for a spi device.
void	nrf_wifi_osal_bus_spi_dev_intr_unreg (void *os_spi_dev_ctx)
	Unregister an interrupt handler for a spi device.
void	nrf_wifi_osal_bus_spi_dev_host_map_get (void *os_spi_dev_ctx, struct nrf_wifi_osal_host_map *host_map)
	Get host mapped address for a spi device.
unsigned int	nrf_wifi_osal_spi_read_reg32 (void *priv, unsigned long addr)
	Read value from a 32 bit register on a SPI slave device.
void	nrf_wifi_osal_spi_write_reg32 (void *priv, unsigned long addr, unsigned int val)
	Writes a 32 bit value to a 32 bit device register on a SPI slave device.
void	nrf_wifi_osal_spi_cpy_from (void *priv, void *dest, unsigned long addr, size_t count)
	Copies data from a SPI slave device to a destination buffer.
void	nrf_wifi_osal_spi_cpy_to (void *priv, unsigned long addr, const void *src, size_t count)
	Copies data from a source buffer to a SPI slave device.
void	nrf_wifi_osal_assert (int test, int val, enum nrf_wifi_assert_op_type op, char *msg)
	nrf_wifi_osal_assert() - Assert a condition with a value.
unsigned int	nrf_wifi_osal_strlen (const void *str)
	Gives the length of the string @str.
int	nrf_wifi_osal_mem_cmp (const void *addr1, const void *addr2, size_t count)
	Compare contents from one memory location to another.