Collaboration diagram for I2S Exported Macros:

Macros
#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag. More...

#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag. More...

#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag. More...

#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag. More...

#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_OVRC)
	Clear the I2S OVR pending flag. More...

#define	__HAL_I2S_CLEAR_TIFREFLAG(__HANDLE__) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TIFREC)
	Clear the I2S FRE pending flag. More...

#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag. More...

#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag. More...

#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag. More...

#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag. More...

#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_UDRC)
	Clear the I2S UDR pending flag. More...

#define	__HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Disable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Disable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Disable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Disable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE))
	Disable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Disable the specified I2S interrupts. More...

#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Disable the specified I2S interrupts. More...

#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Disable the specified I2S interrupts. More...

#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Disable the specified I2S interrupts. More...

#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
	Disable the specified I2S interrupts. More...

#define	__HAL_I2S_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Enable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Enable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Enable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
	Enable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE))
	Enable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Enable the specified I2S interrupts. More...

#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Enable the specified I2S interrupts. More...

#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Enable the specified I2S interrupts. More...

#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
	Enable the specified I2S interrupts. More...

#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER \|= (__INTERRUPT__))
	Enable the specified I2S interrupts. More...

#define	__HAL_I2S_FLUSH_RX_DR(__HANDLE__)
	Flush the I2S DR Register. More...

#define	__HAL_I2S_FLUSH_RX_DR(__HANDLE__)
	Flush the I2S DR Register. More...

#define	__HAL_I2S_FLUSH_RX_DR(__HANDLE__)
	Flush the I2S DR Register. More...

#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified I2S flag is set or not. More...

#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified I2S flag is set or not. More...

#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified I2S flag is set or not. More...

#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified I2S flag is set or not. More...

#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Check whether the specified I2S flag is set or not. More...

#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. More...

#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Checks if the specified I2S interrupt source is enabled or disabled. More...

#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Checks if the specified I2S interrupt source is enabled or disabled. More...

#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Checks if the specified I2S interrupt source is enabled or disabled. More...

#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
	Check if the specified I2S interrupt source is enabled or disabled. More...

#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...

#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...

#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...

#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...

#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...

Detailed Description

Macro Definition Documentation

◆ __HAL_I2S_CLEAR_OVRFLAG [1/5]

#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)

Clears the I2S OVR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 376 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_OVRFLAG [2/5]

#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)

Clears the I2S OVR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 410 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_OVRFLAG [3/5]

#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)

Clears the I2S OVR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 410 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_OVRFLAG [4/5]

#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)

Clears the I2S OVR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 410 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_OVRFLAG [5/5]

#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.

◆ __HAL_I2S_CLEAR_TIFREFLAG

#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.

◆ __HAL_I2S_CLEAR_UDRFLAG [1/5]

#define __HAL_I2S_CLEAR_UDRFLAG ( __HANDLE__ )

Value:

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

Clears the I2S UDR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 386 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_UDRFLAG [2/5]

#define __HAL_I2S_CLEAR_UDRFLAG ( __HANDLE__ )

Value:

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

Clears the I2S UDR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 420 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_UDRFLAG [3/5]

#define __HAL_I2S_CLEAR_UDRFLAG ( __HANDLE__ )

Value:

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

Clears the I2S UDR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 420 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_UDRFLAG [4/5]

#define __HAL_I2S_CLEAR_UDRFLAG ( __HANDLE__ )

Value:

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

Clears the I2S UDR pending flag.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 420 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_CLEAR_UDRFLAG [5/5]

#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.

◆ __HAL_I2S_DISABLE [1/5]

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

Disable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 321 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE [2/5]

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

Disable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 354 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE [3/5]

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

Disable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 354 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE [4/5]

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

Disable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 354 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE [5/5]

#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 372 of file stm32h7xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE_IT [1/5]

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

Disable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 343 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE_IT [2/5]

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

Disable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 376 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE_IT [3/5]

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

Disable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 376 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE_IT [4/5]

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

Disable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 376 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_DISABLE_IT [5/5]

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

Disable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2 or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 402 of file stm32h7xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE [1/5]

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

Enable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 315 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE [2/5]

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

Enable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 348 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE [3/5]

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

Enable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 348 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE [4/5]

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

Enable the specified SPI peripheral (in I2S mode).

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 348 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE [5/5]

#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 366 of file stm32h7xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE_IT [1/5]

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

Enable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE_IT [2/5]

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

Enable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 365 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE_IT [3/5]

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

Enable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 365 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE_IT [4/5]

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

Enable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>INTERRUPT</strong>	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 365 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_ENABLE_IT [5/5]

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

Enable the specified I2S interrupts.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2 or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 387 of file stm32h7xx_hal_i2s.h.

◆ __HAL_I2S_FLUSH_RX_DR [1/3]

#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)

Flush the I2S DR Register.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 429 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_FLUSH_RX_DR [2/3]

#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)

Flush the I2S DR Register.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 429 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_FLUSH_RX_DR [3/3]

#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)

Flush the I2S DR Register.

Parameters

HANDLE specifies the I2S Handle.

Return values

None

Definition at line 429 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_FLAG [1/5]

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

Checks whether the specified I2S flag is set or not.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>FLAG</strong>	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 370 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_GET_FLAG [2/5]

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

Checks whether the specified I2S flag is set or not.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>FLAG</strong>	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 404 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_FLAG [3/5]

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

Checks whether the specified I2S flag is set or not.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>FLAG</strong>	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 404 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_FLAG [4/5]

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

Checks whether the specified I2S flag is set or not.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle.
<strong>FLAG</strong>	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 404 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_FLAG [5/5]

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

Check whether the specified I2S flag is set or not.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2 or 3 to select the I2S peripheral.
<strong>FLAG</strong>	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.

◆ __HAL_I2S_GET_IT_SOURCE [1/5]

#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

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 355 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_GET_IT_SOURCE [2/5]

#define __HAL_I2S_GET_IT_SOURCE	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

((((__HANDLE__)->Instance->CR2\

& (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

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

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 388 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_IT_SOURCE [3/5]

#define __HAL_I2S_GET_IT_SOURCE	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

((((__HANDLE__)->Instance->CR2\

& (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

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

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 388 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_IT_SOURCE [4/5]

#define __HAL_I2S_GET_IT_SOURCE	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

((((__HANDLE__)->Instance->CR2\

& (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

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

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 388 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_GET_IT_SOURCE [5/5]

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

Check if the specified I2S interrupt source is enabled or disabled.

Parameters

<strong>HANDLE</strong>	specifies the I2S Handle. This parameter can be I2S where x: 1, 2 or 3 to select the I2S peripheral.
<strong>INTERRUPT</strong>	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 418 of file stm32h7xx_hal_i2s.h.

◆ __HAL_I2S_RESET_HANDLE_STATE [1/5]

#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 308 of file stm32f7xx_hal_i2s.h.

◆ __HAL_I2S_RESET_HANDLE_STATE [2/5]

#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 341 of file stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_RESET_HANDLE_STATE [3/5]

#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 341 of file stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_RESET_HANDLE_STATE [4/5]

#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 341 of file stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h.

◆ __HAL_I2S_RESET_HANDLE_STATE [5/5]

#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 359 of file stm32h7xx_hal_i2s.h.