RTCEx Calibration

Collaboration diagram for RTCEx Calibration:

Macros
#define	__HAL_RTC_COARSE_CALIB_ENABLE(__HANDLE__)
	Enable the Coarse calibration process.
#define	__HAL_RTC_COARSE_CALIB_DISABLE(__HANDLE__)
	Disable the Coarse calibration process.
#define	__HAL_RTC_CALIBRATION_OUTPUT_ENABLE(__HANDLE__)
	Enable the RTC calibration output.
#define	__HAL_RTC_CALIBRATION_OUTPUT_DISABLE(__HANDLE__)
	Disable the calibration output.
#define	__HAL_RTC_CLOCKREF_DETECTION_ENABLE(__HANDLE__)
	Enable the clock reference detection.
#define	__HAL_RTC_CLOCKREF_DETECTION_DISABLE(__HANDLE__)
	Disable the clock reference detection.
#define	__HAL_RTC_SHIFT_GET_FLAG(__HANDLE__, __FLAG__)
	Get the selected RTC shift operation's flag status.

Detailed Description

Macro Definition Documentation

__HAL_RTC_COARSE_CALIB_ENABLE

#define __HAL_RTC_COARSE_CALIB_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR |= (RTC_CR_DCE))

Enable the Coarse calibration process.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 779 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetCoarseCalib().

__HAL_RTC_COARSE_CALIB_DISABLE

#define __HAL_RTC_COARSE_CALIB_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR &= ~(RTC_CR_DCE))

Disable the Coarse calibration process.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 786 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_DeactivateCoarseCalib().

__HAL_RTC_CALIBRATION_OUTPUT_ENABLE

#define __HAL_RTC_CALIBRATION_OUTPUT_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR |= (RTC_CR_COE))

Enable the RTC calibration output.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 793 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetCalibrationOutPut().

__HAL_RTC_CALIBRATION_OUTPUT_DISABLE

#define __HAL_RTC_CALIBRATION_OUTPUT_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR &= ~(RTC_CR_COE))

Disable the calibration output.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 800 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_DeactivateCalibrationOutPut().

__HAL_RTC_CLOCKREF_DETECTION_ENABLE

#define __HAL_RTC_CLOCKREF_DETECTION_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR |= (RTC_CR_REFCKON))

Enable the clock reference detection.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 807 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetRefClock().

__HAL_RTC_CLOCKREF_DETECTION_DISABLE

#define __HAL_RTC_CLOCKREF_DETECTION_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR &= ~(RTC_CR_REFCKON))

Disable the clock reference detection.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 814 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_DeactivateRefClock().

__HAL_RTC_SHIFT_GET_FLAG

#define __HAL_RTC_SHIFT_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

(((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U)? 1U : 0U)

Get the selected RTC shift operation's flag status.

Parameters

__HANDLE__	specifies the RTC handle.
__FLAG__	specifies the RTC shift operation Flag is pending or not. This parameter can be: RTC_FLAG_SHPF: Shift pending flag

Return values

None

Definition at line 824 of file stm32f4xx_hal_rtc_ex.h.