STM32F10x Standard Peripherals Library  3.5.0
RTC_Exported_Functions

Functions

void RTC_ITConfig (uint16_t RTC_IT, FunctionalState NewState)
 Enables or disables the specified RTC interrupts.
void RTC_EnterConfigMode (void)
 Enters the RTC configuration mode.
void RTC_ExitConfigMode (void)
 Exits from the RTC configuration mode.
uint32_t RTC_GetCounter (void)
 Gets the RTC counter value.
void RTC_SetCounter (uint32_t CounterValue)
 Sets the RTC counter value.
void RTC_SetPrescaler (uint32_t PrescalerValue)
 Sets the RTC prescaler value.
void RTC_SetAlarm (uint32_t AlarmValue)
 Sets the RTC alarm value.
uint32_t RTC_GetDivider (void)
 Gets the RTC divider value.
void RTC_WaitForLastTask (void)
 Waits until last write operation on RTC registers has finished.
void RTC_WaitForSynchro (void)
 Waits until the RTC registers (RTC_CNT, RTC_ALR and RTC_PRL) are synchronized with RTC APB clock.
FlagStatus RTC_GetFlagStatus (uint16_t RTC_FLAG)
 Checks whether the specified RTC flag is set or not.
void RTC_ClearFlag (uint16_t RTC_FLAG)
 Clears the RTC's pending flags.
ITStatus RTC_GetITStatus (uint16_t RTC_IT)
 Checks whether the specified RTC interrupt has occurred or not.
void RTC_ClearITPendingBit (uint16_t RTC_IT)
 Clears the RTC's interrupt pending bits.

Function Documentation

void RTC_ClearFlag ( uint16_t  RTC_FLAG)

Clears the RTC's pending flags.

Parameters:
RTC_FLAG,:specifies the flag to clear. This parameter can be any combination of the following values:
  • RTC_FLAG_RSF: Registers Synchronized flag. This flag is cleared only after an APB reset or an APB Clock stop.
  • RTC_FLAG_OW: Overflow flag
  • RTC_FLAG_ALR: Alarm flag
  • RTC_FLAG_SEC: Second flag
Return values:
None

Definition at line 273 of file stm32f10x_rtc.c.

void RTC_ClearITPendingBit ( uint16_t  RTC_IT)

Clears the RTC's interrupt pending bits.

Parameters:
RTC_IT,:specifies the interrupt pending bit to clear. This parameter can be any combination of the following values:
  • RTC_IT_OW: Overflow interrupt
  • RTC_IT_ALR: Alarm interrupt
  • RTC_IT_SEC: Second interrupt
Return values:
None

Definition at line 318 of file stm32f10x_rtc.c.

void RTC_EnterConfigMode ( void  )

Enters the RTC configuration mode.

Parameters:
None
Return values:
None

Definition at line 111 of file stm32f10x_rtc.c.

void RTC_ExitConfigMode ( void  )

Exits from the RTC configuration mode.

Parameters:
None
Return values:
None

Definition at line 122 of file stm32f10x_rtc.c.

uint32_t RTC_GetCounter ( void  )

Gets the RTC counter value.

Parameters:
None
Return values:
RTCcounter value.

Definition at line 133 of file stm32f10x_rtc.c.

uint32_t RTC_GetDivider ( void  )

Gets the RTC divider value.

Parameters:
None
Return values:
RTCDivider value.

Definition at line 193 of file stm32f10x_rtc.c.

FlagStatus RTC_GetFlagStatus ( uint16_t  RTC_FLAG)

Checks whether the specified RTC flag is set or not.

Parameters:
RTC_FLAG,:specifies the flag to check. This parameter can be one the following values:
  • RTC_FLAG_RTOFF: RTC Operation OFF flag
  • RTC_FLAG_RSF: Registers Synchronized flag
  • RTC_FLAG_OW: Overflow flag
  • RTC_FLAG_ALR: Alarm flag
  • RTC_FLAG_SEC: Second flag
Return values:
Thenew state of RTC_FLAG (SET or RESET).

Definition at line 244 of file stm32f10x_rtc.c.

ITStatus RTC_GetITStatus ( uint16_t  RTC_IT)

Checks whether the specified RTC interrupt has occurred or not.

Parameters:
RTC_IT,:specifies the RTC interrupts sources to check. This parameter can be one of the following values:
  • RTC_IT_OW: Overflow interrupt
  • RTC_IT_ALR: Alarm interrupt
  • RTC_IT_SEC: Second interrupt
Return values:
Thenew state of the RTC_IT (SET or RESET).

Definition at line 291 of file stm32f10x_rtc.c.

void RTC_ITConfig ( uint16_t  RTC_IT,
FunctionalState  NewState 
)

Enables or disables the specified RTC interrupts.

Parameters:
RTC_IT,:specifies the RTC interrupts sources to be enabled or disabled. This parameter can be any combination of the following values:
  • RTC_IT_OW: Overflow interrupt
  • RTC_IT_ALR: Alarm interrupt
  • RTC_IT_SEC: Second interrupt
NewState,:new state of the specified RTC interrupts. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 90 of file stm32f10x_rtc.c.

void RTC_SetAlarm ( uint32_t  AlarmValue)

Sets the RTC alarm value.

Parameters:
AlarmValue,:RTC alarm new value.
Return values:
None

Definition at line 178 of file stm32f10x_rtc.c.

void RTC_SetCounter ( uint32_t  CounterValue)

Sets the RTC counter value.

Parameters:
CounterValue,:RTC counter new value.
Return values:
None

Definition at line 145 of file stm32f10x_rtc.c.

void RTC_SetPrescaler ( uint32_t  PrescalerValue)

Sets the RTC prescaler value.

Parameters:
PrescalerValue,:RTC prescaler new value.
Return values:
None

Definition at line 160 of file stm32f10x_rtc.c.

void RTC_WaitForLastTask ( void  )

Waits until last write operation on RTC registers has finished.

Note:
This function must be called before any write to RTC registers.
Parameters:
None
Return values:
None

Definition at line 207 of file stm32f10x_rtc.c.

void RTC_WaitForSynchro ( void  )

Waits until the RTC registers (RTC_CNT, RTC_ALR and RTC_PRL) are synchronized with RTC APB clock.

Note:
This function must be called before any read operation after an APB reset or an APB clock stop.
Parameters:
None
Return values:
None

Definition at line 223 of file stm32f10x_rtc.c.