esp-idf/components/driver/test/touch_sensor_test/touch_scope.c

/*
 * SPDX-FileCopyrightText: 2015-2021 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;
}