TUKS MCU Introductory course / TUKS-COURSE-TIMER
Embed: (wiki syntax)

« Back to documentation index

Peripheral State, Mode and Error functions

Peripheral State, Mode and Error functions
[I2C Exported Functions]

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

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

uint32_t HAL_I2C_GetError ( I2C_HandleTypeDef *  hi2c )

Return the I2C error code.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
Return values:
I2CError Code

Definition at line 3186 of file stm32l4xx_hal_i2c.c.

HAL_I2C_ModeTypeDef HAL_I2C_GetMode ( I2C_HandleTypeDef *  hi2c )

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

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for I2C module
Return values:
HALmode

Definition at line 3175 of file stm32l4xx_hal_i2c.c.

HAL_I2C_StateTypeDef HAL_I2C_GetState ( I2C_HandleTypeDef *  hi2c )

Return the I2C handle state.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
Return values:
HALstate

Definition at line 3163 of file stm32l4xx_hal_i2c.c.