/*******************************************************************************
* @file rsi_os.h
* @brief
*******************************************************************************
* # License
* <b>Copyright 2020 Silicon Laboratories Inc. www.silabs.com</b>
*******************************************************************************
*
* The licensor of this software is Silicon Laboratories Inc. Your use of this
* software is governed by the terms of Silicon Labs Master Software License
* Agreement (MSLA) available at
* www.silabs.com/about-us/legal/master-software-license-agreement. This
* software is distributed to you in Source Code format and is governed by the
* sections of the MSLA applicable to Source Code.
*
******************************************************************************/
#ifndef RSI_OS_H
#define RSI_OS_H
#include "rsi_error.h"
#include "rsi_data_types.h"
/******************************************************
* * Macros
* ******************************************************/
// Macro to increment a value
#define RSI_ATOMIC_INCREMENT(value) \
{ \
(value)++; \
}
// Macro to decrement a value
#define RSI_ATOMIC_DECREMENT(value) \
{ \
(value)--; \
}
// Error none (success)
#define RSI_ERR_NONE (0)
// Error returned when invalid arguments are given
#define RSI_ERR_INVALID_ARGS (1)
// Error returned when timeout error occurs
#define RSI_ERR_TIMEOUT (3)
// Mutex unlock value
#define RSI_NO_OS_MUTEX_UNLOCKED (0)
// Mutex lock value
#define RSI_NO_OS_MUTEX_LOCKED (1)
// Macro to set the mutex lock
#define RSI_NO_OS_ATOMIC_MUTEX_SET(mutex, value) (mutex) = value
// Macro for checking whether mutex is locked or not
#define RSI_NO_OS_ATOMIC_MUTEX_CHECK(mutex, value) (((mutex) == value) ? 1 : 0)
/******************************************************
* * Constants
* ******************************************************/
/******************************************************
* * Enumerations
* ******************************************************/
/******************************************************
* * Type Definitions
* ******************************************************/
typedef uint32_t rsi_reg_flags_t;
// Handle to manage Semaphores.
typedef uint32_t rsi_semaphore_handle_t;
// Handle to manage Mutex.
typedef uint32_t rsi_mutex_handle_t;
// Task handler
typedef void *rsi_task_handle_t;
typedef long rsi_base_type_t;
// Task function
typedef void (*rsi_task_function_t)(void *function);
/******************************************************
* * Structures
* ******************************************************/
/******************************************************
* * Global Variables
* ******************************************************/
/******************************************************
* * Function Declarations
* ******************************************************/
/* --------- CRITICAL SECTION FUNCTIONS --------- */
rsi_reg_flags_t rsi_critical_section_entry(void);
void rsi_critical_section_exit(rsi_reg_flags_t flags);
/* -------------- MUTEX FUNCTIONS -------------- */
rsi_error_t rsi_mutex_create(rsi_mutex_handle_t *p_mutex);
rsi_error_t rsi_mutex_lock(volatile rsi_mutex_handle_t *p_mutex);
void rsi_mutex_lock_from_isr(volatile rsi_mutex_handle_t *mutex);
rsi_error_t rsi_mutex_unlock(volatile rsi_mutex_handle_t *p_mutex);
void rsi_mutex_unlock_from_isr(volatile rsi_mutex_handle_t *mutex);
rsi_error_t rsi_mutex_destroy(rsi_mutex_handle_t *p_mutex);
/* ------------- SEMAPHORE FUNCTIONS ----------- */
rsi_error_t rsi_semaphore_create(rsi_semaphore_handle_t *p_sem, uint32_t cnt);
rsi_error_t rsi_semaphore_destroy(rsi_semaphore_handle_t *p_sem);
rsi_error_t rsi_semaphore_check_and_destroy(rsi_semaphore_handle_t *p_sem);
rsi_error_t rsi_semaphore_wait(rsi_semaphore_handle_t *p_sem, uint32_t timeout);
rsi_error_t rsi_semaphore_post(rsi_semaphore_handle_t *p_sem);
rsi_error_t rsi_semaphore_post_from_isr(rsi_semaphore_handle_t *semaphore);
rsi_error_t rsi_semaphore_reset(rsi_semaphore_handle_t *p_sem);
/* ------------- TASK FUNCTIONS ----------- */
rsi_error_t rsi_task_create(rsi_task_function_t task_function,
uint8_t *task_name,
uint32_t stack_size,
void *parameters,
uint32_t task_priority,
rsi_task_handle_t *task_handle);
void rsi_task_destroy(rsi_task_handle_t *task_handle);
void rsi_task_delete(rsi_task_handle_t *task_handle);
void rsi_os_task_delay(uint32_t timeout_ms);
void rsi_task_suspend(rsi_task_handle_t *task_handle);
void rsi_start_os_scheduler(void);
void rsi_wireless_driver_task_create(void);
uint32_t rsi_ms_to_tick(uint32_t timeout_ms);
/* ---------- OS MEMORY MAPPING FUNCTIONS -------- */
void *rsi_virtual_to_physical_address(void *x);
void *rsi_physical_to_virtual_address(void *x);
void *rsi_malloc(uint32_t size);
void rsi_free(void *p);
void rsi_vport_enter_critical(void);
void rsi_vport_exit_critical(void);
int32_t rsi_get_error(int32_t sockID);
void rsi_set_os_errno(int32_t error);
#endif
Macros#
#define
RSI_ATOMIC_INCREMENT (value)
#define
RSI_ATOMIC_DECREMENT (value)
#define
RSI_ERR_NONE (0)
#define
#define
RSI_ERR_TIMEOUT (3)
#define
#define
#define
RSI_NO_OS_ATOMIC_MUTEX_SET (mutex, value)
#define
RSI_NO_OS_ATOMIC_MUTEX_CHECK (mutex, value)
Typedefs#
typedef uint32_t
typedef uint32_t
typedef uint32_t
typedef void *
typedef long
typedef void(*
rsi_task_function_t)(void *function)
Functions#
rsi_reg_flags_t
void
rsi_critical_section_exit(rsi_reg_flags_t flags)
rsi_error_t
rsi_mutex_create(rsi_mutex_handle_t *p_mutex)
rsi_error_t
rsi_mutex_lock(volatile rsi_mutex_handle_t *p_mutex)
void
rsi_mutex_lock_from_isr(volatile rsi_mutex_handle_t *mutex)
rsi_error_t
rsi_mutex_unlock(volatile rsi_mutex_handle_t *p_mutex)
void
rsi_mutex_unlock_from_isr(volatile rsi_mutex_handle_t *mutex)
rsi_error_t
rsi_mutex_destroy(rsi_mutex_handle_t *p_mutex)
rsi_error_t
rsi_semaphore_create(rsi_semaphore_handle_t *p_sem, uint32_t cnt)
rsi_error_t
rsi_semaphore_destroy(rsi_semaphore_handle_t *p_sem)
rsi_error_t
rsi_semaphore_check_and_destroy(rsi_semaphore_handle_t *p_sem)
Checks whether the semaphore is created and destroys the semaphore instance, if its created.
rsi_error_t
rsi_semaphore_wait(rsi_semaphore_handle_t *p_sem, uint32_t timeout)
rsi_error_t
rsi_semaphore_post(rsi_semaphore_handle_t *p_sem)
rsi_error_t
rsi_semaphore_post_from_isr(rsi_semaphore_handle_t *semaphore)
rsi_error_t
rsi_semaphore_reset(rsi_semaphore_handle_t *p_sem)
rsi_error_t
rsi_task_create(rsi_task_function_t task_function, uint8_t *task_name, uint32_t stack_size, void *parameters, uint32_t task_priority, rsi_task_handle_t *task_handle)
void
rsi_task_destroy(rsi_task_handle_t *task_handle)
void
rsi_task_delete(rsi_task_handle_t *task_handle)
void
rsi_os_task_delay(uint32_t timeout_ms)
void
rsi_task_suspend(rsi_task_handle_t *task_handle)
void
rsi_start_os_scheduler(void)
void
uint32_t
rsi_ms_to_tick(uint32_t timeout_ms)
void *
rsi_virtual_to_physical_address(void *x)
Map virtual address to physical address.
void *
rsi_physical_to_virtual_address(void *x)
Map physical address to virtual address.
void *
rsi_malloc(uint32_t size)
void
rsi_free(void *p)
void
rsi_vport_enter_critical(void)
void
rsi_vport_exit_critical(void)
int32_t
rsi_get_error(int32_t sockID)
void
rsi_set_os_errno(int32_t error)
Macro Definition Documentation#
Typedef Documentation#
Function Documentation#
rsi_critical_section_entry#
rsi_reg_flags_t rsi_critical_section_entry (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
rsi_critical_section_exit#
void rsi_critical_section_exit (rsi_reg_flags_t flags)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_reg_flags_t | N/A | flags |
rsi_mutex_create#
rsi_error_t rsi_mutex_create (rsi_mutex_handle_t * p_mutex)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_mutex_handle_t * | N/A | p_mutex |
Referenced by rsi_common_cb_init , and rsi_wlan_cb_init
rsi_mutex_lock#
rsi_error_t rsi_mutex_lock (volatile rsi_mutex_handle_t * p_mutex)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| volatile rsi_mutex_handle_t * | N/A | p_mutex |
Referenced by rsi_rx_event_handler , and rsi_tx_event_handler
rsi_mutex_lock_from_isr#
void rsi_mutex_lock_from_isr (volatile rsi_mutex_handle_t * mutex)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| volatile rsi_mutex_handle_t * | N/A | mutex |
rsi_mutex_unlock#
rsi_error_t rsi_mutex_unlock (volatile rsi_mutex_handle_t * p_mutex)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| volatile rsi_mutex_handle_t * | N/A | p_mutex |
Referenced by rsi_rx_event_handler , and rsi_tx_event_handler
rsi_mutex_unlock_from_isr#
void rsi_mutex_unlock_from_isr (volatile rsi_mutex_handle_t * mutex)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| volatile rsi_mutex_handle_t * | N/A | mutex |
rsi_mutex_destroy#
rsi_error_t rsi_mutex_destroy (rsi_mutex_handle_t * p_mutex)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_mutex_handle_t * | N/A | p_mutex |
rsi_semaphore_create#
rsi_error_t rsi_semaphore_create (rsi_semaphore_handle_t * p_sem, uint32_t cnt)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | p_sem | |
| uint32_t | N/A | cnt |
Referenced by rsi_common_cb_init , and rsi_wlan_cb_init
rsi_semaphore_destroy#
rsi_error_t rsi_semaphore_destroy (rsi_semaphore_handle_t * p_sem)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | p_sem |
Referenced by rsi_driver_deinit , and rsi_semaphore_check_and_destroy
rsi_semaphore_check_and_destroy#
rsi_error_t rsi_semaphore_check_and_destroy (rsi_semaphore_handle_t * semaphore)
Checks whether the semaphore is created and destroys the semaphore instance, if its created.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | [in] | semaphore | - Semaphore handle pointer |
Returns
0 - Success
Negative Value - Failure
rsi_semaphore_wait#
rsi_error_t rsi_semaphore_wait (rsi_semaphore_handle_t * p_sem, uint32_t timeout)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | p_sem | |
| uint32_t | N/A | timeout |
References global_cb_s::rsi_driver_cb , rsi_init_timer , rsi_scheduler , rsi_timer_expired , and rsi_driver_cb_s::scheduler_cb
Referenced by rsi_req_wakeup , rsi_wait4wakeup , rsi_wait_on_common_semaphore , and rsi_wait_on_wlan_semaphore
rsi_semaphore_post#
rsi_error_t rsi_semaphore_post (rsi_semaphore_handle_t * p_sem)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | p_sem |
Referenced by rsi_check_and_update_cmd_state , rsi_check_common_buffer_full , rsi_check_wlan_buffer_full , rsi_common_cb_init , rsi_driver_process_common_recv_cmd , rsi_driver_process_wlan_recv_cmd , rsi_handle_slp_wkp , rsi_post_waiting_bt_semaphore , rsi_post_waiting_common_semaphore , rsi_post_waiting_semaphore , rsi_post_waiting_wlan_semaphore , rsi_release_waiting_semaphore , rsi_wlan_cb_init , and rsi_wlan_packet_transfer_done
rsi_semaphore_post_from_isr#
rsi_error_t rsi_semaphore_post_from_isr (rsi_semaphore_handle_t * semaphore)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore |
rsi_semaphore_reset#
rsi_error_t rsi_semaphore_reset (rsi_semaphore_handle_t * p_sem)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | p_sem |
rsi_task_create#
rsi_error_t rsi_task_create (rsi_task_function_t task_function, uint8_t * task_name, uint32_t stack_size, void * parameters, uint32_t task_priority, rsi_task_handle_t * task_handle)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_task_function_t | N/A | task_function | |
| uint8_t * | N/A | task_name | |
| uint32_t | N/A | stack_size | |
| void * | N/A | parameters | |
| uint32_t | N/A | task_priority | |
| rsi_task_handle_t * | N/A | task_handle |
rsi_task_destroy#
void rsi_task_destroy (rsi_task_handle_t * task_handle)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_task_handle_t * | N/A | task_handle |
rsi_task_delete#
void rsi_task_delete (rsi_task_handle_t * task_handle)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_task_handle_t * | N/A | task_handle |
rsi_os_task_delay#
void rsi_os_task_delay (uint32_t timeout_ms)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | timeout_ms |
rsi_task_suspend#
void rsi_task_suspend (rsi_task_handle_t * task_handle)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_task_handle_t * | N/A | task_handle |
rsi_start_os_scheduler#
void rsi_start_os_scheduler (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
rsi_wireless_driver_task_create#
void rsi_wireless_driver_task_create (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
rsi_ms_to_tick#
uint32_t rsi_ms_to_tick (uint32_t timeout_ms)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | timeout_ms |
rsi_virtual_to_physical_address#
void * rsi_virtual_to_physical_address (void * virtual_address)
Map virtual address to physical address.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void * | [in] | virtual_address | - pointer to virtual address |
Returns
void
rsi_physical_to_virtual_address#
void * rsi_physical_to_virtual_address (void * physical_address)
Map physical address to virtual address.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void * | [in] | physical_address | - pointer to physical_address |
Returns
void
rsi_malloc#
void * rsi_malloc (uint32_t size)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | size |
rsi_vport_enter_critical#
void rsi_vport_enter_critical (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
rsi_vport_exit_critical#
void rsi_vport_exit_critical (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
rsi_get_error#
int32_t rsi_get_error (int32_t sockID)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| int32_t | N/A | sockID |
rsi_set_os_errno#
void rsi_set_os_errno (int32_t error)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| int32_t | N/A | error |