STM32H735xx HAL User Manual
Functions
Initialization and de-initialization functions
OTFDEC Exported Functions

Initialization and Configuration functions. More...

Functions

HAL_StatusTypeDef HAL_OTFDEC_Init (OTFDEC_HandleTypeDef *hotfdec)
 Initialize the OTFDEC peripheral and create the associated handle.
HAL_StatusTypeDef HAL_OTFDEC_DeInit (OTFDEC_HandleTypeDef *hotfdec)
 DeInitialize the OTFDEC peripheral.
__weak void HAL_OTFDEC_MspInit (OTFDEC_HandleTypeDef *hotfdec)
 Initialize the OTFDEC MSP.
__weak void HAL_OTFDEC_MspDeInit (OTFDEC_HandleTypeDef *hotfdec)
 DeInitialize OTFDEC MSP.
HAL_StatusTypeDef HAL_OTFDEC_RegisterCallback (OTFDEC_HandleTypeDef *hotfdec, HAL_OTFDEC_CallbackIDTypeDef CallbackID, pOTFDEC_CallbackTypeDef pCallback)
 Register a User OTFDEC Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef HAL_OTFDEC_UnRegisterCallback (OTFDEC_HandleTypeDef *hotfdec, HAL_OTFDEC_CallbackIDTypeDef CallbackID)
 Unregister a OTFDEC Callback OTFDEC callback is redirected to the weak predefined callback.

Detailed Description

Initialization and Configuration functions.

  ==============================================================================
              ##### Initialization and de-initialization functions #####
  ==============================================================================


Function Documentation

HAL_StatusTypeDef HAL_OTFDEC_DeInit ( OTFDEC_HandleTypeDef hotfdec)

DeInitialize the OTFDEC peripheral.

Parameters:
hotfdecpointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
Return values:
HALstatus

Definition at line 221 of file stm32h7xx_hal_otfdec.c.

References assert_param, __OTFDEC_HandleTypeDef::ErrorCode, HAL_OTFDEC_ERROR_NONE, HAL_OTFDEC_MspDeInit(), HAL_OTFDEC_STATE_BUSY, HAL_OTFDEC_STATE_RESET, __OTFDEC_HandleTypeDef::Instance, __OTFDEC_HandleTypeDef::MspDeInitCallback, and __OTFDEC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_OTFDEC_Init ( OTFDEC_HandleTypeDef hotfdec)

Initialize the OTFDEC peripheral and create the associated handle.

Parameters:
hotfdecpointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
Return values:
HALstatus

Definition at line 175 of file stm32h7xx_hal_otfdec.c.

References assert_param, __OTFDEC_HandleTypeDef::ErrorCallback, HAL_OTFDEC_ErrorCallback(), HAL_OTFDEC_MspInit(), HAL_OTFDEC_STATE_READY, HAL_OTFDEC_STATE_RESET, __OTFDEC_HandleTypeDef::Instance, __OTFDEC_HandleTypeDef::MspInitCallback, and __OTFDEC_HandleTypeDef::State.

DeInitialize OTFDEC MSP.

Parameters:
hotfdecpointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
Return values:
None

Definition at line 283 of file stm32h7xx_hal_otfdec.c.

Referenced by HAL_OTFDEC_DeInit(), and HAL_OTFDEC_UnRegisterCallback().

Initialize the OTFDEC MSP.

Parameters:
hotfdecpointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
Return values:
None

Definition at line 267 of file stm32h7xx_hal_otfdec.c.

Referenced by HAL_OTFDEC_Init(), and HAL_OTFDEC_UnRegisterCallback().

HAL_StatusTypeDef HAL_OTFDEC_RegisterCallback ( OTFDEC_HandleTypeDef hotfdec,
HAL_OTFDEC_CallbackIDTypeDef  CallbackID,
pOTFDEC_CallbackTypeDef  pCallback 
)

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

Parameters:
hotfdecpointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
CallbackIDID of the callback to be registered This parameter can be one of the following values:
pCallbackpointer to the Callback function
Return values:
HALstatus

Definition at line 307 of file stm32h7xx_hal_otfdec.c.

References __OTFDEC_HandleTypeDef::ErrorCallback, __OTFDEC_HandleTypeDef::ErrorCode, HAL_OTFDEC_ERROR_CB_ID, HAL_OTFDEC_ERROR_INVALID_CALLBACK, HAL_OTFDEC_MSPDEINIT_CB_ID, HAL_OTFDEC_MSPINIT_CB_ID, HAL_OTFDEC_STATE_READY, HAL_OTFDEC_STATE_RESET, __OTFDEC_HandleTypeDef::MspDeInitCallback, __OTFDEC_HandleTypeDef::MspInitCallback, and __OTFDEC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_OTFDEC_UnRegisterCallback ( OTFDEC_HandleTypeDef hotfdec,
HAL_OTFDEC_CallbackIDTypeDef  CallbackID 
)

Unregister a OTFDEC Callback OTFDEC callback is redirected to the weak predefined callback.

Parameters:
hotfdecpointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
CallbackIDID of the callback to be registered This parameter can be one of the following values:
Return values:
HALstatus

Definition at line 390 of file stm32h7xx_hal_otfdec.c.

References __OTFDEC_HandleTypeDef::ErrorCallback, __OTFDEC_HandleTypeDef::ErrorCode, HAL_OTFDEC_ERROR_CB_ID, HAL_OTFDEC_ERROR_INVALID_CALLBACK, HAL_OTFDEC_ErrorCallback(), HAL_OTFDEC_MspDeInit(), HAL_OTFDEC_MSPDEINIT_CB_ID, HAL_OTFDEC_MspInit(), HAL_OTFDEC_MSPINIT_CB_ID, HAL_OTFDEC_STATE_READY, HAL_OTFDEC_STATE_RESET, __OTFDEC_HandleTypeDef::MspDeInitCallback, __OTFDEC_HandleTypeDef::MspInitCallback, and __OTFDEC_HandleTypeDef::State.