Extension Peripheral Control functions. More...

Functions
void	HAL_RTCEx_BKUPWrite (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data)
	Writes a data in a specified RTC Backup data register.
uint32_t	HAL_RTCEx_BKUPRead (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister)
	Reads data from the specified RTC Backup data Register.
HAL_StatusTypeDef	HAL_RTCEx_SetCoarseCalib (RTC_HandleTypeDef *hrtc, uint32_t CalibSign, uint32_t Value)
	Sets the Coarse calibration parameters.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateCoarseCalib (RTC_HandleTypeDef *hrtc)
	Deactivates the Coarse calibration parameters.
HAL_StatusTypeDef	HAL_RTCEx_SetSmoothCalib (RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmouthCalibMinusPulsesValue)
	Sets the Smooth calibration parameters.
HAL_StatusTypeDef	HAL_RTCEx_SetSynchroShift (RTC_HandleTypeDef *hrtc, uint32_t ShiftAdd1S, uint32_t ShiftSubFS)
	Configures the Synchronization Shift Control Settings.
HAL_StatusTypeDef	HAL_RTCEx_SetCalibrationOutPut (RTC_HandleTypeDef *hrtc, uint32_t CalibOutput)
	Configures the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
HAL_StatusTypeDef	HAL_RTCEx_DeactivateCalibrationOutPut (RTC_HandleTypeDef *hrtc)
	Deactivates the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
HAL_StatusTypeDef	HAL_RTCEx_SetRefClock (RTC_HandleTypeDef *hrtc)
	Enables the RTC reference clock detection.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateRefClock (RTC_HandleTypeDef *hrtc)
	Disable the RTC reference clock detection.
HAL_StatusTypeDef	HAL_RTCEx_EnableBypassShadow (RTC_HandleTypeDef *hrtc)
	Enables the Bypass Shadow feature.
HAL_StatusTypeDef	HAL_RTCEx_DisableBypassShadow (RTC_HandleTypeDef *hrtc)
	Disables the Bypass Shadow feature.

Detailed Description

Extension Peripheral Control functions.

 ===============================================================================
              ##### Extension Peripheral Control functions #####
 ===============================================================================  
    [..]
    This subsection provides functions allowing to
      (+) Write a data in a specified RTC Backup data register
      (+) Read a data in a specified RTC Backup data register
      (+) Set the Coarse calibration parameters.
      (+) Deactivate the Coarse calibration parameters
      (+) Set the Smooth calibration parameters.
      (+) Configure the Synchronization Shift Control Settings.
      (+) Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
      (+) Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
      (+) Enable the RTC reference clock detection.
      (+) Disable the RTC reference clock detection.
      (+) Enable the Bypass Shadow feature.
      (+) Disable the Bypass Shadow feature.

Function Documentation

uint32_t HAL_RTCEx_BKUPRead	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	BackupRegister
	)

Reads data from the specified RTC Backup data Register.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
BackupRegister	RTC Backup data Register number. This parameter can be: RTC_BKP_DRx where x can be from 0 to 19 to specify the register.

Return values:

Read value

Definition at line 1146 of file stm32f4xx_hal_rtc_ex.c.

References assert_param, RTC_HandleTypeDef::Instance, and IS_RTC_BKP.

void HAL_RTCEx_BKUPWrite	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	BackupRegister,
		uint32_t	Data
	)

Writes a data in a specified RTC Backup data register.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
BackupRegister	RTC Backup data Register number. This parameter can be: RTC_BKP_DRx where x can be from 0 to 19 to specify the register.
Data	Data to be written in the specified RTC Backup data register.

Return values:

None

Definition at line 1123 of file stm32f4xx_hal_rtc_ex.c.

References assert_param, RTC_HandleTypeDef::Instance, and IS_RTC_BKP.

HAL_StatusTypeDef HAL_RTCEx_DeactivateCalibrationOutPut ( RTC_HandleTypeDef * hrtc )

Deactivates the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 1504 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_CALIBRATION_OUTPUT_DISABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_DeactivateCoarseCalib ( RTC_HandleTypeDef * hrtc )

Deactivates the Coarse calibration parameters.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 1235 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_COARSE_CALIB_DISABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_ERROR, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, RTC_EnterInitMode(), and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_DeactivateRefClock ( RTC_HandleTypeDef * hrtc )

Disable the RTC reference clock detection.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 1584 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_CLOCKREF_DETECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_ERROR, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, RTC_EnterInitMode(), and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_DisableBypassShadow ( RTC_HandleTypeDef * hrtc )

Disables the Bypass Shadow feature.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Note:: When the Bypass Shadow is enabled the calendar value are taken directly from the Calendar counter.

Return values:

HAL status

Definition at line 1669 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_EnableBypassShadow ( RTC_HandleTypeDef * hrtc )

Enables the Bypass Shadow feature.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Note:: When the Bypass Shadow is enabled the calendar value are taken directly from the Calendar counter.

Return values:

HAL status

Definition at line 1636 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	CalibOutput
	)

Configures the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
CalibOutput	Select the Calibration output Selection . This parameter can be one of the following values: RTC_CALIBOUTPUT_512HZ: A signal has a regular waveform at 512Hz. RTC_CALIBOUTPUT_1HZ: A signal has a regular waveform at 1Hz.

Return values:

HAL status

Definition at line 1465 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_CALIBRATION_OUTPUT_ENABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, IS_RTC_CALIB_OUTPUT, and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetCoarseCalib	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	CalibSign,
		uint32_t	Value
	)

Sets the Coarse calibration parameters.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
CalibSign	Specifies the sign of the coarse calibration value. This parameter can be one of the following values : RTC_CALIBSIGN_POSITIVE: The value sign is positive RTC_CALIBSIGN_NEGATIVE: The value sign is negative
Value	value of coarse calibration expressed in ppm (coded on 5 bits).

Note:: This Calibration value should be between 0 and 63 when using negative sign with a 2-ppm step.; This Calibration value should be between 0 and 126 when using positive sign with a 4-ppm step.

Return values:

HAL status

Definition at line 1177 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_COARSE_CALIB_ENABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_ERROR, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, IS_RTC_CALIB_SIGN, IS_RTC_CALIB_VALUE, RTC_EnterInitMode(), and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetRefClock ( RTC_HandleTypeDef * hrtc )

Enables the RTC reference clock detection.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 1534 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_CLOCKREF_DETECTION_ENABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_ERROR, HAL_RTC_STATE_READY, RTC_HandleTypeDef::Instance, RTC_EnterInitMode(), and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	SmoothCalibPeriod,
		uint32_t	SmoothCalibPlusPulses,
		uint32_t	SmouthCalibMinusPulsesValue
	)

Sets the Smooth calibration parameters.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
SmoothCalibPeriod	Select the Smooth Calibration Period. This parameter can be can be one of the following values : RTC_SMOOTHCALIB_PERIOD_32SEC: The smooth calibration period is 32s. RTC_SMOOTHCALIB_PERIOD_16SEC: The smooth calibration period is 16s. RTC_SMOOTHCALIB_PERIOD_8SEC: The smooth calibration period is 8s.
SmoothCalibPlusPulses	Select to Set or reset the CALP bit. This parameter can be one of the following values: RTC_SMOOTHCALIB_PLUSPULSES_SET: Add one RTCCLK pulse every 2*11 pulses. RTC_SMOOTHCALIB_PLUSPULSES_RESET: No RTCCLK pulses are added.
SmouthCalibMinusPulsesValue	Select the value of CALM[80] bits. This parameter can be one any value from 0 to 0x000001FF.

Note:: To deactivate the smooth calibration, the field SmoothCalibPlusPulses must be equal to SMOOTHCALIB_PLUSPULSES_RESET and the field SmouthCalibMinusPulsesValue must be equal to 0.

Return values:

HAL status

Definition at line 1300 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_GetTick(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_HandleTypeDef::Instance, IS_RTC_SMOOTH_CALIB_MINUS, IS_RTC_SMOOTH_CALIB_PERIOD, IS_RTC_SMOOTH_CALIB_PLUS, RTC_TIMEOUT_VALUE, and RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetSynchroShift	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	ShiftAdd1S,
		uint32_t	ShiftSubFS
	)

Configures the Synchronization Shift Control Settings.

Note:: When REFCKON is set, firmware must not write to Shift control register.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
ShiftAdd1S	Select to add or not 1 second to the time calendar. This parameter can be one of the following values : RTC_SHIFTADD1S_SET: Add one second to the clock calendar. RTC_SHIFTADD1S_RESET: No effect.
ShiftSubFS	Select the number of Second Fractions to substitute. This parameter can be one any value from 0 to 0x7FFF.

Return values:

HAL status

Definition at line 1370 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_GetTick(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_ERROR, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, HAL_RTC_WaitForSynchro(), RTC_HandleTypeDef::Instance, IS_RTC_SHIFT_ADD1S, IS_RTC_SHIFT_SUBFS, RTC_TIMEOUT_VALUE, and RTC_HandleTypeDef::State.

Functions

Detailed Description

Function Documentation