Channel operation functions

Channel operation functions. More...

Functions
HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStart (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to start clock absence detection in polling mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStart_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to start clock absence detection in interrupt mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStop (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop clock absence detection in polling mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelCkabStop_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop clock absence detection in interrupt mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStart (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Threshold, uint32_t BreakSignal)
	This function allows to start short circuit detection in polling mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStart_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Threshold, uint32_t BreakSignal)
	This function allows to start short circuit detection in interrupt mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStop (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop short circuit detection in polling mode. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelScdStop_IT (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to stop short circuit detection in interrupt mode. More...
int16_t	HAL_DFSDM_ChannelGetAwdValue (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	This function allows to get channel analog watchdog value. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelModifyOffset (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, int32_t Offset)
	This function allows to modify channel offset value. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelPollForCkab (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout)
	This function allows to poll for the clock absence detection. More...
HAL_StatusTypeDef	HAL_DFSDM_ChannelPollForScd (DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t Timeout)
	This function allows to poll for the short circuit detection. More...
void	HAL_DFSDM_ChannelCkabCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	Clock absence detection callback. More...
void	HAL_DFSDM_ChannelScdCallback (DFSDM_Channel_HandleTypeDef *hdfsdm_channel)
	Short circuit detection callback. More...

Detailed Description

Channel operation functions.

  ==============================================================================
                   ##### Channel operation functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Manage clock absence detector feature.
      (+) Manage short circuit detector feature.
      (+) Get analog watchdog value.
      (+) Modify offset value.

Function Documentation

HAL_DFSDM_ChannelCkabCallback()

__weak void HAL_DFSDM_ChannelCkabCallback

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

Clock absence detection callback.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

None

Definition at line 905 of file stm32l4xx_hal_dfsdm.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hdfsdm_channel);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_DFSDM_ChannelCkabCallback could be implemented in the user file
   */
}

HAL_DFSDM_ChannelCkabStart()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStart

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to start clock absence detection in polling mode.

Note

Same mode has to be used for all channels.

If clock is not available on this channel during 5 seconds, clock absence detection will not be activated and function will return HAL_TIMEOUT error.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

HAL

status

Definition at line 711 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t channel;
  uint32_t tickstart;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Get channel number from channel instance */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);

    /* Get timeout */
    tickstart = HAL_GetTick();

    /* Clear clock absence flag */
    while ((((DFSDM1_Filter0->FLTISR & DFSDM_FLTISR_CKABF) >> (DFSDM_FLTISR_CKABF_Pos + channel)) & 1U) != 0U)
    {
      DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRCKABF_Pos + channel));

      /* Check the Timeout */
      if ((HAL_GetTick() - tickstart) > DFSDM_CKAB_TIMEOUT)
      {
        /* Set timeout status */
        status = HAL_TIMEOUT;
        break;
      }
    }

    if (status == HAL_OK)
    {
      /* Start clock absence detection */
      hdfsdm_channel->Instance->CHCFGR1 |= DFSDM_CHCFGR1_CKABEN;
    }
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelCkabStart_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStart_IT

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to start clock absence detection in interrupt mode.

Note

Same mode has to be used for all channels.

If clock is not available on this channel during 5 seconds, clock absence detection will not be activated and function will return HAL_TIMEOUT error.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

HAL

status

Definition at line 850 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t channel;
  uint32_t tickstart;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Get channel number from channel instance */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);

    /* Get timeout */
    tickstart = HAL_GetTick();

    /* Clear clock absence flag */
    while ((((DFSDM1_Filter0->FLTISR & DFSDM_FLTISR_CKABF) >> (DFSDM_FLTISR_CKABF_Pos + channel)) & 1U) != 0U)
    {
      DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRCKABF_Pos + channel));

      /* Check the Timeout */
      if ((HAL_GetTick() - tickstart) > DFSDM_CKAB_TIMEOUT)
      {
        /* Set timeout status */
        status = HAL_TIMEOUT;
        break;
      }
    }

    if (status == HAL_OK)
    {
      /* Activate clock absence detection interrupt */
      DFSDM1_Filter0->FLTCR2 |= DFSDM_FLTCR2_CKABIE;

      /* Start clock absence detection */
      hdfsdm_channel->Instance->CHCFGR1 |= DFSDM_CHCFGR1_CKABEN;
    }
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelCkabStop()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStop

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to stop clock absence detection in polling mode.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

HAL

status

Definition at line 814 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t channel;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Stop clock absence detection */
    hdfsdm_channel->Instance->CHCFGR1 &= ~(DFSDM_CHCFGR1_CKABEN);

    /* Clear clock absence flag */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);
    DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRCKABF_Pos + channel));
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelCkabStop_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelCkabStop_IT

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to stop clock absence detection in interrupt mode.

Note

Interrupt will be disabled for all channels

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

HAL

status

Definition at line 921 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t channel;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Stop clock absence detection */
    hdfsdm_channel->Instance->CHCFGR1 &= ~(DFSDM_CHCFGR1_CKABEN);

    /* Clear clock absence flag */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);
    DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRCKABF_Pos + channel));

    /* Disable clock absence detection interrupt */
    DFSDM1_Filter0->FLTCR2 &= ~(DFSDM_FLTCR2_CKABIE);
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelGetAwdValue()

int16_t HAL_DFSDM_ChannelGetAwdValue

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to get channel analog watchdog value.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

Channel

analog watchdog value.

Definition at line 1175 of file stm32l4xx_hal_dfsdm.c.

{
  return (int16_t) hdfsdm_channel->Instance->CHWDATAR;
}

HAL_DFSDM_ChannelModifyOffset()

HAL_StatusTypeDef HAL_DFSDM_ChannelModifyOffset	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		int32_t	Offset
	)

This function allows to modify channel offset value.

Parameters

hdfsdm_channel	DFSDM channel handle.
Offset	DFSDM channel offset. This parameter must be a number between Min_Data = -8388608 and Max_Data = 8388607.

Return values

HAL

status.

Definition at line 1187 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));
  assert_param(IS_DFSDM_CHANNEL_OFFSET(Offset));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Modify channel offset */
    hdfsdm_channel->Instance->CHCFGR2 &= ~(DFSDM_CHCFGR2_OFFSET);
    hdfsdm_channel->Instance->CHCFGR2 |= ((uint32_t) Offset << DFSDM_CHCFGR2_OFFSET_Pos);
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelPollForCkab()

HAL_StatusTypeDef HAL_DFSDM_ChannelPollForCkab	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Timeout
	)

This function allows to poll for the clock absence detection.

Parameters

hdfsdm_channel	DFSDM channel handle.
Timeout	Timeout value in milliseconds.

Return values

HAL

status

Definition at line 764 of file stm32l4xx_hal_dfsdm.c.

{
  uint32_t tickstart;
  uint32_t channel;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    return HAL_ERROR;
  }
  else
  {
    /* Get channel number from channel instance */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);

    /* Get timeout */
    tickstart = HAL_GetTick();

    /* Wait clock absence detection */
    while ((((DFSDM1_Filter0->FLTISR & DFSDM_FLTISR_CKABF) >> (DFSDM_FLTISR_CKABF_Pos + channel)) & 1U) == 0U)
    {
      /* Check the Timeout */
      if (Timeout != HAL_MAX_DELAY)
      {
        if (((HAL_GetTick() - tickstart) > Timeout) || (Timeout == 0U))
        {
          /* Return timeout status */
          return HAL_TIMEOUT;
        }
      }
    }

    /* Clear clock absence detection flag */
    DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRCKABF_Pos + channel));

    /* Return function status */
    return HAL_OK;
  }
}

HAL_DFSDM_ChannelPollForScd()

HAL_StatusTypeDef HAL_DFSDM_ChannelPollForScd	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Timeout
	)

This function allows to poll for the short circuit detection.

Parameters

hdfsdm_channel	DFSDM channel handle.
Timeout	Timeout value in milliseconds.

Return values

HAL

status

Definition at line 998 of file stm32l4xx_hal_dfsdm.c.

{
  uint32_t tickstart;
  uint32_t channel;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    return HAL_ERROR;
  }
  else
  {
    /* Get channel number from channel instance */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);

    /* Get timeout */
    tickstart = HAL_GetTick();

    /* Wait short circuit detection */
    while (((DFSDM1_Filter0->FLTISR & DFSDM_FLTISR_SCDF) >> (DFSDM_FLTISR_SCDF_Pos + channel)) == 0U)
    {
      /* Check the Timeout */
      if (Timeout != HAL_MAX_DELAY)
      {
        if (((HAL_GetTick() - tickstart) > Timeout) || (Timeout == 0U))
        {
          /* Return timeout status */
          return HAL_TIMEOUT;
        }
      }
    }

    /* Clear short circuit detection flag */
    DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRSCDF_Pos + channel));

    /* Return function status */
    return HAL_OK;
  }
}

HAL_DFSDM_ChannelScdCallback()

__weak void HAL_DFSDM_ChannelScdCallback

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

Short circuit detection callback.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

None

Definition at line 1124 of file stm32l4xx_hal_dfsdm.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hdfsdm_channel);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_DFSDM_ChannelScdCallback could be implemented in the user file
   */
}

HAL_DFSDM_ChannelScdStart()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStart	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Threshold,
		uint32_t	BreakSignal
	)

This function allows to start short circuit detection in polling mode.

Note

Same mode has to be used for all channels

Parameters

hdfsdm_channel	DFSDM channel handle.
Threshold	Short circuit detector threshold. This parameter must be a number between Min_Data = 0 and Max_Data = 255.
BreakSignal	Break signals assigned to short circuit event. This parameter can be a values combination of DFSDM break signals.

Return values

HAL

status

Definition at line 961 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));
  assert_param(IS_DFSDM_CHANNEL_SCD_THRESHOLD(Threshold));
  assert_param(IS_DFSDM_BREAK_SIGNALS(BreakSignal));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Configure threshold and break signals */
    hdfsdm_channel->Instance->CHAWSCDR &= ~(DFSDM_CHAWSCDR_BKSCD | DFSDM_CHAWSCDR_SCDT);
    hdfsdm_channel->Instance->CHAWSCDR |= ((BreakSignal << DFSDM_CHAWSCDR_BKSCD_Pos) | \
                                           Threshold);

    /* Start short circuit detection */
    hdfsdm_channel->Instance->CHCFGR1 |= DFSDM_CHCFGR1_SCDEN;
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelScdStart_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStart_IT	(	DFSDM_Channel_HandleTypeDef *	hdfsdm_channel,
		uint32_t	Threshold,
		uint32_t	BreakSignal
	)

This function allows to start short circuit detection in interrupt mode.

Note

Same mode has to be used for all channels

Parameters

hdfsdm_channel	DFSDM channel handle.
Threshold	Short circuit detector threshold. This parameter must be a number between Min_Data = 0 and Max_Data = 255.
BreakSignal	Break signals assigned to short circuit event. This parameter can be a values combination of DFSDM break signals.

Return values

HAL

status

Definition at line 1085 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));
  assert_param(IS_DFSDM_CHANNEL_SCD_THRESHOLD(Threshold));
  assert_param(IS_DFSDM_BREAK_SIGNALS(BreakSignal));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Activate short circuit detection interrupt */
    DFSDM1_Filter0->FLTCR2 |= DFSDM_FLTCR2_SCDIE;

    /* Configure threshold and break signals */
    hdfsdm_channel->Instance->CHAWSCDR &= ~(DFSDM_CHAWSCDR_BKSCD | DFSDM_CHAWSCDR_SCDT);
    hdfsdm_channel->Instance->CHAWSCDR |= ((BreakSignal << DFSDM_CHAWSCDR_BKSCD_Pos) | \
                                           Threshold);

    /* Start short circuit detection */
    hdfsdm_channel->Instance->CHCFGR1 |= DFSDM_CHCFGR1_SCDEN;
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelScdStop()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStop

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to stop short circuit detection in polling mode.

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

HAL

status

Definition at line 1048 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t channel;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Stop short circuit detection */
    hdfsdm_channel->Instance->CHCFGR1 &= ~(DFSDM_CHCFGR1_SCDEN);

    /* Clear short circuit detection flag */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);
    DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRSCDF_Pos + channel));
  }
  /* Return function status */
  return status;
}

HAL_DFSDM_ChannelScdStop_IT()

HAL_StatusTypeDef HAL_DFSDM_ChannelScdStop_IT

(

DFSDM_Channel_HandleTypeDef *

hdfsdm_channel

)

This function allows to stop short circuit detection in interrupt mode.

Note

Interrupt will be disabled for all channels

Parameters

hdfsdm_channel

DFSDM channel handle.

Return values

HAL

status

Definition at line 1140 of file stm32l4xx_hal_dfsdm.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  uint32_t channel;

  /* Check parameters */
  assert_param(IS_DFSDM_CHANNEL_ALL_INSTANCE(hdfsdm_channel->Instance));

  /* Check DFSDM channel state */
  if (hdfsdm_channel->State != HAL_DFSDM_CHANNEL_STATE_READY)
  {
    /* Return error status */
    status = HAL_ERROR;
  }
  else
  {
    /* Stop short circuit detection */
    hdfsdm_channel->Instance->CHCFGR1 &= ~(DFSDM_CHCFGR1_SCDEN);

    /* Clear short circuit detection flag */
    channel = DFSDM_GetChannelFromInstance(hdfsdm_channel->Instance);
    DFSDM1_Filter0->FLTICR = (1UL << (DFSDM_FLTICR_CLRSCDF_Pos + channel));

    /* Disable short circuit detection interrupt */
    DFSDM1_Filter0->FLTCR2 &= ~(DFSDM_FLTCR2_SCDIE);
  }
  /* Return function status */
  return status;
}