lvd_api_t Struct Reference

#include <r_lvd_api.h>

Data Fields
ssp_err_t(*	open )(lvd_ctrl_t *const p_ctrl, lvd_cfg_t const *const p_cfg)
ssp_err_t(*	statusGet )(lvd_ctrl_t *const p_ctrl, lvd_status_t *p_lvd_status)
ssp_err_t(*	statusClear )(lvd_ctrl_t *const p_ctrl)
ssp_err_t(*	close )(lvd_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

LVD driver API structure. LVD driver functions implemented at the HAL layer will adhere to this API.

Field Documentation

close

ssp_err_t(* lvd_api_t::close) (lvd_ctrl_t *const p_ctrl)

Disables the LVD peripheral. Closes the driver instance.

Implemented as

• R_LVD_Close()

Parameters

[in]

p_ctrl

Pointer to the control structure for the driver instance

open

ssp_err_t(* lvd_api_t::open) (lvd_ctrl_t *const p_ctrl, lvd_cfg_t const *const p_cfg)

Initializes a low voltage detection driver according to the passed in configuration structure. Enables an LVD peripheral based on configuration structure.

Implemented as

• R_LVD_Open()

Parameters

[in]	p_ctrl	Pointer to monitor control structure for the driver instance
[in]	p_cfg	Pointer to the configuration structure for the driver instance

statusClear

ssp_err_t(* lvd_api_t::statusClear) (lvd_ctrl_t *const p_ctrl)

Clears the latched status of the monitor. Must be used if the peripheral was initialized with lvd_response_t set to LVD_RESPONSE_NONE.

Implemented as

• R_LVD_StatusClear()

Parameters

[in]

p_ctrl

Pointer to the control structure for the driver instance

statusGet

ssp_err_t(* lvd_api_t::statusGet) (lvd_ctrl_t *const p_ctrl, lvd_status_t *p_lvd_status)

Get the current state of the monitor, (threshold crossing detected, voltage currently within range) Can be used to poll the state of the LVD monitor at any time. Must be used if the peripheral was initialized with lvd_response_t set to LVD_RESPONSE_NONE.

Implemented as

• R_LVD_StatusGet()

Parameters

[in]	p_ctrl	Pointer to the control structure for the driver instance
[in,out]	p_lvd_status	Pointer to an lvd_status_t instance

versionGet

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

Returns the LVD driver version based on compile time macros.

Implemented as

• R_LVD_VersionGet()

Parameters

[in,out]

p_version

Pointer to version structure

---

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

• r_lvd_api.h