opamp_api_t Struct Reference

#include <r_opamp_api.h>

Data Fields
ssp_err_t(*	open )(opamp_ctrl_t *const p_ctrl, opamp_cfg_t const *const p_cfg)
ssp_err_t(*	start )(opamp_ctrl_t *const p_ctrl, uint32_t const channel_mask)
ssp_err_t(*	stop )(opamp_ctrl_t *const p_ctrl, uint32_t const channel_mask)
ssp_err_t(*	trim )(opamp_ctrl_t *const p_ctrl, opamp_trim_cmd_t const cmd, opamp_trim_args_t const *const p_args)
ssp_err_t(*	infoGet )(opamp_ctrl_t *const p_ctrl, opamp_info_t *const p_info)
ssp_err_t(*	statusGet )(opamp_ctrl_t *const p_ctrl, opamp_status_t *const p_status)
ssp_err_t(*	close )(opamp_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

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

Field Documentation

close

ssp_err_t(* opamp_api_t::close) (opamp_ctrl_t *const p_ctrl)

Close the specified OPAMP unit by ending any scan in progress, disabling interrupts, and removing power to the specified A/D unit.

Implemented as

• R_OPAMP_Close()

Parameters

[in]

p_ctrl

Pointer to instance control block

infoGet

ssp_err_t(* opamp_api_t::infoGet) (opamp_ctrl_t *const p_ctrl, opamp_info_t *const p_info)

Provide information such as the recommended minimum stabilization wait time.

Implemented as

• R_OPAMP_InfoGet()

Parameters

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

open

ssp_err_t(* opamp_api_t::open) (opamp_ctrl_t *const p_ctrl, opamp_cfg_t const *const p_cfg)

Initialize the operational amplifier.

Implemented as

• R_OPAMP_Open()

Parameters

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

start

ssp_err_t(* opamp_api_t::start) (opamp_ctrl_t *const p_ctrl, uint32_t const channel_mask)

Start the op-amp(s).

Implemented as

• R_OPAMP_Start()

Parameters

[in]	p_ctrl	Pointer to instance control block
[in]	channel_mask	Bitmask of channels to start

statusGet

ssp_err_t(* opamp_api_t::statusGet) (opamp_ctrl_t *const p_ctrl, opamp_status_t *const p_status)

Provide status of each op-amp channel.

Implemented as

• R_OPAMP_StatusGet()

Parameters

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

stop

ssp_err_t(* opamp_api_t::stop) (opamp_ctrl_t *const p_ctrl, uint32_t const channel_mask)

Stop the op-amp(s).

Implemented as

• R_OPAMP_Stop()

Parameters

[in]	p_ctrl	Pointer to instance control block
[in]	channel_mask	Bitmask of channels to stop

trim

ssp_err_t(* opamp_api_t::trim) (opamp_ctrl_t *const p_ctrl, opamp_trim_cmd_t const cmd, opamp_trim_args_t const *const p_args)

Trim the op-amp(s). Not supported on all MCUs. See implementation for procedure details.

Implemented as

• R_OPAMP_Trim()

Parameters

[in]	p_ctrl	Pointer to instance control block
[in]	cmd	Trim command
[in]	p_args	Pointer to arguments for the command

versionGet

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

Retrieve the API version.

Implemented as

• R_OPAMP_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_opamp_api.h