stm32f4xx_hal_rtc.h File Reference

Header file of RTC HAL module. More...

Go to the source code of this file.

Data Structures
struct	RTC_InitTypeDef
	RTC Configuration Structure definition. More...
struct	RTC_TimeTypeDef
	RTC Time structure definition. More...
struct	RTC_DateTypeDef
	RTC Date structure definition. More...
struct	RTC_AlarmTypeDef
	RTC Alarm structure definition. More...
struct	endif
	ADC handle Structure definition. More...

Typedefs
typedef struct __RTC_HandleTypeDef else typedef struct endif	RTC_HandleTypeDef
	RTC Handle Structure definition.
typedef void(*	pRTC_CallbackTypeDef) (RTC_HandleTypeDef *hrtc)
	HAL RTC Callback pointer definition. More...

Enumerations
enum	HAL_RTCStateTypeDef {   HAL_RTC_STATE_RESET = 0x00U , HAL_RTC_STATE_READY = 0x01U , HAL_RTC_STATE_BUSY = 0x02U , HAL_RTC_STATE_TIMEOUT = 0x03U ,   HAL_RTC_STATE_ERROR = 0x04U }
	HAL State structures definition. More...
enum	HAL_RTC_CallbackIDTypeDef {   HAL_RTC_ALARM_A_EVENT_CB_ID = 0x00U , HAL_RTC_ALARM_B_EVENT_CB_ID = 0x01U , HAL_RTC_TIMESTAMP_EVENT_CB_ID = 0x02U , HAL_RTC_WAKEUPTIMER_EVENT_CB_ID = 0x03U ,   HAL_RTC_TAMPER1_EVENT_CB_ID = 0x04U , HAL_RTC_TAMPER2_EVENT_CB_ID = 0x05U , HAL_RTC_MSPINIT_CB_ID = 0x0EU , HAL_RTC_MSPDEINIT_CB_ID = 0x0FU }
	HAL RTC Callback ID enumeration definition. More...

Functions
HAL_StatusTypeDef	HAL_RTC_Init (RTC_HandleTypeDef *hrtc)
	Initializes the RTC peripheral. More...
HAL_StatusTypeDef	HAL_RTC_DeInit (RTC_HandleTypeDef *hrtc)
	DeInitializes the RTC peripheral. More...
void	HAL_RTC_MspInit (RTC_HandleTypeDef *hrtc)
	Initializes the RTC MSP. More...
void	HAL_RTC_MspDeInit (RTC_HandleTypeDef *hrtc)
	DeInitializes the RTC MSP. More...
HAL_StatusTypeDef	HAL_RTC_RegisterCallback (RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback)
	Registers a User RTC Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_RTC_UnRegisterCallback (RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID)
	Unregisters an RTC Callback RTC callback is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_RTC_SetTime (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
	Sets RTC current time. More...
HAL_StatusTypeDef	HAL_RTC_GetTime (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
	Gets RTC current time. More...
HAL_StatusTypeDef	HAL_RTC_SetDate (RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
	Sets RTC current date. More...
HAL_StatusTypeDef	HAL_RTC_GetDate (RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
	Gets RTC current date. More...
HAL_StatusTypeDef	HAL_RTC_SetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	Sets the specified RTC Alarm. More...
HAL_StatusTypeDef	HAL_RTC_SetAlarm_IT (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	Sets the specified RTC Alarm with Interrupt. More...
HAL_StatusTypeDef	HAL_RTC_DeactivateAlarm (RTC_HandleTypeDef *hrtc, uint32_t Alarm)
	Deactivates the specified RTC Alarm. More...
HAL_StatusTypeDef	HAL_RTC_GetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format)
	Gets the RTC Alarm value and masks. More...
void	HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef *hrtc)
	Handles Alarm interrupt request. More...
HAL_StatusTypeDef	HAL_RTC_PollForAlarmAEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	Handles Alarm A Polling request. More...
void	HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *hrtc)
	Alarm A callback. More...
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. More...
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. More...
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. More...
void	HAL_RTC_DST_SetStoreOperation (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, sets the store operation bit. More...
void	HAL_RTC_DST_ClearStoreOperation (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, clears the store operation bit. More...
uint32_t	HAL_RTC_DST_ReadStoreOperation (RTC_HandleTypeDef *hrtc)
	Daylight Saving Time, reads the store operation bit. More...
HAL_RTCStateTypeDef	HAL_RTC_GetState (RTC_HandleTypeDef *hrtc)
	Returns the RTC state. More...
HAL_StatusTypeDef	RTC_EnterInitMode (RTC_HandleTypeDef *hrtc)
	Enters the RTC Initialization mode. More...
HAL_StatusTypeDef	RTC_ExitInitMode (RTC_HandleTypeDef *hrtc)
	Exits the RTC Initialization mode. More...
uint8_t	RTC_ByteToBcd2 (uint8_t number)
	Converts a 2-digit number from decimal to BCD format. More...
uint8_t	RTC_Bcd2ToByte (uint8_t number)
	Converts a 2-digit number from BCD to decimal format. More...

Detailed Description

Header file of RTC HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_rtc.h.