Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

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. More...
HAL_StatusTypeDef	HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s)
	DeInitializes the I2S peripheral. More...
void	HAL_I2S_MspInit (I2S_HandleTypeDef *hi2s)
	I2S MSP Init. More...
void	HAL_I2S_MspDeInit (I2S_HandleTypeDef *hi2s)
	I2S MSP DeInit. More...
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. More...
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. More...

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_I2S_DeInit()

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.

HAL_I2S_Init()

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.

HAL_I2S_MspDeInit()

__weak 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.

HAL_I2S_MspInit()

__weak 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.

HAL_I2S_RegisterCallback()

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.

HAL_I2S_UnRegisterCallback()

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.