BURTC - Backup RTC

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
BURTC initialization structure for Series 2 devices.

Functions

void BURTC_IntClear (uint32_t flags)
Clear one or more pending BURTC interrupts.
void BURTC_IntDisable (uint32_t flags)
Disable one or more BURTC interrupts.
void BURTC_IntEnable (uint32_t flags)
Enable one or more BURTC interrupts.
uint32_t BURTC_IntGet (void)
Get pending BURTC interrupt flags.
uint32_t BURTC_IntGetEnabled (void)
Get enabled and pending BURTC interrupt flags.
void BURTC_IntSet (uint32_t flags)
Set one or more pending BURTC interrupts from SW.
uint32_t BURTC_Status (void)
Status of BURTC RAM, timestamp and LP Mode.
void BURTC_SyncWait (void)
Wait for the BURTC to complete all synchronization of register changes and commands.
void BURTC_Start (void)
Start BURTC counter.
void BURTC_Stop (void)
Stop the BURTC counter.
uint32_t BURTC_CounterGet (void)
Get BURTC counter.
void BURTC_Lock (void)
Lock BURTC registers, will protect from writing new config settings.
void BURTC_Unlock (void)
Unlock BURTC registers, enable write access to change configuration.
void BURTC_Reset (void)
Restore BURTC to reset state.
void BURTC_Init (const BURTC_Init_TypeDef *burtcInit)
Initialize BURTC.
void BURTC_Enable (bool enable)
Enable or Disable BURTC peripheral.
void BURTC_CounterReset (void)
Reset counter.
void BURTC_CompareSet (unsigned int comp, uint32_t value)
Set BURTC compare channel.
uint32_t BURTC_CompareGet (unsigned int comp)
Get the BURTC compare value.

Macros

#define burtcClkDiv_1 1
BURTC clock divisors.
#define burtcClkDiv_2 2
Divide clock by 2.
#define burtcClkDiv_4 4
Divide clock by 4.
#define burtcClkDiv_8 8
Divide clock by 8.
#define burtcClkDiv_16 16
Divide clock by 16.
#define burtcClkDiv_32 32
Divide clock by 32.
#define burtcClkDiv_64 64
Divide clock by 64.
#define burtcClkDiv_128 128
Divide clock by 128.
#define BURTC_INIT_DEFAULT
Default configuration for BURTC init structure.

Function Documentation

BURTC_IntClear()

void BURTC_IntClear ( uint32_t flags )
inline

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).

BURTC_IntDisable()

void BURTC_IntDisable ( uint32_t flags )
inline

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).

BURTC_IntEnable()

void BURTC_IntEnable ( uint32_t flags )
inline

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).

BURTC_IntGet()

uint32_t BURTC_IntGet ( void )
inline

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).

BURTC_IntGetEnabled()

uint32_t BURTC_IntGetEnabled ( void )
inline

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).

BURTC_IntSet()

void BURTC_IntSet ( uint32_t flags )
inline

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).

BURTC_Status()

uint32_t BURTC_Status ( void )