STM32F439xx HAL User Manual
Defines
I2S Extended Exported Macros
I2SEx

Defines

#define I2SxEXT(__INSTANCE__)   ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))
#define __HAL_I2SEXT_ENABLE(__HANDLE__)   (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR |= SPI_I2SCFGR_I2SE)
 Enable or disable the specified I2SExt peripheral.
#define __HAL_I2SEXT_DISABLE(__HANDLE__)   (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
#define __HAL_I2SEXT_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (I2SxEXT((__HANDLE__)->Instance)->CR2 |= (__INTERRUPT__))
 Enable or disable the specified I2SExt interrupts.
#define __HAL_I2SEXT_DISABLE_IT(__HANDLE__, __INTERRUPT__)   (I2SxEXT((__HANDLE__)->Instance)->CR2 &= ~(__INTERRUPT__))
#define __HAL_I2SEXT_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   (((I2SxEXT((__HANDLE__)->Instance)->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
 Checks if the specified I2SExt interrupt source is enabled or disabled.
#define __HAL_I2SEXT_GET_FLAG(__HANDLE__, __FLAG__)   (((I2SxEXT((__HANDLE__)->Instance)->SR) & (__FLAG__)) == (__FLAG__))
 Checks whether the specified I2SExt flag is set or not.
#define __HAL_I2SEXT_CLEAR_OVRFLAG(__HANDLE__)
 Clears the I2SExt OVR pending flag.
#define __HAL_I2SEXT_CLEAR_UDRFLAG(__HANDLE__)
 Clears the I2SExt UDR pending flag.

Define Documentation

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

Clears the I2SExt OVR pending flag.

Parameters:
__HANDLE__specifies the I2S Handle.
Return values:
None

Definition at line 114 of file stm32f4xx_hal_i2s_ex.h.

Referenced by HAL_I2SEx_TransmitReceive().

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

Clears the I2SExt UDR pending flag.

Parameters:
__HANDLE__specifies the I2S Handle.
Return values:
None

Definition at line 124 of file stm32f4xx_hal_i2s_ex.h.

#define __HAL_I2SEXT_DISABLE (   __HANDLE__)    (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR &= ~SPI_I2SCFGR_I2SE)

Definition at line 69 of file stm32f4xx_hal_i2s_ex.h.

Referenced by HAL_I2S_DMAStop().

#define __HAL_I2SEXT_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (I2SxEXT((__HANDLE__)->Instance)->CR2 &= ~(__INTERRUPT__))
#define __HAL_I2SEXT_ENABLE (   __HANDLE__)    (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR |= SPI_I2SCFGR_I2SE)

Enable or disable the specified I2SExt peripheral.

Parameters:
__HANDLE__specifies the I2S Handle.
Return values:
None

Definition at line 68 of file stm32f4xx_hal_i2s_ex.h.

Referenced by HAL_I2S_DMAResume(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), and HAL_I2SEx_TransmitReceive_IT().

#define __HAL_I2SEXT_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (I2SxEXT((__HANDLE__)->Instance)->CR2 |= (__INTERRUPT__))

Enable or disable the specified I2SExt interrupts.

Parameters:
__HANDLE__specifies the I2S Handle.
__INTERRUPT__specifies the interrupt source to enable or disable. This parameter can be one of the following values:
  • I2S_IT_TXE: Tx buffer empty interrupt enable
  • I2S_IT_RXNE: RX buffer not empty interrupt enable
  • I2S_IT_ERR: Error interrupt enable
Return values:
None

Definition at line 80 of file stm32f4xx_hal_i2s_ex.h.

Referenced by HAL_I2SEx_TransmitReceive_IT().

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

Checks whether the specified I2SExt flag is set or not.

Parameters:
__HANDLE__specifies the I2S Handle.
__FLAG__specifies the flag to check. This parameter can be one of the following values:
  • I2S_FLAG_RXNE: Receive buffer not empty flag
  • I2S_FLAG_TXE: Transmit buffer empty flag
  • I2S_FLAG_UDR: Underrun flag
  • I2S_FLAG_OVR: Overrun flag
  • I2S_FLAG_FRE: Frame error flag
  • I2S_FLAG_CHSIDE: Channel Side flag
  • I2S_FLAG_BSY: Busy flag
Return values:
Thenew state of __FLAG__ (TRUE or FALSE).

Definition at line 108 of file stm32f4xx_hal_i2s_ex.h.

Referenced by HAL_I2SEx_TransmitReceive(), and I2SEx_FullDuplexWaitFlagStateUntilTimeout().

#define __HAL_I2SEXT_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)    (((I2SxEXT((__HANDLE__)->Instance)->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

Checks if the specified I2SExt interrupt source is enabled or disabled.

Parameters:
__HANDLE__specifies the I2S Handle. This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
__INTERRUPT__specifies the I2S interrupt source to check. This parameter can be one of the following values:
  • I2S_IT_TXE: Tx buffer empty interrupt enable
  • I2S_IT_RXNE: RX buffer not empty interrupt enable
  • I2S_IT_ERR: Error interrupt enable
Return values:
Thenew state of __IT__ (TRUE or FALSE).

Definition at line 93 of file stm32f4xx_hal_i2s_ex.h.

Referenced by HAL_I2SEx_FullDuplex_IRQHandler().

#define I2SxEXT (   __INSTANCE__)    ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))