STM32F479xx 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(__CR2__, __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_STANDARD(__STANDARD__)
#define IS_I2S_DATA_FORMAT(__FORMAT__)
#define IS_I2S_MCLK_OUTPUT(__OUTPUT__)
#define IS_I2S_AUDIO_FREQ(__FREQ__)
#define IS_I2S_FULLDUPLEX_MODE(MODE)
#define IS_I2S_CPOL(__CPOL__)
 Checks if I2S Serial clock steady state parameter is in allowed range.
#define IS_I2S_CLOCKSOURCE(CLOCK)

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_RXNE: Receive buffer not empty flag
  • I2S_FLAG_TXE: Transmit buffer empty flag
  • I2S_FLAG_UDR: Underrun error flag
  • I2S_FLAG_OVR: Overrun flag
  • I2S_FLAG_CHSIDE: Channel side flag
  • I2S_FLAG_BSY: Busy flag
Return values:
SETor RESET.

Definition at line 530 of file stm32f4xx_hal_i2s.h.

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

Check whether the specified SPI Interrupt is set or not.

Parameters:
__CR2__copy of I2S CR2 register.
__INTERRUPT__specifies the SPI 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:
SETor RESET.

Definition at line 542 of file stm32f4xx_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 569 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_CLOCKSOURCE (   CLOCK)
Value:
(((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
                                   ((CLOCK) == I2S_CLOCK_PLL))

Definition at line 585 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

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

Checks if I2S Serial clock steady state parameter is in allowed range.

Parameters:
__CPOL__specifies the I2S serial clock steady state. This parameter can be a value of I2S Clock Polarity
Return values:
None

Definition at line 581 of file stm32f4xx_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 561 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#define IS_I2S_FULLDUPLEX_MODE (   MODE)
Value:

Definition at line 573 of file stm32f4xx_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 566 of file stm32f4xx_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))

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 550 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

#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 555 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().