summaryrefslogtreecommitdiffstats
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h
index 92bdf67fba..df6a7be5df 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h
@@ -40,6 +40,7 @@
/* Exported types ------------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_Types SPDIFRX Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -205,9 +206,11 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
/* Exported constants --------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_Constants SPDIFRX Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup SPDIFRX_ErrorCode SPDIFRX Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_SPDIFRX_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -224,6 +227,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Input_Selection SPDIFRX Input Selection
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_INPUT_IN0 ((uint32_t)0x00000000U)
@@ -235,6 +239,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Max_Retries SPDIFRX Maximum Retries
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_MAXRETRIES_NONE ((uint32_t)0x00000000U)
@@ -246,6 +251,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Wait_For_Activity SPDIFRX Wait For Activity
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_WAITFORACTIVITY_OFF ((uint32_t)0x00000000U)
@@ -255,6 +261,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_PT_Mask SPDIFRX Preamble Type Mask
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_PREAMBLETYPEMASK_OFF ((uint32_t)0x00000000U)
@@ -264,6 +271,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_ChannelStatus_Mask SPDIFRX Channel Status Mask
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_CHANNELSTATUS_OFF ((uint32_t)0x00000000U) /* The channel status and user bits are copied into the SPDIF_DR */
@@ -273,6 +281,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_V_Mask SPDIFRX Validity Mask
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_VALIDITYMASK_OFF ((uint32_t)0x00000000U)
@@ -282,6 +291,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_PE_Mask SPDIFRX Parity Error Mask
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_PARITYERRORMASK_OFF ((uint32_t)0x00000000U)
@@ -291,6 +301,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Channel_Selection SPDIFRX Channel Selection
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_CHANNEL_A ((uint32_t)0x00000000U)
@@ -300,6 +311,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Data_Format SPDIFRX Data Format
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_DATAFORMAT_LSB ((uint32_t)0x00000000U)
@@ -310,6 +322,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Stereo_Mode SPDIFRX Stereo Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_STEREOMODE_DISABLE ((uint32_t)0x00000000U)
@@ -319,6 +332,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_State SPDIFRX State
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -330,6 +344,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Interrupts_Definition SPDIFRX Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_IT_RXNE ((uint32_t)SPDIFRX_IMR_RXNEIE)
@@ -344,6 +359,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
*/
/** @defgroup SPDIFRX_Flags_Definition SPDIFRX Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SPDIFRX_FLAG_RXNE ((uint32_t)SPDIFRX_SR_RXNE)
@@ -365,6 +381,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!<
/* Exported macros -----------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_macros SPDIFRX Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -537,6 +554,7 @@ uint32_t HAL_SPDIFRX_GetError(SPDIFRX_HandleTypeDef const * const hspdif);
/* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup SPDIFRX_Private_Macros SPDIFRX Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define IS_SPDIFRX_INPUT_SELECT(INPUT) (((INPUT) == SPDIFRX_INPUT_IN1) || \
@@ -581,6 +599,7 @@ uint32_t HAL_SPDIFRX_GetError(SPDIFRX_HandleTypeDef const * const hspdif);
/* Private functions ---------------------------------------------------------*/
/** @defgroup SPDIFRX_Private_Functions SPDIFRX Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/**