STM32L486xx HAL User Manual
Defines
SWPMI Exported Macros
SWPMI

Defines

#define __HAL_SWPMI_RESET_HANDLE_STATE(__HANDLE__)
 Reset SWPMI handle state.
#define __HAL_SWPMI_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
 Enable the SWPMI peripheral.
#define __HAL_SWPMI_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
 Disable the SWPMI peripheral.
#define __HAL_SWPMI_GET_FLAG(__HANDLE__, __FLAG__)   (READ_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)) == (__FLAG__))
 Check whether the specified SWPMI flag is set or not.
#define __HAL_SWPMI_CLEAR_FLAG(__HANDLE__, __FLAG__)   WRITE_REG((__HANDLE__)->Instance->ICR, (__FLAG__))
 Clear the specified SWPMI ISR flag.
#define __HAL_SWPMI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
 Enable the specified SWPMI interrupt.
#define __HAL_SWPMI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
 Disable the specified SWPMI interrupt.
#define __HAL_SWPMI_GET_IT(__HANDLE__, __IT__)   (READ_BIT((__HANDLE__)->Instance->ISR,(__IT__)) == (__IT__))
 Check whether the specified SWPMI interrupt has occurred or not.
#define __HAL_SWPMI_GET_IT_SOURCE(__HANDLE__, __IT__)   ((READ_BIT((__HANDLE__)->Instance->IER, (__IT__)) == (__IT__)) ? SET : RESET)
 Check whether the specified SWPMI interrupt source is enabled or not.

Define Documentation

#define __HAL_SWPMI_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    WRITE_REG((__HANDLE__)->Instance->ICR, (__FLAG__))

Clear the specified SWPMI ISR flag.

Parameters:
__HANDLE__specifies the SWPMI Handle.
__FLAG__,:specifies the flag to clear. This parameter can be one of the following values:
  • SWPMI_FLAG_RXBFF Receive buffer full flag.
  • SWPMI_FLAG_TXBEF Transmit buffer empty flag.
  • SWPMI_FLAG_RXBERF Receive CRC error flag.
  • SWPMI_FLAG_RXOVRF Receive overrun error flag.
  • SWPMI_FLAG_TXUNRF Transmit underrun error flag.
  • SWPMI_FLAG_TCF Transfer complete flag.
  • SWPMI_FLAG_SRF Slave resume flag.
Return values:
None

Definition at line 327 of file stm32l4xx_hal_swpmi.h.

Referenced by HAL_SWPMI_Transmit().

#define __HAL_SWPMI_DISABLE (   __HANDLE__)    CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)

Disable the SWPMI peripheral.

Parameters:
__HANDLE__SWPMI handle
Return values:
None

Definition at line 293 of file stm32l4xx_hal_swpmi.h.

#define __HAL_SWPMI_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    CLEAR_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))

Disable the specified SWPMI interrupt.

Parameters:
__HANDLE__specifies the SWPMI Handle.
__INTERRUPT__specifies the SWPMI interrupt source to disable. This parameter can be one of the following values:
  • SWPMI_IT_SRIE Slave resume interrupt.
  • SWPMI_IT_TCIE Transmit complete interrupt.
  • SWPMI_IT_TIE Transmit interrupt.
  • SWPMI_IT_RIE Receive interrupt.
  • SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
  • SWPMI_IT_RXOVRIE Receive overrun error interrupt.
  • SWPMI_IT_RXBEIE Receive CRC error interrupt.
  • SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
  • SWPMI_IT_RXBFIE Receive buffer full interrupt.
Return values:
None

Definition at line 361 of file stm32l4xx_hal_swpmi.h.

Referenced by HAL_SWPMI_Transmit().

#define __HAL_SWPMI_ENABLE (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)

Enable the SWPMI peripheral.

Parameters:
__HANDLE__SWPMI handle
Return values:
None

Definition at line 286 of file stm32l4xx_hal_swpmi.h.

#define __HAL_SWPMI_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    SET_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))

Enable the specified SWPMI interrupt.

Parameters:
__HANDLE__specifies the SWPMI Handle.
__INTERRUPT__specifies the SWPMI interrupt source to enable. This parameter can be one of the following values:
  • SWPMI_IT_SRIE Slave resume interrupt.
  • SWPMI_IT_TCIE Transmit complete interrupt.
  • SWPMI_IT_TIE Transmit interrupt.
  • SWPMI_IT_RIE Receive interrupt.
  • SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
  • SWPMI_IT_RXOVRIE Receive overrun error interrupt.
  • SWPMI_IT_RXBEIE Receive CRC error interrupt.
  • SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
  • SWPMI_IT_RXBFIE Receive buffer full interrupt.
Return values:
None

Definition at line 344 of file stm32l4xx_hal_swpmi.h.

Referenced by HAL_SWPMI_Receive_DMA(), HAL_SWPMI_Receive_IT(), HAL_SWPMI_Transmit_DMA(), and HAL_SWPMI_Transmit_IT().

#define __HAL_SWPMI_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    (READ_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)) == (__FLAG__))

Check whether the specified SWPMI flag is set or not.

Parameters:
__HANDLE__specifies the SWPMI Handle.
__FLAG__,:specifies the flag to check. This parameter can be one of the following values:
  • SWPMI_FLAG_RXBFF Receive buffer full flag.
  • SWPMI_FLAG_TXBEF Transmit buffer empty flag.
  • SWPMI_FLAG_RXBERF Receive CRC error flag.
  • SWPMI_FLAG_RXOVRF Receive overrun error flag.
  • SWPMI_FLAG_TXUNRF Transmit underrun error flag.
  • SWPMI_FLAG_RXNE Receive data register not empty.
  • SWPMI_FLAG_TXE Transmit data register empty.
  • SWPMI_FLAG_TCF Transfer complete flag.
  • SWPMI_FLAG_SRF Slave resume flag.
  • SWPMI_FLAG_SUSP SUSPEND flag.
  • SWPMI_FLAG_DEACTF DEACTIVATED flag.
Return values:
Thenew state of __FLAG__ (TRUE or FALSE).

Definition at line 312 of file stm32l4xx_hal_swpmi.h.

#define __HAL_SWPMI_GET_IT (   __HANDLE__,
  __IT__ 
)    (READ_BIT((__HANDLE__)->Instance->ISR,(__IT__)) == (__IT__))

Check whether the specified SWPMI interrupt has occurred or not.

Parameters:
__HANDLE__specifies the SWPMI Handle.
__IT__specifies the SWPMI interrupt to check. This parameter can be one of the following values:
  • SWPMI_IT_SRIE Slave resume interrupt.
  • SWPMI_IT_TCIE Transmit complete interrupt.
  • SWPMI_IT_TIE Transmit interrupt.
  • SWPMI_IT_RIE Receive interrupt.
  • SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
  • SWPMI_IT_RXOVRIE Receive overrun error interrupt.
  • SWPMI_IT_RXBERIE Receive CRC error interrupt.
  • SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
  • SWPMI_IT_RXBFIE Receive buffer full interrupt.
Return values:
Thenew state of __IT__ (TRUE or FALSE).

Definition at line 378 of file stm32l4xx_hal_swpmi.h.

#define __HAL_SWPMI_GET_IT_SOURCE (   __HANDLE__,
  __IT__ 
)    ((READ_BIT((__HANDLE__)->Instance->IER, (__IT__)) == (__IT__)) ? SET : RESET)

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

Parameters:
__HANDLE__specifies the SWPMI Handle.
__IT__specifies the SWPMI interrupt source to check. This parameter can be one of the following values:
  • SWPMI_IT_SRIE Slave resume interrupt.
  • SWPMI_IT_TCIE Transmit complete interrupt.
  • SWPMI_IT_TIE Transmit interrupt.
  • SWPMI_IT_RIE Receive interrupt.
  • SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
  • SWPMI_IT_RXOVRIE Receive overrun error interrupt.
  • SWPMI_IT_RXBERIE Receive CRC error interrupt.
  • SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
  • SWPMI_IT_RXBFIE Receive buffer full interrupt.
Return values:
Thenew state of __IT__ (TRUE or FALSE).

Definition at line 395 of file stm32l4xx_hal_swpmi.h.

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

Reset SWPMI handle state.

Parameters:
__HANDLE__specifies the SWPMI Handle.
Return values:
None

Definition at line 272 of file stm32l4xx_hal_swpmi.h.