MINI55_BSP V3.02.004
The Board Support Package for Mini55 Series MCU
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 &~(SYS_BODCTL_BODVL1_0_Msk|SYS_BODCTL_BODEN_Msk))|SYS_BODCTL_BODVL1_0_Msk)
 Disable Brown-out detector function. More...
 
#define SYS_ENABLE_BOD()   (SYS->BODCTL = (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_BODVL1_0_Msk|SYS_BODCTL_BODVL2_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_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_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...
 
#define SYS_GET_IRCTRIM_INT_FLAG()   (SYS->IRCTISTS)
 Get HIRC trim status. More...
 
#define SYS_CLEAR_IRCTRIM_INT_FLAG(u32IRCTrimFlg)   (SYS->IRCTISTS = u32IRCTrimFlg )
 Clear HIRC trim 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)
 This function clear the selected system reset source. More...
 
uint32_t SYS_GetBODStatus (void)
 This function get Brown-out detector output status. More...
 
uint32_t SYS_GetResetSrc (void)
 This function get the system reset source register value. More...
 
uint32_t SYS_IsRegLocked (void)
 This function check register write-protection bit setting. More...
 
uint32_t SYS_ReadPDID (void)
 This function get product ID. More...
 
void SYS_ResetChip (void)
 This function reset chip. More...
 
void SYS_ResetCPU (void)
 This function reset CPU. More...
 
void SYS_ResetModule (uint32_t u32ModuleIndex)
 This function reset selected modules. More...
 
void SYS_EnableBOD (int32_t i32Mode, uint32_t u32BODLevel)
 This function configure BOD function. Configure BOD reset or interrupt mode and set Brown-out voltage level. Enable Brown-out function. More...
 
void SYS_DisableBOD (void)
 This function disable BOD function. More...
 
void SYS_EnableIRCTrim (uint32_t u32TrimSel, uint32_t u32TrimEnInt)
 This function enable HIRC trim function. More...
 
void SYS_DisableIRCTrim (void)
 This function disable HIRC trim 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 241 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 250 of file sys.h.

◆ SYS_CLEAR_IRCTRIM_INT_FLAG

#define SYS_CLEAR_IRCTRIM_INT_FLAG (   u32IRCTrimFlg)    (SYS->IRCTISTS = u32IRCTrimFlg )

Clear HIRC trim flag.

Parameters
[in]u32IRCTrimFlgis HIRC trim flags. Including:
Returns
None

This macro clear HIRC trim flag.

Definition at line 467 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 417 of file sys.h.

◆ SYS_DISABLE_BOD

#define SYS_DISABLE_BOD ( )    (SYS->BODCTL = (SYS->BODCTL &~(SYS_BODCTL_BODVL1_0_Msk|SYS_BODCTL_BODEN_Msk))|SYS_BODCTL_BODVL1_0_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 259 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 296 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 394 of file sys.h.

◆ SYS_ENABLE_BOD

#define SYS_ENABLE_BOD ( )    (SYS->BODCTL = (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 268 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 305 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 403 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 277 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 287 of file sys.h.

◆ SYS_GET_IRCTRIM_INT_FLAG

#define SYS_GET_IRCTRIM_INT_FLAG ( )    (SYS->IRCTISTS)

Get HIRC trim status.

Parameters
None
Return values
BIT0HIRC Frequency Lock
BIT1Trim Failure Interrupt
BIT2LXT Clock error

This macro get HIRC trim interrupt status register.

Definition at line 457 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 340 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 349 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 358 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 367 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 376 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 385 of file sys.h.

◆ SYS_SET_BOD_LEVEL

#define SYS_SET_BOD_LEVEL (   u32Level)    (SYS->BODCTL = (SYS->BODCTL & ~(SYS_BODCTL_BODVL1_0_Msk|SYS_BODCTL_BODVL2_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 331 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 314 of file sys.h.

Function Documentation

◆ SYS_ClearResetSrc()

void SYS_ClearResetSrc ( uint32_t  u32Src)

This function clear the selected system reset source.

Parameters
[in]u32Srcis system reset source
Returns
None

Definition at line 31 of file sys.c.

◆ SYS_DisableBOD()

void SYS_DisableBOD ( void  )

This function disable BOD function.

Returns
None

Definition at line 143 of file sys.c.

◆ SYS_DisableIRCTrim()

void SYS_DisableIRCTrim ( void  )

This function disable HIRC trim function.

Parameters
None
Returns
None

Definition at line 170 of file sys.c.

◆ SYS_EnableBOD()

void SYS_EnableBOD ( int32_t  i32Mode,
uint32_t  u32BODLevel 
)

This function configure BOD function. Configure BOD reset or interrupt mode and set Brown-out voltage level. Enable Brown-out function.

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

Definition at line 132 of file sys.c.

◆ SYS_EnableIRCTrim()

void SYS_EnableIRCTrim ( uint32_t  u32TrimSel,
uint32_t  u32TrimEnInt 
)

This function enable HIRC trim function.

Parameters
[in]u32TrimSelis trim frequency selection. Including :
[in]u32TrimEnIntis HIRC trim interrupt selection. Including :
Returns
None

Definition at line 159 of file sys.c.

◆ SYS_GetBODStatus()

uint32_t SYS_GetBODStatus ( void  )

This function get Brown-out detector output status.

Returns
0: System voltage is higher than BOD_VL setting or BOD_EN is 0. 1: System voltage is lower than BOD_VL setting. Note : If the BOD_EN is 0, this function always return 0.

Definition at line 42 of file sys.c.

◆ SYS_GetResetSrc()

uint32_t SYS_GetResetSrc ( void  )

This function get the system reset source register value.

Returns
Reset source

Definition at line 51 of file sys.c.

◆ SYS_IsRegLocked()

uint32_t SYS_IsRegLocked ( void  )

This function check register write-protection bit setting.

Returns
0: Write-protection function is disabled. 1: Write-protection function is enabled.

Definition at line 61 of file sys.c.

◆ SYS_LockReg()

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 444 of file sys.h.

◆ SYS_ReadPDID()

uint32_t SYS_ReadPDID ( void  )

This function get product ID.

Returns
Product ID

Definition at line 70 of file sys.c.

◆ SYS_ResetChip()

void SYS_ResetChip ( void  )

This function reset chip.

Returns
None

Definition at line 79 of file sys.c.

◆ SYS_ResetCPU()

void SYS_ResetCPU ( void  )

This function reset CPU.

Returns
None

Definition at line 88 of file sys.c.

◆ SYS_ResetModule()

void SYS_ResetModule ( uint32_t  u32ModuleIndex)

This function reset selected modules.

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

Definition at line 108 of file sys.c.

◆ SYS_UnlockReg()

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 426 of file sys.h.