TUKS MCU Introductory course / TUKS-COURSE-2-LED
Embed: (wiki syntax)

« Back to documentation index

Peripheral Control and State functions

Peripheral Control and State functions
[QSPI Exported Functions]

QSPI control and State functions. More...

Functions

HAL_QSPI_StateTypeDef HAL_QSPI_GetState (QSPI_HandleTypeDef *hqspi)
 Return the QSPI handle state.
uint32_t HAL_QSPI_GetError (QSPI_HandleTypeDef *hqspi)
 Return the QSPI error code.
HAL_StatusTypeDef HAL_QSPI_Abort (QSPI_HandleTypeDef *hqspi)
 Abort the current transmission.
HAL_StatusTypeDef HAL_QSPI_Abort_IT (QSPI_HandleTypeDef *hqspi)
 Abort the current transmission (non-blocking function)
void HAL_QSPI_SetTimeout (QSPI_HandleTypeDef *hqspi, uint32_t Timeout)
 Set QSPI timeout.
HAL_StatusTypeDef HAL_QSPI_SetFifoThreshold (QSPI_HandleTypeDef *hqspi, uint32_t Threshold)
 Set QSPI Fifo threshold.
uint32_t HAL_QSPI_GetFifoThreshold (QSPI_HandleTypeDef *hqspi)
 Get QSPI Fifo threshold.

Detailed Description

QSPI control and State functions.

 ===============================================================================
                  ##### Peripheral Control and State functions #####
 ===============================================================================  
    [..]
    This subsection provides a set of functions allowing to :
      (+) Check in run-time the state of the driver. 
      (+) Check the error code set during last operation.
      (+) Abort any operation.

  

Function Documentation

HAL_StatusTypeDef HAL_QSPI_Abort ( QSPI_HandleTypeDef *  hqspi )

Abort the current transmission.

Parameters:
hqspi,:QSPI handle
Return values:
HALstatus

Definition at line 1893 of file stm32l4xx_hal_qspi.c.

HAL_StatusTypeDef HAL_QSPI_Abort_IT ( QSPI_HandleTypeDef *  hqspi )

Abort the current transmission (non-blocking function)

Parameters:
hqspi,:QSPI handle
Return values:
HALstatus

Definition at line 1946 of file stm32l4xx_hal_qspi.c.

uint32_t HAL_QSPI_GetError ( QSPI_HandleTypeDef *  hqspi )

Return the QSPI error code.

Parameters:
hqspi,:QSPI handle
Return values:
QSPIError Code

Definition at line 1883 of file stm32l4xx_hal_qspi.c.

uint32_t HAL_QSPI_GetFifoThreshold ( QSPI_HandleTypeDef *  hqspi )

Get QSPI Fifo threshold.

Parameters:
hqspi,:QSPI handle.
Return values:
Fifothreshold (value between 1 and 16)

Definition at line 2033 of file stm32l4xx_hal_qspi.c.

HAL_QSPI_StateTypeDef HAL_QSPI_GetState ( QSPI_HandleTypeDef *  hqspi )

Return the QSPI handle state.

Parameters:
hqspi,:QSPI handle
Return values:
HALstate

Definition at line 1872 of file stm32l4xx_hal_qspi.c.

HAL_StatusTypeDef HAL_QSPI_SetFifoThreshold ( QSPI_HandleTypeDef *  hqspi,
uint32_t  Threshold 
)

Set QSPI Fifo threshold.

Parameters:
hqspi,:QSPI handle.
Threshold,:Threshold of the Fifo (value between 1 and 16).
Return values:
HALstatus

Definition at line 2001 of file stm32l4xx_hal_qspi.c.

void HAL_QSPI_SetTimeout ( QSPI_HandleTypeDef *  hqspi,
uint32_t  Timeout 
)

Set QSPI timeout.

Parameters:
hqspi,:QSPI handle.
Timeout,:Timeout for the QSPI memory access.
Return values:
None

Definition at line 1991 of file stm32l4xx_hal_qspi.c.