Input and Output operation functions

Input and Output operation functions. More...

Functions
HAL_StatusTypeDef	HAL_TSC_Start (TSC_HandleTypeDef *htsc)
	Start the acquisition. More...
HAL_StatusTypeDef	HAL_TSC_Start_IT (TSC_HandleTypeDef *htsc)
	Start the acquisition in interrupt mode. More...
HAL_StatusTypeDef	HAL_TSC_Stop (TSC_HandleTypeDef *htsc)
	Stop the acquisition previously launched in polling mode. More...
HAL_StatusTypeDef	HAL_TSC_Stop_IT (TSC_HandleTypeDef *htsc)
	Stop the acquisition previously launched in interrupt mode. More...
HAL_StatusTypeDef	HAL_TSC_PollForAcquisition (TSC_HandleTypeDef *htsc)
	Start acquisition and wait until completion. More...
TSC_GroupStatusTypeDef	HAL_TSC_GroupGetStatus (TSC_HandleTypeDef *htsc, uint32_t gx_index)
	Get the acquisition status for a group. More...
uint32_t	HAL_TSC_GroupGetValue (TSC_HandleTypeDef *htsc, uint32_t gx_index)
	Get the acquisition measure for a group. More...

Detailed Description

Input and Output operation functions.

 ===============================================================================
             ##### IO Operation functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Start acquisition in polling mode.
      (+) Start acquisition in interrupt mode.
      (+) Stop conversion in polling mode.
      (+) Stop conversion in interrupt mode.
      (+) Poll for acquisition completed.
      (+) Get group acquisition status.
      (+) Get group acquisition value.

Function Documentation

HAL_TSC_GroupGetStatus()

TSC_GroupStatusTypeDef HAL_TSC_GroupGetStatus	(	TSC_HandleTypeDef *	htsc,
		uint32_t	gx_index
	)

Get the acquisition status for a group.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
gx_index	Index of the group

Return values

Group

status

Definition at line 823 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
  assert_param(IS_TSC_GROUP_INDEX(gx_index));

  /* Return the group status */
  return (__HAL_TSC_GET_GROUP_STATUS(htsc, gx_index));
}

HAL_TSC_GroupGetValue()

uint32_t HAL_TSC_GroupGetValue	(	TSC_HandleTypeDef *	htsc,
		uint32_t	gx_index
	)

Get the acquisition measure for a group.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.
gx_index	Index of the group

Return values

Acquisition

measure

Definition at line 840 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
  assert_param(IS_TSC_GROUP_INDEX(gx_index));

  /* Return the group acquisition counter */
  return htsc->Instance->IOGXCR[gx_index];
}

HAL_TSC_PollForAcquisition()

HAL_StatusTypeDef HAL_TSC_PollForAcquisition

(

TSC_HandleTypeDef *

htsc

)

Start acquisition and wait until completion.

Note

There is no need of a timeout parameter as the max count error is already managed by the TSC peripheral.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.

Return values

HAL

state

Definition at line 796 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));

  /* Process locked */
  __HAL_LOCK(htsc);

  /* Check end of acquisition */
  while (HAL_TSC_GetState(htsc) == HAL_TSC_STATE_BUSY)
  {
    /* The timeout (max count error) is managed by the TSC peripheral itself. */
  }

  /* Process unlocked */
  __HAL_UNLOCK(htsc);

  return HAL_OK;
}

HAL_TSC_Start()

HAL_StatusTypeDef HAL_TSC_Start

(

TSC_HandleTypeDef *

htsc

)

Start the acquisition.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.

Return values

HAL

status

Definition at line 628 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));

  /* Process locked */
  __HAL_LOCK(htsc);

  /* Change TSC state */
  htsc->State = HAL_TSC_STATE_BUSY;

  /* Clear interrupts */
  __HAL_TSC_DISABLE_IT(htsc, (TSC_IT_EOA | TSC_IT_MCE));

  /* Clear flags */
  __HAL_TSC_CLEAR_FLAG(htsc, (TSC_FLAG_EOA | TSC_FLAG_MCE));

  /* Set touch sensing IOs not acquired to the specified IODefaultMode */
  if (htsc->Init.IODefaultMode == TSC_IODEF_OUT_PP_LOW)
  {
    __HAL_TSC_SET_IODEF_OUTPPLOW(htsc);
  }
  else
  {
    __HAL_TSC_SET_IODEF_INFLOAT(htsc);
  }

  /* Launch the acquisition */
  __HAL_TSC_START_ACQ(htsc);

  /* Process unlocked */
  __HAL_UNLOCK(htsc);

  /* Return function status */
  return HAL_OK;
}

HAL_TSC_Start_IT()

HAL_StatusTypeDef HAL_TSC_Start_IT

(

TSC_HandleTypeDef *

htsc

)

Start the acquisition in interrupt mode.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.

Return values

HAL

status.

Definition at line 671 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
  assert_param(IS_TSC_MCE_IT(htsc->Init.MaxCountInterrupt));

  /* Process locked */
  __HAL_LOCK(htsc);

  /* Change TSC state */
  htsc->State = HAL_TSC_STATE_BUSY;

  /* Enable end of acquisition interrupt */
  __HAL_TSC_ENABLE_IT(htsc, TSC_IT_EOA);

  /* Enable max count error interrupt (optional) */
  if (htsc->Init.MaxCountInterrupt == ENABLE)
  {
    __HAL_TSC_ENABLE_IT(htsc, TSC_IT_MCE);
  }
  else
  {
    __HAL_TSC_DISABLE_IT(htsc, TSC_IT_MCE);
  }

  /* Clear flags */
  __HAL_TSC_CLEAR_FLAG(htsc, (TSC_FLAG_EOA | TSC_FLAG_MCE));

  /* Set touch sensing IOs not acquired to the specified IODefaultMode */
  if (htsc->Init.IODefaultMode == TSC_IODEF_OUT_PP_LOW)
  {
    __HAL_TSC_SET_IODEF_OUTPPLOW(htsc);
  }
  else
  {
    __HAL_TSC_SET_IODEF_INFLOAT(htsc);
  }

  /* Launch the acquisition */
  __HAL_TSC_START_ACQ(htsc);

  /* Process unlocked */
  __HAL_UNLOCK(htsc);

  /* Return function status */
  return HAL_OK;
}

HAL_TSC_Stop()

HAL_StatusTypeDef HAL_TSC_Stop

(

TSC_HandleTypeDef *

htsc

)

Stop the acquisition previously launched in polling mode.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.

Return values

HAL

status

Definition at line 725 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));

  /* Process locked */
  __HAL_LOCK(htsc);

  /* Stop the acquisition */
  __HAL_TSC_STOP_ACQ(htsc);

  /* Set touch sensing IOs in low power mode (output push-pull) */
  __HAL_TSC_SET_IODEF_OUTPPLOW(htsc);

  /* Clear flags */
  __HAL_TSC_CLEAR_FLAG(htsc, (TSC_FLAG_EOA | TSC_FLAG_MCE));

  /* Change TSC state */
  htsc->State = HAL_TSC_STATE_READY;

  /* Process unlocked */
  __HAL_UNLOCK(htsc);

  /* Return function status */
  return HAL_OK;
}

HAL_TSC_Stop_IT()

HAL_StatusTypeDef HAL_TSC_Stop_IT

(

TSC_HandleTypeDef *

htsc

)

Stop the acquisition previously launched in interrupt mode.

Parameters

htsc	Pointer to a TSC_HandleTypeDef structure that contains the configuration information for the specified TSC.

Return values

HAL

status

Definition at line 758 of file stm32l4xx_hal_tsc.c.

{
  /* Check the parameters */
  assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));

  /* Process locked */
  __HAL_LOCK(htsc);

  /* Stop the acquisition */
  __HAL_TSC_STOP_ACQ(htsc);

  /* Set touch sensing IOs in low power mode (output push-pull) */
  __HAL_TSC_SET_IODEF_OUTPPLOW(htsc);

  /* Disable interrupts */
  __HAL_TSC_DISABLE_IT(htsc, (TSC_IT_EOA | TSC_IT_MCE));

  /* Clear flags */
  __HAL_TSC_CLEAR_FLAG(htsc, (TSC_FLAG_EOA | TSC_FLAG_MCE));

  /* Change TSC state */
  htsc->State = HAL_TSC_STATE_READY;

  /* Process unlocked */
  __HAL_UNLOCK(htsc);

  /* Return function status */
  return HAL_OK;
}