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

Functions
static void	I2C_DMAMasterTransmitCplt (DMA_HandleTypeDef *hdma)
	DMA I2C master transmit process complete callback. More...

static void	I2C_DMAMasterReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA I2C master receive process complete callback. More...

static void	I2C_DMASlaveTransmitCplt (DMA_HandleTypeDef *hdma)
	DMA I2C slave transmit process complete callback. More...

static void	I2C_DMASlaveReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA I2C slave receive process complete callback. More...

static void	I2C_DMAError (DMA_HandleTypeDef *hdma)
	DMA I2C communication error callback. More...

static void	I2C_DMAAbort (DMA_HandleTypeDef *hdma)
	DMA I2C communication abort callback (To be called at end of DMA Abort procedure). More...

static void	I2C_ITAddrCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
	I2C Address complete process callback. More...

static void	I2C_ITMasterSeqCplt (I2C_HandleTypeDef *hi2c)
	I2C Master sequential complete process. More...

static void	I2C_ITSlaveSeqCplt (I2C_HandleTypeDef *hi2c)
	I2C Slave sequential complete process. More...

static void	I2C_ITMasterCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
	I2C Master complete process. More...

static void	I2C_ITSlaveCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
	I2C Slave complete process. More...

static void	I2C_ITListenCplt (I2C_HandleTypeDef *hi2c, uint32_t ITFlags)
	I2C Listen complete process. More...

static void	I2C_ITError (I2C_HandleTypeDef *hi2c, uint32_t ErrorCode)
	I2C interrupts error process. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static HAL_StatusTypeDef	I2C_IsAcknowledgeFailed (I2C_HandleTypeDef *hi2c, uint32_t Timeout, uint32_t Tickstart)
	This function handles Acknowledge failed detection during an I2C Communication. More...

static void	I2C_Enable_IRQ (I2C_HandleTypeDef *hi2c, uint16_t InterruptRequest)
	Manage the enabling of Interrupts. More...

static void	I2C_Disable_IRQ (I2C_HandleTypeDef *hi2c, uint16_t InterruptRequest)
	Manage the disabling of Interrupts. More...

static void	I2C_Flush_TXDR (I2C_HandleTypeDef *hi2c)
	I2C Tx data register flush process. More...

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). More...

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

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. More...

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

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

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

HAL_StatusTypeDef	HAL_I2C_RegisterCallback (I2C_HandleTypeDef *hi2c, HAL_I2C_CallbackIDTypeDef CallbackID, pI2C_CallbackTypeDef pCallback)
	Register a User I2C Callback To be used instead of the weak predefined callback. More...

HAL_StatusTypeDef	HAL_I2C_UnRegisterCallback (I2C_HandleTypeDef *hi2c, HAL_I2C_CallbackIDTypeDef CallbackID)
	Unregister an I2C Callback I2C callback is redirected to the weak predefined callback. More...

HAL_StatusTypeDef	HAL_I2C_RegisterAddrCallback (I2C_HandleTypeDef *hi2c, pI2C_AddrCallbackTypeDef pCallback)
	Register the Slave Address Match I2C Callback To be used instead of the weak HAL_I2C_AddrCallback() predefined callback. More...

HAL_StatusTypeDef	HAL_I2C_UnRegisterAddrCallback (I2C_HandleTypeDef *hi2c)
	UnRegister the Slave Address Match I2C Callback Info Ready I2C Callback is redirected to the weak HAL_I2C_AddrCallback() predefined callback. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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 I2C mode an amount of data in non-blocking mode with DMA. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	HAL_I2C_ListenCpltCallback (I2C_HandleTypeDef *hi2c)
	Listen Complete callback. More...

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

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

void	HAL_I2C_ErrorCallback (I2C_HandleTypeDef *hi2c)
	I2C error callback. More...

void	HAL_I2C_AbortCpltCallback (I2C_HandleTypeDef *hi2c)
	I2C abort callback. More...

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...

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 and Errors functions

==============================================================================
                      ##### 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 @ref 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 channel
          (+++) Enable the DMAx interface clock using
          (+++) Configure the DMA handle parameters
          (+++) Configure the DMA Tx or Rx channel
          (+++) 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 channel

  (#) Configure the Communication Clock Timing, Own Address1, Master Addressing mode, Dual Addressing mode,
      Own Address2, Own Address2 Mask, General call and Nostretch mode in the hi2c Init structure.

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

  (#) To check if target device is ready for communication, use the function @ref 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 @ref HAL_I2C_Master_Transmit()
    (+) Receive in master mode an amount of data in blocking mode using @ref HAL_I2C_Master_Receive()
    (+) Transmit in slave mode an amount of data in blocking mode using @ref HAL_I2C_Slave_Transmit()
    (+) Receive in slave mode an amount of data in blocking mode using @ref HAL_I2C_Slave_Receive()

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


  *** Interrupt mode IO operation ***
  ===================================
  [..]
    (+) Transmit in master mode an amount of data in non-blocking mode using @ref HAL_I2C_Master_Transmit_IT()
    (+) At transmission end of transfer, @ref HAL_I2C_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_MasterTxCpltCallback()
    (+) Receive in master mode an amount of data in non-blocking mode using @ref HAL_I2C_Master_Receive_IT()
    (+) At reception end of transfer, @ref HAL_I2C_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_MasterRxCpltCallback()
    (+) Transmit in slave mode an amount of data in non-blocking mode using @ref HAL_I2C_Slave_Transmit_IT()
    (+) At transmission end of transfer, @ref HAL_I2C_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_SlaveTxCpltCallback()
    (+) Receive in slave mode an amount of data in non-blocking mode using @ref HAL_I2C_Slave_Receive_IT()
    (+) At reception end of transfer, @ref HAL_I2C_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_SlaveRxCpltCallback()
    (+) In case of transfer Error, @ref HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_ErrorCallback()
    (+) Abort a master I2C process communication with Interrupt using @ref HAL_I2C_Master_Abort_IT()
    (+) End of abort process, @ref HAL_I2C_AbortCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_AbortCpltCallback()
    (+) Discard a slave I2C process communication using @ref __HAL_I2C_GENERATE_NACK() macro.
         This action will inform Master to generate a Stop condition to discard the communication.


  *** 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 @ref I2C_XFEROPTIONS and are listed below:
    (++) I2C_FIRST_AND_LAST_FRAME: No sequential usage, functionnal 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 @ref HAL_I2C_Master_Seq_Transmit_IT() then @ref HAL_I2C_Master_Seq_Transmit_IT()
                          or @ref HAL_I2C_Master_Seq_Transmit_DMA() then @ref 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 oposite 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.

    (+) Differents sequential I2C interfaces are listed below:
    (++) Sequential transmit in master I2C mode an amount of data in non-blocking mode using @ref HAL_I2C_Master_Seq_Transmit_IT()
          or using @ref HAL_I2C_Master_Seq_Transmit_DMA()
    (+++) At transmission end of current frame transfer, @ref HAL_I2C_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_MasterTxCpltCallback()
    (++) Sequential receive in master I2C mode an amount of data in non-blocking mode using @ref HAL_I2C_Master_Seq_Receive_IT()
          or using @ref HAL_I2C_Master_Seq_Receive_DMA()
    (+++) At reception end of current frame transfer, @ref HAL_I2C_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_MasterRxCpltCallback()
    (++) Abort a master IT or DMA I2C process communication with Interrupt using @ref HAL_I2C_Master_Abort_IT()
    (+++) End of abort process, @ref HAL_I2C_AbortCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_AbortCpltCallback()
    (++) Enable/disable the Address listen mode in slave I2C mode using @ref HAL_I2C_EnableListen_IT() @ref HAL_I2C_DisableListen_IT()
    (+++) When address slave I2C match, @ref 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 @ref HAL_I2C_ListenCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_ListenCpltCallback()
    (++) Sequential transmit in slave I2C mode an amount of data in non-blocking mode using @ref HAL_I2C_Slave_Seq_Transmit_IT()
          or using @ref HAL_I2C_Slave_Seq_Transmit_DMA()
    (+++) At transmission end of current frame transfer, @ref HAL_I2C_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_SlaveTxCpltCallback()
    (++) Sequential receive in slave I2C mode an amount of data in non-blocking mode using @ref HAL_I2C_Slave_Seq_Receive_IT()
          or using @ref HAL_I2C_Slave_Seq_Receive_DMA()
    (+++) At reception end of current frame transfer, @ref HAL_I2C_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_SlaveRxCpltCallback()
    (++) In case of transfer Error, @ref HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_ErrorCallback()
    (++) Discard a slave I2C process communication using @ref __HAL_I2C_GENERATE_NACK() macro.
         This action will inform Master to generate a Stop condition to discard the communication.

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

  *** DMA mode IO operation ***
  ==============================
  [..]
    (+) Transmit in master mode an amount of data in non-blocking mode (DMA) using
        @ref HAL_I2C_Master_Transmit_DMA()
    (+) At transmission end of transfer, @ref HAL_I2C_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_MasterTxCpltCallback()
    (+) Receive in master mode an amount of data in non-blocking mode (DMA) using
        @ref HAL_I2C_Master_Receive_DMA()
    (+) At reception end of transfer, @ref HAL_I2C_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_MasterRxCpltCallback()
    (+) Transmit in slave mode an amount of data in non-blocking mode (DMA) using
        @ref HAL_I2C_Slave_Transmit_DMA()
    (+) At transmission end of transfer, @ref HAL_I2C_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_SlaveTxCpltCallback()
    (+) Receive in slave mode an amount of data in non-blocking mode (DMA) using
        @ref HAL_I2C_Slave_Receive_DMA()
    (+) At reception end of transfer, @ref HAL_I2C_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_SlaveRxCpltCallback()
    (+) In case of transfer Error, @ref HAL_I2C_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_ErrorCallback()
    (+) Abort a master I2C process communication with Interrupt using @ref HAL_I2C_Master_Abort_IT()
    (+) End of abort process, @ref HAL_I2C_AbortCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_I2C_AbortCpltCallback()
    (+) Discard a slave I2C process communication using @ref __HAL_I2C_GENERATE_NACK() macro.
         This action will inform Master to generate a Stop condition to discard the communication.

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


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

    (+) @ref __HAL_I2C_ENABLE: Enable the I2C peripheral
    (+) @ref __HAL_I2C_DISABLE: Disable the I2C peripheral
    (+) @ref __HAL_I2C_GENERATE_NACK: Generate a Non-Acknowledge I2C peripheral in Slave mode
    (+) @ref __HAL_I2C_GET_FLAG: Check whether the specified I2C flag is set or not
    (+) @ref __HAL_I2C_CLEAR_FLAG: Clear the specified I2C pending flag
    (+) @ref __HAL_I2C_ENABLE_IT: Enable the specified I2C interrupt
    (+) @ref __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 @ref HAL_I2C_RegisterCallback() or @ref HAL_I2C_RegisterAddrCallback()
   to register an interrupt callback.
  [..]
   Function @ref 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 : @ref HAL_I2C_RegisterAddrCallback().
  [..]
   Use function @ref HAL_I2C_UnRegisterCallback to reset a callback to the default
   weak function.
   @ref 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 : @ref HAL_I2C_UnRegisterAddrCallback().
  [..]
   By default, after the @ref HAL_I2C_Init() and when the state is @ref HAL_I2C_STATE_RESET
   all callbacks are set to the corresponding weak functions:
   examples @ref HAL_I2C_MasterTxCpltCallback(), @ref HAL_I2C_MasterRxCpltCallback().
   Exception done for MspInit and MspDeInit functions that are
   reset to the legacy weak functions in the @ref HAL_I2C_Init()/ @ref HAL_I2C_DeInit() only when
   these callbacks are null (not registered beforehand).
   If MspInit or MspDeInit are not null, the @ref HAL_I2C_Init()/ @ref HAL_I2C_DeInit()
   keep and use the user MspInit/MspDeInit callbacks (registered beforehand) whatever the state.
  [..]
   Callbacks can be registered/unregistered in @ref HAL_I2C_STATE_READY state only.
   Exception done MspInit/MspDeInit functions that can be registered/unregistered
   in @ref HAL_I2C_STATE_READY or @ref 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 @ref HAL_I2C_RegisterCallback() before calling @ref HAL_I2C_DeInit()
   or @ref 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

Attention

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_i2c.c.

Functions

Detailed Description

© Copyright (c) 2017 STMicroelectronics. All rights reserved.