STM32F103xB HAL User Manual
Defines
I2C Exported Macros
I2C

Defines

#define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__)
 Reset I2C handle state.
#define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__))
 Enable or disable the specified I2C interrupts.
#define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
#define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
 Checks if the specified I2C interrupt source is enabled or disabled.
#define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__)
 Checks whether the specified I2C flag is set or not.
#define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))
 Clears the I2C pending flags which are cleared by writing 0 in a specific bit.
#define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__)
 Clears the I2C ADDR pending flag.
#define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__)
 Clears the I2C STOPF pending flag.
#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 Documentation

#define __HAL_I2C_CLEAR_ADDRFLAG (   __HANDLE__)
Value:
do{                                           \
    __IO uint32_t tmpreg = 0x00U;               \
    tmpreg = (__HANDLE__)->Instance->SR1;       \
    tmpreg = (__HANDLE__)->Instance->SR2;       \
    UNUSED(tmpreg);                             \
  } while(0)

Clears the I2C ADDR pending flag.

Parameters:
__HANDLE__specifies the I2C Handle. This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
Return values:
None

Definition at line 497 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_IsDeviceReady(), HAL_I2C_Master_Receive(), HAL_I2C_Master_Transmit(), HAL_I2C_Mem_Read(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Write_DMA(), HAL_I2C_Slave_Receive(), HAL_I2C_Slave_Seq_Receive_DMA(), HAL_I2C_Slave_Seq_Receive_IT(), HAL_I2C_Slave_Seq_Transmit_DMA(), HAL_I2C_Slave_Seq_Transmit_IT(), HAL_I2C_Slave_Transmit(), I2C_Master_ADDR(), I2C_MasterRequestRead(), I2C_RequestMemoryRead(), I2C_RequestMemoryWrite(), and I2C_Slave_ADDR().

#define __HAL_I2C_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))

Clears the I2C pending flags which are cleared by writing 0 in a specific bit.

Parameters:
__HANDLE__specifies the I2C Handle.
__FLAG__specifies the flag to clear. This parameter can be any combination of the following values:
  • I2C_FLAG_OVR: Overrun/Underrun flag (Slave mode)
  • I2C_FLAG_AF: Acknowledge failure flag
  • I2C_FLAG_ARLO: Arbitration lost flag (Master mode)
  • I2C_FLAG_BERR: Bus error flag
Return values:
None

Definition at line 490 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_ER_IRQHandler(), HAL_I2C_IsDeviceReady(), HAL_I2C_Slave_Transmit(), I2C_IsAcknowledgeFailed(), I2C_Slave_AF(), I2C_WaitOnMasterAddressFlagUntilTimeout(), and I2C_WaitOnRXNEFlagUntilTimeout().

#define __HAL_I2C_CLEAR_STOPFLAG (   __HANDLE__)
Value:
do{                                                  \
    __IO uint32_t tmpreg = 0x00U;                      \
    tmpreg = (__HANDLE__)->Instance->SR1;              \
    SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE);  \
    UNUSED(tmpreg);                                    \
  } while(0)

Clears the I2C STOPF pending flag.

Parameters:
__HANDLE__specifies the I2C Handle.
Return values:
None

Definition at line 509 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_Slave_Receive(), and I2C_Slave_STOPF().

#define __HAL_I2C_DISABLE (   __HANDLE__)    CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)

Disable the specified I2C peripheral.

Parameters:
__HANDLE__specifies the I2C Handle.
Return values:
None

Definition at line 527 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_DeInit(), HAL_I2C_Init(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Write_DMA(), I2C_DMAAbort(), and I2C_ITError().

#define __HAL_I2C_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))

Definition at line 440 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_DisableListen_IT(), HAL_I2C_Master_Abort_IT(), HAL_I2C_Slave_Seq_Receive_DMA(), HAL_I2C_Slave_Seq_Transmit_DMA(), I2C_DMAXferCplt(), I2C_ITError(), I2C_MasterReceive_BTF(), I2C_MasterReceive_RXNE(), I2C_MasterTransmit_BTF(), I2C_MasterTransmit_TXE(), I2C_MemoryTransmit_TXE_BTF(), I2C_Slave_ADDR(), I2C_Slave_AF(), I2C_Slave_STOPF(), I2C_SlaveReceive_RXNE(), and I2C_SlaveTransmit_TXE().

#define __HAL_I2C_ENABLE (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)

Enable the specified I2C peripheral.

Parameters:
__HANDLE__specifies the I2C Handle.
Return values:
None

Definition at line 521 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_EnableListen_IT(), HAL_I2C_Init(), HAL_I2C_IsDeviceReady(), HAL_I2C_Master_Receive(), HAL_I2C_Master_Receive_DMA(), HAL_I2C_Master_Receive_IT(), HAL_I2C_Master_Seq_Receive_DMA(), HAL_I2C_Master_Seq_Receive_IT(), HAL_I2C_Master_Seq_Transmit_DMA(), HAL_I2C_Master_Seq_Transmit_IT(), HAL_I2C_Master_Transmit(), HAL_I2C_Master_Transmit_DMA(), HAL_I2C_Master_Transmit_IT(), HAL_I2C_Mem_Read(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Read_IT(), HAL_I2C_Mem_Write(), HAL_I2C_Mem_Write_DMA(), HAL_I2C_Mem_Write_IT(), HAL_I2C_Slave_Receive(), HAL_I2C_Slave_Receive_DMA(), HAL_I2C_Slave_Receive_IT(), HAL_I2C_Slave_Seq_Receive_DMA(), HAL_I2C_Slave_Seq_Receive_IT(), HAL_I2C_Slave_Seq_Transmit_DMA(), HAL_I2C_Slave_Seq_Transmit_IT(), HAL_I2C_Slave_Transmit(), HAL_I2C_Slave_Transmit_DMA(), HAL_I2C_Slave_Transmit_IT(), and I2C_DMAAbort().

#define __HAL_I2C_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__))

Enable or disable the specified I2C interrupts.

Parameters:
__HANDLE__specifies the I2C Handle.
__INTERRUPT__specifies the interrupt source to enable or disable. This parameter can be one of the following values:
  • I2C_IT_BUF: Buffer interrupt enable
  • I2C_IT_EVT: Event interrupt enable
  • I2C_IT_ERR: Error interrupt enable
Return values:
None

Definition at line 439 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_EnableListen_IT(), HAL_I2C_Master_Receive_DMA(), HAL_I2C_Master_Receive_IT(), HAL_I2C_Master_Seq_Receive_DMA(), HAL_I2C_Master_Seq_Receive_IT(), HAL_I2C_Master_Seq_Transmit_DMA(), HAL_I2C_Master_Seq_Transmit_IT(), HAL_I2C_Master_Transmit_DMA(), HAL_I2C_Master_Transmit_IT(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Read_IT(), HAL_I2C_Mem_Write_DMA(), HAL_I2C_Mem_Write_IT(), HAL_I2C_Slave_Receive_DMA(), HAL_I2C_Slave_Receive_IT(), HAL_I2C_Slave_Seq_Receive_DMA(), HAL_I2C_Slave_Seq_Receive_IT(), HAL_I2C_Slave_Seq_Transmit_DMA(), HAL_I2C_Slave_Seq_Transmit_IT(), HAL_I2C_Slave_Transmit_DMA(), HAL_I2C_Slave_Transmit_IT(), and I2C_DMAXferCplt().

#define __HAL_I2C_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)
Value:
((((uint8_t)((__FLAG__) >> 16U)) == 0x01U) ? \
                                                  (((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET) : \
                                                  (((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET))

Checks whether the specified I2C flag is set or not.

Parameters:
__HANDLE__specifies the I2C Handle.
__FLAG__specifies the flag to check. This parameter can be one of the following values:
  • I2C_FLAG_OVR: Overrun/Underrun flag
  • I2C_FLAG_AF: Acknowledge failure flag
  • I2C_FLAG_ARLO: Arbitration lost flag
  • I2C_FLAG_BERR: Bus error flag
  • I2C_FLAG_TXE: Data register empty flag
  • I2C_FLAG_RXNE: Data register not empty flag
  • I2C_FLAG_STOPF: Stop detection flag
  • I2C_FLAG_ADD10: 10-bit header sent flag
  • I2C_FLAG_BTF: Byte transfer finished flag
  • I2C_FLAG_ADDR: Address sent flag Address matched flag
  • I2C_FLAG_SB: Start bit flag
  • I2C_FLAG_DUALF: Dual flag
  • I2C_FLAG_GENCALL: General call header flag
  • I2C_FLAG_TRA: Transmitter/Receiver flag
  • I2C_FLAG_BUSY: Bus busy flag
  • I2C_FLAG_MSL: Master/Slave flag
Return values:
Thenew state of __FLAG__ (TRUE or FALSE).

Definition at line 476 of file stm32f1xx_hal_i2c.h.

Referenced by HAL_I2C_IsDeviceReady(), HAL_I2C_Master_Abort_IT(), HAL_I2C_Master_Receive(), HAL_I2C_Master_Receive_DMA(), HAL_I2C_Master_Receive_IT(), HAL_I2C_Master_Seq_Receive_DMA(), HAL_I2C_Master_Seq_Receive_IT(), HAL_I2C_Master_Seq_Transmit_DMA(), HAL_I2C_Master_Seq_Transmit_IT(), HAL_I2C_Master_Transmit(), HAL_I2C_Master_Transmit_DMA(), HAL_I2C_Master_Transmit_IT(), HAL_I2C_Mem_Read(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Read_IT(), HAL_I2C_Mem_Write(), HAL_I2C_Mem_Write_DMA(), HAL_I2C_Mem_Write_IT(), HAL_I2C_Slave_Receive(), HAL_I2C_Slave_Transmit(), I2C_IsAcknowledgeFailed(), I2C_ITError(), I2C_Slave_STOPF(), I2C_WaitOnBTFFlagUntilTimeout(), I2C_WaitOnFlagUntilTimeout(), I2C_WaitOnMasterAddressFlagUntilTimeout(), I2C_WaitOnRXNEFlagUntilTimeout(), I2C_WaitOnSTOPFlagUntilTimeout(), and I2C_WaitOnTXEFlagUntilTimeout().

#define __HAL_I2C_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)    ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

Checks if the specified I2C interrupt source is enabled or disabled.

Parameters:
__HANDLE__specifies the I2C Handle.
__INTERRUPT__specifies the I2C interrupt source to check. This parameter can be one of the following values:
  • I2C_IT_BUF: Buffer interrupt enable
  • I2C_IT_EVT: Event interrupt enable
  • I2C_IT_ERR: Error interrupt enable
Return values:
Thenew state of __INTERRUPT__ (TRUE or FALSE).

Definition at line 451 of file stm32f1xx_hal_i2c.h.

#define __HAL_I2C_RESET_HANDLE_STATE (   __HANDLE__)
Value:
do{                                                   \
                                                                    (__HANDLE__)->State = HAL_I2C_STATE_RESET;       \
                                                                    (__HANDLE__)->MspInitCallback = NULL;            \
                                                                    (__HANDLE__)->MspDeInitCallback = NULL;          \
                                                                  } while(0)

Reset I2C handle state.

Parameters:
__HANDLE__specifies the I2C Handle.
Return values:
None

Definition at line 421 of file stm32f1xx_hal_i2c.h.

Generated on Tue May 18 2021 12:53:09 for STM32F103xB HAL User Manual by   doxygen 1.7.6.1