diff options
author | Karel Gardas <karel@functional.vision> | 2023-07-21 14:24:09 +0200 |
---|---|---|
committer | Karel Gardas <karel@functional.vision> | 2023-07-31 15:15:10 +0200 |
commit | ba8ac65929f9e82892d44779a3c37d4cfea14ec7 (patch) | |
tree | 0606d24aa7ae7ec806837f2e67c70833ae0c58ee /bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h | |
parent | bsps/stm32h7: workaround compilation issue with libbsd (diff) | |
download | rtems-ba8ac65929f9e82892d44779a3c37d4cfea14ec7.tar.bz2 |
bsp/stm32h7: Add and use BSP Doxygen group
Inspired by:
commit fe58f6ce4bf1ff5e92d64b9fee0cb46b6ac06e64
Author: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Thu Nov 26 08:13:52 2020 +0100
bsp/stm32h7: Add and use BSP Doxygen group
Update #3910.
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h')
-rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h index a21afc09d5..b5dc99a7b1 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/ /** @defgroup DCMI_Exported_Types DCMI Exported Types + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @@ -183,10 +184,12 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer /* Exported constants --------------------------------------------------------*/ /** @defgroup DCMI_Exported_Constants DCMI Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup DCMI_Error_Code DCMI Error Code + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_DCMI_ERROR_NONE (0x00000000U) /*!< No error */ @@ -202,6 +205,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Capture_Mode DCMI Capture Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_MODE_CONTINUOUS (0x00000000U) /*!< The received data are transferred continuously @@ -213,6 +217,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_SYNCHRO_HARDWARE (0x00000000U) /*!< Hardware synchronization data capture (frame/line start/stop) @@ -225,6 +230,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_PCKPOLARITY_FALLING (0x00000000U) /*!< Pixel clock active on Falling edge */ @@ -235,6 +241,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_VSPOLARITY_LOW (0x00000000U) /*!< Vertical synchronization active Low */ @@ -245,6 +252,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_HSPOLARITY_LOW (0x00000000U) /*!< Horizontal synchronization active Low */ @@ -255,6 +263,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_JPEG_DISABLE (0x00000000U) /*!< Mode JPEG Disabled */ @@ -265,6 +274,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Capture_Rate DCMI Capture Rate + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_CR_ALL_FRAME (0x00000000U) /*!< All frames are captured */ @@ -276,6 +286,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_EXTEND_DATA_8B (0x00000000U) /*!< Interface captures 8-bit data on every pixel clock */ @@ -288,6 +299,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_WINDOW_COORDINATE (0x3FFFU) /*!< Window coordinate */ @@ -297,6 +309,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Window_Height DCMI Window Height + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_WINDOW_HEIGHT (0x1FFFU) /*!< Window Height */ @@ -306,6 +319,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_interrupt_sources DCMI interrupt sources + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE) /*!< Capture complete interrupt */ @@ -318,6 +332,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Flags DCMI Flags + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -348,6 +363,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Byte_Select_Mode DCMI Byte Select Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_BSM_ALL (0x00000000U) /*!< Interface captures all received data */ @@ -360,6 +376,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Byte_Select_Start DCMI Byte Select Start + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_OEBS_ODD (0x00000000U) /*!< Interface captures first data from the frame/line start, second one being dropped */ @@ -370,6 +387,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Line_Select_Mode DCMI Line Select Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_LSM_ALL (0x00000000U) /*!< Interface captures all received lines */ @@ -380,6 +398,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */ /** @defgroup DCMI_Line_Select_Start DCMI Line Select Start + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_OELS_ODD (0x00000000U) /*!< Interface captures first line from the frame start, second one being dropped */ @@ -395,6 +414,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer /* Exported macro ------------------------------------------------------------*/ /** @defgroup DCMI_Exported_Macros DCMI Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -582,6 +602,7 @@ uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi); /* Private types -------------------------------------------------------------*/ /* Private defines -----------------------------------------------------------*/ /** @defgroup DCMI_Private_Defines DCMI Private Defines + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @@ -590,6 +611,7 @@ uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi); /* Private variables ---------------------------------------------------------*/ /* Private constants ---------------------------------------------------------*/ /** @defgroup DCMI_Private_Constants DCMI Private Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DCMI_MIS_INDEX ((uint32_t)0x1000) /*!< DCMI MIS register index */ @@ -599,6 +621,7 @@ uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi); */ /* Private macro -------------------------------------------------------------*/ /** @defgroup DCMI_Private_Macros DCMI Private Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \ |