M471M/R1/S BSP V3.01.000
The Board Support Package for M4521
Macros | Functions
Collaboration diagram for SYS Exported Functions:

Macros

#define SYS_CLEAR_BOD_INT_FLAG()   (SYS->BODCTL |= SYS_BODCTL_BODIF_Msk)
 Clear Brown-out detector interrupt flag. More...
 
#define SYS_CLEAR_BOD_LPM()   (SYS->BODCTL &= ~SYS_BODCTL_BODLPM_Msk)
 Set Brown-out detector function to normal mode. More...
 
#define SYS_DISABLE_BOD()   (SYS->BODCTL &= ~SYS_BODCTL_BODEN_Msk)
 Disable Brown-out detector function. More...
 
#define SYS_ENABLE_BOD()   (SYS->BODCTL |= SYS_BODCTL_BODEN_Msk)
 Enable Brown-out detector function. More...
 
#define SYS_GET_BOD_INT_FLAG()   (SYS->BODCTL & SYS_BODCTL_BODIF_Msk)
 Get Brown-out detector interrupt flag. More...
 
#define SYS_GET_BOD_OUTPUT()   (SYS->BODCTL & SYS_BODCTL_BODOUT_Msk)
 Get Brown-out detector status. More...
 
#define SYS_DISABLE_BOD_RST()   (SYS->BODCTL &= ~SYS_BODCTL_BODRSTEN_Msk)
 Enable Brown-out detector interrupt function. More...
 
#define SYS_ENABLE_BOD_RST()   (SYS->BODCTL |= SYS_BODCTL_BODRSTEN_Msk)
 Enable Brown-out detector reset function. More...
 
#define SYS_SET_BOD_LPM()   (SYS->BODCTL |= SYS_BODCTL_BODLPM_Msk)
 Set Brown-out detector function low power mode. More...
 
#define SYS_SET_BOD_LEVEL(u32Level)   (SYS->BODCTL = (SYS->BODCTL & ~SYS_BODCTL_BODVL_Msk) | (u32Level))
 Set Brown-out detector voltage level. More...
 
#define SYS_IS_BOD_RST()   (SYS->RSTSTS & SYS_RSTSTS_BODRF_Msk)
 Get reset source is from Brown-out detector reset. More...
 
#define SYS_IS_CPU_RST()   (SYS->RSTSTS & SYS_RSTSTS_CPURF_Msk)
 Get reset source is from CPU reset. More...
 
#define SYS_IS_LVR_RST()   (SYS->RSTSTS & SYS_RSTSTS_LVRF_Msk)
 Get reset source is from LVR Reset. More...
 
#define SYS_IS_POR_RST()   (SYS->RSTSTS & SYS_RSTSTS_PORF_Msk)
 Get reset source is from Power-on Reset. More...
 
#define SYS_IS_RSTPIN_RST()   (SYS->RSTSTS & SYS_RSTSTS_PINRF_Msk)
 Get reset source is from reset pin reset. More...
 
#define SYS_IS_SYSTEM_RST()   (SYS->RSTSTS & SYS_RSTSTS_SYSRF_Msk)
 Get reset source is from system reset. More...
 
#define SYS_IS_WDT_RST()   (SYS->RSTSTS & SYS_RSTSTS_WDTRF_Msk)
 Get reset source is from window watch dog reset. More...
 
#define SYS_DISABLE_LVR()   (SYS->BODCTL &= ~SYS_BODCTL_LVREN_Msk)
 Disable Low-Voltage-Reset function. More...
 
#define SYS_ENABLE_LVR()   (SYS->BODCTL |= SYS_BODCTL_LVREN_Msk)
 Enable Low-Voltage-Reset function. More...
 
#define SYS_DISABLE_POR()   (SYS->PORCTL = 0x5AA5)
 Disable Power-on Reset function. More...
 
#define SYS_ENABLE_POR()   (SYS->PORCTL = 0)
 Enable Power-on Reset function. More...
 
#define SYS_CLEAR_RST_SOURCE(u32RstSrc)   ((SYS->RSTSTS) = (u32RstSrc) )
 Clear reset source flag. More...
 

Functions

__STATIC_INLINE void SYS_UnlockReg (void)
 Disable register write-protection function. More...
 
__STATIC_INLINE void SYS_LockReg (void)
 Enable register write-protection function. More...
 
void SYS_ClearResetSrc (uint32_t u32Src)
 Clear reset source. More...
 
uint32_t SYS_GetBODStatus (void)
 Get Brown-out detector output status. More...
 
uint32_t SYS_GetResetSrc (void)
 Get reset status register value. More...
 
uint32_t SYS_IsRegLocked (void)
 Check if register is locked nor not. More...
 
uint32_t SYS_ReadPDID (void)
 Get product ID. More...
 
void SYS_ResetChip (void)
 Reset chip with chip reset. More...
 
void SYS_ResetCPU (void)
 Reset chip with CPU reset. More...
 
void SYS_ResetModule (uint32_t u32ModuleIndex)
 Reset selected module. More...
 
void SYS_EnableBOD (int32_t i32Mode, uint32_t u32BODLevel)
 Enable and configure Brown-out detector function. More...
 
void SYS_DisableBOD (void)
 Disable Brown-out detector function. More...
 

Detailed Description

Macro Definition Documentation

◆ SYS_CLEAR_BOD_INT_FLAG

#define SYS_CLEAR_BOD_INT_FLAG ( )    (SYS->BODCTL |= SYS_BODCTL_BODIF_Msk)

Clear Brown-out detector interrupt flag.

Parameters
None
Returns
None

This macro clear Brown-out detector interrupt flag.

Definition at line 464 of file sys.h.

◆ SYS_CLEAR_BOD_LPM

#define SYS_CLEAR_BOD_LPM ( )    (SYS->BODCTL &= ~SYS_BODCTL_BODLPM_Msk)

Set Brown-out detector function to normal mode.

Parameters
None
Returns
None

This macro set Brown-out detector to normal mode. The register write-protection function should be disabled before using this macro.

Definition at line 473 of file sys.h.

◆ SYS_CLEAR_RST_SOURCE

#define SYS_CLEAR_RST_SOURCE (   u32RstSrc)    ((SYS->RSTSTS) = (u32RstSrc) )

Clear reset source flag.

Parameters
[in]u32RstSrcis reset source. Including :
Returns
None

This macro clear reset source flag.

Definition at line 665 of file sys.h.

◆ SYS_DISABLE_BOD

#define SYS_DISABLE_BOD ( )    (SYS->BODCTL &= ~SYS_BODCTL_BODEN_Msk)

Disable Brown-out detector function.

Parameters
None
Returns
None

This macro disable Brown-out detector function. The register write-protection function should be disabled before using this macro.

Definition at line 482 of file sys.h.

◆ SYS_DISABLE_BOD_RST

#define SYS_DISABLE_BOD_RST ( )    (SYS->BODCTL &= ~SYS_BODCTL_BODRSTEN_Msk)

Enable Brown-out detector interrupt function.

Parameters
None
Returns
None

This macro enable Brown-out detector interrupt function. The register write-protection function should be disabled before using this macro.

Definition at line 519 of file sys.h.

◆ SYS_DISABLE_LVR

#define SYS_DISABLE_LVR ( )    (SYS->BODCTL &= ~SYS_BODCTL_LVREN_Msk)

Disable Low-Voltage-Reset function.

Parameters
None
Returns
None

This macro disable Low-Voltage-Reset function. The register write-protection function should be disabled before using this macro.

Definition at line 622 of file sys.h.

◆ SYS_DISABLE_POR

#define SYS_DISABLE_POR ( )    (SYS->PORCTL = 0x5AA5)

Disable Power-on Reset function.

Parameters
None
Returns
None

This macro disable Power-on Reset function. The register write-protection function should be disabled before using this macro.

Definition at line 640 of file sys.h.

◆ SYS_ENABLE_BOD

#define SYS_ENABLE_BOD ( )    (SYS->BODCTL |= SYS_BODCTL_BODEN_Msk)

Enable Brown-out detector function.

Parameters
None
Returns
None

This macro enable Brown-out detector function. The register write-protection function should be disabled before using this macro.

Definition at line 491 of file sys.h.

◆ SYS_ENABLE_BOD_RST

#define SYS_ENABLE_BOD_RST ( )    (SYS->BODCTL |= SYS_BODCTL_BODRSTEN_Msk)

Enable Brown-out detector reset function.

Parameters
None
Returns
None

This macro enable Brown-out detect reset function. The register write-protection function should be disabled before using this macro.

Definition at line 528 of file sys.h.

◆ SYS_ENABLE_LVR

#define SYS_ENABLE_LVR ( )    (SYS->BODCTL |= SYS_BODCTL_LVREN_Msk)

Enable Low-Voltage-Reset function.

Parameters
None
Returns
None

This macro enable Low-Voltage-Reset function. The register write-protection function should be disabled before using this macro.

Definition at line 631 of file sys.h.

◆ SYS_ENABLE_POR

#define SYS_ENABLE_POR ( )    (SYS->PORCTL = 0)

Enable Power-on Reset function.

Parameters
None
Returns
None

This macro enable Power-on Reset function. The register write-protection function should be disabled before using this macro.

Definition at line 649 of file sys.h.

◆ SYS_GET_BOD_INT_FLAG

#define SYS_GET_BOD_INT_FLAG ( )    (SYS->BODCTL & SYS_BODCTL_BODIF_Msk)

Get Brown-out detector interrupt flag.

Parameters
None
Return values
0Brown-out detect interrupt flag is not set.
>=1Brown-out detect interrupt flag is set.

This macro get Brown-out detector interrupt flag.

Definition at line 500 of file sys.h.

◆ SYS_GET_BOD_OUTPUT

#define SYS_GET_BOD_OUTPUT ( )    (SYS->BODCTL & SYS_BODCTL_BODOUT_Msk)

Get Brown-out detector status.

Parameters
None
Return values
0System voltage is higher than BOD threshold voltage setting or BOD function is disabled.
>=1System voltage is lower than BOD threshold voltage setting.

This macro get Brown-out detector output status. If the BOD function is disabled, this function always return 0.

Definition at line 510 of file sys.h.

◆ SYS_IS_BOD_RST

#define SYS_IS_BOD_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_BODRF_Msk)

Get reset source is from Brown-out detector reset.

Parameters
None
Return values
0Previous reset source is not from Brown-out detector reset
>=1Previous reset source is from Brown-out detector reset

This macro get previous reset source is from Brown-out detect reset or not.

Definition at line 559 of file sys.h.

◆ SYS_IS_CPU_RST

#define SYS_IS_CPU_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_CPURF_Msk)

Get reset source is from CPU reset.

Parameters
None
Return values
0Previous reset source is not from CPU reset
>=1Previous reset source is from CPU reset

This macro get previous reset source is from CPU reset.

Definition at line 568 of file sys.h.

◆ SYS_IS_LVR_RST

#define SYS_IS_LVR_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_LVRF_Msk)

Get reset source is from LVR Reset.

Parameters
None
Return values
0Previous reset source is not from Low-Voltage-Reset
>=1Previous reset source is from Low-Voltage-Reset

This macro get previous reset source is from Low-Voltage-Reset.

Definition at line 577 of file sys.h.

◆ SYS_IS_POR_RST

#define SYS_IS_POR_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_PORF_Msk)

Get reset source is from Power-on Reset.

Parameters
None
Return values
0Previous reset source is not from Power-on Reset
>=1Previous reset source is from Power-on Reset

This macro get previous reset source is from Power-on Reset.

Definition at line 586 of file sys.h.

◆ SYS_IS_RSTPIN_RST

#define SYS_IS_RSTPIN_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_PINRF_Msk)

Get reset source is from reset pin reset.

Parameters
None
Return values
0Previous reset source is not from reset pin reset
>=1Previous reset source is from reset pin reset

This macro get previous reset source is from reset pin reset.

Definition at line 595 of file sys.h.

◆ SYS_IS_SYSTEM_RST

#define SYS_IS_SYSTEM_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_SYSRF_Msk)

Get reset source is from system reset.

Parameters
None
Return values
0Previous reset source is not from system reset
>=1Previous reset source is from system reset

This macro get previous reset source is from system reset.

Definition at line 604 of file sys.h.

◆ SYS_IS_WDT_RST

#define SYS_IS_WDT_RST ( )    (SYS->RSTSTS & SYS_RSTSTS_WDTRF_Msk)

Get reset source is from window watch dog reset.

Parameters
None
Return values
0Previous reset source is not from window watch dog reset
>=1Previous reset source is from window watch dog reset

This macro get previous reset source is from window watch dog reset.

Definition at line 613 of file sys.h.

◆ SYS_SET_BOD_LEVEL

#define SYS_SET_BOD_LEVEL (   u32Level)    (SYS->BODCTL = (SYS->BODCTL & ~SYS_BODCTL_BODVL_Msk) | (u32Level))

Set Brown-out detector voltage level.

Parameters
[in]u32Levelis Brown-out voltage level. Including :
Returns
None

This macro set Brown-out detector voltage level. The write-protection function should be disabled before using this macro.

Definition at line 550 of file sys.h.

◆ SYS_SET_BOD_LPM

#define SYS_SET_BOD_LPM ( )    (SYS->BODCTL |= SYS_BODCTL_BODLPM_Msk)

Set Brown-out detector function low power mode.

Parameters
None
Returns
None

This macro set Brown-out detector to low power mode. The register write-protection function should be disabled before using this macro.

Definition at line 537 of file sys.h.

Function Documentation

◆ SYS_ClearResetSrc()

void SYS_ClearResetSrc ( uint32_t  u32Src)

Clear reset source.

Parameters
[in]u32Srcis system reset source. Including :
Returns
None

This function clear the selected system reset source.

Definition at line 42 of file sys.c.

◆ SYS_DisableBOD()

void SYS_DisableBOD ( void  )

Disable Brown-out detector function.

Parameters
None
Returns
None

This function disable Brown-out detector function. The register write-protection function should be disabled before using this function.

Definition at line 186 of file sys.c.

◆ SYS_EnableBOD()

void SYS_EnableBOD ( int32_t  i32Mode,
uint32_t  u32BODLevel 
)

Enable and configure Brown-out detector function.

Parameters
[in]i32Modeis reset or interrupt mode. Including :
[in]u32BODLevelis Brown-out voltage level. Including :
Returns
None

This function configure Brown-out detector reset or interrupt mode, enable Brown-out function and set Brown-out voltage level. The register write-protection function should be disabled before using this function.

Definition at line 167 of file sys.c.

◆ SYS_GetBODStatus()

uint32_t SYS_GetBODStatus ( void  )

Get Brown-out detector output status.

Parameters
None
Return values
0System voltage is higher than BOD_VL setting or BOD_EN is 0.
1System voltage is lower than BOD_VL setting.

This function get Brown-out detector output status.

Definition at line 54 of file sys.c.

◆ SYS_GetResetSrc()

uint32_t SYS_GetResetSrc ( void  )

Get reset status register value.

Parameters
None
Returns
Reset source

This function get the system reset status register value.

Definition at line 65 of file sys.c.

◆ SYS_IsRegLocked()

uint32_t SYS_IsRegLocked ( void  )

Check if register is locked nor not.

Parameters
None
Return values
0Write-protection function is disabled. 1 Write-protection function is enabled.

This function check register write-protection bit setting.

Definition at line 77 of file sys.c.

◆ SYS_LockReg()

__STATIC_INLINE void SYS_LockReg ( void  )

Enable register write-protection function.

Parameters
None
Returns
None

This function is used to enable register write-protection function. To lock the protected register to forbid write access.

Definition at line 698 of file sys.h.

Here is the caller graph for this function:

◆ SYS_ReadPDID()

uint32_t SYS_ReadPDID ( void  )

Get product ID.

Parameters
None
Returns
Product ID

This function get product ID.

Definition at line 88 of file sys.c.

◆ SYS_ResetChip()

void SYS_ResetChip ( void  )

Reset chip with chip reset.

Parameters
None
Returns
None

This function reset chip with chip reset. The register write-protection function should be disabled before using this function.

Definition at line 100 of file sys.c.

◆ SYS_ResetCPU()

void SYS_ResetCPU ( void  )

Reset chip with CPU reset.

Parameters
None
Returns
None

This function reset CPU with CPU reset. The register write-protection function should be disabled before using this function.

Definition at line 112 of file sys.c.

◆ SYS_ResetModule()

void SYS_ResetModule ( uint32_t  u32ModuleIndex)

Reset selected module.

Parameters
[in]u32ModuleIndexis module index. Including :
Returns
None

This function reset selected module.

Definition at line 144 of file sys.c.

◆ SYS_UnlockReg()

__STATIC_INLINE void SYS_UnlockReg ( void  )

Disable register write-protection function.

Parameters
None
Returns
None

This function disable register write-protection function. To unlock the protected register to allow write access.

Definition at line 680 of file sys.h.

Here is the caller graph for this function: