Peripheral Control and State functions

OSPI control and State functions. More...

Functions
HAL_StatusTypeDef	HAL_OSPI_Abort (OSPI_HandleTypeDef *hospi)
	Abort the current transmission.
HAL_StatusTypeDef	HAL_OSPI_Abort_IT (OSPI_HandleTypeDef *hospi)
	Abort the current transmission (non-blocking function)
HAL_StatusTypeDef	HAL_OSPI_SetFifoThreshold (OSPI_HandleTypeDef *hospi, uint32_t Threshold)
	Set OSPI Fifo threshold.
uint32_t	HAL_OSPI_GetFifoThreshold (OSPI_HandleTypeDef *hospi)
	Get OSPI Fifo threshold.
HAL_StatusTypeDef	HAL_OSPI_SetTimeout (OSPI_HandleTypeDef *hospi, uint32_t Timeout)
	Set OSPI timeout.
uint32_t	HAL_OSPI_GetError (OSPI_HandleTypeDef *hospi)
	Return the OSPI error code.
uint32_t	HAL_OSPI_GetState (OSPI_HandleTypeDef *hospi)
	Return the OSPI handle state.

---

Detailed Description

OSPI control and State functions.

 ===============================================================================
                  ##### Peripheral Control and State functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to :
      (+) Check in run-time the state of the driver.
      (+) Check the error code set during last operation.
      (+) Abort any operation.
      (+) Manage the Fifo threshold.
      (+) Configure the timeout duration used in the driver.

---

Function Documentation

HAL_StatusTypeDef HAL_OSPI_Abort

(

OSPI_HandleTypeDef *

hospi

)

Abort the current transmission.

Parameters:

hospi

: OSPI handle

Return values:

HAL

status

Definition at line 2231 of file stm32h7xx_hal_ospi.c.

References __HAL_OSPI_CLEAR_FLAG, __HAL_OSPI_GET_FLAG, __OSPI_HandleTypeDef::ErrorCode, HAL_GetTick(), HAL_MDMA_Abort(), HAL_OSPI_ERROR_DMA, HAL_OSPI_ERROR_INVALID_SEQUENCE, HAL_OSPI_FLAG_BUSY, HAL_OSPI_FLAG_TC, HAL_OSPI_STATE_READY, __OSPI_HandleTypeDef::hmdma, __OSPI_HandleTypeDef::Instance, __OSPI_HandleTypeDef::State, and __OSPI_HandleTypeDef::Timeout.

HAL_StatusTypeDef HAL_OSPI_Abort_IT

(

OSPI_HandleTypeDef *

hospi

)

Abort the current transmission (non-blocking function)

Parameters:

hospi

: OSPI handle

Return values:

HAL

status

Definition at line 2299 of file stm32h7xx_hal_ospi.c.

References __HAL_OSPI_CLEAR_FLAG, __HAL_OSPI_DISABLE_IT, __HAL_OSPI_ENABLE_IT, __HAL_OSPI_GET_FLAG, __OSPI_HandleTypeDef::AbortCpltCallback, __OSPI_HandleTypeDef::ErrorCode, HAL_MDMA_Abort_IT(), HAL_OSPI_AbortCpltCallback(), HAL_OSPI_ERROR_INVALID_SEQUENCE, HAL_OSPI_FLAG_BUSY, HAL_OSPI_FLAG_TC, HAL_OSPI_IT_FT, HAL_OSPI_IT_SM, HAL_OSPI_IT_TC, HAL_OSPI_IT_TE, HAL_OSPI_IT_TO, HAL_OSPI_STATE_ABORT, HAL_OSPI_STATE_READY, __OSPI_HandleTypeDef::hmdma, __OSPI_HandleTypeDef::Instance, __OSPI_HandleTypeDef::State, and __MDMA_HandleTypeDef::XferAbortCallback.

uint32_t HAL_OSPI_GetError

(

OSPI_HandleTypeDef *

hospi

)

Return the OSPI error code.

Parameters:

hospi

: OSPI handle

Return values:

OSPI	Error Code

Definition at line 2426 of file stm32h7xx_hal_ospi.c.

References __OSPI_HandleTypeDef::ErrorCode.

uint32_t HAL_OSPI_GetFifoThreshold

(

OSPI_HandleTypeDef *

hospi

)

Get OSPI Fifo threshold.

Parameters:

hospi

: OSPI handle.

Return values:

Fifo

threshold

Definition at line 2405 of file stm32h7xx_hal_ospi.c.

References __OSPI_HandleTypeDef::Instance.

uint32_t HAL_OSPI_GetState

(

OSPI_HandleTypeDef *

hospi

)

Return the OSPI handle state.

Parameters:

hospi

: OSPI handle

Return values:

HAL

state

Definition at line 2436 of file stm32h7xx_hal_ospi.c.

References __OSPI_HandleTypeDef::State.

HAL_StatusTypeDef HAL_OSPI_SetFifoThreshold	(	OSPI_HandleTypeDef *	hospi,
		uint32_t	Threshold
	)

Set OSPI Fifo threshold.

Parameters:

hospi	: OSPI handle.
Threshold	: Threshold of the Fifo.

Return values:

HAL

status

Definition at line 2377 of file stm32h7xx_hal_ospi.c.

References __OSPI_HandleTypeDef::ErrorCode, OSPI_InitTypeDef::FifoThreshold, HAL_OSPI_ERROR_INVALID_SEQUENCE, __OSPI_HandleTypeDef::Init, __OSPI_HandleTypeDef::Instance, and __OSPI_HandleTypeDef::State.

HAL_StatusTypeDef HAL_OSPI_SetTimeout	(	OSPI_HandleTypeDef *	hospi,
		uint32_t	Timeout
	)

Set OSPI timeout.

Parameters:

hospi	: OSPI handle.
Timeout	: Timeout for the memory access.

Return values:

None

Definition at line 2415 of file stm32h7xx_hal_ospi.c.

References __OSPI_HandleTypeDef::Timeout.

Referenced by HAL_OSPI_Init().