I/Os Freeze

General Description

Functions
bool	Cy_SysPm_IoIsFrozen (void)
	Checks whether IOs are frozen. More...
void	Cy_SysPm_IoUnfreeze (void)
	This function unfreezes the I/O cells that are automatically frozen when Hibernate is entered with the call to Cy_SysPm_SystemEnterHibernate(). More...
void	Cy_SysPm_IoFreeze (void)
	Freezes IOs. More...
bool	Cy_SysPm_DeepSleepIoIsFrozen (void)
	Checks whether IOs are frozen during DEEPSLEEP-RAM/OFF. More...
void	Cy_SysPm_DeepSleepIoUnfreeze (void)
	This function unfreezes the I/O cells that are automatically frozen when DEEPSLEEP-RAM/OFF is entered. More...

Function Documentation

Cy_SysPm_IoIsFrozen()

bool Cy_SysPm_IoIsFrozen

(

void

)

Checks whether IOs are frozen.

Returns

• True if IOs are frozen.
• False if IOs are unfrozen.

Function Usage

    
    /* Scenario: There is a need to use Hibernate power mode and retain the 
    *  the I/O state after the a wake-up from Hibernate
    */

    /* Check the I/O freeze status after the boot.
    *  If the I/O is frozen it means we have returned from Hibernate.
    */
    if(Cy_SysPm_IoIsFrozen())
    {
        /* Restore the I/O configuration before unfreezing.
        *  Use configuration data programmed into firmware stored in
        *  SRSS->PWR_HIB_DATA[] or BACKUP->BREG[] 
        *  before the Hibernate was entered.The most common use case is to
        *  restore from GPIO driver the firmware initialization structures.
        */
        Cy_SysPm_IoUnfreeze();
    }

    /* Save the I/O before entering Hibernate. You can store the
    *  the I/O configuration into SRSS->PWR_HIB_DATA[] or 
    *  BACKUP->BREG[] registers.
    */
    
    /* Enter Hibernate mode */
    Cy_SysPm_SystemEnterHibernate();
    

Cy_SysPm_IoUnfreeze()

void Cy_SysPm_IoUnfreeze

(

void

)

This function unfreezes the I/O cells that are automatically frozen when Hibernate is entered with the call to Cy_SysPm_SystemEnterHibernate().

I/O cells remain frozen after a wakeup from Hibernate mode until the firmware unfreezes them by calling this function.

If the firmware must retain the data value on the pin, then the value must be read and re-written to the pin's port data register before calling this function. Furthermore, the drive mode must be re-programmed before the pins are unfrozen. If this is not done, the pin will change to the default state the moment the freeze is removed.

Note that I/O cell configuration can be changed while frozen. The new configuration becomes effective only after the pins are unfrozen.

Function Usage

    
    /* Scenario: There is a need to use Hibernate power mode and retain the 
    *  the I/O state after the a wake-up from Hibernate
    */

    /* Check the I/O freeze status after the boot.
    *  If the I/O is frozen it means we have returned from Hibernate.
    */
    if(Cy_SysPm_IoIsFrozen())
    {
        /* Restore the I/O configuration before unfreezing.
        *  Use configuration data programmed into firmware stored in
        *  SRSS->PWR_HIB_DATA[] or BACKUP->BREG[] 
        *  before the Hibernate was entered.The most common use case is to
        *  restore from GPIO driver the firmware initialization structures.
        */
        Cy_SysPm_IoUnfreeze();
    }

    /* Save the I/O before entering Hibernate. You can store the
    *  the I/O configuration into SRSS->PWR_HIB_DATA[] or 
    *  BACKUP->BREG[] registers.
    */
    
    /* Enter Hibernate mode */
    Cy_SysPm_SystemEnterHibernate();
    

Cy_SysPm_IoFreeze()

void Cy_SysPm_IoFreeze

(

void

)

Freezes IOs.

Freezes the IO cells directly to save the IO-cell state on a wakeup from the Hibernate. Do not call this function before entering the Hibernate mode, because Cy_SysPm_Hibernate() function freezes the IO cells.

Note

This function is available for CAT1C devices.

Freezes the IO cells directly to save the IO-cell state on a wakeup from the Hibernate. Do not call this function before entering the Hibernate mode, because Cy_SysPm_Hibernate() function freezes the IO cells.

Cy_SysPm_DeepSleepIoIsFrozen()

bool Cy_SysPm_DeepSleepIoIsFrozen

(

void

)

Checks whether IOs are frozen during DEEPSLEEP-RAM/OFF.

Returns

• True if IOs are frozen.
• False if IOs are unfrozen.

Note

This function is available for CAT1B and CAT1D devices.

Cy_SysPm_DeepSleepIoUnfreeze()

void Cy_SysPm_DeepSleepIoUnfreeze

(

void

)

This function unfreezes the I/O cells that are automatically frozen when DEEPSLEEP-RAM/OFF is entered.

I/O cells remain frozen after a wakeup from DEEPSLEEP_RAM/OFF mode until the firmware unfreezes them by calling this function.

If the firmware must retain the data value on the pin, then the value must be read and re-written to the pin's port data register before calling this function. Furthermore, the drive mode must be re-programmed before the pins are unfrozen. If this is not done, the pin will change to the default state the moment the freeze is removed.

Note that I/O cell configuration can be changed while frozen. The new configuration becomes effective only after the pins are unfrozen.

Note

This function is available for CAT1B and CAT1D devices.