I2S Private Macros

Collaboration diagram for I2S Private Macros:

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

Detailed Description

Macro Definition Documentation

I2S_CHECK_FLAG

#define I2S_CHECK_FLAG	(		__SR__,
			__FLAG__ )

#include <stm32f4xx_hal_i2s.h>

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

SET

or RESET.

Definition at line 529 of file stm32f4xx_hal_i2s.h.

I2S_CHECK_IT_SOURCE

#define I2S_CHECK_IT_SOURCE	(		__CR2__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_i2s.h>

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

SET

or RESET.

Definition at line 541 of file stm32f4xx_hal_i2s.h.

IS_I2S_MODE

#define IS_I2S_MODE

(

__MODE__

)

#include <stm32f4xx_hal_i2s.h>

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

Referenced by HAL_I2S_Init().

IS_I2S_STANDARD

#define IS_I2S_STANDARD

(

__STANDARD__

)

#include <stm32f4xx_hal_i2s.h>

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

Referenced by HAL_I2S_Init().

IS_I2S_DATA_FORMAT

#define IS_I2S_DATA_FORMAT

(

__FORMAT__

)

#include <stm32f4xx_hal_i2s.h>

Value:

                                        (((__FORMAT__) == I2S_DATAFORMAT_16B)          || \
                                        ((__FORMAT__) == I2S_DATAFORMAT_16B_EXTENDED) || \
                                        ((__FORMAT__) == I2S_DATAFORMAT_24B)          || \
                                        ((__FORMAT__) == I2S_DATAFORMAT_32B))

Definition at line 560 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

IS_I2S_MCLK_OUTPUT

#define IS_I2S_MCLK_OUTPUT

(

__OUTPUT__

)

#include <stm32f4xx_hal_i2s.h>

Value:

                                        (((__OUTPUT__) == I2S_MCLKOUTPUT_ENABLE) || \
                                        ((__OUTPUT__) == I2S_MCLKOUTPUT_DISABLE))

Definition at line 565 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

IS_I2S_AUDIO_FREQ

#define IS_I2S_AUDIO_FREQ

(

__FREQ__

)

#include <stm32f4xx_hal_i2s.h>

Value:

                                      ((((__FREQ__) >= I2S_AUDIOFREQ_8K)    && \
                                      ((__FREQ__) <= I2S_AUDIOFREQ_192K)) || \
                                     ((__FREQ__) == I2S_AUDIOFREQ_DEFAULT))

Definition at line 568 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

IS_I2S_FULLDUPLEX_MODE

#define IS_I2S_FULLDUPLEX_MODE

(

MODE

)

#include <stm32f4xx_hal_i2s.h>

Value:

                                      (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
                                      ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))

Definition at line 572 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

IS_I2S_CPOL

#define IS_I2S_CPOL

(

__CPOL__

)

#include <stm32f4xx_hal_i2s.h>

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

Referenced by HAL_I2S_Init().

IS_I2S_CLOCKSOURCE

#define IS_I2S_CLOCKSOURCE

(

CLOCK

)

#include <stm32f4xx_hal_i2s.h>

Value:

                                   (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
                                   ((CLOCK) == I2S_CLOCK_PLL)      ||\
                                   ((CLOCK) == I2S_CLOCK_PLLSRC)   ||\
                                   ((CLOCK) == I2S_CLOCK_PLLR))

Definition at line 590 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().