feat(ulp_touch): support ulp touch driver on p4

L-KAYA · L-KAYA · commit ffb8adcf49ab · 2025-03-14T21:10:16.000+08:00
diff --git a/components/esp_driver_touch_sens/hw_ver1/include/driver/touch_version_types.h b/components/esp_driver_touch_sens/hw_ver1/include/driver/touch_version_types.h
@@ -19,9 +19,6 @@
 extern "C" {
 #endif
 
-#define TOUCH_MIN_CHAN_ID           0           /*!< The minimum available channel id of the touch pad */
-#define TOUCH_MAX_CHAN_ID           9           /*!< The maximum available channel id of the touch pad */
-
 /**
  * @brief Helper macro to the default configurations of the touch sensor controller
  *
diff --git a/components/esp_driver_touch_sens/hw_ver2/include/driver/touch_version_types.h b/components/esp_driver_touch_sens/hw_ver2/include/driver/touch_version_types.h
@@ -19,9 +19,6 @@
 extern "C" {
 #endif
 
-#define TOUCH_MIN_CHAN_ID           1           /*!< The minimum available channel id of the touch pad */
-#define TOUCH_MAX_CHAN_ID           14          /*!< The maximum available channel id of the touch pad */
-
 #define TOUCH_SHIELD_CHAN_ID        14          /*!< The touch channel that can be used as the shield channel */
 
 /**
diff --git a/components/esp_driver_touch_sens/hw_ver3/include/driver/touch_version_types.h b/components/esp_driver_touch_sens/hw_ver3/include/driver/touch_version_types.h
@@ -19,9 +19,6 @@
 extern "C" {
 #endif
 
-#define TOUCH_MIN_CHAN_ID           0           /*!< The minimum available channel id of the touch pad */
-#define TOUCH_MAX_CHAN_ID           13          /*!< The maximum available channel id of the touch pad */
-
 /**
  * @brief Helper macro to the default configurations of the touch sensor controller
  *
diff --git a/components/esp_driver_touch_sens/include/driver/touch_sens_types.h b/components/esp_driver_touch_sens/include/driver/touch_sens_types.h
@@ -22,6 +22,9 @@ extern "C" {
 #define TOUCH_PROXIMITY_CHAN_NUM    SOC_TOUCH_PROXIMITY_CHANNEL_NUM     /*!< The supported proximity channel number in proximity sensing mode */
 #endif
 
+#define TOUCH_MIN_CHAN_ID           SOC_TOUCH_MIN_CHAN_ID               /*!< The minimum available channel id of the touch pad */
+#define TOUCH_MAX_CHAN_ID           SOC_TOUCH_MAX_CHAN_ID               /*!< The maximum available channel id of the touch pad */
+
 /**
  * @brief The chip sleep level that allows the touch sensor to wake-up
  *
diff --git a/components/hal/esp32p4/include/hal/touch_sensor_ll.h b/components/hal/esp32p4/include/hal/touch_sensor_ll.h
@@ -584,6 +584,18 @@ static inline void touch_ll_sample_cfg_set_engaged_num(uint8_t sample_cfg_num)
     LP_ANA_PERI.touch_scan_ctrl2.freq_scan_cnt_limit = sample_cfg_num ? sample_cfg_num : 1;
 }
 
+/**
+ * Get the engaged sample configuration number
+ *
+ * @return The engaged sample configuration number, range 0~3.
+ */
+static inline uint32_t touch_ll_sample_cfg_get_engaged_num(void)
+{
+    uint32_t sample_cfg_num = LP_ANA_PERI.touch_scan_ctrl2.freq_scan_cnt_limit;
+    return sample_cfg_num ? sample_cfg_num : 1;
+}
+
+
 /**
  * Set capacitance and resistance of the RC filter of the sampling frequency.
  *
diff --git a/components/hal/esp32s2/include/hal/touch_sensor_ll.h b/components/hal/esp32s2/include/hal/touch_sensor_ll.h
@@ -1682,6 +1682,29 @@ static inline void touch_ll_sleep_read_data(uint32_t *raw_data)
     *raw_data = SENS.sar_touch_status[touch_num - 1].touch_pad_data;
 }
 
+/**
+ * Get the data of the touch channel according to the types
+ *
+ * @param sample_cfg_id The sample configuration index
+ * @param type  data type
+ *              0/1: TOUCH_LL_READ_RAW, the raw data of the touch channel
+ *              2:   TOUCH_LL_READ_BENCHMARK, benchmark value of touch channel,
+ *                   the benchmark value is the maximum during the first measurement period
+ *              3:   TOUCH_LL_READ_SMOOTH, the smoothed data that obtained by filtering the raw data.
+ * @param smooth_data pointer to smoothed data
+ */
+__attribute__((always_inline))
+static inline void touch_ll_sleep_read_chan_data(uint8_t type, uint32_t *data)
+{
+    SENS.sar_touch_conf.touch_data_sel = type;
+    if (type == TOUCH_LL_READ_RAW) {
+        uint32_t touch_num = RTCCNTL.touch_slp_thres.touch_slp_pad;
+        *data = SENS.sar_touch_status[touch_num - 1].touch_pad_data;
+    } else {
+        *data = SENS.sar_touch_slp_status.touch_slp_data;
+    }
+}
+
 /**
  * Select touch sensor dbias to save power in sleep mode.
  *
diff --git a/components/hal/esp32s3/include/hal/touch_sensor_ll.h b/components/hal/esp32s3/include/hal/touch_sensor_ll.h
@@ -1718,6 +1718,29 @@ static inline void touch_ll_sleep_read_data(uint32_t *raw_data)
     *raw_data = SENS.sar_touch_status[touch_num - 1].touch_pad_data;
 }
 
+/**
+ * Get the data of the touch channel according to the types
+ *
+ * @param sample_cfg_id The sample configuration index
+ * @param type  data type
+ *              0/1: TOUCH_LL_READ_RAW, the raw data of the touch channel
+ *              2:   TOUCH_LL_READ_BENCHMARK, benchmark value of touch channel,
+ *                   the benchmark value is the maximum during the first measurement period
+ *              3:   TOUCH_LL_READ_SMOOTH, the smoothed data that obtained by filtering the raw data.
+ * @param smooth_data pointer to smoothed data
+ */
+__attribute__((always_inline))
+static inline void touch_ll_sleep_read_chan_data(uint8_t type, uint32_t *data)
+{
+    SENS.sar_touch_conf.touch_data_sel = type;
+    if (type == TOUCH_LL_READ_RAW) {
+        uint32_t touch_num = RTCCNTL.touch_slp_thres.touch_slp_pad;
+        *data = SENS.sar_touch_status[touch_num - 1].touch_pad_data;
+    } else {
+        *data = SENS.sar_touch_slp_status.touch_slp_data;
+    }
+}
+
 
 /**
  * Select touch sensor dbias to save power in sleep mode.
diff --git a/components/soc/esp32/include/soc/Kconfig.soc_caps.in b/components/soc/esp32/include/soc/Kconfig.soc_caps.in
@@ -735,6 +735,14 @@ config SOC_TOUCH_SENSOR_NUM
     int
     default 10
 
+config SOC_TOUCH_MIN_CHAN_ID
+    bool
+    default n
+
+config SOC_TOUCH_MAX_CHAN_ID
+    int
+    default 9
+
 config SOC_TOUCH_SUPPORT_SLEEP_WAKEUP
     bool
     default y
diff --git a/components/soc/esp32/include/soc/soc_caps.h b/components/soc/esp32/include/soc/soc_caps.h
@@ -336,6 +336,8 @@
 /*-------------------------- TOUCH SENSOR CAPS -------------------------------*/
 #define SOC_TOUCH_SENSOR_VERSION            (1U)     /*!<Hardware version of touch sensor */
 #define SOC_TOUCH_SENSOR_NUM                (10)
+#define SOC_TOUCH_MIN_CHAN_ID               (0)     /*!< Touch minimum channel number */
+#define SOC_TOUCH_MAX_CHAN_ID               (9)     /*!< Touch maximum channel number */
 #define SOC_TOUCH_SUPPORT_SLEEP_WAKEUP      (1)
 #define SOC_TOUCH_SAMPLE_CFG_NUM            (1U)    /*!< The sample configuration number in total, each sampler can be used to sample on one frequency */
 
diff --git a/components/soc/esp32p4/include/soc/Kconfig.soc_caps.in b/components/soc/esp32p4/include/soc/Kconfig.soc_caps.in
@@ -1723,6 +1723,14 @@ config SOC_TOUCH_SENSOR_NUM
     int
     default 14
 
+config SOC_TOUCH_MIN_CHAN_ID
+    bool
+    default n
+
+config SOC_TOUCH_MAX_CHAN_ID
+    int
+    default 13
+
 config SOC_TOUCH_SUPPORT_SLEEP_WAKEUP
     bool
     default y
diff --git a/components/soc/esp32p4/include/soc/soc_caps.h b/components/soc/esp32p4/include/soc/soc_caps.h
@@ -635,6 +635,8 @@
 /*-------------------------- TOUCH SENSOR CAPS -------------------------------*/
 #define SOC_TOUCH_SENSOR_VERSION                    (3)     /*!< Hardware version of touch sensor */
 #define SOC_TOUCH_SENSOR_NUM                        (14)    /*!< Touch available channel number. Actually there are 15 Touch channels, but channel 14 is not pinned out, limit to 14 channels */
+#define SOC_TOUCH_MIN_CHAN_ID                       (0)     /*!< Touch minimum channel number */
+#define SOC_TOUCH_MAX_CHAN_ID                       (13)    /*!< Touch maximum channel number */
 
 /* Touch Sensor Features */
 #define SOC_TOUCH_SUPPORT_SLEEP_WAKEUP              (1)     /*!< Touch sensor supports sleep awake */
diff --git a/components/soc/esp32s2/include/soc/Kconfig.soc_caps.in b/components/soc/esp32s2/include/soc/Kconfig.soc_caps.in
@@ -831,6 +831,14 @@ config SOC_TOUCH_SENSOR_NUM
     int
     default 15
 
+config SOC_TOUCH_MIN_CHAN_ID
+    bool
+    default y
+
+config SOC_TOUCH_MAX_CHAN_ID
+    int
+    default 14
+
 config SOC_TOUCH_SUPPORT_BENCHMARK
     bool
     default y
diff --git a/components/soc/esp32s2/include/soc/soc_caps.h b/components/soc/esp32s2/include/soc/soc_caps.h
@@ -349,6 +349,8 @@
 /*-------------------------- TOUCH SENSOR CAPS -------------------------------*/
 #define SOC_TOUCH_SENSOR_VERSION            (2)     /*!< Hardware version of touch sensor */
 #define SOC_TOUCH_SENSOR_NUM                (15)    /*!< 15 Touch channels */
+#define SOC_TOUCH_MIN_CHAN_ID               (1)     /*!< Touch minimum channel number, (0 is internal denoise channel) */
+#define SOC_TOUCH_MAX_CHAN_ID               (14)    /*!< Touch maximum channel number */
 #define SOC_TOUCH_SUPPORT_BENCHMARK         (1)     /*!< Touch sensor supports benchmark configuration */
 #define SOC_TOUCH_SUPPORT_SLEEP_WAKEUP      (1)     /*!< Touch sensor supports sleep awake */
 #define SOC_TOUCH_SUPPORT_WATERPROOF        (1)     /*!< Touch sensor supports waterproof */
diff --git a/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in b/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in
@@ -1027,6 +1027,14 @@ config SOC_TOUCH_SENSOR_NUM
     int
     default 15
 
+config SOC_TOUCH_MIN_CHAN_ID
+    bool
+    default y
+
+config SOC_TOUCH_MAX_CHAN_ID
+    int
+    default 14
+
 config SOC_TOUCH_SUPPORT_BENCHMARK
     bool
     default y
diff --git a/components/soc/esp32s3/include/soc/soc_caps.h b/components/soc/esp32s3/include/soc/soc_caps.h
@@ -399,6 +399,8 @@
 /*-------------------------- TOUCH SENSOR CAPS -------------------------------*/
 #define SOC_TOUCH_SENSOR_VERSION                    (2)  /*!< Hardware version of touch sensor */
 #define SOC_TOUCH_SENSOR_NUM                        (15) /*!< 15 Touch channels */
+#define SOC_TOUCH_MIN_CHAN_ID                       (1)  /*!< Touch minimum channel number, (0 is internal denoise channel) */
+#define SOC_TOUCH_MAX_CHAN_ID                       (14) /*!< Touch maximum channel number */
 #define SOC_TOUCH_SUPPORT_BENCHMARK                 (1)  /*!< Touch sensor supports benchmark configuration */
 #define SOC_TOUCH_SUPPORT_SLEEP_WAKEUP              (1)  /*!< Touch sensor supports sleep awake */
 #define SOC_TOUCH_SUPPORT_WATERPROOF                (1)  /*!< Touch sensor supports waterproof */
diff --git a/components/ulp/CMakeLists.txt b/components/ulp/CMakeLists.txt
@@ -46,7 +46,11 @@ if(CONFIG_ULP_COPROC_TYPE_FSM OR CONFIG_ULP_COPROC_TYPE_RISCV)
             "ulp_riscv/ulp_riscv.c"
             "ulp_riscv/ulp_riscv_lock.c"
             "ulp_riscv/ulp_riscv_i2c.c")
+            if(CONFIG_SOC_TOUCH_SENSOR_SUPPORTED)
+                list(APPEND srcs "ulp_riscv/ulp_riscv_touch.c")
+            endif()
     endif()
+
 endif()
 
 if(CONFIG_ULP_COPROC_TYPE_LP_CORE)
@@ -77,6 +81,10 @@ if(CONFIG_ULP_COPROC_TYPE_LP_CORE)
         list(APPEND srcs "lp_core/lp_core_etm.c")
     endif()
 
+    if(CONFIG_SOC_TOUCH_SENSOR_SUPPORTED)
+        list(APPEND srcs "lp_core/lp_core_touch.c")
+    endif()
+
     if(CONFIG_SOC_LP_ADC_SUPPORTED)
         list(APPEND srcs "lp_core/shared/ulp_lp_core_lp_adc_shared.c")
     endif()
diff --git a/components/ulp/lp_core/lp_core/include/ulp_lp_core_touch.h b/components/ulp/lp_core/lp_core/include/ulp_lp_core_touch.h
@@ -0,0 +1,94 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "esp_err.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Read raw data of touch sensor on the ULP RISC-V core
+ * @note Refer `touch_pad_read_raw_data()` for more details
+ *
+ * @param touch_num     Touch pad index
+ * @param raw_data      Pointer to accept touch sensor value
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_read_raw_data(int touch_num, uint32_t *raw_data);
+
+/**
+ * @brief Read benchmark of touch sensor on the ULP RISC-V core
+ * @note Refer `touch_pad_read_benchmark()` for more details
+ *
+ * @param touch_num     Touch pad index
+ * @param benchmark     Pointer to accept touch sensor benchmark value
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_read_benchmark(int touch_num, uint32_t *benchmark);
+
+/**
+ * @brief Read the filtered (smoothened) touch sensor data on the ULP RISC-V core
+ * @note Refer `touch_pad_filter_read_smooth()` for more details
+ *
+ * @param touch_num     Touch pad index
+ * @param smooth_data   Pointer to accept smoothened touch sensor value
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_filter_read_smooth(int touch_num, uint32_t *smooth_data);
+
+/**
+ * @brief Force reset benchmark to raw data of touch sensor.
+ * @note Refer `touch_pad_reset_benchmark()` for more details
+ *
+ * @param touch_num     Touch pad index (TOUCH_PAD_MAX resets basaline of all channels)
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_reset_benchmark(int touch_num);
+
+/**
+ * @brief Read raw data of touch sensor sleep channel on the ULP RISC-V core
+ * @note Refer `touch_pad_sleep_channel_read_data()` for more details
+ *
+ * @param touch_num     Touch pad index (Only one touch sensor channel is supported in deep sleep)
+ * @param raw_data      Pointer to accept touch sensor value
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_sleep_channel_read_data(int touch_num, uint32_t *raw_data);
+
+/**
+ * @brief Read benchmark of touch sensor sleep channel on the ULP RISC-V core
+ * @note Refer `touch_pad_sleep_channel_read_benchmark()` for more details
+ *
+ * @param touch_num     Touch pad index (Only one touch sensor channel is supported in deep sleep)
+ * @param benchmark     Pointer to accept touch sensor benchmark value
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_sleep_channel_read_benchmark(int touch_num, uint32_t *benchmark);
+
+/**
+ * @brief Read the filtered (smoothened) touch sensor sleep channel data on the ULP RISC-V core
+ * @note Refer `touch_pad_sleep_channel_read_smooth()` for more details
+ *
+ * @param touch_num     Touch pad index (Only one touch sensor channel is supported in deep sleep)
+ * @param smooth_data   Pointer to accept smoothened touch sensor value
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_sleep_channel_read_smooth(int touch_num, uint32_t *smooth_data);
+
+/**
+ * @brief Reset benchmark of touch sensor sleep channel.
+ * @note Refer `touch_pad_sleep_channel_reset_benchmark()` for more details
+ *
+ * @return esp_err_t    ESP_OK when successful
+ */
+esp_err_t lp_core_touch_pad_sleep_channel_reset_benchmark(void);
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/components/ulp/lp_core/lp_core/lp_core_touch.c b/components/ulp/lp_core/lp_core/lp_core_touch.c
diff --git a/components/ulp/ulp_riscv/ulp_core/ulp_riscv_touch.c b/components/ulp/ulp_riscv/ulp_core/ulp_riscv_touch.c

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,6 @@`
`19`	`19`	`extern "C" {`
`20`	`20`	`#endif`
`21`	`21`
`22`		`-#define TOUCH_MIN_CHAN_ID 0 /!< The minimum available channel id of the touch pad /`
`23`		`-#define TOUCH_MAX_CHAN_ID 9 /!< The maximum available channel id of the touch pad /`
`24`		`-`
`25`	`22`	`/**`
`26`	`23`	`* @brief Helper macro to the default configurations of the touch sensor controller`
`27`	`24`	`*`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ extern "C" {`
`22`	`22`	`#define TOUCH_PROXIMITY_CHAN_NUM SOC_TOUCH_PROXIMITY_CHANNEL_NUM /!< The supported proximity channel number in proximity sensing mode /`
`23`	`23`	`#endif`
`24`	`24`
	`25`	`+#define TOUCH_MIN_CHAN_ID SOC_TOUCH_MIN_CHAN_ID /!< The minimum available channel id of the touch pad /`
	`26`	`+#define TOUCH_MAX_CHAN_ID SOC_TOUCH_MAX_CHAN_ID /!< The maximum available channel id of the touch pad /`
	`27`	`+`
`25`	`28`	`/**`
`26`	`29`	`* @brief The chip sleep level that allows the touch sensor to wake-up`
`27`	`30`	`*`