Peripheral Control and State functions

QSPI control and State functions. More...

Functions
HAL_QSPI_StateTypeDef	HAL_QSPI_GetState (QSPI_HandleTypeDef *hqspi)
	Return the QSPI handle state. More...
uint32_t	HAL_QSPI_GetError (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 (QSPI_HandleTypeDef *hqspi)
	Get QSPI Fifo threshold. More...
HAL_StatusTypeDef	HAL_QSPI_SetFlashID (QSPI_HandleTypeDef *hqspi, uint32_t FlashID)
	Set FlashID. More...

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_QSPI_Abort()

HAL_StatusTypeDef HAL_QSPI_Abort

(

QSPI_HandleTypeDef *

hqspi

)

Abort the current transmission.

Parameters

hqspi

: QSPI handle

Return values

HAL

status

Definition at line 2285 of file stm32l4xx_hal_qspi.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t tickstart = HAL_GetTick();

  /* Check if the state is in one of the busy states */
  if (((uint32_t)hqspi->State & 0x2U) != 0U)
  {
    /* Process unlocked */
    __HAL_UNLOCK(hqspi);

    if ((hqspi->Instance->CR & QUADSPI_CR_DMAEN) != 0U)
    {
      /* Disable the DMA transfer by clearing the DMAEN bit in the QSPI CR register */
      CLEAR_BIT(hqspi->Instance->CR, QUADSPI_CR_DMAEN);

      /* Abort DMA channel */
      status = HAL_DMA_Abort(hqspi->hdma);
      if(status != HAL_OK)
      {
        hqspi->ErrorCode |= HAL_QSPI_ERROR_DMA;
      }
    }

    /* Configure QSPI: CR register with Abort request */
    SET_BIT(hqspi->Instance->CR, QUADSPI_CR_ABORT);

    /* Wait until TC flag is set to go back in idle state */
    status = QSPI_WaitFlagStateUntilTimeout(hqspi, QSPI_FLAG_TC, SET, tickstart, hqspi->Timeout);

    if (status == HAL_OK)
    {
      __HAL_QSPI_CLEAR_FLAG(hqspi, QSPI_FLAG_TC);

      /* Wait until BUSY flag is reset */
      status = QSPI_WaitFlagStateUntilTimeout(hqspi, QSPI_FLAG_BUSY, RESET, tickstart, hqspi->Timeout);
    }

    if (status == HAL_OK)
    {
      /* Reset functional mode configuration to indirect write mode by default */
      CLEAR_BIT(hqspi->Instance->CCR, QUADSPI_CCR_FMODE);

      /* Update state */
      hqspi->State = HAL_QSPI_STATE_READY;
    }
  }

  return status;
}

HAL_QSPI_Abort_IT()

HAL_StatusTypeDef HAL_QSPI_Abort_IT

(

QSPI_HandleTypeDef *

hqspi

)

Abort the current transmission (non-blocking function)

Parameters

hqspi

: QSPI handle

Return values

HAL

status

Definition at line 2341 of file stm32l4xx_hal_qspi.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Check if the state is in one of the busy states */
  if (((uint32_t)hqspi->State & 0x2U) != 0U)
  {
    /* Process unlocked */
    __HAL_UNLOCK(hqspi);

    /* Update QSPI state */
    hqspi->State = HAL_QSPI_STATE_ABORT;

    /* Disable all interrupts */
    __HAL_QSPI_DISABLE_IT(hqspi, (QSPI_IT_TO | QSPI_IT_SM | QSPI_IT_FT | QSPI_IT_TC | QSPI_IT_TE));

    if ((hqspi->Instance->CR & QUADSPI_CR_DMAEN) != 0U)
    {
      /* Disable the DMA transfer by clearing the DMAEN bit in the QSPI CR register */
      CLEAR_BIT(hqspi->Instance->CR, QUADSPI_CR_DMAEN);

      /* Abort DMA channel */
      hqspi->hdma->XferAbortCallback = QSPI_DMAAbortCplt;
      if (HAL_DMA_Abort_IT(hqspi->hdma) != HAL_OK)
      {
        /* Change state of QSPI */
        hqspi->State = HAL_QSPI_STATE_READY;
        
        /* Abort Complete callback */
#if (USE_HAL_QSPI_REGISTER_CALLBACKS == 1)
        hqspi->AbortCpltCallback(hqspi);
#else
        HAL_QSPI_AbortCpltCallback(hqspi);
#endif
      }
    }
    else
    {
      /* Clear interrupt */
      __HAL_QSPI_CLEAR_FLAG(hqspi, QSPI_FLAG_TC);

      /* Enable the QSPI Transfer Complete Interrupt */
      __HAL_QSPI_ENABLE_IT(hqspi, QSPI_IT_TC);

      /* Configure QSPI: CR register with Abort request */
      SET_BIT(hqspi->Instance->CR, QUADSPI_CR_ABORT);
    }
  }
  return status;
}

HAL_QSPI_GetError()

uint32_t HAL_QSPI_GetError

(

QSPI_HandleTypeDef *

hqspi

)

Return the QSPI error code.

Parameters

hqspi

: QSPI handle

Return values

QSPI	Error Code

Definition at line 2275 of file stm32l4xx_hal_qspi.c.

{
  return hqspi->ErrorCode;
}

HAL_QSPI_GetFifoThreshold()

uint32_t HAL_QSPI_GetFifoThreshold

(

QSPI_HandleTypeDef *

hqspi

)

Get QSPI Fifo threshold.

Parameters

hqspi

: QSPI handle.

Return values

Fifo	threshold (value between 1 and 16)

Definition at line 2439 of file stm32l4xx_hal_qspi.c.

{
  return ((READ_BIT(hqspi->Instance->CR, QUADSPI_CR_FTHRES) >> QUADSPI_CR_FTHRES_Pos) + 1U);
}

HAL_QSPI_GetState()

HAL_QSPI_StateTypeDef HAL_QSPI_GetState

(

QSPI_HandleTypeDef *

hqspi

)

Return the QSPI handle state.

Parameters

hqspi

: QSPI handle

Return values

HAL

state

Definition at line 2264 of file stm32l4xx_hal_qspi.c.

{
  /* Return QSPI handle state */
  return hqspi->State;
}

HAL_QSPI_SetFifoThreshold()

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

HAL

status

Definition at line 2407 of file stm32l4xx_hal_qspi.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hqspi);

  if(hqspi->State == HAL_QSPI_STATE_READY)
  {
    /* Synchronize init structure with new FIFO threshold value */
    hqspi->Init.FifoThreshold = Threshold;

    /* Configure QSPI FIFO Threshold */
    MODIFY_REG(hqspi->Instance->CR, QUADSPI_CR_FTHRES,
               ((hqspi->Init.FifoThreshold - 1U) << QUADSPI_CR_FTHRES_Pos));
  }
  else
  {
    status = HAL_BUSY;
  }

  /* Process unlocked */
  __HAL_UNLOCK(hqspi);

  /* Return function status */
  return status;
}

HAL_QSPI_SetFlashID()

HAL_StatusTypeDef HAL_QSPI_SetFlashID	(	QSPI_HandleTypeDef *	hqspi,
		uint32_t	FlashID
	)

Set FlashID.

Parameters

hqspi	: QSPI handle.
FlashID	: Index of the flash memory to be accessed. This parameter can be a value of QSPI Flash Select.

Note

The FlashID is ignored when dual flash mode is enabled.

Return values

HAL

status

Definition at line 2452 of file stm32l4xx_hal_qspi.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Check the parameter */
  assert_param(IS_QSPI_FLASH_ID(FlashID));

  /* Process locked */
  __HAL_LOCK(hqspi);

  if(hqspi->State == HAL_QSPI_STATE_READY)
  {
    /* Synchronize init structure with new FlashID value */
    hqspi->Init.FlashID = FlashID;

    /* Configure QSPI FlashID */
    MODIFY_REG(hqspi->Instance->CR, QUADSPI_CR_FSEL, FlashID);
  }
  else
  {
    status = HAL_BUSY;
  }

  /* Process unlocked */
  __HAL_UNLOCK(hqspi);

  /* Return function status */
  return status;
}

HAL_QSPI_SetTimeout()

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 2397 of file stm32l4xx_hal_qspi.c.

{
  hqspi->Timeout = Timeout;
}