summaryrefslogtreecommitdiffstats
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h
index ed7fe5e8d6..681f17b9f2 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h
@@ -34,6 +34,7 @@ extern "C" {
#if defined (RNG)
/** @defgroup RNG RNG
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief RNG HAL module driver
* @{
*/
@@ -41,10 +42,12 @@ extern "C" {
/* Exported types ------------------------------------------------------------*/
/** @defgroup RNG_Exported_Types RNG Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup RNG_Exported_Types_Group1 RNG Init Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef struct
@@ -57,6 +60,7 @@ typedef struct
*/
/** @defgroup RNG_Exported_Types_Group2 RNG State Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef enum
@@ -74,6 +78,7 @@ typedef enum
*/
/** @defgroup RNG_Exported_Types_Group3 RNG Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if (USE_HAL_RNG_REGISTER_CALLBACKS == 1)
@@ -135,10 +140,12 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t
/* Exported constants --------------------------------------------------------*/
/** @defgroup RNG_Exported_Constants RNG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup RNG_Exported_Constants_Group1 RNG Interrupt definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RNG_IT_DRDY RNG_SR_DRDY /*!< Data Ready interrupt */
@@ -149,6 +156,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t
*/
/** @defgroup RNG_Exported_Constants_Group2 RNG Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RNG_FLAG_DRDY RNG_SR_DRDY /*!< Data ready */
@@ -159,6 +167,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t
*/
/** @defgroup RNG_Exported_Constants_Group3 RNG Clock Error Detection
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RNG_CED_ENABLE 0x00000000U /*!< Clock error detection Enabled */
@@ -168,6 +177,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t
*/
/** @defgroup RNG_Error_Definition RNG Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_RNG_ERROR_NONE 0x00000000U /*!< No error */
@@ -188,6 +198,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t
/* Exported macros -----------------------------------------------------------*/
/** @defgroup RNG_Exported_Macros RNG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -289,10 +300,12 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t
#endif /* RNG_CR_CONDRST */
/* Exported functions --------------------------------------------------------*/
/** @defgroup RNG_Exported_Functions RNG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup RNG_Exported_Functions_Group1 Initialization and configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_RNG_Init(RNG_HandleTypeDef *hrng);
@@ -315,6 +328,7 @@ HAL_StatusTypeDef HAL_RNG_UnRegisterReadyDataCallback(RNG_HandleTypeDef *hrng);
*/
/** @defgroup RNG_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber(RNG_HandleTypeDef *hrng, uint32_t *random32bit);
@@ -330,6 +344,7 @@ void HAL_RNG_ReadyDataCallback(RNG_HandleTypeDef *hrng, uint32_t random32bit);
*/
/** @defgroup RNG_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_RNG_StateTypeDef HAL_RNG_GetState(RNG_HandleTypeDef *hrng);
@@ -344,6 +359,7 @@ uint32_t HAL_RNG_GetError(RNG_HandleTypeDef *hrng);
/* Private macros ------------------------------------------------------------*/
/** @defgroup RNG_Private_Macros RNG Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define IS_RNG_IT(IT) (((IT) == RNG_IT_CEI) || \
@@ -367,6 +383,7 @@ uint32_t HAL_RNG_GetError(RNG_HandleTypeDef *hrng);
#if defined(RNG_CR_CONDRST)
/* Private functions ---------------------------------------------------------*/
/** @defgroup RNG_Private_Functions RNG Private functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef RNG_RecoverSeedError(RNG_HandleTypeDef *hrng);