RTCC - Real Timer Counter/Calendar
Description
Real Time Counter and Calendar (RTCC) Peripheral API.
This module contains functions to control the RTCC peripheral of Silicon Labs 32-bit MCUs and SoCs. The RTCC ensures timekeeping in low energy modes. The RTCC also includes a BCD calendar mode for easy time and date keeping.
Data Structures |
|
struct | RTCC_Init_TypeDef |
RTCC initialization structure.
|
|
struct | RTCC_CCChConf_TypeDef |
RTCC capture/compare channel configuration structure.
|
|
Functions |
|
uint32_t | RTCC_ChannelCompareValueGet (int ch) |
Get RTCC compare register value for selected channel.
|
|
void | RTCC_ChannelCompareValueSet (int ch, uint32_t value) |
Set RTCC compare register value for selected channel.
|
|
uint32_t | RTCC_ChannelCaptureValueGet (int ch) |
Get RTCC input capture register value for selected channel.
|
|
uint32_t | RTCC_ChannelCCVGet (int ch) |
Get RTCC capture/compare register value for selected channel.
|
|
void | RTCC_ChannelCCVSet (int ch, uint32_t value) |
Set RTCC capture/compare register value for selected channel.
|
|
uint32_t | RTCC_ChannelDateGet (int ch) |
Get the calendar DATE register content for selected channel.
|
|
void | RTCC_ChannelDateSet (int ch, uint32_t date) |
Set calendar DATE register for selected channel.
|
|
uint32_t | RTCC_ChannelTimeGet (int ch) |
Get calendar TIME register content for selected channel.
|
|
void | RTCC_ChannelTimeSet (int ch, uint32_t time) |
Set calendar TIME register for selected channel.
|
|
uint32_t | RTCC_CombinedCounterGet (void) |
Get combined CNT/PRECNT register content.
|
|
uint32_t | RTCC_CounterGet (void) |
Get RTCC counter value.
|
|
void | RTCC_CounterSet (uint32_t value) |
Set RTCC CNT counter.
|
|
uint32_t | RTCC_DateGet (void) |
Get DATE register value.
|
|
void | RTCC_DateSet (uint32_t date) |
Set RTCC DATE register.
|
|
void | RTCC_EM4WakeupEnable (bool enable) |
Enable/disable EM4 wakeup capability.
|
|
void | RTCC_Enable (bool enable) |
Enable/disable RTCC counting.
|
|
void | RTCC_Init (const RTCC_Init_TypeDef *init) |
Initialize RTCC.
|
|
void | RTCC_ChannelInit (int ch, RTCC_CCChConf_TypeDef const *confPtr) |
Configure the selected capture/compare channel of the RTCC.
|
|
void | RTCC_IntClear (uint32_t flags) |
Clear one or more pending RTCC interrupts.
|
|
void | RTCC_IntDisable (uint32_t flags) |
Disable one or more RTCC interrupts.
|
|
void | RTCC_IntEnable (uint32_t flags) |
Enable one or more RTCC interrupts.
|
|
uint32_t | RTCC_IntGet (void) |
Get pending RTCC interrupt flags.
|
|
uint32_t | RTCC_IntGetEnabled (void) |
Get enabled and pending RTCC interrupt flags.
|
|
void | RTCC_IntSet (uint32_t flags) |
Set one or more pending RTCC interrupts from SW.
|
|
void | RTCC_Lock (void) |
Lock RTCC registers.
|
|
uint32_t | RTCC_PreCounterGet (void) |
Get RTCC pre-counter value.
|
|
void | RTCC_PreCounterSet (uint32_t preCntVal) |
Set RTCC pre-counter value.
|
|
void | RTCC_Reset (void) |
Restore RTCC to its reset state.
|
|
void | RTCC_RetentionRamPowerDown (void) |
Power down retention RAM.
|
|
void | RTCC_StatusClear (void) |
Clear the STATUS register.
|
|
uint32_t | RTCC_StatusGet (void) |
Get STATUS register value.
|
|
uint32_t | RTCC_TimeGet (void) |
Get TIME register value.
|
|
void | RTCC_TimeSet (uint32_t time) |
Set RTCC TIME register.
|
|
void | RTCC_Unlock (void) |
Unlock RTCC registers.
|
|
Macros |
|
#define | RTCC_INIT_DEFAULT |
Default RTCC initialization structure.
|
|
#define | RTCC_CH_INIT_COMPARE_DEFAULT |
Default RTCC channel output compare initialization structure.
|
|
#define | RTCC_CH_INIT_CAPTURE_DEFAULT |
Default RTCC channel input capture initialization structure.
|
|
#define | RTCC_CC_NUM 3UL |
Number of RTCC capture/compare channels.
|
|
#define | RTCC_CH_VALID (ch) ((unsigned)(ch) < RTCC_CC_NUM ) |
Validation of valid RTCC channel for assert statements.
|
|
Typedefs |
|
typedef uint8_t | RTCC_PRSSel_TypeDef |
PRS channel number.
|
|
Enumerations |
|
enum |
RTCC_CntMode_TypeDef
{
rtccCntModeNormal = _RTCC_CTRL_CNTMODE_NORMAL, rtccCntModeCalendar = _RTCC_CTRL_CNTMODE_CALENDAR } |
Operational mode of the counter.
|
|
enum |
RTCC_CntPresc_TypeDef
{
rtccCntPresc_1 = _RTCC_CTRL_CNTPRESC_DIV1, rtccCntPresc_2 = _RTCC_CTRL_CNTPRESC_DIV2, rtccCntPresc_4 = _RTCC_CTRL_CNTPRESC_DIV4, rtccCntPresc_8 = _RTCC_CTRL_CNTPRESC_DIV8, rtccCntPresc_16 = _RTCC_CTRL_CNTPRESC_DIV16, rtccCntPresc_32 = _RTCC_CTRL_CNTPRESC_DIV32, rtccCntPresc_64 = _RTCC_CTRL_CNTPRESC_DIV64, rtccCntPresc_128 = _RTCC_CTRL_CNTPRESC_DIV128, rtccCntPresc_256 = _RTCC_CTRL_CNTPRESC_DIV256, rtccCntPresc_512 = _RTCC_CTRL_CNTPRESC_DIV512, rtccCntPresc_1024 = _RTCC_CTRL_CNTPRESC_DIV1024, rtccCntPresc_2048 = _RTCC_CTRL_CNTPRESC_DIV2048, rtccCntPresc_4096 = _RTCC_CTRL_CNTPRESC_DIV4096, rtccCntPresc_8192 = _RTCC_CTRL_CNTPRESC_DIV8192, rtccCntPresc_16384 = _RTCC_CTRL_CNTPRESC_DIV16384, rtccCntPresc_32768 = _RTCC_CTRL_CNTPRESC_DIV32768 } |
Counter prescaler selection.
|
|
enum |
RTCC_PrescMode_TypeDef
{
rtccCntTickPresc = _RTCC_CTRL_CNTTICK_PRESC, rtccCntTickCCV0Match = _RTCC_CTRL_CNTTICK_CCV0MATCH } |
Prescaler mode of the RTCC counter.
|
|
enum |
RTCC_CapComChMode_TypeDef
{
rtccCapComChModeOff = _RTCC_CC_CTRL_MODE_OFF, rtccCapComChModeCapture = _RTCC_CC_CTRL_MODE_INPUTCAPTURE, rtccCapComChModeCompare = _RTCC_CC_CTRL_MODE_OUTPUTCOMPARE } |
Capture/Compare channel mode.
|
|
enum |
RTCC_CompMatchOutAction_TypeDef
{
rtccCompMatchOutActionPulse = _RTCC_CC_CTRL_CMOA_PULSE, rtccCompMatchOutActionToggle = _RTCC_CC_CTRL_CMOA_TOGGLE, rtccCompMatchOutActionClear = _RTCC_CC_CTRL_CMOA_CLEAR, rtccCompMatchOutActionSet = _RTCC_CC_CTRL_CMOA_SET } |
Compare match output action mode.
|
|
enum |
RTCC_InEdgeSel_TypeDef
{
rtccInEdgeRising = _RTCC_CC_CTRL_ICEDGE_RISING, rtccInEdgeFalling = _RTCC_CC_CTRL_ICEDGE_FALLING, rtccInEdgeBoth = _RTCC_CC_CTRL_ICEDGE_BOTH, rtccInEdgeNone = _RTCC_CC_CTRL_ICEDGE_NONE } |
Input edge select.
|
|
enum |
RTCC_CompBase_TypeDef
{
rtccCompBaseCnt = _RTCC_CC_CTRL_COMPBASE_CNT, rtccCompBasePreCnt = _RTCC_CC_CTRL_COMPBASE_PRECNT } |
Capture/Compare channel compare mode.
|
|
enum |
RTCC_DayCompareMode_TypeDef
{
rtccDayCompareModeMonth = _RTCC_CC_CTRL_DAYCC_MONTH, rtccDayCompareModeWeek = _RTCC_CC_CTRL_DAYCC_WEEK } |
Day compare mode.
|
|
Function Documentation
◆ RTCC_ChannelCompareValueGet()
|
inline |
Get RTCC compare register value for selected channel.
- Parameters
-
[in] ch
Channel selector.
- Returns
- Compare register value.
◆ RTCC_ChannelCompareValueSet()
|
inline |
Set RTCC compare register value for selected channel.
- Parameters
-
[in] ch
Channel selector. [in] value
Compare register value
◆ RTCC_ChannelCaptureValueGet()
|
inline |
Get RTCC input capture register value for selected channel.
- Parameters
-
[in] ch
Channel selector.
- Returns
- Capture register value.
◆ RTCC_ChannelCCVGet()
|
inline |
Get RTCC capture/compare register value for selected channel.
For parts with separate capture compare value registers, this function returns the compare value.
- Parameters
-
[in] ch
Channel selector.
- Returns
- Capture/compare register value.
◆ RTCC_ChannelCCVSet()
|
inline |
Set RTCC capture/compare register value for selected channel.
For parts with separate capture compare value registers, this function sets the compare value.
- Parameters
-
[in] ch
Channel selector. [in] value
Capture/compare register value
◆ RTCC_ChannelDateGet()
|
inline |
Get the calendar DATE register content for selected channel.
- Parameters
-
[in] ch
Channel selector.
- Returns
- DATE register value.
◆ RTCC_ChannelDateSet()
|
inline |
Set calendar DATE register for selected channel.
- Parameters
-
[in] ch
Channel selector. [in] date
DATE value.
◆ RTCC_ChannelTimeGet()
|
inline |
Get calendar TIME register content for selected channel.
- Parameters
-
[in] ch
Channel selector.
- Returns
- TIME register value.
◆ RTCC_ChannelTimeSet()
|
inline |
Set calendar TIME register for selected channel.
- Parameters
-
[in] ch
Channel selector. [in] time
TIME value.
◆ RTCC_CombinedCounterGet()
|
inline |
Get combined CNT/PRECNT register content.
- Returns
- CNT/PRECNT register value.
◆ RTCC_CounterGet()
|
inline |
Get RTCC counter value.
- Returns
- Current RTCC counter value.
◆ RTCC_CounterSet()
|
inline |
Set RTCC CNT counter.
- Parameters
-
[in] value
CNT value.
◆ RTCC_DateGet()
|
inline |
Get DATE register value.
- Returns
- Current DATE register value.
◆ RTCC_DateSet()
|
inline |
Set RTCC DATE register.
- Parameters
-
[in] date
DATE value.
◆ RTCC_EM4WakeupEnable()
|
inline |
Enable/disable EM4 wakeup capability.
- Parameters
-
[in] enable
Set to true to enable EM4 wakeup, set to false otherwise.
◆ RTCC_Enable()
void RTCC_Enable | ( | bool |
enable
|
) |
Enable/disable RTCC counting.
- Parameters
-
[in] enable
True to enable RTCC counting, false to disable counting.
◆ RTCC_Init()
void RTCC_Init | ( | const RTCC_Init_TypeDef * |
init
|
) |
Initialize RTCC.
Note that the compare values must be set separately with RTCC_CompareSet(), which should probably be done prior to the use of this function if configuring the RTCC to start when initialization is completed.
- Parameters
-
[in] init
A pointer to the RTCC initialization structure.
◆ RTCC_ChannelInit()
void RTCC_ChannelInit | ( | int |
ch,
|
RTCC_CCChConf_TypeDef const * |
confPtr
|
||
) |
Configure the selected capture/compare channel of the RTCC.
Use this function to configure an RTCC channel. Select capture/compare mode, match output action, overflow output action, and PRS input configuration. See the configuration structure RTCC_CCChConf_TypeDef for more details.
- Parameters
-
[in] ch
A channel selector. [in] confPtr
A pointer to the configuration structure.
Configure the selected capture/compare channel.
◆ RTCC_IntClear()
|
inline |
Clear one or more pending RTCC interrupts.
- Parameters
-
[in] flags
RTCC interrupt sources to clear. Use a set of interrupt flags OR-ed together to clear multiple interrupt sources.
◆ RTCC_IntDisable()
|
inline |
Disable one or more RTCC interrupts.
- Parameters
-
[in] flags
RTCC interrupt sources to disable. Use a set of interrupt flags OR-ed together to disable multiple interrupt.
◆ RTCC_IntEnable()
|
inline |
Enable one or more RTCC interrupts.
- Note
- Depending on the use, a pending interrupt may already be set prior to enabling the interrupt. To ignore a pending interrupt, consider using RTCC_IntClear() prior to enabling the interrupt.
- Parameters
-
[in] flags
RTCC interrupt sources to enable. Use a set of interrupt flags OR-ed together to set multiple interrupt.
◆ RTCC_IntGet()
|
inline |
Get pending RTCC interrupt flags.
- Note
- Event bits are not cleared by using this function.
- Returns
- Pending RTCC interrupt sources. Returns a set of interrupt flags OR-ed together for the interrupt sources set.
◆ RTCC_IntGetEnabled()
|
inline |
Get enabled and pending RTCC interrupt flags.
Useful for handling more interrupt sources in the same interrupt handler.
- Returns
- Pending and enabled RTCC interrupt sources. Returns a set of interrupt flags OR-ed together for the interrupt sources set.
◆ RTCC_IntSet()
|
inline |
Set one or more pending RTCC interrupts from SW.
- Parameters
-
[in] flags
RTCC interrupt sources to set to pending. Use a set of interrupt flags (RTCC_IFS_nnn).
◆ RTCC_Lock()
|
inline |
Lock RTCC registers.
- Note
- When RTCC registers are locked, RTCC_CTRL, RTCC_PRECNT, RTCC_CNT, RTCC_TIME, RTCC_DATE, RTCC_IEN, RTCC_POWERDOWN and RTCC_CCx_XXX registers cannot be written to.
◆ RTCC_PreCounterGet()
|
inline |
Get RTCC pre-counter value.
- Returns
- Current RTCC pre-counter value.
◆ RTCC_PreCounterSet()
|
inline |
Set RTCC pre-counter value.
- Parameters
-
[in] preCntVal
RTCC pre-counter value to be set.
◆ RTCC_Reset()
void RTCC_Reset | ( | void |
|
) |
Restore RTCC to its reset state.
◆ RTCC_RetentionRamPowerDown()
|
inline |
Power down retention RAM.
- Note
- Once retention RAM is powered down, it cannot be powered up again.
◆ RTCC_StatusClear()
void RTCC_StatusClear | ( | void |
|
) |
Clear the STATUS register.
◆ RTCC_StatusGet()
|
inline |
Get STATUS register value.
- Returns
- Current STATUS register value.
◆ RTCC_TimeGet()
|
inline |
Get TIME register value.
- Returns
- Current TIME register value.
◆ RTCC_TimeSet()
|
inline |
Set RTCC TIME register.
- Parameters
-
[in] time
TIME value.
◆ RTCC_Unlock()
|
inline |
Unlock RTCC registers.
- Note
- When RTCC registers are locked, RTCC_CTRL, RTCC_PRECNT, RTCC_CNT, RTCC_TIME, RTCC_DATE, RTCC_IEN, RTCC_POWERDOWN and RTCC_CCx_XXX registers cannot be written to.
Macro Definition Documentation
◆ RTCC_INIT_DEFAULT
#define RTCC_INIT_DEFAULT |
Default RTCC initialization structure.
◆ RTCC_CH_INIT_COMPARE_DEFAULT
#define RTCC_CH_INIT_COMPARE_DEFAULT |
Default RTCC channel output compare initialization structure.
◆ RTCC_CH_INIT_CAPTURE_DEFAULT
#define RTCC_CH_INIT_CAPTURE_DEFAULT |
Default RTCC channel input capture initialization structure.
◆ RTCC_CC_NUM
#define RTCC_CC_NUM 3UL |
Number of RTCC capture/compare channels.
◆ RTCC_CH_VALID
#define RTCC_CH_VALID | ( |
ch
|
) | ((unsigned)(ch) < RTCC_CC_NUM ) |
Validation of valid RTCC channel for assert statements.
Typedef Documentation
◆ RTCC_PRSSel_TypeDef
typedef uint8_t RTCC_PRSSel_TypeDef |
PRS channel number.
This type is used when configuring input capture mode on a RTCC channel.
Enumeration Type Documentation
◆ RTCC_CntMode_TypeDef
enum RTCC_CntMode_TypeDef |
◆ RTCC_CntPresc_TypeDef
Counter prescaler selection.