STM32L443xx HAL User Manual
Functions
Input and Output operation functions
QSPI Exported Functions

QSPI Transmit/Receive functions. More...

Functions

void HAL_QSPI_IRQHandler (QSPI_HandleTypeDef *hqspi)
 Handle QSPI interrupt request.
HAL_StatusTypeDef HAL_QSPI_Command (QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, uint32_t Timeout)
 Set the command configuration.
HAL_StatusTypeDef HAL_QSPI_Command_IT (QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd)
 Set the command configuration in interrupt mode.
HAL_StatusTypeDef HAL_QSPI_Transmit (QSPI_HandleTypeDef *hqspi, uint8_t *pData, uint32_t Timeout)
 Transmit an amount of data in blocking mode.
HAL_StatusTypeDef HAL_QSPI_Receive (QSPI_HandleTypeDef *hqspi, uint8_t *pData, uint32_t Timeout)
 Receive an amount of data in blocking mode.
HAL_StatusTypeDef HAL_QSPI_Transmit_IT (QSPI_HandleTypeDef *hqspi, uint8_t *pData)
 Send an amount of data in non-blocking mode with interrupt.
HAL_StatusTypeDef HAL_QSPI_Receive_IT (QSPI_HandleTypeDef *hqspi, uint8_t *pData)
 Receive an amount of data in non-blocking mode with interrupt.
HAL_StatusTypeDef HAL_QSPI_Transmit_DMA (QSPI_HandleTypeDef *hqspi, uint8_t *pData)
 Send an amount of data in non-blocking mode with DMA.
HAL_StatusTypeDef HAL_QSPI_Receive_DMA (QSPI_HandleTypeDef *hqspi, uint8_t *pData)
 Receive an amount of data in non-blocking mode with DMA.
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.
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.
HAL_StatusTypeDef HAL_QSPI_MemoryMapped (QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, QSPI_MemoryMappedTypeDef *cfg)
 Configure the Memory Mapped mode.
__weak void HAL_QSPI_ErrorCallback (QSPI_HandleTypeDef *hqspi)
 Transfer Error callback.
__weak void HAL_QSPI_AbortCpltCallback (QSPI_HandleTypeDef *hqspi)
 Abort completed callback.
__weak void HAL_QSPI_CmdCpltCallback (QSPI_HandleTypeDef *hqspi)
 Command completed callback.
__weak void HAL_QSPI_RxCpltCallback (QSPI_HandleTypeDef *hqspi)
 Rx Transfer completed callback.
__weak void HAL_QSPI_TxCpltCallback (QSPI_HandleTypeDef *hqspi)
 Tx Transfer completed callback.
__weak void HAL_QSPI_RxHalfCpltCallback (QSPI_HandleTypeDef *hqspi)
 Rx Half Transfer completed callback.
__weak void HAL_QSPI_TxHalfCpltCallback (QSPI_HandleTypeDef *hqspi)
 Tx Half Transfer completed callback.
__weak void HAL_QSPI_FifoThresholdCallback (QSPI_HandleTypeDef *hqspi)
 FIFO Threshold callback.
__weak void HAL_QSPI_StatusMatchCallback (QSPI_HandleTypeDef *hqspi)
 Status Match callback.
__weak void HAL_QSPI_TimeOutCallback (QSPI_HandleTypeDef *hqspi)
 Timeout callback.
HAL_StatusTypeDef HAL_QSPI_RegisterCallback (QSPI_HandleTypeDef *hqspi, HAL_QSPI_CallbackIDTypeDef CallbackId, pQSPI_CallbackTypeDef pCallback)
 Register a User QSPI Callback To be used instead of the weak (surcharged) predefined callback.
HAL_StatusTypeDef HAL_QSPI_UnRegisterCallback (QSPI_HandleTypeDef *hqspi, HAL_QSPI_CallbackIDTypeDef CallbackId)
 Unregister a User QSPI Callback QSPI Callback is redirected to the weak (surcharged) predefined callback.

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

Abort completed callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1880 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Abort_IT(), HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

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:
hqspiQSPI handle
cmdstructure that contains the command configuration information.
cfgstructure that contains the polling configuration information.
TimeoutTimeout duration
Note:
This function is used only in Automatic Polling Mode
Return values:
HALstatus

Definition at line 1575 of file stm32l4xx_hal_qspi.c.

References __HAL_QSPI_CLEAR_FLAG, QSPI_CommandTypeDef::AddressMode, QSPI_CommandTypeDef::AddressSize, QSPI_CommandTypeDef::AlternateByteMode, QSPI_CommandTypeDef::AlternateBytesSize, assert_param, QSPI_CommandTypeDef::DataMode, QSPI_CommandTypeDef::DdrHoldHalfCycle, QSPI_CommandTypeDef::DdrMode, QSPI_CommandTypeDef::DummyCycles, __QSPI_HandleTypeDef::ErrorCode, HAL_GetTick(), HAL_QSPI_ERROR_NONE, HAL_QSPI_STATE_BUSY_AUTO_POLLING, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::Instance, QSPI_CommandTypeDef::Instruction, QSPI_CommandTypeDef::InstructionMode, QSPI_AutoPollingTypeDef::Interval, IS_QSPI_ADDRESS_MODE, IS_QSPI_ADDRESS_SIZE, IS_QSPI_ALTERNATE_BYTES_MODE, IS_QSPI_ALTERNATE_BYTES_SIZE, IS_QSPI_DATA_MODE, IS_QSPI_DDR_HHC, IS_QSPI_DDR_MODE, IS_QSPI_DUMMY_CYCLES, IS_QSPI_INSTRUCTION, IS_QSPI_INSTRUCTION_MODE, IS_QSPI_INTERVAL, IS_QSPI_MATCH_MODE, IS_QSPI_SIOO_MODE, IS_QSPI_STATUS_BYTES_SIZE, QSPI_AutoPollingTypeDef::Mask, QSPI_AutoPollingTypeDef::Match, QSPI_AutoPollingTypeDef::MatchMode, QSPI_CommandTypeDef::NbData, QSPI_ADDRESS_NONE, QSPI_ALTERNATE_BYTES_NONE, QSPI_AUTOMATIC_STOP_ENABLE, QSPI_Config(), QSPI_FLAG_BUSY, QSPI_FLAG_SM, QSPI_FUNCTIONAL_MODE_AUTO_POLLING, QSPI_INSTRUCTION_NONE, QSPI_WaitFlagStateUntilTimeout(), QSPI_CommandTypeDef::SIOOMode, __QSPI_HandleTypeDef::State, and QSPI_AutoPollingTypeDef::StatusBytesSize.

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:
hqspiQSPI handle
cmdstructure that contains the command configuration information.
cfgstructure that contains the polling configuration information.
Note:
This function is used only in Automatic Polling Mode
Return values:
HALstatus

Definition at line 1675 of file stm32l4xx_hal_qspi.c.

References __HAL_QSPI_CLEAR_FLAG, __HAL_QSPI_ENABLE_IT, QSPI_CommandTypeDef::AddressMode, QSPI_CommandTypeDef::AddressSize, QSPI_CommandTypeDef::AlternateByteMode, QSPI_CommandTypeDef::AlternateBytesSize, assert_param, QSPI_AutoPollingTypeDef::AutomaticStop, QSPI_CommandTypeDef::DataMode, QSPI_CommandTypeDef::DdrHoldHalfCycle, QSPI_CommandTypeDef::DdrMode, QSPI_CommandTypeDef::DummyCycles, __QSPI_HandleTypeDef::ErrorCode, HAL_GetTick(), HAL_QSPI_ERROR_NONE, HAL_QSPI_STATE_BUSY_AUTO_POLLING, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::Instance, QSPI_CommandTypeDef::Instruction, QSPI_CommandTypeDef::InstructionMode, QSPI_AutoPollingTypeDef::Interval, IS_QSPI_ADDRESS_MODE, IS_QSPI_ADDRESS_SIZE, IS_QSPI_ALTERNATE_BYTES_MODE, IS_QSPI_ALTERNATE_BYTES_SIZE, IS_QSPI_AUTOMATIC_STOP, IS_QSPI_DATA_MODE, IS_QSPI_DDR_HHC, IS_QSPI_DDR_MODE, IS_QSPI_DUMMY_CYCLES, IS_QSPI_INSTRUCTION, IS_QSPI_INSTRUCTION_MODE, IS_QSPI_INTERVAL, IS_QSPI_MATCH_MODE, IS_QSPI_SIOO_MODE, IS_QSPI_STATUS_BYTES_SIZE, QSPI_AutoPollingTypeDef::Mask, QSPI_AutoPollingTypeDef::Match, QSPI_AutoPollingTypeDef::MatchMode, QSPI_CommandTypeDef::NbData, QSPI_ADDRESS_NONE, QSPI_ALTERNATE_BYTES_NONE, QSPI_Config(), QSPI_FLAG_BUSY, QSPI_FLAG_SM, QSPI_FLAG_TE, QSPI_FUNCTIONAL_MODE_AUTO_POLLING, QSPI_INSTRUCTION_NONE, QSPI_IT_SM, QSPI_IT_TE, QSPI_WaitFlagStateUntilTimeout(), QSPI_CommandTypeDef::SIOOMode, __QSPI_HandleTypeDef::State, QSPI_AutoPollingTypeDef::StatusBytesSize, and __QSPI_HandleTypeDef::Timeout.

Command completed callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1895 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

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

Transfer Error callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1865 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), HAL_QSPI_UnRegisterCallback(), and QSPI_DMAAbortCplt().

FIFO Threshold callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1970 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

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

Configure the Memory Mapped mode.

Parameters:
hqspiQSPI handle
cmdstructure that contains the command configuration information.
cfgstructure that contains the memory mapped configuration information.
Note:
This function is used only in Memory mapped Mode
Return values:
HALstatus

Definition at line 1779 of file stm32l4xx_hal_qspi.c.

References __HAL_QSPI_CLEAR_FLAG, __HAL_QSPI_ENABLE_IT, QSPI_CommandTypeDef::AddressMode, QSPI_CommandTypeDef::AddressSize, QSPI_CommandTypeDef::AlternateByteMode, QSPI_CommandTypeDef::AlternateBytesSize, assert_param, QSPI_CommandTypeDef::DataMode, QSPI_CommandTypeDef::DdrHoldHalfCycle, QSPI_CommandTypeDef::DdrMode, QSPI_CommandTypeDef::DummyCycles, __QSPI_HandleTypeDef::ErrorCode, HAL_GetTick(), HAL_QSPI_ERROR_NONE, HAL_QSPI_STATE_BUSY_MEM_MAPPED, HAL_QSPI_STATE_READY, __QSPI_HandleTypeDef::Instance, QSPI_CommandTypeDef::Instruction, QSPI_CommandTypeDef::InstructionMode, IS_QSPI_ADDRESS_MODE, IS_QSPI_ADDRESS_SIZE, IS_QSPI_ALTERNATE_BYTES_MODE, IS_QSPI_ALTERNATE_BYTES_SIZE, IS_QSPI_DATA_MODE, IS_QSPI_DDR_HHC, IS_QSPI_DDR_MODE, IS_QSPI_DUMMY_CYCLES, IS_QSPI_INSTRUCTION, IS_QSPI_INSTRUCTION_MODE, IS_QSPI_SIOO_MODE, IS_QSPI_TIMEOUT_ACTIVATION, IS_QSPI_TIMEOUT_PERIOD, QSPI_ADDRESS_NONE, QSPI_ALTERNATE_BYTES_NONE, QSPI_Config(), QSPI_FLAG_BUSY, QSPI_FLAG_TO, QSPI_FUNCTIONAL_MODE_MEMORY_MAPPED, QSPI_INSTRUCTION_NONE, QSPI_IT_TO, QSPI_TIMEOUT_COUNTER_ENABLE, QSPI_WaitFlagStateUntilTimeout(), QSPI_CommandTypeDef::SIOOMode, __QSPI_HandleTypeDef::State, __QSPI_HandleTypeDef::Timeout, QSPI_MemoryMappedTypeDef::TimeOutActivation, and QSPI_MemoryMappedTypeDef::TimeOutPeriod.

HAL_StatusTypeDef HAL_QSPI_Receive ( QSPI_HandleTypeDef hqspi,
uint8_t *  pData,
uint32_t  Timeout 
)
HAL_StatusTypeDef HAL_QSPI_Receive_DMA ( QSPI_HandleTypeDef hqspi,
uint8_t *  pData 
)
HAL_StatusTypeDef HAL_QSPI_Receive_IT ( QSPI_HandleTypeDef hqspi,
uint8_t *  pData 
)
HAL_StatusTypeDef HAL_QSPI_RegisterCallback ( QSPI_HandleTypeDef hqspi,
HAL_QSPI_CallbackIDTypeDef  CallbackId,
pQSPI_CallbackTypeDef  pCallback 
)

Register a User QSPI Callback To be used instead of the weak (surcharged) predefined callback.

Parameters:
hqspiQSPI handle
CallbackIdID of the callback to be registered This parameter can be one of the following values:
pCallbackpointer to the Callback function
Return values:
status

Definition at line 2031 of file stm32l4xx_hal_qspi.c.

References __QSPI_HandleTypeDef::AbortCpltCallback, __QSPI_HandleTypeDef::CmdCpltCallback, __QSPI_HandleTypeDef::ErrorCallback, __QSPI_HandleTypeDef::ErrorCode, __QSPI_HandleTypeDef::FifoThresholdCallback, HAL_QSPI_ABORT_CB_ID, HAL_QSPI_CMD_CPLT_CB_ID, HAL_QSPI_ERROR_CB_ID, HAL_QSPI_ERROR_INVALID_CALLBACK, HAL_QSPI_FIFO_THRESHOLD_CB_ID, HAL_QSPI_MSP_DEINIT_CB_ID, HAL_QSPI_MSP_INIT_CB_ID, HAL_QSPI_RX_CPLT_CB_ID, HAL_QSPI_RX_HALF_CPLT_CB_ID, HAL_QSPI_STATE_READY, HAL_QSPI_STATE_RESET, HAL_QSPI_STATUS_MATCH_CB_ID, HAL_QSPI_TIMEOUT_CB_ID, HAL_QSPI_TX_CPLT_CB_ID, HAL_QSPI_TX_HALF_CPLT_CB_ID, __QSPI_HandleTypeDef::MspDeInitCallback, __QSPI_HandleTypeDef::MspInitCallback, __QSPI_HandleTypeDef::RxCpltCallback, __QSPI_HandleTypeDef::RxHalfCpltCallback, __QSPI_HandleTypeDef::State, __QSPI_HandleTypeDef::StatusMatchCallback, __QSPI_HandleTypeDef::TimeOutCallback, __QSPI_HandleTypeDef::TxCpltCallback, and __QSPI_HandleTypeDef::TxHalfCpltCallback.

Rx Transfer completed callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1910 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

Rx Half Transfer completed callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1940 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_UnRegisterCallback(), and QSPI_DMARxHalfCplt().

Status Match callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1985 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

Timeout callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 2000 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

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

Tx Transfer completed callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1925 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_IRQHandler(), and HAL_QSPI_UnRegisterCallback().

Tx Half Transfer completed callback.

Parameters:
hqspiQSPI handle
Return values:
None

Definition at line 1955 of file stm32l4xx_hal_qspi.c.

Referenced by HAL_QSPI_Init(), HAL_QSPI_UnRegisterCallback(), and QSPI_DMATxHalfCplt().

HAL_StatusTypeDef HAL_QSPI_UnRegisterCallback ( QSPI_HandleTypeDef hqspi,
HAL_QSPI_CallbackIDTypeDef  CallbackId 
)

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

Parameters:
hqspiQSPI handle
CallbackIdID of the callback to be unregistered This parameter can be one of the following values:
Return values:
status

Definition at line 2144 of file stm32l4xx_hal_qspi.c.

References __QSPI_HandleTypeDef::AbortCpltCallback, __QSPI_HandleTypeDef::CmdCpltCallback, __QSPI_HandleTypeDef::ErrorCallback, __QSPI_HandleTypeDef::ErrorCode, __QSPI_HandleTypeDef::FifoThresholdCallback, HAL_QSPI_ABORT_CB_ID, HAL_QSPI_AbortCpltCallback(), HAL_QSPI_CMD_CPLT_CB_ID, HAL_QSPI_CmdCpltCallback(), HAL_QSPI_ERROR_CB_ID, HAL_QSPI_ERROR_INVALID_CALLBACK, HAL_QSPI_ErrorCallback(), HAL_QSPI_FIFO_THRESHOLD_CB_ID, HAL_QSPI_FifoThresholdCallback(), HAL_QSPI_MSP_DEINIT_CB_ID, HAL_QSPI_MSP_INIT_CB_ID, HAL_QSPI_MspDeInit(), HAL_QSPI_MspInit(), HAL_QSPI_RX_CPLT_CB_ID, HAL_QSPI_RX_HALF_CPLT_CB_ID, HAL_QSPI_RxCpltCallback(), HAL_QSPI_RxHalfCpltCallback(), HAL_QSPI_STATE_READY, HAL_QSPI_STATE_RESET, HAL_QSPI_STATUS_MATCH_CB_ID, HAL_QSPI_StatusMatchCallback(), HAL_QSPI_TIMEOUT_CB_ID, HAL_QSPI_TimeOutCallback(), HAL_QSPI_TX_CPLT_CB_ID, HAL_QSPI_TX_HALF_CPLT_CB_ID, HAL_QSPI_TxCpltCallback(), HAL_QSPI_TxHalfCpltCallback(), __QSPI_HandleTypeDef::MspDeInitCallback, __QSPI_HandleTypeDef::MspInitCallback, __QSPI_HandleTypeDef::RxCpltCallback, __QSPI_HandleTypeDef::RxHalfCpltCallback, __QSPI_HandleTypeDef::State, __QSPI_HandleTypeDef::StatusMatchCallback, __QSPI_HandleTypeDef::TimeOutCallback, __QSPI_HandleTypeDef::TxCpltCallback, and __QSPI_HandleTypeDef::TxHalfCpltCallback.