Peripheral Control functions

Peripheral Control functions. More...

Functions
HAL_StatusTypeDef	HAL_LTDC_ConfigLayer (LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC Layer according to the specified parameters in the LTDC_InitTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size. More...
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position. More...
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format. More...
HAL_StatusTypeDef	HAL_LTDC_SetAlpha (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value. More...
HAL_StatusTypeDef	HAL_LTDC_SetAddress (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address. More...
HAL_StatusTypeDef	HAL_LTDC_SetPitch (LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
	Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen. Example of a buffer 800x480 attached to layer for which we want to read and display on screen only a portion 320x240 taken in the center of the buffer. The pitch in pixels will be in that case 800 pixels and not 320 pixels as initially configured by previous call to HAL_LTDC_ConfigLayer(). More...
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying. More...
HAL_StatusTypeDef	HAL_LTDC_ConfigCLUT (LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx)
	Load the color lookup table. More...
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying. More...
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying. More...
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table. More...
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table. More...
HAL_StatusTypeDef	HAL_LTDC_ProgramLineEvent (LTDC_HandleTypeDef *hltdc, uint32_t Line)
	Define the position of the line interrupt. More...
HAL_StatusTypeDef	HAL_LTDC_EnableDither (LTDC_HandleTypeDef *hltdc)
	Enable Dither. More...
HAL_StatusTypeDef	HAL_LTDC_DisableDither (LTDC_HandleTypeDef *hltdc)
	Disable Dither. More...
HAL_StatusTypeDef	HAL_LTDC_Reload (LTDC_HandleTypeDef *hltdc, uint32_t ReloadType)
	Reload LTDC Layers configuration. More...
HAL_StatusTypeDef	HAL_LTDC_ConfigLayer_NoReload (LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC Layer according to the specified without reloading parameters in the LTDC_InitTypeDef and create the associated handle. Variant of the function HAL_LTDC_ConfigLayer without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size without reloading. Variant of the function HAL_LTDC_SetWindowSize without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position without reloading. Variant of the function HAL_LTDC_SetWindowPosition without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format without reloading. Variant of the function HAL_LTDC_SetPixelFormat without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_SetAlpha_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value without reloading. Variant of the function HAL_LTDC_SetAlpha without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_SetAddress_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address without reloading. Variant of the function HAL_LTDC_SetAddress without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_SetPitch_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
	Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen. Example of a buffer 800x480 attached to layer for which we want to read and display on screen only a portion 320x240 taken in the center of the buffer. The pitch in pixels will be in that case 800 pixels and not 320 pixels as initially configured by previous call to HAL_LTDC_ConfigLayer(). More...
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying without reloading. Variant of the function HAL_LTDC_ConfigColorKeying without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying without reloading. Variant of the function HAL_LTDC_EnableColorKeying without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying without reloading. Variant of the function HAL_LTDC_DisableColorKeying without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table without reloading. Variant of the function HAL_LTDC_EnableCLUT without immediate reload. More...
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table without reloading. Variant of the function HAL_LTDC_DisableCLUT without immediate reload. More...

Detailed Description

Peripheral Control functions.

 ===============================================================================
                    ##### Peripheral Control functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure the LTDC foreground or/and background parameters.
      (+) Set the active layer.
      (+) Configure the color keying.
      (+) Configure the C-LUT.
      (+) Enable / Disable the color keying.
      (+) Enable / Disable the C-LUT.
      (+) Update the layer position.
      (+) Update the layer size.
      (+) Update pixel format on the fly.
      (+) Update transparency on the fly.
      (+) Update address on the fly.

Function Documentation

HAL_LTDC_ConfigCLUT()

HAL_StatusTypeDef HAL_LTDC_ConfigCLUT	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t *	pCLUT,
		uint32_t	CLUTSize,
		uint32_t	LayerIdx
	)

Load the color lookup table.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
pCLUT	pointer to the color lookup table address.
CLUTSize	the color lookup table size.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 872 of file stm32l4xx_hal_ltdc.c.

{
  uint32_t tmp;
  uint32_t counter;
  uint32_t *pcolorlut = pCLUT;
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  for (counter = 0U; (counter < CLUTSize); counter++)
  {
    if (hltdc->LayerCfg[LayerIdx].PixelFormat == LTDC_PIXEL_FORMAT_AL44)
    {
      tmp  = (((counter + (16U*counter)) << 24U) | ((uint32_t)(*pcolorlut) & 0xFFU) | ((uint32_t)(*pcolorlut) & 0xFF00U) | ((uint32_t)(*pcolorlut) & 0xFF0000U));
    }
    else
    {
      tmp  = ((counter << 24U) | ((uint32_t)(*pcolorlut) & 0xFFU) | ((uint32_t)(*pcolorlut) & 0xFF00U) | ((uint32_t)(*pcolorlut) & 0xFF0000U));
    }

    pcolorlut++;

    /* Specifies the C-LUT address and RGB value */
    LTDC_LAYER(hltdc, LayerIdx)->CLUTWR  = tmp;
  }

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_ConfigColorKeying()

HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	RGBValue,
		uint32_t	LayerIdx
	)

Configure the color keying.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
RGBValue	the color key value
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 834 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Configure the default color values */
  LTDC_LAYER(hltdc, LayerIdx)->CKCR &=  ~(LTDC_LxCKCR_CKBLUE | LTDC_LxCKCR_CKGREEN | LTDC_LxCKCR_CKRED);
  LTDC_LAYER(hltdc, LayerIdx)->CKCR  = RGBValue;

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_ConfigColorKeying_NoReload()

HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	RGBValue,
		uint32_t	LayerIdx
	)

Configure the color keying without reloading. Variant of the function HAL_LTDC_ConfigColorKeying without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
RGBValue	the color key value
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1857 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Configure the default color values */
  LTDC_LAYER(hltdc, LayerIdx)->CKCR &=  ~(LTDC_LxCKCR_CKBLUE | LTDC_LxCKCR_CKGREEN | LTDC_LxCKCR_CKRED);
  LTDC_LAYER(hltdc, LayerIdx)->CKCR  = RGBValue;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_ConfigLayer()

HAL_StatusTypeDef HAL_LTDC_ConfigLayer	(	LTDC_HandleTypeDef *	hltdc,
		LTDC_LayerCfgTypeDef *	pLayerCfg,
		uint32_t	LayerIdx
	)

Configure the LTDC Layer according to the specified parameters in the LTDC_InitTypeDef and create the associated handle.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
pLayerCfg	pointer to a LTDC_LayerCfgTypeDef structure that contains the configuration information for the Layer.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 784 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));
  assert_param(IS_LTDC_HCONFIGST(pLayerCfg->WindowX0));
  assert_param(IS_LTDC_HCONFIGSP(pLayerCfg->WindowX1));
  assert_param(IS_LTDC_VCONFIGST(pLayerCfg->WindowY0));
  assert_param(IS_LTDC_VCONFIGSP(pLayerCfg->WindowY1));
  assert_param(IS_LTDC_PIXEL_FORMAT(pLayerCfg->PixelFormat));
  assert_param(IS_LTDC_ALPHA(pLayerCfg->Alpha));
  assert_param(IS_LTDC_ALPHA(pLayerCfg->Alpha0));
  assert_param(IS_LTDC_BLENDING_FACTOR1(pLayerCfg->BlendingFactor1));
  assert_param(IS_LTDC_BLENDING_FACTOR2(pLayerCfg->BlendingFactor2));
  assert_param(IS_LTDC_CFBLL(pLayerCfg->ImageWidth));
  assert_param(IS_LTDC_CFBLNBR(pLayerCfg->ImageHeight));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Copy new layer configuration into handle structure */
  hltdc->LayerCfg[LayerIdx] = *pLayerCfg;

  /* Configure the LTDC Layer */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_ConfigLayer_NoReload()

HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		LTDC_LayerCfgTypeDef *	pLayerCfg,
		uint32_t	LayerIdx
	)

Configure the LTDC Layer according to the specified without reloading parameters in the LTDC_InitTypeDef and create the associated handle. Variant of the function HAL_LTDC_ConfigLayer without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
pLayerCfg	pointer to a LTDC_LayerCfgTypeDef structure that contains the configuration information for the Layer.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1507 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));
  assert_param(IS_LTDC_HCONFIGST(pLayerCfg->WindowX0));
  assert_param(IS_LTDC_HCONFIGSP(pLayerCfg->WindowX1));
  assert_param(IS_LTDC_VCONFIGST(pLayerCfg->WindowY0));
  assert_param(IS_LTDC_VCONFIGSP(pLayerCfg->WindowY1));
  assert_param(IS_LTDC_PIXEL_FORMAT(pLayerCfg->PixelFormat));
  assert_param(IS_LTDC_ALPHA(pLayerCfg->Alpha));
  assert_param(IS_LTDC_ALPHA(pLayerCfg->Alpha0));
  assert_param(IS_LTDC_BLENDING_FACTOR1(pLayerCfg->BlendingFactor1));
  assert_param(IS_LTDC_BLENDING_FACTOR2(pLayerCfg->BlendingFactor2));
  assert_param(IS_LTDC_CFBLL(pLayerCfg->ImageWidth));
  assert_param(IS_LTDC_CFBLNBR(pLayerCfg->ImageHeight));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Copy new layer configuration into handle structure */
  hltdc->LayerCfg[LayerIdx] = *pLayerCfg;

  /* Configure the LTDC Layer */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_DisableCLUT()

HAL_StatusTypeDef HAL_LTDC_DisableCLUT	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color lookup table.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1026 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable LTDC color lookup table by setting CLUTEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR &= ~(uint32_t)LTDC_LxCR_CLUTEN;

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_DisableCLUT_NoReload()

HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color lookup table without reloading. Variant of the function HAL_LTDC_DisableCLUT without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1990 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable LTDC color lookup table by setting CLUTEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR &= ~(uint32_t)LTDC_LxCR_CLUTEN;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_DisableColorKeying()

HAL_StatusTypeDef HAL_LTDC_DisableColorKeying	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color keying.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 956 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable LTDC color keying by setting COLKEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR &= ~(uint32_t)LTDC_LxCR_COLKEN;

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_DisableColorKeying_NoReload()

HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color keying without reloading. Variant of the function HAL_LTDC_DisableColorKeying without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1924 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable LTDC color keying by setting COLKEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR &= ~(uint32_t)LTDC_LxCR_COLKEN;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_DisableDither()

HAL_StatusTypeDef HAL_LTDC_DisableDither

(

LTDC_HandleTypeDef *

hltdc

)

Disable Dither.

Parameters

hltdc

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

Return values

HAL

status

Definition at line 1086 of file stm32l4xx_hal_ltdc.c.

{
  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable Dither by setting DTEN bit */
  LTDC->GCR &= ~(uint32_t)LTDC_GCR_DEN;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_EnableCLUT()

HAL_StatusTypeDef HAL_LTDC_EnableCLUT	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color lookup table.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 991 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Enable LTDC color lookup table by setting CLUTEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR |= (uint32_t)LTDC_LxCR_CLUTEN;

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_EnableCLUT_NoReload()

HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color lookup table without reloading. Variant of the function HAL_LTDC_EnableCLUT without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1957 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable LTDC color lookup table by setting CLUTEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR |= (uint32_t)LTDC_LxCR_CLUTEN;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_EnableColorKeying()

HAL_StatusTypeDef HAL_LTDC_EnableColorKeying	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color keying.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 921 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Enable LTDC color keying by setting COLKEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR |= (uint32_t)LTDC_LxCR_COLKEN;

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_EnableColorKeying_NoReload()

HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color keying without reloading. Variant of the function HAL_LTDC_EnableColorKeying without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1891 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Enable LTDC color keying by setting COLKEN bit */
  LTDC_LAYER(hltdc, LayerIdx)->CR |= (uint32_t)LTDC_LxCR_COLKEN;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_EnableDither()

HAL_StatusTypeDef HAL_LTDC_EnableDither

(

LTDC_HandleTypeDef *

hltdc

)

Enable Dither.

Parameters

hltdc

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

Return values

HAL

status

Definition at line 1059 of file stm32l4xx_hal_ltdc.c.

{
  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Enable Dither by setting DTEN bit */
  LTDC->GCR |= (uint32_t)LTDC_GCR_DEN;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_ProgramLineEvent()

HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Line
	)

Define the position of the line interrupt.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Line	Line Interrupt Position.

Note

User application may resort to HAL_LTDC_LineEventCallback() at line interrupt generation.

Return values

HAL

status

Definition at line 1429 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_LIPOS(Line));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Disable the Line interrupt */
  __HAL_LTDC_DISABLE_IT(hltdc, LTDC_IT_LI);

  /* Set the Line Interrupt position */
  LTDC->LIPCR = (uint32_t)Line;

  /* Enable the Line interrupt */
  __HAL_LTDC_ENABLE_IT(hltdc, LTDC_IT_LI);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_Reload()

HAL_StatusTypeDef HAL_LTDC_Reload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	ReloadType
	)

Reload LTDC Layers configuration.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
ReloadType	This parameter can be one of the following values : LTDC_RELOAD_IMMEDIATE : Immediate Reload LTDC_RELOAD_VERTICAL_BLANKING : Reload in the next Vertical Blanking

Note

User application may resort to HAL_LTDC_ReloadEventCallback() at reload interrupt generation.

Return values

HAL

status

Definition at line 1468 of file stm32l4xx_hal_ltdc.c.

{
  /* Check the parameters */
  assert_param(IS_LTDC_RELOAD(ReloadType));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Enable the Reload interrupt */
  __HAL_LTDC_ENABLE_IT(hltdc, LTDC_IT_RR);

  /* Apply Reload type */
  hltdc->Instance->SRCR = ReloadType;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetAddress()

HAL_StatusTypeDef HAL_LTDC_SetAddress	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Address,
		uint32_t	LayerIdx
	)

Reconfigure the frame buffer Address.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Address	new address value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values

HAL

status

Definition at line 1313 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* Reconfigure the Address */
  pLayerCfg->FBStartAdress = Address;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetAddress_NoReload()

HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Address,
		uint32_t	LayerIdx
	)

Reconfigure the frame buffer Address without reloading. Variant of the function HAL_LTDC_SetAddress without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Address	new address value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values

HAL

status

Definition at line 1745 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* Reconfigure the Address */
  pLayerCfg->FBStartAdress = Address;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetAlpha()

HAL_StatusTypeDef HAL_LTDC_SetAlpha	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Alpha,
		uint32_t	LayerIdx
	)

Reconfigure the layer alpha value.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Alpha	new alpha value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1269 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_ALPHA(Alpha));
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* Reconfigure the Alpha value */
  pLayerCfg->Alpha = Alpha;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetAlpha_NoReload()

HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Alpha,
		uint32_t	LayerIdx
	)

Reconfigure the layer alpha value without reloading. Variant of the function HAL_LTDC_SetAlpha without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Alpha	new alpha value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1702 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_ALPHA(Alpha));
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* Reconfigure the Alpha value */
  pLayerCfg->Alpha = Alpha;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetPitch()

HAL_StatusTypeDef HAL_LTDC_SetPitch	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LinePitchInPixels,
		uint32_t	LayerIdx
	)

Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen. Example of a buffer 800x480 attached to layer for which we want to read and display on screen only a portion 320x240 taken in the center of the buffer. The pitch in pixels will be in that case 800 pixels and not 320 pixels as initially configured by previous call to HAL_LTDC_ConfigLayer().

Note

This function should be called only after a previous call to HAL_LTDC_ConfigLayer() to modify the default pitch configured by HAL_LTDC_ConfigLayer() when required (refer to example described just above).

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LinePitchInPixels	New line pitch in pixels to configure for LTDC layer 'LayerIdx'.
LayerIdx	LTDC layer index concerned by the modification of line pitch.

Return values

HAL

status

Definition at line 1360 of file stm32l4xx_hal_ltdc.c.

{
  uint32_t tmp;
  uint32_t pitchUpdate;
  uint32_t pixelFormat;

  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* get LayerIdx used pixel format */
  pixelFormat = hltdc->LayerCfg[LayerIdx].PixelFormat;

  if (pixelFormat == LTDC_PIXEL_FORMAT_ARGB8888)
  {
    tmp = 4U;
  }
  else if (pixelFormat == LTDC_PIXEL_FORMAT_RGB888)
  {
    tmp = 3U;
  }
  else if ((pixelFormat == LTDC_PIXEL_FORMAT_ARGB4444) || \
           (pixelFormat == LTDC_PIXEL_FORMAT_RGB565)   || \
           (pixelFormat == LTDC_PIXEL_FORMAT_ARGB1555) || \
           (pixelFormat == LTDC_PIXEL_FORMAT_AL88))
  {
    tmp = 2U;
  }
  else
  {
    tmp = 1U;
  }

  pitchUpdate = ((LinePitchInPixels * tmp) << 16U);

  /* Clear previously set standard pitch */
  LTDC_LAYER(hltdc, LayerIdx)->CFBLR &= ~LTDC_LxCFBLR_CFBP;

  /* Set the Reload type as immediate update of LTDC pitch configured above */
  LTDC->SRCR |= LTDC_SRCR_IMR;

  /* Set new line pitch value */
  LTDC_LAYER(hltdc, LayerIdx)->CFBLR |= pitchUpdate;

  /* Set the Reload type as immediate update of LTDC pitch configured above */
  LTDC->SRCR |= LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetPitch_NoReload()

HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LinePitchInPixels,
		uint32_t	LayerIdx
	)

Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen. Example of a buffer 800x480 attached to layer for which we want to read and display on screen only a portion 320x240 taken in the center of the buffer. The pitch in pixels will be in that case 800 pixels and not 320 pixels as initially configured by previous call to HAL_LTDC_ConfigLayer().

Note

This function should be called only after a previous call to HAL_LTDC_ConfigLayer() to modify the default pitch configured by HAL_LTDC_ConfigLayer() when required (refer to example described just above). Variant of the function HAL_LTDC_SetPitch without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LinePitchInPixels	New line pitch in pixels to configure for LTDC layer 'LayerIdx'.
LayerIdx	LTDC layer index concerned by the modification of line pitch.

Return values

HAL

status

Definition at line 1790 of file stm32l4xx_hal_ltdc.c.

{
  uint32_t tmp;
  uint32_t pitchUpdate;
  uint32_t pixelFormat;

  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* get LayerIdx used pixel format */
  pixelFormat = hltdc->LayerCfg[LayerIdx].PixelFormat;

  if (pixelFormat == LTDC_PIXEL_FORMAT_ARGB8888)
  {
    tmp = 4U;
  }
  else if (pixelFormat == LTDC_PIXEL_FORMAT_RGB888)
  {
    tmp = 3U;
  }
  else if ((pixelFormat == LTDC_PIXEL_FORMAT_ARGB4444) || \
           (pixelFormat == LTDC_PIXEL_FORMAT_RGB565)   || \
           (pixelFormat == LTDC_PIXEL_FORMAT_ARGB1555) || \
           (pixelFormat == LTDC_PIXEL_FORMAT_AL88))
  {
    tmp = 2U;
  }
  else
  {
    tmp = 1U;
  }

  pitchUpdate = ((LinePitchInPixels * tmp) << 16U);

  /* Clear previously set standard pitch */
  LTDC_LAYER(hltdc, LayerIdx)->CFBLR &= ~LTDC_LxCFBLR_CFBP;

  /* Set new line pitch value */
  LTDC_LAYER(hltdc, LayerIdx)->CFBLR |= pitchUpdate;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetPixelFormat()

HAL_StatusTypeDef HAL_LTDC_SetPixelFormat	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Pixelformat,
		uint32_t	LayerIdx
	)

Reconfigure the pixel format.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Pixelformat	new pixel format value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values

HAL

status

Definition at line 1224 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_PIXEL_FORMAT(Pixelformat));
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* Reconfigure the pixel format */
  pLayerCfg->PixelFormat = Pixelformat;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetPixelFormat_NoReload()

HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Pixelformat,
		uint32_t	LayerIdx
	)

Reconfigure the pixel format without reloading. Variant of the function HAL_LTDC_SetPixelFormat without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDfef structure that contains the configuration information for the LTDC.
Pixelformat	new pixel format value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values

HAL

status

Definition at line 1659 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_PIXEL_FORMAT(Pixelformat));
  assert_param(IS_LTDC_LAYER(LayerIdx));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* Reconfigure the pixel format */
  pLayerCfg->PixelFormat = Pixelformat;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetWindowPosition()

HAL_StatusTypeDef HAL_LTDC_SetWindowPosition	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	X0,
		uint32_t	Y0,
		uint32_t	LayerIdx
	)

Set the LTDC window position.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
X0	LTDC window X offset
Y0	LTDC window Y offset
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1173 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));
  assert_param(IS_LTDC_CFBLL(X0));
  assert_param(IS_LTDC_CFBLNBR(Y0));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* update horizontal start/stop */
  pLayerCfg->WindowX0 = X0;
  pLayerCfg->WindowX1 = X0 + pLayerCfg->ImageWidth;

  /* update vertical start/stop */
  pLayerCfg->WindowY0 = Y0;
  pLayerCfg->WindowY1 = Y0 + pLayerCfg->ImageHeight;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetWindowPosition_NoReload()

HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	X0,
		uint32_t	Y0,
		uint32_t	LayerIdx
	)

Set the LTDC window position without reloading. Variant of the function HAL_LTDC_SetWindowPosition without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
X0	LTDC window X offset
Y0	LTDC window Y offset
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1610 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters */
  assert_param(IS_LTDC_LAYER(LayerIdx));
  assert_param(IS_LTDC_CFBLL(X0));
  assert_param(IS_LTDC_CFBLNBR(Y0));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* update horizontal start/stop */
  pLayerCfg->WindowX0 = X0;
  pLayerCfg->WindowX1 = X0 + pLayerCfg->ImageWidth;

  /* update vertical start/stop */
  pLayerCfg->WindowY0 = Y0;
  pLayerCfg->WindowY1 = Y0 + pLayerCfg->ImageHeight;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetWindowSize()

HAL_StatusTypeDef HAL_LTDC_SetWindowSize	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	XSize,
		uint32_t	YSize,
		uint32_t	LayerIdx
	)

Set the LTDC window size.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
XSize	LTDC Pixel per line
YSize	LTDC Line number
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1117 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters (Layers parameters)*/
  assert_param(IS_LTDC_LAYER(LayerIdx));
  assert_param(IS_LTDC_CFBLL(XSize));
  assert_param(IS_LTDC_CFBLNBR(YSize));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* update horizontal stop */
  pLayerCfg->WindowX1 = XSize + pLayerCfg->WindowX0;

  /* update vertical stop */
  pLayerCfg->WindowY1 = YSize + pLayerCfg->WindowY0;

  /* Reconfigures the color frame buffer pitch in byte */
  pLayerCfg->ImageWidth = XSize;

  /* Reconfigures the frame buffer line number */
  pLayerCfg->ImageHeight = YSize;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

  /* Set the Immediate Reload type */
  hltdc->Instance->SRCR = LTDC_SRCR_IMR;

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}

HAL_LTDC_SetWindowSize_NoReload()

HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	XSize,
		uint32_t	YSize,
		uint32_t	LayerIdx
	)

Set the LTDC window size without reloading. Variant of the function HAL_LTDC_SetWindowSize without immediate reload.

Parameters

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
XSize	LTDC Pixel per line
YSize	LTDC Line number
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values

HAL

status

Definition at line 1556 of file stm32l4xx_hal_ltdc.c.

{
  LTDC_LayerCfgTypeDef *pLayerCfg;

  /* Check the parameters (Layers parameters)*/
  assert_param(IS_LTDC_LAYER(LayerIdx));
  assert_param(IS_LTDC_CFBLL(XSize));
  assert_param(IS_LTDC_CFBLNBR(YSize));

  /* Process locked */
  __HAL_LOCK(hltdc);

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

  /* Get layer configuration from handle structure */
  pLayerCfg = &hltdc->LayerCfg[LayerIdx];

  /* update horizontal stop */
  pLayerCfg->WindowX1 = XSize + pLayerCfg->WindowX0;

  /* update vertical stop */
  pLayerCfg->WindowY1 = YSize + pLayerCfg->WindowY0;

  /* Reconfigures the color frame buffer pitch in byte */
  pLayerCfg->ImageWidth = XSize;

  /* Reconfigures the frame buffer line number */
  pLayerCfg->ImageHeight = YSize;

  /* Set LTDC parameters */
  LTDC_SetConfig(hltdc, pLayerCfg, LayerIdx);

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

  /* Process unlocked */
  __HAL_UNLOCK(hltdc);

  return HAL_OK;
}