diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h index ad0fa135f4..9ca5dd0c60 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h @@ -32,11 +32,13 @@ extern "C" { */ /** @defgroup RTC RTC + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Exported types ------------------------------------------------------------*/ /** @defgroup RTC_Exported_Types RTC Exported Types + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -257,10 +259,12 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to /* Exported constants --------------------------------------------------------*/ /** @defgroup RTC_Exported_Constants RTC Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup RTC_Hour_Formats_Definitions RTC Hour Formats Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_HOURFORMAT_24 0x00000000u @@ -270,6 +274,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Output_selection_Definitions RTC Output Selection Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_OUTPUT_DISABLE 0x00000000u @@ -284,6 +289,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_OUTPUT_POLARITY_HIGH 0x00000000u @@ -293,6 +299,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #if defined(TAMP) @@ -309,6 +316,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Output_PullUp_ALARM_OUT RTC Output Pull-Up ALARM OUT + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #if defined(TAMP) @@ -320,6 +328,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Output_ALARM_OUT_Remap RTC Output ALARM OUT Remap + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #if defined(TAMP) @@ -334,6 +343,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_HOURFORMAT12_AM ((uint8_t)0x00) @@ -343,6 +353,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_DayLightSaving_Definitions RTC DayLight Saving Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_DAYLIGHTSAVING_SUB1H RTC_CR_SUB1H @@ -353,6 +364,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_StoreOperation_Definitions RTC Store Operation Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_STOREOPERATION_RESET 0x00000000u @@ -362,6 +374,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Input_parameter_format_definitions RTC Input Parameter Format Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_FORMAT_BIN 0x00000000u @@ -371,6 +384,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions (in BCD format) + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_MONTH_JANUARY ((uint8_t)0x01) @@ -391,6 +405,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_WEEKDAY_MONDAY ((uint8_t)0x01) @@ -406,6 +421,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_AlarmDateWeekDay_Definitions RTC Alarm Date WeekDay Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_ALARMDATEWEEKDAYSEL_DATE 0x00000000u @@ -416,6 +432,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_AlarmMask_Definitions RTC Alarm Mask Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_ALARMMASK_NONE 0x00000000u @@ -432,6 +449,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_ALARM_A RTC_CR_ALRAE @@ -441,6 +459,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions RTC Alarm Sub Seconds Masks Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /*!< All Alarm SS fields are masked. There is no comparison on sub seconds for Alarm */ @@ -481,6 +500,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define RTC_IT_TS RTC_CR_TSIE /*!< Enable Timestamp Interrupt */ @@ -492,6 +512,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Flags_Definitions RTC Flags Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #if defined(TAMP) @@ -530,6 +551,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */ /** @defgroup RTC_Clear_Flags_Definitions RTC Clear Flags Definitions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #if defined(TAMP) @@ -551,6 +573,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to /* Exported macros -----------------------------------------------------------*/ /** @defgroup RTC_Exported_Macros RTC Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -908,10 +931,12 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to /* Exported functions --------------------------------------------------------*/ /** @defgroup RTC_Exported_Functions RTC Exported Functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup RTC_Exported_Functions_Group1 Initialization and de-initialization functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Initialization and de-initialization functions ****************************/ @@ -931,6 +956,7 @@ HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_Ca */ /** @defgroup RTC_Exported_Functions_Group2 RTC Time and Date functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* RTC Time and Date functions ************************************************/ @@ -943,6 +969,7 @@ HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDat */ /** @defgroup RTC_Exported_Functions_Group3 RTC Alarm functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* RTC Alarm functions ********************************************************/ @@ -958,6 +985,7 @@ HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t T */ /** @defgroup RTC_Exported_Functions_Group4 Peripheral Control functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Peripheral Control functions ***********************************************/ @@ -967,6 +995,7 @@ HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc); */ /** @defgroup RTC_Exported_Functions_Group5 Peripheral State functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Peripheral State functions *************************************************/ @@ -983,6 +1012,7 @@ HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc); /* Private variables ---------------------------------------------------------*/ /* Private constants ---------------------------------------------------------*/ /** @defgroup RTC_Private_Constants RTC Private Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Masks Definition */ @@ -1014,10 +1044,12 @@ HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc); /* Private macros ------------------------------------------------------------*/ /** @defgroup RTC_Private_Macros RTC Private Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup RTC_IS_RTC_Definitions RTC Private macros to check input parameters + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -1123,6 +1155,7 @@ HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc); /* Private functions -------------------------------------------------------------*/ /** @defgroup RTC_Private_Functions RTC Private Functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc); |