![]() |
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... | |
EventP_Status | 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_wait (EventP_Handle handle, uint32_t eventMask, uint8_t waitMode, uint32_t timeout) |
Function for Event Wait. More... | |
EventP_Status | EventP_post (EventP_Handle handle, uint32_t eventMask) |
Function for Event Post. More... | |
uint32_t | EventP_getPostedEvents (EventP_Handle handle) |
Function to return Event Posted. 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_WAIT_FOREVER (~((uint32_t)0U)) |
Wait forever define. More... | |
#define | EventP_NO_WAIT ((uint32_t)0U) |
No wait define. More... | |
Event ID definitions | |
Pre-defined Event Ids. EventP_Ids are provided to simplify the specification of mask argument to EventP_wait(). Since each EventP_Id is a bitmask composed of only a single bit, a group of EventP_Ids within a Mask can be indicated by simply adding them together. | |
#define | EventP_ID_NONE 0x0U |
Event ID NONE. More... | |
#define | EventP_ID_00 0x1U |
Event ID 0. More... | |
#define | EventP_ID_01 0x2U |
Event ID 1. More... | |
#define | EventP_ID_02 0x4U |
Event ID 2. More... | |
#define | EventP_ID_03 0x8U |
Event ID 3. More... | |
#define | EventP_ID_04 0x10U |
Event ID 4. More... | |
#define | EventP_ID_05 0x20U |
Event ID 5. More... | |
#define | EventP_ID_06 0x40U |
Event ID 6. More... | |
#define | EventP_ID_07 0x80U |
Event ID 7. More... | |
#define | EventP_ID_08 0x100U |
Event ID 8. More... | |
#define | EventP_ID_09 0x200U |
Event ID 9. More... | |
#define | EventP_ID_10 0x400U |
Event ID 10. More... | |
#define | EventP_ID_11 0x800U |
Event ID 11. More... | |
#define | EventP_ID_12 0x1000U |
Event ID 12. More... | |
#define | EventP_ID_13 0x2000U |
Event ID 13. More... | |
#define | EventP_ID_14 0x4000U |
Event ID 14. More... | |
#define | EventP_ID_15 0x8000U |
Event ID 15. More... | |
#define | EventP_ID_16 0x10000U |
Event ID 16. More... | |
#define | EventP_ID_17 0x20000U |
Event ID 17. More... | |
#define | EventP_ID_18 0x40000U |
Event ID 18. More... | |
#define | EventP_ID_19 0x80000U |
Event ID 19. More... | |
#define | EventP_ID_20 0x100000U |
Event ID 20. More... | |
#define | EventP_ID_21 0x200000U |
Event ID 21. More... | |
#define | EventP_ID_22 0x400000U |
Event ID 22. More... | |
#define | EventP_ID_23 0x800000U |
Event ID 23. More... | |
Event wait modes for EventP_wait API | |
typedef uint8_t | EventP_WaitMode |
This enumerator defines the Event wait modes. More... | |
#define | EventP_WaitMode_ANY ( (uint8_t) 0U) |
#define | EventP_WaitMode_ALL ( (uint8_t) 1U) |
#define EventP_ID_NONE 0x0U |
Event ID NONE.
#define EventP_ID_00 0x1U |
Event ID 0.
#define EventP_ID_01 0x2U |
Event ID 1.
#define EventP_ID_02 0x4U |
Event ID 2.
#define EventP_ID_03 0x8U |
Event ID 3.
#define EventP_ID_04 0x10U |
Event ID 4.
#define EventP_ID_05 0x20U |
Event ID 5.
#define EventP_ID_06 0x40U |
Event ID 6.
#define EventP_ID_07 0x80U |
Event ID 7.
#define EventP_ID_08 0x100U |
Event ID 8.
#define EventP_ID_09 0x200U |
Event ID 9.
#define EventP_ID_10 0x400U |
Event ID 10.
#define EventP_ID_11 0x800U |
Event ID 11.
#define EventP_ID_12 0x1000U |
Event ID 12.
#define EventP_ID_13 0x2000U |
Event ID 13.
#define EventP_ID_14 0x4000U |
Event ID 14.
#define EventP_ID_15 0x8000U |
Event ID 15.
#define EventP_ID_16 0x10000U |
Event ID 16.
#define EventP_ID_17 0x20000U |
Event ID 17.
#define EventP_ID_18 0x40000U |
Event ID 18.
#define EventP_ID_19 0x80000U |
Event ID 19.
#define EventP_ID_20 0x100000U |
Event ID 20.
#define EventP_ID_21 0x200000U |
Event ID 21.
#define EventP_ID_22 0x400000U |
Event ID 22.
#define EventP_ID_23 0x800000U |
Event ID 23.
#define EventP_WaitMode_ANY ( (uint8_t) 0U) |
#define EventP_WaitMode_ALL ( (uint8_t) 1U) |
#define EventP_WAIT_FOREVER (~((uint32_t)0U)) |
Wait forever define.
#define EventP_NO_WAIT ((uint32_t)0U) |
No wait define.
typedef uint8_t EventP_WaitMode |
This enumerator defines the Event wait modes.
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. |
EventP_Status 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_wait | ( | EventP_Handle | handle, |
uint32_t | eventMask, | ||
uint8_t | waitMode, | ||
uint32_t | timeout | ||
) |
Function for Event Wait.
handle | EventP_Handle created via EventP_create API |
eventMask | mask of eventIds to pend on (must be non-zero) Only supports upto 24 bits. |
waitMode | Event wait mode. EventP_WaitMode |
timeout | return from wait() after this many system time units |
EventP_Status 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 to return Event Posted.
handle | A EventP_Handle returned from EventP_create. |