BURTCEMLIB
Detailed Description
Backup Real Time Counter (BURTC) Peripheral API.
This module contains functions to control the BURTC peripheral of Silicon Labs 32-bit MCUs. The Backup Real Time Counter allows timekeeping in all energy modes. The Backup RTC is also available when the system is in backup mode.
Data Structures | |
struct | BURTC_Init_TypeDef |
Macros | |
#define | BURTC_INIT_DEFAULT |
#define | burtcClkDiv_1 1 |
#define | burtcClkDiv_128 128 |
#define | burtcClkDiv_16 16 |
#define | burtcClkDiv_2 2 |
#define | burtcClkDiv_32 32 |
#define | burtcClkDiv_4 4 |
#define | burtcClkDiv_64 64 |
#define | burtcClkDiv_8 8 |
Enumerations | |
enum | BURTC_ClkSel_TypeDef { burtcClkSelULFRCO = BURTC_CTRL_CLKSEL_ULFRCO, burtcClkSelLFRCO = BURTC_CTRL_CLKSEL_LFRCO, burtcClkSelLFXO = BURTC_CTRL_CLKSEL_LFXO } |
enum | BURTC_LP_TypeDef { burtcLPDisable = BURTC_LPMODE_LPMODE_DISABLE, burtcLPEnable = BURTC_LPMODE_LPMODE_ENABLE, burtcLPBU = BURTC_LPMODE_LPMODE_BUEN } |
enum | BURTC_Mode_TypeDef { burtcModeDisable = BURTC_CTRL_MODE_DISABLE, burtcModeEM2 = BURTC_CTRL_MODE_EM2EN, burtcModeEM3 = BURTC_CTRL_MODE_EM3EN, burtcModeEM4 = BURTC_CTRL_MODE_EM4EN } |
Functions | |
uint32_t | BURTC_ClockFreqGet (void) |
Get the clock frequency of the BURTC. | |
uint32_t | BURTC_CompareGet (unsigned int comp) |
Get the BURTC compare value. | |
void | BURTC_CompareSet (unsigned int comp, uint32_t value) |
Set BURTC compare channel. | |
__STATIC_INLINE uint32_t | BURTC_CounterGet (void) |
Get BURTC counter. | |
void | BURTC_CounterReset (void) |
Reset counter. | |
void | BURTC_Enable (bool enable) |
Enable or Disable BURTC peripheral reset and start counter. | |
__STATIC_INLINE void | BURTC_FreezeEnable (bool enable) |
Freeze register updates until enabled. | |
void | BURTC_Init (const BURTC_Init_TypeDef *burtcInit) |
Initialize BURTC. | |
__STATIC_INLINE void | BURTC_IntClear (uint32_t flags) |
Clear one or more pending BURTC interrupts. | |
__STATIC_INLINE void | BURTC_IntDisable (uint32_t flags) |
Disable one or more BURTC interrupts. | |
__STATIC_INLINE void | BURTC_IntEnable (uint32_t flags) |
Enable one or more BURTC interrupts. | |
__STATIC_INLINE uint32_t | BURTC_IntGet (void) |
Get pending BURTC interrupt flags. | |
__STATIC_INLINE uint32_t | BURTC_IntGetEnabled (void) |
Get enabled and pending BURTC interrupt flags. | |
__STATIC_INLINE void | BURTC_IntSet (uint32_t flags) |
Set one or more pending BURTC interrupts from SW. | |
__STATIC_INLINE void | BURTC_Lock (void) |
Lock BURTC registers, will protect from writing new config settings. | |
__STATIC_INLINE void | BURTC_Powerdown (bool enable) |
Shut down power to rentention register bank. | |
void | BURTC_Reset (void) |
Restore BURTC to reset state. | |
__STATIC_INLINE uint32_t | BURTC_RetRegGet (uint32_t num) |
Read a value from one of the retention registers. | |
__STATIC_INLINE void | BURTC_RetRegSet (uint32_t num, uint32_t data) |
Set a value in one of the retention registers. | |
__STATIC_INLINE uint32_t | BURTC_Status (void) |
Status of BURTC RAM, timestamp and LP Mode. | |
__STATIC_INLINE void | BURTC_StatusClear (void) |
Clear and reset BURTC status register. | |
__STATIC_INLINE void | BURTC_SyncWait (void) |
Wait for the BURTC to complete all synchronization of register changes and commands. | |
__STATIC_INLINE uint32_t | BURTC_TimestampGet (void) |
Get BURTC timestamp for entering BU. | |
__STATIC_INLINE void | BURTC_Unlock (void) |
Unlock BURTC registers, enable write access to change configuration. | |
Macro Definition Documentation
#define BURTC_INIT_DEFAULT |
Default configuration for BURTC initialization structure.
Definition at line 132
of file em_burtc.h
.
#define burtcClkDiv_1 1 |
BURTC clock divisors. These values are valid for the BURTC prescaler. Divide clock by 1.
Definition at line 62
of file em_burtc.h
.
#define burtcClkDiv_128 128 |
Divide clock by 128.
Definition at line 69
of file em_burtc.h
.
#define burtcClkDiv_16 16 |
Divide clock by 16.
Definition at line 66
of file em_burtc.h
.
#define burtcClkDiv_2 2 |
Divide clock by 2.
Definition at line 63
of file em_burtc.h
.
#define burtcClkDiv_32 32 |
Divide clock by 32.
Definition at line 67
of file em_burtc.h
.
#define burtcClkDiv_4 4 |
Divide clock by 4.
Definition at line 64
of file em_burtc.h
.
#define burtcClkDiv_64 64 |
Divide clock by 64.
Definition at line 68
of file em_burtc.h
.
#define burtcClkDiv_8 8 |
Divide clock by 8.
Definition at line 65
of file em_burtc.h
.
Enumeration Type Documentation
enum BURTC_ClkSel_TypeDef |
enum BURTC_LP_TypeDef |
enum BURTC_Mode_TypeDef |
Function Documentation
uint32_t BURTC_ClockFreqGet | ( | void |
| ) |
Get the clock frequency of the BURTC.
- Returns
- The current frequency in Hz.
Ultra-low frequency (1 kHz) clock.
Low-frequency RC oscillator.
Low-frequency crystal oscillator.
Definition at line 376
of file em_burtc.c
.
References _BURTC_CTRL_CLKSEL_MASK, _BURTC_CTRL_PRESC_DIV1, _BURTC_CTRL_PRESC_MASK, _BURTC_CTRL_PRESC_SHIFT, BURTC, BURTC_CTRL_CLKSEL_LFRCO, BURTC_CTRL_CLKSEL_LFXO, BURTC_CTRL_CLKSEL_ULFRCO, SystemLFRCOClockGet(), SystemLFXOClockGet(), and SystemULFRCOClockGet().
uint32_t BURTC_CompareGet | ( | unsigned int | comp | ) |
Get the BURTC compare value.
- Parameters
-
[in] comp
Compare the channel index value, must be 0 for Giant/Leopard Gecko.
- Returns
- The currently configured value for this compare channel.
Definition at line 302
of file em_burtc.c
.
References BURTC.
void BURTC_CompareSet | ( | unsigned int | comp, |
uint32_t | value |
||
) |
Set BURTC compare channel.
- Parameters
-
[in] comp
Compare the channel index, must be 0 for current devices. [in] value
New compare value.
Definition at line 272
of file em_burtc.c
.
References BURTC, and BURTC_SYNCBUSY_COMP0.
__STATIC_INLINE uint32_t BURTC_CounterGet | ( | void |
| ) |
Get BURTC counter.
- Returns
- BURTC counter value
Definition at line 374
of file em_burtc.h
.
References BURTC.
void BURTC_Enable | ( | bool | enable | ) |
Enable or Disable BURTC peripheral reset and start counter.
- Parameters
-
[in] enable
If true; asserts reset to BURTC, halts counter, if false; deassert reset
Definition at line 254
of file em_burtc.c
.
References _BURTC_CTRL_MODE_MASK, _BURTC_CTRL_RSTEN_SHIFT, BURTC, BURTC_CTRL_MODE_DISABLE, and BUS_RegBitWrite().
Referenced by BURTC_Init().
__STATIC_INLINE void BURTC_FreezeEnable | ( | bool | enable | ) |
Freeze register updates until enabled.
- Parameters
-
[in] enable
If true, registers are not updated until enabled again.
Definition at line 395
of file em_burtc.h
.
References _BURTC_FREEZE_REGFREEZE_SHIFT, BURTC, and BUS_RegBitWrite().
Referenced by BURTC_Init().
void BURTC_Init | ( | const BURTC_Init_TypeDef * | burtcInit | ) |
Initialize BURTC.
Configures the BURTC peripheral.
- Note
- Before initialization, BURTC module must first be enabled by clearing the reset bit in the RMU, i.e.,
* RMU_ResetControl(rmuResetBU, rmuResetModeClear); *
Compare channel 0 must be configured outside this function, before initialization if enable is set to true. The counter will always be reset.
- Parameters
-
[in] burtcInit
A pointer to the BURTC initialization structure.
Definition at line 130
of file em_burtc.c
.
References _BURTC_CTRL_BUMODETSEN_SHIFT, _BURTC_CTRL_COMP0TOP_SHIFT, _BURTC_CTRL_DEBUGRUN_SHIFT, _BURTC_CTRL_LPCOMP_SHIFT, _BURTC_CTRL_PRESC_SHIFT, BURTC, BURTC_CTRL_RSTEN, BURTC_Enable(), BURTC_FreezeEnable(), BURTC_IntClear(), BURTC_SYNCBUSY_LPMODE, BURTC_SyncWait(), burtcClkSelULFRCO, burtcLPDisable, burtcModeDisable, BURTC_Init_TypeDef::clkDiv, BURTC_Init_TypeDef::clkSel, BURTC_Init_TypeDef::compare0Top, BURTC_Init_TypeDef::debugRun, BURTC_Init_TypeDef::enable, BURTC_Init_TypeDef::lowPowerComp, BURTC_Init_TypeDef::lowPowerMode, BURTC_Init_TypeDef::mode, and BURTC_Init_TypeDef::timeStamp.
__STATIC_INLINE void BURTC_IntClear | ( | uint32_t | flags | ) |
Clear one or more pending BURTC interrupts.
- Parameters
-
[in] flags
BURTC interrupt sources to clear. Use a set of interrupt flags OR-ed together to clear multiple interrupt sources for the BURTC module (BURTC_IFS_nnn).
Definition at line 181
of file em_burtc.h
.
References BURTC.
Referenced by BURTC_Init().
__STATIC_INLINE void BURTC_IntDisable | ( | uint32_t | flags | ) |
Disable one or more BURTC interrupts.
- Parameters
-
[in] flags
BURTC interrupt sources to disable. Use a set of interrupt flags OR-ed together to disable multiple interrupt sources for the BURTC module (BURTC_IFS_nnn).
Definition at line 199
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE void BURTC_IntEnable | ( | uint32_t | flags | ) |
Enable one or more BURTC interrupts.
- Note
- Depending on use, a pending interrupt may already be set prior to enabling the interrupt. Consider using BURTC_IntClear() prior to enabling if a pending interrupt should be ignored.
- Parameters
-
[in] flags
BURTC interrupt sources to enable. Use a set of interrupt flags OR-ed together to set multiple interrupt sources for the BURTC module (BURTC_IFS_nnn).
Definition at line 222
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE uint32_t BURTC_IntGet | ( | void |
| ) |
Get pending BURTC interrupt flags.
- Note
- This function does not clear the event bits.
- Returns
- Pending BURTC interrupt sources. Returns a set of interrupt flags OR-ed together for multiple interrupt sources in the BURTC module (BURTC_IFS_nnn).
Definition at line 242
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE uint32_t BURTC_IntGetEnabled | ( | void |
| ) |
Get enabled and pending BURTC interrupt flags.
- Note
- The event bits are not cleared by the use of this function.
- Returns
- Pending BURTC interrupt sources that is also enabled. Returns a set of interrupt flags OR-ed together for multiple interrupt sources in the BURTC module (BURTC_IFS_nnn).
Definition at line 259
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE void BURTC_IntSet | ( | uint32_t | flags | ) |
Set one or more pending BURTC interrupts from SW.
- Parameters
-
[in] flags
BURTC interrupt sources to set to pending. Use a set of interrupt flags OR-ed together to set multiple interrupt sources for the BURTC module (BURTC_IFS_nnn).
Definition at line 279
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE void BURTC_Powerdown | ( | bool | enable | ) |
Shut down power to rentention register bank.
- Parameters
-
[in] enable
If true, shuts off power to retention registers.
- Note
- When power rentention is disabled, it cannot be enabled again (until reset).
Definition at line 408
of file em_burtc.h
.
References _BURTC_POWERDOWN_RAM_SHIFT, BURTC, and BUS_RegBitWrite().
void BURTC_Reset | ( | void |
| ) |
Restore BURTC to reset state.
- Note
- Before accessing the BURTC, BURSTEN in RMU->CTRL must be cleared. LOCK will not be reset to default value, as this will disable access to core BURTC registers.
Definition at line 338
of file em_burtc.c
.
References _BURTC_IEN_RESETVALUE, _BURTC_IF_MASK, _RMU_CTRL_BURSTEN_SHIFT, BURTC, BURTC_SyncWait(), BUS_RegBitRead(), BUS_RegBitWrite(), and RMU.
__STATIC_INLINE uint32_t BURTC_RetRegGet | ( | uint32_t | num | ) |
Read a value from one of the retention registers.
- Parameters
-
[in] num
Retention Register to read
Definition at line 436
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE void BURTC_RetRegSet | ( | uint32_t | num, |
uint32_t | data |
||
) |
Set a value in one of the retention registers.
- Parameters
-
[in] num
Register to set [in] data
Value to put into register
Definition at line 422
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE uint32_t BURTC_Status | ( | void |
| ) |
Status of BURTC RAM, timestamp and LP Mode.
- Returns
- A mask logially OR-ed status bits
Definition at line 294
of file em_burtc.h
.
References BURTC.
__STATIC_INLINE uint32_t BURTC_TimestampGet | ( | void |
| ) |
Get BURTC timestamp for entering BU.
- Returns
- BURTC Time Stamp value
Definition at line 386
of file em_burtc.h
.
References BURTC.