Peripheral State, Mode and Error functions

Peripheral State, Mode and Error functions. More...

Collaboration diagram for Peripheral State, Mode and Error functions:

Functions
HAL_I2C_StateTypeDef	HAL_I2C_GetState (I2C_HandleTypeDef *hi2c)
	Return the I2C handle state.
HAL_I2C_ModeTypeDef	HAL_I2C_GetMode (I2C_HandleTypeDef *hi2c)
	Returns the I2C Master, Slave, Memory or no mode.
uint32_t	HAL_I2C_GetError (I2C_HandleTypeDef *hi2c)
	Return the I2C error code.

Detailed Description

Peripheral State, Mode and Error functions.

 ===============================================================================
            ##### Peripheral State, Mode and Error functions #####
 ===============================================================================
    [..]
    This subsection permit to get in run-time the status of the peripheral
    and the data flow.

Function Documentation

HAL_I2C_GetState()

HAL_I2C_StateTypeDef HAL_I2C_GetState

(

I2C_HandleTypeDef *

hi2c

)

#include <stm32f4xx_hal_i2c.h>

Return the I2C handle state.

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.

Return values

HAL

state

Definition at line 5214 of file stm32f4xx_hal_i2c.c.

References I2C_HandleTypeDef::State.

HAL_I2C_GetMode()

HAL_I2C_ModeTypeDef HAL_I2C_GetMode

(

I2C_HandleTypeDef *

hi2c

)

#include <stm32f4xx_hal_i2c.h>

Returns the I2C Master, Slave, Memory or no mode.

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for I2C module

Return values

HAL

mode

Definition at line 5226 of file stm32f4xx_hal_i2c.c.

References I2C_HandleTypeDef::Mode.

HAL_I2C_GetError()

uint32_t HAL_I2C_GetError

(

I2C_HandleTypeDef *

hi2c

)

#include <stm32f4xx_hal_i2c.h>

Return the I2C error code.

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.

Return values

I2C	Error Code

Definition at line 5237 of file stm32f4xx_hal_i2c.c.

References I2C_HandleTypeDef::ErrorCode.