RTEMS 6.1-rc1
Macros
SAI Private Macros
STM32H7xx_HAL_Driver | Board Support Packages » ARM » STM32H7 » SAI

Macros

#define IS_SAI_BLOCK_SYNCEXT(STATE)
 
#define IS_SAI_SUPPORTED_PROTOCOL(PROTOCOL)
 
#define IS_SAI_PROTOCOL_DATASIZE(DATASIZE)
 
#define IS_SAI_AUDIO_FREQUENCY(AUDIO)
 
#define IS_SAI_BLOCK_MCK_OVERSAMPLING(VALUE)
 
#define IS_SAI_PDM_MIC_PAIRS_NUMBER(VALUE)   ((1U <= (VALUE)) && ((VALUE) <= 3U))
 
#define IS_SAI_PDM_CLOCK_ENABLE(CLOCK)
 
#define IS_SAI_BLOCK_MODE(MODE)
 
#define IS_SAI_BLOCK_PROTOCOL(PROTOCOL)
 
#define IS_SAI_BLOCK_DATASIZE(DATASIZE)
 
#define IS_SAI_BLOCK_FIRST_BIT(BIT)
 
#define IS_SAI_BLOCK_CLOCK_STROBING(CLOCK)
 
#define IS_SAI_BLOCK_SYNCHRO(SYNCHRO)
 
#define IS_SAI_BLOCK_MCK_OUTPUT(VALUE)
 
#define IS_SAI_BLOCK_OUTPUT_DRIVE(DRIVE)
 
#define IS_SAI_BLOCK_NODIVIDER(NODIVIDER)
 
#define IS_SAI_BLOCK_MUTE_COUNTER(COUNTER)   ((COUNTER) <= 63U)
 
#define IS_SAI_BLOCK_MUTE_VALUE(VALUE)
 
#define IS_SAI_BLOCK_COMPANDING_MODE(MODE)
 
#define IS_SAI_BLOCK_FIFO_THRESHOLD(THRESHOLD)
 
#define IS_SAI_BLOCK_TRISTATE_MANAGEMENT(STATE)
 
#define IS_SAI_MONO_STEREO_MODE(MODE)
 
#define IS_SAI_SLOT_ACTIVE(ACTIVE)   ((ACTIVE) <= SAI_SLOTACTIVE_ALL)
 
#define IS_SAI_BLOCK_SLOT_NUMBER(NUMBER)   ((1U <= (NUMBER)) && ((NUMBER) <= 16U))
 
#define IS_SAI_BLOCK_SLOT_SIZE(SIZE)
 
#define IS_SAI_BLOCK_FIRSTBIT_OFFSET(OFFSET)   ((OFFSET) <= 24U)
 
#define IS_SAI_BLOCK_FS_OFFSET(OFFSET)
 
#define IS_SAI_BLOCK_FS_POLARITY(POLARITY)
 
#define IS_SAI_BLOCK_FS_DEFINITION(DEFINITION)
 
#define IS_SAI_BLOCK_MASTER_DIVIDER(DIVIDER)   ((DIVIDER) <= 63U)
 
#define IS_SAI_BLOCK_FRAME_LENGTH(LENGTH)   ((8U <= (LENGTH)) && ((LENGTH) <= 256U))
 
#define IS_SAI_BLOCK_ACTIVE_FRAME(LENGTH)   ((1U <= (LENGTH)) && ((LENGTH) <= 128U))
 

Detailed Description

Macro Definition Documentation

◆ IS_SAI_AUDIO_FREQUENCY

#define IS_SAI_AUDIO_FREQUENCY (   AUDIO)
Value:
(((AUDIO) == SAI_AUDIO_FREQUENCY_192K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_96K) || \
((AUDIO) == SAI_AUDIO_FREQUENCY_48K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_44K) || \
((AUDIO) == SAI_AUDIO_FREQUENCY_32K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_22K) || \
((AUDIO) == SAI_AUDIO_FREQUENCY_16K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_11K) || \
((AUDIO) == SAI_AUDIO_FREQUENCY_8K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_MCKDIV))

◆ IS_SAI_BLOCK_CLOCK_STROBING

#define IS_SAI_BLOCK_CLOCK_STROBING (   CLOCK)
Value:
(((CLOCK) == SAI_CLOCKSTROBING_FALLINGEDGE) || \
((CLOCK) == SAI_CLOCKSTROBING_RISINGEDGE))

◆ IS_SAI_BLOCK_COMPANDING_MODE

#define IS_SAI_BLOCK_COMPANDING_MODE (   MODE)
Value:
(((MODE) == SAI_NOCOMPANDING) || \
((MODE) == SAI_ULAW_1CPL_COMPANDING) || \
((MODE) == SAI_ALAW_1CPL_COMPANDING) || \
((MODE) == SAI_ULAW_2CPL_COMPANDING) || \
((MODE) == SAI_ALAW_2CPL_COMPANDING))

◆ IS_SAI_BLOCK_DATASIZE

#define IS_SAI_BLOCK_DATASIZE (   DATASIZE)
Value:
(((DATASIZE) == SAI_DATASIZE_8) || \
((DATASIZE) == SAI_DATASIZE_10) || \
((DATASIZE) == SAI_DATASIZE_16) || \
((DATASIZE) == SAI_DATASIZE_20) || \
((DATASIZE) == SAI_DATASIZE_24) || \
((DATASIZE) == SAI_DATASIZE_32))

◆ IS_SAI_BLOCK_FIFO_THRESHOLD

#define IS_SAI_BLOCK_FIFO_THRESHOLD (   THRESHOLD)
Value:
(((THRESHOLD) == SAI_FIFOTHRESHOLD_EMPTY) || \
((THRESHOLD) == SAI_FIFOTHRESHOLD_1QF) || \
((THRESHOLD) == SAI_FIFOTHRESHOLD_HF) || \
((THRESHOLD) == SAI_FIFOTHRESHOLD_3QF) || \
((THRESHOLD) == SAI_FIFOTHRESHOLD_FULL))

◆ IS_SAI_BLOCK_FIRST_BIT

#define IS_SAI_BLOCK_FIRST_BIT (   BIT)
Value:
(((BIT) == SAI_FIRSTBIT_MSB) || \
((BIT) == SAI_FIRSTBIT_LSB))

◆ IS_SAI_BLOCK_FS_DEFINITION

#define IS_SAI_BLOCK_FS_DEFINITION (   DEFINITION)
Value:
(((DEFINITION) == SAI_FS_STARTFRAME) || \
((DEFINITION) == SAI_FS_CHANNEL_IDENTIFICATION))

◆ IS_SAI_BLOCK_FS_OFFSET

#define IS_SAI_BLOCK_FS_OFFSET (   OFFSET)
Value:
(((OFFSET) == SAI_FS_FIRSTBIT) || \
((OFFSET) == SAI_FS_BEFOREFIRSTBIT))

◆ IS_SAI_BLOCK_FS_POLARITY

#define IS_SAI_BLOCK_FS_POLARITY (   POLARITY)
Value:
(((POLARITY) == SAI_FS_ACTIVE_LOW) || \
((POLARITY) == SAI_FS_ACTIVE_HIGH))

◆ IS_SAI_BLOCK_MCK_OUTPUT

#define IS_SAI_BLOCK_MCK_OUTPUT (   VALUE)
Value:
(((VALUE) == SAI_MCK_OUTPUT_ENABLE) || \
((VALUE) == SAI_MCK_OUTPUT_DISABLE))

◆ IS_SAI_BLOCK_MCK_OVERSAMPLING

#define IS_SAI_BLOCK_MCK_OVERSAMPLING (   VALUE)
Value:
(((VALUE) == SAI_MCK_OVERSAMPLING_DISABLE) || \
((VALUE) == SAI_MCK_OVERSAMPLING_ENABLE))

◆ IS_SAI_BLOCK_MODE

#define IS_SAI_BLOCK_MODE (   MODE)
Value:
(((MODE) == SAI_MODEMASTER_TX) || \
((MODE) == SAI_MODEMASTER_RX) || \
((MODE) == SAI_MODESLAVE_TX) || \
((MODE) == SAI_MODESLAVE_RX))

◆ IS_SAI_BLOCK_MUTE_VALUE

#define IS_SAI_BLOCK_MUTE_VALUE (   VALUE)
Value:
(((VALUE) == SAI_ZERO_VALUE) || \
((VALUE) == SAI_LAST_SENT_VALUE))

◆ IS_SAI_BLOCK_NODIVIDER

#define IS_SAI_BLOCK_NODIVIDER (   NODIVIDER)
Value:
(((NODIVIDER) == SAI_MASTERDIVIDER_ENABLE) || \
((NODIVIDER) == SAI_MASTERDIVIDER_DISABLE))

◆ IS_SAI_BLOCK_OUTPUT_DRIVE

#define IS_SAI_BLOCK_OUTPUT_DRIVE (   DRIVE)
Value:
(((DRIVE) == SAI_OUTPUTDRIVE_DISABLE) || \
((DRIVE) == SAI_OUTPUTDRIVE_ENABLE))

◆ IS_SAI_BLOCK_PROTOCOL

#define IS_SAI_BLOCK_PROTOCOL (   PROTOCOL)
Value:
(((PROTOCOL) == SAI_FREE_PROTOCOL) || \
((PROTOCOL) == SAI_AC97_PROTOCOL) || \
((PROTOCOL) == SAI_SPDIF_PROTOCOL))

◆ IS_SAI_BLOCK_SLOT_SIZE

#define IS_SAI_BLOCK_SLOT_SIZE (   SIZE)
Value:
(((SIZE) == SAI_SLOTSIZE_DATASIZE) || \
((SIZE) == SAI_SLOTSIZE_16B) || \
((SIZE) == SAI_SLOTSIZE_32B))

◆ IS_SAI_BLOCK_SYNCEXT

#define IS_SAI_BLOCK_SYNCEXT (   STATE)
Value:
(((STATE) == SAI_SYNCEXT_DISABLE) ||\
((STATE) == SAI_SYNCEXT_OUTBLOCKA_ENABLE) ||\
((STATE) == SAI_SYNCEXT_OUTBLOCKB_ENABLE))

◆ IS_SAI_BLOCK_SYNCHRO

#define IS_SAI_BLOCK_SYNCHRO (   SYNCHRO)
Value:
(((SYNCHRO) == SAI_ASYNCHRONOUS) || \
((SYNCHRO) == SAI_SYNCHRONOUS) || \
((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) || \
((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI4))
SAI_SYNCHRONOUS_EXT_SAI1
#define SAI_SYNCHRONOUS_EXT_SAI1
Definition: stm32h7xx_hal_sai.h:465
SAI_SYNCHRONOUS
#define SAI_SYNCHRONOUS
Definition: stm32h7xx_hal_sai.h:464
SAI_ASYNCHRONOUS
#define SAI_ASYNCHRONOUS
Definition: stm32h7xx_hal_sai.h:463

◆ IS_SAI_BLOCK_TRISTATE_MANAGEMENT

#define IS_SAI_BLOCK_TRISTATE_MANAGEMENT (   STATE)
Value:
(((STATE) == SAI_OUTPUT_NOTRELEASED) ||\
((STATE) == SAI_OUTPUT_RELEASED))

◆ IS_SAI_MONO_STEREO_MODE

#define IS_SAI_MONO_STEREO_MODE (   MODE)
Value:
(((MODE) == SAI_MONOMODE) ||\
((MODE) == SAI_STEREOMODE))

◆ IS_SAI_PDM_CLOCK_ENABLE

#define IS_SAI_PDM_CLOCK_ENABLE (   CLOCK)
Value:
(((CLOCK) != 0U) && \
(((CLOCK) & ~(SAI_PDM_CLOCK1_ENABLE | SAI_PDM_CLOCK2_ENABLE)) == 0U))

◆ IS_SAI_PROTOCOL_DATASIZE

#define IS_SAI_PROTOCOL_DATASIZE (   DATASIZE)
Value:
(((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BIT) ||\
((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BITEXTENDED) ||\
((DATASIZE) == SAI_PROTOCOL_DATASIZE_24BIT) ||\
((DATASIZE) == SAI_PROTOCOL_DATASIZE_32BIT))

◆ IS_SAI_SUPPORTED_PROTOCOL

#define IS_SAI_SUPPORTED_PROTOCOL (   PROTOCOL)
Value:
(((PROTOCOL) == SAI_I2S_STANDARD) ||\
((PROTOCOL) == SAI_I2S_MSBJUSTIFIED) ||\
((PROTOCOL) == SAI_I2S_LSBJUSTIFIED) ||\
((PROTOCOL) == SAI_PCM_LONG) ||\
((PROTOCOL) == SAI_PCM_SHORT))
Generated by doxygen 1.9.4