[ckmd.h] Clock Management Controller

Collaboration diagram for [ckmd.h] Clock Management Controller:

Macros
#define	CKMD_WATCHDOG_UNLOCK   0x1ACCE551
	Watchdog unlocking value. More...

Functions
__STATIC_INLINE void	CKMDEnableHighPerformanceClockBuffer (void)
	Enable high performance clock buffer. More...
__STATIC_INLINE void	CKMDDisableHighPerformanceClockBuffer (void)
	Disable high performance clock buffer. More...
__STATIC_INLINE void	CKMDSetInitialCapTrim (uint32_t q1CapTrim, uint32_t q2CapTrim)
	Sets initial HFXT capacitor ramp trims. More...
__STATIC_INLINE void	CKMDSetInitialQ1CapTrim (uint32_t q1Cap)
	Sets initial HFXT Q1 capacitor ramp trim. More...
__STATIC_INLINE void	CKMDSetInitialQ2CapTrim (uint32_t q2Cap)
	Sets initial HFXT Q2 capacitor ramp trim. More...
__STATIC_INLINE void	CKMDSetInitialIrefTrim (uint32_t iref)
	Sets initial HFXT IREF ramp trim. More...
__STATIC_INLINE void	CKMDSetInitialIdacTrim (uint32_t idac)
	Sets initial HFXT IDAC ramp trim. More...
__STATIC_INLINE void	CKMDSetInitialAmplitudeThresholdTrim (uint32_t amplitudeThreshold)
	Sets initial HFXT amplitude threshold ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetInitialQ1CapTrim (void)
	Gets initial HFXT Q1 capacitor ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetInitialQ2CapTrim (void)
	Gets initial HFXT Q2 capacitor ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetInitialIrefTrim (void)
	Gets initial HFXT IREF ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetInitialIdacTrim (void)
	Gets initial HFXT IDAC ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetInitialAmplitudeThresholdTrim (void)
	Gets initial HFXT amplitude threshold ramp trim. More...
__STATIC_INLINE void	CKMDSetTargetCapTrim (uint32_t q1CapTrim, uint32_t q2CapTrim)
	Sets target HFXT capacitor ramp trims. More...
__STATIC_INLINE void	CKMDSetTargetQ1CapTrim (uint32_t q1Cap)
	Sets target HFXT Q1 capacitor ramp trim. More...
__STATIC_INLINE void	CKMDSetTargetQ2CapTrim (uint32_t q2Cap)
	Sets target HFXT Q2 capacitor ramp trim. More...
__STATIC_INLINE void	CKMDSetTargetIrefTrim (uint32_t iref)
	Sets target HFXT IREF ramp trim. More...
__STATIC_INLINE void	CKMDSetTargetIdacTrim (uint32_t idac)
	Sets target HFXT IDAC ramp trim. More...
__STATIC_INLINE void	CKMDSetTargetAmplitudeThresholdTrim (uint32_t amplitudeThreshold)
	Sets target HFXT amplitude threshold ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetTargetQ1CapTrim (void)
	Gets target HFXT Q1 capacitor ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetTargetQ2CapTrim (void)
	Gets target HFXT Q2 capacitor ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetTargetIrefTrim (void)
	Gets target HFXT IREF ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetTargetIdacTrim (void)
	Gets target HFXT IDAC ramp trim. More...
__STATIC_INLINE uint32_t	CKMDGetTargetAmplitudeThresholdTrim (void)
	Gets target HFXT amplitude threshold ramp trim. More...
__STATIC_INLINE uint_least16_t	CKMDGetLfoscRtnPpm (void)
	Gets the worst-case LFOSC frequency jump due to RTN. More...
__STATIC_INLINE uint_least16_t	CKMDGetLfoscMidTempCoefficientPpmPerC (void)
	Gets the the worst-case LFOSC temperature coefficient in the "middle" temperature range. More...
__STATIC_INLINE uint_least16_t	CKMDGetLfoscExtTempCoefficientPpmPerC (void)
	Gets the the worst-case LFOSC temperature coefficient in the "extended" temperature range. More...
__STATIC_INLINE void	CKMDUnlockWatchdog (void)
	Unlock write access to the Watchdog. More...
__STATIC_INLINE void	CKMDLockWatchdog (void)
	Lock write access to the Watchdog. More...
__STATIC_INLINE void	CKMDSetWatchdogCounter (uint32_t value)
	Set watchdog counter value. More...
__STATIC_INLINE void	CKMDSetWatchdogDebugConfig (bool stopWhenCpuIsHalted)
	Configure if the Watchdog should stop when the CPU is halted by a debugger. More...

LFOSC Temperature Coefficient Temperature Limits
If the temperature in Celsius is within the range [ CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN, CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX ], inclusive, then the temperature coefficient CKMDGetLfoscMidTempCoefficientPpmPerC() shall be used, otherwise CKMDGetLfoscExtTempCoefficientPpmPerC(). If CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN is INT16_MIN, then there is no lower limit for the above mentioned temperature range. If CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX is INT16_MAX, then there is no upper limit for the above mentioned temperature range.
#define	CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN   (INT16_MIN)
#define	CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX   (70)

Detailed Description

Macro Definition Documentation

CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN

#define CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN   (INT16_MIN)

CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX

#define CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX   (70)

CKMD_WATCHDOG_UNLOCK

#define CKMD_WATCHDOG_UNLOCK   0x1ACCE551

Watchdog unlocking value.

Referenced by CKMDUnlockWatchdog().

Function Documentation

CKMDEnableHighPerformanceClockBuffer()

__STATIC_INLINE void CKMDEnableHighPerformanceClockBuffer

(

void

)

Enable high performance clock buffer.

CKMDDisableHighPerformanceClockBuffer()

__STATIC_INLINE void CKMDDisableHighPerformanceClockBuffer

(

void

)

Disable high performance clock buffer.

CKMDSetInitialCapTrim()

__STATIC_INLINE void CKMDSetInitialCapTrim	(	uint32_t	q1CapTrim,
		uint32_t	q2CapTrim
	)

Sets initial HFXT capacitor ramp trims.

This function sets the initial HFXT capacitor ramp trims. It will overwrite the initial HFXT ramp trim values set during startup.

This trim value is used when initially turning on the HFXT.

Note

The value for capTrim must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

q1CapTrim	Initial Q1 capacitor trim.
q2CapTrim	Initial Q2 capacitor trim.

Returns

None

See also

CKMD_O_HFXTINIT for trim range

CKMDSetInitialQ1CapTrim()

__STATIC_INLINE void CKMDSetInitialQ1CapTrim

(

uint32_t

q1Cap

)

Sets initial HFXT Q1 capacitor ramp trim.

This function sets the initial HFXT Q1 capacitor ramp trim. It will overwrite the initial HFXT ramp trim value set during startup.

This trim value is used when initially turning on the HFXT.

Note

The value for q1Cap must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

q1Cap

Initial Q1 capacitor trim.

Returns

None

See also

CKMD_O_HFXTINIT for trim range

CKMDSetInitialQ2CapTrim()

__STATIC_INLINE void CKMDSetInitialQ2CapTrim

(

uint32_t

q2Cap

)

Sets initial HFXT Q2 capacitor ramp trim.

This function sets the initial HFXT Q2 capacitor ramp trim. It will overwrite the initial HFXT ramp trim value set during startup.

This trim value is used when initially turning on the HFXT.

Note

The value for q2Cap must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

q2Cap

Initial Q2 capacitor trim.

Returns

None

See also

CKMD_O_HFXTINIT for trim range

CKMDSetInitialIrefTrim()

__STATIC_INLINE void CKMDSetInitialIrefTrim

(

uint32_t

iref

)

Sets initial HFXT IREF ramp trim.

This function sets initial HFXT IREF ramp trim. It will overwrite the initial HFXT ramp trim value set during startup.

This trim value is used when initially turning on the HFXT.

Note

The value for iref must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

iref	Initial IREF trim.

Returns

None

See also

CKMD_O_HFXTINIT for trim range

CKMDSetInitialIdacTrim()

__STATIC_INLINE void CKMDSetInitialIdacTrim

(

uint32_t

idac

)

Sets initial HFXT IDAC ramp trim.

This function sets the initial HFXT IDAC ramp trim. It will overwrite the initial HFXT ramp trim value set during startup.

This trim value is used when initially turning on the HFXT.

Note

The value for idac must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

idac	Initial IDAC trim.

Returns

None

See also

CKMD_O_HFXTINIT for trim range

CKMDSetInitialAmplitudeThresholdTrim()

__STATIC_INLINE void CKMDSetInitialAmplitudeThresholdTrim

(

uint32_t

amplitudeThreshold

)

Sets initial HFXT amplitude threshold ramp trim.

This function sets the initial HFXT amplitude threshold ramp trim. It will overwrite the initial HFXT ramp trim value set during startup.

This trim value is used when initially turning on the HFXT.

Note

The value for amplitudeThreshold must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

amplitudeThreshold

Initial amplitude threshold trim.

Returns

None

See also

CKMD_O_HFXTINIT for trim range

CKMDGetInitialQ1CapTrim()

__STATIC_INLINE uint32_t CKMDGetInitialQ1CapTrim

(

void

)

Gets initial HFXT Q1 capacitor ramp trim.

This function gets the initial HFXT Q1 capacitor ramp trim.

Returns

Initial Q1 capacitor trim.

See also

CKMD_O_HFXTINIT for trim range

CKMDGetInitialQ2CapTrim()

__STATIC_INLINE uint32_t CKMDGetInitialQ2CapTrim

(

void

)

Gets initial HFXT Q2 capacitor ramp trim.

This function gets the initial HFXT Q2 capacitor ramp trim.

Returns

Initial Q2 capacitor trim.

See also

CKMD_O_HFXTINIT for trim range

CKMDGetInitialIrefTrim()

__STATIC_INLINE uint32_t CKMDGetInitialIrefTrim

(

void

)

Gets initial HFXT IREF ramp trim.

This function gets the initial HFXT IREF ramp trim.

Returns

Initial IREF trim.

See also

CKMD_O_HFXTINIT for trim range

CKMDGetInitialIdacTrim()

__STATIC_INLINE uint32_t CKMDGetInitialIdacTrim

(

void

)

Gets initial HFXT IDAC ramp trim.

This function gets the initial HFXT IDAC ramp trim.

Returns

Initial IDAC trim.

See also

CKMD_O_HFXTINIT for trim range

CKMDGetInitialAmplitudeThresholdTrim()

__STATIC_INLINE uint32_t CKMDGetInitialAmplitudeThresholdTrim

(

void

)

Gets initial HFXT amplitude threshold ramp trim.

This function initial HFXT amplitude threshold ramp trim.

Returns

Initial amplitude threshold trim.

See also

CKMD_O_HFXTINIT for trim range

CKMDSetTargetCapTrim()

__STATIC_INLINE void CKMDSetTargetCapTrim	(	uint32_t	q1CapTrim,
		uint32_t	q2CapTrim
	)

Sets target HFXT capacitor ramp trims.

This function sets the target HFXT capacitor ramp trims. It will overwrite the target HFXT ramp trim values set during startup.

This trim value is used when target turning on the HFXT.

Note

The value for capTrim must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

q1CapTrim	Target Q1 capacitor trim.
q2CapTrim	Target Q2 capacitor trim.

Returns

None

See also

CKMD_O_HFXTTARG for trim range

CKMDSetTargetQ1CapTrim()

__STATIC_INLINE void CKMDSetTargetQ1CapTrim

(

uint32_t

q1Cap

)

Sets target HFXT Q1 capacitor ramp trim.

This function target HFXT Q1 capacitor ramp trim. It will overwrite the target HFXT ramp trim value set during startup.

This trim value is used after HFXT has ramped to change crystal performance.

Note

The value for q1Cap must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

q1Cap

Target Q1 capacitor trim.

Returns

None

CKMDSetTargetQ2CapTrim()

__STATIC_INLINE void CKMDSetTargetQ2CapTrim

(

uint32_t

q2Cap

)

Sets target HFXT Q2 capacitor ramp trim.

This function target HFXT Q2 capacitor ramp trim. It will overwrite the target HFXT ramp trim value set during startup.

This trim value is used after HFXT has ramped to change crystal performance.

Note

The value for q2Cap must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

q2Cap

Target Q2 capacitor trim.

Returns

None

CKMDSetTargetIrefTrim()

__STATIC_INLINE void CKMDSetTargetIrefTrim

(

uint32_t

iref

)

Sets target HFXT IREF ramp trim.

This function target HFXT IREF ramp trim. It will overwrite the target HFXT ramp trim value set during startup.

This trim value is used after HFXT has ramped to change crystal performance.

Note

The value for iref must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

iref	Target IREF trim.

Returns

None

CKMDSetTargetIdacTrim()

__STATIC_INLINE void CKMDSetTargetIdacTrim

(

uint32_t

idac

)

Sets target HFXT IDAC ramp trim.

This function target HFXT IDAC ramp trim. It will overwrite the target HFXT ramp trim value set during startup.

This trim value is used after HFXT has ramped to change crystal performance.

Note

The value for idac must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

idac	Target IDAC trim.

Returns

None

CKMDSetTargetAmplitudeThresholdTrim()

__STATIC_INLINE void CKMDSetTargetAmplitudeThresholdTrim

(

uint32_t

amplitudeThreshold

)

Sets target HFXT amplitude threshold ramp trim.

This function target HFXT amplitude threshold ramp trim. It will overwrite the target HFXT ramp trim value set during startup.

This trim value is used after HFXT has ramped to change crystal performance.

Note

The value for amplitudeThreshold must be found experimentally based on the chosen crystal and desired ramp behaviour.

Parameters

amplitudeThreshold

Target amplitude threshold trim.

Returns

None

CKMDGetTargetQ1CapTrim()

__STATIC_INLINE uint32_t CKMDGetTargetQ1CapTrim

(

void

)

Gets target HFXT Q1 capacitor ramp trim.

This function gets the target HFXT Q1 capacitor ramp trim.

Returns

Target Q1 capacitor trim.

See also

CKMD_O_HFXTTARG for trim range

CKMDGetTargetQ2CapTrim()

__STATIC_INLINE uint32_t CKMDGetTargetQ2CapTrim

(

void

)

Gets target HFXT Q2 capacitor ramp trim.

This function gets the target HFXT Q2 capacitor ramp trim.

Returns

Target Q2 capacitor trim.

See also

CKMD_O_HFXTTARG for trim range

CKMDGetTargetIrefTrim()

__STATIC_INLINE uint32_t CKMDGetTargetIrefTrim

(

void

)

Gets target HFXT IREF ramp trim.

This function gets the target HFXT IREF ramp trim.

Returns

Target IREF trim.

See also

CKMD_O_HFXTTARG for trim range

CKMDGetTargetIdacTrim()

__STATIC_INLINE uint32_t CKMDGetTargetIdacTrim

(

void

)

Gets target HFXT IDAC ramp trim.

This function gets the target HFXT IDAC ramp trim.

Returns

Target IDAC trim.

See also

CKMD_O_HFXTTARG for trim range

CKMDGetTargetAmplitudeThresholdTrim()

__STATIC_INLINE uint32_t CKMDGetTargetAmplitudeThresholdTrim

(

void

)

Gets target HFXT amplitude threshold ramp trim.

This function target HFXT amplitude threshold ramp trim.

Returns

Target amplitude threshold trim.

See also

CKMD_O_HFXTTARG for trim range

CKMDGetLfoscRtnPpm()

__STATIC_INLINE uint_least16_t CKMDGetLfoscRtnPpm

(

void

)

Gets the worst-case LFOSC frequency jump due to RTN.

Returns

The absolute value of the worst-case jump due to RTN in ppm.

CKMDGetLfoscMidTempCoefficientPpmPerC()

__STATIC_INLINE uint_least16_t CKMDGetLfoscMidTempCoefficientPpmPerC

(

void

)

Gets the the worst-case LFOSC temperature coefficient in the "middle" temperature range.

This function can be used to determine the the worst-case LFOSC temperature coefficient in units of ppm/C in the temperature range [ CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN, CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX ].

Returns

The absolute value of worst-case temperature coefficient in ppm/C.

CKMDGetLfoscExtTempCoefficientPpmPerC()

__STATIC_INLINE uint_least16_t CKMDGetLfoscExtTempCoefficientPpmPerC

(

void

)

Gets the the worst-case LFOSC temperature coefficient in the "extended" temperature range.

This function can be used to determine the the worst-case LFOSC temperature coefficient in units of ppm/C when the temperature is outside of the temperature range [ CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN, CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX ].

Returns

The absolute value of worst-case temperature coefficient in ppm/C.

CKMDUnlockWatchdog()

__STATIC_INLINE void CKMDUnlockWatchdog

(

void

)

Unlock write access to the Watchdog.

The function will wait until the Watchdog has actually been unlocked, before returning.

References CKMD_WATCHDOG_UNLOCK.

CKMDLockWatchdog()

__STATIC_INLINE void CKMDLockWatchdog

(

void

)

Lock write access to the Watchdog.

CKMDSetWatchdogCounter()

__STATIC_INLINE void CKMDSetWatchdogCounter

(

uint32_t

value

)

Set watchdog counter value.

Calling this function will immediately start (or restart) the counter. It will count down from the value

Parameters

value

is the value to write to the Watchdog counter.

CKMDSetWatchdogDebugConfig()

__STATIC_INLINE void CKMDSetWatchdogDebugConfig

(

bool

stopWhenCpuIsHalted

)

Configure if the Watchdog should stop when the CPU is halted by a debugger.

Parameters

stopWhenCpuIsHalted

if true, the Watchdog will stop counting while the CPU is stopped by a debugger. If false, the Watchdog will continue counting while the CPU is stopped by a debugger.