wdt_api_t Struct Reference

#include <r_wdt_api.h>

Data Fields
ssp_err_t(*	cfgGet )(wdt_ctrl_t *const p_ctrl, wdt_cfg_t *const p_cfg)
ssp_err_t(*	open )(wdt_ctrl_t *const p_ctrl, wdt_cfg_t const *const p_cfg)
ssp_err_t(*	refresh )(wdt_ctrl_t *const p_ctrl)
ssp_err_t(*	statusGet )(wdt_ctrl_t *const p_ctrl, wdt_status_t *const p_status)
ssp_err_t(*	statusClear )(wdt_ctrl_t *const p_ctrl, const wdt_status_t status)
ssp_err_t(*	counterGet )(wdt_ctrl_t *const p_ctrl, uint32_t *const p_count)
ssp_err_t(*	timeoutGet )(wdt_ctrl_t *const p_ctrl, wdt_timeout_values_t *const p_timeout)
ssp_err_t(*	versionGet )(ssp_version_t *const p_data)

Detailed Description

WDT functions implemented at the HAL layer will follow this API.

Field Documentation

cfgGet

ssp_err_t(* wdt_api_t::cfgGet) (wdt_ctrl_t *const p_ctrl, wdt_cfg_t *const p_cfg)

Initialize the WDT in register start mode. In auto-start mode with NMI output it registers the NMI callback.

Implemented as

• R_WDT_CfgGet()
• R_IWDT_CfgGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_cfg	Pointer to pin configuration structure for reading WDT configuration.

counterGet

ssp_err_t(* wdt_api_t::counterGet) (wdt_ctrl_t *const p_ctrl, uint32_t *const p_count)

Read the current WDT counter value.

Implemented as

• R_WDT_CounterGet()
• R_IWDT_CounterGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_count	Pointer to variable to return current WDT counter value.

open

ssp_err_t(* wdt_api_t::open) (wdt_ctrl_t *const p_ctrl, wdt_cfg_t const *const p_cfg)

Initialize the WDT in register start mode. In auto-start mode with NMI output it registers the NMI callback.

Implemented as

• R_WDT_Open()
• R_IWDT_Open()

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to pin configuration structure.

refresh

ssp_err_t(* wdt_api_t::refresh) (wdt_ctrl_t *const p_ctrl)

Refresh the watchdog timer.

Implemented as

• R_WDT_Refresh()
• R_IWDT_Refresh()

Precondition

If the WDT is in auto-start mode ensure the OFS0 register is configured before using this function.

Warning

Calling this function in register-start mode before calling R_WDT_Open will start the WDT in it's default state and further changes to the configuration will not be possible.

Parameters

[in]

p_ctrl

Pointer to control structure.

statusClear

ssp_err_t(* wdt_api_t::statusClear) (wdt_ctrl_t *const p_ctrl, const wdt_status_t status)

Clear the status flags of the WDT.

Implemented as

• R_WDT_StatusClear()
• R_IWDT_StatusClear()

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	status	Status condition(s) to clear.

statusGet

ssp_err_t(* wdt_api_t::statusGet) (wdt_ctrl_t *const p_ctrl, wdt_status_t *const p_status)

Read the status of the WDT.

Implemented as

• R_WDT_StatusGet()
• R_IWDT_StatusGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_status	Pointer to variable to return status information through.

timeoutGet

ssp_err_t(* wdt_api_t::timeoutGet) (wdt_ctrl_t *const p_ctrl, wdt_timeout_values_t *const p_timeout)

Read the watchdog timeout values.

Implemented as

• R_WDT_TimeoutGet()
• R_IWDT_TimeoutGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_timeout	Pointer to structure to return timeout values.

versionGet

ssp_err_t(* wdt_api_t::versionGet) (ssp_version_t *const p_data)

Return the version of the IOPort driver.

Implemented as

• R_WDT_VersionGet()
• R_IWDT_VersionGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_data	Memory address to return version information to.

---

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

• r_wdt_api.h