QSPI Transmit/Receive functions. More...

Collaboration diagram for Input and Output operation functions:

Functions
void	HAL_QSPI_IRQHandler (QSPI_HandleTypeDef *hqspi)
	Handle QSPI interrupt request. More...

HAL_StatusTypeDef	HAL_QSPI_Command (QSPI_HandleTypeDef hqspi, QSPI_CommandTypeDef cmd, uint32_t Timeout)
	Set the command configuration. More...

HAL_StatusTypeDef	HAL_QSPI_Transmit (QSPI_HandleTypeDef hqspi, uint8_t pData, uint32_t Timeout)
	Transmit an amount of data in blocking mode. More...

HAL_StatusTypeDef	HAL_QSPI_Receive (QSPI_HandleTypeDef hqspi, uint8_t pData, uint32_t Timeout)
	Receive an amount of data in blocking mode. More...

HAL_StatusTypeDef	HAL_QSPI_Command_IT (QSPI_HandleTypeDef hqspi, QSPI_CommandTypeDef cmd)
	Set the command configuration in interrupt mode. More...

HAL_StatusTypeDef	HAL_QSPI_Transmit_IT (QSPI_HandleTypeDef hqspi, uint8_t pData)
	Send an amount of data in non-blocking mode with interrupt. More...

HAL_StatusTypeDef	HAL_QSPI_Receive_IT (QSPI_HandleTypeDef hqspi, uint8_t pData)
	Receive an amount of data in non-blocking mode with interrupt. More...

HAL_StatusTypeDef	HAL_QSPI_Transmit_DMA (QSPI_HandleTypeDef hqspi, uint8_t pData)
	Send an amount of data in non-blocking mode with DMA. More...

HAL_StatusTypeDef	HAL_QSPI_Receive_DMA (QSPI_HandleTypeDef hqspi, uint8_t pData)
	Receive an amount of data in non-blocking mode with DMA. More...

HAL_StatusTypeDef	HAL_QSPI_AutoPolling (QSPI_HandleTypeDef hqspi, QSPI_CommandTypeDef cmd, QSPI_AutoPollingTypeDef *cfg, uint32_t Timeout)
	Configure the QSPI Automatic Polling Mode in blocking mode. More...

HAL_StatusTypeDef	HAL_QSPI_AutoPolling_IT (QSPI_HandleTypeDef hqspi, QSPI_CommandTypeDef cmd, QSPI_AutoPollingTypeDef *cfg)
	Configure the QSPI Automatic Polling Mode in non-blocking mode. More...

HAL_StatusTypeDef	HAL_QSPI_MemoryMapped (QSPI_HandleTypeDef hqspi, QSPI_CommandTypeDef cmd, QSPI_MemoryMappedTypeDef *cfg)
	Configure the Memory Mapped mode. More...

void	HAL_QSPI_ErrorCallback (QSPI_HandleTypeDef *hqspi)
	Transfer Error callback. More...

void	HAL_QSPI_AbortCpltCallback (QSPI_HandleTypeDef *hqspi)
	Abort completed callback. More...

void	HAL_QSPI_FifoThresholdCallback (QSPI_HandleTypeDef *hqspi)
	FIFO Threshold callback. More...

void	HAL_QSPI_CmdCpltCallback (QSPI_HandleTypeDef *hqspi)
	Command completed callback. More...

void	HAL_QSPI_RxCpltCallback (QSPI_HandleTypeDef *hqspi)
	Rx Transfer completed callback. More...

void	HAL_QSPI_TxCpltCallback (QSPI_HandleTypeDef *hqspi)
	Tx Transfer completed callback. More...

void	HAL_QSPI_RxHalfCpltCallback (QSPI_HandleTypeDef *hqspi)
	Rx Half Transfer completed callback. More...

void	HAL_QSPI_TxHalfCpltCallback (QSPI_HandleTypeDef *hqspi)
	Tx Half Transfer completed callback. More...

void	HAL_QSPI_StatusMatchCallback (QSPI_HandleTypeDef *hqspi)
	Status Match callback. More...

void	HAL_QSPI_TimeOutCallback (QSPI_HandleTypeDef *hqspi)
	Timeout callback. More...

HAL_StatusTypeDef	HAL_QSPI_RegisterCallback (QSPI_HandleTypeDef *hqspi, HAL_QSPI_CallbackIDTypeDef CallbackId, pQSPI_CallbackTypeDef pCallback)
	Register a User QSPI Callback To be used to override the weak predefined callback. More...

HAL_StatusTypeDef	HAL_QSPI_UnRegisterCallback (QSPI_HandleTypeDef *hqspi, HAL_QSPI_CallbackIDTypeDef CallbackId)
	Unregister a User QSPI Callback QSPI Callback is redirected to the weak predefined callback. More...

Detailed Description

QSPI Transmit/Receive functions.

 ===============================================================================
                      ##### IO operation functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to :
      (+) Handle the interrupts.
      (+) Handle the command sequence.
      (+) Transmit data in blocking, interrupt or DMA mode.
      (+) Receive data in blocking, interrupt or DMA mode.
      (+) Manage the auto-polling functional mode.
      (+) Manage the memory-mapped functional mode.

Function Documentation

◆ HAL_QSPI_AbortCpltCallback()

__weak void HAL_QSPI_AbortCpltCallback ( QSPI_HandleTypeDef * hqspi )

Abort completed callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 1946 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_AutoPolling()

HAL_StatusTypeDef HAL_QSPI_AutoPolling	(	QSPI_HandleTypeDef *	hqspi,
		QSPI_CommandTypeDef *	cmd,
		QSPI_AutoPollingTypeDef *	cfg,
		uint32_t	Timeout
	)

Configure the QSPI Automatic Polling Mode in blocking mode.

Parameters

hqspi	QSPI handle
cmd	structure that contains the command configuration information.
cfg	structure that contains the polling configuration information.
Timeout	Timeout duration

Note: This function is used only in Automatic Polling Mode

Return values

HAL status

Definition at line 1642 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_AutoPolling_IT()

HAL_StatusTypeDef HAL_QSPI_AutoPolling_IT	(	QSPI_HandleTypeDef *	hqspi,
		QSPI_CommandTypeDef *	cmd,
		QSPI_AutoPollingTypeDef *	cfg
	)

Configure the QSPI Automatic Polling Mode in non-blocking mode.

Parameters

hqspi	QSPI handle
cmd	structure that contains the command configuration information.
cfg	structure that contains the polling configuration information.

Note: This function is used only in Automatic Polling Mode

Return values

HAL status

Definition at line 1742 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_CmdCpltCallback()

__weak void HAL_QSPI_CmdCpltCallback ( QSPI_HandleTypeDef * hqspi )

Command completed callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 1961 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Command()

HAL_StatusTypeDef HAL_QSPI_Command	(	QSPI_HandleTypeDef *	hqspi,
		QSPI_CommandTypeDef *	cmd,
		uint32_t	Timeout
	)

Set the command configuration.

Parameters

hqspi	QSPI handle
cmd	: structure that contains the command configuration information
Timeout	Timeout duration

Note: This function is used only in Indirect Read or Write Modes

Return values

HAL status

Definition at line 781 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Command_IT()

HAL_StatusTypeDef HAL_QSPI_Command_IT	(	QSPI_HandleTypeDef *	hqspi,
		QSPI_CommandTypeDef *	cmd
	)

Set the command configuration in interrupt mode.

Parameters

hqspi	QSPI handle
cmd	structure that contains the command configuration information

Note: This function is used only in Indirect Read or Write Modes

Return values

HAL status

Definition at line 870 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_ErrorCallback()

__weak void HAL_QSPI_ErrorCallback ( QSPI_HandleTypeDef * hqspi )

Transfer Error callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 1931 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_FifoThresholdCallback()

__weak void HAL_QSPI_FifoThresholdCallback ( QSPI_HandleTypeDef * hqspi )

FIFO Threshold callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 2036 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_IRQHandler()

void HAL_QSPI_IRQHandler ( QSPI_HandleTypeDef * hqspi )

Handle QSPI interrupt request.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 488 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_MemoryMapped()

HAL_StatusTypeDef HAL_QSPI_MemoryMapped	(	QSPI_HandleTypeDef *	hqspi,
		QSPI_CommandTypeDef *	cmd,
		QSPI_MemoryMappedTypeDef *	cfg
	)

Configure the Memory Mapped mode.

Parameters

hqspi	QSPI handle
cmd	structure that contains the command configuration information.
cfg	structure that contains the memory mapped configuration information.

Note: This function is used only in Memory mapped Mode

Return values

HAL status

Definition at line 1845 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Receive()

HAL_StatusTypeDef HAL_QSPI_Receive	(	QSPI_HandleTypeDef *	hqspi,
		uint8_t *	pData,
		uint32_t	Timeout
	)

Receive an amount of data in blocking mode.

Parameters

hqspi	QSPI handle
pData	pointer to data buffer
Timeout	Timeout duration

Note: This function is used only in Indirect Read Mode

Return values

HAL status

Definition at line 1054 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Receive_DMA()

HAL_StatusTypeDef HAL_QSPI_Receive_DMA	(	QSPI_HandleTypeDef *	hqspi,
		uint8_t *	pData
	)

Receive an amount of data in non-blocking mode with DMA.

Parameters

hqspi	QSPI handle
pData	pointer to data buffer.

Note: This function is used only in Indirect Read Mode; If DMA peripheral access is configured as halfword, the number of data and the fifo threshold should be aligned on halfword; If DMA peripheral access is configured as word, the number of data and the fifo threshold should be aligned on word

Return values

HAL status

Definition at line 1436 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Receive_IT()

HAL_StatusTypeDef HAL_QSPI_Receive_IT	(	QSPI_HandleTypeDef *	hqspi,
		uint8_t *	pData
	)

Receive an amount of data in non-blocking mode with interrupt.

Parameters

hqspi	QSPI handle
pData	pointer to data buffer

Note: This function is used only in Indirect Read Mode

Return values

HAL status

Definition at line 1201 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_RegisterCallback()

HAL_StatusTypeDef HAL_QSPI_RegisterCallback	(	QSPI_HandleTypeDef *	hqspi,
		HAL_QSPI_CallbackIDTypeDef	CallbackId,
		pQSPI_CallbackTypeDef	pCallback
	)

Register a User QSPI Callback To be used to override the weak predefined callback.

Parameters

hqspi	QSPI handle
CallbackId	ID of the callback to be registered This parameter can be one of the following values: HAL_QSPI_ERROR_CB_ID QSPI Error Callback ID HAL_QSPI_ABORT_CB_ID QSPI Abort Callback ID HAL_QSPI_FIFO_THRESHOLD_CB_ID QSPI FIFO Threshold Callback ID HAL_QSPI_CMD_CPLT_CB_ID QSPI Command Complete Callback ID HAL_QSPI_RX_CPLT_CB_ID QSPI Rx Complete Callback ID HAL_QSPI_TX_CPLT_CB_ID QSPI Tx Complete Callback ID HAL_QSPI_RX_HALF_CPLT_CB_ID QSPI Rx Half Complete Callback ID HAL_QSPI_TX_HALF_CPLT_CB_ID QSPI Tx Half Complete Callback ID HAL_QSPI_STATUS_MATCH_CB_ID QSPI Status Match Callback ID HAL_QSPI_TIMEOUT_CB_ID QSPI Timeout Callback ID HAL_QSPI_MSP_INIT_CB_ID QSPI MspInit callback ID HAL_QSPI_MSP_DEINIT_CB_ID QSPI MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

status

Definition at line 2097 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_RxCpltCallback()

__weak void HAL_QSPI_RxCpltCallback ( QSPI_HandleTypeDef * hqspi )

Rx Transfer completed callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 1976 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_RxHalfCpltCallback()

__weak void HAL_QSPI_RxHalfCpltCallback ( QSPI_HandleTypeDef * hqspi )

Rx Half Transfer completed callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 2006 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_StatusMatchCallback()

__weak void HAL_QSPI_StatusMatchCallback ( QSPI_HandleTypeDef * hqspi )

Status Match callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 2051 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_TimeOutCallback()

__weak void HAL_QSPI_TimeOutCallback ( QSPI_HandleTypeDef * hqspi )

Timeout callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 2066 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Transmit()

HAL_StatusTypeDef HAL_QSPI_Transmit	(	QSPI_HandleTypeDef *	hqspi,
		uint8_t *	pData,
		uint32_t	Timeout
	)

Transmit an amount of data in blocking mode.

Parameters

hqspi	QSPI handle
pData	pointer to data buffer
Timeout	Timeout duration

Note: This function is used only in Indirect Write Mode

Return values

HAL status

Definition at line 969 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Transmit_DMA()

HAL_StatusTypeDef HAL_QSPI_Transmit_DMA	(	QSPI_HandleTypeDef *	hqspi,
		uint8_t *	pData
	)

Send an amount of data in non-blocking mode with DMA.

Parameters

hqspi	QSPI handle
pData	pointer to data buffer

Note: This function is used only in Indirect Write Mode; If DMA peripheral access is configured as halfword, the number of data and the fifo threshold should be aligned on halfword; If DMA peripheral access is configured as word, the number of data and the fifo threshold should be aligned on word

Return values

HAL status

Definition at line 1269 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_Transmit_IT()

HAL_StatusTypeDef HAL_QSPI_Transmit_IT	(	QSPI_HandleTypeDef *	hqspi,
		uint8_t *	pData
	)

Send an amount of data in non-blocking mode with interrupt.

Parameters

hqspi	QSPI handle
pData	pointer to data buffer

Note: This function is used only in Indirect Write Mode

Return values

HAL status

Definition at line 1141 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_TxCpltCallback()

__weak void HAL_QSPI_TxCpltCallback ( QSPI_HandleTypeDef * hqspi )

Tx Transfer completed callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 1991 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_TxHalfCpltCallback()

__weak void HAL_QSPI_TxHalfCpltCallback ( QSPI_HandleTypeDef * hqspi )

Tx Half Transfer completed callback.

Parameters

hqspi QSPI handle

Return values

None

Definition at line 2021 of file stm32f4xx_hal_qspi.c.

◆ HAL_QSPI_UnRegisterCallback()

HAL_StatusTypeDef HAL_QSPI_UnRegisterCallback	(	QSPI_HandleTypeDef *	hqspi,
		HAL_QSPI_CallbackIDTypeDef	CallbackId
	)

Unregister a User QSPI Callback QSPI Callback is redirected to the weak predefined callback.

Parameters

hqspi QSPI handle

CallbackId

ID of the callback to be unregistered This parameter can be one of the following values:

HAL_QSPI_ERROR_CB_ID QSPI Error Callback ID
HAL_QSPI_ABORT_CB_ID QSPI Abort Callback ID
HAL_QSPI_FIFO_THRESHOLD_CB_ID QSPI FIFO Threshold Callback ID
HAL_QSPI_CMD_CPLT_CB_ID QSPI Command Complete Callback ID
HAL_QSPI_RX_CPLT_CB_ID QSPI Rx Complete Callback ID
HAL_QSPI_TX_CPLT_CB_ID QSPI Tx Complete Callback ID
HAL_QSPI_RX_HALF_CPLT_CB_ID QSPI Rx Half Complete Callback ID
HAL_QSPI_TX_HALF_CPLT_CB_ID QSPI Tx Half Complete Callback ID
HAL_QSPI_STATUS_MATCH_CB_ID QSPI Status Match Callback ID
HAL_QSPI_TIMEOUT_CB_ID QSPI Timeout Callback ID
HAL_QSPI_MSP_INIT_CB_ID QSPI MspInit callback ID
HAL_QSPI_MSP_DEINIT_CB_ID QSPI MspDeInit callback ID

Return values

status

Definition at line 2210 of file stm32f4xx_hal_qspi.c.

Functions

Detailed Description

Function Documentation

◆ HAL_QSPI_AbortCpltCallback()

◆ HAL_QSPI_AutoPolling()

◆ HAL_QSPI_AutoPolling_IT()

◆ HAL_QSPI_CmdCpltCallback()

◆ HAL_QSPI_Command()

◆ HAL_QSPI_Command_IT()

◆ HAL_QSPI_ErrorCallback()

◆ HAL_QSPI_FifoThresholdCallback()

◆ HAL_QSPI_IRQHandler()

◆ HAL_QSPI_MemoryMapped()

◆ HAL_QSPI_Receive()

◆ HAL_QSPI_Receive_DMA()

◆ HAL_QSPI_Receive_IT()

◆ HAL_QSPI_RegisterCallback()

◆ HAL_QSPI_RxCpltCallback()

◆ HAL_QSPI_RxHalfCpltCallback()

◆ HAL_QSPI_StatusMatchCallback()

◆ HAL_QSPI_TimeOutCallback()

◆ HAL_QSPI_Transmit()

◆ HAL_QSPI_Transmit_DMA()

◆ HAL_QSPI_Transmit_IT()

◆ HAL_QSPI_TxCpltCallback()

◆ HAL_QSPI_TxHalfCpltCallback()

◆ HAL_QSPI_UnRegisterCallback()