]> begriffs open source - cmsis/blob - CMSIS/DoxyGen/RTOS2/src/validation.txt
Added osDelay to the list of functions that can be used with osWaitForever
[cmsis] / CMSIS / DoxyGen / RTOS2 / src / validation.txt
1 /**
2 \page rtosValidation RTOS Validation
3
4 Arm offers a <a class=el href="http://www.keil.com/pack" target="_blank">Software Pack</a> for the CMSIS-RTOS Validation.
5 The <b>ARM::CMSIS-RTOS_Validation</b> Pack contains the following:
6
7  - Source code of a CMSIS-RTOS Validation Suite along with configuration file.
8  - Documentation of the CMSIS-RTOS Validation Suite.
9  - Example that shows the usage of the CMSIS-RTOS Validation Suite using simulation.
10
11 \note
12 Currently, a public version of the test suite is available only for CMSIS-RTOS v1 API.
13
14 The CMSIS-RTOS Validation Suite performs generic validation of various RTOS features. The test cases verify the 
15 functional behavior, test invalid parameters and call management functions from ISR.
16
17 The following CMSIS-RTOS features can be tested with the current release:
18  - Thread : Create multiple threads, terminate, restart, yield, change priority 
19  - Timer : Create periodic and one-shot timers
20  - GenWait : Call generic wait functions (osDelay and osWait)
21  - WaitFunc : Measure wait ticks (delay, mail, message, mutex, semaphore, signal)
22  
23 Moreover the following inter-thread communication functions can be tested: 
24  - Signal : Verify signal events
25  - Memory Pool : Verify memory allocation
26  - Message Queue : Exchange messages between threads
27  - Mail Queue : Exchange data between threads
28  - Mutex : Synchronize resource access 
29  - Semaphore : Access shared resources 
30  
31 The RTOS Validation output can be printed to a console, output via ITM printf, or output to a memory buffer.
32  
33 \section test_output Sample Test Output
34 \verbatim
35 CMSIS-RTOS Test Suite   Oct 21 2015   16:39:16 
36
37 TEST 01: TC_ThreadCreate                  PASSED
38 TEST 02: TC_ThreadMultiInstance           PASSED
39 TEST 03: TC_ThreadTerminate               PASSED
40   :
41   :
42 TEST 08: TC_ThreadChainedCreate           PASSED
43 TEST 09: TC_ThreadYield                   NOT EXECUTED
44 TEST 10: TC_ThreadParam                   PASSED
45   :
46   :
47 TEST 60: TC_MailFromISRToThread           PASSED
48
49 Test Summary: 60 Tests, 59 Executed, 59 Passed, 0 Failed, 0 Warnings.
50 Test Result: PASSED
51 \endverbatim
52 */