comparator_api_t Struct Reference

#include <r_comparator_api.h>

Data Fields
ssp_err_t(*	open )(comparator_ctrl_t *const p_ctrl, comparator_cfg_t const *const p_cfg)
ssp_err_t(*	outputEnable )(comparator_ctrl_t *const p_ctrl)
ssp_err_t(*	infoGet )(comparator_ctrl_t *const p_ctrl, comparator_info_t *const p_info)
ssp_err_t(*	statusGet )(comparator_ctrl_t *const p_ctrl, comparator_status_t *const p_status)
ssp_err_t(*	close )(comparator_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

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

Field Documentation

close

ssp_err_t(* comparator_api_t::close) (comparator_ctrl_t *const p_ctrl)

Stop the comparator.

Implemented as

• R_ACMPHS_Close()
• R_ACMPLP_Close()

Parameters

[in]

p_ctrl

Pointer to instance control block

infoGet

ssp_err_t(* comparator_api_t::infoGet) (comparator_ctrl_t *const p_ctrl, comparator_info_t *const p_info)

Provide information such as the recommended minimum stabilization wait time.

Implemented as

• R_ACMPHS_InfoGet()
• R_ACMPLP_InfoGet()

Parameters

[in]	p_ctrl	Pointer to instance control block
[out]	p_info	Comparator information stored here

open

ssp_err_t(* comparator_api_t::open) (comparator_ctrl_t *const p_ctrl, comparator_cfg_t const *const p_cfg)

Initialize the comparator.

Implemented as

• R_ACMPHS_Open()
• R_ACMPLP_Open()

Parameters

[in]	p_ctrl	Pointer to instance control block
[in]	p_cfg	Pointer to configuration

outputEnable

ssp_err_t(* comparator_api_t::outputEnable) (comparator_ctrl_t *const p_ctrl)

Start the comparator.

Implemented as

• R_ACMPHS_OutputEnable()
• R_ACMPLP_OutputEnable()

Parameters

[in]

p_ctrl

Pointer to instance control block

statusGet

ssp_err_t(* comparator_api_t::statusGet) (comparator_ctrl_t *const p_ctrl, comparator_status_t *const p_status)

Provide current comparator status.

Implemented as

• R_ACMPHS_StatusGet()
• R_ACMPLP_StatusGet()

Parameters

[in]	p_ctrl	Pointer to instance control block
[out]	p_status	Status stored here

versionGet

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

Retrieve the API version.

Implemented as

• R_ACMPHS_VersionGet()
• R_ACMPLP_VersionGet()

Precondition

This function retrieves the API version.

Parameters

[in]

p_version

Pointer to version structure

---

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

• r_comparator_api.h