Peripheral State, Mode and Error functions

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

Detailed Description

Function Documentation

HAL_I2C_GetError()

uint32_t HAL_I2C_GetError

(

I2C_HandleTypeDef *

hi2c

)

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

HAL_I2C_GetMode()

HAL_I2C_ModeTypeDef HAL_I2C_GetMode

(

I2C_HandleTypeDef *

hi2c

)

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

HAL_I2C_GetState()

HAL_I2C_StateTypeDef HAL_I2C_GetState

(

I2C_HandleTypeDef *

hi2c

)

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

HAL_I2C_Reset()

uint32_t HAL_I2C_Reset

(

I2C_HandleTypeDef *

hi2c

)

Send I2C bus reset and reset I2C controller.

Parameters

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

Return values

I2C	Error Code