test_stack: Make file header doxygen compliant

Change-Id: I9bfc678ad4a6abe144f9486fac34fbb34e2dd716
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
This commit is contained in:
Peter Mitsis 2016-01-04 10:38:23 -05:00 committed by Anas Nashif
commit 0032dbe8ad

View file

@ -1,5 +1,3 @@
/* stack.c - test nanokernel stack APIs */
/* /*
* Copyright (c) 2012-2014 Wind River Systems, Inc. * Copyright (c) 2012-2014 Wind River Systems, Inc.
* *
@ -17,33 +15,35 @@
*/ */
/* /*
DESCRIPTION * @file
This module tests three basic scenarios with the usage of the following STACK * @brief Test nanokernel stack APIs
routines: *
* This module tests three basic scenarios with the usage of the following
nano_fiber_stack_pop, nano_fiber_stack_pop_wait, nano_fiber_stack_push * STACK routines:
nano_task_stack_pop, nano_task_stack_pop_wait, nano_task_stack_push *
nano_isr_stack_pop, nano_isr_stack_push * nano_fiber_stack_pop, nano_fiber_stack_pop_wait, nano_fiber_stack_push
* nano_task_stack_pop, nano_task_stack_pop_wait, nano_task_stack_push
Scenario #1 * nano_isr_stack_pop, nano_isr_stack_push
Task enters items into a queue, starts the fiber and waits for a semaphore. *
Fiber extracts all items from the queue and enters some items back into * Scenario #1
the queue. Fiber gives the semaphore for task to continue. Once the control * Task enters items into a queue, starts the fiber and waits for a semaphore.
is returned back to task, task extracts all items from the queue. * Fiber extracts all items from the queue and enters some items back into
* the queue. Fiber gives the semaphore for task to continue. Once the
Scenario #2 * control is returned back to task, task extracts all items from the queue.
Task enters an item into queue2, starts a fiber and extract an item from *
queue1 once the item is there. The fiber will extract an item from queue2 * Scenario #2
once the item is there and and enter an item to queue1. The flow of control * Task enters an item into queue2, starts a fiber and extract an item from
goes from task to fiber and so forth. * queue1 once the item is there. The fiber will extract an item from queue2
* once the item is there and and enter an item to queue1. The flow of control
Scenario #3 * goes from task to fiber and so forth.
Tests the ISR interfaces. Fiber2 pops an item from queue1 in ISR context. *
It then enters four items into the queue and finishes execution. Control * Scenario #3
is returned back to function testTaskStackPopW which also finished it's execution * Tests the ISR interfaces. Fiber2 pops an item from queue1 in ISR context.
and returned to main. Finally function testIsrStackFromTask is run and * It then enters four items into the queue and finishes execution. Control
it popped all data from queue1, push and pop one last item to the queue. All * is returned back to function testTaskStackPopW which also finished it's
these are run in ISR context. * execution and returned to main. Finally function testIsrStackFromTask is
* run and it popped all data from queue1, push and pop one last item to the
* queue. All these are run in ISR context.
*/ */
#include <tc_util.h> #include <tc_util.h>