Initialization and de-initialization functions

Initialization and de-initialization functions. More...

Functions
HAL_StatusTypeDef	HAL_GFXMMU_Init (GFXMMU_HandleTypeDef *hgfxmmu)
	Initialize the GFXMMU according to the specified parameters in the GFXMMU_InitTypeDef structure and initialize the associated handle. More...
HAL_StatusTypeDef	HAL_GFXMMU_DeInit (GFXMMU_HandleTypeDef *hgfxmmu)
	De-initialize the GFXMMU. More...
void	HAL_GFXMMU_MspInit (GFXMMU_HandleTypeDef *hgfxmmu)
	Initialize the GFXMMU MSP. More...
void	HAL_GFXMMU_MspDeInit (GFXMMU_HandleTypeDef *hgfxmmu)
	De-initialize the GFXMMU MSP. More...
HAL_StatusTypeDef	HAL_GFXMMU_RegisterCallback (GFXMMU_HandleTypeDef *hgfxmmu, HAL_GFXMMU_CallbackIDTypeDef CallbackID, pGFXMMU_CallbackTypeDef pCallback)
	Register a user GFXMMU callback to be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_GFXMMU_UnRegisterCallback (GFXMMU_HandleTypeDef *hgfxmmu, HAL_GFXMMU_CallbackIDTypeDef CallbackID)
	Unregister a user GFXMMU callback. GFXMMU callback is redirected to the weak predefined callback. More...

Detailed Description

Initialization and de-initialization functions.

  ==============================================================================
          ##### Initialization and de-initialization functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize the GFXMMU.
      (+) De-initialize the GFXMMU.

Function Documentation

HAL_GFXMMU_DeInit()

HAL_StatusTypeDef HAL_GFXMMU_DeInit

(

GFXMMU_HandleTypeDef *

hgfxmmu

)

De-initialize the GFXMMU.

Parameters

hgfxmmu

GFXMMU handle.

Return values

HAL

status.

Definition at line 237 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Check GFXMMU handle */
  if(hgfxmmu == NULL)
  {
    status = HAL_ERROR;
  }
  else
  {
    /* Check parameters */
    assert_param(IS_GFXMMU_ALL_INSTANCE(hgfxmmu->Instance));
    
    /* Disable all interrupts on GFXMMU_CR register */
    hgfxmmu->Instance->CR &= ~(GFXMMU_CR_B0OIE | GFXMMU_CR_B1OIE | GFXMMU_CR_B2OIE | GFXMMU_CR_B3OIE |
                               GFXMMU_CR_AMEIE);
    
    /* Call GFXMMU MSP de-init function */
#if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
    if(hgfxmmu->MspDeInitCallback == NULL)
    {
      hgfxmmu->MspDeInitCallback = HAL_GFXMMU_MspDeInit;
    }
    hgfxmmu->MspDeInitCallback(hgfxmmu);
#else
    HAL_GFXMMU_MspDeInit(hgfxmmu);
#endif
    
    /* Set GFXMMU to reset state */
    hgfxmmu->State = HAL_GFXMMU_STATE_RESET;
  }
  /* Return function status */
  return status;
}

HAL_GFXMMU_Init()

HAL_StatusTypeDef HAL_GFXMMU_Init

(

GFXMMU_HandleTypeDef *

hgfxmmu

)

Initialize the GFXMMU according to the specified parameters in the GFXMMU_InitTypeDef structure and initialize the associated handle.

Parameters

hgfxmmu

GFXMMU handle.

Return values

HAL

status.

Definition at line 168 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Check GFXMMU handle */
  if(hgfxmmu == NULL)
  {
    status = HAL_ERROR;
  }
  else
  {
    /* Check parameters */
    assert_param(IS_GFXMMU_ALL_INSTANCE(hgfxmmu->Instance));
    assert_param(IS_GFXMMU_BLOCKS_PER_LINE(hgfxmmu->Init.BlocksPerLine));
    assert_param(IS_GFXMMU_BUFFER_ADDRESS(hgfxmmu->Init.Buffers.Buf0Address));
    assert_param(IS_GFXMMU_BUFFER_ADDRESS(hgfxmmu->Init.Buffers.Buf1Address));
    assert_param(IS_GFXMMU_BUFFER_ADDRESS(hgfxmmu->Init.Buffers.Buf2Address));
    assert_param(IS_GFXMMU_BUFFER_ADDRESS(hgfxmmu->Init.Buffers.Buf3Address));
    assert_param(IS_FUNCTIONAL_STATE(hgfxmmu->Init.Interrupts.Activation));
    
#if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
    /* Reset callback pointers to the weak predefined callbacks */
    hgfxmmu->ErrorCallback = HAL_GFXMMU_ErrorCallback;

    /* Call GFXMMU MSP init function */
    if(hgfxmmu->MspInitCallback == NULL)
    {
      hgfxmmu->MspInitCallback = HAL_GFXMMU_MspInit;
    }
    hgfxmmu->MspInitCallback(hgfxmmu);
#else
    /* Call GFXMMU MSP init function */
    HAL_GFXMMU_MspInit(hgfxmmu);
#endif
    
    /* Configure blocks per line and interrupts parameters on GFXMMU_CR register */
    hgfxmmu->Instance->CR &= ~(GFXMMU_CR_B0OIE | GFXMMU_CR_B1OIE | GFXMMU_CR_B2OIE | GFXMMU_CR_B3OIE |
                               GFXMMU_CR_AMEIE | GFXMMU_CR_192BM);
    hgfxmmu->Instance->CR |= (hgfxmmu->Init.BlocksPerLine);
    if(hgfxmmu->Init.Interrupts.Activation == ENABLE)
    {
      assert_param(IS_GFXMMU_INTERRUPTS(hgfxmmu->Init.Interrupts.UsedInterrupts));
      hgfxmmu->Instance->CR |= hgfxmmu->Init.Interrupts.UsedInterrupts;
    }
    
    /* Configure default value on GFXMMU_DVR register */
    hgfxmmu->Instance->DVR = hgfxmmu->Init.DefaultValue;
    
    /* Configure physical buffer adresses on GFXMMU_BxCR registers */
    hgfxmmu->Instance->B0CR = hgfxmmu->Init.Buffers.Buf0Address;
    hgfxmmu->Instance->B1CR = hgfxmmu->Init.Buffers.Buf1Address;
    hgfxmmu->Instance->B2CR = hgfxmmu->Init.Buffers.Buf2Address;
    hgfxmmu->Instance->B3CR = hgfxmmu->Init.Buffers.Buf3Address;
    
    /* Reset GFXMMU error code */
    hgfxmmu->ErrorCode = GFXMMU_ERROR_NONE;
    
    /* Set GFXMMU to ready state */
    hgfxmmu->State = HAL_GFXMMU_STATE_READY;
  }
  /* Return function status */
  return status;
}

HAL_GFXMMU_MspDeInit()

__weak void HAL_GFXMMU_MspDeInit

(

GFXMMU_HandleTypeDef *

hgfxmmu

)

De-initialize the GFXMMU MSP.

Parameters

hgfxmmu

GFXMMU handle.

Return values

None.

Definition at line 293 of file stm32l4xx_hal_gfxmmu.c.

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

HAL_GFXMMU_MspInit()

__weak void HAL_GFXMMU_MspInit

(

GFXMMU_HandleTypeDef *

hgfxmmu

)

Initialize the GFXMMU MSP.

Parameters

hgfxmmu

GFXMMU handle.

Return values

None.

Definition at line 278 of file stm32l4xx_hal_gfxmmu.c.

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

HAL_GFXMMU_RegisterCallback()

HAL_StatusTypeDef HAL_GFXMMU_RegisterCallback	(	GFXMMU_HandleTypeDef *	hgfxmmu,
		HAL_GFXMMU_CallbackIDTypeDef	CallbackID,
		pGFXMMU_CallbackTypeDef	pCallback
	)

Register a user GFXMMU callback to be used instead of the weak predefined callback.

Parameters

hgfxmmu	GFXMMU handle.
CallbackID	ID of the callback to be registered. This parameter can be one of the following values: HAL_GFXMMU_ERROR_CB_ID error callback ID. HAL_GFXMMU_MSPINIT_CB_ID MSP init callback ID. HAL_GFXMMU_MSPDEINIT_CB_ID MSP de-init callback ID.
pCallback	pointer to the callback function.

Return values

HAL

status.

Definition at line 316 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if(pCallback == NULL)
  {
    /* update the error code */
    hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
    /* update return status */
    status = HAL_ERROR;
  }
  else
  {
    if(HAL_GFXMMU_STATE_READY == hgfxmmu->State)
    {
      switch (CallbackID)
      {
      case HAL_GFXMMU_ERROR_CB_ID :
        hgfxmmu->ErrorCallback = pCallback;
        break;
      case HAL_GFXMMU_MSPINIT_CB_ID :
        hgfxmmu->MspInitCallback = pCallback;
        break;
      case HAL_GFXMMU_MSPDEINIT_CB_ID :
        hgfxmmu->MspDeInitCallback = pCallback;
        break;
      default :
        /* update the error code */
        hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
        /* update return status */
        status = HAL_ERROR;
        break;
      }
    }
    else if(HAL_GFXMMU_STATE_RESET == hgfxmmu->State)
    {
      switch (CallbackID)
      {
      case HAL_GFXMMU_MSPINIT_CB_ID :
        hgfxmmu->MspInitCallback = pCallback;
        break;
      case HAL_GFXMMU_MSPDEINIT_CB_ID :
        hgfxmmu->MspDeInitCallback = pCallback;
        break;
      default :
        /* update the error code */
        hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
        /* update return status */
        status = HAL_ERROR;
        break;
      }
    }
    else
    {
      /* update the error code */
      hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
      /* update return status */
      status = HAL_ERROR;
    }
  }
  return status;
}

HAL_GFXMMU_UnRegisterCallback()

HAL_StatusTypeDef HAL_GFXMMU_UnRegisterCallback	(	GFXMMU_HandleTypeDef *	hgfxmmu,
		HAL_GFXMMU_CallbackIDTypeDef	CallbackID
	)

Unregister a user GFXMMU callback. GFXMMU callback is redirected to the weak predefined callback.

Parameters

hgfxmmu	GFXMMU handle.
CallbackID	ID of the callback to be unregistered. This parameter can be one of the following values: HAL_GFXMMU_ERROR_CB_ID error callback ID. HAL_GFXMMU_MSPINIT_CB_ID MSP init callback ID. HAL_GFXMMU_MSPDEINIT_CB_ID MSP de-init callback ID.

Return values

HAL

status.

Definition at line 392 of file stm32l4xx_hal_gfxmmu.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if(HAL_GFXMMU_STATE_READY == hgfxmmu->State)
  {
    switch (CallbackID)
    {
    case HAL_GFXMMU_ERROR_CB_ID :
      hgfxmmu->ErrorCallback = HAL_GFXMMU_ErrorCallback;
      break;
    case HAL_GFXMMU_MSPINIT_CB_ID :
      hgfxmmu->MspInitCallback = HAL_GFXMMU_MspInit;
      break;
    case HAL_GFXMMU_MSPDEINIT_CB_ID :
      hgfxmmu->MspDeInitCallback = HAL_GFXMMU_MspDeInit;
      break;
    default :
      /* update the error code */
      hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
      /* update return status */
      status = HAL_ERROR;
      break;
    }
  }
  else if(HAL_GFXMMU_STATE_RESET == hgfxmmu->State)
  {
    switch (CallbackID)
    {
    case HAL_GFXMMU_MSPINIT_CB_ID :
      hgfxmmu->MspInitCallback = HAL_GFXMMU_MspInit;
      break;
    case HAL_GFXMMU_MSPDEINIT_CB_ID :
      hgfxmmu->MspDeInitCallback = HAL_GFXMMU_MspDeInit;
      break;
    default :
      /* update the error code */
      hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
      /* update return status */
      status = HAL_ERROR;
      break;
    }
  }
  else
  {
    /* update the error code */
    hgfxmmu->ErrorCode |= GFXMMU_ERROR_INVALID_CALLBACK;
    /* update return status */
    status = HAL_ERROR;
  }
  return status;
}