Classes | Macros | Typedefs | Enumerations | Functions
stm32f7xx_hal_sai.h File Reference

Header file of SAI HAL module. More...

#include "stm32f7xx_hal_def.h"
Include dependency graph for stm32f7xx_hal_sai.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  __SAI_HandleTypeDef
 
struct  SAI_FrameInitTypeDef
 
struct  SAI_InitTypeDef
 
struct  SAI_SlotInitTypeDef
 

Macros

#define __HAL_SAI_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->CLRFR = (__FLAG__))
 Clear the specified SAI pending flag. More...
 
#define __HAL_SAI_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 &= ~SAI_xCR1_SAIEN)
 
#define __HAL_SAI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IMR &= (~(__INTERRUPT__)))
 
#define __HAL_SAI_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 |= SAI_xCR1_SAIEN)
 
#define __HAL_SAI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
 Enable or disable the specified SAI interrupts. More...
 
#define __HAL_SAI_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 Check whether the specified SAI flag is set or not. More...
 
#define __HAL_SAI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((__HANDLE__)->Instance->IMR & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
 Check whether the specified SAI interrupt source is enabled or not. More...
 
#define __HAL_SAI_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_SAI_STATE_RESET)
 Reset SAI handle state. More...
 
#define HAL_SAI_ERROR_AFSDET   ((uint32_t)0x00000004U)
 
#define HAL_SAI_ERROR_CNREADY   ((uint32_t)0x00000010U)
 
#define HAL_SAI_ERROR_DMA   ((uint32_t)0x00000080U)
 
#define HAL_SAI_ERROR_LFSDET   ((uint32_t)0x00000008U)
 
#define HAL_SAI_ERROR_NONE   ((uint32_t)0x00000000U)
 
#define HAL_SAI_ERROR_OVR   ((uint32_t)0x00000001U)
 
#define HAL_SAI_ERROR_TIMEOUT   ((uint32_t)0x00000040U)
 
#define HAL_SAI_ERROR_UDR   ((uint32_t)0x00000002U)
 
#define HAL_SAI_ERROR_WCKCFG   ((uint32_t)0x00000020U)
 
#define IS_SAI_AUDIO_FREQUENCY(AUDIO)
 
#define IS_SAI_BLOCK_ACTIVE_FRAME(LENGTH)   ((1 <= (LENGTH)) && ((LENGTH) <= 128))
 
#define IS_SAI_BLOCK_CLOCK_STROBING(CLOCK)
 
#define IS_SAI_BLOCK_COMPANDING_MODE(MODE)
 
#define IS_SAI_BLOCK_DATASIZE(DATASIZE)
 
#define IS_SAI_BLOCK_FIFO_THRESHOLD(THRESHOLD)
 
#define IS_SAI_BLOCK_FIRST_BIT(BIT)
 
#define IS_SAI_BLOCK_FIRSTBIT_OFFSET(OFFSET)   ((OFFSET) <= 24)
 
#define IS_SAI_BLOCK_FRAME_LENGTH(LENGTH)   ((8 <= (LENGTH)) && ((LENGTH) <= 256))
 
#define IS_SAI_BLOCK_FS_DEFINITION(DEFINITION)
 
#define IS_SAI_BLOCK_FS_OFFSET(OFFSET)
 
#define IS_SAI_BLOCK_FS_POLARITY(POLARITY)
 
#define IS_SAI_BLOCK_MASTER_DIVIDER(DIVIDER)   ((DIVIDER) <= 15U)
 
#define IS_SAI_BLOCK_MODE(MODE)
 
#define IS_SAI_BLOCK_MUTE_COUNTER(COUNTER)   ((COUNTER) <= 63)
 
#define IS_SAI_BLOCK_MUTE_VALUE(VALUE)
 
#define IS_SAI_BLOCK_NODIVIDER(NODIVIDER)
 
#define IS_SAI_BLOCK_OUTPUT_DRIVE(DRIVE)
 
#define IS_SAI_BLOCK_PROTOCOL(PROTOCOL)
 
#define IS_SAI_BLOCK_SLOT_NUMBER(NUMBER)   ((1 <= (NUMBER)) && ((NUMBER) <= 16))
 
#define IS_SAI_BLOCK_SLOT_SIZE(SIZE)
 
#define IS_SAI_BLOCK_SYNCEXT(STATE)
 
#define IS_SAI_BLOCK_SYNCHRO(SYNCHRO)
 
#define IS_SAI_BLOCK_TRISTATE_MANAGEMENT(STATE)
 
#define IS_SAI_MONO_STEREO_MODE(MODE)
 
#define IS_SAI_PROTOCOL_DATASIZE(DATASIZE)
 
#define IS_SAI_SLOT_ACTIVE(ACTIVE)   ((ACTIVE) <= SAI_SLOTACTIVE_ALL)
 
#define IS_SAI_SUPPORTED_PROTOCOL(PROTOCOL)
 
#define SAI_AC97_PROTOCOL   ((uint32_t)SAI_xCR1_PRTCFG_1)
 
#define SAI_ALAW_1CPL_COMPANDING   ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0))
 
#define SAI_ALAW_2CPL_COMPANDING   ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0 | SAI_xCR2_CPL))
 
#define SAI_ASYNCHRONOUS   0
 
#define SAI_AUDIO_FREQUENCY_11K   ((uint32_t)11025U)
 
#define SAI_AUDIO_FREQUENCY_16K   ((uint32_t)16000U)
 
#define SAI_AUDIO_FREQUENCY_192K   ((uint32_t)192000U)
 
#define SAI_AUDIO_FREQUENCY_22K   ((uint32_t)22050U)
 
#define SAI_AUDIO_FREQUENCY_32K   ((uint32_t)32000U)
 
#define SAI_AUDIO_FREQUENCY_44K   ((uint32_t)44100U)
 
#define SAI_AUDIO_FREQUENCY_48K   ((uint32_t)48000U)
 
#define SAI_AUDIO_FREQUENCY_8K   ((uint32_t)8000U)
 
#define SAI_AUDIO_FREQUENCY_96K   ((uint32_t)96000U)
 
#define SAI_AUDIO_FREQUENCY_MCKDIV   ((uint32_t)0U)
 
#define SAI_CLOCKSTROBING_FALLINGEDGE   0
 
#define SAI_CLOCKSTROBING_RISINGEDGE   1
 
#define SAI_DATASIZE_10   ((uint32_t)(SAI_xCR1_DS_1 | SAI_xCR1_DS_0))
 
#define SAI_DATASIZE_16   ((uint32_t)SAI_xCR1_DS_2)
 
#define SAI_DATASIZE_20   ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_0))
 
#define SAI_DATASIZE_24   ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_1))
 
#define SAI_DATASIZE_32   ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_1 | SAI_xCR1_DS_0))
 
#define SAI_DATASIZE_8   ((uint32_t)SAI_xCR1_DS_1)
 
#define SAI_FIFOSTATUS_1QUARTERFULL   ((uint32_t)0x00020000U)
 
#define SAI_FIFOSTATUS_3QUARTERFULL   ((uint32_t)0x00040000U)
 
#define SAI_FIFOSTATUS_EMPTY   ((uint32_t)0x00000000U)
 
#define SAI_FIFOSTATUS_FULL   ((uint32_t)0x00050000U)
 
#define SAI_FIFOSTATUS_HALFFULL   ((uint32_t)0x00030000U)
 
#define SAI_FIFOSTATUS_LESS1QUARTERFULL   ((uint32_t)0x00010000U)
 
#define SAI_FIFOTHRESHOLD_1QF   ((uint32_t)(SAI_xCR2_FTH_0))
 
#define SAI_FIFOTHRESHOLD_3QF   ((uint32_t)(SAI_xCR2_FTH_1 | SAI_xCR2_FTH_0))
 
#define SAI_FIFOTHRESHOLD_EMPTY   ((uint32_t)0x00000000U)
 
#define SAI_FIFOTHRESHOLD_FULL   ((uint32_t)(SAI_xCR2_FTH_2))
 
#define SAI_FIFOTHRESHOLD_HF   ((uint32_t)(SAI_xCR2_FTH_1))
 
#define SAI_FIRSTBIT_LSB   ((uint32_t)SAI_xCR1_LSBFIRST)
 
#define SAI_FIRSTBIT_MSB   ((uint32_t)0x00000000U)
 
#define SAI_FLAG_AFSDET   ((uint32_t)SAI_xSR_AFSDET)
 
#define SAI_FLAG_CNRDY   ((uint32_t)SAI_xSR_CNRDY)
 
#define SAI_FLAG_FREQ   ((uint32_t)SAI_xSR_FREQ)
 
#define SAI_FLAG_LFSDET   ((uint32_t)SAI_xSR_LFSDET)
 
#define SAI_FLAG_MUTEDET   ((uint32_t)SAI_xSR_MUTEDET)
 
#define SAI_FLAG_OVRUDR   ((uint32_t)SAI_xSR_OVRUDR)
 
#define SAI_FLAG_WCKCFG   ((uint32_t)SAI_xSR_WCKCFG)
 
#define SAI_FREE_PROTOCOL   ((uint32_t)0x00000000U)
 
#define SAI_FS_ACTIVE_HIGH   ((uint32_t)SAI_xFRCR_FSPOL)
 
#define SAI_FS_ACTIVE_LOW   ((uint32_t)0x00000000U)
 
#define SAI_FS_BEFOREFIRSTBIT   ((uint32_t)SAI_xFRCR_FSOFF)
 
#define SAI_FS_CHANNEL_IDENTIFICATION   ((uint32_t)SAI_xFRCR_FSDEF)
 
#define SAI_FS_FIRSTBIT   ((uint32_t)0x00000000U)
 
#define SAI_FS_STARTFRAME   ((uint32_t)0x00000000U)
 
#define SAI_I2S_LSBJUSTIFIED   2
 
#define SAI_I2S_MSBJUSTIFIED   1
 
#define SAI_I2S_STANDARD   0
 
#define SAI_IT_AFSDET   ((uint32_t)SAI_xIMR_AFSDETIE)
 
#define SAI_IT_CNRDY   ((uint32_t)SAI_xIMR_CNRDYIE)
 
#define SAI_IT_FREQ   ((uint32_t)SAI_xIMR_FREQIE)
 
#define SAI_IT_LFSDET   ((uint32_t)SAI_xIMR_LFSDETIE)
 
#define SAI_IT_MUTEDET   ((uint32_t)SAI_xIMR_MUTEDETIE)
 
#define SAI_IT_OVRUDR   ((uint32_t)SAI_xIMR_OVRUDRIE)
 
#define SAI_IT_WCKCFG   ((uint32_t)SAI_xIMR_WCKCFGIE)
 
#define SAI_LAST_SENT_VALUE   ((uint32_t)SAI_xCR2_MUTEVAL)
 
#define SAI_MASTERDIVIDER_DISABLE   ((uint32_t)SAI_xCR1_NODIV)
 
#define SAI_MASTERDIVIDER_ENABLE   ((uint32_t)0x00000000U)
 
#define SAI_MODEMASTER_RX   ((uint32_t)SAI_xCR1_MODE_0)
 
#define SAI_MODEMASTER_TX   ((uint32_t)0x00000000U)
 
#define SAI_MODESLAVE_RX   ((uint32_t)(SAI_xCR1_MODE_1 | SAI_xCR1_MODE_0))
 
#define SAI_MODESLAVE_TX   ((uint32_t)SAI_xCR1_MODE_1)
 
#define SAI_MONOMODE   ((uint32_t)SAI_xCR1_MONO)
 
#define SAI_NOCOMPANDING   ((uint32_t)0x00000000U)
 
#define SAI_OUTPUT_NOTRELEASED   ((uint32_t)0x00000000U)
 
#define SAI_OUTPUT_RELEASED   ((uint32_t)SAI_xCR2_TRIS)
 
#define SAI_OUTPUTDRIVE_DISABLE   ((uint32_t)0x00000000U)
 
#define SAI_OUTPUTDRIVE_ENABLE   ((uint32_t)SAI_xCR1_OUTDRIV)
 
#define SAI_PCM_LONG   3
 
#define SAI_PCM_SHORT   4
 
#define SAI_PROTOCOL_DATASIZE_16BIT   0
 
#define SAI_PROTOCOL_DATASIZE_16BITEXTENDED   1
 
#define SAI_PROTOCOL_DATASIZE_24BIT   2
 
#define SAI_PROTOCOL_DATASIZE_32BIT   3
 
#define SAI_SLOT_NOTACTIVE   ((uint32_t)0x00000000U)
 
#define SAI_SLOTACTIVE_0   ((uint32_t)0x00000001U)
 
#define SAI_SLOTACTIVE_1   ((uint32_t)0x00000002U)
 
#define SAI_SLOTACTIVE_10   ((uint32_t)0x00000400U)
 
#define SAI_SLOTACTIVE_11   ((uint32_t)0x00000800U)
 
#define SAI_SLOTACTIVE_12   ((uint32_t)0x00001000U)
 
#define SAI_SLOTACTIVE_13   ((uint32_t)0x00002000U)
 
#define SAI_SLOTACTIVE_14   ((uint32_t)0x00004000U)
 
#define SAI_SLOTACTIVE_15   ((uint32_t)0x00008000U)
 
#define SAI_SLOTACTIVE_2   ((uint32_t)0x00000004U)
 
#define SAI_SLOTACTIVE_3   ((uint32_t)0x00000008U)
 
#define SAI_SLOTACTIVE_4   ((uint32_t)0x00000010U)
 
#define SAI_SLOTACTIVE_5   ((uint32_t)0x00000020U)
 
#define SAI_SLOTACTIVE_6   ((uint32_t)0x00000040U)
 
#define SAI_SLOTACTIVE_7   ((uint32_t)0x00000080U)
 
#define SAI_SLOTACTIVE_8   ((uint32_t)0x00000100U)
 
#define SAI_SLOTACTIVE_9   ((uint32_t)0x00000200U)
 
#define SAI_SLOTACTIVE_ALL   ((uint32_t)0x0000FFFFU)
 
#define SAI_SLOTSIZE_16B   ((uint32_t)SAI_xSLOTR_SLOTSZ_0)
 
#define SAI_SLOTSIZE_32B   ((uint32_t)SAI_xSLOTR_SLOTSZ_1)
 
#define SAI_SLOTSIZE_DATASIZE   ((uint32_t)0x00000000U)
 
#define SAI_SPDIF_PROTOCOL   ((uint32_t)SAI_xCR1_PRTCFG_0)
 
#define SAI_STEREOMODE   ((uint32_t)0x00000000U)
 
#define SAI_SYNCEXT_DISABLE   0
 
#define SAI_SYNCEXT_OUTBLOCKA_ENABLE   1
 
#define SAI_SYNCEXT_OUTBLOCKB_ENABLE   2
 
#define SAI_SYNCHRONOUS   1
 
#define SAI_SYNCHRONOUS_EXT_SAI1   2
 
#define SAI_SYNCHRONOUS_EXT_SAI2   3
 
#define SAI_ULAW_1CPL_COMPANDING   ((uint32_t)(SAI_xCR2_COMP_1))
 
#define SAI_ULAW_2CPL_COMPANDING   ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_CPL))
 
#define SAI_ZERO_VALUE   ((uint32_t)0x00000000U)
 

Typedefs

typedef struct __SAI_HandleTypeDef SAI_HandleTypeDef
 
typedef void(* SAIcallback) (void)
 SAI Callback prototype. More...
 

Enumerations

enum  HAL_SAI_StateTypeDef {
  HAL_SAI_STATE_RESET = 0x00U, HAL_SAI_STATE_READY = 0x01U, HAL_SAI_STATE_BUSY = 0x02U, HAL_SAI_STATE_BUSY_TX = 0x12U,
  HAL_SAI_STATE_BUSY_RX = 0x22U, HAL_SAI_STATE_RESET = 0x00U, HAL_SAI_STATE_READY = 0x01U, HAL_SAI_STATE_BUSY = 0x02U,
  HAL_SAI_STATE_BUSY_TX = 0x12U, HAL_SAI_STATE_BUSY_RX = 0x22U, HAL_SAI_STATE_RESET = 0x00U, HAL_SAI_STATE_READY = 0x01U,
  HAL_SAI_STATE_BUSY = 0x02U, HAL_SAI_STATE_BUSY_TX = 0x12U, HAL_SAI_STATE_BUSY_RX = 0x22U
}
 HAL State structures definition. More...
 

Functions

HAL_StatusTypeDef HAL_SAI_Abort (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_DeInit (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_DMAPause (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_DMAResume (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_DMAStop (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode (SAI_HandleTypeDef *hsai, SAIcallback callback, uint16_t counter)
 
HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode (SAI_HandleTypeDef *hsai, uint16_t val)
 
void HAL_SAI_ErrorCallback (SAI_HandleTypeDef *hsai)
 SAI error callbacks. More...
 
uint32_t HAL_SAI_GetError (SAI_HandleTypeDef *hsai)
 
HAL_SAI_StateTypeDef HAL_SAI_GetState (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_Init (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_InitProtocol (SAI_HandleTypeDef *hsai, uint32_t protocol, uint32_t datasize, uint32_t nbslot)
 
void HAL_SAI_IRQHandler (SAI_HandleTypeDef *hsai)
 
void HAL_SAI_MspDeInit (SAI_HandleTypeDef *hsai)
 
void HAL_SAI_MspInit (SAI_HandleTypeDef *hsai)
 
HAL_StatusTypeDef HAL_SAI_Receive (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_SAI_Receive_DMA (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SAI_Receive_IT (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 
void HAL_SAI_RxCpltCallback (SAI_HandleTypeDef *hsai)
 Reception complete callback. More...
 
void HAL_SAI_RxHalfCpltCallback (SAI_HandleTypeDef *hsai)
 Half reception complete callback. More...
 
HAL_StatusTypeDef HAL_SAI_Transmit (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_SAI_Transmit_DMA (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SAI_Transmit_IT (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 
void HAL_SAI_TxCpltCallback (SAI_HandleTypeDef *hsai)
 Tx Transfer completed callbacks. More...
 
void HAL_SAI_TxHalfCpltCallback (SAI_HandleTypeDef *hsai)
 Tx Half Transfer completed callbacks. More...
 

Detailed Description

Header file of SAI HAL module.

Author
MCD Application Team
Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32f7xx_hal_sai.h.


picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:15:02