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_clearEvent (uint32_t eventId)
	Function to clear 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...
int32_t	EventCombinerP_dispatchUnplug (uint32_t eventId)
	Function to unplug 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)

Osal Event Combiner return Codes
Return codes for Osal Event Combiner functions
#define	OSAL_EVTCOMBINE_GROUPREG_SUCCESS   (0)
#define	OSAL_EVTCOMBINE_ERR_GROUPREG_REGISTER_ERR   (-1)
#define	OSAL_EVTCOMBINE_ERR_GROUPREG_INVALID_INTNUM   (-2)

Osal Event Combiner Defualt Group Interrupts
Deafult group interrupt numbers for the Event Combiner These are the system default interrupt numbers if the Event Combiner has already not been registered If applications register Event Combiners during startup, these values may not be used (in SYSBIOS case) If not, these are the interrupts reserved for Event Combiner group events (0-3). These defaults are stored in Osal_HwAttrs.ECM_intNum[] and can be obtained by the application at run time through the OSAL API Osal_getHwAttrs(). These values also can be modified using Osal_setHwAttrs(Osal_HwAttrs,OSAL_HWATTR_SET_ECM_INT)
#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

OSAL_EVTCOMBINE_GROUPREG_SUCCESS

#define OSAL_EVTCOMBINE_GROUPREG_SUCCESS   (0)

Successful call

OSAL_EVTCOMBINE_ERR_GROUPREG_REGISTER_ERR

#define OSAL_EVTCOMBINE_ERR_GROUPREG_REGISTER_ERR   (-1)

Registration Error

OSAL_EVTCOMBINE_ERR_GROUPREG_INVALID_INTNUM

#define OSAL_EVTCOMBINE_ERR_GROUPREG_INVALID_INTNUM   (-2)

Invalid interrupt number

OSAL_ECM_GROUP0_INT

#define OSAL_ECM_GROUP0_INT   4

ECM group 0 default interrupt: 4

OSAL_ECM_GROUP1_INT

#define OSAL_ECM_GROUP1_INT   5

ECM group 1 default interrupt: 5

OSAL_ECM_GROUP2_INT

#define OSAL_ECM_GROUP2_INT   6

ECM group 2 default interrupt: 6

OSAL_ECM_GROUP3_INT

#define OSAL_ECM_GROUP3_INT   7

ECM group 3 default interrupt: 7

Typedef Documentation

EventCombinerP_FuncPtr

typedef void(* EventCombinerP_FuncPtr) (uint32_t arg)

Function Documentation

EventCombinerP_disableEvent()

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

EventCombinerP_enableEvent()

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

EventCombinerP_clearEvent()

int32_t EventCombinerP_clearEvent

(

uint32_t

eventId

)

Function to clear an event inside event combiner.

Parameters

eventId

event ID to be cleared in the event combiner

EventCombinerP_dispatchPlug()

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

EventCombinerP_dispatchUnplug()

int32_t EventCombinerP_dispatchUnplug

(

uint32_t

eventId

)

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

Parameters

eventId

The event id (4-127)

EventCombinerP_getHwi()

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)

EventCombinerP_getIntNum()

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)

EventCombinerP_SingleRegisterInt()

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)

EventCombinerP_GroupRegisterInt()

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)