RTEMS 6.1-rc5
Loading...
Searching...
No Matches
Macros

Macros

#define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
 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.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_I2S_CLEAR_OVRFLAG

#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

◆ __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

◆ __HAL_I2S_CLEAR_UDRFLAG

#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

◆ __HAL_I2S_DISABLE

#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

◆ __HAL_I2S_DISABLE_IT

#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

◆ __HAL_I2S_ENABLE

#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

◆ __HAL_I2S_ENABLE_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

◆ __HAL_I2S_GET_FLAG

#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
Thenew state of FLAG (TRUE or FALSE).

◆ __HAL_I2S_GET_IT_SOURCE

#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
Thenew 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
__HANDLE__specifies the I2S Handle.
Return values
None