STM32H735xx HAL User Manual
Defines
SPI Exported Macros
SPI

Defines

#define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__)
 Reset SPI handle state.
#define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
 Enable the specified SPI interrupts.
#define __HAL_SPI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
 Disable the specified SPI interrupts.
#define __HAL_SPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified SPI interrupt source is enabled or not.
#define __HAL_SPI_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 Check whether the specified SPI flag is set or not.
#define __HAL_SPI_CLEAR_CRCERRFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_CRCEC)
 Clear the SPI CRCERR pending flag.
#define __HAL_SPI_CLEAR_MODFFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , (uint32_t)(SPI_IFCR_MODFC));
 Clear the SPI MODF pending flag.
#define __HAL_SPI_CLEAR_OVRFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_OVRC)
 Clear the SPI OVR pending flag.
#define __HAL_SPI_CLEAR_FREFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TIFREC)
 Clear the SPI FRE pending flag.
#define __HAL_SPI_CLEAR_UDRFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_UDRC)
 Clear the SPI UDR pending flag.
#define __HAL_SPI_CLEAR_EOTFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_EOTC)
 Clear the SPI EOT pending flag.
#define __HAL_SPI_CLEAR_TXTFFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TXTFC)
 Clear the SPI UDR pending flag.
#define __HAL_SPI_CLEAR_SUSPFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_SUSPC)
 Clear the SPI SUSP pending flag.
#define __HAL_SPI_CLEAR_TSERFFLAG(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TSERFC)
 Clear the SPI TSERF pending flag.
#define __HAL_SPI_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR1 , SPI_CR1_SPE)
 Enable the SPI peripheral.
#define __HAL_SPI_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR1 , SPI_CR1_SPE)
 Disable the SPI peripheral.

Define Documentation

#define __HAL_SPI_CLEAR_CRCERRFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_CRCEC)

Clear the SPI CRCERR pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 765 of file stm32h7xx_hal_spi.h.

Referenced by SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_CLEAR_EOTFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_EOTC)

Clear the SPI EOT pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 795 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_CLEAR_FREFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TIFREC)

Clear the SPI FRE pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 783 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_CLEAR_MODFFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , (uint32_t)(SPI_IFCR_MODFC));

Clear the SPI MODF pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 771 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_CLEAR_OVRFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_OVRC)

Clear the SPI OVR pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 777 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_CLEAR_SUSPFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_SUSPC)

Clear the SPI SUSP pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 807 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), and SPI_AbortTransfer().

#define __HAL_SPI_CLEAR_TSERFFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TSERFC)

Clear the SPI TSERF pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 813 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler().

#define __HAL_SPI_CLEAR_TXTFFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TXTFC)

Clear the SPI UDR pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 801 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_CLEAR_UDRFLAG (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_UDRC)

Clear the SPI UDR pending flag.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 789 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_DISABLE (   __HANDLE__)    CLEAR_BIT((__HANDLE__)->Instance->CR1 , SPI_CR1_SPE)

Disable the SPI peripheral.

Parameters:
__HANDLE__,:specifies the SPI Handle.
Return values:
None

Definition at line 825 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_DeInit(), HAL_SPI_Init(), HAL_SPI_IRQHandler(), HAL_SPIEx_ConfigureUnderrun(), HAL_SPIEx_EnableLockConfiguration(), SPI_AbortTransfer(), and SPI_CloseTransfer().

#define __HAL_SPI_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))

Disable the specified SPI interrupts.

Parameters:
__HANDLE__,:specifies the SPI Handle. This parameter can be SPI where x: 1, 2, 3, 4, 5 or 6 to select the SPI peripheral.
__INTERRUPT__,:specifies the interrupt source to enable or disable. This parameter can be one of the following values:
  • SPI_IT_RXP : Rx-Packet available interrupt
  • SPI_IT_TXP : Tx-Packet space available interrupt
  • SPI_IT_DXP : Duplex Packet interrupt
  • SPI_IT_EOT : End of transfer interrupt
  • SPI_IT_TXTF : Transmission Transfer Filled interrupt
  • SPI_IT_UDR : Underrun interrupt
  • SPI_IT_OVR : Overrun interrupt
  • SPI_IT_CRCERR : CRC error interrupt
  • SPI_IT_FRE : TI mode frame format error interrupt
  • SPI_IT_MODF : Mode fault interrupt
  • SPI_IT_TSERF : Additional number of data reloaded interrupt
  • SPI_IT_ERR : Error interrupt
Return values:
None

Definition at line 713 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_IRQHandler(), SPI_AbortTransfer(), SPI_CloseTransfer(), SPI_RxISR_16BIT(), SPI_RxISR_32BIT(), SPI_RxISR_8BIT(), SPI_TxISR_16BIT(), SPI_TxISR_32BIT(), and SPI_TxISR_8BIT().

#define __HAL_SPI_ENABLE (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->CR1 , SPI_CR1_SPE)
#define __HAL_SPI_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))

Enable the specified SPI interrupts.

Parameters:
__HANDLE__,:specifies the SPI Handle. This parameter can be SPI where x: 1, 2, 3, 4, 5 or 6 to select the SPI peripheral.
__INTERRUPT__,:specifies the interrupt source to enable or disable. This parameter can be one of the following values:
  • SPI_IT_RXP : Rx-Packet available interrupt
  • SPI_IT_TXP : Tx-Packet space available interrupt
  • SPI_IT_DXP : Duplex Packet interrupt
  • SPI_IT_EOT : End of transfer interrupt
  • SPI_IT_TXTF : Transmission Transfer Filled interrupt
  • SPI_IT_UDR : Underrun interrupt
  • SPI_IT_OVR : Overrun interrupt
  • SPI_IT_CRCERR : CRC error interrupt
  • SPI_IT_FRE : TI mode frame format error interrupt
  • SPI_IT_MODF : Mode fault interrupt
  • SPI_IT_TSERF : Additional number of data reloaded interrupt
  • SPI_IT_ERR : Error interrupt
Return values:
None

Definition at line 692 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_Receive_DMA(), HAL_SPI_Receive_IT(), HAL_SPI_Transmit_DMA(), HAL_SPI_Transmit_IT(), HAL_SPI_TransmitReceive_DMA(), HAL_SPI_TransmitReceive_IT(), SPI_DMAReceiveCplt(), SPI_DMATransmitCplt(), and SPI_DMATransmitReceiveCplt().

#define __HAL_SPI_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))

Check whether the specified SPI flag is set or not.

Parameters:
__HANDLE__,:specifies the SPI Handle. This parameter can be SPI where x: 1, 2, 3, 4, 5 or 6 to select the SPI peripheral.
__FLAG__,:specifies the flag to check. This parameter can be one of the following values:
  • SPI_FLAG_RXP : Rx-Packet available flag
  • SPI_FLAG_TXP : Tx-Packet space available flag
  • SPI_FLAG_DXP : Duplex Packet flag
  • SPI_FLAG_EOT : End of transfer flag
  • SPI_FLAG_TXTF : Transmission Transfer Filled flag
  • SPI_FLAG_UDR : Underrun flag
  • SPI_FLAG_OVR : Overrun flag
  • SPI_FLAG_CRCERR : CRC error flag
  • SPI_FLAG_FRE : TI mode frame format error flag
  • SPI_FLAG_MODF : Mode fault flag
  • SPI_FLAG_TSERF : Additional number of data reloaded flag
  • SPI_FLAG_SUSP : Transfer suspend complete flag
  • SPI_FLAG_TXC : TxFIFO transmission complete flag
  • SPI_FLAG_FRLVL : Fifo reception level flag
  • SPI_FLAG_RXWNE : RxFIFO word not empty flag
Return values:
Thenew state of __FLAG__ (TRUE or FALSE).

Definition at line 759 of file stm32h7xx_hal_spi.h.

Referenced by HAL_SPI_Transmit(), HAL_SPI_TransmitReceive(), HAL_SPI_TransmitReceive_IT(), and SPI_WaitOnFlagUntilTimeout().

#define __HAL_SPI_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
((((__HANDLE__)->Instance->IER & \
                                                              (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

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

Parameters:
__HANDLE__,:specifies the SPI Handle. This parameter can be SPI where x: 1, 2, 3, 4, 5 or 6 to select the SPI peripheral.
__INTERRUPT__,:specifies the SPI interrupt source to check. This parameter can be one of the following values:
  • SPI_IT_RXP : Rx-Packet available interrupt
  • SPI_IT_TXP : Tx-Packet space available interrupt
  • SPI_IT_DXP : Duplex Packet interrupt
  • SPI_IT_EOT : End of transfer interrupt
  • SPI_IT_TXTF : Transmission Transfer Filled interrupt
  • SPI_IT_UDR : Underrun interrupt
  • SPI_IT_OVR : Overrun interrupt
  • SPI_IT_CRCERR : CRC error interrupt
  • SPI_IT_FRE : TI mode frame format error interrupt
  • SPI_IT_MODF : Mode fault interrupt
  • SPI_IT_TSERF : Additional number of data reloaded interrupt
  • SPI_IT_ERR : Error interrupt
Return values:
Thenew state of __IT__ (TRUE or FALSE).

Definition at line 734 of file stm32h7xx_hal_spi.h.

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

Reset SPI handle state.

Parameters:
__HANDLE__,:specifies the SPI Handle. This parameter can be SPI where x: 1, 2, 3, 4, 5 or 6 to select the SPI peripheral.
Return values:
None

Definition at line 664 of file stm32h7xx_hal_spi.h.