Initialization and de-initialization functions

Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_RTC_Init (RTC_HandleTypeDef *hrtc)
	Initialize the RTC peripheral.
HAL_StatusTypeDef	HAL_RTC_DeInit (RTC_HandleTypeDef *hrtc)
	DeInitialize the RTC peripheral.
HAL_StatusTypeDef	HAL_RTC_RegisterCallback (RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback)
	Register a User RTC Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_RTC_UnRegisterCallback (RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID)
	Unregister an RTC Callback RTC callback is redirected to the weak predefined callback.
__weak void	HAL_RTC_MspInit (RTC_HandleTypeDef *hrtc)
	Initialize the RTC MSP.
__weak void	HAL_RTC_MspDeInit (RTC_HandleTypeDef *hrtc)
	DeInitialize the RTC MSP.

---

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
              ##### Initialization and de-initialization functions #####
 ===============================================================================
   [..] This section provides functions allowing to initialize and configure the
         RTC Prescaler (Synchronous and Asynchronous), RTC Hour format, disable
         RTC registers Write protection, enter and exit the RTC initialization mode,
         RTC registers synchronization check and reference clock detection enable.
         (#) The RTC Prescaler is programmed to generate the RTC 1Hz time base.
             It is split into 2 programmable prescalers to minimize power consumption.
             (++) A 7-bit asynchronous prescaler and a 15-bit synchronous prescaler.
             (++) When both prescalers are used, it is recommended to configure the
                 asynchronous prescaler to a high value to minimize power consumption.
         (#) All RTC registers are Write protected. Writing to the RTC registers
             is enabled by writing a key into the Write Protection register, RTC_WPR.
         (#) To configure the RTC Calendar, user application should enter
             initialization mode. In this mode, the calendar counter is stopped
             and its value can be updated. When the initialization sequence is
             complete, the calendar restarts counting after 4 RTCCLK cycles.
         (#) 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.The HAL_RTC_WaitForSynchro() function
             implements the above software sequence (RSF clear and RSF check).

---

Function Documentation

HAL_StatusTypeDef HAL_RTC_DeInit

(

RTC_HandleTypeDef *

hrtc

)

DeInitialize the RTC peripheral.

Note:

This function does not reset the RTC Backup Data registers.

Parameters:

hrtc	RTC handle

Return values:

HAL

status

Definition at line 379 of file stm32l4xx_hal_rtc.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_RTC_MspDeInit(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_RESET, __RTC_HandleTypeDef::Instance, __RTC_HandleTypeDef::MspDeInitCallback, RTC_EnterInitMode(), RTC_ExitInitMode(), and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTC_Init

(

RTC_HandleTypeDef *

hrtc

)

Initialize the RTC peripheral.

Parameters:

hrtc	RTC handle

Return values:

HAL

status

Definition at line 246 of file stm32l4xx_hal_rtc.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, __RTC_HandleTypeDef::AlarmAEventCallback, __RTC_HandleTypeDef::AlarmBEventCallback, assert_param, RTC_InitTypeDef::AsynchPrediv, HAL_RTC_AlarmAEventCallback(), HAL_RTC_MspDeInit(), HAL_RTC_MspInit(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, HAL_RTC_STATE_RESET, HAL_RTCEx_AlarmBEventCallback(), HAL_RTCEx_Tamper1EventCallback(), HAL_RTCEx_Tamper2EventCallback(), HAL_RTCEx_Tamper3EventCallback(), HAL_RTCEx_TimeStampEventCallback(), HAL_RTCEx_WakeUpTimerEventCallback(), RTC_InitTypeDef::HourFormat, __RTC_HandleTypeDef::Init, __RTC_HandleTypeDef::Instance, IS_RTC_ASYNCH_PREDIV, IS_RTC_HOUR_FORMAT, IS_RTC_OUTPUT, IS_RTC_OUTPUT_POL, IS_RTC_OUTPUT_REMAP, IS_RTC_OUTPUT_TYPE, IS_RTC_SYNCH_PREDIV, __RTC_HandleTypeDef::Lock, __RTC_HandleTypeDef::MspDeInitCallback, __RTC_HandleTypeDef::MspInitCallback, RTC_InitTypeDef::OutPut, RTC_InitTypeDef::OutPutPolarity, RTC_InitTypeDef::OutPutRemap, RTC_InitTypeDef::OutPutType, RTC_EnterInitMode(), RTC_ExitInitMode(), __RTC_HandleTypeDef::State, RTC_InitTypeDef::SynchPrediv, __RTC_HandleTypeDef::Tamper1EventCallback, __RTC_HandleTypeDef::Tamper2EventCallback, __RTC_HandleTypeDef::Tamper3EventCallback, __RTC_HandleTypeDef::TimeStampEventCallback, and __RTC_HandleTypeDef::WakeUpTimerEventCallback.

void HAL_RTC_MspDeInit

(

RTC_HandleTypeDef *

hrtc

)

DeInitialize the RTC MSP.

Parameters:

hrtc	RTC handle

Return values:

None

Definition at line 710 of file stm32l4xx_hal_rtc.c.

Referenced by HAL_RTC_DeInit(), HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

void HAL_RTC_MspInit

(

RTC_HandleTypeDef *

hrtc

)

Initialize the RTC MSP.

Parameters:

hrtc	RTC handle

Return values:

None

Definition at line 695 of file stm32l4xx_hal_rtc.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

HAL_StatusTypeDef HAL_RTC_RegisterCallback	(	RTC_HandleTypeDef *	hrtc,
		HAL_RTC_CallbackIDTypeDef	CallbackID,
		pRTC_CallbackTypeDef	pCallback
	)

Register a User RTC Callback To be used instead of the weak predefined callback.

Parameters:

hrtc	RTC handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_RTC_ALARM_A_EVENT_CB_ID Alarm A Event Callback ID HAL_RTC_ALARM_B_EVENT_CB_ID Alarm B Event Callback ID HAL_RTC_TIMESTAMP_EVENT_CB_ID TimeStamp Event Callback ID HAL_RTC_WAKEUPTIMER_EVENT_CB_ID WakeUp Timer Event Callback ID HAL_RTC_TAMPER1_EVENT_CB_ID Tamper 1 Callback ID HAL_RTC_TAMPER2_EVENT_CB_ID Tamper 2 Callback ID HAL_RTC_TAMPER3_EVENT_CB_ID Tamper 3 Callback ID HAL_RTC_MSPINIT_CB_ID Msp Init callback ID HAL_RTC_MSPDEINIT_CB_ID Msp DeInit callback ID
pCallback	pointer to the Callback function

Return values:

HAL

status

Definition at line 478 of file stm32l4xx_hal_rtc.c.

References __RTC_HandleTypeDef::AlarmAEventCallback, __RTC_HandleTypeDef::AlarmBEventCallback, HAL_RTC_ALARM_A_EVENT_CB_ID, HAL_RTC_ALARM_B_EVENT_CB_ID, HAL_RTC_MSPDEINIT_CB_ID, HAL_RTC_MSPINIT_CB_ID, HAL_RTC_STATE_READY, HAL_RTC_STATE_RESET, HAL_RTC_TAMPER1_EVENT_CB_ID, HAL_RTC_TAMPER2_EVENT_CB_ID, HAL_RTC_TAMPER3_EVENT_CB_ID, HAL_RTC_TIMESTAMP_EVENT_CB_ID, HAL_RTC_WAKEUPTIMER_EVENT_CB_ID, __RTC_HandleTypeDef::MspDeInitCallback, __RTC_HandleTypeDef::MspInitCallback, __RTC_HandleTypeDef::State, __RTC_HandleTypeDef::Tamper1EventCallback, __RTC_HandleTypeDef::Tamper2EventCallback, __RTC_HandleTypeDef::Tamper3EventCallback, __RTC_HandleTypeDef::TimeStampEventCallback, and __RTC_HandleTypeDef::WakeUpTimerEventCallback.

HAL_StatusTypeDef HAL_RTC_UnRegisterCallback	(	RTC_HandleTypeDef *	hrtc,
		HAL_RTC_CallbackIDTypeDef	CallbackID
	)

Unregister an RTC Callback RTC callback is redirected to the weak predefined callback.

Parameters:

hrtc

RTC handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_RTC_ALARM_A_EVENT_CB_ID Alarm A Event Callback ID HAL_RTC_ALARM_B_EVENT_CB_ID Alarm B Event Callback ID HAL_RTC_TIMESTAMP_EVENT_CB_ID TimeStamp Event Callback ID #if defined (STM32L4P5xx) || defined (STM32L4Q5xx) HAL_RTC_SSRU_EVENT_CB_ID SSRU Callback ID #endif HAL_RTC_WAKEUPTIMER_EVENT_CB_ID WakeUp Timer Event Callback ID HAL_RTC_TAMPER1_EVENT_CB_ID Tamper 1 Callback ID HAL_RTC_TAMPER2_EVENT_CB_ID Tamper 2 Callback ID HAL_RTC_TAMPER3_EVENT_CB_ID Tamper 3 Callback ID HAL_RTC_MSPINIT_CB_ID Msp Init callback ID HAL_RTC_MSPDEINIT_CB_ID Msp DeInit callback ID

Return values:

HAL

status

Definition at line 596 of file stm32l4xx_hal_rtc.c.

References __RTC_HandleTypeDef::AlarmAEventCallback, __RTC_HandleTypeDef::AlarmBEventCallback, HAL_RTC_ALARM_A_EVENT_CB_ID, HAL_RTC_ALARM_B_EVENT_CB_ID, HAL_RTC_AlarmAEventCallback(), HAL_RTC_MspDeInit(), HAL_RTC_MSPDEINIT_CB_ID, HAL_RTC_MspInit(), HAL_RTC_MSPINIT_CB_ID, HAL_RTC_STATE_READY, HAL_RTC_STATE_RESET, HAL_RTC_TAMPER1_EVENT_CB_ID, HAL_RTC_TAMPER2_EVENT_CB_ID, HAL_RTC_TAMPER3_EVENT_CB_ID, HAL_RTC_TIMESTAMP_EVENT_CB_ID, HAL_RTC_WAKEUPTIMER_EVENT_CB_ID, HAL_RTCEx_AlarmBEventCallback(), HAL_RTCEx_Tamper1EventCallback(), HAL_RTCEx_Tamper2EventCallback(), HAL_RTCEx_Tamper3EventCallback(), HAL_RTCEx_TimeStampEventCallback(), HAL_RTCEx_WakeUpTimerEventCallback(), __RTC_HandleTypeDef::MspDeInitCallback, __RTC_HandleTypeDef::MspInitCallback, __RTC_HandleTypeDef::State, __RTC_HandleTypeDef::Tamper1EventCallback, __RTC_HandleTypeDef::Tamper2EventCallback, __RTC_HandleTypeDef::Tamper3EventCallback, __RTC_HandleTypeDef::TimeStampEventCallback, and __RTC_HandleTypeDef::WakeUpTimerEventCallback.