PDK API Guide for J721E
|
EventP interface
Files | |
file | EventP.h |
Event module for the RTOS Porting Interface. | |
Data Structures | |
struct | EventP_Params |
Basic EventP Parameters. More... | |
Functions | |
EventP_Handle | EventP_create (EventP_Params *params) |
Function to create an event. More... | |
void | EventP_delete (EventP_Handle *handle) |
Function to delete an event. More... | |
void | EventP_Params_init (EventP_Params *params) |
Initialize params structure to default values. More... | |
uint32_t | EventP_pend (EventP_Handle handle, uint32_t andMask, uint32_t orMask, uint32_t timeout) |
Function for Event Pend. More... | |
void | EventP_post (EventP_Handle handle, uint32_t eventMask) |
Function for Event Post. More... | |
uint32_t | EventP_getPostedEvents (EventP_Handle handle) |
Function for Event Post. More... | |
Typedefs | |
typedef void * | EventP_Handle |
Opaque client reference to an instance of a EventP. More... | |
Enumerations | |
enum | EventP_Status { EventP_OK = 0, EventP_FAILURE = (-(int32_t)1) } |
Status codes for EventP APIs. More... | |
Macros | |
#define | EventP_ID_NONE Event_Id_NONE |
Event ID 0. More... | |
#define | EventP_ID_00 Event_Id_00 |
Event ID 0. More... | |
#define | EventP_ID_01 Event_Id_01 |
Event ID 1. More... | |
#define | EventP_ID_02 Event_Id_02 |
Event ID 2. More... | |
#define | EventP_ID_03 Event_Id_03 |
Event ID 3. More... | |
#define | EventP_ID_04 Event_Id_04 |
Event ID 4. More... | |
#define | EventP_ID_05 Event_Id_05 |
Event ID 5. More... | |
#define | EventP_ID_06 Event_Id_06 |
Event ID 6. More... | |
#define | EventP_ID_07 Event_Id_07 |
Event ID 7. More... | |
#define | EventP_ID_08 Event_Id_08 |
Event ID 8. More... | |
#define | EventP_ID_09 Event_Id_09 |
Event ID 9. More... | |
#define | EventP_ID_10 Event_Id_10 |
Event ID 10. More... | |
#define | EventP_WAIT_FOREVER (~((uint32_t)0U)) |
Wait forever define. More... | |
#define | EventP_NO_WAIT ((uint32_t)0U) |
No wait define. More... | |
#define EventP_ID_NONE Event_Id_NONE |
Event ID 0.
#define EventP_ID_00 Event_Id_00 |
Event ID 0.
#define EventP_ID_01 Event_Id_01 |
Event ID 1.
#define EventP_ID_02 Event_Id_02 |
Event ID 2.
#define EventP_ID_03 Event_Id_03 |
Event ID 3.
#define EventP_ID_04 Event_Id_04 |
Event ID 4.
#define EventP_ID_05 Event_Id_05 |
Event ID 5.
#define EventP_ID_06 Event_Id_06 |
Event ID 6.
#define EventP_ID_07 Event_Id_07 |
Event ID 7.
#define EventP_ID_08 Event_Id_08 |
Event ID 8.
#define EventP_ID_09 Event_Id_09 |
Event ID 9.
#define EventP_ID_10 Event_Id_10 |
Event ID 10.
#define EventP_WAIT_FOREVER (~((uint32_t)0U)) |
Wait forever define.
#define EventP_NO_WAIT ((uint32_t)0U) |
No wait define.
typedef void* EventP_Handle |
Opaque client reference to an instance of a EventP.
A EventP_Handle returned from the EventP_create represents that instance and is used in the other instance based functions
enum EventP_Status |
EventP_Handle EventP_create | ( | EventP_Params * | params | ) |
Function to create an event.
params | Pointer to the instance configuration parameters. |
void EventP_delete | ( | EventP_Handle * | handle | ) |
Function to delete an event.
handle | A EventP_Handle returned from EventP_create |
void EventP_Params_init | ( | EventP_Params * | params | ) |
Initialize params structure to default values.
params | Pointer to the instance configuration parameters. |
uint32_t EventP_pend | ( | EventP_Handle | handle, |
uint32_t | andMask, | ||
uint32_t | orMask, | ||
uint32_t | timeout | ||
) |
Function for Event Pend.
handle | EventP handle.created via EventP_create API |
andMask | return from pend() when ALL of these events have occurred |
orMask | return from pend() when ANY of these events have occurred |
timeout | return from pend() after this many system time units |
void EventP_post | ( | EventP_Handle | handle, |
uint32_t | eventMask | ||
) |
Function for Event Post.
handle | A EventP_Handle returned from EventP_create. |
eventMask | mask of eventIds to post (must be non-zero) |
uint32_t EventP_getPostedEvents | ( | EventP_Handle | handle | ) |
Function for Event Post.
handle | A EventP_Handle returned from EventP_create. |