MTB CAT1 Peripheral driver library
Functions
Power Status
SysPm (System Power Management) » Functions

General Description

Functions

uint32_t Cy_SysPm_ReadStatus (void)
 Reads the power modes status of the system and CPU(s). More...
 
bool Cy_SysPm_IsSystemUlp (void)
 Checks if the system is in ULP mode. More...
 
bool Cy_SysPm_IsSystemLp (void)
 Checks if the system is in LP mode. More...
 
bool Cy_SysPm_IsSystemMf (void)
 Checks if the system is in MF mode. More...
 
bool Cy_SysPm_IsSystemHp (void)
 Checks if the system is in HP mode. More...
 
bool Cy_SysPm_Cm4IsActive (void)
 Checks if CM4 is in CPU Active mode. More...
 
bool Cy_SysPm_Cm4IsSleep (void)
 Checks if the CM4 is in CPU Sleep mode. More...
 
bool Cy_SysPm_Cm4IsDeepSleep (void)
 Checks if the CM4 is in the CPU Deep Sleep mode. More...
 
bool Cy_SysPm_Cm0IsActive (void)
 Checks if the CM0+ is in CPU Active mode. More...
 
bool Cy_SysPm_Cm0IsSleep (void)
 Checks if the CM0+ is in CPU Sleep mode. More...
 
bool Cy_SysPm_Cm0IsDeepSleep (void)
 Checks if the CM0+ is in CPU Deep Sleep mode. More...
 
bool Cy_SysPm_IsBgRefCtrl (void)
 Get the power mode status of Bandgap Ref Circuits. More...
 
void Cy_SysPm_BgRefCtrl (bool enable)
 Enables/Disables powers mode of Bandgap Ref Circuits. More...
 
bool Cy_SysPm_Cm33IsActive (void)
 Checks if CM33 is in the active mode. More...
 
bool Cy_SysPm_Cm33IsSleep (void)
 Checks if the CM33 is in the sleep mode. More...
 
bool Cy_SysPm_Cm33IsDeepSleep (void)
 Checks if the CM33 is in the deep sleep mode. More...
 
bool Cy_SysPm_Cm55IsActive (void)
 Checks if CM55 is in the active mode. More...
 
bool Cy_SysPm_Cm55IsSleep (void)
 Checks if the CM55 is in the sleep mode. More...
 
bool Cy_SysPm_Cm55IsDeepSleep (void)
 Checks if the CM55 is in the deep sleep mode. More...
 
bool Cy_SysPm_Cm7IsActive (uint8_t core)
 Checks if CM7 is in the active mode. More...
 
bool Cy_SysPm_Cm7IsSleep (uint8_t core)
 Checks if the CM7 is in the sleep mode. More...
 
bool Cy_SysPm_Cm7IsDeepSleep (uint8_t core)
 Checks if the CM7 is in the deep sleep mode. More...
 

Function Documentation

◆ Cy_SysPm_ReadStatus()

uint32_t Cy_SysPm_ReadStatus ( void  )

Reads the power modes status of the system and CPU(s).

Returns
The current power mode. See The Power Mode Status Defines.
Function Usage
/* Scenario: There is a need to check the system current power mode and CPU
* power mode
*/
if(CY_SYSPM_STATUS_SYSTEM_ULP == (CY_SYSPM_STATUS_SYSTEM_ULP & Cy_SysPm_ReadStatus()))
{
/* The system is currently in ULP mode */
}
Note
This API is available for CAT1A, CAT1B(PSoC C3) and CAT1D devices.

Reads the power modes status of the system and CPU(s).

Returns
The current power mode. See The Power Mode Status Defines.

◆ Cy_SysPm_IsSystemUlp()

bool Cy_SysPm_IsSystemUlp ( void  )

Checks if the system is in ULP mode.

Returns
  • True the system is in ULP mode.
  • False the system is is not ULP mode.
Note
This API is available for CAT1A, CAT1B(BOYII) and CAT1D devices.
Function Usage
/* Scenario: There is a need to check if the system is in Ultra Low Power
* mode
*/
if (Cy_SysPm_IsSystemUlp())
{
/* The system is in ULP */
}

◆ Cy_SysPm_IsSystemLp()

bool Cy_SysPm_IsSystemLp ( void  )

Checks if the system is in LP mode.

Returns
  • True the system is in LP mode.
  • False the system is not in LP mode.
Note
This API is available for CAT1A, CAT1B(BOYII), CAT1C & CAT1D devices.
Function Usage
/* Scenario: There is a need to check if the system is in Low Power
* mode
*/
if (Cy_SysPm_IsSystemLp())
{
/* The system is in LP mode */
}

◆ Cy_SysPm_IsSystemMf()

bool Cy_SysPm_IsSystemMf ( void  )

Checks if the system is in MF mode.

Returns
  • True the system is in MF mode.
  • False the system is not in MF mode.
Note
This API is available for CAT1B(PSoC C3) devices only.
Function Usage
/* Scenario: There is a need to check if the system is in Low Power
* mode
*/
#if defined (CY_IP_MXS40SSRSS) && (CY_MXS40SSRSS_VER_1_2 > 0UL)
if (Cy_SysPm_IsSystemMf())
{
/* The system is in MF mode */
}

◆ Cy_SysPm_IsSystemHp()

bool Cy_SysPm_IsSystemHp ( void  )

Checks if the system is in HP mode.

Returns
  • True the system is in HP mode.
  • False the system is not in HP mode.
Note
This API is available for CAT1D devices only.
Function Usage
/* Scenario: There is a need to check if the system is in Low Power
* mode
*/
#if defined (CY_IP_MXS22SRSS)
if (Cy_SysPm_IsSystemHp())
{
/* The system is in MF mode */
}

◆ Cy_SysPm_Cm4IsActive()

bool Cy_SysPm_Cm4IsActive ( void  )

Checks if CM4 is in CPU Active mode.

Returns
  • True if CM4 is in CPU Active mode.
  • False if the CM4 is not in CPU Active mode.
Note
This API is available for CAT1A devices.
Function Usage
/* Scenario: There is a need to check if CM4 is in CPU Active mode */
if (Cy_SysPm_Cm4IsActive())
{
/* CM4 is in CPU Active mode */
}

◆ Cy_SysPm_Cm4IsSleep()

bool Cy_SysPm_Cm4IsSleep ( void  )

Checks if the CM4 is in CPU Sleep mode.

Returns
  • True if the CM4 is in CPU Sleep mode.
  • False if the CM4 is not in CPU Sleep mode.
Note
This API is available for CAT1A devices.
Function Usage
/* Scenario: There is a need to check if CM4 is in CPU Sleep mode */
if (Cy_SysPm_Cm4IsSleep())
{
/* CM4 is in CPU Sleep mode */
}

◆ Cy_SysPm_Cm4IsDeepSleep()

bool Cy_SysPm_Cm4IsDeepSleep ( void  )

Checks if the CM4 is in the CPU Deep Sleep mode.

Returns
  • True if CM4 is in CPU Deep Sleep mode.
  • False if the CM4 is not CPU in Deep Sleep mode.
Note
This API is available for CAT1A devices.
Function Usage
/* Scenario: There is a need to check if CM4 is in CPU Deep Sleep mode */
if (Cy_SysPm_Cm4IsDeepSleep())
{
/* CM4 is in CPU Deep Sleep mode */
}

◆ Cy_SysPm_Cm0IsActive()

bool Cy_SysPm_Cm0IsActive ( void  )

Checks if the CM0+ is in CPU Active mode.

Returns
  • True if the CM0+ is in CPU Active mode.
  • False if the CM0+ is not in CPU Active mode.
Note
This API is available for CAT1A & CAT1C devices.
Function Usage
/* Scenario: There is a need to check if CM0+ is in CPU Active mode */
if (Cy_SysPm_Cm0IsActive())
{
/* CM0+ is in CPU Active mode */
}

◆ Cy_SysPm_Cm0IsSleep()

bool Cy_SysPm_Cm0IsSleep ( void  )

Checks if the CM0+ is in CPU Sleep mode.

Returns
  • True if the CM0+ is in CPU Sleep mode.
  • False if the CM0+ is not in CPU Sleep mode.
Note
This API is available for CAT1A & CAT1C devices.
Function Usage
/* Scenario: There is a need to check if CM0+ is in CPU Sleep mode */
if (Cy_SysPm_Cm0IsSleep())
{
/* CM0+ is in CPU Sleep mode */
}

◆ Cy_SysPm_Cm0IsDeepSleep()

bool Cy_SysPm_Cm0IsDeepSleep ( void  )

Checks if the CM0+ is in CPU Deep Sleep mode.

Returns
  • True if the CM0+ is in CPU Deep Sleep mode
  • False if the CM0+ is not in CPU Deep Sleep mode
Note
This API is available for CAT1A & CAT1C devices.
Function Usage
/* Scenario: There is a need to check if CM0+ is in CPU Deep Sleep mode */
if (Cy_SysPm_Cm0IsDeepSleep())
{
/* CM0+ is in CPU Deep Sleep mode */
}

◆ Cy_SysPm_IsBgRefCtrl()

bool Cy_SysPm_IsBgRefCtrl ( void  )

Get the power mode status of Bandgap Ref Circuits.

Returns
true - Bandgap Ref Circuits power mode is enabled, false - Bandgap Ref Circuits power mode is disabled.
Note
This API is available for CAT1A (TVIIBE only) and CAT1C devices.

◆ Cy_SysPm_BgRefCtrl()

void Cy_SysPm_BgRefCtrl ( bool  enable)

Enables/Disables powers mode of Bandgap Ref Circuits.

Parameters
enabletrue - to enable, false - to disable
Note
This API is available for CAT1A (TVIIBE only) and CAT1C devices.

◆ Cy_SysPm_Cm33IsActive()

bool Cy_SysPm_Cm33IsActive ( void  )

Checks if CM33 is in the active mode.

Note
This API is available for CAT1D devices.
Returns
true - if CM33 is in the active mode, false - if the CM33 is not in active mode.

◆ Cy_SysPm_Cm33IsSleep()

bool Cy_SysPm_Cm33IsSleep ( void  )

Checks if the CM33 is in the sleep mode.

Note
This API is available for CAT1D devices.
Returns
true - if the CM33 is in the sleep mode, false - if the CM33 is not in the sleep mode.

◆ Cy_SysPm_Cm33IsDeepSleep()

bool Cy_SysPm_Cm33IsDeepSleep ( void  )

Checks if the CM33 is in the deep sleep mode.

Returns
true - if CM33 is in the deep sleep mode, false - if the CM33 is not in the deep sleep mode.

◆ Cy_SysPm_Cm55IsActive()

bool Cy_SysPm_Cm55IsActive ( void  )

Checks if CM55 is in the active mode.

Note
This API is available for CAT1D devices.
Returns
true - if CM55 is in the active mode, false - if the CM55 is not in active mode.

◆ Cy_SysPm_Cm55IsSleep()

bool Cy_SysPm_Cm55IsSleep ( void  )

Checks if the CM55 is in the sleep mode.

Note
This API is available for CAT1D devices.
Returns
true - if the CM55 is in the sleep mode, false - if the CM55 is not in the sleep mode.

◆ Cy_SysPm_Cm55IsDeepSleep()

bool Cy_SysPm_Cm55IsDeepSleep ( void  )

Checks if the CM55 is in the deep sleep mode.

Returns
true - if CM55 is in the deep sleep mode, false - if the CM55 is not in the deep sleep mode.

◆ Cy_SysPm_Cm7IsActive()

bool Cy_SysPm_Cm7IsActive ( uint8_t  core)

Checks if CM7 is in the active mode.

Parameters
coreSelects the core, 0 for CM7_0, 1 for CM7_1
Note
This API is available for CAT1C devices.
Returns
true - if CM7 is in the active mode, false - if the CM7 is not in active mode.

◆ Cy_SysPm_Cm7IsSleep()

bool Cy_SysPm_Cm7IsSleep ( uint8_t  core)

Checks if the CM7 is in the sleep mode.

Parameters
coreSelects the core, 0 for CM7_0, 1 for CM7_1
Note
This API is available for CAT1C devices.
Returns
true - if the CM7 is in the sleep mode, false - if the CM7 is not in the sleep mode.

◆ Cy_SysPm_Cm7IsDeepSleep()

bool Cy_SysPm_Cm7IsDeepSleep ( uint8_t  core)

Checks if the CM7 is in the deep sleep mode.

Parameters
coreSelects the core, 0 for CM7_0, 1 for CM7_1
Returns
true - if CM7 is in the deep sleep mode, false - if the CM7 is not in the deep sleep mode.