Functions

Functions
cy_en_sysclk_status_t	Cy_SysClk_ImoSetFrequency (cy_en_sysclk_imo_freq_t freq)
	Sets the IMO desired frequency. More...
uint32_t	Cy_SysClk_ImoGetFrequency (void)
	Returns the IMO nominal frequency. More...
cy_en_sysclk_status_t	Cy_SysClk_ImoLock (cy_en_sysclk_imo_lock_t lock)
	Locks/unlocks IMO. More...
cy_en_sysclk_imo_lock_t	Cy_SysClk_ImoGetLockStatus (void)
	Returns IMO lock status. More...
void	Cy_SysClk_ImoTempTrim (int16_t tenthDegreeC)
	Trims the IMO based on tens of degree Celsius. More...
__STATIC_INLINE void	Cy_SysClk_ImoEnable (void)
	Enables IMO.
__STATIC_INLINE void	Cy_SysClk_ImoDisable (void)
	Disables IMO.
__STATIC_INLINE bool	Cy_SysClk_ImoIsEnabled (void)
	Returns IMO enable/disable state.

Detailed Description

Function Documentation

Cy_SysClk_ImoSetFrequency()

cy_en_sysclk_status_t Cy_SysClk_ImoSetFrequency

(

cy_en_sysclk_imo_freq_t

freq

)

Sets the IMO desired frequency.

Note

There is a Cy_SysClk_ImoLock feature to improve an IMO precision.

Parameters

freq	- the desired IMO frequency, cy_en_sysclk_imo_freq_t.

Note

Call SystemCoreClockUpdate after this function calling if it affects the SYSCLK frequency.

Call Cy_SysLib_SetWaitStates before calling this function if SYSCLK frequency is increasing.

Call Cy_SysLib_SetWaitStates after calling this function if SYSCLK frequency is decreasing.

Returns

Error / status code cy_en_sysclk_status_t :
CY_SYSCLK_SUCCESS - the frequency is set as requested
CY_SYSCLK_BAD_PARAM - Invalid parameter
CY_SYSCLK_INVALID_STATE - IMO is not enabled

Cy_SysClk_ImoGetFrequency()

uint32_t Cy_SysClk_ImoGetFrequency

(

void

)

Returns the IMO nominal frequency.

Returns

the frequency value in Hz.

Cy_SysClk_ImoLock()

cy_en_sysclk_status_t Cy_SysClk_ImoLock

(

cy_en_sysclk_imo_lock_t

lock

)

Locks/unlocks IMO.

Parameters

lock	- the desired IMO lock state, cy_en_sysclk_imo_lock_t

Returns

Error / status code cy_en_sysclk_status_t :
CY_SYSCLK_SUCCESS - the lock state is set as requested
CY_SYSCLK_BAD_PARAM - Invalid parameter
CY_SYSCLK_INVALID_STATE - Invalid state (IMO or WCO is not enabled, etc.)

Note

Not applicable for PSOC4 HVMS/PA.

Cy_SysClk_ImoGetLockStatus()

cy_en_sysclk_imo_lock_t Cy_SysClk_ImoGetLockStatus

(

void

)

Returns IMO lock status.

Returns

IMO lock state cy_en_sysclk_imo_lock_t.

Note

Not applicable for PSOC4 HVMS/PA.

Cy_SysClk_ImoTempTrim()

void Cy_SysClk_ImoTempTrim

(

int16_t

tenthDegreeC

)

Trims the IMO based on tens of degree Celsius.

For example, 12.3C must pass in as 123. Supported only on specific PSOC 4 with additional calibration data in SFLASH.

Parameters

tenthDegreeC

- The die temperature in tens of degrees Celsius.