Skip to content

Commit 788dd63

Browse files
Steven Wangnashif
authored andcommitted
Test: add doxygen comment for test_pipe_thread2thread().
Add doxygen comments for details of test_pipe_thread2thread(). By the way, plan to do the same thing to all test cases in test_pipe_contexts.c. Signed-off-by: Steven Wang <steven.l.wang@linux.intel.com>
1 parent 06aedc4 commit 788dd63

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

tests/kernel/pipe/pipe_api/src/test_pipe_contexts.c

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,48 @@ static void thread_for_block_put(void *p1, void *p2, void *p3)
176176

177177
/**
178178
* @brief Test pipe data passing between threads
179+
*
180+
* @ingroup kernel_pipe_tests
181+
*
182+
* @details
183+
* Test Objective:
184+
* - Verify data passing with "pipe put/get" APIs between
185+
* threads
186+
*
187+
* Testing techniques:
188+
* - function and block box testing,Interface testing,
189+
* Dynamic analysis and testing.
190+
*
191+
* Prerequisite Conditions:
192+
* - CONFIG_TEST_USERSPACE.
193+
*
194+
* Input Specifications:
195+
* - N/A
196+
*
197+
* Test Procedure:
198+
* -# Initialize a pipe, which is defined at run time.
199+
* -# Create a thread (A).
200+
* -# In A thread, check if it can get data, which is sent
201+
* by main thread via the pipe.
202+
* -# In A thread, send data to main thread via the pipe.
203+
* -# In main thread, send data to A thread via the pipe.
204+
* -# In main thread, check if it can get data, which is sent
205+
* by A thread.
206+
* -# Do the same testing with a pipe, which is defined at compile
207+
* time
208+
*
209+
* Expected Test Result:
210+
* - Data can be sent/received between threads.
211+
*
212+
* Pass/Fail Criteria:
213+
* - Successful if check points in test procedure are all passed, otherwise failure.
214+
*
215+
* Assumptions and Constraints:
216+
* - N/A
217+
*
179218
* @see k_pipe_init(), k_pipe_put(), #K_PIPE_DEFINE(x)
180219
*/
220+
181221
void test_pipe_thread2thread(void)
182222
{
183223
/**TESTPOINT: test k_pipe_init pipe*/

0 commit comments

Comments
 (0)