FMPI2C Exported Macros

Collaboration diagram for FMPI2C Exported Macros:

Macros
#define	__HAL_FMPI2C_RESET_HANDLE_STATE(__HANDLE__)
	Reset FMPI2C handle state.
#define	__HAL_FMPI2C_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified FMPI2C interrupt.
#define	__HAL_FMPI2C_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified FMPI2C interrupt.
#define	__HAL_FMPI2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified FMPI2C interrupt source is enabled or not.
#define	FMPI2C_FLAG_MASK   (0x0001FFFFU)
	Check whether the specified FMPI2C flag is set or not.
#define	__HAL_FMPI2C_GET_FLAG(__HANDLE__, __FLAG__)
#define	__HAL_FMPI2C_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the FMPI2C pending flags which are cleared by writing 1 in a specific bit.
#define	__HAL_FMPI2C_ENABLE(__HANDLE__)
	Enable the specified FMPI2C peripheral.
#define	__HAL_FMPI2C_DISABLE(__HANDLE__)
	Disable the specified FMPI2C peripheral.
#define	__HAL_FMPI2C_GENERATE_NACK(__HANDLE__)
	Generate a Non-Acknowledge FMPI2C peripheral in Slave mode.

Detailed Description

Macro Definition Documentation

__HAL_FMPI2C_RESET_HANDLE_STATE

#define __HAL_FMPI2C_RESET_HANDLE_STATE

(

__HANDLE__

)

#include <stm32f4xx_hal_fmpi2c.h>

Value:

((__HANDLE__)->State = HAL_FMPI2C_STATE_RESET)

Reset FMPI2C handle state.

Parameters

__HANDLE__

specifies the FMPI2C Handle.

Return values

None

Definition at line 469 of file stm32f4xx_hal_fmpi2c.h.

__HAL_FMPI2C_ENABLE_IT

#define __HAL_FMPI2C_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_fmpi2c.h>

Value:

((__HANDLE__)->Instance->CR1 |= (__INTERRUPT__))

Enable the specified FMPI2C interrupt.

Parameters

__HANDLE__	specifies the FMPI2C Handle.
__INTERRUPT__	specifies the interrupt source to enable. This parameter can be one of the following values: FMPI2C_IT_ERRI Errors interrupt enable FMPI2C_IT_TCI Transfer complete interrupt enable FMPI2C_IT_STOPI STOP detection interrupt enable FMPI2C_IT_NACKI NACK received interrupt enable FMPI2C_IT_ADDRI Address match interrupt enable FMPI2C_IT_RXI RX interrupt enable FMPI2C_IT_TXI TX interrupt enable

Return values

None

Definition at line 486 of file stm32f4xx_hal_fmpi2c.h.

Referenced by FMPI2C_Enable_IRQ().

__HAL_FMPI2C_DISABLE_IT

#define __HAL_FMPI2C_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_fmpi2c.h>

Value:

((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__)))

Disable the specified FMPI2C interrupt.

Parameters

__HANDLE__	specifies the FMPI2C Handle.
__INTERRUPT__	specifies the interrupt source to disable. This parameter can be one of the following values: FMPI2C_IT_ERRI Errors interrupt enable FMPI2C_IT_TCI Transfer complete interrupt enable FMPI2C_IT_STOPI STOP detection interrupt enable FMPI2C_IT_NACKI NACK received interrupt enable FMPI2C_IT_ADDRI Address match interrupt enable FMPI2C_IT_RXI RX interrupt enable FMPI2C_IT_TXI TX interrupt enable

Return values

None

Definition at line 502 of file stm32f4xx_hal_fmpi2c.h.

Referenced by FMPI2C_Disable_IRQ(), and FMPI2C_Master_ISR_DMA().

__HAL_FMPI2C_GET_IT_SOURCE

#define __HAL_FMPI2C_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_fmpi2c.h>

Value:

                                                                      ((((__HANDLE__)->Instance->CR1 & \
                                                                      (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

Check whether the specified FMPI2C interrupt source is enabled or not.

Parameters

__HANDLE__	specifies the FMPI2C Handle.
__INTERRUPT__	specifies the FMPI2C interrupt source to check. This parameter can be one of the following values: FMPI2C_IT_ERRI Errors interrupt enable FMPI2C_IT_TCI Transfer complete interrupt enable FMPI2C_IT_STOPI STOP detection interrupt enable FMPI2C_IT_NACKI NACK received interrupt enable FMPI2C_IT_ADDRI Address match interrupt enable FMPI2C_IT_RXI RX interrupt enable FMPI2C_IT_TXI TX interrupt enable

Return values

The	new state of INTERRUPT (SET or RESET).

Definition at line 518 of file stm32f4xx_hal_fmpi2c.h.

FMPI2C_FLAG_MASK

#define FMPI2C_FLAG_MASK   (0x0001FFFFU)

#include <stm32f4xx_hal_fmpi2c.h>

Check whether the specified FMPI2C flag is set or not.

Parameters

__HANDLE__

specifies the FMPI2C Handle.

__FLAG__

specifies the flag to check. This parameter can be one of the following values: FMPI2C_FLAG_TXE Transmit data register empty FMPI2C_FLAG_TXIS Transmit interrupt status FMPI2C_FLAG_RXNE Receive data register not empty FMPI2C_FLAG_ADDR Address matched (slave mode) FMPI2C_FLAG_AF Acknowledge failure received flag FMPI2C_FLAG_STOPF STOP detection flag FMPI2C_FLAG_TC Transfer complete (master mode) FMPI2C_FLAG_TCR Transfer complete reload FMPI2C_FLAG_BERR Bus error FMPI2C_FLAG_ARLO Arbitration lost FMPI2C_FLAG_OVR Overrun/Underrun FMPI2C_FLAG_PECERR PEC error in reception FMPI2C_FLAG_TIMEOUT Timeout or Tlow detection flag FMPI2C_FLAG_ALERT SMBus alert FMPI2C_FLAG_BUSY Bus busy FMPI2C_FLAG_DIR Transfer direction (slave mode)

Return values

The	new state of FLAG (SET or RESET).

Definition at line 544 of file stm32f4xx_hal_fmpi2c.h.

__HAL_FMPI2C_GET_FLAG

#define __HAL_FMPI2C_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_fmpi2c.h>

Value:

                                                       (((((__HANDLE__)->Instance->ISR) & \
                                                       (__FLAG__)) == (__FLAG__)) ? SET : RESET)

Definition at line 545 of file stm32f4xx_hal_fmpi2c.h.

Referenced by FMPI2C_Flush_TXDR(), FMPI2C_IsErrorOccurred(), FMPI2C_ITError(), FMPI2C_WaitOnFlagUntilTimeout(), FMPI2C_WaitOnRXNEFlagUntilTimeout(), FMPI2C_WaitOnSTOPFlagUntilTimeout(), FMPI2C_WaitOnTXISFlagUntilTimeout(), HAL_FMPI2C_IsDeviceReady(), HAL_FMPI2C_Master_Receive_DMA(), HAL_FMPI2C_Master_Receive_IT(), HAL_FMPI2C_Master_Transmit_DMA(), HAL_FMPI2C_Master_Transmit_IT(), HAL_FMPI2C_Mem_Read_DMA(), HAL_FMPI2C_Mem_Read_IT(), HAL_FMPI2C_Mem_Write_DMA(), HAL_FMPI2C_Mem_Write_IT(), HAL_FMPI2C_Slave_Receive(), HAL_FMPI2C_Slave_Seq_Receive_DMA(), HAL_FMPI2C_Slave_Seq_Receive_IT(), HAL_FMPI2C_Slave_Seq_Transmit_DMA(), and HAL_FMPI2C_Slave_Seq_Transmit_IT().

__HAL_FMPI2C_CLEAR_FLAG

#define __HAL_FMPI2C_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_fmpi2c.h>

Value:

                                                       (((__FLAG__) == FMPI2C_FLAG_TXE) ? \
                                                       ((__HANDLE__)->Instance->ISR |= (__FLAG__)) : \
                                                       ((__HANDLE__)->Instance->ICR = (__FLAG__)))

Clear the FMPI2C pending flags which are cleared by writing 1 in a specific bit.

Parameters

__HANDLE__

specifies the FMPI2C Handle.

__FLAG__

specifies the flag to clear. This parameter can be any combination of the following values: FMPI2C_FLAG_TXE Transmit data register empty FMPI2C_FLAG_ADDR Address matched (slave mode) FMPI2C_FLAG_AF Acknowledge failure received flag FMPI2C_FLAG_STOPF STOP detection flag FMPI2C_FLAG_BERR Bus error FMPI2C_FLAG_ARLO Arbitration lost FMPI2C_FLAG_OVR Overrun/Underrun FMPI2C_FLAG_PECERR PEC error in reception FMPI2C_FLAG_TIMEOUT Timeout or Tlow detection flag FMPI2C_FLAG_ALERT SMBus alert

Return values

None

Definition at line 565 of file stm32f4xx_hal_fmpi2c.h.

Referenced by FMPI2C_Flush_TXDR(), FMPI2C_IsErrorOccurred(), FMPI2C_ITAddrCplt(), FMPI2C_ITError(), FMPI2C_ITListenCplt(), FMPI2C_ITMasterCplt(), FMPI2C_ITSlaveCplt(), FMPI2C_Master_ISR_DMA(), FMPI2C_Master_ISR_IT(), FMPI2C_Mem_ISR_DMA(), FMPI2C_Mem_ISR_IT(), FMPI2C_Slave_ISR_DMA(), FMPI2C_Slave_ISR_IT(), FMPI2C_WaitOnRXNEFlagUntilTimeout(), HAL_FMPI2C_ER_IRQHandler(), HAL_FMPI2C_IsDeviceReady(), HAL_FMPI2C_Master_Receive(), HAL_FMPI2C_Master_Transmit(), HAL_FMPI2C_Mem_Read(), HAL_FMPI2C_Mem_Write(), HAL_FMPI2C_Slave_Receive(), HAL_FMPI2C_Slave_Seq_Receive_DMA(), HAL_FMPI2C_Slave_Seq_Receive_IT(), HAL_FMPI2C_Slave_Seq_Transmit_DMA(), HAL_FMPI2C_Slave_Seq_Transmit_IT(), and HAL_FMPI2C_Slave_Transmit().

__HAL_FMPI2C_ENABLE

#define __HAL_FMPI2C_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_fmpi2c.h>

Value:

(SET_BIT((__HANDLE__)->Instance->CR1, FMPI2C_CR1_PE))

Enable the specified FMPI2C peripheral.

Parameters

__HANDLE__

specifies the FMPI2C Handle.

Return values

None

Definition at line 573 of file stm32f4xx_hal_fmpi2c.h.

Referenced by HAL_FMPI2C_Init(), HAL_FMPI2CEx_ConfigAnalogFilter(), and HAL_FMPI2CEx_ConfigDigitalFilter().

__HAL_FMPI2C_DISABLE

#define __HAL_FMPI2C_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_fmpi2c.h>

Value:

(CLEAR_BIT((__HANDLE__)->Instance->CR1, FMPI2C_CR1_PE))

Disable the specified FMPI2C peripheral.

Parameters

__HANDLE__

specifies the FMPI2C Handle.

Return values

None

Definition at line 579 of file stm32f4xx_hal_fmpi2c.h.

Referenced by HAL_FMPI2C_DeInit(), HAL_FMPI2C_Init(), HAL_FMPI2CEx_ConfigAnalogFilter(), and HAL_FMPI2CEx_ConfigDigitalFilter().

__HAL_FMPI2C_GENERATE_NACK

#define __HAL_FMPI2C_GENERATE_NACK

(

__HANDLE__

)

#include <stm32f4xx_hal_fmpi2c.h>

Value:

(SET_BIT((__HANDLE__)->Instance->CR2, FMPI2C_CR2_NACK))

Generate a Non-Acknowledge FMPI2C peripheral in Slave mode.

Parameters

__HANDLE__

specifies the FMPI2C Handle.

Return values

None

Definition at line 585 of file stm32f4xx_hal_fmpi2c.h.