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

« Back to documentation index

I2C Private Functions

I2C Private Functions
[I2C]

Functions

static void I2C_DMAMasterTransmitCplt (DMA_HandleTypeDef *hdma)
 DMA I2C master transmit process complete callback.
static void I2C_DMAMasterReceiveCplt (DMA_HandleTypeDef *hdma)
 DMA I2C master receive process complete callback.
static void I2C_DMASlaveTransmitCplt (DMA_HandleTypeDef *hdma)
 DMA I2C slave transmit process complete callback.
static void I2C_DMASlaveReceiveCplt (DMA_HandleTypeDef *hdma)
 DMA I2C slave receive process complete callback.
static void I2C_DMAError (DMA_HandleTypeDef *hdma)
 DMA I2C communication error callback.
static void I2C_DMAAbort (DMA_HandleTypeDef *hdma)
 DMA I2C communication abort callback (To be called at end of DMA Abort procedure).
static void I2C_ITAddrCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
 I2C Address complete process callback.
static void I2C_ITMasterSequentialCplt (I2C_HandleTypeDef *hi2c)
 I2C Master sequential complete process.
static void I2C_ITSlaveSequentialCplt (I2C_HandleTypeDef *hi2c)
 I2C Slave sequential complete process.
static void I2C_ITMasterCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
 I2C Master complete process.
static void I2C_ITSlaveCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
 I2C Slave complete process.
static void I2C_ITListenCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
 I2C Listen complete process.
static void I2C_ITError (I2C_HandleTypeDef *hi2c, uint32_t ErrorCode)
 I2C interrupts error process.
static HAL_StatusTypeDef I2C_RequestMemoryWrite (I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint32_t Timeout, uint32_t Tickstart)
 Master sends target device address followed by internal memory address for write request.
static HAL_StatusTypeDef I2C_RequestMemoryRead (I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint32_t Timeout, uint32_t Tickstart)
 Master sends target device address followed by internal memory address for read request.
static HAL_StatusTypeDef I2C_Master_ISR_IT (struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources)
 Interrupt Sub-Routine which handle the Interrupt Flags Master Mode with Interrupt.
static HAL_StatusTypeDef I2C_Slave_ISR_IT (struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources)
 Interrupt Sub-Routine which handle the Interrupt Flags Slave Mode with Interrupt.
static HAL_StatusTypeDef I2C_Master_ISR_DMA (struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources)
 Interrupt Sub-Routine which handle the Interrupt Flags Master Mode with DMA.
static HAL_StatusTypeDef I2C_Slave_ISR_DMA (struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources)
 Interrupt Sub-Routine which handle the Interrupt Flags Slave Mode with DMA.
static HAL_StatusTypeDef I2C_WaitOnFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Flag, FlagStatus Status, uint32_t Timeout, uint32_t Tickstart)
 This function handles I2C Communication Timeout.
static HAL_StatusTypeDef I2C_WaitOnTXISFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
 This function handles I2C Communication Timeout for specific usage of TXIS flag.
static HAL_StatusTypeDef I2C_WaitOnRXNEFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
 This function handles I2C Communication Timeout for specific usage of RXNE flag.
static HAL_StatusTypeDef I2C_WaitOnSTOPFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
 This function handles I2C Communication Timeout for specific usage of STOP flag.
static HAL_StatusTypeDef I2C_IsAcknowledgeFailed (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
 This function handles Acknowledge failed detection during an I2C Communication.
static HAL_StatusTypeDef I2C_Enable_IRQ (I2C_HandleTypeDef *hi2c, uint16_t InterruptRequest)
 Manage the enabling of Interrupts.
static HAL_StatusTypeDef I2C_Disable_IRQ (I2C_HandleTypeDef *hi2c, uint16_t InterruptRequest)
 Manage the disabling of Interrupts.
static void I2C_Flush_TXDR (I2C_HandleTypeDef *hi2c)
 I2C Tx data register flush process.
static void I2C_TransferConfig (I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t Size, uint32_t Mode, uint32_t Request)
 Handles I2Cx communication when starting transfer or during transfer (TC or TCR flag are set).

Function Documentation

static HAL_StatusTypeDef I2C_Disable_IRQ ( I2C_HandleTypeDef *  hi2c,
uint16_t  InterruptRequest 
) [static]

Manage the disabling of Interrupts.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
InterruptRequestValue of I2C_Interrupt_configuration_definition.
Return values:
HALstatus

Definition at line 4731 of file stm32l4xx_hal_i2c.c.

static void I2C_DMAAbort ( DMA_HandleTypeDef *  hdma ) [static]

DMA I2C communication abort callback (To be called at end of DMA Abort procedure).

Parameters:
hdma,:DMA handle.
Return values:
None

Definition at line 4374 of file stm32l4xx_hal_i2c.c.

static void I2C_DMAError ( DMA_HandleTypeDef *  hdma ) [static]

DMA I2C communication error callback.

Parameters:
hdmaDMA handle
Return values:
None

Definition at line 4357 of file stm32l4xx_hal_i2c.c.

static void I2C_DMAMasterReceiveCplt ( DMA_HandleTypeDef *  hdma ) [static]

DMA I2C master receive process complete callback.

Parameters:
hdmaDMA handle
Return values:
None

Definition at line 4303 of file stm32l4xx_hal_i2c.c.

static void I2C_DMAMasterTransmitCplt ( DMA_HandleTypeDef *  hdma ) [static]

DMA I2C master transmit process complete callback.

Parameters:
hdmaDMA handle
Return values:
None

Definition at line 4249 of file stm32l4xx_hal_i2c.c.

static void I2C_DMASlaveReceiveCplt ( DMA_HandleTypeDef *  hdma ) [static]

DMA I2C slave receive process complete callback.

Parameters:
hdmaDMA handle
Return values:
None

Definition at line 4345 of file stm32l4xx_hal_i2c.c.

static void I2C_DMASlaveTransmitCplt ( DMA_HandleTypeDef *  hdma ) [static]

DMA I2C slave transmit process complete callback.

Parameters:
hdmaDMA handle
Return values:
None

Definition at line 4291 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_Enable_IRQ ( I2C_HandleTypeDef *  hi2c,
uint16_t  InterruptRequest 
) [static]

Manage the enabling of Interrupts.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
InterruptRequestValue of I2C_Interrupt_configuration_definition.
Return values:
HALstatus

Definition at line 4658 of file stm32l4xx_hal_i2c.c.

static void I2C_Flush_TXDR ( I2C_HandleTypeDef *  hi2c ) [static]

I2C Tx data register flush process.

Parameters:
hi2cI2C handle.
Return values:
None

Definition at line 4228 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_IsAcknowledgeFailed ( I2C_HandleTypeDef *  hi2c,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

This function handles Acknowledge failed detection during an I2C Communication.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 4562 of file stm32l4xx_hal_i2c.c.

static void I2C_ITAddrCplt ( I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags 
) [static]

I2C Address complete process callback.

Parameters:
hi2cI2C handle.
ITFlagsInterrupt flags to handle.
Return values:
None

Definition at line 3715 of file stm32l4xx_hal_i2c.c.

static void I2C_ITError ( I2C_HandleTypeDef *  hi2c,
uint32_t  ErrorCode 
) [static]

I2C interrupts error process.

Parameters:
hi2cI2C handle.
ErrorCodeError code to handle.
Return values:
None

Definition at line 4126 of file stm32l4xx_hal_i2c.c.

static void I2C_ITListenCplt ( I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags 
) [static]

I2C Listen complete process.

Parameters:
hi2cI2C handle.
ITFlagsInterrupt flags to handle.
Return values:
None

Definition at line 4082 of file stm32l4xx_hal_i2c.c.

static void I2C_ITMasterCplt ( I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags 
) [static]

I2C Master complete process.

Parameters:
hi2cI2C handle.
ITFlagsInterrupt flags to handle.
Return values:
None

Definition at line 3884 of file stm32l4xx_hal_i2c.c.

static void I2C_ITMasterSequentialCplt ( I2C_HandleTypeDef *  hi2c ) [static]

I2C Master sequential complete process.

Parameters:
hi2cI2C handle.
Return values:
None

Definition at line 3795 of file stm32l4xx_hal_i2c.c.

static void I2C_ITSlaveCplt ( I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags 
) [static]

I2C Slave complete process.

Parameters:
hi2cI2C handle.
ITFlagsInterrupt flags to handle.
Return values:
None

Definition at line 3976 of file stm32l4xx_hal_i2c.c.

static void I2C_ITSlaveSequentialCplt ( I2C_HandleTypeDef *  hi2c ) [static]

I2C Slave sequential complete process.

Parameters:
hi2cI2C handle.
Return values:
None

Definition at line 3840 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_Master_ISR_DMA ( struct __I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags,
uint32_t  ITSources 
) [static]

Interrupt Sub-Routine which handle the Interrupt Flags Master Mode with DMA.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
ITFlagsInterrupt flags to handle.
ITSourcesInterrupt sources enabled.
Return values:
HALstatus

Definition at line 3445 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_Master_ISR_IT ( struct __I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags,
uint32_t  ITSources 
) [static]

Interrupt Sub-Routine which handle the Interrupt Flags Master Mode with Interrupt.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
ITFlagsInterrupt flags to handle.
ITSourcesInterrupt sources enabled.
Return values:
HALstatus

Definition at line 3211 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_RequestMemoryRead ( I2C_HandleTypeDef *  hi2c,
uint16_t  DevAddress,
uint16_t  MemAddress,
uint16_t  MemAddSize,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

Master sends target device address followed by internal memory address for read request.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
DevAddressTarget device address
MemAddressInternal memory address
MemAddSizeSize of internal memory address
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 3654 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_RequestMemoryWrite ( I2C_HandleTypeDef *  hi2c,
uint16_t  DevAddress,
uint16_t  MemAddress,
uint16_t  MemAddSize,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

Master sends target device address followed by internal memory address for write request.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
DevAddressTarget device address
MemAddressInternal memory address
MemAddSizeSize of internal memory address
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 3588 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_Slave_ISR_DMA ( struct __I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags,
uint32_t  ITSources 
) [static]

Interrupt Sub-Routine which handle the Interrupt Flags Slave Mode with DMA.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
ITFlagsInterrupt flags to handle.
ITSourcesInterrupt sources enabled.
Return values:
HALstatus

Definition at line 3534 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_Slave_ISR_IT ( struct __I2C_HandleTypeDef *  hi2c,
uint32_t  ITFlags,
uint32_t  ITSources 
) [static]

Interrupt Sub-Routine which handle the Interrupt Flags Slave Mode with Interrupt.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
ITFlagsInterrupt flags to handle.
ITSourcesInterrupt sources enabled.
Return values:
HALstatus

Definition at line 3332 of file stm32l4xx_hal_i2c.c.

static void I2C_TransferConfig ( I2C_HandleTypeDef *  hi2c,
uint16_t  DevAddress,
uint8_t  Size,
uint32_t  Mode,
uint32_t  Request 
) [static]

Handles I2Cx communication when starting transfer or during transfer (TC or TCR flag are set).

Parameters:
hi2cI2C handle.
DevAddressSpecifies the slave address to be programmed.
SizeSpecifies the number of bytes to be programmed. This parameter must be a value between 0 and 255.
ModeNew state of the I2C START condition generation. This parameter can be one of the following values:

  • I2C_RELOAD_MODE Enable Reload mode .
  • I2C_AUTOEND_MODE Enable Automatic end mode.
  • I2C_SOFTEND_MODE Enable Software end mode.
RequestNew state of the I2C START condition generation. This parameter can be one of the following values:

  • I2C_NO_STARTSTOP Don't Generate stop and start condition.
  • I2C_GENERATE_STOP Generate stop condition (Size should be set to 0).
  • I2C_GENERATE_START_READ Generate Restart for read request.
  • I2C_GENERATE_START_WRITE Generate Restart for write request.
Return values:
None

Definition at line 4628 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_WaitOnFlagUntilTimeout ( I2C_HandleTypeDef *  hi2c,
uint32_t  Flag,
FlagStatus  Status,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

This function handles I2C Communication Timeout.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
FlagSpecifies the I2C flag to check.
StatusThe new Flag status (SET or RESET).
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 4410 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_WaitOnRXNEFlagUntilTimeout ( I2C_HandleTypeDef *  hi2c,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

This function handles I2C Communication Timeout for specific usage of RXNE flag.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 4510 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_WaitOnSTOPFlagUntilTimeout ( I2C_HandleTypeDef *  hi2c,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

This function handles I2C Communication Timeout for specific usage of STOP flag.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 4476 of file stm32l4xx_hal_i2c.c.

static HAL_StatusTypeDef I2C_WaitOnTXISFlagUntilTimeout ( I2C_HandleTypeDef *  hi2c,
uint32_t  Timeout,
uint32_t  Tickstart 
) [static]

This function handles I2C Communication Timeout for specific usage of TXIS flag.

Parameters:
hi2cPointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2C.
TimeoutTimeout duration
TickstartTick start value
Return values:
HALstatus

Definition at line 4439 of file stm32l4xx_hal_i2c.c.