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.
HAL_StatusTypeDef	HAL_LTDC_DeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC peripheral.
__weak void	HAL_LTDC_MspInit (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC MSP.
__weak void	HAL_LTDC_MspDeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC MSP.
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.
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.
void	HAL_LTDC_ErrorCallback (LTDC_HandleTypeDef *hltdc)
	Error LTDC callback.
void	HAL_LTDC_LineEventCallback (LTDC_HandleTypeDef *hltdc)
	Line Event callback.
void	HAL_LTDC_ReloadEventCallback (LTDC_HandleTypeDef *hltdc)
	Reload Event callback.

---

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_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 stm32f4xx_hal_ltdc.c.

References __LTDC_HandleTypeDef::ErrorCode, HAL_LTDC_ERROR_NONE, HAL_LTDC_MspDeInit(), HAL_LTDC_STATE_RESET, __LTDC_HandleTypeDef::MspDeInitCallback, and __LTDC_HandleTypeDef::State.

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 stm32f4xx_hal_ltdc.c.

Referenced by HAL_LTDC_Init(), HAL_LTDC_IRQHandler(), and HAL_LTDC_UnRegisterCallback().

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 stm32f4xx_hal_ltdc.c.

References __HAL_LTDC_ENABLE, __HAL_LTDC_ENABLE_IT, LTDC_InitTypeDef::AccumulatedActiveH, LTDC_InitTypeDef::AccumulatedActiveW, LTDC_InitTypeDef::AccumulatedHBP, LTDC_InitTypeDef::AccumulatedVBP, assert_param, LTDC_InitTypeDef::Backcolor, LTDC_ColorTypeDef::Blue, LTDC_InitTypeDef::DEPolarity, __LTDC_HandleTypeDef::ErrorCallback, __LTDC_HandleTypeDef::ErrorCode, LTDC_ColorTypeDef::Green, HAL_LTDC_ERROR_NONE, HAL_LTDC_ErrorCallback(), HAL_LTDC_LineEventCallback(), HAL_LTDC_MspInit(), HAL_LTDC_ReloadEventCallback(), HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, HAL_LTDC_STATE_RESET, LTDC_InitTypeDef::HorizontalSync, LTDC_InitTypeDef::HSPolarity, __LTDC_HandleTypeDef::Init, __LTDC_HandleTypeDef::Instance, IS_LTDC_AAH, IS_LTDC_AAW, IS_LTDC_AHBP, IS_LTDC_AVBP, IS_LTDC_DEPOL, IS_LTDC_HSPOL, IS_LTDC_HSYNC, IS_LTDC_PCPOL, IS_LTDC_TOTALH, IS_LTDC_TOTALW, IS_LTDC_VSPOL, IS_LTDC_VSYNC, __LTDC_HandleTypeDef::LineEventCallback, __LTDC_HandleTypeDef::Lock, LTDC_IT_FU, LTDC_IT_TE, __LTDC_HandleTypeDef::MspInitCallback, LTDC_InitTypeDef::PCPolarity, LTDC_ColorTypeDef::Red, __LTDC_HandleTypeDef::ReloadEventCallback, __LTDC_HandleTypeDef::State, LTDC_InitTypeDef::TotalHeigh, LTDC_InitTypeDef::TotalWidth, LTDC_InitTypeDef::VerticalSync, and LTDC_InitTypeDef::VSPolarity.

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 stm32f4xx_hal_ltdc.c.

Referenced by HAL_LTDC_Init(), HAL_LTDC_IRQHandler(), and HAL_LTDC_UnRegisterCallback().

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 stm32f4xx_hal_ltdc.c.

Referenced by HAL_LTDC_DeInit(), and HAL_LTDC_UnRegisterCallback().

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 stm32f4xx_hal_ltdc.c.

Referenced by HAL_LTDC_Init(), and HAL_LTDC_UnRegisterCallback().

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 stm32f4xx_hal_ltdc.c.

References __LTDC_HandleTypeDef::ErrorCallback, __LTDC_HandleTypeDef::ErrorCode, HAL_LTDC_ERROR_CB_ID, HAL_LTDC_ERROR_INVALID_CALLBACK, HAL_LTDC_LINE_EVENT_CB_ID, HAL_LTDC_MSPDEINIT_CB_ID, HAL_LTDC_MSPINIT_CB_ID, HAL_LTDC_RELOAD_EVENT_CB_ID, HAL_LTDC_STATE_READY, HAL_LTDC_STATE_RESET, __LTDC_HandleTypeDef::LineEventCallback, __LTDC_HandleTypeDef::MspDeInitCallback, __LTDC_HandleTypeDef::MspInitCallback, __LTDC_HandleTypeDef::ReloadEventCallback, and __LTDC_HandleTypeDef::State.

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 stm32f4xx_hal_ltdc.c.

Referenced by HAL_LTDC_Init(), HAL_LTDC_IRQHandler(), and 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 stm32f4xx_hal_ltdc.c.

References __LTDC_HandleTypeDef::ErrorCallback, __LTDC_HandleTypeDef::ErrorCode, HAL_LTDC_ERROR_CB_ID, HAL_LTDC_ERROR_INVALID_CALLBACK, HAL_LTDC_ErrorCallback(), HAL_LTDC_LINE_EVENT_CB_ID, HAL_LTDC_LineEventCallback(), HAL_LTDC_MspDeInit(), HAL_LTDC_MSPDEINIT_CB_ID, HAL_LTDC_MspInit(), HAL_LTDC_MSPINIT_CB_ID, HAL_LTDC_RELOAD_EVENT_CB_ID, HAL_LTDC_ReloadEventCallback(), HAL_LTDC_STATE_READY, HAL_LTDC_STATE_RESET, __LTDC_HandleTypeDef::LineEventCallback, __LTDC_HandleTypeDef::MspDeInitCallback, __LTDC_HandleTypeDef::MspInitCallback, __LTDC_HandleTypeDef::ReloadEventCallback, and __LTDC_HandleTypeDef::State.