PDK API Guide for AM64x
EventP

Introduction

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 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. Event_Ids are provided to simplify the specification of andMasks and orMasks arguments to Event_pend(). Since each Event_Id is a bitmask composed of only a single bit, a group of Event_Ids within an andMask or orMask can be indicated by simply adding them together.

#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...
 

Macro Definition Documentation

◆ EventP_ID_NONE

#define EventP_ID_NONE   Event_Id_NONE

Event ID 0.

◆ EventP_ID_00

#define EventP_ID_00   Event_Id_00

Event ID 0.

◆ EventP_ID_01

#define EventP_ID_01   Event_Id_01

Event ID 1.

◆ EventP_ID_02

#define EventP_ID_02   Event_Id_02

Event ID 2.

◆ EventP_ID_03

#define EventP_ID_03   Event_Id_03

Event ID 3.

◆ EventP_ID_04

#define EventP_ID_04   Event_Id_04

Event ID 4.

◆ EventP_ID_05

#define EventP_ID_05   Event_Id_05

Event ID 5.

◆ EventP_ID_06

#define EventP_ID_06   Event_Id_06

Event ID 6.

◆ EventP_ID_07

#define EventP_ID_07   Event_Id_07

Event ID 7.

◆ EventP_ID_08

#define EventP_ID_08   Event_Id_08

Event ID 8.

◆ EventP_ID_09

#define EventP_ID_09   Event_Id_09

Event ID 9.

◆ EventP_ID_10

#define EventP_ID_10   Event_Id_10

Event ID 10.

◆ EventP_WAIT_FOREVER

#define EventP_WAIT_FOREVER   (~((uint32_t)0U))

Wait forever define.

◆ EventP_NO_WAIT

#define EventP_NO_WAIT   ((uint32_t)0U)

No wait define.

Typedef Documentation

◆ EventP_Handle

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

Enumeration Type Documentation

◆ EventP_Status

Status codes for EventP APIs.

Enumerator
EventP_OK 

API completed successfully

EventP_FAILURE 

API failed

Function Documentation

◆ EventP_create()

EventP_Handle EventP_create ( EventP_Params params)

Function to create an event.

Parameters
paramsPointer to the instance configuration parameters.
Returns
A EventP_Handle on success or a NULL on an error

◆ EventP_delete()

void EventP_delete ( EventP_Handle handle)

Function to delete an event.

Parameters
handleA EventP_Handle returned from EventP_create

◆ EventP_Params_init()

void EventP_Params_init ( EventP_Params params)

Initialize params structure to default values.

Parameters
paramsPointer to the instance configuration parameters.

◆ EventP_pend()

uint32_t EventP_pend ( EventP_Handle  handle,
uint32_t  andMask,
uint32_t  orMask,
uint32_t  timeout 
)

Function for Event Pend.

Parameters
handleEventP handle.created via EventP_create API
andMaskreturn from pend() when ALL of these events have occurred
orMaskreturn from pend() when ANY of these events have occurred
timeoutreturn from pend() after this many system time units
Returns
All consumed events or zero if timeout

◆ EventP_post()

void EventP_post ( EventP_Handle  handle,
uint32_t  eventMask 
)

Function for Event Post.

Parameters
handleA EventP_Handle returned from EventP_create.
eventMaskmask of eventIds to post (must be non-zero)

◆ EventP_getPostedEvents()

uint32_t EventP_getPostedEvents ( EventP_Handle  handle)

Function to return Event Posted.

Parameters
handleA EventP_Handle returned from EventP_create.
Returns
All un-consumed events posted