DIY Logging Volt/Ampmeter
Macros
I2C Exported Macros
STM32F1xx_HAL_Driver » I2C

Macros

#define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
 Reset I2C handle state. More...
 
#define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__))
 Enable or disable the specified I2C interrupts. More...
 
#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. More...
 
#define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__)
 Checks whether the specified I2C flag is set or not. More...
 
#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. More...
 
#define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__)
 Clears the I2C ADDR pending flag. More...
 
#define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__)
 Clears the I2C STOPF pending flag. More...
 
#define __HAL_I2C_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
 Enable the specified I2C peripheral. More...
 
#define __HAL_I2C_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
 Disable the specified I2C peripheral. More...
 

Detailed Description

Macro Definition Documentation

◆ __HAL_I2C_CLEAR_ADDRFLAG

#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
<strong>HANDLE</strong>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.

◆ __HAL_I2C_CLEAR_FLAG

#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
<strong>HANDLE</strong>specifies the I2C Handle.
<strong>FLAG</strong>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.

◆ __HAL_I2C_CLEAR_STOPFLAG

#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
<strong>HANDLE</strong>specifies the I2C Handle.
Return values
None

Definition at line 509 of file stm32f1xx_hal_i2c.h.

◆ __HAL_I2C_DISABLE

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

Disable the specified I2C peripheral.

Parameters
<strong>HANDLE</strong>specifies the I2C Handle.
Return values
None

Definition at line 527 of file stm32f1xx_hal_i2c.h.

◆ __HAL_I2C_DISABLE_IT

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

Definition at line 440 of file stm32f1xx_hal_i2c.h.

◆ __HAL_I2C_ENABLE

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

Enable the specified I2C peripheral.

Parameters
<strong>HANDLE</strong>specifies the I2C Handle.
Return values
None

Definition at line 521 of file stm32f1xx_hal_i2c.h.

◆ __HAL_I2C_ENABLE_IT

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

Enable or disable the specified I2C interrupts.

Parameters
<strong>HANDLE</strong>specifies the I2C Handle.
<strong>INTERRUPT</strong>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.

◆ __HAL_I2C_GET_FLAG

#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
<strong>HANDLE</strong>specifies the I2C Handle.
<strong>FLAG</strong>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.

◆ __HAL_I2C_GET_IT_SOURCE

#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
<strong>HANDLE</strong>specifies the I2C Handle.
<strong>INTERRUPT</strong>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.

◆ __HAL_I2C_RESET_HANDLE_STATE

#define __HAL_I2C_RESET_HANDLE_STATE (   __HANDLE__)    ((__HANDLE__)->State = HAL_I2C_STATE_RESET)

Reset I2C handle state.

Parameters
<strong>HANDLE</strong>specifies the I2C Handle.
Return values
None

Definition at line 427 of file stm32f1xx_hal_i2c.h.

I2C_CR1_PE
#define I2C_CR1_PE
Definition: stm32f103xb.h:9206
I2C_FLAG_MASK
#define I2C_FLAG_MASK
Definition: stm32f1xx_hal_i2c.h:645
RESET
@ RESET
Definition: stm32f1xx.h:153
SET
@ SET
Definition: stm32f1xx.h:154
SET_BIT
#define SET_BIT(REG, BIT)
Definition: stm32f1xx.h:178