elc_api_t Struct Reference

#include <r_elc_api.h>

Data Fields
ssp_err_t(*	init )(elc_cfg_t const *const p_cfg)
ssp_err_t(*	softwareEventGenerate )(elc_software_event_t event_num)
ssp_err_t(*	linkSet )(elc_peripheral_t peripheral, elc_event_t signal)
ssp_err_t(*	linkBreak )(elc_peripheral_t peripheral)
ssp_err_t(*	enable )(void)
ssp_err_t(*	disable )(void)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

ELC driver structure. General ELC functions implemented at the HAL layer follow this API.

Field Documentation

disable

ssp_err_t(* elc_api_t::disable) (void)

Disable the operation of the Event Link Controller.

Implemented as

• R_ELC_Disable()

enable

ssp_err_t(* elc_api_t::enable) (void)

Enable the operation of the Event Link Controller.

Implemented as

• R_ELC_Enable()

init

ssp_err_t(* elc_api_t::init) (elc_cfg_t const *const p_cfg)

Initialize all links in the Event Link Controller.

Implemented as

• R_ELC_Init()

Parameters

[in]

p_cfg

Pointer to configuration structure.

linkBreak

ssp_err_t(* elc_api_t::linkBreak) (elc_peripheral_t peripheral)

Break an event link.

Implemented as

• R_ELC_LinkBreak()

Parameters

[in]

peripheral

The peripheral that should no longer be linked.

linkSet

ssp_err_t(* elc_api_t::linkSet) (elc_peripheral_t peripheral, elc_event_t signal)

Create a single event link.

Implemented as

• R_ELC_LinkSet()

Parameters

[in]	peripheral	The peripheral block that will receive the event signal.
[in]	signal	The event signal.

softwareEventGenerate

ssp_err_t(* elc_api_t::softwareEventGenerate) (elc_software_event_t event_num)

Generate a software event in the Event Link Controller.

Implemented as

• R_ELC_SoftwareEventGenerate()

Parameters

[in]

eventNum

Software event number to be generated.

versionGet

ssp_err_t(* elc_api_t::versionGet) (ssp_version_t *const p_version)

Get the driver version based on compile time macros.

Implemented as

• R_ELC_VersionGet()

Parameters

[out]

p_version

is value returned.

---

The documentation for this struct was generated from the following file:

• r_elc_api.h