UM1725
Return values
LayerIdx: LTDC layer index concerned by the modification of line pitch.
HAL status
38.3.30 HAL_LTDC_ProgramLineEvent
Function Name
HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent
(LTDC_HandleTypeDef * hltdc, uint32_t Line)
Function Description Define the position of the line interrupt .
Parameters
Return values
hltdc: pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Line: Line Interrupt Position.
HAL status
38.3.31 HAL_LTDC_GetState
Function Name
HAL_LTDC_StateTypeDef HAL_LTDC_GetState
(LTDC_HandleTypeDef * hltdc)
Function Description Return the LTDC state.
Parameters
hltdc: pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Return values
HAL state
38.3.32 HAL_LTDC_GetError
Function Name
uint32_t HAL_LTDC_GetError (LTDC_HandleTypeDef * hltdc)
Function Description Return the LTDC error code.
Parameters
Return values
hltdc: : pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LTDC Error Code
38.4 LTDC Firmware driver defines
38.4.1 LTDC
LTDC Alpha
LTDC_ALPHA
LTDC BACK COLOR
LTDC Cte Alpha mask
LTDC_COLOR Color mask
LTDC Blending Factor1
LTDC_BLENDING_FACTOR1_CA Blending factor : Cte Alpha
LTDC_BLENDING_FACTOR1_PAxCA Blending factor : Cte Alpha x Pixel Alpha
LTDC Blending Factor2
LTDC_BLENDING_FACTOR2_CA Blending factor : Cte Alpha
DOCID025834 Rev 3 533/963
534/963
LTDC_BLENDING_FACTOR2_PAxCA Blending factor : Cte Alpha x Pixel Alpha
UM1725
LTDC DE POLARITY
LTDC_DEPOLARITY_AL Data Enable, is active low.
LTDC_DEPOLARITY_AH Data Enable, is active high.
LTDC Error Code
HAL_LTDC_ERROR_NONE
HAL_LTDC_ERROR_TE
LTDC No error
LTDC Transfer error
HAL_LTDC_ERROR_FU LTDC FIFO Underrun
HAL_LTDC_ERROR_TIMEOUT LTDC Timeout error
LTDC Exported Macros
__HAL_LTDC_RESET_HANDLE_STATE Description:
Reset LTDC handle state.
Parameters:
__HANDLE__: specifies the LTDC handle.
Return value:
None
__HAL_LTDC_ENABLE
__HAL_LTDC_DISABLE
__HAL_LTDC_LAYER_ENABLE
Description:
Enable the LTDC.
Parameters:
__HANDLE__: LTDC handle
Return value:
None.
Description:
Disable the LTDC.
Parameters:
__HANDLE__: LTDC handle
Return value:
None.
Description:
Enable the LTDC Layer.
Parameters:
__HANDLE__: LTDC handle
__LAYER__: Specify the layer to be enabled This parameter can be 0 or 1
Return value:
None.
DOCID025834 Rev 3
UM1725
__HAL_LTDC_LAYER_DISABLE
__HAL_LTDC_RELOAD_CONFIG
__HAL_LTDC_GET_FLAG
__HAL_LTDC_CLEAR_FLAG
Description:
Disable the LTDC Layer.
Parameters:
__HANDLE__: LTDC handle
__LAYER__: Specify the layer to be disabled This parameter can be 0 or 1
Return value:
None.
Description:
Reload Layer Configuration.
Parameters:
__HANDLE__: LTDC handle
Return value:
None.
Description:
Get the LTDC pending flags.
Parameters:
__HANDLE__: LTDC handle
__FLAG__: Get the specified flag. This parameter can be any combination of the following values:
LTDC_FLAG_LI: Line Interrupt flag
LTDC_FLAG_FU: FIFO Underrun
Interrupt flag
LTDC_FLAG_TE: Transfer Error interrupt flag
LTDC_FLAG_RR: Register Reload
Interrupt Flag
Return value:
The: state of FLAG (SET or RESET).
Description:
Clears the LTDC pending flags.
Parameters:
__HANDLE__: LTDC handle
__FLAG__: specifies the flag to clear.
This parameter can be any combination of the following values:
LTDC_FLAG_LI: Line Interrupt flag
LTDC_FLAG_FU: FIFO Underrun
Interrupt flag
LTDC_FLAG_TE: Transfer Error interrupt flag
LTDC_FLAG_RR: Register Reload
DOCID025834 Rev 3 535/963
536/963
__HAL_LTDC_ENABLE_IT
__HAL_LTDC_DISABLE_IT
__HAL_LTDC_GET_IT_SOURCE
UM1725
Interrupt Flag
Return value:
None
Description:
Enables the specified LTDC interrupts.
Parameters:
__HANDLE__: LTDC handle
__INTERRUPT__: specifies the LTDC interrupt sources to be enabled. This parameter can be any combination of the following values:
LTDC_IT_LI: Line Interrupt flag
LTDC_IT_FU: FIFO Underrun
Interrupt flag
LTDC_IT_TE: Transfer Error interrupt flag
LTDC_IT_RR: Register Reload
Interrupt Flag
Return value:
None
Description:
Disables the specified LTDC interrupts.
Parameters:
__HANDLE__: LTDC handle
__INTERRUPT__: specifies the LTDC interrupt sources to be disabled. This parameter can be any combination of the following values:
LTDC_IT_LI: Line Interrupt flag
LTDC_IT_FU: FIFO Underrun
Interrupt flag
LTDC_IT_TE: Transfer Error interrupt flag
LTDC_IT_RR: Register Reload
Interrupt Flag
Return value:
None
Description:
Checks whether the specified LTDC interrupt has occurred or not.
Parameters:
__HANDLE__: LTDC handle
__INTERRUPT__: specifies the LTDC interrupt source to check. This parameter can be one of the following values:
DOCID025834 Rev 3
UM1725
LTDC_IT_LI: Line Interrupt flag
LTDC_IT_FU: FIFO Underrun
Interrupt flag
LTDC_IT_TE: Transfer Error interrupt flag
LTDC_IT_RR: Register Reload
Interrupt Flag
Return value:
The: state of INTERRUPT (SET or
RESET).
LTDC Exported Types
MAX_LAYER
LTDC Flag
LTDC_FLAG_LI
LTDC_FLAG_FU
LTDC_FLAG_TE
LTDC_FLAG_RR
LTDC HS POLARITY
LTDC_HSPOLARITY_AL Horizontal Synchronization is active low.
LTDC_HSPOLARITY_AH Horizontal Synchronization is active high.
LTDC Interrupts
LTDC_IT_LI
LTDC_IT_FU
LTDC_IT_TE
LTDC_IT_RR
LTDC LAYER Config
LTDC_STOPPOSITION
LTDC_STARTPOSITION
LTDC Layer stop position
LTDC Layer start position
LTDC_COLOR_FRAME_BUFFER LTDC Layer Line length
LTDC_LINE_NUMBER
LTDC PC POLARITY
LTDC Layer Line number
LTDC_PCPOLARITY_IPC input pixel clock.
LTDC_PCPOLARITY_IIPC inverted input pixel clock.
LTDC Pixel format
LTDC_PIXEL_FORMAT_ARGB8888 ARGB8888 LTDC pixel format
LTDC_PIXEL_FORMAT_RGB888 RGB888 LTDC pixel format
LTDC_PIXEL_FORMAT_RGB565 RGB565 LTDC pixel format
LTDC_PIXEL_FORMAT_ARGB1555 ARGB1555 LTDC pixel format
LTDC_PIXEL_FORMAT_ARGB4444 ARGB4444 LTDC pixel format
DOCID025834 Rev 3 537/963
538/963
LTDC_PIXEL_FORMAT_L8
LTDC_PIXEL_FORMAT_AL44
LTDC_PIXEL_FORMAT_AL88
LTDC Private Macros
LTDC_LAYER
IS_LTDC_LAYER
IS_LTDC_HSPOL
IS_LTDC_VSPOL
IS_LTDC_DEPOL
IS_LTDC_PCPOL
IS_LTDC_HSYNC
IS_LTDC_VSYNC
IS_LTDC_AHBP
IS_LTDC_AVBP
IS_LTDC_AAW
IS_LTDC_AAH
IS_LTDC_TOTALW
IS_LTDC_TOTALH
IS_LTDC_BLUEVALUE
IS_LTDC_REDVALUE
IS_LTDC_GREENVALUE
IS_LTDC_BLENDING_FACTOR1
IS_LTDC_BLENDING_FACTOR2
IS_LTDC_PIXEL_FORMAT
IS_LTDC_ALPHA
IS_LTDC_HCONFIGST
IS_LTDC_HCONFIGSP
IS_LTDC_VCONFIGST
IS_LTDC_VCONFIGSP
IS_LTDC_CFBP
IS_LTDC_CFBLL
IS_LTDC_CFBLNBR
IS_LTDC_LIPOS
L8 LTDC pixel format
AL44 LTDC pixel format
AL88 LTDC pixel format
LTDC SYNC
LTDC_HORIZONTALSYNC Horizontal synchronization width.
LTDC_VERTICALSYNC Vertical synchronization height.
LTDC VS POLARITY
DOCID025834 Rev 3
UM1725
UM1725
LTDC_VSPOLARITY_AL Vertical Synchronization is active low.
LTDC_VSPOLARITY_AH Vertical Synchronization is active high.
DOCID025834 Rev 3 539/963
