Initialization and de-initialization functions

Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_I2S_Init (I2S_HandleTypeDef *hi2s)
	Initializes the I2S according to the specified parameters in the I2S_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s)
	DeInitializes the I2S peripheral.
__weak void	HAL_I2S_MspInit (I2S_HandleTypeDef *hi2s)
	I2S MSP Init.
__weak void	HAL_I2S_MspDeInit (I2S_HandleTypeDef *hi2s)
	I2S MSP DeInit.
HAL_StatusTypeDef	HAL_I2S_RegisterCallback (I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID, pI2S_CallbackTypeDef pCallback)
	Register a User I2S Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_I2S_UnRegisterCallback (I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID)
	Unregister an I2S Callback I2S callback is redirected to the weak predefined callback.

---

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 I2Sx peripheral in simplex mode:

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

      (+) Call the function HAL_I2S_Init() to configure the selected device with
          the selected configuration:
        (++) Mode
        (++) Standard
        (++) Data Format
        (++) MCLK Output
        (++) Audio frequency
        (++) Polarity
        (++) Full duplex mode

     (+) Call the function HAL_I2S_DeInit() to restore the default configuration
          of the selected I2Sx peripheral.
  

---

Function Documentation

HAL_StatusTypeDef HAL_I2S_DeInit

(

I2S_HandleTypeDef *

hi2s

)

DeInitializes the I2S peripheral.

Parameters:

hi2s	pointer to a I2S_HandleTypeDef structure that contains the configuration information for I2S module

Return values:

HAL

status

Definition at line 495 of file stm32f4xx_hal_i2s.c.

References __HAL_I2S_DISABLE, assert_param, __I2S_HandleTypeDef::ErrorCode, HAL_I2S_ERROR_NONE, HAL_I2S_MspDeInit(), HAL_I2S_STATE_BUSY, HAL_I2S_STATE_RESET, __I2S_HandleTypeDef::Instance, __I2S_HandleTypeDef::MspDeInitCallback, and __I2S_HandleTypeDef::State.

HAL_StatusTypeDef HAL_I2S_Init

(

I2S_HandleTypeDef *

hi2s

)

Initializes the I2S according to the specified parameters in the I2S_InitTypeDef and create the associated handle.

Parameters:

hi2s	pointer to a I2S_HandleTypeDef structure that contains the configuration information for I2S module

Return values:

HAL

status

Definition at line 265 of file stm32f4xx_hal_i2s.c.

References assert_param, I2S_InitTypeDef::AudioFreq, I2S_InitTypeDef::ClockSource, I2S_InitTypeDef::CPOL, I2S_InitTypeDef::DataFormat, __I2S_HandleTypeDef::ErrorCallback, __I2S_HandleTypeDef::ErrorCode, I2S_InitTypeDef::FullDuplexMode, HAL_I2S_ERROR_NONE, HAL_I2S_ERROR_PRESCALER, HAL_I2S_ErrorCallback(), HAL_I2S_MspInit(), HAL_I2S_RxCpltCallback(), HAL_I2S_RxHalfCpltCallback(), HAL_I2S_STATE_BUSY, HAL_I2S_STATE_READY, HAL_I2S_STATE_RESET, HAL_I2S_TxCpltCallback(), HAL_I2S_TxHalfCpltCallback(), HAL_I2SEx_FullDuplex_IRQHandler(), HAL_I2SEx_TxRxCpltCallback(), HAL_I2SEx_TxRxHalfCpltCallback(), HAL_RCCEx_GetPeriphCLKFreq(), I2S_AUDIOFREQ_DEFAULT, I2S_DATAFORMAT_16B, I2S_FULLDUPLEXMODE_ENABLE, I2S_IRQHandler(), I2S_MCLKOUTPUT_ENABLE, I2S_MODE_MASTER_TX, I2S_MODE_SLAVE_RX, I2S_MODE_SLAVE_TX, I2S_STANDARD_LSB, I2S_STANDARD_PCM_LONG, I2S_STANDARD_PCM_SHORT, I2SxEXT, __I2S_HandleTypeDef::Init, __I2S_HandleTypeDef::Instance, __I2S_HandleTypeDef::IrqHandlerISR, IS_I2S_AUDIO_FREQ, IS_I2S_CLOCKSOURCE, IS_I2S_CPOL, IS_I2S_DATA_FORMAT, IS_I2S_FULLDUPLEX_MODE, IS_I2S_MCLK_OUTPUT, IS_I2S_MODE, IS_I2S_STANDARD, __I2S_HandleTypeDef::Lock, I2S_InitTypeDef::MCLKOutput, I2S_InitTypeDef::Mode, __I2S_HandleTypeDef::MspInitCallback, RCC_PERIPHCLK_I2S, __I2S_HandleTypeDef::RxCpltCallback, __I2S_HandleTypeDef::RxHalfCpltCallback, I2S_InitTypeDef::Standard, __I2S_HandleTypeDef::State, __I2S_HandleTypeDef::TxCpltCallback, __I2S_HandleTypeDef::TxHalfCpltCallback, __I2S_HandleTypeDef::TxRxCpltCallback, and __I2S_HandleTypeDef::TxRxHalfCpltCallback.

void HAL_I2S_MspDeInit

(

I2S_HandleTypeDef *

hi2s

)

I2S MSP DeInit.

Parameters:

hi2s	pointer to a I2S_HandleTypeDef structure that contains the configuration information for I2S module

Return values:

None

Definition at line 555 of file stm32f4xx_hal_i2s.c.

Referenced by HAL_I2S_DeInit(), and HAL_I2S_UnRegisterCallback().

void HAL_I2S_MspInit

(

I2S_HandleTypeDef *

hi2s

)

I2S MSP Init.

Parameters:

hi2s	pointer to a I2S_HandleTypeDef structure that contains the configuration information for I2S module

Return values:

None

Definition at line 539 of file stm32f4xx_hal_i2s.c.

Referenced by HAL_I2S_Init(), and HAL_I2S_UnRegisterCallback().

HAL_StatusTypeDef HAL_I2S_RegisterCallback	(	I2S_HandleTypeDef *	hi2s,
		HAL_I2S_CallbackIDTypeDef	CallbackID,
		pI2S_CallbackTypeDef	pCallback
	)

Register a User I2S Callback To be used instead of the weak predefined callback.

Parameters:

hi2s	Pointer to a I2S_HandleTypeDef structure that contains the configuration information for the specified I2S.
CallbackID	ID of the callback to be registered
pCallback	pointer to the Callback function

Return values:

HAL

status

Definition at line 575 of file stm32f4xx_hal_i2s.c.

References __I2S_HandleTypeDef::ErrorCallback, __I2S_HandleTypeDef::ErrorCode, HAL_I2S_ERROR_CB_ID, HAL_I2S_ERROR_INVALID_CALLBACK, HAL_I2S_MSPDEINIT_CB_ID, HAL_I2S_MSPINIT_CB_ID, HAL_I2S_RX_COMPLETE_CB_ID, HAL_I2S_RX_HALF_COMPLETE_CB_ID, HAL_I2S_STATE_READY, HAL_I2S_STATE_RESET, HAL_I2S_TX_COMPLETE_CB_ID, HAL_I2S_TX_HALF_COMPLETE_CB_ID, HAL_I2S_TX_RX_COMPLETE_CB_ID, HAL_I2S_TX_RX_HALF_COMPLETE_CB_ID, __I2S_HandleTypeDef::MspDeInitCallback, __I2S_HandleTypeDef::MspInitCallback, __I2S_HandleTypeDef::RxCpltCallback, __I2S_HandleTypeDef::RxHalfCpltCallback, __I2S_HandleTypeDef::State, __I2S_HandleTypeDef::TxCpltCallback, __I2S_HandleTypeDef::TxHalfCpltCallback, __I2S_HandleTypeDef::TxRxCpltCallback, and __I2S_HandleTypeDef::TxRxHalfCpltCallback.

HAL_StatusTypeDef HAL_I2S_UnRegisterCallback	(	I2S_HandleTypeDef *	hi2s,
		HAL_I2S_CallbackIDTypeDef	CallbackID
	)

Unregister an I2S Callback I2S callback is redirected to the weak predefined callback.

Parameters:

hi2s	Pointer to a I2S_HandleTypeDef structure that contains the configuration information for the specified I2S.
CallbackID	ID of the callback to be unregistered

Return values:

HAL

status

Definition at line 686 of file stm32f4xx_hal_i2s.c.

References __I2S_HandleTypeDef::ErrorCallback, __I2S_HandleTypeDef::ErrorCode, HAL_I2S_ERROR_CB_ID, HAL_I2S_ERROR_INVALID_CALLBACK, HAL_I2S_ErrorCallback(), HAL_I2S_MspDeInit(), HAL_I2S_MSPDEINIT_CB_ID, HAL_I2S_MspInit(), HAL_I2S_MSPINIT_CB_ID, HAL_I2S_RX_COMPLETE_CB_ID, HAL_I2S_RX_HALF_COMPLETE_CB_ID, HAL_I2S_RxCpltCallback(), HAL_I2S_RxHalfCpltCallback(), HAL_I2S_STATE_READY, HAL_I2S_STATE_RESET, HAL_I2S_TX_COMPLETE_CB_ID, HAL_I2S_TX_HALF_COMPLETE_CB_ID, HAL_I2S_TX_RX_COMPLETE_CB_ID, HAL_I2S_TX_RX_HALF_COMPLETE_CB_ID, HAL_I2S_TxCpltCallback(), HAL_I2S_TxHalfCpltCallback(), HAL_I2SEx_TxRxCpltCallback(), HAL_I2SEx_TxRxHalfCpltCallback(), __I2S_HandleTypeDef::MspDeInitCallback, __I2S_HandleTypeDef::MspInitCallback, __I2S_HandleTypeDef::RxCpltCallback, __I2S_HandleTypeDef::RxHalfCpltCallback, __I2S_HandleTypeDef::State, __I2S_HandleTypeDef::TxCpltCallback, __I2S_HandleTypeDef::TxHalfCpltCallback, __I2S_HandleTypeDef::TxRxCpltCallback, and __I2S_HandleTypeDef::TxRxHalfCpltCallback.