mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-11-16 12:34:33 +00:00
328 lines
9.3 KiB
C
328 lines
9.3 KiB
C
/*
|
|
* Copyright (c) 2006-2025 RT-Thread Development Team
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Change Logs:
|
|
* Date Author Notes
|
|
* 2021-06-16 KyleChan the first version
|
|
* 2025-11-13 CYFS Add standardized utest documentation block
|
|
*/
|
|
|
|
/**
|
|
* Test Case Name: UART Non-Blocking RX & Blocking TX Integration Test
|
|
*
|
|
* Test Objectives:
|
|
* - Validate RX interrupt/callback based reception paired with blocking transmit path
|
|
* - Verify APIs: rt_device_find, rt_device_control(RT_DEVICE_CTRL_CONFIG / RT_SERIAL_CTRL_SET_RX_TIMEOUT),
|
|
* rt_device_open with RT_DEVICE_FLAG_RX_NON_BLOCKING | RT_DEVICE_FLAG_TX_BLOCKING,
|
|
* rt_device_set_rx_indicate, rt_device_read, rt_device_write, rt_sem APIs
|
|
*
|
|
* Test Scenarios:
|
|
* - **Scenario 1 (Callback-Driven Reception / tc_uart_api):**
|
|
* 1. Configure UART buffers (optional DMA ping buffer) and create RX semaphore.
|
|
* 2. Register `uart_rx_indicate` callback to signal semaphore whenever new bytes arrive.
|
|
* 3. For a sweep of deterministic and random lengths, launch sender/receiver threads.
|
|
* 4. Receiver waits on semaphore, drains available bytes, and enforces monotonic data ordering until quota met.
|
|
*
|
|
* Verification Metrics:
|
|
* - Received data remains sequential; `uart_result` stays `RT_TRUE`.
|
|
* - Semaphore take operations succeed; `uart_over_flag` flips upon completion.
|
|
* - UART open/close and callback registration succeed without leaks; resources cleaned in teardown.
|
|
*
|
|
* Dependencies:
|
|
* - Requires `RT_UTEST_SERIAL_V2` with loopback for `RT_SERIAL_TC_DEVICE_NAME`.
|
|
* - Non-blocking RX must support callback indication.
|
|
* - Heap must provide buffers and semaphore; two 1 KB thread stacks required.
|
|
*
|
|
* Expected Results:
|
|
* - Test executes without assertion failures; logs show iteration counts and lengths.
|
|
* - Utest harness prints `[ PASSED ] [ result ] testcase (components.drivers.serial.v2.uart_rxnb_txb)`.
|
|
*/
|
|
|
|
#include <rtthread.h>
|
|
#include "utest.h"
|
|
#include <rtdevice.h>
|
|
#include <stdlib.h>
|
|
|
|
|
|
#ifdef RT_UTEST_SERIAL_V2
|
|
|
|
static struct rt_serial_device *serial;
|
|
static rt_sem_t rx_sem;
|
|
static rt_uint8_t uart_over_flag;
|
|
static rt_bool_t uart_result = RT_TRUE;
|
|
|
|
static rt_err_t uart_find(void)
|
|
{
|
|
serial = (struct rt_serial_device *)rt_device_find(RT_SERIAL_TC_DEVICE_NAME);
|
|
|
|
if (serial == RT_NULL)
|
|
{
|
|
LOG_E("find %s device failed!\n", RT_SERIAL_TC_DEVICE_NAME);
|
|
return -RT_ERROR;
|
|
}
|
|
|
|
return RT_EOK;
|
|
}
|
|
|
|
static rt_err_t uart_rx_indicate(rt_device_t device, rt_size_t size)
|
|
{
|
|
rt_sem_release(rx_sem);
|
|
|
|
return RT_EOK;
|
|
}
|
|
|
|
static void uart_send_entry(void *parameter)
|
|
{
|
|
rt_uint8_t *uart_write_buffer;
|
|
rt_uint16_t send_len;
|
|
|
|
rt_uint32_t i = 0;
|
|
send_len = *(rt_uint16_t *)parameter;
|
|
|
|
/* assign send buffer */
|
|
uart_write_buffer = (rt_uint8_t *)rt_malloc(send_len);
|
|
if (uart_write_buffer == RT_NULL)
|
|
{
|
|
LOG_E("Without spare memory for uart dma!");
|
|
uart_result = RT_FALSE;
|
|
return;
|
|
}
|
|
|
|
rt_memset(uart_write_buffer, 0, send_len);
|
|
|
|
for (i = 0; i < send_len; i++)
|
|
{
|
|
uart_write_buffer[i] = (rt_uint8_t)i;
|
|
}
|
|
|
|
/* send buffer */
|
|
if (rt_device_write(&serial->parent, 0, uart_write_buffer, send_len) != send_len)
|
|
{
|
|
LOG_E("device write failed\r\n");
|
|
}
|
|
rt_free(uart_write_buffer);
|
|
}
|
|
|
|
static void uart_rec_entry(void *parameter)
|
|
{
|
|
rt_uint16_t rev_len;
|
|
|
|
rev_len = *(rt_uint16_t *)parameter;
|
|
rt_uint8_t *uart_write_buffer;
|
|
uart_write_buffer = (rt_uint8_t *)rt_calloc(1, rev_len + 1);
|
|
rt_int32_t cnt, i;
|
|
rt_uint8_t last_old_data;
|
|
rt_bool_t fisrt_flag = RT_TRUE;
|
|
rt_uint32_t all_receive_length = 0;
|
|
|
|
while (1)
|
|
{
|
|
rt_err_t result;
|
|
|
|
result = rt_sem_take(rx_sem, RT_WAITING_FOREVER);
|
|
if (result != RT_EOK)
|
|
{
|
|
LOG_E("take sem err in recv.");
|
|
}
|
|
|
|
cnt = rt_device_read(&serial->parent, 0, (void *)uart_write_buffer, rev_len);
|
|
if (cnt == 0)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
if (fisrt_flag != RT_TRUE)
|
|
{
|
|
if ((rt_uint8_t)(last_old_data + 1) != uart_write_buffer[0])
|
|
{
|
|
LOG_E("_Read Different data -> former data: %x, current data: %x.", last_old_data, uart_write_buffer[0]);
|
|
uart_result = RT_FALSE;
|
|
rt_free(uart_write_buffer);
|
|
return;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
fisrt_flag = RT_FALSE;
|
|
}
|
|
|
|
for (i = 0; i < cnt - 1; i++)
|
|
{
|
|
if ((rt_uint8_t)(uart_write_buffer[i] + 1) != uart_write_buffer[i + 1])
|
|
{
|
|
LOG_E("Read Different data -> former data: %x, current data: %x.", uart_write_buffer[i], uart_write_buffer[i + 1]);
|
|
|
|
uart_result = RT_FALSE;
|
|
rt_free(uart_write_buffer);
|
|
return;
|
|
}
|
|
}
|
|
all_receive_length += cnt;
|
|
if (all_receive_length >= rev_len)
|
|
break;
|
|
else
|
|
last_old_data = uart_write_buffer[cnt - 1];
|
|
}
|
|
rt_free(uart_write_buffer);
|
|
uart_over_flag = RT_TRUE;
|
|
}
|
|
|
|
static rt_err_t uart_api(rt_uint16_t test_buf)
|
|
{
|
|
rt_thread_t thread_send = RT_NULL;
|
|
rt_thread_t thread_recv = RT_NULL;
|
|
rt_err_t result = RT_EOK;
|
|
|
|
result = uart_find();
|
|
if (result != RT_EOK)
|
|
{
|
|
return -RT_ERROR;
|
|
}
|
|
|
|
rx_sem = rt_sem_create("rx_sem", 0, RT_IPC_FLAG_PRIO);
|
|
if (rx_sem == RT_NULL)
|
|
{
|
|
LOG_E("Init sem failed.");
|
|
uart_result = RT_FALSE;
|
|
return -RT_ERROR;
|
|
}
|
|
|
|
/* reinitialize */
|
|
struct serial_configure config = RT_SERIAL_CONFIG_DEFAULT;
|
|
config.baud_rate = BAUD_RATE_115200;
|
|
config.rx_bufsz = RT_SERIAL_TC_RXBUF_SIZE;
|
|
config.tx_bufsz = RT_SERIAL_TC_TXBUF_SIZE;
|
|
|
|
#ifdef RT_SERIAL_USING_DMA
|
|
config.dma_ping_bufsz = RT_SERIAL_TC_RXBUF_SIZE / 2;
|
|
#endif
|
|
rt_device_control(&serial->parent, RT_DEVICE_CTRL_CONFIG, &config);
|
|
|
|
result = rt_device_open(&serial->parent, RT_DEVICE_FLAG_RX_NON_BLOCKING | RT_DEVICE_FLAG_TX_BLOCKING);
|
|
if (result != RT_EOK)
|
|
{
|
|
LOG_E("Open uart device failed.");
|
|
uart_result = RT_FALSE;
|
|
rt_sem_delete(rx_sem);
|
|
return -RT_ERROR;
|
|
}
|
|
|
|
rt_int32_t timeout = 5000;
|
|
rt_device_control(&serial->parent, RT_SERIAL_CTRL_SET_RX_TIMEOUT, (void *)&timeout);
|
|
|
|
/* set receive callback function */
|
|
result = rt_device_set_rx_indicate(&serial->parent, uart_rx_indicate);
|
|
if (result != RT_EOK)
|
|
{
|
|
goto __exit;
|
|
}
|
|
|
|
thread_recv = rt_thread_create("uart_recv", uart_rec_entry, &test_buf, 1024, RT_THREAD_PRIORITY_MAX - 5, 10);
|
|
thread_send = rt_thread_create("uart_send", uart_send_entry, &test_buf, 1024, RT_THREAD_PRIORITY_MAX - 4, 10);
|
|
|
|
if (thread_send != RT_NULL && thread_recv != RT_NULL)
|
|
{
|
|
rt_thread_startup(thread_recv);
|
|
rt_thread_startup(thread_send);
|
|
}
|
|
else
|
|
{
|
|
result = -RT_ERROR;
|
|
goto __exit;
|
|
}
|
|
|
|
while (1)
|
|
{
|
|
if (uart_result != RT_TRUE)
|
|
{
|
|
LOG_E("The test for uart dma is failure.");
|
|
result = -RT_ERROR;
|
|
goto __exit;
|
|
}
|
|
if (uart_over_flag == RT_TRUE)
|
|
{
|
|
goto __exit;
|
|
}
|
|
/* waiting for test over */
|
|
rt_thread_mdelay(5);
|
|
}
|
|
__exit:
|
|
if (rx_sem)
|
|
rt_sem_delete(rx_sem);
|
|
rt_device_close(&serial->parent);
|
|
rt_thread_mdelay(5);
|
|
uart_over_flag = RT_FALSE;
|
|
return result;
|
|
}
|
|
|
|
static void tc_uart_api(void)
|
|
{
|
|
rt_uint32_t count = 0;
|
|
rt_uint16_t num = 0;
|
|
rt_uint32_t i = 0;
|
|
for (i = 1; i < 10; i++)
|
|
{
|
|
if (uart_api(RT_SERIAL_TC_TXBUF_SIZE * i + i % 2) == RT_EOK)
|
|
LOG_I("data_lens [%4d], it is correct to read and write data. [%d] count testing.", RT_SERIAL_TC_TXBUF_SIZE * i + i % 2, ++count);
|
|
else
|
|
{
|
|
LOG_E("uart test error");
|
|
goto __exit;
|
|
}
|
|
}
|
|
|
|
for (i = 1; i < 10; i++)
|
|
{
|
|
if (uart_api(RT_SERIAL_TC_RXBUF_SIZE * i + i % 2) == RT_EOK)
|
|
LOG_I("data_lens [%4d], it is correct to read and write data. [%d] count testing.", RT_SERIAL_TC_RXBUF_SIZE * i + i % 2, ++count);
|
|
else
|
|
{
|
|
LOG_E("uart test error");
|
|
goto __exit;
|
|
}
|
|
}
|
|
|
|
srand(rt_tick_get());
|
|
while (RT_SERIAL_TC_SEND_ITERATIONS - count)
|
|
{
|
|
num = (rand() % 1000) + 1;
|
|
if (uart_api(num) == RT_EOK)
|
|
LOG_I("data_lens [%4d], it is correct to read and write data. [%d] count testing.", num, ++count);
|
|
else
|
|
{
|
|
LOG_E("uart test error");
|
|
break;
|
|
}
|
|
}
|
|
|
|
__exit:
|
|
uassert_true(uart_result == RT_TRUE);
|
|
}
|
|
|
|
static rt_err_t utest_tc_init(void)
|
|
{
|
|
LOG_I("UART TEST: Please connect Tx and Rx directly for self testing.");
|
|
return RT_EOK;
|
|
}
|
|
|
|
static rt_err_t utest_tc_cleanup(void)
|
|
{
|
|
rx_sem = RT_NULL;
|
|
uart_result = RT_TRUE;
|
|
uart_over_flag = RT_FALSE;
|
|
rt_device_t uart_dev = rt_device_find(RT_SERIAL_TC_DEVICE_NAME);
|
|
while (rt_device_close(uart_dev) != -RT_ERROR);
|
|
return RT_EOK;
|
|
}
|
|
|
|
static void testcase(void)
|
|
{
|
|
UTEST_UNIT_RUN(tc_uart_api);
|
|
}
|
|
|
|
UTEST_TC_EXPORT(testcase, "components.drivers.serial.v2.uart_rxnb_txb", utest_tc_init, utest_tc_cleanup, 30);
|
|
|
|
#endif /* TC_UART_USING_TC */
|