Peripheral Control and State functions

QSPI control and State functions. More...

Functions
HAL_QSPI_StateTypeDef	HAL_QSPI_GetState (QSPI_HandleTypeDef *hqspi)
	Return the QSPI handle state.
uint32_t	HAL_QSPI_GetError (QSPI_HandleTypeDef *hqspi)
	Return the QSPI error code.
HAL_StatusTypeDef	HAL_QSPI_Abort (QSPI_HandleTypeDef *hqspi)
	Abort the current transmission.
HAL_StatusTypeDef	HAL_QSPI_Abort_IT (QSPI_HandleTypeDef *hqspi)
	Abort the current transmission (non-blocking function)
void	HAL_QSPI_SetTimeout (QSPI_HandleTypeDef *hqspi, uint32_t Timeout)
	Set QSPI timeout.
HAL_StatusTypeDef	HAL_QSPI_SetFifoThreshold (QSPI_HandleTypeDef *hqspi, uint32_t Threshold)
	Set QSPI Fifo threshold.
uint32_t	HAL_QSPI_GetFifoThreshold (QSPI_HandleTypeDef *hqspi)
	Get QSPI Fifo threshold.
HAL_StatusTypeDef	HAL_QSPI_SetFlashID (QSPI_HandleTypeDef *hqspi, uint32_t FlashID)
	Set FlashID.

---

Detailed Description

QSPI 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.

---

Function Documentation

HAL_StatusTypeDef HAL_QSPI_Abort

(

QSPI_HandleTypeDef *

hqspi

)

Abort the current transmission.

Parameters:

hqspi

: QSPI handle

Return values:

HAL

status

Definition at line 2348 of file stm32f4xx_hal_qspi.c.

References __HAL_QSPI_CLEAR_FLAG, __QSPI_HandleTypeDef::ErrorCode, HAL_DMA_Abort(), HAL_GetTick(), HAL_QSPI_ERROR_DMA, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::hdma, __QSPI_HandleTypeDef::Instance, QSPI_FLAG_BUSY, QSPI_FLAG_TC, QSPI_WaitFlagStateUntilTimeout(), __QSPI_HandleTypeDef::State, and __QSPI_HandleTypeDef::Timeout.

Referenced by HAL_QSPI_Receive(), and HAL_QSPI_Transmit().

HAL_StatusTypeDef HAL_QSPI_Abort_IT

(

QSPI_HandleTypeDef *

hqspi

)

Abort the current transmission (non-blocking function)

Parameters:

hqspi

: QSPI handle

Return values:

HAL

status

Definition at line 2404 of file stm32f4xx_hal_qspi.c.

References __HAL_QSPI_CLEAR_FLAG, __HAL_QSPI_DISABLE_IT, __HAL_QSPI_ENABLE_IT, __QSPI_HandleTypeDef::AbortCpltCallback, HAL_DMA_Abort_IT(), HAL_QSPI_AbortCpltCallback(), HAL_QSPI_STATE_ABORT, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::hdma, __QSPI_HandleTypeDef::Instance, QSPI_DMAAbortCplt(), QSPI_FLAG_TC, QSPI_IT_FT, QSPI_IT_SM, QSPI_IT_TC, QSPI_IT_TE, QSPI_IT_TO, __QSPI_HandleTypeDef::State, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_QSPI_IRQHandler(), and QSPI_DMAError().

uint32_t HAL_QSPI_GetError

(

QSPI_HandleTypeDef *

hqspi

)

Return the QSPI error code.

Parameters:

hqspi

: QSPI handle

Return values:

QSPI	Error Code

Definition at line 2338 of file stm32f4xx_hal_qspi.c.

References __QSPI_HandleTypeDef::ErrorCode.

uint32_t HAL_QSPI_GetFifoThreshold

(

QSPI_HandleTypeDef *

hqspi

)

Get QSPI Fifo threshold.

Parameters:

hqspi

: QSPI handle.

Return values:

Fifo	threshold (value between 1 and 16)

Definition at line 2502 of file stm32f4xx_hal_qspi.c.

References __QSPI_HandleTypeDef::Instance.

HAL_QSPI_StateTypeDef HAL_QSPI_GetState

(

QSPI_HandleTypeDef *

hqspi

)

Return the QSPI handle state.

Parameters:

hqspi

: QSPI handle

Return values:

HAL

state

Definition at line 2327 of file stm32f4xx_hal_qspi.c.

References __QSPI_HandleTypeDef::State.

HAL_StatusTypeDef HAL_QSPI_SetFifoThreshold	(	QSPI_HandleTypeDef *	hqspi,
		uint32_t	Threshold
	)

Set QSPI Fifo threshold.

Parameters:

hqspi	: QSPI handle.
Threshold	: Threshold of the Fifo (value between 1 and 16).

Return values:

HAL

status

Definition at line 2470 of file stm32f4xx_hal_qspi.c.

References QSPI_InitTypeDef::FifoThreshold, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::Init, __QSPI_HandleTypeDef::Instance, and __QSPI_HandleTypeDef::State.

HAL_StatusTypeDef HAL_QSPI_SetFlashID	(	QSPI_HandleTypeDef *	hqspi,
		uint32_t	FlashID
	)

Set FlashID.

Parameters:

hqspi	: QSPI handle.
FlashID	: Index of the flash memory to be accessed. This parameter can be a value of QSPI Flash Select.

Note:

The FlashID is ignored when dual flash mode is enabled.

Return values:

HAL

status

Definition at line 2514 of file stm32f4xx_hal_qspi.c.

References assert_param, QSPI_InitTypeDef::FlashID, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::Init, __QSPI_HandleTypeDef::Instance, IS_QSPI_FLASH_ID, and __QSPI_HandleTypeDef::State.

void HAL_QSPI_SetTimeout	(	QSPI_HandleTypeDef *	hqspi,
		uint32_t	Timeout
	)

Set QSPI timeout.

Parameters:

hqspi	: QSPI handle.
Timeout	: Timeout for the QSPI memory access.

Return values:

None

Definition at line 2460 of file stm32f4xx_hal_qspi.c.

References __QSPI_HandleTypeDef::Timeout.

Referenced by HAL_QSPI_Init().