Peripheral Control functions

Peripheral Control functions. More...

Collaboration diagram for Peripheral Control functions:

Functions
HAL_StatusTypeDef	HAL_RTC_WaitForSynchro (RTC_HandleTypeDef *hrtc)
	Waits until the RTC Time and Date registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock.
void	HAL_RTC_DST_Add1Hour (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, adds one hour to the calendar in one single operation without going through the initialization procedure.
void	HAL_RTC_DST_Sub1Hour (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, subtracts one hour from the calendar in one single operation without going through the initialization procedure.
void	HAL_RTC_DST_SetStoreOperation (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, sets the store operation bit.
void	HAL_RTC_DST_ClearStoreOperation (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, clears the store operation bit.
uint32_t	HAL_RTC_DST_ReadStoreOperation (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, reads the store operation bit.

Detailed Description

Peripheral Control functions.

 ===============================================================================
                     ##### Peripheral Control functions #####
 ===============================================================================
    [..]
    This subsection provides functions allowing to
      (+) Wait for RTC Time and Date Synchronization
      (+) Manage RTC Summer or Winter time change

Function Documentation

HAL_RTC_WaitForSynchro()

HAL_StatusTypeDef HAL_RTC_WaitForSynchro

(

RTC_HandleTypeDef *

hrtc

)

#include <stm32f4xx_hal_rtc.h>

Waits until the RTC Time and Date registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock.

Note

The RTC Resynchronization mode is write protected, use the __HAL_RTC_WRITEPROTECTION_DISABLE() before calling this function.

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.

Parameters

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

Return values

HAL

status

Definition at line 1676 of file stm32f4xx_hal_rtc.c.

References HAL_GetTick(), HAL_OK, HAL_TIMEOUT, RTC_HandleTypeDef::Instance, RTC_ISR_RESERVED_MASK, RTC_RSF_MASK, and RTC_TIMEOUT_VALUE.

Referenced by HAL_RTCEx_SetSynchroShift(), and RTC_ExitInitMode().

HAL_RTC_DST_Add1Hour()

void HAL_RTC_DST_Add1Hour

(

RTC_HandleTypeDef *

hrtc

)

#include <stm32f4xx_hal_rtc.h>

Daylight Saving Time, adds one hour to the calendar in one single operation without going through the initialization procedure.

Parameters

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

Return values

None

Definition at line 1705 of file stm32f4xx_hal_rtc.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, and RTC_HandleTypeDef::Instance.

HAL_RTC_DST_Sub1Hour()

void HAL_RTC_DST_Sub1Hour

(

RTC_HandleTypeDef *

hrtc

)

#include <stm32f4xx_hal_rtc.h>

Daylight Saving Time, subtracts one hour from the calendar in one single operation without going through the initialization procedure.

Parameters

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

Return values

None

Definition at line 1719 of file stm32f4xx_hal_rtc.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, and RTC_HandleTypeDef::Instance.

HAL_RTC_DST_SetStoreOperation()

void HAL_RTC_DST_SetStoreOperation

(

RTC_HandleTypeDef *

hrtc

)

#include <stm32f4xx_hal_rtc.h>

Daylight Saving Time, sets the store operation bit.

Note

It can be used by the software in order to memorize the DST status.

Parameters

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

Return values

None

Definition at line 1733 of file stm32f4xx_hal_rtc.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, and RTC_HandleTypeDef::Instance.

HAL_RTC_DST_ClearStoreOperation()

void HAL_RTC_DST_ClearStoreOperation

(

RTC_HandleTypeDef *

hrtc

)

#include <stm32f4xx_hal_rtc.h>

Daylight Saving Time, clears the store operation bit.

Parameters

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

Return values

None

Definition at line 1746 of file stm32f4xx_hal_rtc.c.

References __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, and RTC_HandleTypeDef::Instance.

HAL_RTC_DST_ReadStoreOperation()

uint32_t HAL_RTC_DST_ReadStoreOperation

(

RTC_HandleTypeDef *

hrtc

)

#include <stm32f4xx_hal_rtc.h>

Daylight Saving Time, reads the store operation bit.

Parameters

hrtc	RTC handle

Return values

operation

see RTC_StoreOperation_Definitions

Definition at line 1758 of file stm32f4xx_hal_rtc.c.

References RTC_HandleTypeDef::Instance.