blob: 1212d01e7b8da9cdfe0eefc9cdf853ca2c417449 [file] [log] [blame]
/******************************************************************************
* Filename: osc.c
* Revised: 2019-02-14 09:35:31 +0100 (Thu, 14 Feb 2019)
* Revision: 54539
*
* Description: Driver for setting up the system Oscillators
*
* Copyright (c) 2015 - 2017, Texas Instruments Incorporated
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1) Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2) Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3) Neither the name of the ORGANIZATION nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************/
#include "../inc/hw_types.h"
#include "../inc/hw_ccfg.h"
#include "../inc/hw_fcfg1.h"
#include "aon_batmon.h"
#include "aon_rtc.h"
#include "osc.h"
#include "setup_rom.h"
//*****************************************************************************
//
// Handle support for DriverLib in ROM:
// This section will undo prototype renaming made in the header file
//
//*****************************************************************************
#if !defined(DOXYGEN)
#undef OSCClockSourceSet
#define OSCClockSourceSet NOROM_OSCClockSourceSet
#undef OSCClockSourceGet
#define OSCClockSourceGet NOROM_OSCClockSourceGet
#undef OSCHF_GetStartupTime
#define OSCHF_GetStartupTime NOROM_OSCHF_GetStartupTime
#undef OSCHF_TurnOnXosc
#define OSCHF_TurnOnXosc NOROM_OSCHF_TurnOnXosc
#undef OSCHF_AttemptToSwitchToXosc
#define OSCHF_AttemptToSwitchToXosc NOROM_OSCHF_AttemptToSwitchToXosc
#undef OSCHF_SwitchToRcOscTurnOffXosc
#define OSCHF_SwitchToRcOscTurnOffXosc NOROM_OSCHF_SwitchToRcOscTurnOffXosc
#undef OSCHF_DebugGetCrystalAmplitude
#define OSCHF_DebugGetCrystalAmplitude NOROM_OSCHF_DebugGetCrystalAmplitude
#undef OSCHF_DebugGetExpectedAverageCrystalAmplitude
#define OSCHF_DebugGetExpectedAverageCrystalAmplitude NOROM_OSCHF_DebugGetExpectedAverageCrystalAmplitude
#undef OSC_HPOSC_Debug_InitFreqOffsetParams
#define OSC_HPOSC_Debug_InitFreqOffsetParams NOROM_OSC_HPOSC_Debug_InitFreqOffsetParams
#undef OSC_HPOSCInitializeFrequencyOffsetParameters
#define OSC_HPOSCInitializeFrequencyOffsetParameters NOROM_OSC_HPOSCInitializeFrequencyOffsetParameters
#undef OSC_HPOSCRelativeFrequencyOffsetGet
#define OSC_HPOSCRelativeFrequencyOffsetGet NOROM_OSC_HPOSCRelativeFrequencyOffsetGet
#undef OSC_AdjustXoscHfCapArray
#define OSC_AdjustXoscHfCapArray NOROM_OSC_AdjustXoscHfCapArray
#undef OSC_HPOSCRelativeFrequencyOffsetToRFCoreFormatConvert
#define OSC_HPOSCRelativeFrequencyOffsetToRFCoreFormatConvert NOROM_OSC_HPOSCRelativeFrequencyOffsetToRFCoreFormatConvert
#undef OSC_HPOSCRtcCompensate
#define OSC_HPOSCRtcCompensate NOROM_OSC_HPOSCRtcCompensate
#endif
//*****************************************************************************
//
// Global HPOSC curve fitting polynomials
// Parameters found/calculated when calling function
// OSC_HPOSCInitializeFrequencyOffsetParameters()
// (or OSC_HPOSC_Debug_InitFreqOffsetParams() used for debugging only)
// These global variables must be updated before using HPOSC
//
//*****************************************************************************
static int16_t _hpOscPolynomials[ 4 ];
//*****************************************************************************
//
// OSCHF switch time calculator defines and globals
//
//*****************************************************************************
#define RTC_CV_TO_MS(x) (( 1000 * ( x )) >> 16 )
#define RTC_CV_TO_US(x) (( 1000000 * ( x )) >> 16 )
typedef struct {
uint32_t previousStartupTimeInUs ;
uint32_t timeXoscOff_CV ;
uint32_t timeXoscOn_CV ;
uint32_t timeXoscStable_CV ;
int32_t tempXoscOff ;
} OscHfGlobals_t;
static OscHfGlobals_t oscHfGlobals;
//*****************************************************************************
//
// Configure the oscillator input to the a source clock.
//
//*****************************************************************************
void
OSCClockSourceSet(uint32_t ui32SrcClk, uint32_t ui32Osc)
{
// Check the arguments.
ASSERT((ui32SrcClk & OSC_SRC_CLK_LF) ||
(ui32SrcClk & OSC_SRC_CLK_HF));
ASSERT((ui32Osc == OSC_RCOSC_HF) ||
(ui32Osc == OSC_RCOSC_LF) ||
(ui32Osc == OSC_XOSC_HF) ||
(ui32Osc == OSC_XOSC_LF));
// Request the high frequency source clock (using 24 MHz XTAL)
if(ui32SrcClk & OSC_SRC_CLK_HF)
{
// Enable the HF XTAL as HF clock source
DDI16BitfieldWrite(AUX_DDI0_OSC_BASE, DDI_0_OSC_O_CTL0,
DDI_0_OSC_CTL0_SCLK_HF_SRC_SEL_M,
DDI_0_OSC_CTL0_SCLK_HF_SRC_SEL_S,
ui32Osc);
}
// Configure the low frequency source clock.
if(ui32SrcClk & OSC_SRC_CLK_LF)
{
// Change the clock source.
DDI16BitfieldWrite(AUX_DDI0_OSC_BASE, DDI_0_OSC_O_CTL0,
DDI_0_OSC_CTL0_SCLK_LF_SRC_SEL_M,
DDI_0_OSC_CTL0_SCLK_LF_SRC_SEL_S,
ui32Osc);
}
}
//*****************************************************************************
//
// Get the source clock settings
//
//*****************************************************************************
uint32_t
OSCClockSourceGet(uint32_t ui32SrcClk)
{
uint32_t ui32ClockSource;
// Check the arguments.
ASSERT((ui32SrcClk & OSC_SRC_CLK_LF) ||
(ui32SrcClk & OSC_SRC_CLK_HF));
// Return the source for the selected clock.
if(ui32SrcClk == OSC_SRC_CLK_LF)
{
ui32ClockSource = DDI16BitfieldRead(AUX_DDI0_OSC_BASE, DDI_0_OSC_O_STAT0,
DDI_0_OSC_STAT0_SCLK_LF_SRC_M,
DDI_0_OSC_STAT0_SCLK_LF_SRC_S);
}
else
{
ui32ClockSource = DDI16BitfieldRead(AUX_DDI0_OSC_BASE, DDI_0_OSC_O_STAT0,
DDI_0_OSC_STAT0_SCLK_HF_SRC_M,
DDI_0_OSC_STAT0_SCLK_HF_SRC_S);
}
return (ui32ClockSource);
}
//*****************************************************************************
//
// Returns maximum startup time (in microseconds) of XOSC_HF
//
//*****************************************************************************
uint32_t
OSCHF_GetStartupTime( uint32_t timeUntilWakeupInMs )
{
uint32_t deltaTimeSinceXoscOnInMs ;
int32_t deltaTempSinceXoscOn ;
uint32_t newStartupTimeInUs ;
deltaTimeSinceXoscOnInMs = RTC_CV_TO_MS( AONRTCCurrentCompareValueGet() - oscHfGlobals.timeXoscOn_CV );
deltaTempSinceXoscOn = AONBatMonTemperatureGetDegC() - oscHfGlobals.tempXoscOff;
if ( deltaTempSinceXoscOn < 0 ) {
deltaTempSinceXoscOn = -deltaTempSinceXoscOn;
}
if ( (( timeUntilWakeupInMs + deltaTimeSinceXoscOnInMs ) > 3000 ) ||
( deltaTempSinceXoscOn > 5 ) ||
( oscHfGlobals.timeXoscStable_CV < oscHfGlobals.timeXoscOn_CV ) ||
( oscHfGlobals.previousStartupTimeInUs == 0 ) )
{
newStartupTimeInUs = 2000;
if (( HWREG( CCFG_BASE + CCFG_O_SIZE_AND_DIS_FLAGS ) & CCFG_SIZE_AND_DIS_FLAGS_DIS_XOSC_OVR_M ) == 0 ) {
newStartupTimeInUs = (( HWREG( CCFG_BASE + CCFG_O_MODE_CONF_1 ) &
CCFG_MODE_CONF_1_XOSC_MAX_START_M ) >>
CCFG_MODE_CONF_1_XOSC_MAX_START_S ) * 125;
// Note: CCFG startup time is "in units of 100us" adding 25% margin results in *125
}
} else {
newStartupTimeInUs = RTC_CV_TO_US( oscHfGlobals.timeXoscStable_CV - oscHfGlobals.timeXoscOn_CV );
newStartupTimeInUs += ( newStartupTimeInUs >> 2 ); // Add 25 percent margin
if ( newStartupTimeInUs < oscHfGlobals.previousStartupTimeInUs ) {
newStartupTimeInUs = oscHfGlobals.previousStartupTimeInUs;
}
}
if ( newStartupTimeInUs < 200 ) {
newStartupTimeInUs = 200;
}
if ( newStartupTimeInUs > 4000 ) {
newStartupTimeInUs = 4000;
}
return ( newStartupTimeInUs );
}
//*****************************************************************************
//
// Turns on XOSC_HF (but without switching to XOSC_HF)
//
//*****************************************************************************
void
OSCHF_TurnOnXosc( void )
{
#if ( defined( ROM_OSCClockSourceSet ))
ROM_OSCClockSourceSet( OSC_SRC_CLK_HF, OSC_XOSC_HF );
#else
OSCClockSourceSet( OSC_SRC_CLK_HF, OSC_XOSC_HF );
#endif
oscHfGlobals.timeXoscOn_CV = AONRTCCurrentCompareValueGet();
}
//*****************************************************************************
//
// Switch to XOSC_HF if XOSC_HF is ready.
//
//*****************************************************************************
bool
OSCHF_AttemptToSwitchToXosc( void )
{
uint32_t startupTimeInUs;
uint32_t prevLimmit25InUs;
#if ( defined( ROM_OSCClockSourceGet ))
if ( ROM_OSCClockSourceGet( OSC_SRC_CLK_HF ) == OSC_XOSC_HF )
#else
if ( OSCClockSourceGet( OSC_SRC_CLK_HF ) == OSC_XOSC_HF )
#endif
{
// Already on XOSC - nothing to do
return ( 1 );
}
if ( OSCHfSourceReady()) {
OSCHfSourceSwitch();
// Store startup time, but limit to 25 percent reduction each time.
oscHfGlobals.timeXoscStable_CV = AONRTCCurrentCompareValueGet();
startupTimeInUs = RTC_CV_TO_US( oscHfGlobals.timeXoscStable_CV - oscHfGlobals.timeXoscOn_CV );
prevLimmit25InUs = oscHfGlobals.previousStartupTimeInUs;
prevLimmit25InUs -= ( prevLimmit25InUs >> 2 ); // 25 percent margin
oscHfGlobals.previousStartupTimeInUs = startupTimeInUs;
if ( prevLimmit25InUs > startupTimeInUs ) {
oscHfGlobals.previousStartupTimeInUs = prevLimmit25InUs;
}
return ( 1 );
}
return ( 0 );
}
//*****************************************************************************
//
// Switch to RCOSC_HF and turn off XOSC_HF
//
//*****************************************************************************
void
OSCHF_SwitchToRcOscTurnOffXosc( void )
{
#if ( defined( ROM_OSCClockSourceSet ))
ROM_OSCClockSourceSet( OSC_SRC_CLK_HF, OSC_RCOSC_HF );
#else
OSCClockSourceSet( OSC_SRC_CLK_HF, OSC_RCOSC_HF );
#endif
// Do the switching if not already running on RCOSC_HF
#if ( defined( ROM_OSCClockSourceGet ))
if ( ROM_OSCClockSourceGet( OSC_SRC_CLK_HF ) != OSC_RCOSC_HF )
#else
if ( OSCClockSourceGet( OSC_SRC_CLK_HF ) != OSC_RCOSC_HF )
#endif
{
OSCHfSourceSwitch();
}
oscHfGlobals.timeXoscOff_CV = AONRTCCurrentCompareValueGet();
oscHfGlobals.tempXoscOff = AONBatMonTemperatureGetDegC();
}
//*****************************************************************************
//
// Adjust the XOSC HF cap array relative to the factory setting
//
//*****************************************************************************
void
OSC_AdjustXoscHfCapArray( int32_t capArrDelta )
{
// read the MODE_CONF register in CCFG
uint32_t ccfg_ModeConfReg = HWREG( CCFG_BASE + CCFG_O_MODE_CONF );
// Clear CAP_MODE and the CAPARRAY_DELATA field
ccfg_ModeConfReg &= ~( CCFG_MODE_CONF_XOSC_CAPARRAY_DELTA_M | CCFG_MODE_CONF_XOSC_CAP_MOD_M );
// Insert new delta value
ccfg_ModeConfReg |= ((((uint32_t)capArrDelta) << CCFG_MODE_CONF_XOSC_CAPARRAY_DELTA_S ) & CCFG_MODE_CONF_XOSC_CAPARRAY_DELTA_M );
// Update the HW register with the new delta value
DDI32RegWrite(AUX_DDI0_OSC_BASE, DDI_0_OSC_O_ANABYPASSVAL1, SetupGetTrimForAnabypassValue1( ccfg_ModeConfReg ));
}
//*****************************************************************************
//
// Initialize the frequency offset curve fitting parameters
// These are either picked diretly from FCFG1:FREQ_OFFSET & FCFG1:MISC_CONF_2 or
// calculated based on the FCFG1:HPOSC_MEAS_x parameters.
//
//*****************************************************************************
// Using the following hardcoded constants (Using temporary constants for now)
#define D1OFFSET_p25C -24
#define D2OFFSET_p85C -36
#define D3OFFSET_m40C 18
#define P3_POLYNOMIAL -47
#define N_INSERTIONS 3
typedef struct {
int32_t dFreq ;
int32_t temp ;
} insertion_t ;
static void
InitializeMeasurmentSet( insertion_t * pInsertion, uint32_t registerAddress, int32_t deltaOffset, int32_t p3PolOffset )
{
// Doing the following adjustment to the deltaFrequence before finding the polynomials P0, P1, P2
// Dx = Dx + DxOFFSET - ((P3*Tx^3)/2^18)
uint32_t insertionData = HWREG( registerAddress );
pInsertion->dFreq = (((int32_t)( insertionData << ( 32 - FCFG1_HPOSC_MEAS_1_HPOSC_D1_W - FCFG1_HPOSC_MEAS_1_HPOSC_D1_S )))
>> ( 32 - FCFG1_HPOSC_MEAS_1_HPOSC_D1_W ));
pInsertion->temp = (((int32_t)( insertionData << ( 32 - FCFG1_HPOSC_MEAS_1_HPOSC_T1_W - FCFG1_HPOSC_MEAS_1_HPOSC_T1_S )))
>> ( 32 - FCFG1_HPOSC_MEAS_1_HPOSC_T1_W ));
pInsertion->dFreq = pInsertion->dFreq + deltaOffset - (( p3PolOffset * pInsertion->temp * pInsertion->temp * pInsertion->temp ) >> 18 );
}
static void
FindPolynomialsAndUpdateGlobals( insertion_t * pMeasurment )
{
uint32_t loopCount ;
int32_t polynomial_0 ;
int32_t polynomial_1 ;
int32_t polynomial_2 ;
int32_t Syi_ = 0 ;
int32_t Sxi_ = 0 ;
int32_t Sxi2_ = 0 ;
int32_t Sxiyi_ = 0 ;
int32_t Sxi2yi_ = 0 ;
int32_t Sxi3_ = 0 ;
int32_t Sxi4_ = 0 ;
for ( loopCount = 0 ; loopCount < N_INSERTIONS ; loopCount++ ) {
int32_t x ;
int32_t x2 ;
int32_t y ;
x = pMeasurment[ loopCount ].temp ;
x2 = ( x * x );
y = pMeasurment[ loopCount ].dFreq ;
Syi_ += ( y );
Sxi_ += ( x );
Sxi2_ += ( x2 );
Sxiyi_ += ( x * y );
Sxi2yi_ += ( x2 * y );
Sxi3_ += ( x2 * x );
Sxi4_ += ( x2 * x2 );
}
int32_t Sxx_ = ( Sxi2_ * N_INSERTIONS ) - ( Sxi_ * Sxi_ );
int32_t Sxy_ = ( Sxiyi_ * N_INSERTIONS ) - ( Sxi_ * Syi_ );
int32_t Sxx2_ = ( Sxi3_ * N_INSERTIONS ) - ( Sxi_ * Sxi2_ );
int32_t Sx2y_ = ( Sxi2yi_ * N_INSERTIONS ) - ( Sxi2_ * Syi_ );
int32_t Sx2x2_ = ( Sxi4_ * N_INSERTIONS ) - ( Sxi2_ * Sxi2_ );
int32_t divisor = ((((int64_t) Sxx_ * Sx2x2_ ) - ((int64_t) Sxx2_ * Sxx2_ )) + (1<<9)) >> 10 ;
if ( divisor == 0 ) {
polynomial_2 = 0 ;
polynomial_1 = 0 ;
} else {
polynomial_2 = (((int64_t) Sx2y_ * Sxx_ ) - ((int64_t) Sxy_ * Sxx2_ )) / divisor ;
polynomial_1 = (((int64_t) Sxy_ * Sx2x2_ ) - ((int64_t) Sx2y_ * Sxx2_ )) / divisor ;
}
polynomial_0 = ( Syi_ - (((( polynomial_1 * Sxi_ ) + ( polynomial_2 * Sxi2_ )) + (1<<9)) >> 10 )) / N_INSERTIONS ;
polynomial_1 = ( polynomial_1 + (1<<6)) >> 7 ;
_hpOscPolynomials[ 0 ] = polynomial_0 ;
_hpOscPolynomials[ 1 ] = polynomial_1 ;
_hpOscPolynomials[ 2 ] = polynomial_2 ;
_hpOscPolynomials[ 3 ] = P3_POLYNOMIAL ;
}
//*****************************************************************************
// Degub function to calculate the HPOSC polynomials for experimental data sets.
//*****************************************************************************
void
OSC_HPOSC_Debug_InitFreqOffsetParams( HposcDebugData_t * pDebugData )
{
// Calculate the curve fitting parameters from temp insertion measurements
// But first adjust the measurements with constants found in characterization
insertion_t pMeasurment[ 3 ];
InitializeMeasurmentSet( &pMeasurment[ 0 ], (uint32_t)&pDebugData->meas_1, pDebugData->offsetD1, pDebugData->polyP3 );
InitializeMeasurmentSet( &pMeasurment[ 1 ], (uint32_t)&pDebugData->meas_2, pDebugData->offsetD2, pDebugData->polyP3 );
InitializeMeasurmentSet( &pMeasurment[ 2 ], (uint32_t)&pDebugData->meas_3, pDebugData->offsetD3, pDebugData->polyP3 );
FindPolynomialsAndUpdateGlobals( pMeasurment );
}
//*****************************************************************************
// The general HPOSC initialization function - Must always be called before using HPOSC
//*****************************************************************************
void
OSC_HPOSCInitializeFrequencyOffsetParameters( void )
{
{
// Calculate the curve fitting parameters from temp insertion measurements
// But first adjust the measurements with constants found in characterization
insertion_t pMeasurment[ 3 ];
InitializeMeasurmentSet( &pMeasurment[ 0 ], FCFG1_BASE + FCFG1_O_HPOSC_MEAS_1, D1OFFSET_p25C, P3_POLYNOMIAL );
InitializeMeasurmentSet( &pMeasurment[ 1 ], FCFG1_BASE + FCFG1_O_HPOSC_MEAS_2, D2OFFSET_p85C, P3_POLYNOMIAL );
InitializeMeasurmentSet( &pMeasurment[ 2 ], FCFG1_BASE + FCFG1_O_HPOSC_MEAS_3, D3OFFSET_m40C, P3_POLYNOMIAL );
FindPolynomialsAndUpdateGlobals( pMeasurment );
}
}
//*****************************************************************************
//
// Calculate the temperature dependent relative frequency offset of HPOSC
//
//*****************************************************************************
int32_t
OSC_HPOSCRelativeFrequencyOffsetGet( int32_t tempDegC )
{
// Estimate HPOSC frequency, using temperature and curve fitting parameters
int32_t paramP0 = _hpOscPolynomials[ 0 ];
int32_t paramP1 = _hpOscPolynomials[ 1 ];
int32_t paramP2 = _hpOscPolynomials[ 2 ];
int32_t paramP3 = _hpOscPolynomials[ 3 ];
// Now we can find the HPOSC freq offset, given as a signed variable d, expressed by:
//
// F_HPOSC = F_nom * (1 + d/(2^22)) , where: F_HPOSC = HPOSC frequency
// F_nom = nominal clock source frequency (e.g. 48.000 MHz)
// d = describes relative freq offset
// We can estimate the d variable, using temperature compensation parameters:
//
// d = P0 + P1*(t - T0) + P2*(t - T0)^2 + P3*(t - T0)^3, where: P0,P1,P2,P3 are curve fitting parameters from FCFG1
// t = current temperature (from temp sensor) in deg C
// T0 = 27 deg C (fixed temperature constant)
int32_t tempDelta = (tempDegC - 27);
int32_t tempDeltaX2 = tempDelta * tempDelta;
int32_t d = paramP0 + ((tempDelta*paramP1)>>3) + ((tempDeltaX2*paramP2)>>10) + ((tempDeltaX2*tempDelta*paramP3)>>18);
return ( d );
}
//*****************************************************************************
//
// Converts the relative frequency offset of HPOSC to the RF Core parameter format.
//
//*****************************************************************************
int16_t
OSC_HPOSCRelativeFrequencyOffsetToRFCoreFormatConvert( int32_t HPOSC_RelFreqOffset )
{
// The input argument, hereby referred to simply as "d", describes the frequency offset
// of the HPOSC relative to the nominal frequency in this way:
//
// F_HPOSC = F_nom * (1 + d/(2^22))
//
// But for use by the radio, to compensate the frequency error, we need to find the
// frequency offset "rfcFreqOffset" defined in the following format:
//
// F_nom = F_HPOSC * (1 + rfCoreFreqOffset/(2^22))
//
// To derive "rfCoreFreqOffset" from "d" we combine the two above equations and get:
//
// (1 + rfCoreFreqOffset/(2^22)) = (1 + d/(2^22))^-1
//
// Which can be rewritten into:
//
// rfCoreFreqOffset = -d*(2^22) / ((2^22) + d)
//
// = -d * [ 1 / (1 + d/(2^22)) ]
//
// To avoid doing a 64-bit division due to the (1 + d/(2^22))^-1 expression,
// we can use Taylor series (Maclaurin series) to approximate it:
//
// 1 / (1 - x) ~= 1 + x + x^2 + x^3 + x^4 + ... etc (Maclaurin series)
//
// In our case, we have x = - d/(2^22), and we only include up to the first
// order term of the series, as the second order term ((d^2)/(2^44)) is very small:
//
// freqError ~= -d + d^2/(2^22) (+ small approximation error)
//
// The approximation error is negligible for our use.
int32_t rfCoreFreqOffset = -HPOSC_RelFreqOffset + (( HPOSC_RelFreqOffset * HPOSC_RelFreqOffset ) >> 22 );
return ( rfCoreFreqOffset );
}
//*****************************************************************************
//
// Compensate the RTC increment based on the relative frequency offset of HPOSC
//
//*****************************************************************************
void
OSC_HPOSCRtcCompensate( int32_t relFreqOffset )
{
uint32_t rtcSubSecInc;
uint32_t lfClkFrequency;
uint32_t hfFreq;
int64_t calcFactor;
// Calculate SCLK_HF frequency, defined as:
// hfFreq = 48000000 * (1 + relFreqOffset/(2^22))
if( relFreqOffset >= 0 )
{
calcFactor = ( ( 48000000 * (int64_t)relFreqOffset ) + 0x200000 ) / 0x400000;
}
else
{
calcFactor = ( ( 48000000 * (int64_t)relFreqOffset ) - 0x200000 ) / 0x400000;
}
hfFreq = 48000000 + calcFactor;
// Calculate SCLK_LF frequency, defined as SCLK_LF_FREQ = SCLK_HF_FREQ / 1536
lfClkFrequency = ( hfFreq + 768 ) / 1536;
// Calculate SUBSECINC, defined as: SUBSECINC = 2^38 / SCLK_LF_FREQ
rtcSubSecInc = 0x4000000000 / lfClkFrequency;
/* Update SUBSECINC value */
SetupSetAonRtcSubSecInc(rtcSubSecInc);
}
//*****************************************************************************
//
// Get crystal amplitude (assuming crystal is running).
//
//*****************************************************************************
uint32_t
OSCHF_DebugGetCrystalAmplitude( void )
{
uint32_t oscCfgRegCopy ;
uint32_t startTime ;
uint32_t deltaTime ;
uint32_t ampValue ;
// The specified method is as follows:
// 1. Set minimum interval between oscillator amplitude calibrations.
// (Done by setting PER_M=0 and PER_E=1)
// 2. Wait approximately 4 milliseconds in order to measure over a
// moderately large number of calibrations.
// 3. Read out the crystal amplitude value from the peek detector.
// 4. Restore original oscillator amplitude calibrations interval.
// 5. Return crystal amplitude value converted to millivolt.
oscCfgRegCopy = HWREG( AON_PMCTL_BASE + AON_PMCTL_O_OSCCFG );
HWREG( AON_PMCTL_BASE + AON_PMCTL_O_OSCCFG ) = ( 1 << AON_PMCTL_OSCCFG_PER_E_S );
startTime = AONRTCCurrentCompareValueGet();
do {
deltaTime = AONRTCCurrentCompareValueGet() - startTime;
} while ( deltaTime < ((uint32_t)( 0.004 * FACTOR_SEC_TO_COMP_VAL_FORMAT )));
ampValue = ( HWREG( AUX_DDI0_OSC_BASE + DDI_0_OSC_O_STAT1 ) &
DDI_0_OSC_STAT1_HPM_UPDATE_AMP_M ) >>
DDI_0_OSC_STAT1_HPM_UPDATE_AMP_S ;
HWREG( AON_PMCTL_BASE + AON_PMCTL_O_OSCCFG ) = oscCfgRegCopy;
return ( ampValue * 15 );
}
//*****************************************************************************
//
// Get the expected average crystal amplitude.
//
//*****************************************************************************
uint32_t
OSCHF_DebugGetExpectedAverageCrystalAmplitude( void )
{
uint32_t ampCompTh1 ;
uint32_t highThreshold ;
uint32_t lowThreshold ;
ampCompTh1 = HWREG( AUX_DDI0_OSC_BASE + DDI_0_OSC_O_AMPCOMPTH1 );
highThreshold = ( ampCompTh1 & DDI_0_OSC_AMPCOMPTH1_HPMRAMP3_HTH_M ) >>
DDI_0_OSC_AMPCOMPTH1_HPMRAMP3_HTH_S ;
lowThreshold = ( ampCompTh1 & DDI_0_OSC_AMPCOMPTH1_HPMRAMP3_LTH_M ) >>
DDI_0_OSC_AMPCOMPTH1_HPMRAMP3_LTH_S ;
return ((( highThreshold + lowThreshold ) * 15 ) >> 1 );
}