Synergy Software Package User's Manual

#include <r_dac_api.h>

Data Fields

ssp_err_t(* open )(dac_ctrl_t *p_ctrl, dac_cfg_t const *const p_cfg)
 
ssp_err_t(* close )(dac_ctrl_t *p_ctrl)
 
ssp_err_t(* write )(dac_ctrl_t *p_ctrl, dac_size_t value)
 
ssp_err_t(* start )(dac_ctrl_t *p_ctrl)
 
ssp_err_t(* stop )(dac_ctrl_t *p_ctrl)
 
ssp_err_t(* versionGet )(ssp_version_t *p_version)
 
ssp_err_t(* infoGet )(dac_info_t *const p_info)
 

Detailed Description

DAC driver structure. General DAC functions implemented at the HAL layer follow this API.

Field Documentation

◆ close

ssp_err_t(* dac_api_t::close) (dac_ctrl_t *p_ctrl)

Close the D/A Converter.

Implemented as
Parameters
[in]p_ctrlControl block set in dac_api_t::open call for this timer.

◆ infoGet

ssp_err_t(* dac_api_t::infoGet) (dac_info_t *const p_info)

Get information about DAC Resolution and store it in provided pointer p_info.

Implemented as
Parameters
[out]p_infoCollection of information for this DAC.

◆ open

ssp_err_t(* dac_api_t::open) (dac_ctrl_t *p_ctrl, dac_cfg_t const *const p_cfg)

Initial configuration.

Implemented as
Parameters
[in]p_ctrlPointer to control block. Must be declared by user. Elements set here.
[in]p_cfgPointer to configuration structure. All elements of this structure must be set by user.

◆ start

ssp_err_t(* dac_api_t::start) (dac_ctrl_t *p_ctrl)

Start the D/A Converter if it has not been started yet.

Implemented as
Parameters
[in]p_ctrlControl block set in dac_api_t::open call for this timer.

◆ stop

ssp_err_t(* dac_api_t::stop) (dac_ctrl_t *p_ctrl)

Stop the D/A Converter if the converter is running.

Implemented as
Parameters
[in]p_ctrlControl block set in dac_api_t::open call for this timer.

◆ versionGet

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

Get version and store it in provided pointer p_version.

Implemented as
Parameters
[out]p_versionCode and API version used.

◆ write

ssp_err_t(* dac_api_t::write) (dac_ctrl_t *p_ctrl, dac_size_t value)

Write sample value to the D/A Converter.

Implemented as
Parameters
[in]p_ctrlControl block set in dac_api_t::open call for this timer.
[in]valueSample value to be written to the D/A Converter.

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