Functions

General Description

Functions
void	Cy_SysClk_IloEnable (void)
	Enables the ILO. More...
bool	Cy_SysClk_IloIsEnabled (void)
	Reports the Enabled/Disabled status of the ILO. More...
cy_en_sysclk_status_t	Cy_SysClk_IloDisable (void)
	Disables the ILO. More...
void	Cy_SysClk_IloHibernateOn (bool on)
	Controls whether the ILO stays on during a hibernate, or through an XRES or brown-out detect (BOD) event. More...
void	Cy_SysClk_IloSrcEnable (uint32_t iloNum)
	Enables the ILO. More...
bool	Cy_SysClk_IloSrcIsEnabled (uint32_t iloNum)
	Reports the Enabled/Disabled status of the ILO. More...
cy_en_sysclk_status_t	Cy_SysClk_IloSrcDisable (uint32_t iloNum)
	Disables the ILO. More...
void	Cy_SysClk_IloSrcHibernateOn (uint32_t iloNum, bool on)
	Controls whether the ILO0 stays on during a hibernate, or through an XRES or brown-out detect (BOD) event, this feature is not available for ILO1. More...

Function Documentation

Cy_SysClk_IloEnable()

void Cy_SysClk_IloEnable

(

void

)

Enables the ILO.

Note

The watchdog timer (WDT) must be unlocked before calling this function.

Function Usage

    /* Scenario: ILO needs to source the LFCLK. The watchdog timer (WDT) is unlocked
                 and all peripherals clocked using the LFCLK are disabled. */

    /* Enable the ILO */
    Cy_SysClk_IloEnable();

    /* Set the LFCLK source to the ILO */
    Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_ILO);

Note

This API is available for CAT1A (excluding TVIIBE) and CAT1B devices.

Cy_SysClk_IloIsEnabled()

bool Cy_SysClk_IloIsEnabled

(

void

)

Reports the Enabled/Disabled status of the ILO.

Returns

Boolean status of ILO: true - Enabled, false - Disabled.

Function Usage

    /* Scenario: LFCLK needs to be sourced by the PILO instead of the ILO. All
                 peripherals clocked by the LFCLK are disabled and the Watchdog
                 timer (WDT) is unlocked. */

    if (Cy_SysClk_IloIsEnabled())
    {
        /* Disable the ILO */
        Cy_SysClk_IloDisable();

        /* Enable the PILO */
        Cy_SysClk_PiloEnable();

        /* Set the LFCLK source to the PILO */
        Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_PILO);
    }

Note

This API is available for CAT1A (excluding TVIIBE) and CAT1B devices.

Cy_SysClk_IloDisable()

cy_en_sysclk_status_t Cy_SysClk_IloDisable

(

void

)

Disables the ILO.

ILO can't be disabled if WDT is enabled.

Returns

Error / status code:
CY_SYSCLK_SUCCESS - ILO successfully disabled
CY_SYSCLK_INVALID_STATE - Cannot disable the ILO if the WDT is enabled. CY_PRA_STATUS_* - For the PSoC 64 devices there are possible situations when function returns the PRA error status code cy_en_pra_status_t instead of cy_en_sysclk_status_t. This is because for PSoC 64 devices the function uses the PRA driver to change the protected registers. Refer to cy_en_pra_status_t for more details.

Note

The watchdog timer (WDT) must be unlocked before calling this function. Do not call this function if the WDT is enabled, because the WDT is clocked by the ILO.

Function Usage

    /* Scenario: LFCLK needs to be sourced by the PILO instead of the ILO. All
                 peripherals clocked by the LFCLK are disabled and the Watchdog
                 timer (WDT) is unlocked. */

    if (Cy_SysClk_IloIsEnabled())
    {
        /* Disable the ILO */
        Cy_SysClk_IloDisable();

        /* Enable the PILO */
        Cy_SysClk_PiloEnable();

        /* Set the LFCLK source to the PILO */
        Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_PILO);
    }

Note

This API is available for CAT1A (excluding TVIIBE) and CAT1B devices.

Cy_SysClk_IloHibernateOn()

void Cy_SysClk_IloHibernateOn

(

bool

on

)

Controls whether the ILO stays on during a hibernate, or through an XRES or brown-out detect (BOD) event.

Parameters

on	true = ILO stays on during hibernate or across XRES/BOD. false = ILO turns off for hibernate or XRES/BOD.

Note

Writes to the register/bit are ignored if the watchdog (WDT) is locked.

Function Usage

    /* Scenario: The ILO needs to clock the Real-Time-clock (RTC) during chip
                 hibernate, hard reset (XRES) and Brown-out detect (BOD) events.
                 All peripherals clocked by the LFCLK are disabled and the
                 Watchdog timer (WDT) is unlocked. */

    /* Enable ILO operation during chip hibernate mode */
    Cy_SysClk_IloHibernateOn(true);

    /* Enable the ILO */
    Cy_SysClk_IloEnable();

    /* Set the LFCLK source to the ILO */
    Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_ILO);

Note

This API is available for CAT1A (excluding TVIIBE) and CAT1B devices.

Cy_SysClk_IloSrcEnable()

void Cy_SysClk_IloSrcEnable

(

uint32_t

iloNum

)

Enables the ILO.

Parameters

iloNum

- ILO index , 0 : ILO0, 1: ILO1

Function Usage

    /* Scenario: ILO0 needs to source the LFCLK. The watchdog timer (WDT) is unlocked
                 and all peripherals clocked using the LFCLK are disabled. */

    /* Enable the ILO0 */
    Cy_SysClk_IloSrcEnable(0);

    /* Set the LFCLK source to the ILO0 */
    Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_ILO);

Note

The watchdog timer (WDT) must be unlocked before calling this function.

This API is available for CAT1A (TVIIBE only) and CAT1C devices.

Cy_SysClk_IloSrcIsEnabled()

bool Cy_SysClk_IloSrcIsEnabled

(

uint32_t

iloNum

)

Reports the Enabled/Disabled status of the ILO.

Parameters

iloNum

- ILO index , ILO0 or ILO1

Function Usage

    /* Scenario: Check the enable/disable status of ILO1 and disable, if it is already enabled.*/
    if (Cy_SysClk_IloSrcIsEnabled(1))
    {
        /* Disable the ILO1 */
        Cy_SysClk_IloSrcDisable(1);
    }

Returns

Boolean status of ILO: true - Enabled, false - Disabled.

Note

This API is available for CAT1A (TVIIBE only) and CAT1C devices.

Cy_SysClk_IloSrcDisable()

cy_en_sysclk_status_t Cy_SysClk_IloSrcDisable

(

uint32_t

iloNum

)

Disables the ILO.

ILO can't be disabled if WDT is enabled.

Parameters

iloNum

- ILO index , 0 : ILO0, 1: ILO1

Function Usage

    /* Scenario: LFCLK needs to be sourced by the PILO instead of the ILO. All
                 peripherals clocked by the LFCLK are disabled and the Watchdog
                 timer (WDT) is unlocked. */

    if (Cy_SysClk_IloSrcIsEnabled(0))
    {
        /* Disable the ILO0 */
        Cy_SysClk_IloSrcDisable(0);

        /* Enable the PILO */
        Cy_SysClk_PiloEnable();

        /* Set the LFCLK source to the PILO */
        Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_PILO);
    }

Returns

Error / status code:
CY_SYSCLK_SUCCESS - ILO successfully disabled
CY_SYSCLK_INVALID_STATE - Cannot disable the ILO if the WDT is enabled.

Note

The watchdog timer (WDT) must be unlocked before calling this function. Do not call this function if the WDT is enabled, because the WDT is clocked by the ILO.

This API is available for CAT1A (TVIIBE only) and CAT1C devices.

Cy_SysClk_IloSrcHibernateOn()

void Cy_SysClk_IloSrcHibernateOn	(	uint32_t	iloNum,
		bool	on
	)

Controls whether the ILO0 stays on during a hibernate, or through an XRES or brown-out detect (BOD) event, this feature is not available for ILO1.

Parameters

iloNum	- ILO index , 0 : ILO0, 1: ILO1(Feature not available, ignored)
on	true = ILO stays on during hibernate or across XRES/BOD. false = ILO turns off for hibernate or XRES/BOD.

Function Usage

    /* Scenario: The ILO0 needs to clock the Real-Time-clock (RTC) during chip
                 hibernate, hard reset (XRES) and Brown-out detect (BOD) events.
                 All peripherals clocked by the LFCLK are disabled and the
                 Watchdog timer (WDT) is unlocked. */

    /* Enable ILO0 operation during chip hibernate mode */
    Cy_SysClk_IloSrcHibernateOn(0, true);

    /* Enable the ILO0 */
    Cy_SysClk_IloSrcEnable(0);

    /* Set the LFCLK source to the ILO0 */
    Cy_SysClk_ClkLfSetSource(CY_SYSCLK_CLKLF_IN_ILO);

Note

Writes to the register/bit are ignored if the watchdog (WDT) is locked.

This API is available for CAT1A (TVIIBE only) and CAT1C devices.