cac_api_t Struct Reference

#include <r_cac_api.h>

Data Fields
ssp_err_t(*	open )(cac_ctrl_t *const p_ctrl, cac_cfg_t const *const p_cfg)
ssp_err_t(*	read )(cac_ctrl_t *const p_ctrl, uint8_t *const p_status, uint16_t *const p_counter)
ssp_err_t(*	close )(cac_ctrl_t *const p_ctrl)
ssp_err_t(*	stopMeasurement )(cac_ctrl_t *const p_ctrl)
ssp_err_t(*	startMeasurement )(cac_ctrl_t *const p_ctrl)
ssp_err_t(*	reset )(cac_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *p_version)

Detailed Description

CAC functions implemented at the HAL layer API

Field Documentation

close

ssp_err_t(* cac_api_t::close) (cac_ctrl_t *const p_ctrl)

Close function for CAC device.

Parameters

[in]

p_ctrl

Pointer to CAC device control.

open

ssp_err_t(* cac_api_t::open) (cac_ctrl_t *const p_ctrl, cac_cfg_t const *const p_cfg)

Open function for CAC device.

Parameters

[out]	p_ctrl	Pointer to CAC device control. Must be declared by user. Value set here.
[in]	cac_cfg_t	Pointer to CAC configuration structure. All elements of this structure must be set by user.

read

ssp_err_t(* cac_api_t::read) (cac_ctrl_t *const p_ctrl, uint8_t *const p_status, uint16_t *const p_counter)

Read function for CAC peripheral.

Parameters

[in]	p_ctrl	Control for the CAC device context.
[in]	p_status	Pointer to variable in which to store the current CASTR register contents.
[in]	p_counter	Pointer to variable in which to store the current CACNTBR register contents.

reset

ssp_err_t(* cac_api_t::reset) (cac_ctrl_t *const p_ctrl)

Reset function for CAC device.

Parameters

[in]

p_ctrl

Pointer to CAC device control.

startMeasurement

ssp_err_t(* cac_api_t::startMeasurement) (cac_ctrl_t *const p_ctrl)

Begin a measurement for the CAC peripheral.

Parameters

[in]

p_ctrl

Pointer to CAC device control.

stopMeasurement

ssp_err_t(* cac_api_t::stopMeasurement) (cac_ctrl_t *const p_ctrl)

End a measurement for the CAC peripheral.

Parameters

[in]

p_ctrl

Pointer to CAC device control.

versionGet

ssp_err_t(* cac_api_t::versionGet) (ssp_version_t *p_version)

Get the CAC API and code version information.

Parameters

[out]

p_version

is value returned.

---

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

• r_cac_api.h