Extended Features Functions; Detailed Description Of Functions - ST STM32F2 User Manual

UM1940
Configure the Calibration Pinout (RTC_CALIB).
Deactivate the Calibration Pinout (RTC_CALIB).
Enable the RTC reference clock detection.
Disable the RTC reference clock detection.
This section contains the following APIs:
HAL_RTCEx_BKUPWrite()
HAL_RTCEx_BKUPRead()
HAL_RTCEx_SetCoarseCalib()
HAL_RTCEx_DeactivateCoarseCalib()
HAL_RTCEx_SetCalibrationOutPut()
HAL_RTCEx_DeactivateCalibrationOutPut()
HAL_RTCEx_SetRefClock()
HAL_RTCEx_DeactivateRefClock()
40.2.5

Extended features functions

This section provides functions allowing to:
RTC Alarm B callback
RTC Poll for Alarm B request
This section contains the following APIs:
HAL_RTCEx_AlarmBEventCallback()
HAL_RTCEx_PollForAlarmBEvent()
40.2.6

Detailed description of functions

HAL_RTCEx_SetTimeStamp
Function name
Function description
Parameters
Return values
Notes
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp
(RTC_HandleTypeDef * hrtc, uint32_t TimeStampEdge,
uint32_t RTC_TimeStampPin)
Sets TimeStamp.
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
TimeStampEdge: Specifies the pin edge on which the
TimeStamp is activated. This parameter can be one of the
following values:
RTC_TIMESTAMPEDGE_RISING: the Time stamp
event occurs on the rising edge of the related pin.
RTC_TIMESTAMPEDGE_FALLING: the Time stamp
event occurs on the falling edge of the related pin.
RTC_TimeStampPin: specifies the RTC TimeStamp Pin.
This parameter can be one of the following values:
RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as
RTC TimeStamp Pin.
RTC_TIMESTAMPPIN_POS1: PI8 is selected as RTC
TimeStamp Pin.
HAL: status
This API must be called before enabling the TimeStamp
feature.
DocID028236 Rev 2
HAL RTC Extension Driver
487/1371