ELC

Driver for the Event Link Controller (ELC). More...

Functions
ssp_err_t	R_ELC_Init (elc_cfg_t const *const p_cfg)
	Initialize all the links in the Event Link Controller. More...
ssp_err_t	R_ELC_SoftwareEventGenerate (elc_software_event_t event_number)
	Generate a software event in the Event Link Controller. More...
ssp_err_t	R_ELC_LinkSet (elc_peripheral_t peripheral, elc_event_t signal)
	Create a single event link. More...
ssp_err_t	R_ELC_LinkBreak (elc_peripheral_t peripheral)
	Break an event link. More...
ssp_err_t	R_ELC_Enable (void)
	Enable the operation of the Event Link Controller. More...
ssp_err_t	R_ELC_Disable (void)
	Disable the operation of the Event Link Controller. More...
ssp_err_t	R_ELC_VersionGet (ssp_version_t *const p_version)
	Get the driver version based on compile time macros. More...

Detailed Description

Driver for the Event Link Controller (ELC).

This module supports the Event Link Controller (ELC). It implements the following interface: events and peripheral definitions

Function Documentation

R_ELC_Disable()

ssp_err_t R_ELC_Disable

(

void

)

Disable the operation of the Event Link Controller.

Implements elc_api_t::disable

Return values

SSP_SUCCESS

ELC disabled.

Disable the Event Link Controller block.

R_ELC_Enable()

ssp_err_t R_ELC_Enable

(

void

)

Enable the operation of the Event Link Controller.

Implements elc_api_t::enable

Return values

SSP_SUCCESS

ELC enabled.

Enable the Event Link Controller block.

R_ELC_Init()

ssp_err_t R_ELC_Init

(

elc_cfg_t const *const

p_cfg

)

Initialize all the links in the Event Link Controller.

Implements elc_api_t::init

The configuration structure passed in to this function includes links for every event source included in the ELC and sets them all at once. To set an individual link use R_ELC_LinkSet()

Return values

SSP_SUCCESS	Initialization was successful
SSP_ERR_ASSERTION	p_config was NULL

Returns

See Common Error Codes or functions called by this function for other possible return codes. This function calls:

• fmi_api_t::productFeatureGet

Power on ELC

Enable the operation of the Event Link Controller

R_ELC_LinkBreak()

ssp_err_t R_ELC_LinkBreak

(

elc_peripheral_t

peripheral

)

Break an event link.

Implements elc_api_t::linkBreak

Return values

SSP_SUCCESS

Event link broken

Break a link between a signal and a peripheral.

R_ELC_LinkSet()

ssp_err_t R_ELC_LinkSet	(	elc_peripheral_t	peripheral,
		elc_event_t	signal
	)

Create a single event link.

Implements elc_api_t::linkSet

Return values

SSP_SUCCESS

Initialization was successful

Make a link between a signal and a peripheral.

R_ELC_SoftwareEventGenerate()

ssp_err_t R_ELC_SoftwareEventGenerate

(

elc_software_event_t

event_number

)

Generate a software event in the Event Link Controller.

Implements elc_api_t::softwareEventGenerate

Return values

SSP_SUCCESS	Initialization was successful
SSP_ERR_ASSERTION	Invalid event number

Generate a software event in the Event Link Controller.

R_ELC_VersionGet()

ssp_err_t R_ELC_VersionGet

(

ssp_version_t *const

p_version

)

Get the driver version based on compile time macros.

Implements elc_api_t::versionGet

Return values

SSP_SUCCESS	Successful close.
SSP_ERR_ASSERTION	p_version is NULL.