PDK API Guide for J721E
|
TaskP interface
Files | |
file | TaskP.h |
Task module for the RTOS Porting Interface. | |
Data Structures | |
struct | TaskP_Params |
Basic TaskP Parameters. More... | |
Functions | |
TaskP_Handle | TaskP_create (TaskP_Fxn taskfxn, const TaskP_Params *params) |
Function to create a task. More... | |
TaskP_Status | TaskP_delete (TaskP_Handle *handle) |
Function to delete a task. More... | |
void | TaskP_Params_init (TaskP_Params *params) |
Initialize params structure to default values. More... | |
void | TaskP_sleep (uint32_t timeout) |
Function for Task sleep in units of OS tick. More... | |
void | TaskP_sleepInMsecs (uint32_t timeoutInMsecs) |
Function for Task sleep in units of msecs. More... | |
void | TaskP_setPrio (TaskP_Handle handle, uint32_t priority) |
Function to update Task priority. More... | |
TaskP_Handle | TaskP_self (void) |
Function returns the Task handle of current task. More... | |
TaskP_Handle | TaskP_selfmacro (void) |
Function returns the Task handle of current task.This is an inline function. More... | |
void | TaskP_yield (void) |
Function Yield processor to equal priority task. More... | |
uint32_t | TaskP_isTerminated (TaskP_Handle handle) |
Check if task is terminated. More... | |
uint32_t | TaskP_disable (void) |
Disable the task scheduler. More... | |
void | TaskP_restore (uint32_t key) |
Restore Task scheduling state. More... | |
uint32_t | TaskP_getTaskStackHighWatermark (TaskP_Handle handle) |
Return the task stack high watermark value (in bytes) More... | |
Typedefs | |
typedef void * | TaskP_Handle |
Opaque client reference to an instance of a TaskP. More... | |
typedef unsigned long | TaskP_Privilege_Mode |
[SafeRTOS only] Privilege of the task in safertos More... | |
typedef void(* | TaskP_Fxn) (void *arg0, void *arg1) |
Prototype for TaskP function. More... | |
Enumerations | |
enum | TaskP_Status { TaskP_OK = 0, TaskP_FAILURE = (-(int32_t)1) } |
Status codes for TaskP APIs. More... | |
Macros | |
#define | OS_TICKS_IN_MILLI_SEC 1 /* 1000us tick */ |
Number Ticks by OS in 1 millisecond. More... | |
#define OS_TICKS_IN_MILLI_SEC 1 /* 1000us tick */ |
Number Ticks by OS in 1 millisecond.
typedef void* TaskP_Handle |
Opaque client reference to an instance of a TaskP.
A TaskP_Handle returned from the TaskP_create represents that instance and is used in the other instance based functions
typedef unsigned long TaskP_Privilege_Mode |
[SafeRTOS only] Privilege of the task in safertos
A TaskP_Privilege_Mode can have two values as below. mpuUNPRIVILEGED_TASK value is 0. mpuPRIVILEGED_TASK value is 1.
typedef void( * TaskP_Fxn) (void *arg0, void *arg1) |
Prototype for TaskP function.
enum TaskP_Status |
TaskP_Handle TaskP_create | ( | TaskP_Fxn | taskfxn, |
const TaskP_Params * | params | ||
) |
Function to create a task.
taskfxn | Function pointer of the task. |
params | Pointer to the instance configuration parameters. |
TaskP_Status TaskP_delete | ( | TaskP_Handle * | handle | ) |
Function to delete a task.
handle | A TaskP_Handle returned from TaskP_create |
void TaskP_Params_init | ( | TaskP_Params * | params | ) |
Initialize params structure to default values.
params | Pointer to the instance configuration parameters. |
void TaskP_sleep | ( | uint32_t | timeout | ) |
Function for Task sleep in units of OS tick.
timeout | sleep ticks. |
void TaskP_sleepInMsecs | ( | uint32_t | timeoutInMsecs | ) |
Function for Task sleep in units of msecs.
timeoutInMsecs | sleep in units of msecs. |
void TaskP_setPrio | ( | TaskP_Handle | handle, |
uint32_t | priority | ||
) |
Function to update Task priority.
handle | A TaskP_Handle returned from TaskP_create. |
priority | New priority to be set. |
TaskP_Handle TaskP_self | ( | void | ) |
Function returns the Task handle of current task.
TaskP_Handle TaskP_selfmacro | ( | void | ) |
Function returns the Task handle of current task.This is an inline function.
void TaskP_yield | ( | void | ) |
Function Yield processor to equal priority task.
uint32_t TaskP_isTerminated | ( | TaskP_Handle | handle | ) |
Check if task is terminated.
Typically a task MUST be terminated before it can be deleted.
uint32_t TaskP_disable | ( | void | ) |
Disable the task scheduler.
Control Task scheduling. This disables all other Tasks from running until TaskP_restore is called. Interrupts can still run.
void TaskP_restore | ( | uint32_t | key | ) |
Restore Task scheduling state.
Resumes the scheduler after it was disabled using a call to TaskP_disable.
key | key to restore previous Task scheduler state |
uint32_t TaskP_getTaskStackHighWatermark | ( | TaskP_Handle | handle | ) |
Return the task stack high watermark value (in bytes)
This represents the smallest distance in bytes thus far before experiencing a stack overflow
handle | A TaskP_Handle returned from TaskP_create. |