RTOS APIs#

rsi_critical_section_entry#

rsi_reg_flags_t rsi_critical_section_entry ()

Enter critical section.

Returns

• Interrupt status before entering critical section

rsi_critical_section_exit#

void rsi_critical_section_exit (rsi_reg_flags_t xflags)

Exit critical section by restoring interrupts.

Returns

• Void

rsi_mutex_create#

rsi_error_t rsi_mutex_create (rsi_mutex_handle_t *mutex)

Create and initialize the mutex.

Returns

• 0 - Success

• Negative Value - Failure

rsi_mutex_lock#

rsi_error_t rsi_mutex_lock (volatile rsi_mutex_handle_t *mutex)

Lock the mutex.

Returns

• 0 - Success

• Negative Value - Failure

rsi_mutex_lock_from_isr#

void rsi_mutex_lock_from_isr (volatile rsi_mutex_handle_t *mutex)

Lock the mutex from ISR context.

Returns

• 0 - Success

• Negative Value - Failure

rsi_mutex_unlock#

rsi_error_t rsi_mutex_unlock (volatile rsi_mutex_handle_t *mutex)

Unlock the mutex.

Returns

• 0 - Success

• Negative Value - Failure

rsi_mutex_unlock_from_isr#

void rsi_mutex_unlock_from_isr (volatile rsi_mutex_handle_t *mutex)

Unlock the mutex from ISR context.

Returns

• None

rsi_mutex_destroy#

rsi_error_t rsi_mutex_destroy (rsi_mutex_handle_t *mutex)

Destroy the mutex.

Returns

• 0 - Success

• Negative Value - Failure

rsi_semaphore_create#

rsi_error_t rsi_semaphore_create (rsi_semaphore_handle_t *semaphore, uint32_t count)

Create and initialize the semaphore instance.

Returns

• 0 - Success

• Negative Value - Failure

rsi_semaphore_destroy#

rsi_error_t rsi_semaphore_destroy (rsi_semaphore_handle_t *semaphore)

Destroy the semaphore instance.

Returns

• 0 - Success

• Negative Value - Failure

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.

Check whether the semaphore is created and destroy, if created.

Returns

• 0 - Success

• Negative Value - Failure

Returns

• 0 - Success

• Negative Value - Failure

rsi_semaphore_wait#

rsi_error_t rsi_semaphore_wait (rsi_semaphore_handle_t *semaphore, uint32_t timeout_ms)

Wait for semaphore.

Returns

• 0 - Success

• Negative Value - Failure

rsi_semaphore_post#

rsi_error_t rsi_semaphore_post (rsi_semaphore_handle_t *semaphore)

Release semaphore, which is acquired.

Returns

• 0 - Success

• Negative Value - Failure

rsi_semaphore_post_from_isr#

rsi_error_t rsi_semaphore_post_from_isr (rsi_semaphore_handle_t *semaphore)

Release semaphore, which is acquired from ISR context.

Returns

• 0 - Success

• Negative Value - Failure

rsi_semaphore_reset#

rsi_error_t rsi_semaphore_reset (rsi_semaphore_handle_t *semaphore)

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)

Create OS task/thread.

Returns

• 0 - Success

• Negative Value - Failure

rsi_task_destroy#

void rsi_task_destroy (rsi_task_handle_t *task_handle)

Destroy the task created.

Returns

• Void

rsi_os_task_delay#

void rsi_os_task_delay (uint32_t timeout_ms)

Induce required delay in milli seconds.

Returns

• Void

rsi_start_os_scheduler#

void rsi_start_os_scheduler ()

Schedule the tasks created.

Returns

• Void

rsi_setup_timer_os_interrupt#

void rsi_setup_timer_os_interrupt ()

Setup the systick timer to generate the tick interrupts at the required frequency.

Returns

• void

rsi_set_os_errno#

void rsi_set_os_errno (int32_t error)

Sets the OS error .

Returns

• Void

rsi_task_notify_wait#

rsi_base_type_t rsi_task_notify_wait (uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, uint32_t timeout)

Allow a task to wait with optional timeout.

Returns

• 0 - Success

• Negative Value - Failure

rsi_task_notify#

rsi_base_type_t rsi_task_notify (rsi_task_handle_t xTaskToNotify, uint32_t ulValue)

Notify a task.

Returns

• 0 - Success

• Non-Zero Value - Failure

rsi_task_notify_from_isr#

rsi_base_type_t rsi_task_notify_from_isr (rsi_task_handle_t xTaskToNotify, uint32_t ulValue, rsi_base_type_t *pxHigherPriorityTaskWoken)

Notify a task from ISR context.

Returns

• 0 - Success

• Non-Zero Value - Failure

rsi_os_task_notify_take#

uint32_t rsi_os_task_notify_take (BaseType_t xClearCountOnExit, TickType_t xTicksToWait)

Allow a task in wait in blocked state for its notification value.

Returns

• 0 - Success

• Non-Zero Value - Failure

rsi_os_task_notify_give#

BaseType_t rsi_os_task_notify_give (rsi_task_handle_t xTaskToNotify)

Notify to a task.

Returns

• Task notification value - Success

• -1 - Failure

rsi_get_error#

int32_t rsi_get_error (int32_t sockID)

Get WLAN status.

Returns

• WLAN status

rsi_malloc#

void* rsi_malloc (uint32_t size)

Allocate memory from the buffer which is maintained by freeRTOS.

Returns

• Void

rsi_free#

void rsi_free (void *ptr)

Free the memory pointed by 'ptr'.

Returns

• Void

rsi_vport_enter_critical#

void rsi_vport_enter_critical (void)

Enter into critical section.

Returns

• Void

rsi_vport_exit_critical#

void rsi_vport_exit_critical (void)

Enter exit section.

Returns

• Void

rsi_task_suspend#

void rsi_task_suspend (rsi_task_handle_t *task_handle)

Exit critical section.

Returns

• Void