I2S Exported Macros

Macros
#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...
#define	__HAL_I2S_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
	Enable or disable the specified SPI peripheral (in I2S mode). More...
#define	__HAL_I2S_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
	Enable or disable the specified I2S interrupts. More...
#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR2 &= ~(__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. 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_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag. More...
#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag. More...

Detailed Description

Macro Definition Documentation

__HAL_I2S_CLEAR_OVRFLAG

#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

<strong>HANDLE</strong>

specifies the I2S Handle.

Return values

None

__HAL_I2S_CLEAR_UDRFLAG

#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

<strong>HANDLE</strong>

specifies the I2S Handle.

Return values

None

__HAL_I2S_ENABLE

#define __HAL_I2S_ENABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)

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

Parameters

<strong>HANDLE</strong>

specifies the I2S Handle.

Return values

None

__HAL_I2S_ENABLE_IT

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

Enable or 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

__HAL_I2S_GET_FLAG

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

__HAL_I2S_GET_IT_SOURCE

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

__HAL_I2S_RESET_HANDLE_STATE

#define __HAL_I2S_RESET_HANDLE_STATE

(

__HANDLE__

)

((__HANDLE__)->State = HAL_I2S_STATE_RESET)

Reset I2S handle state.

Parameters

<strong>HANDLE</strong>

specifies the I2S Handle.

Return values

None