STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_qspi.h File Reference

Header file of QSPI HAL module. More...

Go to the source code of this file.

Data Structures

struct  endif
 ADC handle Structure definition. More...
 
struct  QSPI_CommandTypeDef
 QSPI Command structure definition. More...
 
struct  QSPI_AutoPollingTypeDef
 QSPI Auto Polling mode configuration structure definition. More...
 
struct  QSPI_MemoryMappedTypeDef
 QSPI Memory Mapped mode configuration structure definition. More...
 

Typedefs

typedef struct __QSPI_HandleTypeDef else typedef struct endif QSPI_HandleTypeDef
 QSPI Handle Structure definition.
 
typedef void(* pQSPI_CallbackTypeDef) (QSPI_HandleTypeDef *hqspi)
 HAL QSPI Callback pointer definition.
 

Enumerations

enum  HAL_QSPI_StateTypeDef {
  HAL_QSPI_STATE_RESET = 0x00U , HAL_QSPI_STATE_READY = 0x01U , HAL_QSPI_STATE_BUSY = 0x02U , HAL_QSPI_STATE_BUSY_INDIRECT_TX = 0x12U ,
  HAL_QSPI_STATE_BUSY_INDIRECT_RX = 0x22U , HAL_QSPI_STATE_BUSY_AUTO_POLLING = 0x42U , HAL_QSPI_STATE_BUSY_MEM_MAPPED = 0x82U , HAL_QSPI_STATE_ABORT = 0x08U ,
  HAL_QSPI_STATE_ERROR = 0x04U
}
 HAL QSPI State structures definition. More...
 
enum  HAL_QSPI_CallbackIDTypeDef {
  HAL_QSPI_ERROR_CB_ID = 0x00U , HAL_QSPI_ABORT_CB_ID = 0x01U , HAL_QSPI_FIFO_THRESHOLD_CB_ID = 0x02U , HAL_QSPI_CMD_CPLT_CB_ID = 0x03U ,
  HAL_QSPI_RX_CPLT_CB_ID = 0x04U , HAL_QSPI_TX_CPLT_CB_ID = 0x05U , HAL_QSPI_RX_HALF_CPLT_CB_ID = 0x06U , HAL_QSPI_TX_HALF_CPLT_CB_ID = 0x07U ,
  HAL_QSPI_STATUS_MATCH_CB_ID = 0x08U , HAL_QSPI_TIMEOUT_CB_ID = 0x09U , HAL_QSPI_MSP_INIT_CB_ID = 0x0AU , HAL_QSPI_MSP_DEINIT_CB_ID = 0x0B0
}
 HAL QSPI Callback ID enumeration definition. More...
 

Functions

HAL_StatusTypeDef HAL_QSPI_Init (QSPI_HandleTypeDef *hqspi)
 Initialize the QSPI mode according to the specified parameters in the QSPI_InitTypeDef and initialize the associated handle. More...
 
HAL_StatusTypeDef HAL_QSPI_DeInit (QSPI_HandleTypeDef *hqspi)
 De-Initialize the QSPI peripheral. More...
 
void HAL_QSPI_MspInit (QSPI_HandleTypeDef *hqspi)
 Initialize the QSPI MSP. More...
 
void HAL_QSPI_MspDeInit (QSPI_HandleTypeDef *hqspi)
 DeInitialize the QSPI MSP. More...
 
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...
 
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...
 

Variables

 C
 

Detailed Description

Header file of QSPI HAL module.

Author
MCD Application Team
Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_qspi.h.


Data Structure Documentation

◆ QSPI_CommandTypeDef

struct QSPI_CommandTypeDef

QSPI Command structure definition.

Definition at line 131 of file stm32f4xx_hal_qspi.h.

Data Fields
uint32_t Address
uint32_t AddressMode
uint32_t AddressSize
uint32_t AlternateByteMode
uint32_t AlternateBytes
uint32_t AlternateBytesSize
uint32_t DataMode
uint32_t DdrHoldHalfCycle
uint32_t DdrMode
uint32_t DummyCycles
uint32_t Instruction
uint32_t InstructionMode
uint32_t NbData
uint32_t SIOOMode

◆ QSPI_AutoPollingTypeDef

struct QSPI_AutoPollingTypeDef

QSPI Auto Polling mode configuration structure definition.

Definition at line 168 of file stm32f4xx_hal_qspi.h.

Data Fields
uint32_t AutomaticStop
uint32_t Interval
uint32_t Mask
uint32_t Match
uint32_t MatchMode
uint32_t StatusBytesSize

◆ QSPI_MemoryMappedTypeDef

struct QSPI_MemoryMappedTypeDef

QSPI Memory Mapped mode configuration structure definition.

Definition at line 187 of file stm32f4xx_hal_qspi.h.

Data Fields
uint32_t TimeOutActivation
uint32_t TimeOutPeriod

Enumeration Type Documentation

◆ HAL_QSPI_CallbackIDTypeDef

HAL QSPI Callback ID enumeration definition.

Enumerator
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

Definition at line 199 of file stm32f4xx_hal_qspi.h.

◆ HAL_QSPI_StateTypeDef

HAL QSPI State structures definition.

Enumerator
HAL_QSPI_STATE_RESET 

Peripheral not initialized

HAL_QSPI_STATE_READY 

Peripheral initialized and ready for use

HAL_QSPI_STATE_BUSY 

Peripheral in indirect mode and busy

HAL_QSPI_STATE_BUSY_INDIRECT_TX 

Peripheral in indirect mode with transmission ongoing

HAL_QSPI_STATE_BUSY_INDIRECT_RX 

Peripheral in indirect mode with reception ongoing

HAL_QSPI_STATE_BUSY_AUTO_POLLING 

Peripheral in auto polling mode ongoing

HAL_QSPI_STATE_BUSY_MEM_MAPPED 

Peripheral in memory mapped mode ongoing

HAL_QSPI_STATE_ABORT 

Peripheral with abort request ongoing

HAL_QSPI_STATE_ERROR 

Peripheral in error

Definition at line 76 of file stm32f4xx_hal_qspi.h.

Variable Documentation

◆ C

C
extern
Initial value:
{
#endif
#if defined(QUADSPI)
typedef struct
{
uint32_t ClockPrescaler;
uint32_t FifoThreshold;
uint32_t SampleShifting;
uint32_t FlashSize;
uint32_t ChipSelectHighTime;
uint32_t ClockMode;
uint32_t FlashID;
uint32_t DualFlash;
}QSPI_InitTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.