Event

Overview

Event API.

Functions
IOL_FUNC_DECL void	IOLM_API_AL_vEventRsp (INT8U u8Port_p)
	Acknowledge Device Events. More...
IOL_FUNC_DECL void	IOLM_Port_AL_vEventInd (INT8U u8Port_p, IOL_EEInstance eEInstance_p, IOL_EEType eEType_p, IOL_EESource eOrigin_p, IOL_EEMode eEMode_p, INT16U u16ECode_p)
	Event indication. More...

Function Documentation

IOLM_API_AL_vEventRsp()

IOL_FUNC_DECL void IOLM_API_AL_vEventRsp

(

INT8U

u8Port_p

)

Acknowledge Device Events.

The event response function acknowledges the events which are signaled by event indication. Only events with origin IOL_eESource_DEVICE need to be acknowledged. Other events can also be acknowledged. This is used to prevent event flooding by the Device. The Device sends no further events until the pending one is acknowledged by this function.

Parameters

[in]

u8Port_p

The port number of the affected port.

Returns

void

Precondition

The port number must be smaller than IOLM_PORT_COUNT.

Postcondition

Further Device Events can be indicated

IRQ-safe

No Function needs to be called in Mainloop context.

IOLM_Port_AL_vEventInd()

IOL_FUNC_DECL void IOLM_Port_AL_vEventInd	(	INT8U	u8Port_p,
		IOL_EEInstance	eEInstance_p,
		IOL_EEType	eEType_p,
		IOL_EESource	eOrigin_p,
		IOL_EEMode	eEMode_p,
		INT16U	u16ECode_p
	)

Event indication.

This function is called if events for a specific port are available. If the events are handled, the function IOLM_API_AL_vEventRsp has to be called. There is no further IOL_eESource_DEVICE event indicated until the last is confirmed. Events which are only needed for internal handling (DataStorage, ISDU, etc) are handled by the stack and are not indicated.

Parameters

[in]	u8Port_p	The port number of the affected port.
[in]	eEInstance_p	Event instance.
[in]	eEType_p	Event type.
[in]	eOrigin_p	Event source.
[in]	eEMode_p	Event mode.
[in]	u16ECode_p	EventCode.

Returns

void

IRQ-safe

No Function will be called from Mainloop context.