Upload capsense 5.0.0.6806 [2234]

Infineon · Mar 7, 2024 · a4aa930 · a4aa930
1 parent 2dc8cc7
commit a4aa930
Show file tree

Hide file tree

Showing 182 changed files with 5,007 additions and 2,206 deletions.
diff --git a/README.md b/README.md
@@ -39,15 +39,15 @@ For more information, refer to:
 * CAPSENSE™ overview:
   * [CAPSENSE™ Middleware RELEASE.md](./RELEASE.md)
   * [CAPSENSE™ Middleware API Reference Guide](https://infineon.github.io/capsense/capsense_api_reference_manual/html/index.html)
-  * [ModusToolbox™ CAPSENSE™ Configurator Tool Guide](www.cypress.com/ModusToolboxCapSenseConfig)
-  * [ModusToolbox™ CAPSENSE™ Tuner Tool Guide](www.cypress.com/ModusToolboxCapSenseTuner)
+  * [ModusToolbox™ CAPSENSE™ Configurator Tool Guide](www.infineon.com/ModusToolboxCapSenseConfig)
+  * [ModusToolbox™ CAPSENSE™ Tuner Tool Guide](www.infineon.com/ModusToolboxCapSenseTuner)
   * [CAPSENSE™ Design Guide](https://www.infineon.com/dgdl/Infineon-AN85951_PSoC_4_and_PSoC_6_MCU_CapSense_Design_Guide-ApplicationNotes-v27_00-EN.pdf?fileId=8ac78c8c7cdc391c017d0723535d4661)
   * [CSDADC Middleware API Reference Guide](https://infineon.github.io/csdadc/csdadc_api_reference_manual/html/index.html)
   * [CSDIDAC Middleware API Reference Guide](https://infineon.github.io/csdidac/csdidac_api_reference_manual/html/index.html)
 
 * ModusToolbox™ Overview:
   * [ModusToolbox™ Software Environment, Quick Start Guide, Documentation, and Videos](https://www.infineon.com/cms/en/design-support/tools/sdk/modustoolbox-software)
-  * [ModusToolbox™ Device Configurator Tool Guide](https://www.cypress.com/ModusToolboxDeviceConfig)
+  * [ModusToolbox™ Device Configurator Tool Guide](https://www.infineon.com/ModusToolboxDeviceConfig)
 
 * Infineon Technologies AG Kits and Code Examples:
   * [CAPSENSE™ Middleware Code Example for MBED OS](https://github.com/Infineon/mbed-os-example-capsense)
@@ -56,9 +56,11 @@ For more information, refer to:
   * [CY8CKIT-149 PSoC™ 4100S Plus Prototyping Kit](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-149/)
   * [CY8CKIT-041-40XX PSoC™ 4 S-Series Pioneer Kit](https://www.infineon.com/dgdl/Infineon-CY8CKIT-041-40XX_PSoC_4_S-Series_Pioneer_Kit_Quick_Start_Guide-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0efc44781263)
   * [CY8CKIT-041-41XX PSoC™ 4100S CAPSENSE™ Pioneer Kit](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-041-41xx/)
+  * [CY8CKIT-040T PSoC™ 4000T CAPSENSE™ Evaluation Kit](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-040t/)
 
 * General Information:
   * [AN210781 Getting Started with PSoC™ 6 MCU with Bluetooth Low Energy (BLE) Connectivity](https://www.infineon.com/dgdl/Infineon-AN210781_Getting_Started_with_PSoC_6_MCU_with_Bluetooth_Low_Energy_(BLE)_Connectivity_on_PSoC_Creator-ApplicationNotes-v05_00-EN.pdf?fileId=8ac78c8c7cdc391c017d0d311f536528)
+  * [AN215671 PSoC&trade; 6 MCU firmware design for BLE applications](https://www.infineon.com/cms/en/search.html#!term=AN215671&view=downloads)
   * [PSoC™ 6 Technical Reference Manual](https://www.infineon.com/dgdl/Infineon-PSoC_6_MCU_PSoC_63_with_BLE_Architecture_Technical_Reference_Manual-AdditionalTechnicalInformation-v11_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0f946fea01ca)
   * [PSoC™ 63 with BLE Datasheet Programmable System-on-Chip datasheet](https://www.infineon.com/dgdl/Infineon-PSoC_6_MCU_PSoC_63_with_BLE_Datasheet_Programmable_System-on-Chip_(PSoC)-DataSheet-v16_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0ee4efe46c37)
   * [CAT1 PDL API Reference](https://infineon.github.io/mtb-pdl-cat1/pdl_api_reference_manual/html/index.html)
@@ -69,4 +71,4 @@ For more information, refer to:
   * [Infineon Technologies](http://www.infineon.com)
 
 ---
-CYPRESS™ Semiconductor Corporation, 2019-2023.
+CYPRESS™ Semiconductor Corporation, 2019-2024.
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,4 +1,4 @@
-# CAPSENSE™ Middleware Library 4.0
+# CAPSENSE™ Middleware Library 5.0
 
 ### What is Included?
 For a complete description of the CAPSENSE™ middleware, refer to [README.md](./README.md) and [API Reference Guide](https://infineon.github.io/capsense/capsense_api_reference_manual/html/index.html).
@@ -18,14 +18,14 @@ This version of the CAPSENSE™ middleware was validated for compatibility with
 
 | Software and tools                                                                                | Version |
 | :---                                                                                              | :----:  |
-| ModusToolbox™ Software Environment                                                                | 3.1     |
-| - ModusToolbox™ Device Configurator                                                               | 4.10    |
+| ModusToolbox™ Software Environment                                                                | 3.2     |
+| - ModusToolbox™ Device Configurator                                                               | 4.20    |
 | - ModusToolbox™ MSC Superblock Personality for PSoC™ 4 devices in the Device Configurator         | 1.0     |
 | - ModusToolbox™ MSCLP Personality for PSoC™ 4 devices in the Device Configurator                  | 3.0     |
 | - ModusToolbox™ MSC Personality for PSoC™ 4 devices in the Device Configurator                    | 1.1     |
 | - ModusToolbox™ CSD Personality for PSoC™ 4 devices in the Device Configurator                    | 2.0     |
-| - ModusToolbox™ CSD Personality for PSoC™ 6 devices in the Device Configurator                    | 2.0     |
-| - ModusToolbox™ CAPSENSE™ Configurator / Tuner                                                    | 6.10    |
+| - ModusToolbox™ CSD Personality for PSoC™ 6 devices in the Device Configurator                    | 3.0     |
+| - ModusToolbox™ CAPSENSE™ Configurator / Tuner                                                    | 6.20    |
 | CAT1 Peripheral Driver Library (PDL)                                                              | 3.3.1   |
 | CAT2 Peripheral Driver Library (PDL)                                                              | 2.5.0   |
 | GCC Compiler                                                                                      | 11.3.1  |
@@ -39,15 +39,15 @@ For more information, refer to:
 * CAPSENSE™ overview:
   * [CAPSENSE™ Middleware RELEASE.md](./RELEASE.md)
   * [CAPSENSE™ Middleware API Reference Guide](https://infineon.github.io/capsense/capsense_api_reference_manual/html/index.html)
-  * [ModusToolbox™ CAPSENSE™ Configurator Tool Guide](www.cypress.com/ModusToolboxCapSenseConfig)
-  * [ModusToolbox™ CAPSENSE™ Tuner Tool Guide](www.cypress.com/ModusToolboxCapSenseTuner)
+  * [ModusToolbox™ CAPSENSE™ Configurator Tool Guide](www.infineon.com/ModusToolboxCapSenseConfig)
+  * [ModusToolbox™ CAPSENSE™ Tuner Tool Guide](www.infineon.com/ModusToolboxCapSenseTuner)
   * [CAPSENSE™ Design Guide](https://www.infineon.com/dgdl/Infineon-AN85951_PSoC_4_and_PSoC_6_MCU_CapSense_Design_Guide-ApplicationNotes-v27_00-EN.pdf?fileId=8ac78c8c7cdc391c017d0723535d4661)
   * [CSDADC Middleware API Reference Guide](https://infineon.github.io/csdadc/csdadc_api_reference_manual/html/index.html)
   * [CSDIDAC Middleware API Reference Guide](https://infineon.github.io/csdidac/csdidac_api_reference_manual/html/index.html)
 
 * ModusToolbox™ Overview:
   * [ModusToolbox™ Software Environment, Quick Start Guide, Documentation, and Videos](https://www.infineon.com/cms/en/design-support/tools/sdk/modustoolbox-software)
-  * [ModusToolbox™ Device Configurator Tool Guide](https://www.cypress.com/ModusToolboxDeviceConfig)
+  * [ModusToolbox™ Device Configurator Tool Guide](https://www.infineon.com/ModusToolboxDeviceConfig)
 
 * Infineon Technologies AG Kits and Code Examples
   * [CAPSENSE™ Middleware Code Example for MBED OS](https://github.com/Infineon/mbed-os-example-capsense)
@@ -56,9 +56,11 @@ For more information, refer to:
   * [CY8CKIT-149 PSoC™ 4100S Plus Prototyping Kit](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-149)
   * [CY8CKIT-041-40XX PSoC™ 4 S-Series Pioneer Kit](https://www.infineon.com/dgdl/Infineon-CY8CKIT-041-40XX_PSoC_4_S-Series_Pioneer_Kit_Quick_Start_Guide-UserManual-v01_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0efc44781263)
   * [CY8CKIT-041-41XX PSoC™ 4100S CAPSENSE™ Pioneer Kit](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-041-41xx/)
+  * [CY8CKIT-040T PSoC™ 4000T CAPSENSE™ Evaluation Kit](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-040t/)
 
 * General information:
   * [AN210781 Getting Started with PSoC™ 6 MCU with Bluetooth Low Energy (BLE) Connectivity](https://www.infineon.com/dgdl/Infineon-AN210781_Getting_Started_with_PSoC_6_MCU_with_Bluetooth_Low_Energy_(BLE)_Connectivity_on_PSoC_Creator-ApplicationNotes-v05_00-EN.pdf?fileId=8ac78c8c7cdc391c017d0d311f536528)
+  * [AN215671 PSoC&trade; 6 MCU firmware design for BLE applications](https://www.infineon.com/cms/en/search.html#!term=AN215671&view=downloads)
   * [PSoC™ 6 Technical Reference Manual](https://www.infineon.com/dgdl/Infineon-PSoC_6_MCU_PSoC_63_with_BLE_Architecture_Technical_Reference_Manual-AdditionalTechnicalInformation-v11_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0f946fea01ca)
   * [PSoC™ 63 with BLE Datasheet Programmable System-on-Chip datasheet](https://www.infineon.com/dgdl/Infineon-PSoC_6_MCU_PSoC_63_with_BLE_Datasheet_Programmable_System-on-Chip_(PSoC)-DataSheet-v16_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0ee4efe46c37)
   * [CAT1 PDL API Reference](https://infineon.github.io/mtb-pdl-cat1/pdl_api_reference_manual/html/index.html)
@@ -69,4 +71,4 @@ For more information, refer to:
   * [Infineon Technologies](http://www.infineon.com)
 
 ---
-CYPRESS™ Semiconductor Corporation, 2019-2023.
+CYPRESS™ Semiconductor Corporation, 2019-2024.
diff --git a/cy_capsense.h b/cy_capsense.h
@@ -1,13 +1,13 @@
 /***************************************************************************//**
 * \file cy_capsense.h
-* \version 4.0
+* \version 5.0
 *
 * \brief
 * This file includes all the header files of the CAPSENSE&trade; middleware.
 *
 ********************************************************************************
 * \copyright
-* Copyright 2018-2023, Cypress Semiconductor Corporation (an Infineon company)
+* Copyright 2018-2024, Cypress Semiconductor Corporation (an Infineon company)
 * or an affiliate of Cypress Semiconductor Corporation. All rights reserved.
 * You may use this file only in accordance with the license, terms, conditions,
 * disclaimers, and limitations in the end user license agreement accompanying
@@ -185,11 +185,11 @@
 * * The <a href="https:/\/github.com/Infineon/mtb-pdl-cat2">
 * <b>CAT2 Peripheral Driver Library (PDL)</b></a> is included in the project
 * in case if the PSoC&trade; 4 device is used.
-* * <a href="https:/\/www.cypress.com/ModusToolboxDeviceConfig">
+* * <a href="https:/\/www.infineon.com/ModusToolboxDeviceConfig">
 * <b>ModusToolbox&trade; Device Configurator Tool</b></a>,
-* <a href="https:/\/www.cypress.com/ModusToolboxCapSenseConfig">
+* <a href="https:/\/www.infineon.com/ModusToolboxCapSenseConfig">
 * <b>ModusToolbox&trade; CAPSENSE&trade; Configurator Tool</b></a>, and
-* <a href="https:/\/www.cypress.com/ModusToolboxCapSenseTuner">
+* <a href="https:/\/www.infineon.com/ModusToolboxCapSenseTuner">
 * <b>ModusToolbox&trade; CAPSENSE&trade; Tuner Tool</b></a>
 * are installed on the machine.
 *
@@ -250,11 +250,11 @@
 *   </tr>
 *   <tr>
 *     <td>ModusToolbox&trade; Software Environment</td>
-*     <td>3.1</td>
+*     <td>3.2</td>
 *   </tr>
 *   <tr>
 *     <td>- ModusToolbox&trade; Device Configurator tool</td>
-*     <td>4.10</td>
+*     <td>4.20</td>
 *   </tr>
 *   <tr>
 *     <td>- ModusToolbox&trade; MSC Superblock Personality for PSoC&trade; 4 devices in the Device Configurator tool</td>
@@ -274,11 +274,11 @@
 *   </tr>
 *   <tr>
 *     <td>- ModusToolbox&trade; CSD Personality for PSoC&trade; 6 devices in the Device Configurator tool</td>
-*     <td>2.0</td>
+*     <td>3.0</td>
 *   </tr>
 *   <tr>
 *     <td>- ModusToolbox&trade; CAPSENSE&trade; Configurator tool</td>
-*     <td>6.10</td>
+*     <td>6.20</td>
 *   </tr>
 *   <tr>
 *     <td>- ModusToolbox&trade; CAPSENSE&trade; Tuner tool</td>
@@ -661,14 +661,136 @@
 *   </tr>
 * </table>
 *
+* \note Refer to the "Errata" section of the device datasheet to get information
+* about the known problems related to the CAPSENSE&trade; HW IP block.
+*
 ********************************************************************************
 * \section section_capsense_changelog Changelog
 ********************************************************************************
 *
 * <table class="doxtable">
 *   <tr><th>Version</th><th>Changes</th><th>Reason for Change</th></tr>
 *   <tr>
-*     <td rowspan="16" >4.0</td>
+*     <td rowspan="13">5.0</td>
+*     <td colspan="2"><i><b>
+*       This version is not backward compatible with the
+*       previous version due to re-designed CDAC Auto-calibration.
+*       We tried to keep the established API, but your design may need to be
+*       updated to operate with CAPSENSE&trade; middleware v5.0.
+*       Also, if you use the CAPSENSE&trade middleware v5.0, you must use
+*       the CAPSENSE&trade Configurator v6.20 tool or later. This MW version is not
+*       compatible with the previous Configurator tool versions.
+*     </b></i>
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Re-designed CDAC Auto-calibration algorithm for the fifth-generation
+*         LP devices
+*     </td>
+*     <td>
+*         Feature enhancement
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Added auto selection mode of CIC2 decimation rate for the
+*         fifth-generation LP devices
+*     </td>
+*     <td>
+*         Feature enhancement
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Added Auto-selection mode of CDAC Dither scale value for the
+*         fifth-generation and fifth-generation LP devices
+*     </td>
+*     <td>
+*         Feature enhancement
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Added the HW IIR Filter initialization function
+*         Cy_CapSense_ScanInitializeHwIirAllSlots() and
+*         Cy_CapSense_ScanInitializeHwIirSlots() for fifth-generation LP devices
+*     </td>
+*     <td>
+*         Feature enhancement
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Corrected the low power widget scanning flow by excluding waking up at a
+*         signal detection - only the end of the frame interrupt is kept.
+*         Condition: multiple low power sensors. This will avoid multiple interrupt
+*         generation and in some cases prevent the device from hanging.
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Corrected description of the cy_stc_capsense_position_t structure
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Removed Epilogue cycles from the maximum Raw Counts definition
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Hidden a Multi-phase Self feature for fifth-generation LP devices
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Disabled the External Frame Start in the Cy_CapSense_InitializeMaxRaw()
+*         function for the fifth-generation devices
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Corrected description of the BIST measurement function
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Corrected description of the cy_stc_capsense_touch_t structure
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td>
+*         Updated description of the software watchdog time calculation for
+*         the fifth-generation devices
+*     </td>
+*     <td>
+*         Defect fixing
+*     </td>
+*   </tr>
+*   <tr>
+*     <td rowspan="17" >4.0</td>
 *     <td colspan="2"><i><b>
 *       This version is not backward compatible with the
 *       previous version due to fifth-generation LP devices support
@@ -810,6 +932,14 @@
 *     </td>
 *   </tr>
 *   <tr>
+*     <td>
+*         Added Long Press gesture
+*     </td>
+*     <td>
+*         Feature enhancement
+*     </td>
+*   </tr>
+*   <tr>
 *     <td rowspan="12">3.0</td>
 *     <td colspan="2"><i><b>
 *       This version is not backward compatible with the
@@ -1043,10 +1173,10 @@
 *
 * * CAPSENSE&trade; Overview:
 *
-*   * <a href="https:/\/www.cypress.com/ModusToolboxCapSenseConfig"><b>ModusToolbox&trade;
+*   * <a href="https:/\/www.infineon.com/ModusToolboxCapSenseConfig"><b>ModusToolbox&trade;
 *   CAPSENSE&trade; Configurator Tool Guide</b></a>
 *
-*   * <a href="https:/\/www.cypress.com/ModusToolboxCapSenseTuner"><b>ModusToolbox&trade;
+*   * <a href="https:/\/www.infineon.com/ModusToolboxCapSenseTuner"><b>ModusToolbox&trade;
 *   CAPSENSE&trade; Tuner Tool Guide</b></a>
 *
 *   * <a href="https:/\/www.infineon.com/dgdl/Infineon-AN85951_PSoC_4_and_PSoC_6_MCU_CapSense_Design_Guide-ApplicationNotes-v30_00-EN.pdf?fileId=8ac78c8c7cdc391c017d0723535d4661">
@@ -1058,7 +1188,7 @@
 *   <b>ModusToolbox&trade; Software Environment, Quick Start Guide, Documentation,
 *   and Videos</b></a>
 *
-*   * <a href="https:/\/www.cypress.com/ModusToolboxDeviceConfig"><b>ModusToolbox&trade;
+*   * <a href="https:/\/www.infineon.com/ModusToolboxDeviceConfig"><b>ModusToolbox&trade;
 *   Device Configurator Tool Guide</b></a>
 *
 * * Infineon Technologies Kits and Code Examples:
@@ -1086,6 +1216,9 @@
 *   * <a href="http:/\/www.infineon.com/cms/en/search.html#!term=AN210781&view=downloads"><b>AN210781 Getting Started with
 *   PSoC&trade; 6 MCU with Bluetooth Low Energy (BLE) Connectivity</b></a>
 *
+*   * <a href="http:/\/www.infineon.com/cms/en/search.html#!term=AN215671&view=downloads"><b>AN215671 PSoC&trade; 6 MCU
+*   firmware design for BLE applications</b></a>
+*
 *   * <a href="https:/\/www.infineon.com/cms/en/search.html#!term=psoc%206%20TRM&view=downloads">
 *   <b>PSoC&trade; 6 Technical Reference Manual</b></a>
 *

diff --git a/cy_capsense_centroid.c b/cy_capsense_centroid.c
@@ -1,14 +1,14 @@
 /***************************************************************************//**
 * \file cy_capsense_centroid.c
-* \version 4.0
+* \version 5.0
 *
 * \brief
 * This file provides the source code for the centroid calculation methods
 * of the CAPSENSE&trade; middleware.
 *
 ********************************************************************************
 * \copyright
-* Copyright 2018-2023, Cypress Semiconductor Corporation (an Infineon company)
+* Copyright 2018-2024, Cypress Semiconductor Corporation (an Infineon company)
 * or an affiliate of Cypress Semiconductor Corporation. All rights reserved.
 * You may use this file only in accordance with the license, terms, conditions,
 * disclaimers, and limitations in the end user license agreement accompanying

diff --git a/cy_capsense_centroid.h b/cy_capsense_centroid.h
@@ -1,14 +1,14 @@
 /***************************************************************************//**
 * \file cy_capsense_centroid.h
-* \version 4.0
+* \version 5.0
 *
 * \brief
 * This file provides the function prototypes for the centroid calculation
 * methods.
 *
 ********************************************************************************
 * \copyright
-* Copyright 2018-2023, Cypress Semiconductor Corporation (an Infineon company)
+* Copyright 2018-2024, Cypress Semiconductor Corporation (an Infineon company)
 * or an affiliate of Cypress Semiconductor Corporation. All rights reserved.
 * You may use this file only in accordance with the license, terms, conditions,
 * disclaimers, and limitations in the end user license agreement accompanying