diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h index a8dd6d5680..0dc6f0fa0f 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup SAI_Exported_Types SAI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -59,6 +60,7 @@ typedef enum typedef void (*SAIcallback)(void);
/** @defgroup SAI_PDM_Structure_definition SAI PDM Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI PDM Init structure definition
* @{
*/
@@ -75,6 +77,7 @@ typedef struct */
/** @defgroup SAI_Init_Structure_definition SAI Init Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Init Structure definition
* @{
*/
@@ -153,6 +156,7 @@ typedef struct */
/** @defgroup SAI_Frame_Structure_definition SAI Frame Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Frame Init structure definition
* @{
*/
@@ -185,6 +189,7 @@ typedef struct */
/** @defgroup SAI_Slot_Structure_definition SAI Slot Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Block Slot Init Structure definition
* @{
*/
@@ -207,6 +212,7 @@ typedef struct */
/** @defgroup SAI_Handle_Structure_definition SAI Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI handle Structure definition
* @{
*/
@@ -281,10 +287,12 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); /* Exported constants --------------------------------------------------------*/
/** @defgroup SAI_Exported_Constants SAI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SAI_Error_Code SAI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SAI_ERROR_NONE 0x00000000U /*!< No error */
@@ -304,6 +312,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_SyncExt SAI External synchronisation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_SYNCEXT_DISABLE 0U
@@ -314,6 +323,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_MckOutput SAI Block Master Clock Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MCK_OUTPUT_DISABLE 0x00000000U
@@ -323,6 +333,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Protocol SAI Supported protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_I2S_STANDARD 0U
@@ -335,6 +346,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Protocol_DataSize SAI protocol data size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_PROTOCOL_DATASIZE_16BIT 0U
@@ -346,6 +358,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Audio_Frequency SAI Audio Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_AUDIO_FREQUENCY_192K 192000U
@@ -363,6 +376,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Mck_OverSampling SAI Block Master Clock OverSampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MCK_OVERSAMPLING_DISABLE 0x00000000U
@@ -372,6 +386,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_PDM_ClockEnable SAI PDM Clock Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_PDM_CLOCK1_ENABLE SAI_PDMCR_CKEN1
@@ -381,6 +396,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Mode SAI Block Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MODEMASTER_TX 0x00000000U
@@ -393,6 +409,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Protocol SAI Block Protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FREE_PROTOCOL 0x00000000U
@@ -403,6 +420,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Data_Size SAI Block Data Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_DATASIZE_8 SAI_xCR1_DS_1
@@ -416,6 +434,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_MSB_LSB_transmission SAI Block MSB LSB transmission
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIRSTBIT_MSB 0x00000000U
@@ -425,6 +444,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Clock_Strobing SAI Block Clock Strobing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_CLOCKSTROBING_FALLINGEDGE 0U
@@ -434,6 +454,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Synchronization SAI Block Synchronization
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_ASYNCHRONOUS 0U /*!< Asynchronous */
@@ -453,6 +474,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Output_Drive SAI Block Output Drive
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_OUTPUTDRIVE_DISABLE 0x00000000U
@@ -462,6 +484,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_NoDivider SAI Block NoDivider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MASTERDIVIDER_ENABLE 0x00000000U
@@ -471,6 +494,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_FS_Definition SAI Block FS Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FS_STARTFRAME 0x00000000U
@@ -480,6 +504,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_FS_Polarity SAI Block FS Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FS_ACTIVE_LOW 0x00000000U
@@ -489,6 +514,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_FS_Offset SAI Block FS Offset
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FS_FIRSTBIT 0x00000000U
@@ -498,6 +524,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Slot_Size SAI Block Slot Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_SLOTSIZE_DATASIZE 0x00000000U
@@ -508,6 +535,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Slot_Active SAI Block Slot Active
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_SLOT_NOTACTIVE 0x00000000U
@@ -533,6 +561,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Mono_Stereo_Mode SAI Mono Stereo Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_STEREOMODE 0x00000000U
@@ -542,6 +571,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_TRIState_Management SAI TRIState Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_OUTPUT_NOTRELEASED 0x00000000U
@@ -551,6 +581,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Fifo_Threshold SAI Block Fifo Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIFOTHRESHOLD_EMPTY 0x00000000U
@@ -563,6 +594,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Companding_Mode SAI Block Companding Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_NOCOMPANDING 0x00000000U
@@ -575,6 +607,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Mute_Value SAI Block Mute Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_ZERO_VALUE 0x00000000U
@@ -584,6 +617,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Interrupts_Definition SAI Block Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_IT_OVRUDR SAI_xIMR_OVRUDRIE
@@ -598,6 +632,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Flags_Definition SAI Block Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FLAG_OVRUDR SAI_xSR_OVRUDR
@@ -612,6 +647,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Fifo_Status_Level SAI Block Fifo Status Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIFOSTATUS_EMPTY 0x00000000U
@@ -630,6 +666,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); /* Exported macro ------------------------------------------------------------*/
/** @defgroup SAI_Exported_Macros SAI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific configurations
* @{
*/
@@ -959,6 +996,7 @@ uint32_t HAL_SAI_GetError(SAI_HandleTypeDef *hsai); /* Private functions ---------------------------------------------------------*/
/** @defgroup SAI_Private_Functions SAI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
|