#include <sf_adc_periodic_api.h>

Data Fields
ssp_err_t(*	open )(sf_adc_periodic_ctrl_t const p_ctrl, sf_adc_periodic_cfg_t const const p_cfg)

ssp_err_t(*	start )(sf_adc_periodic_ctrl_t *const p_ctrl)

ssp_err_t(*	stop )(sf_adc_periodic_ctrl_t *const p_ctrl)

ssp_err_t(*	close )(sf_adc_periodic_ctrl_t *const p_ctrl)

ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Framework Periodic ADC API structure. Implementations will use the following API.

Field Documentation

ssp_err_t(* sf_adc_periodic_api_t::close) (sf_adc_periodic_ctrl_t *const p_ctrl)

Releases channel mutex and closes channel at HAL layer.

Parameters

[in] p_ctrl Pointer to control block set in SF_ADC_PERIODIC_Open.

ssp_err_t(* sf_adc_periodic_api_t::open) (sf_adc_periodic_ctrl_t *const p_ctrl, sf_adc_periodic_cfg_t const *const p_cfg)

Acquires mutex, then initializes driver at the HAL layer

Parameters

[in,out]	p_ctrl	Pointer to a structure allocated by user. Elements initialized here.
[in]	p_cfg	Pointer to configuration structure. All elements of the structure must be set by user.

ssp_err_t(* sf_adc_periodic_api_t::start) (sf_adc_periodic_ctrl_t *const p_ctrl)

Starts the scan.

Warning: The driver will enable the ADC to be triggered via timer event; there will be a time delay from the time this function is called to the time the hardware timer count expires and triggers the scan.

Parameters

[in] p_ctrl Pointer to control block set in SF_ADC_PERIODIC_Open.

ssp_err_t(* sf_adc_periodic_api_t::stop) (sf_adc_periodic_ctrl_t *const p_ctrl)

Stops the hardware trigger (timer) from triggering any more ADC scans.

Parameters

[in] p_ctrl Pointer to control block set in SF_ADC_PERIODIC_Open.

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

Gets version and stores it in provided pointer p_version.

Parameters

[out] p_version Code and API version used.

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