You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
825 lines
25 KiB
825 lines
25 KiB
7 years ago
|
/**
|
||
|
|
******************************************************************************
|
||
|
|
* @file stm32f0xx_hal_tsc.c
|
||
|
|
* @author MCD Application Team
|
||
|
|
* @brief This file provides firmware functions to manage the following
|
||
|
|
* functionalities of the Touch Sensing Controller (TSC) peripheral:
|
||
|
|
* + Initialization and DeInitialization
|
||
|
|
* + Channel IOs, Shield IOs and Sampling IOs configuration
|
||
|
|
* + Start and Stop an acquisition
|
||
|
|
* + Read acquisition result
|
||
|
|
* + Interrupts and flags management
|
||
|
|
*
|
||
|
|
@verbatim
|
||
|
|
================================================================================
|
||
|
|
##### TSC specific features #####
|
||
|
|
================================================================================
|
||
|
|
[..]
|
||
|
|
(+) Proven and robust surface charge transfer acquisition principle
|
||
|
|
|
||
|
|
(+) Supports up to 3 capacitive sensing channels per group
|
||
|
|
|
||
|
|
(+) Capacitive sensing channels can be acquired in parallel offering a very good
|
||
|
|
response time
|
||
|
|
|
||
|
|
(+) Spread spectrum feature to improve system robustness in noisy environments
|
||
|
|
|
||
|
|
(+) Full hardware management of the charge transfer acquisition sequence
|
||
|
|
|
||
|
|
(+) Programmable charge transfer frequency
|
||
|
|
|
||
|
|
(+) Programmable sampling capacitor I/O pin
|
||
|
|
|
||
|
|
(+) Programmable channel I/O pin
|
||
|
|
|
||
|
|
(+) Programmable max count value to avoid long acquisition when a channel is faulty
|
||
|
|
|
||
|
|
(+) Dedicated end of acquisition and max count error flags with interrupt capability
|
||
|
|
|
||
|
|
(+) One sampling capacitor for up to 3 capacitive sensing channels to reduce the system
|
||
|
|
components
|
||
|
|
(+) Compatible with proximity, touchkey, linear and rotary touch sensor implementation
|
||
|
|
|
||
|
|
##### How to use this driver #####
|
||
|
|
================================================================================
|
||
|
|
[..]
|
||
|
|
(#) Enable the TSC interface clock using __HAL_RCC_TSC_CLK_ENABLE() macro.
|
||
|
|
|
||
|
|
(#) GPIO pins configuration
|
||
|
|
(++) Enable the clock for the TSC GPIOs using __HAL_RCC_GPIOx_CLK_ENABLE() macro.
|
||
|
|
(++) Configure the TSC pins used as sampling IOs in alternate function output Open-Drain mode,
|
||
|
|
and TSC pins used as channel/shield IOs in alternate function output Push-Pull mode
|
||
|
|
using HAL_GPIO_Init() function.
|
||
|
|
(++) Configure the alternate function on all the TSC pins using HAL_xxxx() function.
|
||
|
|
|
||
|
|
(#) Interrupts configuration
|
||
|
|
(++) Configure the NVIC (if the interrupt model is used) using HAL_xxx() function.
|
||
|
|
|
||
|
|
(#) TSC configuration
|
||
|
|
(++) Configure all TSC parameters and used TSC IOs using HAL_TSC_Init() function.
|
||
|
|
|
||
|
|
*** Acquisition sequence ***
|
||
|
|
===================================
|
||
|
|
[..]
|
||
|
|
(+) Discharge all IOs using HAL_TSC_IODischarge() function.
|
||
|
|
(+) Wait a certain time allowing a good discharge of all capacitors. This delay depends
|
||
|
|
of the sampling capacitor and electrodes design.
|
||
|
|
(+) Select the channel IOs to be acquired using HAL_TSC_IOConfig() function.
|
||
|
|
(+) Launch the acquisition using either HAL_TSC_Start() or HAL_TSC_Start_IT() function.
|
||
|
|
If the synchronized mode is selected, the acquisition will start as soon as the signal
|
||
|
|
is received on the synchro pin.
|
||
|
|
(+) Wait the end of acquisition using either HAL_TSC_PollForAcquisition() or
|
||
|
|
HAL_TSC_GetState() function or using WFI instruction for example.
|
||
|
|
(+) Check the group acquisition status using HAL_TSC_GroupGetStatus() function.
|
||
|
|
(+) Read the acquisition value using HAL_TSC_GroupGetValue() function.
|
||
|
|
|
||
|
|
@endverbatim
|
||
|
|
******************************************************************************
|
||
|
|
* @attention
|
||
|
|
*
|
||
|
|
* <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
||
|
|
* are permitted provided that the following conditions are met:
|
||
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
||
|
|
* this list of conditions and the following disclaimer.
|
||
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||
|
|
* this list of conditions and the following disclaimer in the documentation
|
||
|
|
* and/or other materials provided with the distribution.
|
||
|
|
* 3. Neither the name of STMicroelectronics nor the names of its contributors
|
||
|
|
* may be used to endorse or promote products derived from this software
|
||
|
|
* without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*
|
||
|
|
******************************************************************************
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* Includes ------------------------------------------------------------------*/
|
||
|
|
#include "stm32f0xx_hal.h"
|
||
|
|
|
||
|
|
#ifdef HAL_TSC_MODULE_ENABLED
|
||
|
|
|
||
|
|
#if defined(STM32F051x8) || defined(STM32F071xB) || defined(STM32F091xC) || \
|
||
|
|
defined(STM32F042x6) || defined(STM32F072xB) || \
|
||
|
|
defined(STM32F048xx) || defined(STM32F058xx) || defined(STM32F078xx) || defined(STM32F098xx)
|
||
|
|
|
||
|
|
/** @addtogroup STM32F0xx_HAL_Driver
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC TSC
|
||
|
|
* @brief TSC HAL module driver
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* Private typedef -----------------------------------------------------------*/
|
||
|
|
/* Private define ------------------------------------------------------------*/
|
||
|
|
/* Private macro -------------------------------------------------------------*/
|
||
|
|
/* Private variables ---------------------------------------------------------*/
|
||
|
|
/* Private function prototypes -----------------------------------------------*/
|
||
|
|
static uint32_t TSC_extract_groups(uint32_t iomask);
|
||
|
|
/* Exported functions ---------------------------------------------------------*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Exported_Functions TSC Exported Functions
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Exported_Functions_Group1 Initialization/de-initialization functions
|
||
|
|
* @brief Initialization and Configuration functions
|
||
|
|
*
|
||
|
|
@verbatim
|
||
|
|
===============================================================================
|
||
|
|
##### Initialization and de-initialization functions #####
|
||
|
|
===============================================================================
|
||
|
|
[..] This section provides functions allowing to:
|
||
|
|
(+) Initialize and configure the TSC.
|
||
|
|
(+) De-initialize the TSC.
|
||
|
|
@endverbatim
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Initializes the TSC peripheral according to the specified parameters
|
||
|
|
* in the TSC_InitTypeDef structure.
|
||
|
|
* @param htsc TSC handle
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_Init(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Check TSC handle allocation */
|
||
|
|
if (htsc == NULL)
|
||
|
|
{
|
||
|
|
return HAL_ERROR;
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
assert_param(IS_TSC_CTPH(htsc->Init.CTPulseHighLength));
|
||
|
|
assert_param(IS_TSC_CTPL(htsc->Init.CTPulseLowLength));
|
||
|
|
assert_param(IS_TSC_SS(htsc->Init.SpreadSpectrum));
|
||
|
|
assert_param(IS_TSC_SSD(htsc->Init.SpreadSpectrumDeviation));
|
||
|
|
assert_param(IS_TSC_SS_PRESC(htsc->Init.SpreadSpectrumPrescaler));
|
||
|
|
assert_param(IS_TSC_PG_PRESC(htsc->Init.PulseGeneratorPrescaler));
|
||
|
|
assert_param(IS_TSC_MCV(htsc->Init.MaxCountValue));
|
||
|
|
assert_param(IS_TSC_IODEF(htsc->Init.IODefaultMode));
|
||
|
|
assert_param(IS_TSC_SYNC_POL(htsc->Init.SynchroPinPolarity));
|
||
|
|
assert_param(IS_TSC_ACQ_MODE(htsc->Init.AcquisitionMode));
|
||
|
|
assert_param(IS_TSC_MCE_IT(htsc->Init.MaxCountInterrupt));
|
||
|
|
|
||
|
|
if(htsc->State == HAL_TSC_STATE_RESET)
|
||
|
|
{
|
||
|
|
/* Allocate lock resource and initialize it */
|
||
|
|
htsc->Lock = HAL_UNLOCKED;
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Initialize the TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_BUSY;
|
||
|
|
|
||
|
|
/* Init the low level hardware : GPIO, CLOCK, CORTEX */
|
||
|
|
HAL_TSC_MspInit(htsc);
|
||
|
|
|
||
|
|
/*--------------------------------------------------------------------------*/
|
||
|
|
/* Set TSC parameters */
|
||
|
|
|
||
|
|
/* Enable TSC */
|
||
|
|
htsc->Instance->CR = TSC_CR_TSCE;
|
||
|
|
|
||
|
|
/* Set all functions */
|
||
|
|
htsc->Instance->CR |= (htsc->Init.CTPulseHighLength |
|
||
|
|
htsc->Init.CTPulseLowLength |
|
||
|
|
(uint32_t)(htsc->Init.SpreadSpectrumDeviation << 17U) |
|
||
|
|
htsc->Init.SpreadSpectrumPrescaler |
|
||
|
|
htsc->Init.PulseGeneratorPrescaler |
|
||
|
|
htsc->Init.MaxCountValue |
|
||
|
|
htsc->Init.SynchroPinPolarity |
|
||
|
|
htsc->Init.AcquisitionMode);
|
||
|
|
|
||
|
|
/* Spread spectrum */
|
||
|
|
if (htsc->Init.SpreadSpectrum == ENABLE)
|
||
|
|
{
|
||
|
|
htsc->Instance->CR |= TSC_CR_SSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Disable Schmitt trigger hysteresis on all used TSC IOs */
|
||
|
|
htsc->Instance->IOHCR = (uint32_t)(~(htsc->Init.ChannelIOs | htsc->Init.ShieldIOs | htsc->Init.SamplingIOs));
|
||
|
|
|
||
|
|
/* Set channel and shield IOs */
|
||
|
|
htsc->Instance->IOCCR = (htsc->Init.ChannelIOs | htsc->Init.ShieldIOs);
|
||
|
|
|
||
|
|
/* Set sampling IOs */
|
||
|
|
htsc->Instance->IOSCR = htsc->Init.SamplingIOs;
|
||
|
|
|
||
|
|
/* Set the groups to be acquired */
|
||
|
|
htsc->Instance->IOGCSR = TSC_extract_groups(htsc->Init.ChannelIOs);
|
||
|
|
|
||
|
|
/* Clear interrupts */
|
||
|
|
htsc->Instance->IER &= (uint32_t)(~(TSC_IT_EOA | TSC_IT_MCE));
|
||
|
|
|
||
|
|
/* Clear flags */
|
||
|
|
htsc->Instance->ICR = (TSC_FLAG_EOA | TSC_FLAG_MCE);
|
||
|
|
|
||
|
|
/*--------------------------------------------------------------------------*/
|
||
|
|
|
||
|
|
/* Initialize the TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_READY;
|
||
|
|
|
||
|
|
/* Return function status */
|
||
|
|
return HAL_OK;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Deinitializes the TSC peripheral registers to their default reset values.
|
||
|
|
* @param htsc TSC handle
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_DeInit(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Check TSC handle allocation */
|
||
|
|
if (htsc == NULL)
|
||
|
|
{
|
||
|
|
return HAL_ERROR;
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
|
||
|
|
/* Change TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_BUSY;
|
||
|
|
|
||
|
|
/* DeInit the low level hardware */
|
||
|
|
HAL_TSC_MspDeInit(htsc);
|
||
|
|
|
||
|
|
/* Change TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_RESET;
|
||
|
|
|
||
|
|
/* Process unlocked */
|
||
|
|
__HAL_UNLOCK(htsc);
|
||
|
|
|
||
|
|
/* Return function status */
|
||
|
|
return HAL_OK;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Initializes the TSC MSP.
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval None
|
||
|
|
*/
|
||
|
|
__weak void HAL_TSC_MspInit(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Prevent unused argument(s) compilation warning */
|
||
|
|
UNUSED(htsc);
|
||
|
|
|
||
|
|
/* NOTE : This function should not be modified, when the callback is needed,
|
||
|
|
the HAL_TSC_MspInit could be implemented in the user file.
|
||
|
|
*/
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief DeInitializes the TSC MSP.
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval None
|
||
|
|
*/
|
||
|
|
__weak void HAL_TSC_MspDeInit(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Prevent unused argument(s) compilation warning */
|
||
|
|
UNUSED(htsc);
|
||
|
|
|
||
|
|
/* NOTE : This function should not be modified, when the callback is needed,
|
||
|
|
the HAL_TSC_MspDeInit could be implemented in the user file.
|
||
|
|
*/
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Exported_Functions_Group2 IO operation functions
|
||
|
|
* @brief IO operation functions
|
||
|
|
*
|
||
|
|
@verbatim
|
||
|
|
===============================================================================
|
||
|
|
##### 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.
|
||
|
|
(+) Get group acquisition status.
|
||
|
|
(+) Get group acquisition value.
|
||
|
|
@endverbatim
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Starts the acquisition.
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_Start(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* 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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Enables the interrupt and starts the acquisition
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval HAL status.
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_Start_IT(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* 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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Stops the acquisition previously launched in polling mode
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_Stop(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* 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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Stops the acquisition previously launched in interrupt mode
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_Stop_IT(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* 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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Gets the acquisition status for a group
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @param gx_index Index of the group
|
||
|
|
* @retval Group status
|
||
|
|
*/
|
||
|
|
TSC_GroupStatusTypeDef HAL_TSC_GroupGetStatus(TSC_HandleTypeDef* htsc, uint32_t gx_index)
|
||
|
|
{
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
assert_param(IS_GROUP_INDEX(gx_index));
|
||
|
|
|
||
|
|
/* Return the group status */
|
||
|
|
return(__HAL_TSC_GET_GROUP_STATUS(htsc, gx_index));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Gets the acquisition measure for a group
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @param gx_index Index of the group
|
||
|
|
* @retval Acquisition measure
|
||
|
|
*/
|
||
|
|
uint32_t HAL_TSC_GroupGetValue(TSC_HandleTypeDef* htsc, uint32_t gx_index)
|
||
|
|
{
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
assert_param(IS_GROUP_INDEX(gx_index));
|
||
|
|
|
||
|
|
/* Return the group acquisition counter */
|
||
|
|
return htsc->Instance->IOGXCR[gx_index];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Exported_Functions_Group3 Peripheral Control functions
|
||
|
|
* @brief Peripheral Control functions
|
||
|
|
*
|
||
|
|
@verbatim
|
||
|
|
===============================================================================
|
||
|
|
##### Peripheral Control functions #####
|
||
|
|
===============================================================================
|
||
|
|
[..] This section provides functions allowing to:
|
||
|
|
(+) Configure TSC IOs
|
||
|
|
(+) Discharge TSC IOs
|
||
|
|
@endverbatim
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Configures TSC IOs
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @param config pointer to the configuration structure.
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_IOConfig(TSC_HandleTypeDef* htsc, TSC_IOConfigTypeDef* config)
|
||
|
|
{
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
|
||
|
|
/* Process locked */
|
||
|
|
__HAL_LOCK(htsc);
|
||
|
|
|
||
|
|
/* Stop acquisition */
|
||
|
|
__HAL_TSC_STOP_ACQ(htsc);
|
||
|
|
|
||
|
|
/* Disable Schmitt trigger hysteresis on all used TSC IOs */
|
||
|
|
htsc->Instance->IOHCR = (uint32_t)(~(config->ChannelIOs | config->ShieldIOs | config->SamplingIOs));
|
||
|
|
|
||
|
|
/* Set channel and shield IOs */
|
||
|
|
htsc->Instance->IOCCR = (config->ChannelIOs | config->ShieldIOs);
|
||
|
|
|
||
|
|
/* Set sampling IOs */
|
||
|
|
htsc->Instance->IOSCR = config->SamplingIOs;
|
||
|
|
|
||
|
|
/* Set groups to be acquired */
|
||
|
|
htsc->Instance->IOGCSR = TSC_extract_groups(config->ChannelIOs);
|
||
|
|
|
||
|
|
/* Process unlocked */
|
||
|
|
__HAL_UNLOCK(htsc);
|
||
|
|
|
||
|
|
/* Return function status */
|
||
|
|
return HAL_OK;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Discharge TSC IOs
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @param choice enable or disable
|
||
|
|
* @retval HAL status
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_IODischarge(TSC_HandleTypeDef* htsc, uint32_t choice)
|
||
|
|
{
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
|
||
|
|
/* Process locked */
|
||
|
|
__HAL_LOCK(htsc);
|
||
|
|
|
||
|
|
if (choice == ENABLE)
|
||
|
|
{
|
||
|
|
__HAL_TSC_SET_IODEF_OUTPPLOW(htsc);
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
__HAL_TSC_SET_IODEF_INFLOAT(htsc);
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Process unlocked */
|
||
|
|
__HAL_UNLOCK(htsc);
|
||
|
|
|
||
|
|
/* Return the group acquisition counter */
|
||
|
|
return HAL_OK;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Exported_Functions_Group4 State functions
|
||
|
|
* @brief State functions
|
||
|
|
*
|
||
|
|
@verbatim
|
||
|
|
===============================================================================
|
||
|
|
##### State functions #####
|
||
|
|
===============================================================================
|
||
|
|
[..]
|
||
|
|
This subsection provides functions allowing to
|
||
|
|
(+) Get TSC state.
|
||
|
|
(+) Poll for acquisition completed.
|
||
|
|
(+) Handles TSC interrupt request.
|
||
|
|
|
||
|
|
@endverbatim
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Return the TSC state
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval HAL state
|
||
|
|
*/
|
||
|
|
HAL_TSC_StateTypeDef HAL_TSC_GetState(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
|
||
|
|
if (htsc->State == HAL_TSC_STATE_BUSY)
|
||
|
|
{
|
||
|
|
/* Check end of acquisition flag */
|
||
|
|
if (__HAL_TSC_GET_FLAG(htsc, TSC_FLAG_EOA) != RESET)
|
||
|
|
{
|
||
|
|
/* Check max count error flag */
|
||
|
|
if (__HAL_TSC_GET_FLAG(htsc, TSC_FLAG_MCE) != RESET)
|
||
|
|
{
|
||
|
|
/* Change TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_ERROR;
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
/* Change TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_READY;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Return TSC state */
|
||
|
|
return htsc->State;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief 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.
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval HAL state
|
||
|
|
*/
|
||
|
|
HAL_StatusTypeDef HAL_TSC_PollForAcquisition(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* 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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Handles TSC interrupt request
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval None
|
||
|
|
*/
|
||
|
|
void HAL_TSC_IRQHandler(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Check the parameters */
|
||
|
|
assert_param(IS_TSC_ALL_INSTANCE(htsc->Instance));
|
||
|
|
|
||
|
|
/* Check if the end of acquisition occured */
|
||
|
|
if (__HAL_TSC_GET_FLAG(htsc, TSC_FLAG_EOA) != RESET)
|
||
|
|
{
|
||
|
|
/* Clear EOA flag */
|
||
|
|
__HAL_TSC_CLEAR_FLAG(htsc, TSC_FLAG_EOA);
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Check if max count error occured */
|
||
|
|
if (__HAL_TSC_GET_FLAG(htsc, TSC_FLAG_MCE) != RESET)
|
||
|
|
{
|
||
|
|
/* Clear MCE flag */
|
||
|
|
__HAL_TSC_CLEAR_FLAG(htsc, TSC_FLAG_MCE);
|
||
|
|
/* Change TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_ERROR;
|
||
|
|
/* Conversion completed callback */
|
||
|
|
HAL_TSC_ErrorCallback(htsc);
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
/* Change TSC state */
|
||
|
|
htsc->State = HAL_TSC_STATE_READY;
|
||
|
|
/* Conversion completed callback */
|
||
|
|
HAL_TSC_ConvCpltCallback(htsc);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Exported_Functions_Group5 Callback functions
|
||
|
|
* @brief Callback functions
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Acquisition completed callback in non blocking mode
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval None
|
||
|
|
*/
|
||
|
|
__weak void HAL_TSC_ConvCpltCallback(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Prevent unused argument(s) compilation warning */
|
||
|
|
UNUSED(htsc);
|
||
|
|
|
||
|
|
/* NOTE : This function should not be modified, when the callback is needed,
|
||
|
|
the HAL_TSC_ConvCpltCallback could be implemented in the user file.
|
||
|
|
*/
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Error callback in non blocking mode
|
||
|
|
* @param htsc pointer to a TSC_HandleTypeDef structure that contains
|
||
|
|
* the configuration information for the specified TSC.
|
||
|
|
* @retval None
|
||
|
|
*/
|
||
|
|
__weak void HAL_TSC_ErrorCallback(TSC_HandleTypeDef* htsc)
|
||
|
|
{
|
||
|
|
/* Prevent unused argument(s) compilation warning */
|
||
|
|
UNUSED(htsc);
|
||
|
|
|
||
|
|
/* NOTE : This function should not be modified, when the callback is needed,
|
||
|
|
the HAL_TSC_ErrorCallback could be implemented in the user file.
|
||
|
|
*/
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup TSC_Private_Functions TSC Private Functions
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Utility function used to set the acquired groups mask
|
||
|
|
* @param iomask Channels IOs mask
|
||
|
|
* @retval Acquired groups mask
|
||
|
|
*/
|
||
|
|
static uint32_t TSC_extract_groups(uint32_t iomask)
|
||
|
|
{
|
||
|
|
uint32_t groups = 0U;
|
||
|
|
uint32_t idx;
|
||
|
|
|
||
|
|
for (idx = 0U; idx < TSC_NB_OF_GROUPS; idx++)
|
||
|
|
{
|
||
|
|
if ((iomask & (0x0FU << (idx * 4U))) != RESET)
|
||
|
|
{
|
||
|
|
groups |= (1U << idx);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return groups;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
#endif /* defined(STM32F051x8) || defined(STM32F071xB) || defined(STM32F091xC) || */
|
||
|
|
/* defined(STM32F042x6) || defined(STM32F072xB) || */
|
||
|
|
/* defined(STM32F048xx) || defined(STM32F058xx) || defined(STM32F078xx) || defined(STM32F098xx) */
|
||
|
|
|
||
|
|
#endif /* HAL_TSC_MODULE_ENABLED */
|
||
|
|
|
||
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|