Peripheral Control Functions; Peripheral State Functions; Detailed Description Of Functions - ST STM32F2 User Manual

HAL RTC Generic Driver
39.2.9

Peripheral Control functions

This subsection provides functions allowing to
Wait for RTC Time and Date Synchronization
This section contains the following APIs:
HAL_RTC_WaitForSynchro()
39.2.10

Peripheral State functions

This subsection provides functions allowing to
Get RTC state
This section contains the following APIs:
HAL_RTC_GetState()
39.2.11

Detailed description of functions

HAL_RTC_Init
Function name
Function description
Parameters
Return values
HAL_RTC_DeInit
Function name
Function description
Parameters
Return values
Notes
HAL_RTC_MspInit
Function name
Function description
Parameters
Return values
HAL_RTC_MspDeInit
Function name
470/1371
HAL_StatusTypeDef HAL_RTC_Init (RTC_HandleTypeDef *
hrtc)
Initializes the RTC peripheral.
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
HAL: status
HAL_StatusTypeDef HAL_RTC_DeInit (RTC_HandleTypeDef *
hrtc)
DeInitializes the RTC peripheral.
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
HAL: status
This function doesn't reset the RTC Backup Data registers.
void HAL_RTC_MspInit (RTC_HandleTypeDef * hrtc)
Initializes the RTC MSP.
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
None:
void HAL_RTC_MspDeInit (RTC_HandleTypeDef * hrtc)
DocID028236 Rev 2
UM1940