Contains USS SW Lib HSPLL Configuration. More...

#include <ussSwLib.h>

Data Fields
USS_HSPLL_input_clock_freq	ussXtalFreq

USS_HSPLL_input_clock_type	HSPLLInputCLKType

USS_HSPLL_output_clk_freq	pllOutputFreq

bool	outputPLLXtal

uint16_t	hspllTolerance

uint16_t	ussXTALsettlingCount

Detailed Description

Contains USS SW Lib HSPLL Configuration.

Field Documentation

§ ussXtalFreq

USS_HSPLL_input_clock_freq _USS_HSPLL_Configuration_::ussXtalFreq

Referenced by commonValidateHSPLLconfiguration(), and USS_updateHSPLLConfiguration().

§ HSPLLInputCLKType

USS_HSPLL_input_clock_type _USS_HSPLL_Configuration_::HSPLLInputCLKType

Referenced by USS_updateHSPLLConfiguration().

§ pllOutputFreq

USS_HSPLL_output_clk_freq _USS_HSPLL_Configuration_::pllOutputFreq

If this paramater is modified during runtime, two update APIs need to called; USS_updateHSPLLConfiguration and USS_updateSDHSCapture. USS_updateSDHSCapture needs to be select the correct modulator optimization bits and obtain maximum performance of the SDHS based on the new HSPLL frequency.

Registers modified:HSPLL.CTL.PLLM and SAPH.CTL7.MODOPTI

Referenced by commonGetHSPLLFreqInHz(), commonSDHSConfigModOpt(), commonValidateHSPLLconfiguration(), commonValidateSAPHconfigruation(), commonValidateSDHSconfigruation(), USS_updateHSPLLConfiguration(), and USS_verifyHSPLLFrequency().

§ outputPLLXtal

bool _USS_HSPLL_Configuration_::outputPLLXtal

true = outputs HSPLL crystal , false = does not outputs HSPLL crystal

Registers modified:HSPLL.PLLXTCTL.XTOUTOFF

Referenced by USS_updateHSPLLConfiguration().

§ hspllTolerance

uint16_t _USS_HSPLL_Configuration_::hspllTolerance

number of hspll cycle variance tolerance. Value can be between 0-255 This parameter is required when calling USS_verifyHSPLLFrequency

Referenced by USS_verifyHSPLLFrequency().

§ ussXTALsettlingCount

uint16_t _USS_HSPLL_Configuration_::ussXTALsettlingCount

Specifies the number of LFXT cycles needed to allow USS XT to settle. ussXTALsettlelingCount = ceiling[(LFXTFrequency_inHz)*(settling_in_Sec)] For example if settling time for USSXT is 120usec and LFXTFrequency is configure for 32768 Hz. Then ussXTALsettlelingCount = ceiling[(32768)*(120e-6)] = 4 Please refer to the device datasheet for recommended USSXT settling time ussXTALsettlelingCount must a non-zero positive value Please also refer to USS_startLowPowerUltrasonicCapture API for more detail regarding this parameter usage during low power capture.

Referenced by commonStabilizeOscillator(), commonValidateHSPLLconfiguration(), and USS_commonTriggerSingleCapture().

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

ussSwLib.h

Data Fields