Peripheral State and Errors functions

Peripheral State functions. More...

Collaboration diagram for Peripheral State and Errors functions:

Functions
HAL_I2S_StateTypeDef	HAL_I2S_GetState (I2S_HandleTypeDef *hi2s)
	Return the I2S state.
uint32_t	HAL_I2S_GetError (I2S_HandleTypeDef *hi2s)
	Return the I2S error code.

Detailed Description

Peripheral State functions.

 ===============================================================================
                      ##### Peripheral State and Errors functions #####
 ===============================================================================
    [..]
    This subsection permits to get in run-time the status of the peripheral
    and the data flow.

Function Documentation

HAL_I2S_GetState()

HAL_I2S_StateTypeDef HAL_I2S_GetState

(

I2S_HandleTypeDef *

hi2s

)

#include <stm32f4xx_hal_i2s.h>

Return the I2S state.

Parameters

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

Return values

HAL

state

Definition at line 1770 of file stm32f4xx_hal_i2s.c.

References __I2S_HandleTypeDef::State.

HAL_I2S_GetError()

uint32_t HAL_I2S_GetError

(

I2S_HandleTypeDef *

hi2s

)

#include <stm32f4xx_hal_i2s.h>

Return the I2S error code.

Parameters

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

Return values

I2S	Error Code

Definition at line 1781 of file stm32f4xx_hal_i2s.c.

References __I2S_HandleTypeDef::ErrorCode.