external_irq_api_t Struct Reference

#include <r_external_irq_api.h>

Data Fields
ssp_err_t(*	open )(external_irq_ctrl_t *const p_ctrl, external_irq_cfg_t const *const p_cfg)
ssp_err_t(*	enable )(external_irq_ctrl_t *const p_ctrl)
ssp_err_t(*	disable )(external_irq_ctrl_t *const p_ctrl)
ssp_err_t(*	triggerSet )(external_irq_ctrl_t *const p_ctrl, external_irq_trigger_t const trigger)
ssp_err_t(*	filterEnable )(external_irq_ctrl_t *const p_ctrl)
ssp_err_t(*	filterDisable )(external_irq_ctrl_t *const p_ctrl)
ssp_err_t(*	close )(external_irq_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

External interrupt driver structure. External interrupt functions implemented at the HAL layer will follow this API.

Field Documentation

close

ssp_err_t(* external_irq_api_t::close) (external_irq_ctrl_t *const p_ctrl)

Allow driver to be reconfigured. May reduce power consumption.

Implemented as

• R_ICU_ExternalIrqClose()

Parameters

[in]

p_ctrl

Control block set in Open call for this external interrupt.

disable

ssp_err_t(* external_irq_api_t::disable) (external_irq_ctrl_t *const p_ctrl)

Disable callback when external IRQ occurs.

Implemented as

• R_ICU_ExternalIrqDisable()

Parameters

[in]

p_ctrl

Control block set in Open call for this external interrupt.

enable

ssp_err_t(* external_irq_api_t::enable) (external_irq_ctrl_t *const p_ctrl)

Enable callback when external IRQ occurs.

Implemented as

• R_ICU_ExternalIrqEnable()

Parameters

[in]

p_ctrl

Control block set in Open call for this external interrupt.

filterDisable

ssp_err_t(* external_irq_api_t::filterDisable) (external_irq_ctrl_t *const p_ctrl)

Disable noise filter.

Implemented as

• R_ICU_ExternalIrqFilterDisable()

Parameters

[in]

p_ctrl

Control block set in Open call for this external interrupt.

filterEnable

ssp_err_t(* external_irq_api_t::filterEnable) (external_irq_ctrl_t *const p_ctrl)

Enables noise filter.

Implemented as

• R_ICU_ExternalIrqFilterEnable()

Parameters

[in]

p_ctrl

Control block set in Open call for this external interrupt.

open

ssp_err_t(* external_irq_api_t::open) (external_irq_ctrl_t *const p_ctrl, external_irq_cfg_t const *const p_cfg)

Initial configuration.

Implemented as

• R_ICU_ExternalIrqOpen()

Parameters

[out]	p_ctrl	Pointer to control block. Must be declared by user. Value set here.
[in]	p_cfg	Pointer to configuration structure. All elements of the structure must be set by user.

triggerSet

ssp_err_t(* external_irq_api_t::triggerSet) (external_irq_ctrl_t *const p_ctrl, external_irq_trigger_t const trigger)

Set trigger.

Implemented as

• R_ICU_ExternalIrqTriggerSet()

Parameters

[in]	p_ctrl	Control block set in Open call for this external interrupt.
[in]	trigger	Trigger type

versionGet

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

Get version and store it in provided pointer p_version.

Implemented as

• R_ICU_ExternalIrqVersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• r_external_irq_api.h