Peripheral Control and State functions

QSPI control and State functions. More...

Collaboration diagram for Peripheral Control and State functions:

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

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_QSPI_Abort()

HAL_StatusTypeDef HAL_QSPI_Abort

(

QSPI_HandleTypeDef *

hqspi

)

Abort the current transmission.

Parameters

hqspi

QSPI handle

Return values

HAL

status

Definition at line 2345 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_Abort_IT()

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 2409 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_GetError()

uint32_t HAL_QSPI_GetError

(

const QSPI_HandleTypeDef *

hqspi

)

Return the QSPI error code.

Parameters

hqspi

QSPI handle

Return values

QSPI	Error Code

Definition at line 2335 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_GetFifoThreshold()

uint32_t HAL_QSPI_GetFifoThreshold

(

const QSPI_HandleTypeDef *

hqspi

)

Get QSPI Fifo threshold.

Parameters

hqspi

QSPI handle.

Return values

Fifo	threshold (value between 1 and 16)

Definition at line 2515 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_GetState()

HAL_QSPI_StateTypeDef HAL_QSPI_GetState

(

const QSPI_HandleTypeDef *

hqspi

)

Return the QSPI handle state.

Parameters

hqspi

QSPI handle

Return values

HAL

state

Definition at line 2324 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_SetFifoThreshold()

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 2483 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_SetFlashID()

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 2527 of file stm32f4xx_hal_qspi.c.

HAL_QSPI_SetTimeout()

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 2473 of file stm32f4xx_hal_qspi.c.