I2C HAL module driver. This file provides firmware functions to manage the following functionalities of the Inter Integrated Circuit (I2C) peripheral: More...

#include "stm32f4xx_hal.h"

Include dependency graph for stm32f4xx_hal_i2c.c:

Macros
#define	I2C_TIMEOUT_FLAG 35U

#define	I2C_TIMEOUT_BUSY_FLAG 25U

#define	I2C_TIMEOUT_STOP_FLAG 5U

#define	I2C_NO_OPTION_FRAME 0xFFFF0000U

#define	I2C_STATE_MSK ((uint32_t)((uint32_t)((uint32_t)HAL_I2C_STATE_BUSY_TX \| (uint32_t)HAL_I2C_STATE_BUSY_RX) & (uint32_t)(~((uint32_t)HAL_I2C_STATE_READY))))

#define	I2C_STATE_NONE ((uint32_t)(HAL_I2C_MODE_NONE))

#define	I2C_STATE_MASTER_BUSY_TX ((uint32_t)(((uint32_t)HAL_I2C_STATE_BUSY_TX & I2C_STATE_MSK) \| (uint32_t)HAL_I2C_MODE_MASTER))

#define	I2C_STATE_MASTER_BUSY_RX ((uint32_t)(((uint32_t)HAL_I2C_STATE_BUSY_RX & I2C_STATE_MSK) \| (uint32_t)HAL_I2C_MODE_MASTER))

#define	I2C_STATE_SLAVE_BUSY_TX ((uint32_t)(((uint32_t)HAL_I2C_STATE_BUSY_TX & I2C_STATE_MSK) \| (uint32_t)HAL_I2C_MODE_SLAVE))

#define	I2C_STATE_SLAVE_BUSY_RX ((uint32_t)(((uint32_t)HAL_I2C_STATE_BUSY_RX & I2C_STATE_MSK) \| (uint32_t)HAL_I2C_MODE_SLAVE))

#define	I2C_GET_DMA_REMAIN_DATA(__HANDLE__)

Functions
static void	I2C_DMAXferCplt (DMA_HandleTypeDef *hdma)
	DMA I2C 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_ITError (I2C_HandleTypeDef *hi2c)
	I2C interrupts error process.

static HAL_StatusTypeDef	I2C_MasterRequestWrite (I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Timeout, uint32_t Tickstart)

static HAL_StatusTypeDef	I2C_MasterRequestRead (I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Timeout, uint32_t Tickstart)
	Master sends target device address for read request.

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_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_WaitOnMasterAddressFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Flag, uint32_t Timeout, uint32_t Tickstart)
	This function handles I2C Communication Timeout for Master addressing phase.

static HAL_StatusTypeDef	I2C_WaitOnTXEFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
	This function handles I2C Communication Timeout for specific usage of TXE flag.

static HAL_StatusTypeDef	I2C_WaitOnBTFFlagUntilTimeout (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
	This function handles I2C Communication Timeout for specific usage of BTF 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_WaitOnSTOPRequestThroughIT (I2C_HandleTypeDef *hi2c)
	This function handles I2C Communication Timeout for specific usage of STOP request through Interrupt.

static HAL_StatusTypeDef	I2C_IsAcknowledgeFailed (I2C_HandleTypeDef *hi2c)
	This function handles Acknowledge failed detection during an I2C Communication.

static void	I2C_MasterTransmit_TXE (I2C_HandleTypeDef *hi2c)
	Handle TXE flag for Master.

static void	I2C_MasterTransmit_BTF (I2C_HandleTypeDef *hi2c)
	Handle BTF flag for Master transmitter.

static void	I2C_MasterReceive_RXNE (I2C_HandleTypeDef *hi2c)
	Handle RXNE flag for Master.

static void	I2C_MasterReceive_BTF (I2C_HandleTypeDef *hi2c)
	Handle BTF flag for Master receiver.

static void	I2C_Master_SB (I2C_HandleTypeDef *hi2c)
	Handle SB flag for Master.

static void	I2C_Master_ADD10 (I2C_HandleTypeDef *hi2c)
	Handle ADD10 flag for Master.

static void	I2C_Master_ADDR (I2C_HandleTypeDef *hi2c)
	Handle ADDR flag for Master.

static void	I2C_SlaveTransmit_TXE (I2C_HandleTypeDef *hi2c)
	Handle TXE flag for Slave.

static void	I2C_SlaveTransmit_BTF (I2C_HandleTypeDef *hi2c)
	Handle BTF flag for Slave transmitter.

static void	I2C_SlaveReceive_RXNE (I2C_HandleTypeDef *hi2c)
	Handle RXNE flag for Slave.

static void	I2C_SlaveReceive_BTF (I2C_HandleTypeDef *hi2c)
	Handle BTF flag for Slave receiver.

static void	I2C_Slave_ADDR (I2C_HandleTypeDef *hi2c, uint32_t IT2Flags)
	Handle ADD flag for Slave.

static void	I2C_Slave_STOPF (I2C_HandleTypeDef *hi2c)
	Handle STOPF flag for Slave.

static void	I2C_Slave_AF (I2C_HandleTypeDef *hi2c)

static void	I2C_MemoryTransmit_TXE_BTF (I2C_HandleTypeDef *hi2c)
	Handle TXE and BTF flag for Memory transmitter.

static void	I2C_ConvertOtherXferOptions (I2C_HandleTypeDef *hi2c)
	Convert I2Cx OTHER_xxx XferOptions to functional XferOptions.

static void	I2C_Flush_DR (I2C_HandleTypeDef *hi2c)
	I2C data register flush process.

HAL_StatusTypeDef	HAL_I2C_Init (I2C_HandleTypeDef *hi2c)
	Initializes the I2C according to the specified parameters in the I2C_InitTypeDef and initialize the associated handle.

HAL_StatusTypeDef	HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c)
	DeInitialize the I2C peripheral.

void	HAL_I2C_MspInit (I2C_HandleTypeDef *hi2c)
	Initialize the I2C MSP.

void	HAL_I2C_MspDeInit (I2C_HandleTypeDef *hi2c)
	DeInitialize the I2C MSP.

HAL_StatusTypeDef	HAL_I2C_Master_Transmit (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Transmits in master mode an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_I2C_Master_Receive (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Receives in master mode an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_I2C_Slave_Transmit (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Transmits in slave mode an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_I2C_Slave_Receive (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Receive in slave mode an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_I2C_Master_Transmit_IT (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size)
	Transmit in master mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Master_Receive_IT (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size)
	Receive in master mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Slave_Transmit_IT (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size)
	Transmit in slave mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Slave_Receive_IT (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size)
	Receive in slave mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Master_Transmit_DMA (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size)
	Transmit in master mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Master_Receive_DMA (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size)
	Receive in master mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Slave_Transmit_DMA (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size)
	Transmit in slave mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Slave_Receive_DMA (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size)
	Receive in slave mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Mem_Write (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Write an amount of data in blocking mode to a specific memory address.

HAL_StatusTypeDef	HAL_I2C_Mem_Read (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Read an amount of data in blocking mode from a specific memory address.

HAL_StatusTypeDef	HAL_I2C_Mem_Write_IT (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t pData, uint16_t Size)
	Write an amount of data in non-blocking mode with Interrupt to a specific memory address.

HAL_StatusTypeDef	HAL_I2C_Mem_Read_IT (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t pData, uint16_t Size)
	Read an amount of data in non-blocking mode with Interrupt from a specific memory address.

HAL_StatusTypeDef	HAL_I2C_Mem_Write_DMA (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t pData, uint16_t Size)
	Write an amount of data in non-blocking mode with DMA to a specific memory address.

HAL_StatusTypeDef	HAL_I2C_Mem_Read_DMA (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t pData, uint16_t Size)
	Reads an amount of data in non-blocking mode with DMA from a specific memory address.

HAL_StatusTypeDef	HAL_I2C_IsDeviceReady (I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout)
	Checks if target device is ready for communication.

HAL_StatusTypeDef	HAL_I2C_Master_Seq_Transmit_IT (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential transmit in master I2C mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Master_Seq_Transmit_DMA (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential transmit in master I2C mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Master_Seq_Receive_IT (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential receive in master I2C mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Master_Seq_Receive_DMA (I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential receive in master mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Slave_Seq_Transmit_IT (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential transmit in slave mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Slave_Seq_Transmit_DMA (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential transmit in slave mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_Slave_Seq_Receive_IT (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential receive in slave mode an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Slave_Seq_Receive_DMA (I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Sequential receive in slave mode an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_I2C_EnableListen_IT (I2C_HandleTypeDef *hi2c)
	Enable the Address listen mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_DisableListen_IT (I2C_HandleTypeDef *hi2c)
	Disable the Address listen mode with Interrupt.

HAL_StatusTypeDef	HAL_I2C_Master_Abort_IT (I2C_HandleTypeDef *hi2c, uint16_t DevAddress)
	Abort a master or memory I2C IT or DMA process communication with Interrupt.

void	HAL_I2C_EV_IRQHandler (I2C_HandleTypeDef *hi2c)
	This function handles I2C event interrupt request.

void	HAL_I2C_ER_IRQHandler (I2C_HandleTypeDef *hi2c)
	This function handles I2C error interrupt request.

void	HAL_I2C_MasterTxCpltCallback (I2C_HandleTypeDef *hi2c)
	Master Tx Transfer completed callback.

void	HAL_I2C_MasterRxCpltCallback (I2C_HandleTypeDef *hi2c)
	Master Rx Transfer completed callback.

void	HAL_I2C_SlaveTxCpltCallback (I2C_HandleTypeDef *hi2c)
	Slave Tx Transfer completed callback.

void	HAL_I2C_SlaveRxCpltCallback (I2C_HandleTypeDef *hi2c)
	Slave Rx Transfer completed callback.

void	HAL_I2C_AddrCallback (I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode)
	Slave Address Match callback.

void	HAL_I2C_ListenCpltCallback (I2C_HandleTypeDef *hi2c)
	Listen Complete callback.

void	HAL_I2C_MemTxCpltCallback (I2C_HandleTypeDef *hi2c)
	Memory Tx Transfer completed callback.

void	HAL_I2C_MemRxCpltCallback (I2C_HandleTypeDef *hi2c)
	Memory Rx Transfer completed callback.

void	HAL_I2C_ErrorCallback (I2C_HandleTypeDef *hi2c)
	I2C error callback.

void	HAL_I2C_AbortCpltCallback (I2C_HandleTypeDef *hi2c)
	I2C abort callback.

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

I2C HAL module driver. This file provides firmware functions to manage the following functionalities of the Inter Integrated Circuit (I2C) peripheral:

Author

MCD Application Team

Initialization and de-initialization functions
IO operation functions
Peripheral State, Mode and Error functions

Attention

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

==============================================================================
                      ##### How to use this driver #####
==============================================================================
[..]
  The I2C HAL driver can be used as follows:

  (#) Declare a I2C_HandleTypeDef handle structure, for example:
      I2C_HandleTypeDef  hi2c;

  (#)Initialize the I2C low level resources by implementing the HAL_I2C_MspInit() API:
      (##) Enable the I2Cx interface clock
      (##) I2C pins configuration
          (+++) Enable the clock for the I2C GPIOs
          (+++) Configure I2C pins as alternate function open-drain
      (##) NVIC configuration if you need to use interrupt process
          (+++) Configure the I2Cx interrupt priority
          (+++) Enable the NVIC I2C IRQ Channel
      (##) DMA Configuration if you need to use DMA process
          (+++) Declare a DMA_HandleTypeDef handle structure for the transmit or receive stream
          (+++) Enable the DMAx interface clock using
          (+++) Configure the DMA handle parameters
          (+++) Configure the DMA Tx or Rx stream
          (+++) Associate the initialized DMA handle to the hi2c DMA Tx or Rx handle
          (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on
                the DMA Tx or Rx stream

  (#) Configure the Communication Speed, Duty cycle, Addressing mode, Own Address1,
      Dual Addressing mode, Own Address2, General call and Nostretch mode in the hi2c Init structure.

  (#) Initialize the I2C registers by calling the HAL_I2C_Init(), configures also the low level Hardware
      (GPIO, CLOCK, NVIC...etc) by calling the customized HAL_I2C_MspInit() API.

  (#) To check if target device is ready for communication, use the function HAL_I2C_IsDeviceReady()

  (#) For I2C IO and IO MEM operations, three operation modes are available within this driver :

  *** Polling mode IO operation ***
  =================================
  [..]
    (+) Transmit in master mode an amount of data in blocking mode using HAL_I2C_Master_Transmit()
    (+) Receive in master mode an amount of data in blocking mode using HAL_I2C_Master_Receive()
    (+) Transmit in slave mode an amount of data in blocking mode using HAL_I2C_Slave_Transmit()
    (+) Receive in slave mode an amount of data in blocking mode using HAL_I2C_Slave_Receive()

  *** Polling mode IO MEM operation ***
  =====================================
  [..]
    (+) Write an amount of data in blocking mode to a specific memory address using HAL_I2C_Mem_Write()
    (+) Read an amount of data in blocking mode from a specific memory address using HAL_I2C_Mem_Read()


  *** Interrupt mode IO operation ***
  ===================================
  [..]
    (+) Transmit in master mode an amount of data in non-blocking mode using HAL_I2C_Master_Transmit_IT()
    (+) At transmission end of transfer, HAL_I2C_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MasterTxCpltCallback()
    (+) Receive in master mode an amount of data in non-blocking mode using HAL_I2C_Master_Receive_IT()
    (+) At reception end of transfer, HAL_I2C_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MasterRxCpltCallback()
    (+) Transmit in slave mode an amount of data in non-blocking mode using HAL_I2C_Slave_Transmit_IT()
    (+) At transmission end of transfer, HAL_I2C_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_SlaveTxCpltCallback()
    (+) Receive in slave mode an amount of data in non-blocking mode using HAL_I2C_Slave_Receive_IT()
    (+) At reception end of transfer, HAL_I2C_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_SlaveRxCpltCallback()
    (+) In case of transfer Error, HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer HAL_I2C_ErrorCallback()
    (+) Abort a master or memory I2C process communication with Interrupt using HAL_I2C_Master_Abort_IT()
    (+) End of abort process, HAL_I2C_AbortCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_AbortCpltCallback()

  *** Interrupt mode or DMA mode IO sequential operation ***
  ==========================================================
  [..]
    (@) These interfaces allow to manage a sequential transfer with a repeated start condition
        when a direction change during transfer
  [..]
    (+) A specific option field manage the different steps of a sequential transfer
    (+) Option field values are defined through I2C_XferOptions_definition and are listed below:
    (++) I2C_FIRST_AND_LAST_FRAME: No sequential usage, functional is same as associated interfaces in no sequential mode
    (++) I2C_FIRST_FRAME: Sequential usage, this option allow to manage a sequence with start condition, address
                          and data to transfer without a final stop condition
    (++) I2C_FIRST_AND_NEXT_FRAME: Sequential usage (Master only), this option allow to manage a sequence with start condition, address
                          and data to transfer without a final stop condition, an then permit a call the same master sequential interface
                          several times (like HAL_I2C_Master_Seq_Transmit_IT() then HAL_I2C_Master_Seq_Transmit_IT()
                          or HAL_I2C_Master_Seq_Transmit_DMA() then HAL_I2C_Master_Seq_Transmit_DMA())
    (++) I2C_NEXT_FRAME: Sequential usage, this option allow to manage a sequence with a restart condition, address
                          and with new data to transfer if the direction change or manage only the new data to transfer
                          if no direction change and without a final stop condition in both cases
    (++) I2C_LAST_FRAME: Sequential usage, this option allow to manage a sequance with a restart condition, address
                          and with new data to transfer if the direction change or manage only the new data to transfer
                          if no direction change and with a final stop condition in both cases
    (++) I2C_LAST_FRAME_NO_STOP: Sequential usage (Master only), this option allow to manage a restart condition after several call of the same master sequential
                          interface several times (link with option I2C_FIRST_AND_NEXT_FRAME).
                          Usage can, transfer several bytes one by one using HAL_I2C_Master_Seq_Transmit_IT(option I2C_FIRST_AND_NEXT_FRAME then I2C_NEXT_FRAME)
                            or HAL_I2C_Master_Seq_Receive_IT(option I2C_FIRST_AND_NEXT_FRAME then I2C_NEXT_FRAME)
                            or HAL_I2C_Master_Seq_Transmit_DMA(option I2C_FIRST_AND_NEXT_FRAME then I2C_NEXT_FRAME)
                            or HAL_I2C_Master_Seq_Receive_DMA(option I2C_FIRST_AND_NEXT_FRAME then I2C_NEXT_FRAME).
                          Then usage of this option I2C_LAST_FRAME_NO_STOP at the last Transmit or Receive sequence permit to call the opposite interface Receive or Transmit
                            without stopping the communication and so generate a restart condition.
    (++) I2C_OTHER_FRAME: Sequential usage (Master only), this option allow to manage a restart condition after each call of the same master sequential
                          interface.
                          Usage can, transfer several bytes one by one with a restart with slave address between each bytes using HAL_I2C_Master_Seq_Transmit_IT(option I2C_FIRST_FRAME then I2C_OTHER_FRAME)
                            or HAL_I2C_Master_Seq_Receive_IT(option I2C_FIRST_FRAME then I2C_OTHER_FRAME)
                            or HAL_I2C_Master_Seq_Transmit_DMA(option I2C_FIRST_FRAME then I2C_OTHER_FRAME)
                            or HAL_I2C_Master_Seq_Receive_DMA(option I2C_FIRST_FRAME then I2C_OTHER_FRAME).
                          Then usage of this option I2C_OTHER_AND_LAST_FRAME at the last frame to help automatic generation of STOP condition.

    (+) Different sequential I2C interfaces are listed below:
    (++) Sequential transmit in master I2C mode an amount of data in non-blocking mode using HAL_I2C_Master_Seq_Transmit_IT()
          or using HAL_I2C_Master_Seq_Transmit_DMA()
    (+++) At transmission end of current frame transfer, HAL_I2C_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MasterTxCpltCallback()
    (++) Sequential receive in master I2C mode an amount of data in non-blocking mode using HAL_I2C_Master_Seq_Receive_IT()
          or using HAL_I2C_Master_Seq_Receive_DMA()
    (+++) At reception end of current frame transfer, HAL_I2C_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MasterRxCpltCallback()
    (++) Abort a master or memory IT or DMA I2C process communication with Interrupt using HAL_I2C_Master_Abort_IT()
    (+++) End of abort process, HAL_I2C_AbortCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_AbortCpltCallback()
    (++) Enable/disable the Address listen mode in slave I2C mode using HAL_I2C_EnableListen_IT() HAL_I2C_DisableListen_IT()
    (+++) When address slave I2C match, HAL_I2C_AddrCallback() is executed and user can
         add his own code to check the Address Match Code and the transmission direction request by master (Write/Read).
    (+++) At Listen mode end HAL_I2C_ListenCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_ListenCpltCallback()
    (++) Sequential transmit in slave I2C mode an amount of data in non-blocking mode using HAL_I2C_Slave_Seq_Transmit_IT()
          or using HAL_I2C_Slave_Seq_Transmit_DMA()
    (+++) At transmission end of current frame transfer, HAL_I2C_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_SlaveTxCpltCallback()
    (++) Sequential receive in slave I2C mode an amount of data in non-blocking mode using HAL_I2C_Slave_Seq_Receive_IT()
          or using HAL_I2C_Slave_Seq_Receive_DMA()
    (+++) At reception end of current frame transfer, HAL_I2C_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_SlaveRxCpltCallback()
    (++) In case of transfer Error, HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer HAL_I2C_ErrorCallback()

  *** Interrupt mode IO MEM operation ***
  =======================================
  [..]
    (+) Write an amount of data in non-blocking mode with Interrupt to a specific memory address using
        HAL_I2C_Mem_Write_IT()
    (+) At Memory end of write transfer, HAL_I2C_MemTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MemTxCpltCallback()
    (+) Read an amount of data in non-blocking mode with Interrupt from a specific memory address using
        HAL_I2C_Mem_Read_IT()
    (+) At Memory end of read transfer, HAL_I2C_MemRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MemRxCpltCallback()
    (+) In case of transfer Error, HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer HAL_I2C_ErrorCallback()

  *** DMA mode IO operation ***
  ==============================
  [..]
    (+) Transmit in master mode an amount of data in non-blocking mode (DMA) using
        HAL_I2C_Master_Transmit_DMA()
    (+) At transmission end of transfer, HAL_I2C_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MasterTxCpltCallback()
    (+) Receive in master mode an amount of data in non-blocking mode (DMA) using
        HAL_I2C_Master_Receive_DMA()
    (+) At reception end of transfer, HAL_I2C_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MasterRxCpltCallback()
    (+) Transmit in slave mode an amount of data in non-blocking mode (DMA) using
        HAL_I2C_Slave_Transmit_DMA()
    (+) At transmission end of transfer, HAL_I2C_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_SlaveTxCpltCallback()
    (+) Receive in slave mode an amount of data in non-blocking mode (DMA) using
        HAL_I2C_Slave_Receive_DMA()
    (+) At reception end of transfer, HAL_I2C_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_SlaveRxCpltCallback()
    (+) In case of transfer Error, HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer HAL_I2C_ErrorCallback()
    (+) Abort a master or memory I2C process communication with Interrupt using HAL_I2C_Master_Abort_IT()
    (+) End of abort process, HAL_I2C_AbortCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_AbortCpltCallback()

  *** DMA mode IO MEM operation ***
  =================================
  [..]
    (+) Write an amount of data in non-blocking mode with DMA to a specific memory address using
        HAL_I2C_Mem_Write_DMA()
    (+) At Memory end of write transfer, HAL_I2C_MemTxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MemTxCpltCallback()
    (+) Read an amount of data in non-blocking mode with DMA from a specific memory address using
        HAL_I2C_Mem_Read_DMA()
    (+) At Memory end of read transfer, HAL_I2C_MemRxCpltCallback() is executed and user can
         add his own code by customization of function pointer HAL_I2C_MemRxCpltCallback()
    (+) In case of transfer Error, HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer HAL_I2C_ErrorCallback()


   *** I2C HAL driver macros list ***
   ==================================
   [..]
     Below the list of most used macros in I2C HAL driver.

    (+) __HAL_I2C_ENABLE:     Enable the I2C peripheral
    (+) __HAL_I2C_DISABLE:    Disable the I2C peripheral
    (+) __HAL_I2C_GET_FLAG:   Checks whether the specified I2C flag is set or not
    (+) __HAL_I2C_CLEAR_FLAG: Clear the specified I2C pending flag
    (+) __HAL_I2C_ENABLE_IT:  Enable the specified I2C interrupt
    (+) __HAL_I2C_DISABLE_IT: Disable the specified I2C interrupt

   *** Callback registration ***
   =============================================
  [..]
   The compilation flag USE_HAL_I2C_REGISTER_CALLBACKS when set to 1
   allows the user to configure dynamically the driver callbacks.
   Use Functions HAL_I2C_RegisterCallback() or HAL_I2C_RegisterAddrCallback()
   to register an interrupt callback.
  [..]
   Function HAL_I2C_RegisterCallback() allows to register following callbacks:
     (+) MasterTxCpltCallback : callback for Master transmission end of transfer.
     (+) MasterRxCpltCallback : callback for Master reception end of transfer.
     (+) SlaveTxCpltCallback  : callback for Slave transmission end of transfer.
     (+) SlaveRxCpltCallback  : callback for Slave reception end of transfer.
     (+) ListenCpltCallback   : callback for end of listen mode.
     (+) MemTxCpltCallback    : callback for Memory transmission end of transfer.
     (+) MemRxCpltCallback    : callback for Memory reception end of transfer.
     (+) ErrorCallback        : callback for error detection.
     (+) AbortCpltCallback    : callback for abort completion process.
     (+) MspInitCallback      : callback for Msp Init.
     (+) MspDeInitCallback    : callback for Msp DeInit.
   This function takes as parameters the HAL peripheral handle, the Callback ID
   and a pointer to the user callback function.
  [..]
   For specific callback AddrCallback use dedicated register callbacks : HAL_I2C_RegisterAddrCallback().
  [..]
   Use function HAL_I2C_UnRegisterCallback to reset a callback to the default
   weak function.
   HAL_I2C_UnRegisterCallback takes as parameters the HAL peripheral handle,
   and the Callback ID.
   This function allows to reset following callbacks:
     (+) MasterTxCpltCallback : callback for Master transmission end of transfer.
     (+) MasterRxCpltCallback : callback for Master reception end of transfer.
     (+) SlaveTxCpltCallback  : callback for Slave transmission end of transfer.
     (+) SlaveRxCpltCallback  : callback for Slave reception end of transfer.
     (+) ListenCpltCallback   : callback for end of listen mode.
     (+) MemTxCpltCallback    : callback for Memory transmission end of transfer.
     (+) MemRxCpltCallback    : callback for Memory reception end of transfer.
     (+) ErrorCallback        : callback for error detection.
     (+) AbortCpltCallback    : callback for abort completion process.
     (+) MspInitCallback      : callback for Msp Init.
     (+) MspDeInitCallback    : callback for Msp DeInit.
  [..]
   For callback AddrCallback use dedicated register callbacks : HAL_I2C_UnRegisterAddrCallback().
  [..]
   By default, after the HAL_I2C_Init() and when the state is HAL_I2C_STATE_RESET
   all callbacks are set to the corresponding weak functions:
   examples HAL_I2C_MasterTxCpltCallback(), HAL_I2C_MasterRxCpltCallback().
   Exception done for MspInit and MspDeInit functions that are
   reset to the legacy weak functions in the HAL_I2C_Init()/ HAL_I2C_DeInit() only when
   these callbacks are null (not registered beforehand).
   If MspInit or MspDeInit are not null, the HAL_I2C_Init()/ HAL_I2C_DeInit()
   keep and use the user MspInit/MspDeInit callbacks (registered beforehand) whatever the state.
  [..]
   Callbacks can be registered/unregistered in HAL_I2C_STATE_READY state only.
   Exception done MspInit/MspDeInit functions that can be registered/unregistered
   in HAL_I2C_STATE_READY or HAL_I2C_STATE_RESET state,
   thus registered (user) MspInit/DeInit callbacks can be used during the Init/DeInit.
   Then, the user first registers the MspInit/MspDeInit user callbacks
   using HAL_I2C_RegisterCallback() before calling HAL_I2C_DeInit()
   or HAL_I2C_Init() function.
  [..]
   When the compilation flag USE_HAL_I2C_REGISTER_CALLBACKS is set to 0 or
   not defined, the callback registration feature is not available and all callbacks
   are set to the corresponding weak functions.



   [..]
     (@) You can refer to the I2C HAL driver header file for more useful macros

Definition in file stm32f4xx_hal_i2c.c.

Macros

Functions

Detailed Description