Peripheral Control and State functions

OSPI control and State functions. More...

Functions
HAL_StatusTypeDef	HAL_OSPI_Abort (OSPI_HandleTypeDef *hospi)
	Abort the current transmission. More...
HAL_StatusTypeDef	HAL_OSPI_Abort_IT (OSPI_HandleTypeDef *hospi)
	Abort the current transmission (non-blocking function) More...
HAL_StatusTypeDef	HAL_OSPI_SetFifoThreshold (OSPI_HandleTypeDef *hospi, uint32_t Threshold)
	Set OSPI Fifo threshold. More...
uint32_t	HAL_OSPI_GetFifoThreshold (OSPI_HandleTypeDef *hospi)
	Get OSPI Fifo threshold. More...
HAL_StatusTypeDef	HAL_OSPI_SetTimeout (OSPI_HandleTypeDef *hospi, uint32_t Timeout)
	Set OSPI timeout. More...
uint32_t	HAL_OSPI_GetError (OSPI_HandleTypeDef *hospi)
	Return the OSPI error code. More...
uint32_t	HAL_OSPI_GetState (OSPI_HandleTypeDef *hospi)
	Return the OSPI handle state. More...

Detailed Description

OSPI 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.
      (+) Manage the Fifo threshold.
      (+) Configure the timeout duration used in the driver.

Function Documentation

HAL_OSPI_Abort()

HAL_StatusTypeDef HAL_OSPI_Abort

(

OSPI_HandleTypeDef *

hospi

)

Abort the current transmission.

Parameters

hospi

: OSPI handle

Return values

HAL

status

Definition at line 2219 of file stm32l4xx_hal_ospi.c.

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

  /* Check if the state is in one of the busy or configured states */
  state = hospi->State;
  if (((state & OSPI_BUSY_STATE_MASK) != 0U) || ((state & OSPI_CFG_STATE_MASK) != 0U))
  {
    /* Check if the DMA is enabled */
    if ((hospi->Instance->CR & OCTOSPI_CR_DMAEN) != 0U)
    {
      /* Disable the DMA transfer on the OctoSPI side */
      CLEAR_BIT(hospi->Instance->CR, OCTOSPI_CR_DMAEN);

      /* Disable the DMA transfer on the DMA side */
      status = HAL_DMA_Abort(hospi->hdma);
      if (status != HAL_OK)
      {
        hospi->ErrorCode = HAL_OSPI_ERROR_DMA;
      }
    }

    if (__HAL_OSPI_GET_FLAG(hospi, HAL_OSPI_FLAG_BUSY) != RESET)
    {
      /* Perform an abort of the OctoSPI */
      SET_BIT(hospi->Instance->CR, OCTOSPI_CR_ABORT);

      /* Wait until the transfer complete flag is set to go back in idle state */
      status = OSPI_WaitFlagStateUntilTimeout(hospi, HAL_OSPI_FLAG_TC, SET, tickstart, hospi->Timeout);

      if (status == HAL_OK)
      {
        /* Clear transfer complete flag */
        __HAL_OSPI_CLEAR_FLAG(hospi, HAL_OSPI_FLAG_TC);

        /* Wait until the busy flag is reset to go back in idle state */
        status = OSPI_WaitFlagStateUntilTimeout(hospi, HAL_OSPI_FLAG_BUSY, RESET, tickstart, hospi->Timeout);

        if (status == HAL_OK)
        {
          /* Update state */
          hospi->State = HAL_OSPI_STATE_READY;
        }
      }
    }
    else
    {
      /* Update state */
      hospi->State = HAL_OSPI_STATE_READY;
    }
  }
  else
  {
    status = HAL_ERROR;
    hospi->ErrorCode = HAL_OSPI_ERROR_INVALID_SEQUENCE;
  }

  /* Return function status */
  return status;
}

HAL_OSPI_Abort_IT()

HAL_StatusTypeDef HAL_OSPI_Abort_IT

(

OSPI_HandleTypeDef *

hospi

)

Abort the current transmission (non-blocking function)

Parameters

hospi

: OSPI handle

Return values

HAL

status

Definition at line 2287 of file stm32l4xx_hal_ospi.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t state;

  /* Check if the state is in one of the busy or configured states */
  state = hospi->State;
  if (((state & OSPI_BUSY_STATE_MASK) != 0U) || ((state & OSPI_CFG_STATE_MASK) != 0U))
  {
    /* Disable all interrupts */
    __HAL_OSPI_DISABLE_IT(hospi, (HAL_OSPI_IT_TO | HAL_OSPI_IT_SM | HAL_OSPI_IT_FT | HAL_OSPI_IT_TC | HAL_OSPI_IT_TE));

    /* Update state */
    hospi->State = HAL_OSPI_STATE_ABORT;

    /* Check if the DMA is enabled */
    if ((hospi->Instance->CR & OCTOSPI_CR_DMAEN) != 0U)
    {
      /* Disable the DMA transfer on the OctoSPI side */
      CLEAR_BIT(hospi->Instance->CR, OCTOSPI_CR_DMAEN);

      /* Disable the DMA transfer on the DMA side */
      hospi->hdma->XferAbortCallback = OSPI_DMAAbortCplt;
      if (HAL_DMA_Abort_IT(hospi->hdma) != HAL_OK)
      {
        /* Update state */
        hospi->State = HAL_OSPI_STATE_READY;

        /* Abort callback */
#if defined (USE_HAL_OSPI_REGISTER_CALLBACKS) && (USE_HAL_OSPI_REGISTER_CALLBACKS == 1U)
        hospi->AbortCpltCallback(hospi);
#else
        HAL_OSPI_AbortCpltCallback(hospi);
#endif
      }
    }
    else
    {
      if (__HAL_OSPI_GET_FLAG(hospi, HAL_OSPI_FLAG_BUSY) != RESET)
      {
        /* Clear transfer complete flag */
        __HAL_OSPI_CLEAR_FLAG(hospi, HAL_OSPI_FLAG_TC);

        /* Enable the transfer complete interrupts */
        __HAL_OSPI_ENABLE_IT(hospi, HAL_OSPI_IT_TC);

        /* Perform an abort of the OctoSPI */
        SET_BIT(hospi->Instance->CR, OCTOSPI_CR_ABORT);
      }
      else
      {
        /* Update state */
        hospi->State = HAL_OSPI_STATE_READY;

        /* Abort callback */
#if defined (USE_HAL_OSPI_REGISTER_CALLBACKS) && (USE_HAL_OSPI_REGISTER_CALLBACKS == 1U)
        hospi->AbortCpltCallback(hospi);
#else
        HAL_OSPI_AbortCpltCallback(hospi);
#endif
      }
    }
  }
  else
  {
    status = HAL_ERROR;
    hospi->ErrorCode = HAL_OSPI_ERROR_INVALID_SEQUENCE;
  }

  /* Return function status */
  return status;
}

HAL_OSPI_GetError()

uint32_t HAL_OSPI_GetError

(

OSPI_HandleTypeDef *

hospi

)

Return the OSPI error code.

Parameters

hospi

: OSPI handle

Return values

OSPI	Error Code

Definition at line 2414 of file stm32l4xx_hal_ospi.c.

{
  return hospi->ErrorCode;
}

HAL_OSPI_GetFifoThreshold()

uint32_t HAL_OSPI_GetFifoThreshold

(

OSPI_HandleTypeDef *

hospi

)

Get OSPI Fifo threshold.

Parameters

hospi

: OSPI handle.

Return values

Fifo

threshold

Definition at line 2393 of file stm32l4xx_hal_ospi.c.

{
  return ((READ_BIT(hospi->Instance->CR, OCTOSPI_CR_FTHRES) >> OCTOSPI_CR_FTHRES_Pos) + 1U);
}

HAL_OSPI_GetState()

uint32_t HAL_OSPI_GetState

(

OSPI_HandleTypeDef *

hospi

)

Return the OSPI handle state.

Parameters

hospi

: OSPI handle

Return values

HAL

state

Definition at line 2424 of file stm32l4xx_hal_ospi.c.

{
  /* Return OSPI handle state */
  return hospi->State;
}

HAL_OSPI_SetFifoThreshold()

HAL_StatusTypeDef HAL_OSPI_SetFifoThreshold	(	OSPI_HandleTypeDef *	hospi,
		uint32_t	Threshold
	)

Set OSPI Fifo threshold.

Parameters

hospi	: OSPI handle.
Threshold	: Threshold of the Fifo.

Return values

HAL

status

Definition at line 2365 of file stm32l4xx_hal_ospi.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Check the state */
  if ((hospi->State & OSPI_BUSY_STATE_MASK) == 0U)
  {
    /* Synchronize initialization structure with the new fifo threshold value */
    hospi->Init.FifoThreshold = Threshold;

    /* Configure new fifo threshold */
    MODIFY_REG(hospi->Instance->CR, OCTOSPI_CR_FTHRES, ((hospi->Init.FifoThreshold-1U) << OCTOSPI_CR_FTHRES_Pos));

  }
  else
  {
    status = HAL_ERROR;
    hospi->ErrorCode = HAL_OSPI_ERROR_INVALID_SEQUENCE;
  }

  /* Return function status */
  return status;
}

HAL_OSPI_SetTimeout()

HAL_StatusTypeDef HAL_OSPI_SetTimeout	(	OSPI_HandleTypeDef *	hospi,
		uint32_t	Timeout
	)

Set OSPI timeout.

Parameters

hospi	: OSPI handle.
Timeout	: Timeout for the memory access.

Return values

None

Definition at line 2403 of file stm32l4xx_hal_ospi.c.

{
  hospi->Timeout = Timeout;
  return HAL_OK;
}