Eric Lewiston / STM32L4xx_HAL_Driver

Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

Input and Output operation functions
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_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.

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_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:
HALstatus

Definition at line 1164 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 1265 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_CmdCpltCallback ( QSPI_HandleTypeDef *  hqspi )

Command completed callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1456 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 567 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 658 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_ErrorCallback ( QSPI_HandleTypeDef *  hqspi )

Transfer Error callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1444 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_FifoThresholdCallback ( QSPI_HandleTypeDef *  hqspi )

FIFO Threshold callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1516 of file stm32l4xx_hal_qspi.c.

void HAL_QSPI_IRQHandler ( QSPI_HandleTypeDef *  hqspi )

Handle QSPI interrupt request.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 391 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 1359 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 827 of file stm32l4xx_hal_qspi.c.

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
Return values:
HALstatus

Definition at line 1090 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 965 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_RxCpltCallback ( QSPI_HandleTypeDef *  hqspi )

Rx Transfer completed callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1468 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_RxHalfCpltCallback ( QSPI_HandleTypeDef *  hqspi )

Rx Half Transfer completed callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1492 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_StatusMatchCallback ( QSPI_HandleTypeDef *  hqspi )

Status Match callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1528 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_TimeOutCallback ( QSPI_HandleTypeDef *  hqspi )

Timeout callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1540 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 744 of file stm32l4xx_hal_qspi.c.

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
Return values:
HALstatus

Definition at line 1022 of file stm32l4xx_hal_qspi.c.

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:
HALstatus

Definition at line 912 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_TxCpltCallback ( QSPI_HandleTypeDef *  hqspi )

Tx Transfer completed callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1480 of file stm32l4xx_hal_qspi.c.

__weak void HAL_QSPI_TxHalfCpltCallback ( QSPI_HandleTypeDef *  hqspi )

Tx Half Transfer completed callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1504 of file stm32l4xx_hal_qspi.c.

Generated on Tue Jul 12 2022 11:35:30 by  doxygen 1.7.2