Vision Apps User Guide
app_rtos.h File Reference

Go to the source code of this file.

App Rtos status code

#define APP_RTOS_STATUS_SUCCESS   (0)
 
#define APP_RTOS_STATUS_FAILURE   (-(int32_t)1)
 
#define APP_RTOS_STATUS_TIMEOUT   (-(int32_t)2)
 
typedef int32_t app_rtos_status_t
 Status codes for App Rtos APIs. More...
 

Semaphore Modes

API failed because of a timeout

#define APP_RTOS_SEMAPHORE_MODE_COUNTING   (0x0U)
 
#define APP_RTOS_SEMAPHORE_MODE_BINARY   (0x1U)
 
#define APP_RTOS_SEMAPHORE_MODE_MUTEX   (0x2U)
 
typedef uint32_t app_rtos_semaphore_mode_t
 Mode of the semaphore. More...
 

Data Structures

struct  app_rtos_semaphore_params_t
 Semaphore parameters. More...
 
struct  app_rtos_task_params_t
 Task parameters. More...
 

Macros

#define APP_RTOS_SEMAPHORE_WAIT_FOREVER   (~((uint32_t)0U))
 Wait forever define. More...
 
#define APP_RTOS_SEMAPHORE_NO_WAIT   ((uint32_t)0U)
 No wait define. More...
 

Typedefs

typedef void * app_rtos_semaphore_handle_t
 Opaque client reference to an instance of a semaphore. More...
 
typedef void * app_rtos_task_handle_t
 Opaque client reference to an instance of a task. More...
 

Functions

void appRtosSemaphoreParamsInit (app_rtos_semaphore_params_t *params)
 Initialize params structure to default values. More...
 
app_rtos_semaphore_handle_t appRtosSemaphoreCreate (app_rtos_semaphore_params_t params)
 Creates a semaphore instance. More...
 
app_rtos_status_t appRtosSemaphoreDelete (app_rtos_semaphore_handle_t *semhandle)
 Function to delete a semaphore. More...
 
app_rtos_status_t appRtosSemaphorePend (app_rtos_semaphore_handle_t semhandle, uint32_t timeout)
 Function to pend (wait) on a semaphore. More...
 
app_rtos_status_t appRtosSemaphorePost (app_rtos_semaphore_handle_t semhandle)
 Function to post (signal) a semaphore. More...
 
app_rtos_status_t appRtosSemaphoreReset (app_rtos_semaphore_handle_t semhandle)
 Function to clear a semaphore for reuse. More...
 
void appRtosTaskParamsInit (app_rtos_task_params_t *params)
 Initialize params structure to default values. More...
 
app_rtos_task_handle_t appRtosTaskCreate (const app_rtos_task_params_t *params)
 Function to create a task. More...
 
app_rtos_status_t appRtosTaskDelete (app_rtos_task_handle_t *handle)
 Function to delete a task. More...
 
uint32_t appRtosTaskIsTerminated (app_rtos_task_handle_t handle)
 Check if task is terminated. More...
 
void appRtosTaskYield (void)
 Function for Task yield. More...
 
void appRtosTaskSleep (uint32_t timeout)
 Function for Task sleep in units of OS tick. More...
 
void appRtosTaskSleepInMsecs (uint32_t timeoutInMsecs)
 Function for Task sleep in units of msecs. More...