STM32G474xx HAL用户手册: stm32g4xx_hal_sai

转到此文件的文档。
00001 /**
00002   ******************************************************************************
00003   * @file    stm32g4xx_hal_sai_ex.h
00004   * @author  MCD应用团队
00005   * @brief   SAI HAL扩展模块的头文件。
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * 版权所有 (c) 2019 STMicroelectronics。
00010   * 保留所有权利。
00011   *
00012   * 本软件根据许可证条款许可使用，该许可证文件
00013   * 位于本软件组件的根目录中。
00014   * 如果本软件未附带许可证文件，则按"原样"提供。
00015   *
00016   ******************************************************************************
00017   */
00018 
00019 /* 定义以防止递归包含 -------------------------------------*/
00020 #ifndef STM32G4xx_HAL_SAI_EX_H
00021 #define STM32G4xx_HAL_SAI_EX_H
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /* 包含文件 ------------------------------------------------------------------*/
00028 #include "stm32g4xx_hal_def.h"
00029 
00030 /** @addtogroup STM32G4xx_HAL_Driver
00031   * @{
00032   */
00033 
00034 #if defined(SAI1)
00035 
00036 /** @addtogroup SAIEx
00037   * @{
00038   */
00039 
00040 /* 导出的类型 ------------------------------------------------------------*/
00041 /** @defgroup SAIEx_Exported_Types SAIEx 导出的类型
00042   * @{
00043   */
00044 
00045 /**
00046   * @brief  PDM麦克风延迟结构定义
00047   */
00048 typedef struct
00049 {
00050   uint32_t MicPair;     /*!< 指定选择哪对麦克风。
00051                              此参数必须是一个介于 Min_Data = 1 和 Max_Data = 3 之间的数字。 */
00052 
00053   uint32_t LeftDelay;   /*!< 指定应用到左麦克风的延迟（以PDM时钟单位计）。
00054                              此参数必须是一个介于 Min_Data = 0 和 Max_Data = 7 之间的数字。 */
00055 
00056   uint32_t RightDelay;  /*!< 指定应用到右麦克风的延迟（以PDM时钟单位计）。
00057                              此参数必须是一个介于 Min_Data = 0 和 Max_Data = 7 之间的数字。 */
00058 } SAIEx_PdmMicDelayParamTypeDef;
00059 
00060 /**
00061   * @}
00062   */
00063 
00064 /* 导出的常量 --------------------------------------------------------*/
00065 /* 导出的宏 -----------------------------------------------------------*/
00066 /* 导出的函数 --------------------------------------------------------*/
00067 /** @addtogroup SAIEx_Exported_Functions SAIEx 扩展的导出函数
00068   * @{
00069   */
00070 
00071 /** @addtogroup SAIEx_Exported_Functions_Group1 外设控制函数
00072   * @{
00073   */
00074 HAL_StatusTypeDef HAL_SAIEx_ConfigPdmMicDelay(const SAI_HandleTypeDef *hsai,
00075                                               const SAIEx_PdmMicDelayParamTypeDef *pdmMicDelay);
00076 /**
00077   * @}
00078   */
00079 
00080 /**
00081   * @}
00082   */
00083 
00084 /* 私有宏 ------------------------------------------------------------*/
00085 /** @addtogroup SAIEx_Private_Macros SAIEx 扩展的私有宏
00086   * @{
00087   */
00088 #define IS_SAI_PDM_MIC_DELAY(VALUE)   ((VALUE) <= 7U)
00089 /**
00090   * @}
00091   */
00092 
00093 /**
00094   * @}
00095   */
00096 
00097 #endif /* SAI1 */
00098 
00099 /**
00100   * @}
00101   */
00102 
00103 #ifdef __cplusplus
00104 }
00105 #endif
00106 
00107 #endif /* STM32G4xx_HAL_SAI_EX_H */
00108