STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
FMPSMBUS Exported Macros
Collaboration diagram for FMPSMBUS Exported Macros:

Macros

#define __HAL_FMPSMBUS_RESET_HANDLE_STATE(__HANDLE__)
 Reset FMPSMBUS handle state.
 
#define __HAL_FMPSMBUS_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the specified FMPSMBUS interrupts.
 
#define __HAL_FMPSMBUS_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the specified FMPSMBUS interrupts.
 
#define __HAL_FMPSMBUS_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified FMPSMBUS interrupt source is enabled or not.
 
#define FMPSMBUS_FLAG_MASK   (0x0001FFFFU)
 Check whether the specified FMPSMBUS flag is set or not.
 
#define __HAL_FMPSMBUS_GET_FLAG(__HANDLE__, __FLAG__)
 
#define __HAL_FMPSMBUS_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clear the FMPSMBUS pending flags which are cleared by writing 1 in a specific bit.
 
#define __HAL_FMPSMBUS_ENABLE(__HANDLE__)
 Enable the specified FMPSMBUS peripheral.
 
#define __HAL_FMPSMBUS_DISABLE(__HANDLE__)
 Disable the specified FMPSMBUS peripheral.
 
#define __HAL_FMPSMBUS_GENERATE_NACK(__HANDLE__)
 Generate a Non-Acknowledge FMPSMBUS peripheral in Slave mode.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_FMPSMBUS_RESET_HANDLE_STATE

#define __HAL_FMPSMBUS_RESET_HANDLE_STATE ( __HANDLE__)

#include <stm32f4xx_hal_fmpsmbus.h>

Value:
((__HANDLE__)->State = HAL_FMPSMBUS_STATE_RESET)
#define HAL_FMPSMBUS_STATE_RESET

Reset FMPSMBUS handle state.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
Return values
None

Definition at line 429 of file stm32f4xx_hal_fmpsmbus.h.

◆ __HAL_FMPSMBUS_ENABLE_IT

#define __HAL_FMPSMBUS_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_fmpsmbus.h>

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

Enable the specified FMPSMBUS interrupts.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
__INTERRUPT__specifies the interrupt source to enable. This parameter can be one of the following values:
Return values
None

Definition at line 446 of file stm32f4xx_hal_fmpsmbus.h.

Referenced by FMPSMBUS_Enable_IRQ().

◆ __HAL_FMPSMBUS_DISABLE_IT

#define __HAL_FMPSMBUS_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_fmpsmbus.h>

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

Disable the specified FMPSMBUS interrupts.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
__INTERRUPT__specifies the interrupt source to disable. This parameter can be one of the following values:
Return values
None

Definition at line 462 of file stm32f4xx_hal_fmpsmbus.h.

Referenced by FMPSMBUS_Disable_IRQ(), and FMPSMBUS_Slave_ISR().

◆ __HAL_FMPSMBUS_GET_IT_SOURCE

#define __HAL_FMPSMBUS_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_fmpsmbus.h>

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

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

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
__INTERRUPT__specifies the FMPSMBUS interrupt source to check. This parameter can be one of the following values:
Return values
Thenew state of IT (SET or RESET).

Definition at line 478 of file stm32f4xx_hal_fmpsmbus.h.

◆ FMPSMBUS_FLAG_MASK

#define FMPSMBUS_FLAG_MASK   (0x0001FFFFU)

#include <stm32f4xx_hal_fmpsmbus.h>

Check whether the specified FMPSMBUS flag is set or not.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
__FLAG__specifies the flag to check. This parameter can be one of the following values:
Return values
Thenew state of FLAG (SET or RESET).

Definition at line 504 of file stm32f4xx_hal_fmpsmbus.h.

◆ __HAL_FMPSMBUS_GET_FLAG

#define __HAL_FMPSMBUS_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_fmpsmbus.h>

Value:
(((((__HANDLE__)->Instance->ISR) & ((__FLAG__) & FMPSMBUS_FLAG_MASK)) == \
((__FLAG__) & FMPSMBUS_FLAG_MASK)) ? SET : RESET)
#define FMPSMBUS_FLAG_MASK
Check whether the specified FMPSMBUS flag is set or not.

Definition at line 505 of file stm32f4xx_hal_fmpsmbus.h.

Referenced by FMPSMBUS_Flush_TXDR(), FMPSMBUS_Slave_ISR(), FMPSMBUS_WaitOnFlagUntilTimeout(), and HAL_FMPSMBUS_IsDeviceReady().

◆ __HAL_FMPSMBUS_CLEAR_FLAG

#define __HAL_FMPSMBUS_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_fmpsmbus.h>

Value:
(((__FLAG__) == FMPSMBUS_FLAG_TXE) ? \
((__HANDLE__)->Instance->ISR |= (__FLAG__)) : \
((__HANDLE__)->Instance->ICR = (__FLAG__)))
#define FMPSMBUS_FLAG_TXE

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

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
__FLAG__specifies the flag to clear. This parameter can be any combination of the following values:
Return values
None

Definition at line 526 of file stm32f4xx_hal_fmpsmbus.h.

Referenced by FMPSMBUS_Flush_TXDR(), FMPSMBUS_ITErrorHandler(), FMPSMBUS_Master_ISR(), FMPSMBUS_Slave_ISR(), HAL_FMPSMBUS_EnableAlert_IT(), HAL_FMPSMBUS_IsDeviceReady(), HAL_FMPSMBUS_Slave_Receive_IT(), and HAL_FMPSMBUS_Slave_Transmit_IT().

◆ __HAL_FMPSMBUS_ENABLE

#define __HAL_FMPSMBUS_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_fmpsmbus.h>

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

Enable the specified FMPSMBUS peripheral.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
Return values
None

Definition at line 534 of file stm32f4xx_hal_fmpsmbus.h.

Referenced by FMPSMBUS_Master_ISR(), HAL_FMPSMBUS_ConfigAnalogFilter(), HAL_FMPSMBUS_ConfigDigitalFilter(), and HAL_FMPSMBUS_Init().

◆ __HAL_FMPSMBUS_DISABLE

#define __HAL_FMPSMBUS_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_fmpsmbus.h>

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

Disable the specified FMPSMBUS peripheral.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
Return values
None

Definition at line 540 of file stm32f4xx_hal_fmpsmbus.h.

Referenced by FMPSMBUS_Master_ISR(), HAL_FMPSMBUS_ConfigAnalogFilter(), HAL_FMPSMBUS_ConfigDigitalFilter(), HAL_FMPSMBUS_DeInit(), and HAL_FMPSMBUS_Init().

◆ __HAL_FMPSMBUS_GENERATE_NACK

#define __HAL_FMPSMBUS_GENERATE_NACK ( __HANDLE__)

#include <stm32f4xx_hal_fmpsmbus.h>

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

Generate a Non-Acknowledge FMPSMBUS peripheral in Slave mode.

Parameters
__HANDLE__specifies the FMPSMBUS Handle.
Return values
None

Definition at line 546 of file stm32f4xx_hal_fmpsmbus.h.