STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
SPI Exported Macros
STM32H7xx_HAL_Driver » SPI
Collaboration diagram for SPI Exported Macros:

Macros

#define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__)
 Reset SPI handle state.
#define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the specified SPI interrupts.
#define __HAL_SPI_DISABLE_IT(__HANDLE__, __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__)
 Check whether the specified SPI flag is set or not.
#define __HAL_SPI_CLEAR_CRCERRFLAG(__HANDLE__)
 Clear the SPI CRCERR pending flag.
#define __HAL_SPI_CLEAR_MODFFLAG(__HANDLE__)
 Clear the SPI MODF pending flag.
#define __HAL_SPI_CLEAR_OVRFLAG(__HANDLE__)
 Clear the SPI OVR pending flag.
#define __HAL_SPI_CLEAR_FREFLAG(__HANDLE__)
 Clear the SPI FRE pending flag.
#define __HAL_SPI_CLEAR_UDRFLAG(__HANDLE__)
 Clear the SPI UDR pending flag.
#define __HAL_SPI_CLEAR_EOTFLAG(__HANDLE__)
 Clear the SPI EOT pending flag.
#define __HAL_SPI_CLEAR_TXTFFLAG(__HANDLE__)
 Clear the SPI UDR pending flag.
#define __HAL_SPI_CLEAR_SUSPFLAG(__HANDLE__)
 Clear the SPI SUSP pending flag.
#define __HAL_SPI_CLEAR_TSERFFLAG(__HANDLE__)
 Clear the SPI TSERF pending flag.
#define __HAL_SPI_ENABLE(__HANDLE__)
 Enable the SPI peripheral.
#define __HAL_SPI_DISABLE(__HANDLE__)
 Disable the SPI peripheral.

Detailed Description

Macro Definition Documentation

◆ __HAL_SPI_CLEAR_CRCERRFLAG

#define __HAL_SPI_CLEAR_CRCERRFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_CRCEC)
SET_BIT
#define SET_BIT(REG, BIT)
Definition stm32h7xx.h:207
SPI_IFCR_CRCEC
#define SPI_IFCR_CRCEC
CRC Error flag clear.
Definition stm32h723xx.h:18633

Clear the SPI CRCERR pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 767 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_EOTFLAG

#define __HAL_SPI_CLEAR_EOTFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_EOTC)
SPI_IFCR_EOTC
#define SPI_IFCR_EOTC
End Of Transfer flag clear.
Definition stm32h723xx.h:18621

Clear the SPI EOT pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 797 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_FREFLAG

#define __HAL_SPI_CLEAR_FREFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TIFREC)
SPI_IFCR_TIFREC
#define SPI_IFCR_TIFREC
TI frame format error flag clear.
Definition stm32h723xx.h:18636

Clear the SPI FRE pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 785 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_MODFFLAG

#define __HAL_SPI_CLEAR_MODFFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , (uint32_t)(SPI_IFCR_MODFC));
SPI_IFCR_MODFC
#define SPI_IFCR_MODFC
Mode Fault flag clear.
Definition stm32h723xx.h:18639

Clear the SPI MODF pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 773 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_OVRFLAG

#define __HAL_SPI_CLEAR_OVRFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_OVRC)
SPI_IFCR_OVRC
#define SPI_IFCR_OVRC
Overrun flag clear.
Definition stm32h723xx.h:18630

Clear the SPI OVR pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 779 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_SUSPFLAG

#define __HAL_SPI_CLEAR_SUSPFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_SUSPC)
SPI_IFCR_SUSPC
#define SPI_IFCR_SUSPC
SUSPend flag clear.
Definition stm32h723xx.h:18645

Clear the SPI SUSP pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 809 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_TSERFFLAG

#define __HAL_SPI_CLEAR_TSERFFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TSERFC)
SPI_IFCR_TSERFC
#define SPI_IFCR_TSERFC
TSERFC flag clear.
Definition stm32h723xx.h:18642

Clear the SPI TSERF pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 815 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_TXTFFLAG

#define __HAL_SPI_CLEAR_TXTFFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_TXTFC)
SPI_IFCR_TXTFC
#define SPI_IFCR_TXTFC
Transmission Transfer Filled flag clear.
Definition stm32h723xx.h:18624

Clear the SPI UDR pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 803 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_CLEAR_UDRFLAG

#define __HAL_SPI_CLEAR_UDRFLAG ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->IFCR , SPI_IFCR_UDRC)
SPI_IFCR_UDRC
#define SPI_IFCR_UDRC
Underrun flag clear.
Definition stm32h723xx.h:18627

Clear the SPI UDR pending flag.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 791 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_DISABLE

#define __HAL_SPI_DISABLE ( __HANDLE__)
Value:
CLEAR_BIT((__HANDLE__)->Instance->CR1 , SPI_CR1_SPE)
CLEAR_BIT
#define CLEAR_BIT(REG, BIT)
Definition stm32h7xx.h:209
SPI_CR1_SPE
#define SPI_CR1_SPE
Serial Peripheral Enable.
Definition stm32h723xx.h:18372

Disable the SPI peripheral.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 827 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_DISABLE_IT

#define __HAL_SPI_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )
Value:
((__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 715 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_ENABLE

#define __HAL_SPI_ENABLE ( __HANDLE__)
Value:
SET_BIT((__HANDLE__)->Instance->CR1 , SPI_CR1_SPE)

Enable the SPI peripheral.

Parameters
__HANDLE__specifies the SPI Handle.
Return values
None

Definition at line 821 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_ENABLE_IT

#define __HAL_SPI_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )
Value:
((__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 694 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_GET_FLAG

#define __HAL_SPI_GET_FLAG ( __HANDLE__,
__FLAG__ )
Value:
((((__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 761 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_GET_IT_SOURCE

#define __HAL_SPI_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )
Value:
((((__HANDLE__)->Instance->IER & \
(__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
RESET
@ RESET
Definition stm32h7xx.h:182
SET
@ SET
Definition stm32h7xx.h:183

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 736 of file stm32h7xx_hal_spi.h.

◆ __HAL_SPI_RESET_HANDLE_STATE

#define __HAL_SPI_RESET_HANDLE_STATE ( __HANDLE__)
Value:
((__HANDLE__)->State = HAL_SPI_STATE_RESET)
HAL_SPI_STATE_RESET
@ HAL_SPI_STATE_RESET
Peripheral not Initialized.
Definition stm32h7xx_hal_spi.h:137

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 672 of file stm32h7xx_hal_spi.h.