stm32g4xx_hal_sai.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_sai.h
  * @author  MCD 应用团队
  * @brief   SAI HAL 模块的头文件。
  ******************************************************************************
  * @attention
  *
  * 版权所有 (c) 2019 STMicroelectronics。
  * 保留所有权利。
  *
  * 本软件根据可在 LICENSE 文件中找到的条款进行许可
  * 位于本软件组件的根目录中。
  * 如果本软件没有附带 LICENSE 文件，则按“AS-IS”提供。
  *
  ******************************************************************************
  */

/* 定义防止递归包含 -------------------------------------*/
#ifndef STM32G4xx_HAL_SAI_H
#define STM32G4xx_HAL_SAI_H

#ifdef __cplusplus
extern "C" {
#endif

/* 包含 ------------------------------------------------------------------*/
#include "stm32g4xx_hal_def.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

#if defined(SAI1)

/** @addtogroup SAI
  * @{
  */

/* 导出的类型 ------------------------------------------------------------*/
/** @defgroup SAI_Exported_Types SAI 导出的类型
  * @{
  */

/**
  * @brief  HAL 状态结构定义
  */
typedef enum
{
  HAL_SAI_STATE_RESET   = 0x00U, /*!< SAI 尚未初始化或已禁用  */
  HAL_SAI_STATE_READY   = 0x01U, /*!< SAI 已初始化并准备好使用    */
  HAL_SAI_STATE_BUSY    = 0x02U, /*!< SAI 内部处理正在进行中      */
  HAL_SAI_STATE_BUSY_TX = 0x12U, /*!< 数据传输处理正在进行中 */
  HAL_SAI_STATE_BUSY_RX = 0x22U, /*!< 数据接收处理正在进行中    */
} HAL_SAI_StateTypeDef;

/**
  * @brief  SAI 回调函数原型
  */
typedef void (*SAIcallback)(void);

/** @defgroup SAI_PDM_Structure_definition SAI PDM 结构定义
  * @brief  SAI PDM 初始化结构定义
  * @{
  */
typedef struct
{
  FunctionalState  Activation;  /*!< 启用/禁用 PDM 接口 */
  uint32_t         MicPairsNbr; /*!< 指定使用的麦克风对数。
                                     此参数必须是一个介于 Min_Data = 1 和 Max_Data = 3 之间的数字。 */
  uint32_t         ClockEnable; /*!< 指定必须启用哪个时钟。
                                     此参数可以是 @ref SAI_PDM_ClockEnable 中值的组合 */
} SAI_PdmInitTypeDef;
/**
  * @}
  */

/** @defgroup SAI_Init_Structure_definition SAI 初始化结构定义
  * @brief  SAI 初始化结构定义
  * @{
  */
typedef struct
{
  uint32_t AudioMode;           /*!< 指定 SAI 块的音频模式。
                                     此参数可以是 @ref SAI_Block_Mode 中的一个值 */

  uint32_t Synchro;             /*!< 指定 SAI 块的同步
                                     此参数可以是 @ref SAI_Block_Synchronization 中的一个值 */

  uint32_t SynchroExt;          /*!< 指定 SAI 外部输出同步，此设置对于 BlockA 和 BlockB 是通用的
                                     此参数可以是 @ref SAI_Block_SyncExt 中的一个值
                                     @注意 如果使用同一 SAI 的两个音频块，此参数必须
                                           为每个音频块设置为相同的值 */


  uint32_t MckOutput;           /*!< 指定是否生成主时钟输出。
                                     此参数可以是 @ref SAI_Block_MckOutput 中的一个值 */

  uint32_t OutputDrive;         /*!< 指定 SAI 块输出何时被驱动。
                                     此参数可以是 @ref SAI_Block_Output_Drive 中的一个值
                                     @注意 该值必须在启用音频块之前设置，但应在音频块配置之后设置。 */


  uint32_t NoDivider;           /*!< 指定主时钟是否被分频。
                                     此参数可以是 @ref SAI_Block_NoDivider 中的一个值
                                     @注意 如果 SAI_xCR1 寄存器中的 NODIV 位被清除，帧长度
                                           应对齐到等于 2 的幂的数字，范围从 8 到 256。
                                           如果 SAI_xCR1 寄存器中的 NODIV 位被设置，帧长度可以
                                           取 8 到 256 中的任何值。 */

  uint32_t FIFOThreshold;       /*!< 指定 SAI 块的 FIFO 阈值。
                                     此参数可以是 @ref SAI_Block_Fifo_Threshold 中的一个值 */

  uint32_t AudioFrequency;      /*!< 指定音频频率采样。
                                     此参数可以是 @ref SAI_Audio_Frequency 中的一个值 */

  uint32_t Mckdiv;              /*!< 指定主时钟分频器。
                                     此参数必须是一个介于 Min_Data = 0 和 Max_Data = 63 之间的数字。
                                     @注意 仅当 AudioFrequency 设置为
                                           SAI_AUDIO_FREQUENCY_MCKDIV 时使用此参数，否则由内部计算。 */

  uint32_t MckOverSampling;     /*!< 指定主时钟过采样。
                                     此参数可以是 @ref SAI_Block_Mck_OverSampling 中的一个值 */

  uint32_t MonoStereoMode;      /*!< 指定选择单声道或立体声模式。
                                     此参数可以是 @ref SAI_Mono_Stereo_Mode 中的一个值 */

  uint32_t CompandingMode;      /*!< 指定压扩模式类型。
                                     此参数可以是 @ref SAI_Block_Companding_Mode 中的一个值 */

  uint32_t TriState;            /*!< 指定压扩模式类型。
                                     此参数可以是 @ref SAI_TRIState_Management 中的一个值 */

  SAI_PdmInitTypeDef PdmInit;   /*!< 指定 PDM 配置。 */

  /* 如果您使用高级初始化函数 HAL_SAI_InitProtocol，这部分结构将自动填充 */


  uint32_t Protocol;        /*!< 指定 SAI 块协议。
                                 此参数可以是 @ref SAI_Block_Protocol 中的一个值 */

  uint32_t DataSize;        /*!< 指定 SAI 块的数据大小。
                                 此参数可以是 @ref SAI_Block_Data_Size 中的一个值 */

  uint32_t FirstBit;        /*!< 指定数据传输是从 MSB 还是 LSB 位开始。
                                 此参数可以是 @ref SAI_Block_MSB_LSB_transmission 中的一个值 */

  uint32_t ClockStrobing;   /*!< 指定 SAI 块时钟选通边沿灵敏度。
                                 此参数可以是 @ref SAI_Block_Clock_Strobing 中的一个值 */
} SAI_InitTypeDef;
/**
  * @}
  */

/** @defgroup SAI_Frame_Structure_definition SAI 帧结构定义
  * @brief  SAI 帧初始化结构定义
  * @note   对于 SPDIF 和 AC97 协议，不使用这些参数（由硬件设置）。
  * @{
  */
typedef struct
{

  uint32_t FrameLength;        /*!< 指定帧长度，即每个音频帧的 SCK 时钟数。
                                    此参数必须是一个介于 Min_Data = 8 和 Max_Data = 256 之间的数字。
                                    @注意 如果主时钟 MCLK_x 引脚被声明为输出，帧长度
                                          应对齐到等于 2 的幂的数字，以便在音频帧中保持
                                          每个位时钟具有整数个 MCLK 脉冲。 */

  uint32_t ActiveFrameLength;  /*!< 指定帧同步有效电平长度。
                                    此参数指定在音频帧中，FS 信号有效电平的位时钟 (SCK + 1) 长度。
                                    此参数必须是一个介于 Min_Data = 1 和 Max_Data = 128 之间的数字 */


  uint32_t FSDefinition;       /*!< 指定帧同步定义。
                                    此参数可以是 @ref SAI_Block_FS_Definition 中的一个值 */