Defines
#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state.
#define	__HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR \|= SPI_I2SCFGR_I2SE)
	Enable or disable the specified SPI peripheral (in I2S mode).
#define	__HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &=(uint16_t)(~SPI_I2SCFGR_I2SE))
#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 \|= (__INTERRUPT__))
	Enable or disable the specified I2S interrupts.
#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &=(uint16_t)(~(__INTERRUPT__)))
#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
	Checks if the specified I2S interrupt source is enabled or disabled.
#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified I2S flag is set or not.
#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag.
#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag.

Define Documentation

#define __HAL_I2S_CLEAR_OVRFLAG ( __HANDLE__ )

Value:

do{                                           \
    __IO uint32_t tmpreg = 0x00U;               \
    tmpreg = (__HANDLE__)->Instance->DR;        \
    tmpreg = (__HANDLE__)->Instance->SR;        \
    UNUSED(tmpreg);                             \
  } while(0)

Clears the I2S OVR pending flag.

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 366 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2SEx_FullDuplex_IRQHandler(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), and I2S_IRQHandler().

#define __HAL_I2S_CLEAR_UDRFLAG ( __HANDLE__ )

Value:

do{                                           \
  __IO uint32_t tmpreg = 0x00U;                 \
  tmpreg = (__HANDLE__)->Instance->SR;          \
  UNUSED(tmpreg);                               \
  } while(0)

Clears the I2S UDR pending flag.

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 378 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Transmit(), HAL_I2SEx_FullDuplex_IRQHandler(), HAL_I2SEx_TransmitReceive(), and I2S_IRQHandler().

#define __HAL_I2S_DISABLE ( __HANDLE__ ) ((__HANDLE__)->Instance->I2SCFGR &=(uint16_t)(~SPI_I2SCFGR_I2SE))

Definition at line 321 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop().

#define __HAL_I2S_DISABLE_IT	(	__HANDLE__,
		__INTERRUPT__
	)	((__HANDLE__)->Instance->CR2 &=(uint16_t)(~(__INTERRUPT__)))

Definition at line 333 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2SEx_FullDuplex_IRQHandler(), HAL_I2SEx_TransmitReceive_IT(), I2S_IRQHandler(), I2S_Receive_IT(), I2S_Transmit_IT(), I2SEx_FullDuplexRx_IT(), and I2SEx_FullDuplexTx_IT().

#define __HAL_I2S_ENABLE ( __HANDLE__ ) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)

Enable or disable the specified SPI peripheral (in I2S mode).

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 320 of file stm32f4xx_hal_i2s.h.

Referenced by 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(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), and HAL_I2SEx_TransmitReceive_IT().

#define __HAL_I2S_ENABLE_IT	(	__HANDLE__,
		__INTERRUPT__
	)	((__HANDLE__)->Instance->CR2 \|= (__INTERRUPT__))

Enable or disable the specified I2S 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 332 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive_IT(), HAL_I2S_Transmit_IT(), and HAL_I2SEx_TransmitReceive_IT().

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

Checks whether the specified I2S 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:

The	new state of __FLAG__ (TRUE or FALSE).

Definition at line 360 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Transmit(), HAL_I2SEx_TransmitReceive(), I2S_WaitFlagStateUntilTimeout(), and I2SEx_FullDuplexWaitFlagStateUntilTimeout().

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

Checks if the specified I2S 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:

The	new state of __IT__ (TRUE or FALSE).

Definition at line 345 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2SEx_FullDuplex_IRQHandler(), and I2S_IRQHandler().

#define __HAL_I2S_RESET_HANDLE_STATE ( __HANDLE__ ) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)

Reset I2S handle state.

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 314 of file stm32f4xx_hal_i2s.h.

Defines

Define Documentation