touch_sensor: move unit tests to test_app

components/driver/test_apps/touch_sensor_v2/CMakeLists.txt

@@ -0,0 +1,5 @@
+# This is the project CMakeLists.txt file for the test subproject
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(touch_sensor_v2_test)

components/driver/test_apps/touch_sensor_v2/README.md

@@ -0,0 +1,2 @@
+| Supported Targets | ESP32-S2 | ESP32-S3 |
+| ----------------- | -------- | -------- |

components/driver/test_apps/touch_sensor_v2/main/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "test_app_main.c" "test_touch_v2.c" "touch_scope.c"
+                       WHOLE_ARCHIVE
+)

components/driver/test_apps/touch_sensor_v2/main/test_app_main.c

@@ -0,0 +1,41 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "unity.h"
+#include "unity_test_runner.h"
+#include "esp_heap_caps.h"
+
+// que_touch may be created in any case and reused among all cases so we can't free it, the threshold is left for that
+#define TEST_MEMORY_LEAK_THRESHOLD (-500)
+
+static size_t before_free_8bit;
+static size_t before_free_32bit;
+
+static void check_leak(size_t before_free, size_t after_free, const char *type)
+{
+    ssize_t delta = after_free - before_free;
+    printf("MALLOC_CAP_%s: Before %u bytes free, After %u bytes free (delta %d)\n", type, before_free, after_free, delta);
+    TEST_ASSERT_MESSAGE(delta >= TEST_MEMORY_LEAK_THRESHOLD, "memory leak");
+}
+
+void setUp(void)
+{
+    before_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+    before_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+}
+
+void tearDown(void)
+{
+    size_t after_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+    size_t after_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+    check_leak(before_free_8bit, after_free_8bit, "8BIT");
+    check_leak(before_free_32bit, after_free_32bit, "32BIT");
+}
+
+void app_main(void)
+{
+    unity_run_menu();
+}

components/driver/test_apps/touch_sensor_v2/main/touch_scope.c

@@ -0,0 +1,187 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <string.h>
+#include "esp_err.h"
+#include "driver/uart.h"
+#include "esp_rom_uart.h"
+
+#define ROM_UART_DRIVER_ENABLE 0
+
+#if ROM_UART_DRIVER_ENABLE
+static uint8_t scope_uart_num = 0;
+static int8_t uart_used = 0;
+#else
+static uint8_t scope_uart_num = 255;
+static int8_t uart_used = -1;
+#endif
+static int scope_tx_io_num = 0;
+static int scope_rx_io_num = 0;
+static int scope_debug_baud_rate = 256000;
+static unsigned char datascope_output_buffer[42] = {0};    // Data buff.
+
+/**
+ * @brief Translate a float data to four unsigned char data for uart TX.
+ * @param target target float data address.
+ * @param buf save translated data.
+ * @param offset the start position in buf.
+ * @return
+ *     - void
+ */
+static void float_to_byte(float *target, unsigned char *buf, unsigned char offset)
+{
+    memcpy(buf + offset, (uint8_t*)target, 4);
+}
+
+/**
+ * @brief Add data to channel buff.
+ * @param Data target data.
+ * @param Channel target channel (1 - 10).
+ * @return
+ *     - void
+ */
+static void datascope_get_channel_data(float data, unsigned char channel)
+{
+    if ( (channel > 10) || (channel == 0) ) {
+        return;
+    } else {
+        switch (channel) {
+            case 1:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 2:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 3:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 4:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 5:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 6:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 7:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 8:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 9:  float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+            case 10: float_to_byte(&data,datascope_output_buffer, channel*4-3); break;
+        }
+    }
+}
+
+/**
+ * @brief Transform float data to DataScopeV1.0 data format.
+ * @param channel_num the number of channel that wait to be translated.
+ * @return
+ *     - The number of the UART TX data.
+ */
+static unsigned char datascope_data_generate(unsigned char channel_num)
+{
+    if ( (channel_num > 10) || (channel_num == 0) ) {
+        return 0;
+    } else {
+        datascope_output_buffer[0] = '$';  //frame header
+        switch(channel_num) {
+            case 1:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 2:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 3:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 4:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 5:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 6:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 7:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 8:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 9:   datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+            case 10:  datascope_output_buffer[channel_num*4+1] = channel_num*4+1; return channel_num*4+2; break;
+        }
+    }
+    return 0;
+}
+
+/**
+ * @brief Send touch sensor data to HMI in PC via UART.
+ * @param uart_num Choose uart port (0, 1).
+ * @param data The addr of the touch sensor data.
+ * @param channel_num The number of channel that wait to be translated.
+ * @return
+ *     - ESP_FAIL Error
+ *     - The number of the UART TX data.
+ */
+int test_tp_print_to_scope(float *data, unsigned char channel_num)
+{
+    uint8_t uart_num = scope_uart_num;
+
+    if (uart_num >= UART_NUM_MAX) {
+        return ESP_FAIL;
+    }
+    if ( (channel_num > 10) || (channel_num == 0) || (NULL == data) ) {
+        return ESP_FAIL;
+    }
+    for(uint8_t i = 0 ; i < channel_num; i++)  {
+        datascope_get_channel_data(data[i] , i+1); //  write data x into channel 1~10.
+    }
+    unsigned char out_len = datascope_data_generate(channel_num); //  Generate n number data.
+    unsigned char *out_data = datascope_output_buffer;
+    // Init uart.
+    if(uart_num != uart_used) {
+        return 0;
+    } else {
+#if ROM_UART_DRIVER_ENABLE
+        esp_rom_uart_tx_wait_idle(uart_num);   // Default print uart mumber is 0.
+        for(int i=0; i<out_len; i++) {
+            esp_rom_uart_tx_one_char(out_data[i]);
+        }
+        return out_len;
+#else
+        uart_wait_tx_done(uart_num, portMAX_DELAY);
+        return uart_write_bytes(uart_num, (const char *)out_data, out_len);
+#endif
+    }
+}
+
+/**
+  * @brief  Enable scope debug function. Print the touch sensor raw data to "DataScope" tool via UART.
+  *         "DataScope" tool is touch sensor tune tool. User can monitor the data of each touch channel,
+  *         evaluate the touch system's touch performance (sensitivity, SNR, stability, channel coupling)
+  *         and determine the threshold for each channel.
+  *
+  * @attention 1. Choose a UART port that will only be used for scope debug.
+  * @attention 2. Use this feature only during the testing phase.
+  * @attention 3. "DataScope" tool can be downloaded from Espressif's official website.
+  *
+  * @param  uart_num The uart port to send touch sensor raw data.
+  * @param  tx_io_num set UART TXD IO.
+  * @param  rx_io_num set UART RXD IO.
+  * @param  baud_rate set debug port baud rate.
+  *
+  * @return
+  *     - ESP_OK: succeed
+  *     - ESP_FAIL: the param uart_num is error
+  */
+esp_err_t test_tp_scope_debug_init(uint8_t uart_num, int tx_io_num, int rx_io_num, int baud_rate)
+{
+#if ROM_UART_DRIVER_ENABLE
+    esp_rom_uart_tx_wait_idle(0);   // Default print uart mumber is 0.
+    if(uart_num != 0) {
+        esp_rom_uart_set_as_console(uart_num);
+    }
+#else
+    if(uart_used == uart_num) {
+        return ESP_FAIL;
+    }
+    if (uart_num >= UART_NUM_MAX) {
+        return ESP_FAIL;
+    }
+    scope_uart_num = uart_num;
+    scope_tx_io_num = tx_io_num;
+    scope_rx_io_num = rx_io_num;
+    scope_debug_baud_rate = baud_rate;
+    uart_config_t uart_config = {
+        .baud_rate = scope_debug_baud_rate,
+        .data_bits = UART_DATA_8_BITS,
+        .parity = UART_PARITY_DISABLE,
+        .stop_bits = UART_STOP_BITS_1,
+        .flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
+    };
+    uart_param_config(uart_num, &uart_config);
+    // Set UART pins using UART0 default pins i.e. no changes
+    uart_set_pin(uart_num, scope_tx_io_num, scope_rx_io_num,
+            UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE);
+    uart_driver_install(uart_num, 1024, 2048, 0, NULL, 0);
+    uart_used = uart_num;
+#endif
+    return ESP_OK;
+}

components/driver/test_apps/touch_sensor_v2/main/touch_scope.h

@@ -0,0 +1,23 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+/**
+ * @brief Send data info to digital scope.
+ * @param data Pointer to send buff.
+ * @param channel_num The number of channels to be displayed.
+ * @return the length of successfully transmitted data.
+ */
+int test_tp_print_to_scope(float *data, unsigned char channel_num);
+
+/**
+ * @brief Initialize the UART so that the touch sensor data is output to the digital scope.
+ * @return
+ *      - ESP_OK Success
+ *      - ESP_FAIL UART error
+ */
+esp_err_t test_tp_scope_debug_init(uint8_t uart_num, int tx_io_num, int rx_io_num, int baud_rate);

components/driver/test_apps/touch_sensor_v2/pytest_touch_sensor_v2.py

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import pytest
+from pytest_embedded import Dut
+
+
+@pytest.mark.esp32s2
+@pytest.mark.esp32s3
+@pytest.mark.generic
+def test_touch_sensor_v2(dut: Dut) -> None:
+    dut.expect_exact('Press ENTER to see the list of tests')
+    dut.write('*')
+    dut.expect_unity_test_output(timeout=120)

components/driver/test_apps/touch_sensor_v2/sdkconfig.defaults

@@ -0,0 +1,2 @@
+CONFIG_FREERTOS_HZ=1000
+CONFIG_ESP_TASK_WDT=n