CAT2 Peripheral Driver Library

Functions

__STATIC_INLINE void Cy_SysClk_PiloEnable (void)
 Enables the PILO. More...
 
__STATIC_INLINE bool Cy_SysClk_PiloIsEnabled (void)
 Returns the PILO enable/disable state. More...
 
__STATIC_INLINE cy_en_sysclk_status_t Cy_SysClk_PiloDisable (void)
 Disables the PILO. More...
 

Detailed Description

Function Documentation

◆ Cy_SysClk_PiloEnable()

__STATIC_INLINE void Cy_SysClk_PiloEnable ( void  )

Enables the PILO.

Note
Applicable to PSOC4 HVMS/PA only.
PILO Enable are ignored if PILO is selected as LFCLK source.
Warning
The Watchdog timer should be unlocked before PILO being enabled. Call the Cy_WDT_Unlock() API to unlock the WDT.
Function Usage
/* Scenario: The LFCLK needs to be sourced by the PILO instead of the ILO. */
/* The Watchdog timer should be unlocked before PILO being enabled. */
/* Enable the PILO */
/* Now switch the PILO source to LFCLK */
/* Disable the ILO */

◆ Cy_SysClk_PiloIsEnabled()

__STATIC_INLINE bool Cy_SysClk_PiloIsEnabled ( void  )

Returns the PILO enable/disable state.

Note
Applicable to PSOC4 HVMS/PA only.
Function Usage
/* Scenario: Shut down PILO to reduce power consumption as it is not needed. */
{
/* The Watchdog timer should be unlocked before PILO being enabled. */
Cy_SysClk_PiloDisable(); /* Disable the PILO */
}

◆ Cy_SysClk_PiloDisable()

__STATIC_INLINE cy_en_sysclk_status_t Cy_SysClk_PiloDisable ( void  )

Disables the PILO.

PILO can't be disabled if WDT is enabled or the PILO is selected as a LFCLK source.

Returns
Error / status code, cy_en_sysclk_status_t :
CY_SYSCLK_SUCCESS - PILO successfully disabled
CY_SYSCLK_INVALID_STATE - Cannot disable the PILO if the WDT is enabled or the PILO is selected as a LFCLK source.
Note
Do not call this function if the WDT is enabled, and if the WDT is clocked by the PILO.
Warning
The Watchdog timer should be unlocked before PILO being disabled. Call the Cy_WDT_Unlock() API to unlock the WDT.
Note
Applicable to PSOC4 HVMS/PA only.
Function Usage
/* Scenario: Shut down PILO to reduce power consumption as it is not needed. */
{
/* The Watchdog timer should be unlocked before PILO being enabled. */
Cy_SysClk_PiloDisable(); /* Disable the PILO */
}