Skip to content

Commit de784f7

Browse files
Ze-HouRbb666
authored andcommitted
feature: utest: add standardized utest documentation to event_tc
Signed-off-by: Ze-Hou <[email protected]>
1 parent 4103870 commit de784f7

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

src/utest/event_tc.c

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,37 @@
55
*
66
* Change Logs:
77
* Date Author Notes
8-
* 2021-08-15 liukang the first version
8+
* 2021-08-15 liukang the first version
99
* 2023-09-15 xqyjlj change stack size in cpu64
10+
* 2025-11-17 Ze-Hou add standardized utest documentation block
11+
*/
12+
13+
/**
14+
* Test Case Name: Kernel Core Event Test
15+
*
16+
* Test Objectives:
17+
* - Validate the RT-Thread kernel event (rt_event) functionality
18+
* - Test static and dynamic event object initialization, creation, deletion,
19+
* sending, receiving, and detachment APIs
20+
*
21+
* Test Scenarios:
22+
* - Initialize and detach a static event object with both PRIO and FIFO modes
23+
* - Create and delete a dynamic event object (if RT_USING_HEAP is enabled)
24+
* - Use multiple threads to send and receive event flags, testing both OR and AND logic
25+
* - Test event sending and receiving with different flag combinations and timing
26+
*
27+
* Verification Metrics:
28+
* - All uassert assertions pass without failure
29+
* - Event objects are correctly initialized, created, detached, and deleted
30+
* - Event flags are sent and received as expected, with correct logic and timing
31+
*
32+
* Dependencies:
33+
* - Enable Event Test (RT-Thread Utestcases -> Kernel Core -> Event Test)
34+
* - Test on any RT-Thread supported platform (e.g., qemu-virt64-riscv)
35+
*
36+
* Expected Results:
37+
* - After executing this test in msh, the expected output should be:
38+
* "[ PASSED ] [ result ] testcase (core.ipc_event)"
1039
*/
1140

1241
#include <rtthread.h>

0 commit comments

Comments
 (0)