Initialization and Configuration functions

Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_LTDC_Init (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC according to the specified parameters in the LTDC_InitTypeDef. More...
HAL_StatusTypeDef	HAL_LTDC_DeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC peripheral. More...
void	HAL_LTDC_MspInit (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC MSP. More...
void	HAL_LTDC_MspDeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC MSP. More...
void	HAL_LTDC_ErrorCallback (LTDC_HandleTypeDef *hltdc)
	Error LTDC callback. More...
void	HAL_LTDC_LineEventCallback (LTDC_HandleTypeDef *hltdc)
	Line Event callback. More...
void	HAL_LTDC_ReloadEventCallback (LTDC_HandleTypeDef *hltdc)
	Reload Event callback. More...
HAL_StatusTypeDef	HAL_LTDC_RegisterCallback (LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID, pLTDC_CallbackTypeDef pCallback)
	Register a User LTDC Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_LTDC_UnRegisterCallback (LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID)
	Unregister an LTDC Callback LTDC callabck is redirected to the weak predefined callback. More...

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
                ##### Initialization and Configuration functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize and configure the LTDC
      (+) De-initialize the LTDC

Function Documentation

HAL_LTDC_DeInit()

HAL_StatusTypeDef HAL_LTDC_DeInit

(

LTDC_HandleTypeDef *

hltdc

)

De-initialize the LTDC peripheral.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

None

Definition at line 321 of file stm32l4xx_hal_ltdc.c.

{
#if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
  if (hltdc->MspDeInitCallback == NULL)
  {
    hltdc->MspDeInitCallback = HAL_LTDC_MspDeInit;
  }
  /* DeInit the low level hardware */
  hltdc->MspDeInitCallback(hltdc);
#else
  /* DeInit the low level hardware */
  HAL_LTDC_MspDeInit(hltdc);
#endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */

  /* Initialize the error code */
  hltdc->ErrorCode = HAL_LTDC_ERROR_NONE;

  /* Initialize the LTDC state*/
  hltdc->State = HAL_LTDC_STATE_RESET;

  /* Release Lock */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_ErrorCallback()

void HAL_LTDC_ErrorCallback

(

LTDC_HandleTypeDef *

hltdc

)

Error LTDC callback.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

None

Definition at line 702 of file stm32l4xx_hal_ltdc.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hltdc);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LTDC_ErrorCallback could be implemented in the user file
   */
}

HAL_LTDC_Init()

HAL_StatusTypeDef HAL_LTDC_Init

(

LTDC_HandleTypeDef *

hltdc

)

Initialize the LTDC according to the specified parameters in the LTDC_InitTypeDef.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

HAL

status

Definition at line 212 of file stm32l4xx_hal_ltdc.c.

{
  uint32_t tmp, tmp1;

  /* Check the LTDC peripheral state */
  if (hltdc == NULL)
  {
    return HAL_ERROR;
  }

  /* Check function parameters */
  assert_param(IS_LTDC_ALL_INSTANCE(hltdc->Instance));
  assert_param(IS_LTDC_HSYNC(hltdc->Init.HorizontalSync));
  assert_param(IS_LTDC_VSYNC(hltdc->Init.VerticalSync));
  assert_param(IS_LTDC_AHBP(hltdc->Init.AccumulatedHBP));
  assert_param(IS_LTDC_AVBP(hltdc->Init.AccumulatedVBP));
  assert_param(IS_LTDC_AAH(hltdc->Init.AccumulatedActiveH));
  assert_param(IS_LTDC_AAW(hltdc->Init.AccumulatedActiveW));
  assert_param(IS_LTDC_TOTALH(hltdc->Init.TotalHeigh));
  assert_param(IS_LTDC_TOTALW(hltdc->Init.TotalWidth));
  assert_param(IS_LTDC_HSPOL(hltdc->Init.HSPolarity));
  assert_param(IS_LTDC_VSPOL(hltdc->Init.VSPolarity));
  assert_param(IS_LTDC_DEPOL(hltdc->Init.DEPolarity));
  assert_param(IS_LTDC_PCPOL(hltdc->Init.PCPolarity));

#if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
  if (hltdc->State == HAL_LTDC_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hltdc->Lock = HAL_UNLOCKED;

    /* Reset the LTDC callback to the legacy weak callbacks */
    hltdc->LineEventCallback   = HAL_LTDC_LineEventCallback;    /* Legacy weak LineEventCallback    */
    hltdc->ReloadEventCallback = HAL_LTDC_ReloadEventCallback;  /* Legacy weak ReloadEventCallback  */
    hltdc->ErrorCallback       = HAL_LTDC_ErrorCallback;        /* Legacy weak ErrorCallback        */

    if (hltdc->MspInitCallback == NULL)
    {
      hltdc->MspInitCallback = HAL_LTDC_MspInit;
    }
    /* Init the low level hardware */
    hltdc->MspInitCallback(hltdc);
  }
#else
  if (hltdc->State == HAL_LTDC_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hltdc->Lock = HAL_UNLOCKED;
    /* Init the low level hardware */
    HAL_LTDC_MspInit(hltdc);
  }
#endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */

  /* Change LTDC peripheral state */
  hltdc->State = HAL_LTDC_STATE_BUSY;

  /* Configure the HS, VS, DE and PC polarity */
  hltdc->Instance->GCR &= ~(LTDC_GCR_HSPOL | LTDC_GCR_VSPOL | LTDC_GCR_DEPOL | LTDC_GCR_PCPOL);
  hltdc->Instance->GCR |= (uint32_t)(hltdc->Init.HSPolarity | hltdc->Init.VSPolarity | \
                                     hltdc->Init.DEPolarity | hltdc->Init.PCPolarity);

  /* Set Synchronization size */
  hltdc->Instance->SSCR &= ~(LTDC_SSCR_VSH | LTDC_SSCR_HSW);
  tmp = (hltdc->Init.HorizontalSync << 16U);
  hltdc->Instance->SSCR |= (tmp | hltdc->Init.VerticalSync);

  /* Set Accumulated Back porch */
  hltdc->Instance->BPCR &= ~(LTDC_BPCR_AVBP | LTDC_BPCR_AHBP);
  tmp = (hltdc->Init.AccumulatedHBP << 16U);
  hltdc->Instance->BPCR |= (tmp | hltdc->Init.AccumulatedVBP);

  /* Set Accumulated Active Width */
  hltdc->Instance->AWCR &= ~(LTDC_AWCR_AAH | LTDC_AWCR_AAW);
  tmp = (hltdc->Init.AccumulatedActiveW << 16U);
  hltdc->Instance->AWCR |= (tmp | hltdc->Init.AccumulatedActiveH);

  /* Set Total Width */
  hltdc->Instance->TWCR &= ~(LTDC_TWCR_TOTALH | LTDC_TWCR_TOTALW);
  tmp = (hltdc->Init.TotalWidth << 16U);
  hltdc->Instance->TWCR |= (tmp | hltdc->Init.TotalHeigh);

  /* Set the background color value */
  tmp = ((uint32_t)(hltdc->Init.Backcolor.Green) << 8U);
  tmp1 = ((uint32_t)(hltdc->Init.Backcolor.Red) << 16U);
  hltdc->Instance->BCCR &= ~(LTDC_BCCR_BCBLUE | LTDC_BCCR_BCGREEN | LTDC_BCCR_BCRED);
  hltdc->Instance->BCCR |= (tmp1 | tmp | hltdc->Init.Backcolor.Blue);

  /* Enable the Transfer Error and FIFO underrun interrupts */
  __HAL_LTDC_ENABLE_IT(hltdc, LTDC_IT_TE | LTDC_IT_FU);

  /* Enable LTDC by setting LTDCEN bit */
  __HAL_LTDC_ENABLE(hltdc);

  /* Initialize the error code */
  hltdc->ErrorCode = HAL_LTDC_ERROR_NONE;

  /* Initialize the LTDC state*/
  hltdc->State = HAL_LTDC_STATE_READY;

  return HAL_OK;
}

HAL_LTDC_LineEventCallback()

void HAL_LTDC_LineEventCallback

(

LTDC_HandleTypeDef *

hltdc

)

Line Event callback.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

None

Definition at line 718 of file stm32l4xx_hal_ltdc.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hltdc);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LTDC_LineEventCallback could be implemented in the user file
   */
}

HAL_LTDC_MspDeInit()

__weak void HAL_LTDC_MspDeInit

(

LTDC_HandleTypeDef *

hltdc

)

De-initialize the LTDC MSP.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

None

Definition at line 369 of file stm32l4xx_hal_ltdc.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hltdc);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LTDC_MspDeInit could be implemented in the user file
   */
}

HAL_LTDC_MspInit()

__weak void HAL_LTDC_MspInit

(

LTDC_HandleTypeDef *

hltdc

)

Initialize the LTDC MSP.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

None

Definition at line 353 of file stm32l4xx_hal_ltdc.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hltdc);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LTDC_MspInit could be implemented in the user file
   */
}

HAL_LTDC_RegisterCallback()

HAL_StatusTypeDef HAL_LTDC_RegisterCallback	(	LTDC_HandleTypeDef *	hltdc,
		HAL_LTDC_CallbackIDTypeDef	CallbackID,
		pLTDC_CallbackTypeDef	pCallback
	)

Register a User LTDC Callback To be used instead of the weak predefined callback.

Parameters

hltdc	ltdc handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_LTDC_LINE_EVENT_CB_ID Line Event Callback ID HAL_LTDC_RELOAD_EVENT_CB_ID Reload Event Callback ID HAL_LTDC_ERROR_CB_ID Error Callback ID HAL_LTDC_MSPINIT_CB_ID MspInit callback ID HAL_LTDC_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

status

Definition at line 394 of file stm32l4xx_hal_ltdc.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if (pCallback == NULL)
  {
    /* Update the error code */
    hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;

    return HAL_ERROR;
  }
  /* Process locked */
  __HAL_LOCK(hltdc);

  if (hltdc->State == HAL_LTDC_STATE_READY)
  {
    switch (CallbackID)
    {
      case HAL_LTDC_LINE_EVENT_CB_ID :
        hltdc->LineEventCallback = pCallback;
        break;

      case HAL_LTDC_RELOAD_EVENT_CB_ID :
        hltdc->ReloadEventCallback = pCallback;
        break;

      case HAL_LTDC_ERROR_CB_ID :
        hltdc->ErrorCallback = pCallback;
        break;

      case HAL_LTDC_MSPINIT_CB_ID :
        hltdc->MspInitCallback = pCallback;
        break;

      case HAL_LTDC_MSPDEINIT_CB_ID :
        hltdc->MspDeInitCallback = pCallback;
        break;

      default :
        /* Update the error code */
        hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else if (hltdc->State == HAL_LTDC_STATE_RESET)
  {
    switch (CallbackID)
    {
      case HAL_LTDC_MSPINIT_CB_ID :
        hltdc->MspInitCallback = pCallback;
        break;

      case HAL_LTDC_MSPDEINIT_CB_ID :
        hltdc->MspDeInitCallback = pCallback;
        break;

      default :
        /* Update the error code */
        hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else
  {
    /* Update the error code */
    hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hltdc);

  return status;
}

HAL_LTDC_ReloadEventCallback()

void HAL_LTDC_ReloadEventCallback

(

LTDC_HandleTypeDef *

hltdc

)

Reload Event callback.

Parameters

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values

None

Definition at line 734 of file stm32l4xx_hal_ltdc.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hltdc);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LTDC_ReloadEvenCallback could be implemented in the user file
   */
}

HAL_LTDC_UnRegisterCallback()

HAL_StatusTypeDef HAL_LTDC_UnRegisterCallback	(	LTDC_HandleTypeDef *	hltdc,
		HAL_LTDC_CallbackIDTypeDef	CallbackID
	)

Unregister an LTDC Callback LTDC callabck is redirected to the weak predefined callback.

Parameters

hltdc	ltdc handle
CallbackID	ID of the callback to be unregistered This parameter can be one of the following values: HAL_LTDC_LINE_EVENT_CB_ID Line Event Callback ID HAL_LTDC_RELOAD_EVENT_CB_ID Reload Event Callback ID HAL_LTDC_ERROR_CB_ID Error Callback ID HAL_LTDC_MSPINIT_CB_ID MspInit callback ID HAL_LTDC_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

status

Definition at line 487 of file stm32l4xx_hal_ltdc.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hltdc);

  if (hltdc->State == HAL_LTDC_STATE_READY)
  {
    switch (CallbackID)
    {
      case HAL_LTDC_LINE_EVENT_CB_ID :
        hltdc->LineEventCallback = HAL_LTDC_LineEventCallback;      /* Legacy weak LineEventCallback    */
        break;

      case HAL_LTDC_RELOAD_EVENT_CB_ID :
        hltdc->ReloadEventCallback = HAL_LTDC_ReloadEventCallback;  /* Legacy weak ReloadEventCallback  */
        break;

      case HAL_LTDC_ERROR_CB_ID :
        hltdc->ErrorCallback       = HAL_LTDC_ErrorCallback;        /* Legacy weak ErrorCallback        */
        break;

      case HAL_LTDC_MSPINIT_CB_ID :
        hltdc->MspInitCallback = HAL_LTDC_MspInit;                  /* Legcay weak MspInit Callback     */
        break;

      case HAL_LTDC_MSPDEINIT_CB_ID :
        hltdc->MspDeInitCallback = HAL_LTDC_MspDeInit;              /* Legcay weak MspDeInit Callback     */
        break;

      default :
        /* Update the error code */
        hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else if (hltdc->State == HAL_LTDC_STATE_RESET)
  {
    switch (CallbackID)
    {
      case HAL_LTDC_MSPINIT_CB_ID :
        hltdc->MspInitCallback = HAL_LTDC_MspInit;                  /* Legcay weak MspInit Callback     */
        break;

      case HAL_LTDC_MSPDEINIT_CB_ID :
        hltdc->MspDeInitCallback = HAL_LTDC_MspDeInit;              /* Legcay weak MspDeInit Callback     */
        break;

      default :
        /* Update the error code */
        hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else
  {
    /* Update the error code */
    hltdc->ErrorCode |= HAL_LTDC_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hltdc);

  return status;
}