Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

Functions
HAL_StatusTypeDef	HAL_SAI_InitProtocol (SAI_HandleTypeDef *hsai, uint32_t protocol, uint32_t datasize, uint32_t nbslot)
	Initialize the structure FrameInit, SlotInit and the low part of Init according to the specified parameters and call the function HAL_SAI_Init to initialize the SAI block.
HAL_StatusTypeDef	HAL_SAI_Init (SAI_HandleTypeDef *hsai)
	Initialize the SAI according to the specified parameters. in the SAI_InitTypeDef structure and initialize the associated handle.
HAL_StatusTypeDef	HAL_SAI_DeInit (SAI_HandleTypeDef *hsai)
	DeInitialize the SAI peripheral.
void	HAL_SAI_MspInit (SAI_HandleTypeDef *hsai)
	Initialize the SAI MSP.
void	HAL_SAI_MspDeInit (SAI_HandleTypeDef *hsai)
	DeInitialize the SAI MSP.

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
            ##### Initialization and de-initialization functions #####
 ===============================================================================
  [..]  This subsection provides a set of functions allowing to initialize and
        de-initialize the SAIx peripheral:

      (+) User must implement HAL_SAI_MspInit() function in which he configures
          all related peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).

      (+) Call the function HAL_SAI_Init() to configure the selected device with
          the selected configuration:
        (++) Mode (Master/slave TX/RX)
        (++) Protocol
        (++) Data Size
        (++) MCLK Output
        (++) Audio frequency
        (++) FIFO Threshold
        (++) Frame Config
        (++) Slot Config

      (+) Call the function HAL_SAI_DeInit() to restore the default configuration
          of the selected SAI peripheral.

Function Documentation

HAL_SAI_InitProtocol()

HAL_StatusTypeDef HAL_SAI_InitProtocol	(	SAI_HandleTypeDef *	hsai,
		uint32_t	protocol,
		uint32_t	datasize,
		uint32_t	nbslot )

#include <stm32f4xx_hal_sai.h>

Initialize the structure FrameInit, SlotInit and the low part of Init according to the specified parameters and call the function HAL_SAI_Init to initialize the SAI block.

Parameters

hsai	pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
protocol	one of the supported protocol SAI Supported protocol
datasize	one of the supported datasize SAI protocol data size the configuration information for SAI module.
nbslot	Number of slot.

Return values

HAL

status

Definition at line 333 of file stm32f4xx_hal_sai.c.

References assert_param, HAL_ERROR, HAL_OK, HAL_SAI_Init(), IS_SAI_PROTOCOL_DATASIZE, IS_SAI_SUPPORTED_PROTOCOL, SAI_I2S_LSBJUSTIFIED, SAI_I2S_MSBJUSTIFIED, SAI_I2S_STANDARD, SAI_InitI2S(), SAI_InitPCM(), SAI_PCM_LONG, and SAI_PCM_SHORT.

HAL_SAI_Init()

HAL_StatusTypeDef HAL_SAI_Init

(

SAI_HandleTypeDef *

hsai

)

#include <stm32f4xx_hal_sai.h>

Initialize the SAI according to the specified parameters. in the SAI_InitTypeDef structure and initialize the associated handle.

Parameters

hsai	pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.

Return values

HAL

status

Definition at line 372 of file stm32f4xx_hal_sai.c.

References __HAL_UNLOCK, SAI_FrameInitTypeDef::ActiveFrameLength, assert_param, SAI_InitTypeDef::AudioFrequency, SAI_InitTypeDef::AudioMode, SAI_InitTypeDef::ClockStrobing, SAI_InitTypeDef::CompandingMode, SAI_InitTypeDef::DataSize, __SAI_HandleTypeDef::ErrorCode, SAI_InitTypeDef::FIFOThreshold, SAI_InitTypeDef::FirstBit, SAI_SlotInitTypeDef::FirstBitOffset, __SAI_HandleTypeDef::FrameInit, SAI_FrameInitTypeDef::FrameLength, SAI_FrameInitTypeDef::FSDefinition, SAI_FrameInitTypeDef::FSOffset, SAI_FrameInitTypeDef::FSPolarity, HAL_ERROR, HAL_OK, HAL_SAI_ERROR_NONE, HAL_SAI_ErrorCallback(), HAL_SAI_MspInit(), HAL_SAI_RxCpltCallback(), HAL_SAI_RxHalfCpltCallback(), HAL_SAI_STATE_BUSY, HAL_SAI_STATE_READY, HAL_SAI_STATE_RESET, HAL_SAI_TxCpltCallback(), HAL_SAI_TxHalfCpltCallback(), HAL_UNLOCKED, __SAI_HandleTypeDef::Init, __SAI_HandleTypeDef::Instance, IS_SAI_AUDIO_FREQUENCY, IS_SAI_BLOCK_ACTIVE_FRAME, IS_SAI_BLOCK_CLOCK_STROBING, IS_SAI_BLOCK_COMPANDING_MODE, IS_SAI_BLOCK_DATASIZE, IS_SAI_BLOCK_FIFO_THRESHOLD, IS_SAI_BLOCK_FIRST_BIT, IS_SAI_BLOCK_FIRSTBIT_OFFSET, IS_SAI_BLOCK_FRAME_LENGTH, IS_SAI_BLOCK_FS_DEFINITION, IS_SAI_BLOCK_FS_OFFSET, IS_SAI_BLOCK_FS_POLARITY, IS_SAI_BLOCK_MASTER_DIVIDER, IS_SAI_BLOCK_MODE, IS_SAI_BLOCK_NODIVIDER, IS_SAI_BLOCK_OUTPUT_DRIVE, IS_SAI_BLOCK_PROTOCOL, IS_SAI_BLOCK_SLOT_NUMBER, IS_SAI_BLOCK_SLOT_SIZE, IS_SAI_BLOCK_SYNCEXT, IS_SAI_BLOCK_SYNCHRO, IS_SAI_BLOCK_TRISTATE_MANAGEMENT, IS_SAI_MONO_STEREO_MODE, IS_SAI_SLOT_ACTIVE, __SAI_HandleTypeDef::Lock, SAI_InitTypeDef::Mckdiv, SAI_InitTypeDef::MonoStereoMode, SAI_InitTypeDef::NoDivider, SAI_InitTypeDef::OutputDrive, SAI_InitTypeDef::Protocol, SAI_ASYNCHRONOUS, SAI_AUDIO_FREQUENCY_MCKDIV, SAI_BlockSynchroConfig(), SAI_CLOCKSTROBING_RISINGEDGE, SAI_Disable(), SAI_GetInputClock(), SAI_MODEMASTER_TX, SAI_MODESLAVE_TX, SAI_SPDIF_PROTOCOL, SAI_SYNCHRONOUS, SAI_SYNCHRONOUS_EXT_SAI1, SAI_SYNCHRONOUS_EXT_SAI2, SAI_SlotInitTypeDef::SlotActive, __SAI_HandleTypeDef::SlotInit, SAI_SlotInitTypeDef::SlotNumber, SAI_SlotInitTypeDef::SlotSize, __SAI_HandleTypeDef::State, SAI_InitTypeDef::Synchro, SAI_InitTypeDef::SynchroExt, and SAI_InitTypeDef::TriState.

Referenced by HAL_SAI_InitProtocol().

HAL_SAI_DeInit()

HAL_StatusTypeDef HAL_SAI_DeInit

(

SAI_HandleTypeDef *

hsai

)

#include <stm32f4xx_hal_sai.h>

DeInitialize the SAI peripheral.

Parameters

hsai	pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.

Return values

HAL

status

Definition at line 569 of file stm32f4xx_hal_sai.c.

References __HAL_UNLOCK, __SAI_HandleTypeDef::ErrorCode, HAL_ERROR, HAL_OK, HAL_SAI_ERROR_NONE, HAL_SAI_MspDeInit(), HAL_SAI_STATE_BUSY, HAL_SAI_STATE_RESET, __SAI_HandleTypeDef::Instance, SAI_Disable(), and __SAI_HandleTypeDef::State.

HAL_SAI_MspInit()

__weak void HAL_SAI_MspInit

(

SAI_HandleTypeDef *

hsai

)

#include <stm32f4xx_hal_sai.h>

Initialize the SAI MSP.

Parameters

hsai	pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.

Return values

None

Definition at line 618 of file stm32f4xx_hal_sai.c.

References UNUSED.

Referenced by HAL_SAI_Init().

HAL_SAI_MspDeInit()

__weak void HAL_SAI_MspDeInit

(

SAI_HandleTypeDef *

hsai

)

#include <stm32f4xx_hal_sai.h>

DeInitialize the SAI MSP.

Parameters

hsai	pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.

Return values

None

Definition at line 634 of file stm32f4xx_hal_sai.c.

References UNUSED.

Referenced by HAL_SAI_DeInit().