_USS_Measurement_Configuration_ Struct Reference

Contains USS SW Lib Measurement Configuration. More...

#include <ussSwLib.h>

Collaboration diagram for _USS_Measurement_Configuration_:

Data Fields
USS_measurement_capture_sequence	sequenceSelection
USS_measurement_end_of_sequence_state	eofSequenceState
USS_measurement_drive_strength	ch0DriveStrength
USS_measurement_drive_strength	ch1DriveStrength
USS_Pulse_Configuration *	pulseConfig
uint_least16_t	startPPGCount
uint_least16_t	turnOnADCCount
uint_least16_t	startPGAandINBiasCount
uint_least16_t	startADCsamplingCount
uint_least16_t	restartCaptureCount
uint_least16_t	captureTimeOutCount
uint_least16_t	restartLowPowerCaptureCount
USS_measurement_ULP_bias_delay	ulpBiasDelay
USS_measurement_bias_impedance	biasImpedance
	Allows user to control bias channel bias impedance. More...
USS_measurement_mux_charge_pump	muxChargePumpMode
	Allows user to control multiplexer charge pump during capture. More...
uint16_t	startRxEnCount

Detailed Description

Contains USS SW Lib Measurement Configuration.

Field Documentation

sequenceSelection

USS_measurement_capture_sequence _USS_Measurement_Configuration_::sequenceSelection

Referenced by USS_calculateOffsets(), USS_startLowPowerUltrasonicCapture(), USS_swapCaptureChannels(), and USS_updateSAPHConfiguration().

eofSequenceState

USS_measurement_end_of_sequence_state _USS_Measurement_Configuration_::eofSequenceState

Referenced by USS_startLowPowerUltrasonicCapture(), USS_startUltrasonicMeasurement(), and USS_updateSAPHConfiguration().

ch0DriveStrength

USS_measurement_drive_strength _USS_Measurement_Configuration_::ch0DriveStrength

Referenced by USS_updateSAPHConfiguration().

ch1DriveStrength

USS_measurement_drive_strength _USS_Measurement_Configuration_::ch1DriveStrength

Referenced by USS_updateSAPHConfiguration().

pulseConfig

USS_Pulse_Configuration* _USS_Measurement_Configuration_::pulseConfig

Referenced by commonConfigurePPGDutyCyle(), commonValidateSAPHconfigruation(), USS_commonTriggerSingleCapture(), USS_startPPGToneGeneration(), and USS_updateSAPHConfiguration().

startPPGCount

uint_least16_t _USS_Measurement_Configuration_::startPPGCount

This count determines the time to start the PPG pulse trigger. The count is based on 1 ASQ clock = (HSPLL_CLOCK_FREQ/16) period. For examples if startPPGCount = 15 and ASQ clock is 68 MHz, then PPG pulse will be triggered
(16/68MHz)*(1)*(startPPGCount) = (16/68MHz)*(1)*(15)= 3.52 usec, after
acquisiton sequence has been triggered.

"startPPGCount" valid range (0x0002 - 0xFFFF)

Registers modified: SAPH.ATM_A.TimeMarkA

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

turnOnADCCount

uint_least16_t _USS_Measurement_Configuration_::turnOnADCCount

This count determines the time to arm (turn on ADC). This count is based on 1 ASQ clock = (HSPLL_CLOCK_FREQ/16) period. For examples if turnOnADCCount = 15 and ASQ clock is 68 MHz, then ADC will be turned on
(1/ASQ_clock_freq)*(1)*(turnOnADCCount)= (1/68MHz)*(1)*(15) =0.22 usec,
after acquisiton sequence has been triggered.

"turnOnADCCount" valid range (0x0002 - 0xFFFF)

Registers modified: SAPH.ATM_B.TimeMarkB

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

startPGAandINBiasCount

uint_least16_t _USS_Measurement_Configuration_::startPGAandINBiasCount

This count determines the time start the PGA and input biasing. This count is based on 1 ASQ clock = (HSPLL_CLOCK_FREQ/16) period. For examples if turnOnADCCount = 15 and ASQ clock is 68 MHz, then ADC will be turned on
(1/ASQ_clock_freq)*(1)*(turnOnADCCount)= (1/68MHz)*(1)*(15)=0.22 usec,
after acquisiton sequence has been triggered.

"turnOnADCCount" valid range (0x0002 - 0xFFFF)

Registers modified: SAPH.ATM_C.TimeMarkC

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

startADCsamplingCount

uint_least16_t _USS_Measurement_Configuration_::startADCsamplingCount

This count determines the time to start the ADC acquisition. This count is based on 1 ASQ clock = (HSPLL_CLOCK_FREQ/16) period. For examples if turnOnADCCount = 15 and ASQ clock is 68 MHz, then ADC sampling will start
(1/ASQ_clock_freq)*(1)*(startADCsamplingCount) = (1/68MHz)*(1)*(15) = 0.22 usec
after acquisiton sequence has been triggered.

"startADCsamplingCount" valid range (0x0002 - 0xFFFF)

Registers modified: SAPH.ATM_D.TimeMarkD

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

restartCaptureCount

uint_least16_t _USS_Measurement_Configuration_::restartCaptureCount

This count determined the time to trigger next capture. This count is based on 16 ASQ clock= (HSPLL_CLOCK_FREQ/256) period. For examples if turnOnADCCount = 15 and ASQ clock is 68 MHz, then next capture will be triggered
(16/ASQ_clock_freq)*(16)*(startADCsamplingCount) = (16/68MHz)*(16)*(15) = 56.4 usec
after acquisiton sequence has been triggered.

"restartCaptureCount" valid range (0x0002 - 0xFFFF)

Registers modified: SAPH.ATM_E.TimeMarkE

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

captureTimeOutCount

uint_least16_t _USS_Measurement_Configuration_::captureTimeOutCount

This count determined the time from start to acknowledge of acquisition data complete. This count is based on 4 ASQ clock = (HSPLL_CLOCK_FREQ/64) period. For examples if turnOnADCCount = 15 and ASQ clock is 68 MHz, then time out event will happen
(1/ASQ_clock_freq)*(64)*(startADCsamplingCount) = (16/68MHz)*(4)*(15) = 14.08 usec
after acquisiton sequence has been triggered.

"captureTimeOutCount" valid range (0x0002 - 0xFFFF)

Registers modified: SAPH.ATM_F.TimeMarkF

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

restartLowPowerCaptureCount

uint_least16_t _USS_Measurement_Configuration_::restartLowPowerCaptureCount

This should be calculated using the following formula restartLowPowerCaptureCount=F1/F2*restartCaptureCnt where (F1=PLL/16, F2=32k)

Referenced by USS_startLowPowerUltrasonicCapture().

ulpBiasDelay

USS_measurement_ULP_bias_delay _USS_Measurement_Configuration_::ulpBiasDelay

Allows user to specify delay between triggering an acquisition sequence and starting the acquisition sequence. This delay is used to allow PGA to settle.

Referenced by commonUpdateUSSULPbiasDelay(), and commonValidateSAPHconfigruation().

biasImpedance

USS_measurement_bias_impedance _USS_Measurement_Configuration_::biasImpedance

Allows user to control bias channel bias impedance.

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

muxChargePumpMode

USS_measurement_mux_charge_pump _USS_Measurement_Configuration_::muxChargePumpMode

Allows user to control multiplexer charge pump during capture.

Referenced by commonValidateSAPHconfigruation(), and USS_updateSAPHConfiguration().

startRxEnCount

uint16_t _USS_Measurement_Configuration_::startRxEnCount

This parameter is only required when controlling external AFE startRxEnCount are based of SMCLK cycles

Referenced by USS_configureUltrasonicMeasurement().

---

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

• ussSwLib.h