STM32G474xx HAL用户手册
定义
I2S导出宏
I2S

定义

#define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__)
 重置I2S句柄状态。
#define __HAL_I2S_ENABLE(__HANDLE__)   (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
 使能指定的SPI外设(处于I2S模式)。
#define __HAL_I2S_DISABLE(__HANDLE__)   (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
 禁用指定的SPI外设(处于I2S模式)。
#define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
 使能指定的I2S中断。
#define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__)   (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
 禁用指定的I2S中断。
#define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 检查指定的I2S中断源是处于使能还是禁用状态。
#define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 检查指定的I2S标志位是否被置位。
#define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
 清除I2S OVR挂起标志位。
#define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
 清除I2S UDR挂起标志位。
#define __HAL_I2S_FLUSH_RX_DR(__HANDLE__)
 清空I2S数据寄存器。

定义文档

#define __HAL_I2S_CLEAR_OVRFLAG (   __HANDLE__)
Value:
do{ \
                                                __IO uint32_t tmpreg_ovr = 0x00U; \
                                                tmpreg_ovr = (__HANDLE__)->Instance->DR; \
                                                tmpreg_ovr = (__HANDLE__)->Instance->SR; \
                                                UNUSED(tmpreg_ovr); \
                                              }while(0U)

清除I2S OVR挂起标志位。

参数:
__HANDLE__指定I2S句柄。
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 368 行。

被以下函数引用:HAL_I2S_DMAStop()HAL_I2S_Receive()HAL_I2S_Receive_DMA()

#define __HAL_I2S_CLEAR_UDRFLAG (   __HANDLE__)
Value:
do{\
                                                __IO uint32_t tmpreg_udr = 0x00U;\
                                                tmpreg_udr = ((__HANDLE__)->Instance->SR);\
                                                UNUSED(tmpreg_udr); \
                                              }while(0U)

清除I2S UDR挂起标志位。

参数:
__HANDLE__指定I2S句柄。
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 378 行。

被以下函数引用:HAL_I2S_DMAStop()HAL_I2S_Transmit()

#define __HAL_I2S_DISABLE (   __HANDLE__)    (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))

禁用指定的SPI外设(处于I2S模式)。

参数:
__HANDLE__指定I2S句柄。
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 312 行。

被以下函数引用:HAL_I2S_DeInit()HAL_I2S_DMAStop()

#define __HAL_I2S_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))

禁用指定的I2S中断。

参数:
__HANDLE__指定I2S句柄。
__INTERRUPT__指定要使能或禁用的中断源。该参数可以是以下值之一:
  • I2S_IT_TXE:发送缓冲区空中断使能
  • I2S_IT_RXNE:接收缓冲区非空中断使能
  • I2S_IT_ERR:错误中断使能
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 334 行。

被以下函数引用:HAL_I2S_IRQHandler()I2S_Receive_IT()I2S_Transmit_IT()

#define __HAL_I2S_ENABLE (   __HANDLE__)    (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))

使能指定的SPI外设(处于I2S模式)。

参数:
__HANDLE__指定I2S句柄。
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 306 行。

被以下函数引用:HAL_I2S_DMAResume()HAL_I2S_Receive()HAL_I2S_Receive_DMA()HAL_I2S_Receive_IT()HAL_I2S_Transmit()HAL_I2S_Transmit_DMA()HAL_I2S_Transmit_IT()

#define __HAL_I2S_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))

使能指定的I2S中断。

参数:
__HANDLE__指定I2S句柄。
__INTERRUPT__指定要使能或禁用的中断源。该参数可以是以下值之一:
  • I2S_IT_TXE:发送缓冲区空中断使能
  • I2S_IT_RXNE:接收缓冲区非空中断使能
  • I2S_IT_ERR:错误中断使能
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 323 行。

被以下函数引用:HAL_I2S_Receive_IT()HAL_I2S_Transmit_IT()

#define __HAL_I2S_FLUSH_RX_DR (   __HANDLE__)
Value:
do{\
                                                __IO uint32_t tmpreg_dr = 0x00U;\
                                                tmpreg_dr = ((__HANDLE__)->Instance->DR);\
                                                UNUSED(tmpreg_dr); \
                                              }while(0U)

清空I2S数据寄存器。

参数:
__HANDLE__指定I2S句柄。
返回值:

定义于文件 stm32g4xx_hal_i2s.h 的第 387 行。

#define __HAL_I2S_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((((__HANDLE__)->Instance->SR) & (__FLAG__)) ==