EventCombinerP

Introduction

EventCombinerP interface

Files
file	EventCombinerP.h
	Event Combiner routines for the RTOS Porting Interface.

Functions
int32_t	EventCombinerP_disableEvent (uint32_t eventId)
	Function to disable an event inside event combiner. More...
int32_t	EventCombinerP_enableEvent (uint32_t eventId)
	Function to enable an event inside event combiner. More...
int32_t	EventCombinerP_dispatchPlug (uint32_t eventId, EventCombinerP_FuncPtr eventIsrRoutine, uintptr_t arg, bool unmask)
	Function to plug an ISR handler to an event inside event combiner. More...
HwiP_Handle	EventCombinerP_getHwi (uint32_t groupNum)
	Function to return the Hwi Handle corresponding to an event combiner group number. More...
int32_t	EventCombinerP_getIntNum (int32_t groupNum)
	Function to return the interrupt vector number corresponding to a group number (0-3) More...
int32_t	EventCombinerP_SingleRegisterInt (int32_t groupNum, int32_t intNum)
	Function to register single event combiner group to a vector number. More...
int32_t	EventCombinerP_GroupRegisterInt (int32_t intNum[])
	Function to register single event combiner group to a vector number. More...

Typedefs
typedef void(*	EventCombinerP_FuncPtr) (uint32_t arg)

Macros
#define	OSAL_EVTCOMBINE_GROUPREG_SUCCESS   (0)
#define	OSAL_EVTCOMBINE_ERR_GROUPREG_REGISTER_ERR   (-1)
#define	OSAL_EVTCOMBINE_ERR_GROUPREG_INVALID_INTNUM   (-2)
#define	OSAL_ECM_GROUP0_INT   4
#define	OSAL_ECM_GROUP1_INT   5
#define	OSAL_ECM_GROUP2_INT   6
#define	OSAL_ECM_GROUP3_INT   7

Macro Definition Documentation

#define OSAL_EVTCOMBINE_GROUPREG_SUCCESS   (0)

#define OSAL_EVTCOMBINE_ERR_GROUPREG_REGISTER_ERR   (-1)

#define OSAL_EVTCOMBINE_ERR_GROUPREG_INVALID_INTNUM   (-2)

#define OSAL_ECM_GROUP0_INT   4

#define OSAL_ECM_GROUP1_INT   5

#define OSAL_ECM_GROUP2_INT   6

#define OSAL_ECM_GROUP3_INT   7

Typedef Documentation

typedef void(* EventCombinerP_FuncPtr) (uint32_t arg)

Function Documentation

int32_t EventCombinerP_disableEvent

(

uint32_t

eventId

)

Function to disable an event inside event combiner.

Parameters

eventId

event ID to be disabled in the event combiner

int32_t EventCombinerP_enableEvent

(

uint32_t

eventId

)

Function to enable an event inside event combiner.

Parameters

eventId

event ID to be disabled in the event combiner

int32_t EventCombinerP_dispatchPlug	(	uint32_t	eventId,
		EventCombinerP_FuncPtr	eventIsrRoutine,
		uintptr_t	arg,
		bool	unmask
	)

Function to plug an ISR handler to an event inside event combiner.

Parameters

eventId	The event id (4-127)
eventIsrRoutine	The ISR routine for servicing the event
arg	The argument to the ISR routine
unmask	Unmask the event

HwiP_Handle EventCombinerP_getHwi

(

uint32_t

groupNum

)

Function to return the Hwi Handle corresponding to an event combiner group number.

Parameters

groupNum

The event combiner group id (0-3)

int32_t EventCombinerP_getIntNum

(

int32_t

groupNum

)

Function to return the interrupt vector number corresponding to a group number (0-3)

Parameters

groupNum

The event combiner group id (0-3)

int32_t EventCombinerP_SingleRegisterInt	(	int32_t	groupNum,
		int32_t	intNum
	)

Function to register single event combiner group to a vector number.

Parameters

groupNum	The event combiner group id (0-3)
intNum	The interrupt vector id (4-15)

int32_t EventCombinerP_GroupRegisterInt

(

int32_t

intNum[]

)

Function to register single event combiner group to a vector number.

Parameters

intNum

[] List of interrupt vector ids (4-15) per ECM group(0-3)