STM32H735xx HAL User Manual
Defines
OSPI Exported Macros
OSPI

Defines

#define __HAL_OSPI_RESET_HANDLE_STATE(__HANDLE__)
 Reset OSPI handle state.
#define __HAL_OSPI_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR, OCTOSPI_CR_EN)
 Enable the OSPI peripheral.
#define __HAL_OSPI_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR, OCTOSPI_CR_EN)
 Disable the OSPI peripheral.
#define __HAL_OSPI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))
 Enable the specified OSPI interrupt.
#define __HAL_OSPI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))
 Disable the specified OSPI interrupt.
#define __HAL_OSPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified OSPI interrupt source is enabled or not.
#define __HAL_OSPI_GET_FLAG(__HANDLE__, __FLAG__)
 Check whether the selected OSPI flag is set or not.
#define __HAL_OSPI_CLEAR_FLAG(__HANDLE__, __FLAG__)   WRITE_REG((__HANDLE__)->Instance->FCR, (__FLAG__))
 Clears the specified OSPI's flag status.

Define Documentation

#define __HAL_OSPI_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    WRITE_REG((__HANDLE__)->Instance->FCR, (__FLAG__))

Clears the specified OSPI's flag status.

Parameters:
__HANDLE__specifies the OSPI Handle.
__FLAG__specifies the OSPI clear register flag that needs to be set This parameter can be one of the following values:
  • HAL_OSPI_FLAG_TO: OSPI Timeout flag
  • HAL_OSPI_FLAG_SM: OSPI Status match flag
  • HAL_OSPI_FLAG_TC: OSPI Transfer complete flag
  • HAL_OSPI_FLAG_TE: OSPI Transfer error flag
Return values:
None

Definition at line 781 of file stm32h7xx_hal_ospi.h.

Referenced by HAL_OSPI_Abort(), HAL_OSPI_Abort_IT(), HAL_OSPI_AutoPolling(), HAL_OSPI_AutoPolling_IT(), HAL_OSPI_Command(), HAL_OSPI_Command_IT(), HAL_OSPI_MemoryMapped(), HAL_OSPI_Receive(), HAL_OSPI_Receive_DMA(), HAL_OSPI_Receive_IT(), HAL_OSPI_Transmit(), HAL_OSPI_Transmit_DMA(), and HAL_OSPI_Transmit_IT().

#define __HAL_OSPI_DISABLE (   __HANDLE__)    CLEAR_BIT((__HANDLE__)->Instance->CR, OCTOSPI_CR_EN)

Disable the OSPI peripheral.

Parameters:
__HANDLE__specifies the OSPI Handle.
Return values:
None

Definition at line 712 of file stm32h7xx_hal_ospi.h.

Referenced by HAL_OSPI_DeInit().

#define __HAL_OSPI_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    CLEAR_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))

Disable the specified OSPI interrupt.

Parameters:
__HANDLE__specifies the OSPI Handle.
__INTERRUPT__specifies the OSPI interrupt source to disable. This parameter can be one of the following values:
  • HAL_OSPI_IT_TO: OSPI Timeout interrupt
  • HAL_OSPI_IT_SM: OSPI Status match interrupt
  • HAL_OSPI_IT_FT: OSPI FIFO threshold interrupt
  • HAL_OSPI_IT_TC: OSPI Transfer complete interrupt
  • HAL_OSPI_IT_TE: OSPI Transfer error interrupt
Return values:
None

Definition at line 739 of file stm32h7xx_hal_ospi.h.

Referenced by HAL_OSPI_Abort_IT(), and HAL_OSPI_IRQHandler().

#define __HAL_OSPI_ENABLE (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->CR, OCTOSPI_CR_EN)

Enable the OSPI peripheral.

Parameters:
__HANDLE__specifies the OSPI Handle.
Return values:
None

Definition at line 706 of file stm32h7xx_hal_ospi.h.

Referenced by HAL_OSPI_Init().

#define __HAL_OSPI_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    SET_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))

Enable the specified OSPI interrupt.

Parameters:
__HANDLE__specifies the OSPI Handle.
__INTERRUPT__specifies the OSPI interrupt source to enable. This parameter can be one of the following values:
  • HAL_OSPI_IT_TO: OSPI Timeout interrupt
  • HAL_OSPI_IT_SM: OSPI Status match interrupt
  • HAL_OSPI_IT_FT: OSPI FIFO threshold interrupt
  • HAL_OSPI_IT_TC: OSPI Transfer complete interrupt
  • HAL_OSPI_IT_TE: OSPI Transfer error interrupt
Return values:
None

Definition at line 725 of file stm32h7xx_hal_ospi.h.

Referenced by HAL_OSPI_Abort_IT(), HAL_OSPI_AutoPolling_IT(), HAL_OSPI_Command_IT(), HAL_OSPI_MemoryMapped(), HAL_OSPI_Receive_DMA(), HAL_OSPI_Receive_IT(), HAL_OSPI_Transmit_DMA(), and HAL_OSPI_Transmit_IT().

#define __HAL_OSPI_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)
Value:
((READ_BIT((__HANDLE__)->Instance->SR, (__FLAG__)) \
                                                              != 0U) ? SET : RESET)

Check whether the selected OSPI flag is set or not.

Parameters:
__HANDLE__specifies the OSPI Handle.
__FLAG__specifies the OSPI flag to check. This parameter can be one of the following values:
  • HAL_OSPI_FLAG_BUSY: OSPI Busy flag
  • HAL_OSPI_FLAG_TO: OSPI Timeout flag
  • HAL_OSPI_FLAG_SM: OSPI Status match flag
  • HAL_OSPI_FLAG_FT: OSPI FIFO threshold flag
  • HAL_OSPI_FLAG_TC: OSPI Transfer complete flag
  • HAL_OSPI_FLAG_TE: OSPI Transfer error flag
Return values:
None

Definition at line 768 of file stm32h7xx_hal_ospi.h.

Referenced by HAL_OSPI_Abort(), and HAL_OSPI_Abort_IT().

#define __HAL_OSPI_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
(READ_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))\
                                                             == (__INTERRUPT__))

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

Parameters:
__HANDLE__specifies the OSPI Handle.
__INTERRUPT__specifies the OSPI interrupt source to check. This parameter can be one of the following values:
  • HAL_OSPI_IT_TO: OSPI Timeout interrupt
  • HAL_OSPI_IT_SM: OSPI Status match interrupt
  • HAL_OSPI_IT_FT: OSPI FIFO threshold interrupt
  • HAL_OSPI_IT_TC: OSPI Transfer complete interrupt
  • HAL_OSPI_IT_TE: OSPI Transfer error interrupt
Return values:
Thenew state of __INTERRUPT__ (TRUE or FALSE).

Definition at line 752 of file stm32h7xx_hal_ospi.h.

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

Reset OSPI handle state.

Parameters:
__HANDLE__specifies the OSPI Handle.
Return values:
None

Definition at line 693 of file stm32h7xx_hal_ospi.h.