TIOVX User Guide

Detailed Description

APIs for task operations on the host.

Data Structures

struct  tivx_task
 Typedef for a task. More...
 
struct  tivx_task_create_params_t
 Parameters that can be set during task creation. More...
 

Defines

#define TIVX_TASK_PRI_HIGHEST   (0u)
 Constant to define highest priority for a task.
 
#define TIVX_TASK_PRI_LOWEST   (15u)
 Constant to define lowest priority for a task.
 
#define TIVX_TASK_AFFINITY_ANY   (0xFFFFu)
 constant to indicate task affinity can be decided by OS on a SMP CPU
 
#define TIVX_MAX_TASK_NAME   (12u)
 Max Task Name Size.
 

Functions

void tivxTaskSetDefaultCreateParams (tivx_task_create_params_t *params)
 Used to set default task create parameters in parameter structure. More...
 
vx_status tivxTaskCreate (tivx_task *task, const tivx_task_create_params_t *params)
 Create a task. More...
 
vx_status tivxTaskDelete (tivx_task *task)
 Delete a task. More...
 
void tivxTaskWaitMsecs (uint32_t msec)
 waits/sleeps for given milliseconds More...
 

Function Documentation

◆ tivxTaskSetDefaultCreateParams()

void tivxTaskSetDefaultCreateParams ( tivx_task_create_params_t params)

Used to set default task create parameters in parameter structure.

Parameters
params[out] Params to use for task creation

◆ tivxTaskCreate()

vx_status tivxTaskCreate ( tivx_task task,
const tivx_task_create_params_t params 
)

Create a task.

Parameters
task[out] Pointer to task object
params[in] Task create parameters
Returns
VX_SUCCESS on success

◆ tivxTaskDelete()

vx_status tivxTaskDelete ( tivx_task task)

Delete a task.

Parameters
task[in] Pointer to task object
Returns
VX_SUCCESS on success

◆ tivxTaskWaitMsecs()

void tivxTaskWaitMsecs ( uint32_t  msec)

waits/sleeps for given milliseconds

Parameters
msec[in] amount of milliseconds to sleep