Peripheral Control functions

Peripheral Control functions. More...

Functions
HAL_StatusTypeDef	HAL_DCMI_ConfigCrop (DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize)
	Configure the DCMI crop window coordinates. More...
HAL_StatusTypeDef	HAL_DCMI_EnableCrop (DCMI_HandleTypeDef *hdcmi)
	Enable the crop feature. More...
HAL_StatusTypeDef	HAL_DCMI_DisableCrop (DCMI_HandleTypeDef *hdcmi)
	Disable the crop feature. More...
HAL_StatusTypeDef	HAL_DCMI_ConfigSyncUnmask (DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask)
	Set embedded synchronization delimiters unmasks. More...

Detailed Description

Peripheral Control functions.

 ===============================================================================
                    ##### Peripheral Control functions #####
 ===============================================================================
[..]  This section provides functions allowing to:
      (+) Configure the crop feature.
      (+) Enable/Disable the crop feature.
      (+) Configure the synchronization delimiters unmasks.
      (+) Enable/Disable user-specified DCMI interrupts.

Function Documentation

HAL_DCMI_ConfigCrop()

HAL_StatusTypeDef HAL_DCMI_ConfigCrop	(	DCMI_HandleTypeDef *	hdcmi,
		uint32_t	X0,
		uint32_t	Y0,
		uint32_t	XSize,
		uint32_t	YSize
	)

Configure the DCMI crop window coordinates.

Parameters

hdcmi	pointer to a DCMI_HandleTypeDef structure that contains the configuration information for DCMI.
X0	DCMI window crop window X offset (number of pixels clocks to count before the capture).
Y0	DCMI window crop window Y offset (image capture starts with this line number, previous line data are ignored).
XSize	DCMI crop window horizontal size (in number of pixels per line).
YSize	DCMI crop window vertical size (in lines count).

Note

For all the parameters, the actual value is the input data + 1 (e.g. YSize = 0x0 means 1 line, YSize = 0x1 means 2 lines, ...)

Return values

HAL

status

Definition at line 905 of file stm32l4xx_hal_dcmi.c.

{
  /* Check the parameters */
  assert_param(IS_DCMI_WINDOW_COORDINATE(X0));
  assert_param(IS_DCMI_WINDOW_HEIGHT(Y0));
  assert_param(IS_DCMI_WINDOW_COORDINATE(XSize));
  assert_param(IS_DCMI_WINDOW_COORDINATE(YSize));

  /* Process Locked */
  __HAL_LOCK(hdcmi);

  /* Lock the DCMI peripheral state */
  hdcmi->State = HAL_DCMI_STATE_BUSY;

  /* Configure CROP */
  MODIFY_REG(hdcmi->Instance->CWSIZER, (DCMI_CWSIZE_VLINE|DCMI_CWSIZE_CAPCNT), (XSize | (YSize << DCMI_CWSIZE_VLINE_Pos)));
  MODIFY_REG(hdcmi->Instance->CWSTRTR, (DCMI_CWSTRT_VST|DCMI_CWSTRT_HOFFCNT), (X0 | (Y0 << DCMI_CWSTRT_VST_Pos)));

  /* Initialize the DCMI state*/
  hdcmi->State  = HAL_DCMI_STATE_READY;

  /* Process Unlocked */
  __HAL_UNLOCK(hdcmi);

  return HAL_OK;
}

HAL_DCMI_ConfigSyncUnmask()

HAL_StatusTypeDef HAL_DCMI_ConfigSyncUnmask	(	DCMI_HandleTypeDef *	hdcmi,
		DCMI_SyncUnmaskTypeDef *	SyncUnmask
	)

Set embedded synchronization delimiters unmasks.

Parameters

hdcmi	pointer to a DCMI_HandleTypeDef structure that contains the configuration information for DCMI.
SyncUnmask	pointer to a DCMI_SyncUnmaskTypeDef structure that contains the embedded synchronization delimiters unmasks.

Return values

HAL

status

Definition at line 992 of file stm32l4xx_hal_dcmi.c.

{
  /* Process Locked */
  __HAL_LOCK(hdcmi);

  /* Lock the DCMI peripheral state */
  hdcmi->State = HAL_DCMI_STATE_BUSY;

  /* Write DCMI embedded synchronization unmask register */
    hdcmi->Instance->ESUR = (((uint32_t)SyncUnmask->FrameStartUnmask) |\
                             ((uint32_t)SyncUnmask->LineStartUnmask << DCMI_ESUR_LSU_Pos)|\
                             ((uint32_t)SyncUnmask->LineEndUnmask << DCMI_ESUR_LEU_Pos)|\
                             ((uint32_t)SyncUnmask->FrameEndUnmask << DCMI_ESUR_FEU_Pos));

  /* Change the DCMI state*/
  hdcmi->State = HAL_DCMI_STATE_READY;

  /* Process Unlocked */
  __HAL_UNLOCK(hdcmi);

  return HAL_OK;
}

HAL_DCMI_DisableCrop()

HAL_StatusTypeDef HAL_DCMI_DisableCrop

(

DCMI_HandleTypeDef *

hdcmi

)

Disable the crop feature.

Parameters

hdcmi

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

Return values

HAL

status

Definition at line 938 of file stm32l4xx_hal_dcmi.c.

{
  /* Process Locked */
  __HAL_LOCK(hdcmi);

  /* Lock the DCMI peripheral state */
  hdcmi->State = HAL_DCMI_STATE_BUSY;

  /* Disable DCMI Crop feature */
  CLEAR_BIT(hdcmi->Instance->CR, DCMI_CR_CROP);

  /* Change the DCMI state*/
  hdcmi->State = HAL_DCMI_STATE_READY;

  /* Process Unlocked */
  __HAL_UNLOCK(hdcmi);

  return HAL_OK;
}

HAL_DCMI_EnableCrop()

HAL_StatusTypeDef HAL_DCMI_EnableCrop

(

DCMI_HandleTypeDef *

hdcmi

)

Enable the crop feature.

Parameters

hdcmi

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

Return values

HAL

status

Definition at line 964 of file stm32l4xx_hal_dcmi.c.

{
  /* Process Locked */
  __HAL_LOCK(hdcmi);

  /* Lock the DCMI peripheral state */
  hdcmi->State = HAL_DCMI_STATE_BUSY;

  /* Enable DCMI Crop feature */
  SET_BIT(hdcmi->Instance->CR, DCMI_CR_CROP);

  /* Change the DCMI state*/
  hdcmi->State = HAL_DCMI_STATE_READY;

  /* Process Unlocked */
  __HAL_UNLOCK(hdcmi);

  return HAL_OK;
}