Defines
#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__)
	Reset I2S handle state.
#define	__HAL_I2S_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE))
	Enable the specified SPI peripheral (in I2S mode).
#define	__HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE))
	Disable the specified SPI peripheral (in I2S mode).
#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER \|= (__INTERRUPT__))
	Enable the specified I2S interrupts.
#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
	Disable the specified I2S interrupts.
#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check if the specified I2S interrupt source is enabled or disabled.
#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Check whether the specified I2S flag is set or not.
#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_OVRC)
	Clear the I2S OVR pending flag.
#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_UDRC)
	Clear the I2S UDR pending flag.
#define	__HAL_I2S_CLEAR_TIFREFLAG(__HANDLE__) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TIFREC)
	Clear the I2S FRE pending flag.

Define Documentation

#define __HAL_I2S_CLEAR_OVRFLAG ( __HANDLE__ ) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_OVRC)

Clear the I2S OVR pending flag.

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 438 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_IRQHandler(), HAL_I2S_Receive(), and HAL_I2SEx_TransmitReceive().

#define __HAL_I2S_CLEAR_TIFREFLAG ( __HANDLE__ ) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TIFREC)

Clear the I2S FRE pending flag.

Parameters:

__HANDLE__,: specifies the I2S Handle.

Return values:

None

Definition at line 450 of file stm32h7xx_hal_i2s.h.

#define __HAL_I2S_CLEAR_UDRFLAG ( __HANDLE__ ) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_UDRC)

Clear the I2S UDR pending flag.

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 444 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_IRQHandler(), HAL_I2S_Transmit(), and HAL_I2SEx_TransmitReceive().

#define __HAL_I2S_DISABLE ( __HANDLE__ ) (CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE))

Disable the specified SPI peripheral (in I2S mode).

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 371 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_DMAPause(), HAL_I2S_DMAStop(), and HAL_I2S_Init().

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

Disable the specified I2S interrupts.

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 interrupt source to enable or disable. This parameter can be one of the following values: I2S_IT_RXP : Rx-Packet available interrupt I2S_IT_TXP : Tx-Packet space available interrupt I2S_IT_UDR : Underrun interrupt I2S_IT_OVR : Overrun interrupt I2S_IT_FRE : TI mode frame format error interrupt I2S_IT_ERR : Error interrupt enable

Return values:

None

Definition at line 401 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_IRQHandler(), I2S_Receive_16Bit_IT(), I2S_Receive_32Bit_IT(), I2S_Transmit_16Bit_IT(), and I2S_Transmit_32Bit_IT().

#define __HAL_I2S_ENABLE ( __HANDLE__ ) (SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE))

Enable the specified SPI peripheral (in I2S mode).

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 365 of file stm32h7xx_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->IER \|= (__INTERRUPT__))

Enable the specified I2S interrupts.

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 interrupt source to enable or disable. This parameter can be one of the following values: I2S_IT_RXP : Rx-Packet available interrupt I2S_IT_TXP : Tx-Packet space available interrupt I2S_IT_UDR : Underrun interrupt I2S_IT_OVR : Overrun interrupt I2S_IT_FRE : TI mode frame format error interrupt I2S_IT_ERR : Error interrupt enable

Return values:

None

Definition at line 386 of file stm32h7xx_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__))

Check whether the specified I2S flag is set or not.

Parameters:

__HANDLE__	specifies the I2S Handle. This parameter can be I2S where x: 1, 2 or 3 to select the I2S peripheral.
__FLAG__	specifies the flag to check. This parameter can be one of the following values: I2S_FLAG_RXP : Rx-Packet available flag I2S_FLAG_TXP : Tx-Packet space available flag I2S_FLAG_UDR : Underrun flag I2S_FLAG_OVR : Overrun flag I2S_FLAG_FRE : TI mode frame format error flag

Return values:

The	new state of __FLAG__ (TRUE or FALSE).

Definition at line 432 of file stm32h7xx_hal_i2s.h.

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

#define __HAL_I2S_GET_IT_SOURCE	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

((((__HANDLE__)->Instance->IER\
                                                              & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

Check 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_RXP : Rx-Packet available interrupt I2S_IT_TXP : Tx-Packet space available interrupt I2S_IT_DXP : Tx-Packet space available interrupt I2S_IT_UDR : Underrun interrupt I2S_IT_OVR : Overrun interrupt I2S_IT_FRE : TI mode frame format error interrupt I2S_IT_ERR : Error interrupt enable

Return values:

The	new state of __IT__ (TRUE or FALSE).

Definition at line 417 of file stm32h7xx_hal_i2s.h.

#define __HAL_I2S_RESET_HANDLE_STATE ( __HANDLE__ )

Value:

do{                                                  \
                                                                    (__HANDLE__)->State = HAL_I2S_STATE_RESET;       \
                                                                    (__HANDLE__)->MspInitCallback = NULL;            \
                                                                    (__HANDLE__)->MspDeInitCallback = NULL;          \
                                                                  } while(0)

Reset I2S handle state.

Parameters:

__HANDLE__ specifies the I2S Handle.

Return values:

None

Definition at line 352 of file stm32h7xx_hal_i2s.h.

Defines

Define Documentation