Peripheral State functions

Peripheral State functions. More...

Functions
HAL_DCMI_StateTypeDef	HAL_DCMI_GetState (DCMI_HandleTypeDef *hdcmi)
	Return the DCMI state.
uint32_t	HAL_DCMI_GetError (DCMI_HandleTypeDef *hdcmi)
	Return the DCMI error code.
HAL_StatusTypeDef	HAL_DCMI_RegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID, pDCMI_CallbackTypeDef pCallback)
	Register a User DCMI Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_DCMI_UnRegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID)
	Unregister a DCMI Callback DCMI callabck is redirected to the weak predefined callback.

---

Detailed Description

Peripheral State functions.

 ===============================================================================
               ##### Peripheral State and Errors functions #####
 ===============================================================================
    [..]
    This subsection provides functions allowing to
      (+) Check the DCMI state.
      (+) Get the specific DCMI error flag.

---

Function Documentation

uint32_t HAL_DCMI_GetError

(

DCMI_HandleTypeDef *

hdcmi

)

Return the DCMI error code.

Parameters:

hdcmi

pointer to a DCMI_HandleTypeDef structure that contains the configuration information for DCMI.

Return values:

DCMI	Error Code

Definition at line 923 of file stm32h7xx_hal_dcmi.c.

References __DCMI_HandleTypeDef::ErrorCode.

HAL_DCMI_StateTypeDef HAL_DCMI_GetState

(

DCMI_HandleTypeDef *

hdcmi

)

Return the DCMI state.

Parameters:

hdcmi

pointer to a DCMI_HandleTypeDef structure that contains the configuration information for DCMI.

Return values:

HAL

state

Definition at line 912 of file stm32h7xx_hal_dcmi.c.

References __DCMI_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DCMI_RegisterCallback	(	DCMI_HandleTypeDef *	hdcmi,
		HAL_DCMI_CallbackIDTypeDef	CallbackID,
		pDCMI_CallbackTypeDef	pCallback
	)

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

Parameters:

hdcmi	DCMI handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_DCMI_LINE_EVENT_CB_ID Line Event callback ID HAL_DCMI_FRAME_EVENT_CB_ID Frame Event callback ID HAL_DCMI_VSYNC_EVENT_CB_ID Vsync Event callback ID HAL_DCMI_ERROR_CB_ID Error callback ID HAL_DCMI_MSPINIT_CB_ID MspInit callback ID HAL_DCMI_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values:

HAL

status

Definition at line 944 of file stm32h7xx_hal_dcmi.c.

References __DCMI_HandleTypeDef::ErrorCallback, __DCMI_HandleTypeDef::ErrorCode, __DCMI_HandleTypeDef::FrameEventCallback, HAL_DCMI_ERROR_CB_ID, HAL_DCMI_ERROR_INVALID_CALLBACK, HAL_DCMI_FRAME_EVENT_CB_ID, HAL_DCMI_LINE_EVENT_CB_ID, HAL_DCMI_MSPDEINIT_CB_ID, HAL_DCMI_MSPINIT_CB_ID, HAL_DCMI_STATE_READY, HAL_DCMI_STATE_RESET, HAL_DCMI_VSYNC_EVENT_CB_ID, __DCMI_HandleTypeDef::LineEventCallback, __DCMI_HandleTypeDef::MspDeInitCallback, __DCMI_HandleTypeDef::MspInitCallback, __DCMI_HandleTypeDef::State, and __DCMI_HandleTypeDef::VsyncEventCallback.

HAL_StatusTypeDef HAL_DCMI_UnRegisterCallback	(	DCMI_HandleTypeDef *	hdcmi,
		HAL_DCMI_CallbackIDTypeDef	CallbackID
	)

Unregister a DCMI Callback DCMI callabck is redirected to the weak predefined callback.

Parameters:

hdcmi	DCMI handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_DCMI_LINE_EVENT_CB_ID Line Event callback ID HAL_DCMI_FRAME_EVENT_CB_ID Frame Event callback ID HAL_DCMI_VSYNC_EVENT_CB_ID Vsync Event callback ID HAL_DCMI_ERROR_CB_ID Error callback ID HAL_DCMI_MSPINIT_CB_ID MspInit callback ID HAL_DCMI_MSPDEINIT_CB_ID MspDeInit callback ID

Return values:

HAL

status

Definition at line 1037 of file stm32h7xx_hal_dcmi.c.

References __DCMI_HandleTypeDef::ErrorCallback, __DCMI_HandleTypeDef::ErrorCode, __DCMI_HandleTypeDef::FrameEventCallback, HAL_DCMI_ERROR_CB_ID, HAL_DCMI_ERROR_INVALID_CALLBACK, HAL_DCMI_ErrorCallback(), HAL_DCMI_FRAME_EVENT_CB_ID, HAL_DCMI_FrameEventCallback(), HAL_DCMI_LINE_EVENT_CB_ID, HAL_DCMI_LineEventCallback(), HAL_DCMI_MspDeInit(), HAL_DCMI_MSPDEINIT_CB_ID, HAL_DCMI_MspInit(), HAL_DCMI_MSPINIT_CB_ID, HAL_DCMI_STATE_READY, HAL_DCMI_STATE_RESET, HAL_DCMI_VSYNC_EVENT_CB_ID, HAL_DCMI_VsyncEventCallback(), __DCMI_HandleTypeDef::LineEventCallback, __DCMI_HandleTypeDef::MspDeInitCallback, __DCMI_HandleTypeDef::MspInitCallback, __DCMI_HandleTypeDef::State, and __DCMI_HandleTypeDef::VsyncEventCallback.