diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h index 407bf2ccb3..0ccc899c78 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h @@ -37,6 +37,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/ /** @defgroup I2S_Exported_Types I2S Exported Types + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -178,9 +179,11 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to /* Exported constants --------------------------------------------------------*/ /** @defgroup I2S_Exported_Constants I2S Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup I2S_Error I2S Error + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_I2S_ERROR_NONE (0x00000000UL) /*!< No error */ @@ -200,6 +203,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Mode I2S Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_MODE_SLAVE_TX (0x00000000UL) @@ -213,6 +217,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Standard I2S Standard + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_STANDARD_PHILIPS (0x00000000UL) @@ -225,6 +230,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Data_Format I2S Data Format + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_DATAFORMAT_16B (0x00000000UL) @@ -236,6 +242,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_MCLK_Output I2S MCLK Output + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_MCLKOUTPUT_ENABLE (SPI_I2SCFGR_MCKOE) @@ -245,6 +252,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Audio_Frequency I2S Audio Frequency + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_AUDIOFREQ_192K (192000UL) @@ -262,6 +270,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Clock_Polarity I2S FullDuplex Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_CPOL_LOW (0x00000000UL) @@ -271,6 +280,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_MSB_LSB_Transmission I2S MSB LSB Transmission + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_FIRSTBIT_MSB (0x00000000UL) @@ -280,6 +290,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_WSInversion I2S Word Select Inversion + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_WS_INVERSION_DISABLE (0x00000000UL) @@ -289,6 +300,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Data_24Bit_Alignment Data Padding 24Bit + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_DATA_24BIT_ALIGNMENT_RIGHT (0x00000000UL) @@ -298,6 +310,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Master_Keep_IO_State Keep IO State + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_MASTER_KEEP_IO_STATE_DISABLE (0x00000000U) @@ -307,6 +320,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_IT_RXP SPI_IER_RXPIE @@ -321,6 +335,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */ /** @defgroup I2S_Flags_Definition I2S Flags Definition + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define I2S_FLAG_RXP SPI_SR_RXP /* I2S status flag : Rx-Packet available flag */ @@ -341,6 +356,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to /* Exported macros -----------------------------------------------------------*/ /** @defgroup I2S_Exported_macros I2S Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -535,6 +551,7 @@ uint32_t HAL_I2S_GetError(const I2S_HandleTypeDef *hi2s); /* Private variables ---------------------------------------------------------*/ /* Private constants ---------------------------------------------------------*/ /** @defgroup I2S_Private_Constants I2S Private Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -544,6 +561,7 @@ uint32_t HAL_I2S_GetError(const I2S_HandleTypeDef *hi2s); /* Private Functions ---------------------------------------------------------*/ /** @defgroup I2S_Private_Functions I2S Private Functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Private functions are defined in stm32h7xx_hal_i2S.c file */ @@ -553,6 +571,7 @@ uint32_t HAL_I2S_GetError(const I2S_HandleTypeDef *hi2s); /* Private macros ------------------------------------------------------------*/ /** @defgroup I2S_Private_Macros I2S Private Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ |