STM32H735xx HAL User Manual
Defines
I2S Private Macros
I2S

Defines

#define I2S_CHECK_FLAG(__SR__, __FLAG__)
 Check whether the specified SPI flag is set or not.
#define I2S_CHECK_IT_SOURCE(__IER__, __INTERRUPT__)
 Check whether the specified SPI Interrupt is set or not.
#define IS_I2S_MODE(__MODE__)
 Checks if I2S Mode parameter is in allowed range.
#define IS_I2S_MASTER(__MODE__)
#define IS_I2S_SLAVE(__MODE__)
#define IS_I2S_FULLDUPLEX(__MODE__)
#define IS_I2S_STANDARD(__STANDARD__)
#define IS_I2S_DATA_FORMAT(__FORMAT__)
#define IS_I2S_MCLK_OUTPUT(__OUTPUT__)
#define IS_I2S_AUDIO_FREQ(__FREQ__)
#define IS_I2S_CPOL(__CPOL__)
#define IS_I2S_FIRST_BIT(__BIT__)
#define IS_I2S_WS_INVERSION(__WSINV__)
#define IS_I2S_DATA_24BIT_ALIGNMENT(__ALIGNMENT__)
#define IS_I2S_MASTER_KEEP_IO_STATE(__AFCNTR__)

Define Documentation

#define I2S_CHECK_FLAG (   __SR__,
  __FLAG__ 
)
Value:
((((__SR__)\
                                                    & ((__FLAG__) & I2S_FLAG_MASK)) == ((__FLAG__) & I2S_FLAG_MASK))\
                                                  ? SET : RESET)

Check whether the specified SPI flag is set or not.

Parameters:
__SR__copy of I2S SR register.
__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:
SETor RESET.

Definition at line 561 of file stm32h7xx_hal_i2s.h.

#define I2S_CHECK_IT_SOURCE (   __IER__,
  __INTERRUPT__ 
)
Value:
((((__IER__)\
                                                            & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

Check whether the specified SPI Interrupt is set or not.

Parameters:
__IER__copy of I2S IER register.
__INTERRUPT__specifies the SPI 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_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:
SETor RESET.

Definition at line 577 of file stm32h7xx_hal_i2s.h.

#define IS_I2S_AUDIO_FREQ (   __FREQ__)
Value:
((((__FREQ__) >= I2S_AUDIOFREQ_8K)                    && \
                                                     ((__FREQ__) <= I2S_AUDIOFREQ_192K))                 || \
                                                    ((__FREQ__) == I2S_AUDIOFREQ_DEFAULT))

Definition at line 617 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_CPOL (   __CPOL__)
Value:
(((__CPOL__) == I2S_CPOL_LOW)                        || \
                                                     ((__CPOL__) == I2S_CPOL_HIGH))

Definition at line 621 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_DATA_24BIT_ALIGNMENT (   __ALIGNMENT__)
Value:
(((__ALIGNMENT__) == I2S_DATA_24BIT_ALIGNMENT_RIGHT) || \
                                                     ((__ALIGNMENT__) == I2S_DATA_24BIT_ALIGNMENT_LEFT))

Definition at line 630 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_DATA_FORMAT (   __FORMAT__)
Value:
(((__FORMAT__) == I2S_DATAFORMAT_16B)                || \
                                                     ((__FORMAT__) == I2S_DATAFORMAT_16B_EXTENDED)       || \
                                                     ((__FORMAT__) == I2S_DATAFORMAT_24B)                || \
                                                     ((__FORMAT__) == I2S_DATAFORMAT_32B))

Definition at line 609 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_FIRST_BIT (   __BIT__)
Value:
(((__BIT__) == I2S_FIRSTBIT_MSB)                     || \
                                                     ((__BIT__) == I2S_FIRSTBIT_LSB))

Definition at line 624 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_FULLDUPLEX (   __MODE__)
Value:
(((__MODE__) == I2S_MODE_MASTER_FULLDUPLEX)         || \
                                                     ((__MODE__) == I2S_MODE_SLAVE_FULLDUPLEX))

Definition at line 600 of file stm32h7xx_hal_i2s.h.

Referenced by I2S_Receive_16Bit_IT(), and I2S_Receive_32Bit_IT().

#define IS_I2S_MASTER (   __MODE__)
Value:
(((__MODE__) == I2S_MODE_MASTER_TX)                  || \
                                                     ((__MODE__) == I2S_MODE_MASTER_RX)                  || \
                                                     ((__MODE__) == I2S_MODE_MASTER_FULLDUPLEX))

Definition at line 592 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_DMAPause(), and HAL_I2S_Init().

#define IS_I2S_MASTER_KEEP_IO_STATE (   __AFCNTR__)
Value:
(((__AFCNTR__) == I2S_MASTER_KEEP_IO_STATE_DISABLE)  || \
                                                     ((__AFCNTR__) == I2S_MASTER_KEEP_IO_STATE_ENABLE))

Definition at line 633 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_MCLK_OUTPUT (   __OUTPUT__)
Value:
(((__OUTPUT__) == I2S_MCLKOUTPUT_ENABLE)             || \
                                                     ((__OUTPUT__) == I2S_MCLKOUTPUT_DISABLE))

Definition at line 614 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_MODE (   __MODE__)
Value:
(((__MODE__) == I2S_MODE_SLAVE_TX)                   || \
                                                     ((__MODE__) == I2S_MODE_SLAVE_RX)                   || \
                                                     ((__MODE__) == I2S_MODE_MASTER_TX)                  || \
                                                     ((__MODE__) == I2S_MODE_MASTER_RX)                  || \
                                                     ((__MODE__) == I2S_MODE_SLAVE_FULLDUPLEX)           || \
                                                     ((__MODE__) == I2S_MODE_MASTER_FULLDUPLEX))

Checks if I2S Mode parameter is in allowed range.

Parameters:
__MODE__specifies the I2S Mode. This parameter can be a value of I2S Mode
Return values:
None

Definition at line 585 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_SLAVE (   __MODE__)
Value:
(((__MODE__) == I2S_MODE_SLAVE_TX)                  || \
                                                     ((__MODE__) == I2S_MODE_SLAVE_RX)                  || \
                                                     ((__MODE__) == I2S_MODE_SLAVE_FULLDUPLEX))

Definition at line 596 of file stm32h7xx_hal_i2s.h.

#define IS_I2S_STANDARD (   __STANDARD__)
Value:
(((__STANDARD__) == I2S_STANDARD_PHILIPS)            || \
                                                     ((__STANDARD__) == I2S_STANDARD_MSB)                || \
                                                     ((__STANDARD__) == I2S_STANDARD_LSB)                || \
                                                     ((__STANDARD__) == I2S_STANDARD_PCM_SHORT)          || \
                                                     ((__STANDARD__) == I2S_STANDARD_PCM_LONG))

Definition at line 603 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_WS_INVERSION (   __WSINV__)
Value:
(((__WSINV__) == I2S_WS_INVERSION_DISABLE)           || \
                                                     ((__WSINV__) == I2S_WS_INVERSION_ENABLE))

Definition at line 627 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().