Operations functions

GFXMMU operation functions. More...

Functions
HAL_StatusTypeDef	HAL_GFXMMU_ConfigLut (GFXMMU_HandleTypeDef *hgfxmmu, uint32_t FirstLine, uint32_t LinesNumber, uint32_t Address)
	This function allows to copy LUT from flash to look up RAM. More...
HAL_StatusTypeDef	HAL_GFXMMU_DisableLutLines (GFXMMU_HandleTypeDef *hgfxmmu, uint32_t FirstLine, uint32_t LinesNumber)
	This function allows to disable a range of LUT lines. More...
HAL_StatusTypeDef	HAL_GFXMMU_ConfigLutLine (GFXMMU_HandleTypeDef *hgfxmmu, GFXMMU_LutLineTypeDef *lutLine)
	This function allows to configure one line of LUT. More...
HAL_StatusTypeDef	HAL_GFXMMU_ModifyBuffers (GFXMMU_HandleTypeDef *hgfxmmu, GFXMMU_BuffersTypeDef *Buffers)
	This function allows to modify physical buffer addresses. More...
void	HAL_GFXMMU_IRQHandler (GFXMMU_HandleTypeDef *hgfxmmu)
	This function handles the GFXMMU interrupts. More...
void	HAL_GFXMMU_ErrorCallback (GFXMMU_HandleTypeDef *hgfxmmu)
	Error callback. More...

Detailed Description

GFXMMU operation functions.

  ==============================================================================
                      ##### Operation functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure LUT.
      (+) Modify physical buffer adresses.
      (+) Manage error.

Function Documentation

HAL_GFXMMU_ConfigLut()

HAL_StatusTypeDef HAL_GFXMMU_ConfigLut	(	GFXMMU_HandleTypeDef *	hgfxmmu,
		uint32_t	FirstLine,
		uint32_t	LinesNumber,
		uint32_t	Address
	)

This function allows to copy LUT from flash to look up RAM.

Parameters

hgfxmmu	GFXMMU handle.
FirstLine	First line enabled on LUT. This parameter must be a number between Min_Data = 0 and Max_Data = 1023.
LinesNumber	Number of lines enabled on LUT. This parameter must be a number between Min_Data = 1 and Max_Data = 1024.
Address	Start address of LUT in flash.

Return values

HAL

status.

Definition at line 476 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Check parameters */
  assert_param(IS_GFXMMU_ALL_INSTANCE(hgfxmmu->Instance));
  assert_param(IS_GFXMMU_LUT_LINE(FirstLine));
  assert_param(IS_GFXMMU_LUT_LINES_NUMBER(LinesNumber));
  
  /* Check GFXMMU state and coherent parameters */
  if((hgfxmmu->State != HAL_GFXMMU_STATE_READY) || ((FirstLine + LinesNumber) > 1024U))
  {
    status = HAL_ERROR;
  }
  else
  {
    uint32_t current_address, current_line, lutxl_address, lutxh_address;
    
    /* Initialize local variables */
    current_address = Address;
    current_line    = 0U;
    lutxl_address   = (uint32_t) &(hgfxmmu->Instance->LUT[2U * FirstLine]);
    lutxh_address   = (uint32_t) &(hgfxmmu->Instance->LUT[(2U * FirstLine) + 1U]);
    
    /* Copy LUT from flash to look up RAM */
    while(current_line < LinesNumber)
    {
      *((uint32_t *)lutxl_address) = *((uint32_t *)current_address);
      current_address += 4U;
      *((uint32_t *)lutxh_address) = *((uint32_t *)current_address);
      current_address += 4U;
      lutxl_address += 8U;
      lutxh_address += 8U;
      current_line++;
    }
  }
  /* Return function status */
  return status;
}

HAL_GFXMMU_ConfigLutLine()

HAL_StatusTypeDef HAL_GFXMMU_ConfigLutLine	(	GFXMMU_HandleTypeDef *	hgfxmmu,
		GFXMMU_LutLineTypeDef *	lutLine
	)

This function allows to configure one line of LUT.

Parameters

hgfxmmu	GFXMMU handle.
lutLine	LUT line parameters.

Return values

HAL

status.

Definition at line 573 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Check parameters */
  assert_param(IS_GFXMMU_ALL_INSTANCE(hgfxmmu->Instance));
  assert_param(IS_GFXMMU_LUT_LINE(lutLine->LineNumber));
  assert_param(IS_GFXMMU_LUT_LINE_STATUS(lutLine->LineStatus));
  assert_param(IS_GFXMMU_LUT_BLOCK(lutLine->FirstVisibleBlock));
  assert_param(IS_GFXMMU_LUT_BLOCK(lutLine->LastVisibleBlock));
  assert_param(IS_GFXMMU_LUT_LINE_OFFSET(lutLine->LineOffset));
  
  /* Check GFXMMU state */
  if(hgfxmmu->State != HAL_GFXMMU_STATE_READY)
  {
    status = HAL_ERROR;
  }
  else
  {
    uint32_t lutxl_address, lutxh_address;
    
    /* Initialize local variables */
    lutxl_address   = (uint32_t) &(hgfxmmu->Instance->LUT[2U * lutLine->LineNumber]);
    lutxh_address   = (uint32_t) &(hgfxmmu->Instance->LUT[(2U * lutLine->LineNumber) + 1U]);
    
    /* Configure LUT line */
    if(lutLine->LineStatus == GFXMMU_LUT_LINE_ENABLE)
    {
      /* Enable and configure LUT line */
      *((uint32_t *)lutxl_address) = (lutLine->LineStatus | 
                                     (lutLine->FirstVisibleBlock << GFXMMU_LUTXL_FVB_OFFSET) | 
                                     (lutLine->LastVisibleBlock << GFXMMU_LUTXL_LVB_OFFSET));
      *((uint32_t *)lutxh_address) = (uint32_t) lutLine->LineOffset;
    }
    else
    {
      /* Disable LUT line */
      *((uint32_t *)lutxl_address) = 0U;
      *((uint32_t *)lutxh_address) = 0U;
    }
  }
  /* Return function status */
  return status;
}

HAL_GFXMMU_DisableLutLines()

HAL_StatusTypeDef HAL_GFXMMU_DisableLutLines	(	GFXMMU_HandleTypeDef *	hgfxmmu,
		uint32_t	FirstLine,
		uint32_t	LinesNumber
	)

This function allows to disable a range of LUT lines.

Parameters

hgfxmmu	GFXMMU handle.
FirstLine	First line to disable on LUT. This parameter must be a number between Min_Data = 0 and Max_Data = 1023.
LinesNumber	Number of lines to disable on LUT. This parameter must be a number between Min_Data = 1 and Max_Data = 1024.

Return values

HAL

status.

Definition at line 528 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Check parameters */
  assert_param(IS_GFXMMU_ALL_INSTANCE(hgfxmmu->Instance));
  assert_param(IS_GFXMMU_LUT_LINE(FirstLine));
  assert_param(IS_GFXMMU_LUT_LINES_NUMBER(LinesNumber));
  
  /* Check GFXMMU state and coherent parameters */
  if((hgfxmmu->State != HAL_GFXMMU_STATE_READY) || ((FirstLine + LinesNumber) > 1024U))
  {
    status = HAL_ERROR;
  }
  else
  {
    uint32_t current_line, lutxl_address, lutxh_address;
    
    /* Initialize local variables */
    current_line    = 0U;
    lutxl_address   = (uint32_t) &(hgfxmmu->Instance->LUT[2U * FirstLine]);
    lutxh_address   = (uint32_t) &(hgfxmmu->Instance->LUT[(2U * FirstLine) + 1U]);
    
    /* Disable LUT lines */
    while(current_line < LinesNumber)
    {
      *((uint32_t *)lutxl_address) = 0U;
      *((uint32_t *)lutxh_address) = 0U;
      lutxl_address += 8U;
      lutxh_address += 8U;
      current_line++;
    }
  }
  /* Return function status */
  return status;
}

HAL_GFXMMU_ErrorCallback()

__weak void HAL_GFXMMU_ErrorCallback

(

GFXMMU_HandleTypeDef *

hgfxmmu

)

Error callback.

Parameters

hgfxmmu

GFXMMU handle.

Return values

None.

Definition at line 688 of file stm32l4xx_hal_gfxmmu.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hgfxmmu);
  
  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_GFXMMU_ErrorCallback could be implemented in the user file.
   */
}

HAL_GFXMMU_IRQHandler()

void HAL_GFXMMU_IRQHandler

(

GFXMMU_HandleTypeDef *

hgfxmmu

)

This function handles the GFXMMU interrupts.

Parameters

hgfxmmu

GFXMMU handle.

Return values

None.

Definition at line 657 of file stm32l4xx_hal_gfxmmu.c.

{
  uint32_t flags, interrupts, error;
  
  /* Read current flags and interrupts and determine which error occurs */
  flags = hgfxmmu->Instance->SR;
  interrupts = (hgfxmmu->Instance->CR & GFXMMU_CR_ITS_MASK);
  error = (flags & interrupts);
  
  if(error != 0U)
  {
    /* Clear flags on GFXMMU_FCR register */
    hgfxmmu->Instance->FCR = error;
    
    /* Update GFXMMU error code */
    hgfxmmu->ErrorCode |= error;
    
    /* Call GFXMMU error callback */
#if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
    hgfxmmu->ErrorCallback(hgfxmmu);
#else
    HAL_GFXMMU_ErrorCallback(hgfxmmu);
#endif
  }
}

HAL_GFXMMU_ModifyBuffers()

HAL_StatusTypeDef HAL_GFXMMU_ModifyBuffers	(	GFXMMU_HandleTypeDef *	hgfxmmu,
		GFXMMU_BuffersTypeDef *	Buffers
	)

This function allows to modify physical buffer addresses.

Parameters

hgfxmmu	GFXMMU handle.
Buffers	Buffers parameters.

Return values

HAL

status.

Definition at line 624 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Check parameters */
  assert_param(IS_GFXMMU_ALL_INSTANCE(hgfxmmu->Instance));
  assert_param(IS_GFXMMU_BUFFER_ADDRESS(Buffers->Buf0Address));
  assert_param(IS_GFXMMU_BUFFER_ADDRESS(Buffers->Buf1Address));
  assert_param(IS_GFXMMU_BUFFER_ADDRESS(Buffers->Buf2Address));
  assert_param(IS_GFXMMU_BUFFER_ADDRESS(Buffers->Buf3Address));
  
  /* Check GFXMMU state */
  if(hgfxmmu->State != HAL_GFXMMU_STATE_READY)
  {
    status = HAL_ERROR;
  }
  else
  {
    /* Modify physical buffer adresses on GFXMMU_BxCR registers */
    hgfxmmu->Instance->B0CR = Buffers->Buf0Address;
    hgfxmmu->Instance->B1CR = Buffers->Buf1Address;
    hgfxmmu->Instance->B2CR = Buffers->Buf2Address;
    hgfxmmu->Instance->B3CR = Buffers->Buf3Address;
  }
  /* Return function status */
  return status;
}