STM32F103xB HAL User Manual
Data Structures | Defines | Functions
stm32f1xx_ll_rtc.h File Reference

Header file of RTC LL module. More...

#include "stm32f1xx.h"

Go to the source code of this file.

Data Structures

struct  LL_RTC_InitTypeDef
 RTC Init structures definition. More...
struct  LL_RTC_TimeTypeDef
 RTC Time structure definition. More...
struct  LL_RTC_AlarmTypeDef
 RTC Alarm structure definition. More...

Defines

#define LL_RTC_FORMAT_BIN   (0x000000000U)
#define LL_RTC_FORMAT_BCD   (0x000000001U)
#define LL_RTC_BKP_DR1   (0x00000001U)
#define LL_RTC_BKP_DR2   (0x00000002U)
#define LL_RTC_BKP_DR3   (0x00000003U)
#define LL_RTC_BKP_DR4   (0x00000004U)
#define LL_RTC_BKP_DR5   (0x00000005U)
#define LL_RTC_BKP_DR6   (0x00000006U)
#define LL_RTC_BKP_DR7   (0x00000007U)
#define LL_RTC_BKP_DR8   (0x00000008U)
#define LL_RTC_BKP_DR9   (0x00000009U)
#define LL_RTC_BKP_DR10   (0x0000000AU)
#define LL_RTC_TAMPER_ACTIVELEVEL_LOW   BKP_CR_TPAL
#define LL_RTC_TAMPER_ACTIVELEVEL_HIGH   (0x00000000U)
#define LL_RTC_CALIB_OUTPUT_NONE   (0x00000000U)
#define LL_RTC_CALIB_OUTPUT_RTCCLOCK   BKP_RTCCR_CCO
#define LL_RTC_CALIB_OUTPUT_ALARM   BKP_RTCCR_ASOE
#define LL_RTC_CALIB_OUTPUT_SECOND   (BKP_RTCCR_ASOS | BKP_RTCCR_ASOE)
#define LL_RTC_WriteReg(__INSTANCE__, __REG__, __VALUE__)   WRITE_REG(__INSTANCE__->__REG__, (__VALUE__))
 Write a value in RTC register.
#define LL_RTC_ReadReg(__INSTANCE__, __REG__)   READ_REG(__INSTANCE__->__REG__)
 Read a value in RTC register.
#define __LL_RTC_CONVERT_BIN2BCD(__VALUE__)   (uint8_t)((((__VALUE__) / 10U) << 4U) | ((__VALUE__) % 10U))
 Helper macro to convert a value from 2 digit decimal format to BCD format.
#define __LL_RTC_CONVERT_BCD2BIN(__VALUE__)   (uint8_t)(((uint8_t)((__VALUE__) & (uint8_t)0xF0U) >> (uint8_t)0x4U) * 10U + ((__VALUE__) & (uint8_t)0x0FU))
 Helper macro to convert a value from BCD format to 2 digit decimal format.

Functions

__STATIC_INLINE void LL_RTC_SetAsynchPrescaler (RTC_TypeDef *RTCx, uint32_t AsynchPrescaler)
 Set Asynchronous prescaler factor.
__STATIC_INLINE uint32_t LL_RTC_GetDivider (RTC_TypeDef *RTCx)
 Get Asynchronous prescaler factor.
__STATIC_INLINE void LL_RTC_SetOutputSource (BKP_TypeDef *BKPx, uint32_t OutputSource)
 Set Output Source.
__STATIC_INLINE uint32_t LL_RTC_GetOutPutSource (BKP_TypeDef *BKPx)
 Get Output Source.
__STATIC_INLINE void LL_RTC_EnableWriteProtection (RTC_TypeDef *RTCx)
 Enable the write protection for RTC registers.
__STATIC_INLINE void LL_RTC_DisableWriteProtection (RTC_TypeDef *RTCx)
 Disable the write protection for RTC registers.
__STATIC_INLINE void LL_RTC_TIME_Set (RTC_TypeDef *RTCx, uint32_t TimeCounter)
 Set time counter in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TIME_Get (RTC_TypeDef *RTCx)
 Get time counter in BCD format.
__STATIC_INLINE void LL_RTC_ALARM_Set (RTC_TypeDef *RTCx, uint32_t AlarmCounter)
 Set Alarm Counter.
__STATIC_INLINE uint32_t LL_RTC_ALARM_Get (RTC_TypeDef *RTCx)
 Get Alarm Counter.
__STATIC_INLINE void LL_RTC_TAMPER_Enable (BKP_TypeDef *BKPx)
 Enable RTC_TAMPx input detection.
__STATIC_INLINE void LL_RTC_TAMPER_Disable (BKP_TypeDef *BKPx)
 Disable RTC_TAMPx Tamper.
__STATIC_INLINE void LL_RTC_TAMPER_SetActiveLevel (BKP_TypeDef *BKPx, uint32_t Tamper)
 Enable Active level for Tamper input.
__STATIC_INLINE uint32_t LL_RTC_TAMPER_GetActiveLevel (BKP_TypeDef *BKPx)
 Disable Active level for Tamper input.
__STATIC_INLINE void LL_RTC_BKP_SetRegister (BKP_TypeDef *BKPx, uint32_t BackupRegister, uint32_t Data)
 Writes a data in a specified RTC Backup data register.
__STATIC_INLINE uint32_t LL_RTC_BKP_GetRegister (BKP_TypeDef *BKPx, uint32_t BackupRegister)
 Reads data from the specified RTC Backup data Register.
__STATIC_INLINE void LL_RTC_CAL_SetCoarseDigital (BKP_TypeDef *BKPx, uint32_t Value)
 Set the coarse digital calibration.
__STATIC_INLINE uint32_t LL_RTC_CAL_GetCoarseDigital (BKP_TypeDef *BKPx)
 Get the coarse digital calibration value.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TAMPI (BKP_TypeDef *BKPx)
 Get RTC_TAMPI Interruption detection flag.
__STATIC_INLINE void LL_RTC_ClearFlag_TAMPI (BKP_TypeDef *BKPx)
 Clear RTC_TAMP Interruption detection flag.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TAMPE (BKP_TypeDef *BKPx)
 Get RTC_TAMPE Event detection flag.
__STATIC_INLINE void LL_RTC_ClearFlag_TAMPE (BKP_TypeDef *BKPx)
 Clear RTC_TAMPE Even detection flag.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_ALR (RTC_TypeDef *RTCx)
 Get Alarm flag.
__STATIC_INLINE void LL_RTC_ClearFlag_ALR (RTC_TypeDef *RTCx)
 Clear Alarm flag.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_RS (RTC_TypeDef *RTCx)
 Get Registers synchronization flag.
__STATIC_INLINE void LL_RTC_ClearFlag_RS (RTC_TypeDef *RTCx)
 Clear Registers synchronization flag.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_OW (RTC_TypeDef *RTCx)
 Get Registers OverFlow flag.
__STATIC_INLINE void LL_RTC_ClearFlag_OW (RTC_TypeDef *RTCx)
 Clear Registers OverFlow flag.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_SEC (RTC_TypeDef *RTCx)
 Get Registers synchronization flag.
__STATIC_INLINE void LL_RTC_ClearFlag_SEC (RTC_TypeDef *RTCx)
 Clear Registers synchronization flag.
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_RTOF (RTC_TypeDef *RTCx)
 Get RTC Operation OFF status flag.
__STATIC_INLINE void LL_RTC_EnableIT_ALR (RTC_TypeDef *RTCx)
 Enable Alarm interrupt.
__STATIC_INLINE void LL_RTC_DisableIT_ALR (RTC_TypeDef *RTCx)
 Disable Alarm interrupt.
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_ALR (RTC_TypeDef *RTCx)
 Check if Alarm interrupt is enabled or not.
__STATIC_INLINE void LL_RTC_EnableIT_SEC (RTC_TypeDef *RTCx)
 Enable Second Interrupt interrupt.
__STATIC_INLINE void LL_RTC_DisableIT_SEC (RTC_TypeDef *RTCx)
 Disable Second interrupt.
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_SEC (RTC_TypeDef *RTCx)
 Check if Second interrupt is enabled or not.
__STATIC_INLINE void LL_RTC_EnableIT_OW (RTC_TypeDef *RTCx)
 Enable OverFlow interrupt.
__STATIC_INLINE void LL_RTC_DisableIT_OW (RTC_TypeDef *RTCx)
 Disable OverFlow interrupt.
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_OW (RTC_TypeDef *RTCx)
 Check if OverFlow interrupt is enabled or not.
__STATIC_INLINE void LL_RTC_EnableIT_TAMP (BKP_TypeDef *BKPx)
 Enable Tamper interrupt.
__STATIC_INLINE void LL_RTC_DisableIT_TAMP (BKP_TypeDef *BKPx)
 Disable Tamper interrupt.
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_TAMP (BKP_TypeDef *BKPx)
 Check if all the TAMPER interrupts are enabled or not.
ErrorStatus LL_RTC_DeInit (RTC_TypeDef *RTCx)
 De-Initializes the RTC registers to their default reset values.
ErrorStatus LL_RTC_Init (RTC_TypeDef *RTCx, LL_RTC_InitTypeDef *RTC_InitStruct)
 Initializes the RTC registers according to the specified parameters in RTC_InitStruct.
void LL_RTC_StructInit (LL_RTC_InitTypeDef *RTC_InitStruct)
 Set each LL_RTC_InitTypeDef field to default value.
ErrorStatus LL_RTC_TIME_Init (RTC_TypeDef *RTCx, uint32_t RTC_Format, LL_RTC_TimeTypeDef *RTC_TimeStruct)
 Set the RTC current time.
void LL_RTC_TIME_StructInit (LL_RTC_TimeTypeDef *RTC_TimeStruct)
 Set each LL_RTC_TimeTypeDef field to default value (Time = 00h:00min:00sec).
ErrorStatus LL_RTC_ALARM_Init (RTC_TypeDef *RTCx, uint32_t RTC_Format, LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
 Set the RTC Alarm.
void LL_RTC_ALARM_StructInit (LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
 Set each LL_RTC_AlarmTypeDef of ALARM field to default value (Time = 00h:00mn:00sec / Day = 1st day of the month/Mask = all fields are masked).
ErrorStatus LL_RTC_EnterInitMode (RTC_TypeDef *RTCx)
 Enters the RTC Initialization mode.
ErrorStatus LL_RTC_ExitInitMode (RTC_TypeDef *RTCx)
 Exit the RTC Initialization mode.
ErrorStatus LL_RTC_WaitForSynchro (RTC_TypeDef *RTCx)
 Waits until the RTC registers are synchronized with RTC APB clock.
ErrorStatus LL_RTC_TIME_SetCounter (RTC_TypeDef *RTCx, uint32_t TimeCounter)
 Set the Time Counter.
ErrorStatus LL_RTC_ALARM_SetCounter (RTC_TypeDef *RTCx, uint32_t AlarmCounter)
 Set Alarm Counter.

Detailed Description

Header file of RTC LL module.

Author:
MCD Application Team
Attention:

© Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32f1xx_ll_rtc.h.