STM32H735xx HAL User Manual: stm32h7xx_hal

Header file of I2C HAL module. More...

#include "stm32h7xx_hal_def.h"
#include "stm32h7xx_hal_i2c_ex.h"

Data Structures
struct	I2C_InitTypeDef
struct	__I2C_HandleTypeDef
Defines
#define	HAL_I2C_ERROR_NONE (0x00000000U)
#define	HAL_I2C_ERROR_BERR (0x00000001U)
#define	HAL_I2C_ERROR_ARLO (0x00000002U)
#define	HAL_I2C_ERROR_AF (0x00000004U)
#define	HAL_I2C_ERROR_OVR (0x00000008U)
#define	HAL_I2C_ERROR_DMA (0x00000010U)
#define	HAL_I2C_ERROR_TIMEOUT (0x00000020U)
#define	HAL_I2C_ERROR_SIZE (0x00000040U)
#define	HAL_I2C_ERROR_DMA_PARAM (0x00000080U)
#define	HAL_I2C_ERROR_INVALID_CALLBACK (0x00000100U)
#define	HAL_I2C_ERROR_INVALID_PARAM (0x00000200U)
#define	I2C_FIRST_FRAME ((uint32_t)I2C_SOFTEND_MODE)
#define	I2C_FIRST_AND_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE \| I2C_SOFTEND_MODE))
#define	I2C_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE \| I2C_SOFTEND_MODE))
#define	I2C_FIRST_AND_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE)
#define	I2C_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE)
#define	I2C_LAST_FRAME_NO_STOP ((uint32_t)I2C_SOFTEND_MODE)
#define	I2C_OTHER_FRAME (0x000000AAU)
#define	I2C_OTHER_AND_LAST_FRAME (0x0000AA00U)
#define	I2C_ADDRESSINGMODE_7BIT (0x00000001U)
#define	I2C_ADDRESSINGMODE_10BIT (0x00000002U)
#define	I2C_DUALADDRESS_DISABLE (0x00000000U)
#define	I2C_DUALADDRESS_ENABLE I2C_OAR2_OA2EN
#define	I2C_OA2_NOMASK ((uint8_t)0x00U)
#define	I2C_OA2_MASK01 ((uint8_t)0x01U)
#define	I2C_OA2_MASK02 ((uint8_t)0x02U)
#define	I2C_OA2_MASK03 ((uint8_t)0x03U)
#define	I2C_OA2_MASK04 ((uint8_t)0x04U)
#define	I2C_OA2_MASK05 ((uint8_t)0x05U)
#define	I2C_OA2_MASK06 ((uint8_t)0x06U)
#define	I2C_OA2_MASK07 ((uint8_t)0x07U)
#define	I2C_GENERALCALL_DISABLE (0x00000000U)
#define	I2C_GENERALCALL_ENABLE I2C_CR1_GCEN
#define	I2C_NOSTRETCH_DISABLE (0x00000000U)
#define	I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
#define	I2C_MEMADD_SIZE_8BIT (0x00000001U)
#define	I2C_MEMADD_SIZE_16BIT (0x00000002U)
#define	I2C_DIRECTION_TRANSMIT (0x00000000U)
#define	I2C_DIRECTION_RECEIVE (0x00000001U)
#define	I2C_RELOAD_MODE I2C_CR2_RELOAD
#define	I2C_AUTOEND_MODE I2C_CR2_AUTOEND
#define	I2C_SOFTEND_MODE (0x00000000U)
#define	I2C_NO_STARTSTOP (0x00000000U)
#define	I2C_GENERATE_STOP (uint32_t)(0x80000000U \| I2C_CR2_STOP)
#define	I2C_GENERATE_START_READ (uint32_t)(0x80000000U \| I2C_CR2_START \| I2C_CR2_RD_WRN)
#define	I2C_GENERATE_START_WRITE (uint32_t)(0x80000000U \| I2C_CR2_START)
#define	I2C_IT_ERRI I2C_CR1_ERRIE
#define	I2C_IT_TCI I2C_CR1_TCIE
#define	I2C_IT_STOPI I2C_CR1_STOPIE
#define	I2C_IT_NACKI I2C_CR1_NACKIE
#define	I2C_IT_ADDRI I2C_CR1_ADDRIE
#define	I2C_IT_RXI I2C_CR1_RXIE
#define	I2C_IT_TXI I2C_CR1_TXIE
#define	I2C_FLAG_TXE I2C_ISR_TXE
#define	I2C_FLAG_TXIS I2C_ISR_TXIS
#define	I2C_FLAG_RXNE I2C_ISR_RXNE
#define	I2C_FLAG_ADDR I2C_ISR_ADDR
#define	I2C_FLAG_AF I2C_ISR_NACKF
#define	I2C_FLAG_STOPF I2C_ISR_STOPF
#define	I2C_FLAG_TC I2C_ISR_TC
#define	I2C_FLAG_TCR I2C_ISR_TCR
#define	I2C_FLAG_BERR I2C_ISR_BERR
#define	I2C_FLAG_ARLO I2C_ISR_ARLO
#define	I2C_FLAG_OVR I2C_ISR_OVR
#define	I2C_FLAG_PECERR I2C_ISR_PECERR
#define	I2C_FLAG_TIMEOUT I2C_ISR_TIMEOUT
#define	I2C_FLAG_ALERT I2C_ISR_ALERT
#define	I2C_FLAG_BUSY I2C_ISR_BUSY
#define	I2C_FLAG_DIR I2C_ISR_DIR
#define	__HAL_I2C_RESET_HANDLE_STATE(__HANDLE__)
	Reset I2C handle state.
#define	__HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 \|= (__INTERRUPT__))
	Enable the specified I2C interrupt.
#define	__HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__)))
	Disable the specified I2C interrupt.
#define	__HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified I2C interrupt source is enabled or not.
#define	I2C_FLAG_MASK (0x0001FFFFU)
	Check whether the specified I2C flag is set or not.
#define	__HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__)
#define	__HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the I2C pending flags which are cleared by writing 1 in a specific bit.
#define	__HAL_I2C_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))
	Enable the specified I2C peripheral.
#define	__HAL_I2C_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))
	Disable the specified I2C peripheral.
#define	__HAL_I2C_GENERATE_NACK(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR2, I2C_CR2_NACK))
	Generate a Non-Acknowledge I2C peripheral in Slave mode.
#define	IS_I2C_ADDRESSING_MODE(MODE)
#define	IS_I2C_DUAL_ADDRESS(ADDRESS)
#define	IS_I2C_OWN_ADDRESS2_MASK(MASK)
#define	IS_I2C_GENERAL_CALL(CALL)
#define	IS_I2C_NO_STRETCH(STRETCH)
#define	IS_I2C_MEMADD_SIZE(SIZE)
#define	IS_TRANSFER_MODE(MODE)
#define	IS_TRANSFER_REQUEST(REQUEST)
#define	IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST)
#define	IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST)
#define	I2C_RESET_CR2(__HANDLE__)
#define	I2C_GET_ADDR_MATCH(__HANDLE__)
#define	I2C_GET_DIR(__HANDLE__)
#define	I2C_GET_STOP_MODE(__HANDLE__) ((__HANDLE__)->Instance->CR2 & I2C_CR2_AUTOEND)
#define	I2C_GET_OWN_ADDRESS1(__HANDLE__) ((uint16_t)((__HANDLE__)->Instance->OAR1 & I2C_OAR1_OA1))
#define	I2C_GET_OWN_ADDRESS2(__HANDLE__) ((uint16_t)((__HANDLE__)->Instance->OAR2 & I2C_OAR2_OA2))
#define	IS_I2C_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= 0x000003FFU)
#define	IS_I2C_OWN_ADDRESS2(ADDRESS2) ((ADDRESS2) <= (uint16_t)0x00FFU)
#define	I2C_MEM_ADD_MSB(__ADDRESS__)
#define	I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FFU))))
#define	I2C_GENERATE_START(__ADDMODE__, __ADDRESS__)
#define	I2C_CHECK_FLAG(__ISR__, __FLAG__)
#define	I2C_CHECK_IT_SOURCE(__CR1__, __IT__) ((((__CR1__) & (__IT__)) == (__IT__)) ? SET : RESET)
Typedefs
typedef struct __I2C_HandleTypeDef	I2C_HandleTypeDef
typedef void(*	pI2C_CallbackTypeDef )(I2C_HandleTypeDef *hi2c)
	HAL I2C Callback pointer definition.
typedef void(*	pI2C_AddrCallbackTypeDef )(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode)
Enumerations
enum	HAL_I2C_StateTypeDef { HAL_I2C_STATE_RESET = 0x00U, HAL_I2C_STATE_READY = 0x20U, HAL_I2C_STATE_BUSY = 0x24U, HAL_I2C_STATE_BUSY_TX = 0x21U, HAL_I2C_STATE_BUSY_RX = 0x22U, HAL_I2C_STATE_LISTEN = 0x28U, HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, HAL_I2C_STATE_ABORT = 0x60U, HAL_I2C_STATE_TIMEOUT = 0xA0U, HAL_I2C_STATE_ERROR = 0xE0U }
enum	HAL_I2C_ModeTypeDef { HAL_I2C_MODE_NONE = 0x00U, HAL_I2C_MODE_MASTER = 0x10U, HAL_I2C_MODE_SLAVE = 0x20U, HAL_I2C_MODE_MEM = 0x40U }
enum	HAL_I2C_CallbackIDTypeDef { HAL_I2C_MASTER_TX_COMPLETE_CB_ID = 0x00U, HAL_I2C_MASTER_RX_COMPLETE_CB_ID = 0x01U, HAL_I2C_SLAVE_TX_COMPLETE_CB_ID = 0x02U, HAL_I2C_SLAVE_RX_COMPLETE_CB_ID = 0x03U, HAL_I2C_LISTEN_COMPLETE_CB_ID = 0x04U, HAL_I2C_MEM_TX_COMPLETE_CB_ID = 0x05U, HAL_I2C_MEM_RX_COMPLETE_CB_ID = 0x06U, HAL_I2C_ERROR_CB_ID = 0x07U, HAL_I2C_ABORT_CB_ID = 0x08U, HAL_I2C_MSPINIT_CB_ID = 0x09U, HAL_I2C_MSPDEINIT_CB_ID = 0x0AU }
	HAL I2C Callback ID enumeration definition. More...
Functions
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.
__weak void	HAL_I2C_MspInit (I2C_HandleTypeDef *hi2c)
	Initialize the I2C MSP.
__weak void	HAL_I2C_MspDeInit (I2C_HandleTypeDef *hi2c)
	DeInitialize the I2C MSP.
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.
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.
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.
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.
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_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_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_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_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_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_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_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.
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.
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 I2C IT or DMA process communication 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_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_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_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.
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.
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.
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.
__weak void	HAL_I2C_MasterTxCpltCallback (I2C_HandleTypeDef *hi2c)
	Master Tx Transfer completed callback.
__weak void	HAL_I2C_MasterRxCpltCallback (I2C_HandleTypeDef *hi2c)
	Master Rx Transfer completed callback.
__weak void	HAL_I2C_SlaveTxCpltCallback (I2C_HandleTypeDef *hi2c)
	Slave Tx Transfer completed callback.
__weak void	HAL_I2C_SlaveRxCpltCallback (I2C_HandleTypeDef *hi2c)
	Slave Rx Transfer completed callback.
__weak void	HAL_I2C_AddrCallback (I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode)
	Slave Address Match callback.
__weak void	HAL_I2C_ListenCpltCallback (I2C_HandleTypeDef *hi2c)
	Listen Complete callback.
__weak void	HAL_I2C_MemTxCpltCallback (I2C_HandleTypeDef *hi2c)
	Memory Tx Transfer completed callback.
__weak void	HAL_I2C_MemRxCpltCallback (I2C_HandleTypeDef *hi2c)
	Memory Rx Transfer completed callback.
__weak void	HAL_I2C_ErrorCallback (I2C_HandleTypeDef *hi2c)
	I2C error callback.
__weak 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

Header file of I2C HAL module.

Author:: MCD Application Team

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.

Definition in file stm32h7xx_hal_i2c.h.

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description