Functions
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_DATE_Init (RTC_TypeDef RTCx, uint32_t RTC_Format, LL_RTC_DateTypeDef RTC_DateStruct)
	Set the RTC current date.
void	LL_RTC_DATE_StructInit (LL_RTC_DateTypeDef *RTC_DateStruct)
	Set each LL_RTC_DateTypeDef field to default value (date = Monday, January 01 xx00)
ErrorStatus	LL_RTC_ALMA_Init (RTC_TypeDef RTCx, uint32_t RTC_Format, LL_RTC_AlarmTypeDef RTC_AlarmStruct)
	Set the RTC Alarm A.
ErrorStatus	LL_RTC_ALMB_Init (RTC_TypeDef RTCx, uint32_t RTC_Format, LL_RTC_AlarmTypeDef RTC_AlarmStruct)
	Set the RTC Alarm B.
void	LL_RTC_ALMA_StructInit (LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
	Set each LL_RTC_AlarmTypeDef of ALARMA field to default value (Time = 00h:00mn:00sec / Day = 1st day of the month/Mask = all fields are masked).
void	LL_RTC_ALMB_StructInit (LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
	Set each LL_RTC_AlarmTypeDef of ALARMA 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 Time and Day registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock.

Function Documentation

ErrorStatus LL_RTC_ALMA_Init	(	RTC_TypeDef *	RTCx,
		uint32_t	RTC_Format,
		LL_RTC_AlarmTypeDef *	RTC_AlarmStruct
	)

Set the RTC Alarm A.

Note:: The Alarm register can only be written when the corresponding Alarm is disabled (Use LL_RTC_ALMA_Disable function).

Parameters:

RTCx	RTC Instance
RTC_Format	This parameter can be one of the following values: LL_RTC_FORMAT_BIN LL_RTC_FORMAT_BCD
RTC_AlarmStruct	pointer to a LL_RTC_AlarmTypeDef structure that contains the alarm configuration parameters.

Return values:

An	ErrorStatus enumeration value: SUCCESS: ALARMA registers are configured ERROR: ALARMA registers are not configured

Definition at line 478 of file stm32f4xx_ll_rtc.c.

References __LL_RTC_CONVERT_BCD2BIN, __LL_RTC_CONVERT_BIN2BCD, LL_RTC_AlarmTypeDef::AlarmDateWeekDay, LL_RTC_AlarmTypeDef::AlarmDateWeekDaySel, LL_RTC_AlarmTypeDef::AlarmMask, LL_RTC_AlarmTypeDef::AlarmTime, assert_param, LL_RTC_TimeTypeDef::Hours, IS_LL_RTC_ALMA_DATE_WEEKDAY_SEL, IS_LL_RTC_ALMA_MASK, IS_LL_RTC_DAY, IS_LL_RTC_FORMAT, IS_LL_RTC_HOUR12, IS_LL_RTC_HOUR24, IS_LL_RTC_MINUTES, IS_LL_RTC_SECONDS, IS_LL_RTC_TIME_FORMAT, IS_LL_RTC_WEEKDAY, LL_RTC_ALMA_ConfigTime(), LL_RTC_ALMA_DATEWEEKDAYSEL_DATE, LL_RTC_ALMA_DisableWeekday(), LL_RTC_ALMA_EnableWeekday(), LL_RTC_ALMA_SetDay(), LL_RTC_ALMA_SetMask(), LL_RTC_ALMA_SetWeekDay(), LL_RTC_DisableWriteProtection(), LL_RTC_EnableWriteProtection(), LL_RTC_FORMAT_BIN, LL_RTC_GetHourFormat(), LL_RTC_HOURFORMAT_24HOUR, LL_RTC_TimeTypeDef::Minutes, LL_RTC_TimeTypeDef::Seconds, and LL_RTC_TimeTypeDef::TimeFormat.

void LL_RTC_ALMA_StructInit ( LL_RTC_AlarmTypeDef * RTC_AlarmStruct )

Set each LL_RTC_AlarmTypeDef of ALARMA field to default value (Time = 00h:00mn:00sec / Day = 1st day of the month/Mask = all fields are masked).

Parameters:

RTC_AlarmStruct pointer to a LL_RTC_AlarmTypeDef structure which will be initialized.

Return values:

None

Definition at line 706 of file stm32f4xx_ll_rtc.c.

References LL_RTC_AlarmTypeDef::AlarmDateWeekDay, LL_RTC_AlarmTypeDef::AlarmDateWeekDaySel, LL_RTC_AlarmTypeDef::AlarmMask, LL_RTC_AlarmTypeDef::AlarmTime, LL_RTC_TimeTypeDef::Hours, LL_RTC_ALMA_DATEWEEKDAYSEL_DATE, LL_RTC_ALMA_MASK_NONE, LL_RTC_ALMA_TIME_FORMAT_AM, LL_RTC_TimeTypeDef::Minutes, LL_RTC_TimeTypeDef::Seconds, and LL_RTC_TimeTypeDef::TimeFormat.

ErrorStatus LL_RTC_ALMB_Init	(	RTC_TypeDef *	RTCx,
		uint32_t	RTC_Format,
		LL_RTC_AlarmTypeDef *	RTC_AlarmStruct
	)

Set the RTC Alarm B.

Note:: The Alarm register can only be written when the corresponding Alarm is disabled (LL_RTC_ALMB_Disable function).

Parameters:

RTCx	RTC Instance
RTC_Format	This parameter can be one of the following values: LL_RTC_FORMAT_BIN LL_RTC_FORMAT_BCD
RTC_AlarmStruct	pointer to a LL_RTC_AlarmTypeDef structure that contains the alarm configuration parameters.

Return values:

An	ErrorStatus enumeration value: SUCCESS: ALARMB registers are configured ERROR: ALARMB registers are not configured

Definition at line 596 of file stm32f4xx_ll_rtc.c.

References __LL_RTC_CONVERT_BCD2BIN, __LL_RTC_CONVERT_BIN2BCD, LL_RTC_AlarmTypeDef::AlarmDateWeekDay, LL_RTC_AlarmTypeDef::AlarmDateWeekDaySel, LL_RTC_AlarmTypeDef::AlarmMask, LL_RTC_AlarmTypeDef::AlarmTime, assert_param, LL_RTC_TimeTypeDef::Hours, IS_LL_RTC_ALMB_DATE_WEEKDAY_SEL, IS_LL_RTC_ALMB_MASK, IS_LL_RTC_DAY, IS_LL_RTC_FORMAT, IS_LL_RTC_HOUR12, IS_LL_RTC_HOUR24, IS_LL_RTC_MINUTES, IS_LL_RTC_SECONDS, IS_LL_RTC_TIME_FORMAT, IS_LL_RTC_WEEKDAY, LL_RTC_ALMB_ConfigTime(), LL_RTC_ALMB_DATEWEEKDAYSEL_DATE, LL_RTC_ALMB_DisableWeekday(), LL_RTC_ALMB_EnableWeekday(), LL_RTC_ALMB_SetDay(), LL_RTC_ALMB_SetMask(), LL_RTC_ALMB_SetWeekDay(), LL_RTC_DisableWriteProtection(), LL_RTC_EnableWriteProtection(), LL_RTC_FORMAT_BIN, LL_RTC_GetHourFormat(), LL_RTC_HOURFORMAT_24HOUR, LL_RTC_TimeTypeDef::Minutes, LL_RTC_TimeTypeDef::Seconds, and LL_RTC_TimeTypeDef::TimeFormat.

void LL_RTC_ALMB_StructInit ( LL_RTC_AlarmTypeDef * RTC_AlarmStruct )

Set each LL_RTC_AlarmTypeDef of ALARMA field to default value (Time = 00h:00mn:00sec / Day = 1st day of the month/Mask = all fields are masked).

Parameters:

RTC_AlarmStruct pointer to a LL_RTC_AlarmTypeDef structure which will be initialized.

Return values:

None

Definition at line 728 of file stm32f4xx_ll_rtc.c.

References LL_RTC_AlarmTypeDef::AlarmDateWeekDay, LL_RTC_AlarmTypeDef::AlarmDateWeekDaySel, LL_RTC_AlarmTypeDef::AlarmMask, LL_RTC_AlarmTypeDef::AlarmTime, LL_RTC_TimeTypeDef::Hours, LL_RTC_ALMB_DATEWEEKDAYSEL_DATE, LL_RTC_ALMB_MASK_NONE, LL_RTC_ALMB_TIME_FORMAT_AM, LL_RTC_TimeTypeDef::Minutes, LL_RTC_TimeTypeDef::Seconds, and LL_RTC_TimeTypeDef::TimeFormat.

ErrorStatus LL_RTC_DATE_Init	(	RTC_TypeDef *	RTCx,
		uint32_t	RTC_Format,
		LL_RTC_DateTypeDef *	RTC_DateStruct
	)

Set the RTC current date.

Parameters:

RTCx	RTC Instance
RTC_Format	This parameter can be one of the following values: LL_RTC_FORMAT_BIN LL_RTC_FORMAT_BCD
RTC_DateStruct	pointer to a RTC_DateTypeDef structure that contains the date configuration information for the RTC.

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC Day register is configured ERROR: RTC Day register is not configured

Definition at line 388 of file stm32f4xx_ll_rtc.c.

References __LL_RTC_CONVERT_BCD2BIN, __LL_RTC_CONVERT_BIN2BCD, assert_param, LL_RTC_DateTypeDef::Day, IS_LL_RTC_DAY, IS_LL_RTC_FORMAT, IS_LL_RTC_MONTH, IS_LL_RTC_WEEKDAY, IS_LL_RTC_YEAR, LL_RTC_DATE_Config(), LL_RTC_DisableInitMode(), LL_RTC_DisableWriteProtection(), LL_RTC_EnableWriteProtection(), LL_RTC_EnterInitMode(), LL_RTC_FORMAT_BIN, LL_RTC_IsShadowRegBypassEnabled(), LL_RTC_WaitForSynchro(), LL_RTC_DateTypeDef::Month, LL_RTC_DateTypeDef::WeekDay, and LL_RTC_DateTypeDef::Year.

void LL_RTC_DATE_StructInit ( LL_RTC_DateTypeDef * RTC_DateStruct )

Set each LL_RTC_DateTypeDef field to default value (date = Monday, January 01 xx00)

Parameters:

RTC_DateStruct pointer to a LL_RTC_DateTypeDef structure which will be initialized.

Return values:

None

Definition at line 455 of file stm32f4xx_ll_rtc.c.

References LL_RTC_DateTypeDef::Day, LL_RTC_MONTH_JANUARY, LL_RTC_WEEKDAY_MONDAY, LL_RTC_DateTypeDef::Month, LL_RTC_DateTypeDef::WeekDay, and LL_RTC_DateTypeDef::Year.

ErrorStatus LL_RTC_DeInit ( RTC_TypeDef * RTCx )

De-Initializes the RTC registers to their default reset values.

Note:: This function doesn't reset the RTC Clock source and RTC Backup Data registers.

Parameters:

RTCx	RTC Instance

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC registers are de-initialized ERROR: RTC registers are not de-initialized

Definition at line 165 of file stm32f4xx_ll_rtc.c.

References assert_param, LL_RTC_DisableWriteProtection(), LL_RTC_EnableWriteProtection(), LL_RTC_EnterInitMode(), LL_RTC_ReadReg, LL_RTC_WaitForSynchro(), LL_RTC_WriteReg, and RTC_SYNCH_PRESC_DEFAULT.

ErrorStatus LL_RTC_EnterInitMode ( RTC_TypeDef * RTCx )

Enters the RTC Initialization mode.

Note:: The RTC Initialization mode is write protected, use the LL_RTC_DisableWriteProtection before calling this function.

Parameters:

RTCx	RTC Instance

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC is in Init mode ERROR: RTC is not in Init mode

Definition at line 753 of file stm32f4xx_ll_rtc.c.

References assert_param, LL_RTC_EnableInitMode(), LL_RTC_IsActiveFlag_INIT(), LL_SYSTICK_IsActiveCounterFlag(), and RTC_INITMODE_TIMEOUT.

Referenced by LL_RTC_DATE_Init(), LL_RTC_DeInit(), LL_RTC_Init(), and LL_RTC_TIME_Init().

ErrorStatus LL_RTC_ExitInitMode ( RTC_TypeDef * RTCx )

Exit the RTC Initialization mode.

Note:: When the initialization sequence is complete, the calendar restarts counting after 4 RTCCLK cycles.; The RTC Initialization mode is write protected, use the LL_RTC_DisableWriteProtection before calling this function.

Parameters:

RTCx	RTC Instance

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC exited from in Init mode ERROR: Not applicable

Definition at line 797 of file stm32f4xx_ll_rtc.c.

References assert_param, and LL_RTC_DisableInitMode().

ErrorStatus LL_RTC_Init	(	RTC_TypeDef *	RTCx,
		LL_RTC_InitTypeDef *	RTC_InitStruct
	)

Initializes the RTC registers according to the specified parameters in RTC_InitStruct.

Parameters:

RTCx	RTC Instance
RTC_InitStruct	pointer to a LL_RTC_InitTypeDef structure that contains the configuration information for the RTC peripheral.

Note:: The RTC Prescaler register is write protected and can be written in initialization mode only.

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC registers are initialized ERROR: RTC registers are not initialized

Definition at line 226 of file stm32f4xx_ll_rtc.c.

References assert_param, LL_RTC_InitTypeDef::AsynchPrescaler, LL_RTC_InitTypeDef::HourFormat, IS_LL_RTC_ASYNCH_PREDIV, IS_LL_RTC_HOURFORMAT, IS_LL_RTC_SYNCH_PREDIV, LL_RTC_DisableInitMode(), LL_RTC_DisableWriteProtection(), LL_RTC_EnableWriteProtection(), LL_RTC_EnterInitMode(), LL_RTC_SetAsynchPrescaler(), LL_RTC_SetHourFormat(), LL_RTC_SetSynchPrescaler(), and LL_RTC_InitTypeDef::SynchPrescaler.

void LL_RTC_StructInit ( LL_RTC_InitTypeDef * RTC_InitStruct )

Set each LL_RTC_InitTypeDef field to default value.

Parameters:

RTC_InitStruct pointer to a LL_RTC_InitTypeDef structure which will be initialized.

Return values:

None

Definition at line 265 of file stm32f4xx_ll_rtc.c.

References LL_RTC_InitTypeDef::AsynchPrescaler, LL_RTC_InitTypeDef::HourFormat, LL_RTC_HOURFORMAT_24HOUR, RTC_ASYNCH_PRESC_DEFAULT, RTC_SYNCH_PRESC_DEFAULT, and LL_RTC_InitTypeDef::SynchPrescaler.

ErrorStatus LL_RTC_TIME_Init	(	RTC_TypeDef *	RTCx,
		uint32_t	RTC_Format,
		LL_RTC_TimeTypeDef *	RTC_TimeStruct
	)

Set the RTC current time.

Parameters:

RTCx	RTC Instance
RTC_Format	This parameter can be one of the following values: LL_RTC_FORMAT_BIN LL_RTC_FORMAT_BCD
RTC_TimeStruct	pointer to a RTC_TimeTypeDef structure that contains the time configuration information for the RTC.

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC Time register is configured ERROR: RTC Time register is not configured

Definition at line 285 of file stm32f4xx_ll_rtc.c.

References __LL_RTC_CONVERT_BCD2BIN, __LL_RTC_CONVERT_BIN2BCD, assert_param, LL_RTC_TimeTypeDef::Hours, IS_LL_RTC_FORMAT, IS_LL_RTC_HOUR12, IS_LL_RTC_HOUR24, IS_LL_RTC_MINUTES, IS_LL_RTC_SECONDS, IS_LL_RTC_TIME_FORMAT, LL_RTC_DisableInitMode(), LL_RTC_DisableWriteProtection(), LL_RTC_EnableWriteProtection(), LL_RTC_EnterInitMode(), LL_RTC_FORMAT_BIN, LL_RTC_GetHourFormat(), LL_RTC_HOURFORMAT_24HOUR, LL_RTC_IsShadowRegBypassEnabled(), LL_RTC_TIME_Config(), LL_RTC_WaitForSynchro(), LL_RTC_TimeTypeDef::Minutes, LL_RTC_TimeTypeDef::Seconds, and LL_RTC_TimeTypeDef::TimeFormat.

void LL_RTC_TIME_StructInit ( LL_RTC_TimeTypeDef * RTC_TimeStruct )

Set each LL_RTC_TimeTypeDef field to default value (Time = 00h:00min:00sec).

Parameters:

RTC_TimeStruct pointer to a LL_RTC_TimeTypeDef structure which will be initialized.

Return values:

None

Definition at line 367 of file stm32f4xx_ll_rtc.c.

References LL_RTC_TimeTypeDef::Hours, LL_RTC_TIME_FORMAT_AM_OR_24, LL_RTC_TimeTypeDef::Minutes, LL_RTC_TimeTypeDef::Seconds, and LL_RTC_TimeTypeDef::TimeFormat.

ErrorStatus LL_RTC_WaitForSynchro ( RTC_TypeDef * RTCx )

Waits until the RTC Time and Day registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock.

Note:: The RTC Resynchronization mode is write protected, use the LL_RTC_DisableWriteProtection before calling this function.; To read the calendar through the shadow registers after Calendar initialization, calendar update or after wakeup from low power modes the software must first clear the RSF flag. The software must then wait until it is set again before reading the calendar, which means that the calendar registers have been correctly copied into the RTC_TR and RTC_DR shadow registers.

Parameters:

RTCx	RTC Instance

Return values:

An	ErrorStatus enumeration value: SUCCESS: RTC registers are synchronised ERROR: RTC registers are not synchronised

Definition at line 824 of file stm32f4xx_ll_rtc.c.

References assert_param, LL_RTC_ClearFlag_RS(), LL_RTC_IsActiveFlag_RS(), LL_SYSTICK_IsActiveCounterFlag(), and RTC_SYNCHRO_TIMEOUT.

Referenced by LL_RTC_DATE_Init(), LL_RTC_DeInit(), and LL_RTC_TIME_Init().

Functions

Function Documentation