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

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

enum	EventP_WaitMode { EventP_WaitMode_ANY, EventP_WaitMode_ALL }
	Event wait modes for EventP_wait API. 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 0x0
	Event ID NONE. More...

#define	EventP_ID_00 0x1
	Event ID 0. More...

#define	EventP_ID_01 0x2
	Event ID 1. More...

#define	EventP_ID_02 0x4
	Event ID 2. More...

#define	EventP_ID_03 0x8
	Event ID 3. More...

#define	EventP_ID_04 0x10
	Event ID 4. More...

#define	EventP_ID_05 0x20
	Event ID 5. More...

#define	EventP_ID_06 0x40
	Event ID 6. More...

#define	EventP_ID_07 0x80
	Event ID 7. More...

#define	EventP_ID_08 0x100
	Event ID 8. More...

#define	EventP_ID_09 0x200
	Event ID 9. More...

#define	EventP_ID_10 0x400
	Event ID 10. More...

#define	EventP_ID_11 0x800
	Event ID 11. More...

#define	EventP_ID_12 0x1000
	Event ID 12. More...

#define	EventP_ID_13 0x2000
	Event ID 13. More...

#define	EventP_ID_14 0x4000
	Event ID 14. More...

#define	EventP_ID_15 0x8000
	Event ID 15. More...

#define	EventP_ID_16 0x10000
	Event ID 16. More...

#define	EventP_ID_17 0x20000
	Event ID 17. More...

#define	EventP_ID_18 0x40000
	Event ID 18. More...

#define	EventP_ID_19 0x80000
	Event ID 19. More...

#define	EventP_ID_20 0x100000
	Event ID 20. More...

#define	EventP_ID_21 0x200000
	Event ID 21. More...

#define	EventP_ID_22 0x400000
	Event ID 22. More...

#define	EventP_ID_23 0x800000
	Event ID 23. More...

Macro Definition Documentation

◆ EventP_ID_NONE

#define EventP_ID_NONE 0x0

Event ID NONE.

◆ EventP_ID_00

#define EventP_ID_00 0x1

Event ID 0.

◆ EventP_ID_01

#define EventP_ID_01 0x2

Event ID 1.

◆ EventP_ID_02

#define EventP_ID_02 0x4

Event ID 2.

◆ EventP_ID_03

#define EventP_ID_03 0x8

Event ID 3.

◆ EventP_ID_04

#define EventP_ID_04 0x10

Event ID 4.

◆ EventP_ID_05

#define EventP_ID_05 0x20

Event ID 5.

◆ EventP_ID_06

#define EventP_ID_06 0x40

Event ID 6.

◆ EventP_ID_07

#define EventP_ID_07 0x80

Event ID 7.

◆ EventP_ID_08

#define EventP_ID_08 0x100

Event ID 8.

◆ EventP_ID_09

#define EventP_ID_09 0x200

Event ID 9.

◆ EventP_ID_10

#define EventP_ID_10 0x400

Event ID 10.

◆ EventP_ID_11

#define EventP_ID_11 0x800

Event ID 11.

◆ EventP_ID_12

#define EventP_ID_12 0x1000

Event ID 12.

◆ EventP_ID_13

#define EventP_ID_13 0x2000

Event ID 13.

◆ EventP_ID_14

#define EventP_ID_14 0x4000

Event ID 14.

◆ EventP_ID_15

#define EventP_ID_15 0x8000

Event ID 15.

◆ EventP_ID_16

#define EventP_ID_16 0x10000

Event ID 16.

◆ EventP_ID_17

#define EventP_ID_17 0x20000

Event ID 17.

◆ EventP_ID_18

#define EventP_ID_18 0x40000

Event ID 18.

◆ EventP_ID_19

#define EventP_ID_19 0x80000

Event ID 19.

◆ EventP_ID_20

#define EventP_ID_20 0x100000

Event ID 20.

◆ EventP_ID_21

#define EventP_ID_21 0x200000

Event ID 21.

◆ EventP_ID_22

#define EventP_ID_22 0x400000

Event ID 22.

◆ EventP_ID_23

#define EventP_ID_23 0x800000

Event ID 23.

◆ 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

enum EventP_Status

Status codes for EventP APIs.

Enumerator
EventP_OK	API completed successfully
EventP_FAILURE	API failed

◆ EventP_WaitMode

enum EventP_WaitMode

Event wait modes for EventP_wait API.

Enumerator

EventP_WaitMode_ANY

Test bits for logical OR. EventP_wait will return when ANY of the bits set in mask are set in the Event bits

EventP_WaitMode_ALL

Test bits for logical AND.

EventP_wait will return when ALL the bits set in mask are set in the Event bits

Function Documentation

◆ EventP_create()

EventP_Handle EventP_create ( EventP_Params * params )

Function to create an event.

Parameters

params Pointer to the instance configuration parameters.

Returns: A EventP_Handle on success or a NULL on an error

◆ EventP_delete()

EventP_Status EventP_delete ( EventP_Handle * handle )

Function to delete an event.

Parameters

handle A EventP_Handle returned from EventP_create

Returns

Status of the functions

EventP_OK: Deleted the event instance
EventP_FAILURE: Failed to delete the event instance

◆ EventP_Params_init()

void EventP_Params_init ( EventP_Params * params )

Initialize params structure to default values.

Parameters

params Pointer to the instance configuration parameters.

◆ EventP_wait()

uint32_t EventP_wait	(	EventP_Handle	handle,
		uint32_t	eventMask,
		uint8_t	waitMode,
		uint32_t	timeout
	)

Function for Event Wait.

Parameters

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

Returns: All consumed events or zero if timeout

◆ EventP_post()

EventP_Status EventP_post	(	EventP_Handle	handle,
		uint32_t	eventMask
	)

Function for Event Post.

Parameters

handle	A EventP_Handle returned from EventP_create.
eventMask	mask of eventIds to post (must be non-zero)

Returns

Status of the functions

EventP_OK: Posted the events
EventP_FAILURE: Failed to post the events

◆ EventP_getPostedEvents()

uint32_t EventP_getPostedEvents ( EventP_Handle handle )

Function to return Event Posted.

Parameters

handle A EventP_Handle returned from EventP_create.

Returns: All un-consumed events posted

Introduction

Files

Data Structures

Functions

Typedefs

Enumerations

Macros

Event ID definitions

Macro Definition Documentation

◆ EventP_ID_NONE

◆ EventP_ID_00

◆ EventP_ID_01

◆ EventP_ID_02

◆ EventP_ID_03

◆ EventP_ID_04

◆ EventP_ID_05

◆ EventP_ID_06

◆ EventP_ID_07

◆ EventP_ID_08

◆ EventP_ID_09

◆ EventP_ID_10

◆ EventP_ID_11

◆ EventP_ID_12

◆ EventP_ID_13

◆ EventP_ID_14

◆ EventP_ID_15

◆ EventP_ID_16

◆ EventP_ID_17

◆ EventP_ID_18

◆ EventP_ID_19

◆ EventP_ID_20

◆ EventP_ID_21

◆ EventP_ID_22

◆ EventP_ID_23

◆ EventP_WAIT_FOREVER

◆ EventP_NO_WAIT

Typedef Documentation

◆ EventP_Handle

Enumeration Type Documentation

◆ EventP_Status

◆ EventP_WaitMode

Function Documentation

◆ EventP_create()

◆ EventP_delete()

◆ EventP_Params_init()

◆ EventP_wait()

◆ EventP_post()

◆ EventP_getPostedEvents()