MTB CAT1 Peripheral driver library
Cortex-M4 Control Functions

General Description

Functions

uint32_t Cy_SysGetCM4Status (void)
 Returns the Cortex-M4 core power mode. More...
 
void Cy_SysEnableCM4 (uint32_t vectorTableOffset)
 Sets vector table base address and enables the Cortex-M4 core. More...
 
void Cy_SysDisableCM4 (void)
 Disables the Cortex-M4 core and waits for the mode to take the effect. More...
 
void Cy_SysRetainCM4 (void)
 Retains the Cortex-M4 core and exists without waiting for the mode to take effect. More...
 
void Cy_SysResetCM4 (void)
 Resets the Cortex-M4 core and waits for the mode to take the effect. More...
 

Function Documentation

◆ Cy_SysGetCM4Status()

uint32_t Cy_SysGetCM4Status ( void  )

Returns the Cortex-M4 core power mode.

Returns
Cortex-M4 Status Macros

◆ Cy_SysEnableCM4()

void Cy_SysEnableCM4 ( uint32_t  vectorTableOffset)

Sets vector table base address and enables the Cortex-M4 core.

Note
If the CPU is already enabled, it is reset and then enabled.
Parameters
vectorTableOffsetThe offset of the vector table base address from memory address 0x00000000. The offset should be multiple to 1024 bytes.

◆ Cy_SysDisableCM4()

void Cy_SysDisableCM4 ( void  )

Disables the Cortex-M4 core and waits for the mode to take the effect.

Warning
Do not call the function while the Cortex-M4 is executing because such a call may corrupt/abort a pending bus-transaction by the CPU and cause unexpected behavior in the system including a deadlock. Call the function while the Cortex-M4 core is in the Sleep or Deep Sleep low-power mode. Use the SysPm (System Power Management) Power Management (syspm) API to put the CPU into the low-power modes. Use the Cy_SysPm_ReadStatus() to get a status of the CPU.

◆ Cy_SysRetainCM4()

void Cy_SysRetainCM4 ( void  )

Retains the Cortex-M4 core and exists without waiting for the mode to take effect.

Note
The retained mode can be entered only from the enabled mode.
Warning
Do not call the function while the Cortex-M4 is executing because such a call may corrupt/abort a pending bus-transaction by the CPU and cause unexpected behavior in the system including a deadlock. Call the function while the Cortex-M4 core is in the Sleep or Deep Sleep low-power mode. Use the SysPm (System Power Management) Power Management (syspm) API to put the CPU into the low-power modes. Use the Cy_SysPm_ReadStatus() to get a status of the CPU.

◆ Cy_SysResetCM4()

void Cy_SysResetCM4 ( void  )

Resets the Cortex-M4 core and waits for the mode to take the effect.

Note
The reset mode can not be entered from the retained mode.
Warning
Do not call the function while the Cortex-M4 is executing because such a call may corrupt/abort a pending bus-transaction by the CPU and cause unexpected behavior in the system including a deadlock. Call the function while the Cortex-M4 core is in the Sleep or Deep Sleep low-power mode. Use the SysPm (System Power Management) Power Management (syspm) API to put the CPU into the low-power modes. Use the Cy_SysPm_ReadStatus() to get a status of the CPU.