TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

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_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.

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

__weak void HAL_QSPI_AbortCpltCallback ( QSPI_HandleTypeDef *  hqspi )

Abort completed callback.

Parameters:
hqspi,:QSPI handle
Return values:
None

Definition at line 1715 of file stm32l4xx_hal_qspi.c.

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 1410 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 1510 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 1730 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 653 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 742 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 1700 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 1805 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 425 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 1614 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 928 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
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:
HALstatus

Definition at line 1276 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 1076 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 1745 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 1775 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 1820 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 1835 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 842 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
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:
HALstatus

Definition at line 1144 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 1016 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 1760 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 1790 of file stm32l4xx_hal_qspi.c.

Generated on Tue Jul 12 2022 17:38:54 by  doxygen 1.7.2