STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
SAI_Private_Macros
Collaboration diagram for SAI_Private_Macros:

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_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_OUTPUT_DRIVE(DRIVE)
 
#define IS_SAI_BLOCK_NODIVIDER(NODIVIDER)
 
#define IS_SAI_BLOCK_MUTE_COUNTER(COUNTER)
 
#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)
 
#define IS_SAI_BLOCK_SLOT_NUMBER(NUMBER)
 
#define IS_SAI_BLOCK_SLOT_SIZE(SIZE)
 
#define IS_SAI_BLOCK_FIRSTBIT_OFFSET(OFFSET)
 
#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)
 
#define IS_SAI_BLOCK_FRAME_LENGTH(LENGTH)
 
#define IS_SAI_BLOCK_ACTIVE_FRAME(LENGTH)
 

Detailed Description

Macro Definition Documentation

◆ IS_SAI_BLOCK_SYNCEXT

#define IS_SAI_BLOCK_SYNCEXT ( STATE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 765 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_SUPPORTED_PROTOCOL

#define IS_SAI_SUPPORTED_PROTOCOL ( PROTOCOL)

#include <stm32f4xx_hal_sai.h>

Value:
(((PROTOCOL) == SAI_I2S_STANDARD) ||\
((PROTOCOL) == SAI_I2S_MSBJUSTIFIED) ||\
((PROTOCOL) == SAI_I2S_LSBJUSTIFIED) ||\
((PROTOCOL) == SAI_PCM_LONG) ||\
((PROTOCOL) == SAI_PCM_SHORT))
#define SAI_I2S_LSBJUSTIFIED
#define SAI_PCM_SHORT
#define SAI_I2S_MSBJUSTIFIED
#define SAI_PCM_LONG
#define SAI_I2S_STANDARD

Definition at line 769 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_InitProtocol().

◆ IS_SAI_PROTOCOL_DATASIZE

#define IS_SAI_PROTOCOL_DATASIZE ( DATASIZE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 775 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_InitProtocol().

◆ IS_SAI_AUDIO_FREQUENCY

#define IS_SAI_AUDIO_FREQUENCY ( AUDIO)

#include <stm32f4xx_hal_sai.h>

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))
#define SAI_AUDIO_FREQUENCY_48K
#define SAI_AUDIO_FREQUENCY_16K
#define SAI_AUDIO_FREQUENCY_22K
#define SAI_AUDIO_FREQUENCY_44K
#define SAI_AUDIO_FREQUENCY_11K
#define SAI_AUDIO_FREQUENCY_32K
#define SAI_AUDIO_FREQUENCY_8K
#define SAI_AUDIO_FREQUENCY_MCKDIV
#define SAI_AUDIO_FREQUENCY_96K
#define SAI_AUDIO_FREQUENCY_192K

Definition at line 780 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_MODE

#define IS_SAI_BLOCK_MODE ( MODE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 786 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_PROTOCOL

#define IS_SAI_BLOCK_PROTOCOL ( PROTOCOL)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 791 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_DATASIZE

#define IS_SAI_BLOCK_DATASIZE ( DATASIZE)

#include <stm32f4xx_hal_sai.h>

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))
#define SAI_DATASIZE_16
#define SAI_DATASIZE_10
#define SAI_DATASIZE_32
#define SAI_DATASIZE_20
#define SAI_DATASIZE_24
#define SAI_DATASIZE_8

Definition at line 795 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FIRST_BIT

#define IS_SAI_BLOCK_FIRST_BIT ( BIT)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 802 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_CLOCK_STROBING

#define IS_SAI_BLOCK_CLOCK_STROBING ( CLOCK)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 805 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_SYNCHRO

#define IS_SAI_BLOCK_SYNCHRO ( SYNCHRO)

#include <stm32f4xx_hal_sai.h>

Value:
(((SYNCHRO) == SAI_ASYNCHRONOUS) || \
((SYNCHRO) == SAI_SYNCHRONOUS) || \
((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) ||\
((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI2))
#define SAI_SYNCHRONOUS_EXT_SAI1
#define SAI_SYNCHRONOUS
#define SAI_ASYNCHRONOUS
#define SAI_SYNCHRONOUS_EXT_SAI2

Definition at line 808 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_OUTPUT_DRIVE

#define IS_SAI_BLOCK_OUTPUT_DRIVE ( DRIVE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 813 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_NODIVIDER

#define IS_SAI_BLOCK_NODIVIDER ( NODIVIDER)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 816 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_MUTE_COUNTER

#define IS_SAI_BLOCK_MUTE_COUNTER ( COUNTER)

#include <stm32f4xx_hal_sai.h>

Value:
((COUNTER) <= 63U)

Definition at line 819 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_EnableRxMuteMode().

◆ IS_SAI_BLOCK_MUTE_VALUE

#define IS_SAI_BLOCK_MUTE_VALUE ( VALUE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 821 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_EnableTxMuteMode().

◆ IS_SAI_BLOCK_COMPANDING_MODE

#define IS_SAI_BLOCK_COMPANDING_MODE ( MODE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 824 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FIFO_THRESHOLD

#define IS_SAI_BLOCK_FIFO_THRESHOLD ( THRESHOLD)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 830 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_TRISTATE_MANAGEMENT

#define IS_SAI_BLOCK_TRISTATE_MANAGEMENT ( STATE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 836 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_MONO_STEREO_MODE

#define IS_SAI_MONO_STEREO_MODE ( MODE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 839 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_SLOT_ACTIVE

#define IS_SAI_SLOT_ACTIVE ( ACTIVE)

#include <stm32f4xx_hal_sai.h>

Value:
((ACTIVE) <= SAI_SLOTACTIVE_ALL)
#define SAI_SLOTACTIVE_ALL

Definition at line 842 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_SLOT_NUMBER

#define IS_SAI_BLOCK_SLOT_NUMBER ( NUMBER)

#include <stm32f4xx_hal_sai.h>

Value:
((1U <= (NUMBER)) && ((NUMBER) <= 16U))

Definition at line 844 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_SLOT_SIZE

#define IS_SAI_BLOCK_SLOT_SIZE ( SIZE)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 846 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FIRSTBIT_OFFSET

#define IS_SAI_BLOCK_FIRSTBIT_OFFSET ( OFFSET)

#include <stm32f4xx_hal_sai.h>

Value:
((OFFSET) <= 24U)

Definition at line 850 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FS_OFFSET

#define IS_SAI_BLOCK_FS_OFFSET ( OFFSET)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 852 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FS_POLARITY

#define IS_SAI_BLOCK_FS_POLARITY ( POLARITY)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 855 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FS_DEFINITION

#define IS_SAI_BLOCK_FS_DEFINITION ( DEFINITION)

#include <stm32f4xx_hal_sai.h>

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

Definition at line 858 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_MASTER_DIVIDER

#define IS_SAI_BLOCK_MASTER_DIVIDER ( DIVIDER)

#include <stm32f4xx_hal_sai.h>

Value:
((DIVIDER) <= 15U)

Definition at line 861 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_FRAME_LENGTH

#define IS_SAI_BLOCK_FRAME_LENGTH ( LENGTH)

#include <stm32f4xx_hal_sai.h>

Value:
((8U <= (LENGTH)) && ((LENGTH) <= 256U))

Definition at line 863 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ IS_SAI_BLOCK_ACTIVE_FRAME

#define IS_SAI_BLOCK_ACTIVE_FRAME ( LENGTH)

#include <stm32f4xx_hal_sai.h>

Value:
((1U <= (LENGTH)) && ((LENGTH) <= 128U))

Definition at line 865 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().