diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h index a9159c55f1..c621f78c30 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h @@ -33,16 +33,19 @@ extern "C" { */
/** @defgroup RTCEx RTCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Types RTCEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTCEx_Tamper_structure_definition RTC Tamper structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -83,6 +86,7 @@ typedef struct #if defined(TAMP_CR1_ITAMP1E)
/** @defgroup RTCEx_Internal_Tamper_structure_definition RTCEx Internal Tamper structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -100,6 +104,7 @@ typedef struct #if defined(TAMP_ATCR1_TAMP1AM)
/** @defgroup RTCEx_Active_Seed_Size Seed size Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_SEED_NB_UINT32 4U
@@ -108,6 +113,7 @@ typedef struct */
/** @defgroup RTCEx_Active_Tampers_Number Active Tampers number Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_TAMP_NB 3u
@@ -116,6 +122,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_structures_definition RTC Active Tamper structures definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -174,6 +181,7 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Constants RTC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -182,6 +190,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Backup_Registers_Number_Definitions RTC Backup Registers Number Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_BKP_NUMBER)
@@ -195,6 +204,7 @@ typedef struct */
/** @defgroup RTCEx_Backup_Registers_Definitions RTC Backup Registers Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_BKP_DR0 0x00u
@@ -238,6 +248,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_TimeStamp_Edges_definitions RTC TimeStamp Edges Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 *
* @{
*/
@@ -248,6 +259,7 @@ typedef struct */
/** @defgroup RTCEx_TimeStamp_Pin_Selection RTC TimeStamp Pin Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_TIMESTAMPPIN_DEFAULT 0x00000000u
@@ -261,6 +273,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Tamper_Pins_Definitions RTC Tamper Pins Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR1_TAMP1E)
@@ -289,6 +302,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Interrupt_Definitions RTC Tamper Interrupts Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_IER_TAMP1IE)
@@ -323,6 +337,7 @@ typedef struct */
/** @defgroup RTCEx_Internal_Tamper_Pins_Definitions RTCEx Internal Tamper Pins Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR1_ITAMP1E)
@@ -355,6 +370,7 @@ typedef struct */
/** @defgroup RTCEx_Internal_Tamper_Interrupt_Definitions RTC Internal Tamper Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_IER_ITAMP1IE)
@@ -383,6 +399,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Trigger_Definitions RTC Tamper Triggers Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_TAMPERTRIGGER_RISINGEDGE 0x01u /*!< Warning : Filter must be RTC_TAMPERFILTER_DISABLE */
@@ -418,6 +435,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_EraseBackUp_Definitions RTC Tamper EraseBackUp Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR2_TAMP1NOERASE)
@@ -457,6 +475,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_MaskFlag_Definitions RTC Tamper Mask Flag Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR2_TAMP1MSK)
@@ -496,6 +515,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Filter_Definitions RTC Tamper Filter Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPFLT)
@@ -527,6 +547,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Sampling_Frequencies_Definitions RTC Tamper Sampling Frequencies Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPFREQ)
@@ -574,6 +595,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Pin_Precharge_Duration_Definitions RTC Tamper Pin Precharge Duration Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPPRCH)
@@ -605,6 +627,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_TimeStampOnTamperDetection_Definitions RTC Tamper TimeStamp On Tamper Detection Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPTS)
@@ -622,6 +645,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Pull_UP_Definitions RTC Tamper Pull Up Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPPUDIS)
@@ -639,6 +663,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_DetectionOutput_Definitions RTC Tamper Detection Ouput Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPOE)
@@ -651,6 +676,7 @@ typedef struct */
/** @defgroup RTC_Tamper_Flags_Definitions RTC Tamper Flags Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_SR_TAMP1F)
@@ -677,6 +703,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Enable RTCEx_ActiveTamper_Enable Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_ENABLE 1u
@@ -686,6 +713,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Interrupt RTCEx_ActiveTamper_Interrupt Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_INTERRUPT_ENABLE 1u
@@ -695,6 +723,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Filter RTCEx_ActiveTamper_Filter Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_FILTER_ENABLE TAMP_ATCR1_FLTEN
@@ -704,6 +733,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Async_prescaler RTC Active_Tamper_Asynchronous_Prescaler clock Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_ASYNCPRES_RTCCLK 0u /*!< RTCCLK */
@@ -719,6 +749,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Sel RTC Active Tamper selection Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_1 0u /*!< Tamper 1 */
@@ -734,6 +765,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Registers_Offset RTC Tamper Registers Offset
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (TAMP_CR1_TAMP1E)
@@ -749,6 +781,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Wakeup_Timer_Definitions RTC Wakeup Timer Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_WAKEUPCLOCK_RTCCLK_DIV16 0x00000000u
@@ -766,6 +799,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Smooth_calib_period_Definitions RTC Smooth Calib Period Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_SMOOTHCALIB_PERIOD_32SEC 0x00000000u /*!< If RTCCLK = 32768 Hz, Smooth calibration
@@ -779,6 +813,7 @@ typedef struct */
/** @defgroup RTCEx_Smooth_calib_Plus_pulses_Definitions RTC Smooth Calib Plus pulses Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_SMOOTHCALIB_PLUSPULSES_SET RTC_CALR_CALP /*!< The number of RTCCLK pulses added
@@ -791,6 +826,7 @@ typedef struct */
/** @defgroup RTCEx_Calib_Output_selection_Definitions RTC Calib Output Selection Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_CALIBOUTPUT_512HZ 0x00000000u
@@ -800,6 +836,7 @@ typedef struct */
/** @defgroup RTCEx_Add_1_Second_Parameter_Definitions RTC Add 1 Second Parameter Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_SHIFTADD1S_RESET 0x00000000u
@@ -815,6 +852,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Macros RTC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1762,6 +1800,7 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Functions RTC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1772,6 +1811,7 @@ typedef struct /* RTC TimeStamp functions ****************************************************/
/** @defgroup RTCEx_Exported_Functions_Group1 Extended RTC TimeStamp functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp(RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin);
@@ -1794,6 +1834,7 @@ HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent(RTC_HandleTypeDef *hrtc, uint3 /* RTC Tamper functions *******************************************************/
/** @defgroup RTCEx_Exported_Functions_Group5 Extended RTC Tamper functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetTamper(RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef *sTamper);
@@ -1847,6 +1888,7 @@ HAL_StatusTypeDef HAL_RTCEx_DeactivateActiveTampers(RTC_HandleTypeDef *hrtc); /* RTC Wake-up functions ******************************************************/
/** @defgroup RTCEx_Exported_Functions_Group2 Extended RTC Wake-up functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer(RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock);
@@ -1867,6 +1909,7 @@ HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent(RTC_HandleTypeDef *hrtc, uin /* Extended RTC Backup registers functions ************************************/
/** @defgroup RTCEx_Exported_Functions_Group6 Extended RTC Backup register functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void HAL_RTCEx_BKUPWrite(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data);
@@ -1882,6 +1925,7 @@ uint32_t HAL_RTCEx_BKUPRead(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister); /* Extended RTC Peripheral Control functions **********************************/
/** @defgroup RTCEx_Exported_Functions_Group3 Extended Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib(RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmoothCalibMinusPulsesValue);
@@ -1903,6 +1947,7 @@ HAL_StatusTypeDef HAL_RTCEx_MonotonicCounterGet(RTC_HandleTypeDef *hrtc, uint32_ /* Extended RTC features functions *******************************************/
/** @defgroup RTCEx_Exported_Functions_Group4 Extended features functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1920,6 +1965,7 @@ HAL_StatusTypeDef HAL_RTCEx_PollForAlarmBEvent(RTC_HandleTypeDef *hrtc, uint32_t /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RTCEx_Private_Constants RTC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT EXTI_IMR1_IM18 /*!< External interrupt line 18 Connected to the RTC Tamper and Time Stamp events */
@@ -1935,10 +1981,12 @@ HAL_StatusTypeDef HAL_RTCEx_PollForAlarmBEvent(RTC_HandleTypeDef *hrtc, uint32_t /* Private macros ------------------------------------------------------------*/
/** @defgroup RTCEx_Private_Macros RTC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTCEx_IS_RTC_Definitions Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
|