diff --git a/FreeRTOS-Plus/README.md b/FreeRTOS-Plus/README.md new file mode 100644 index 0000000000..d7f63ad699 --- /dev/null +++ b/FreeRTOS-Plus/README.md @@ -0,0 +1,23 @@ +## Directories: + ++ The **FreeRTOS/Source** directory contains source code for some of the + FreeRTOS+ components. These subdirectories contain further readme files and + links to documentation. + ++ The **FreeRTOS/Demo** directory contains a demo application for every most of + the FreeRTOS+ components. Lots of the demo applications use the FreeRTOS + Windows simulator for easy evaluation. Be aware that FreeRTOS is much slower + and not deterministic when executed in a simulated environment. + ++ The **FreeRTOS/Test** directory contains tests for some of the FreeRTOS+ + components. These tests verify the functional correctness of FreeRTOS+ components. + ++ The **FreeRTOS-Plus/VisualStudio_StaticProjects** directory contains configuration + files and Visual Studio projects for FreeRTOS components and some third party + libraries. These projects are used by the demo applications in the + FreeRTOS-Plus/Demo directory. + ++ The **FreeRTOS-Plus/ThirdParty** directory contains third party libraries used by + the demo applications in the FreeRTOS-Plus/Demo directory. + ++ See http://www.freertos.org/plus \ No newline at end of file diff --git a/FreeRTOS-Plus/Test/README.md b/FreeRTOS-Plus/Test/README.md index bb16f7f8a5..e7120e00d8 100644 --- a/FreeRTOS-Plus/Test/README.md +++ b/FreeRTOS-Plus/Test/README.md @@ -1,13 +1,5 @@ -## Testing in FreeRTOS -FreeRTOS (kernel and libraries) consists of common code and porting layer. Extensive [static analysis](https://en.wikipedia.org/wiki/Static_program_analysis) and [dynamic analysis](https://en.wikipedia.org/wiki/Dynamic_program_analysis) are done on both to ensure functional correctness of FreeRTOS. - -Additional bounded-ness checks are done using [CBMC](https://www.cprover.org/cbmc/). Although these checks do not cover all functions, they cover considerable chunk of code base. Missing CBMC tests will be added later. - -For more information on FreeRTOS testing please refer to https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html. - ## Directory structure -This directory is in working progress -- we are migrating scattered test cases to this directory. Here only lists what's currently under this directory. -- ```./CBMC```: This directory contains automated proofs of the memory safety of various parts of the FreeRTOS code base. -- ```./CMock```: This directory has the submoduled version of CMock for providing basis Unit testing -- ```./Unit-Tests```: This directory has the Unit tests for FreeRTOS-Plus libraries. As of now, just Unit tests for +TCP (testing these). +- ```./CMock```: This directory has the submoduled version of CMock for providing basis for Unit testing. +- ```./FreeRTOS```-Cellular-Interface/Integration: This directory contains integration tests for FreeRTOS-Cellular-Interface library. +- ```./FreeRTOS-Plus```-TCP/Integration: This directory contains integration tests for FreeRTOS-Plus_TCP library. diff --git a/FreeRTOS-Plus/readme.txt b/FreeRTOS-Plus/readme.txt deleted file mode 100644 index 9854164890..0000000000 --- a/FreeRTOS-Plus/readme.txt +++ /dev/null @@ -1,13 +0,0 @@ -Directories: - -+ The FreeRTOS-Plus/Source directory contains source code for some of the - FreeRTOS+ components. These subdirectories contain further readme files and - links to documentation. - -+ The FreeRTOS-Plus/Demo directory contains a demo application for every most of - the FreeRTOS+ components. Lots of the demo applications use the FreeRTOS - Windows simulator for easy evaluation. Be aware that FreeRTOS is much slower - and not deterministic when executed in a simulated environment. - -+ See http://www.freertos.org/plus - diff --git a/FreeRTOS/Test/README.md b/FreeRTOS/Test/README.md index 7a37272ca6..66c6c45607 100644 --- a/FreeRTOS/Test/README.md +++ b/FreeRTOS/Test/README.md @@ -7,4 +7,6 @@ For more information on FreeRTOS testing please refer to https://www.freertos.or This directory is in working progress -- we are migrating scattered test cases to this directory. Here only lists what's currently under this directory. - ```./CBMC```: This directory contains automated proofs of the memory safety of various parts of the FreeRTOS code base. +- ```./CMock```: This directory contains unit tests for verification of functional correctness of FreeRTOS Kernel APIs. +- ```./Target```: This directory contains integration tests which run on target devices to verify functional correctness of FreeRTOS Kernel APIs. - ```./VeriFast```: This directory contains automated proofs of the functional correctness of various parts of the FreeRTOS code base.