Restructure pack directories

.github/workflows/libs.yml

@@ -45,14 +45,14 @@ jobs:
           path: /home/runner/.vcpkg
 
       - name: Prepare vcpkg env
-        working-directory: ./CMSIS/RTOS2/RTX/Library
+        working-directory: ./Library
         run: |  
           . <(curl https://aka.ms/vcpkg-init.sh -L)
           vcpkg x-update-registry --all
           vcpkg activate
 
       - name: Activate Arm tool license
-        working-directory: ./CMSIS/RTOS2/RTX/Library
+        working-directory: ./Library
         run: |
           . /home/runner/.vcpkg/vcpkg-init
           vcpkg activate
@@ -63,7 +63,7 @@ jobs:
           fi
 
       - name: Build libraries
-        working-directory: ./CMSIS/RTOS2/RTX/Library
+        working-directory: ./Library
         run: |
           . /home/runner/.vcpkg/vcpkg-init
           vcpkg activate
@@ -78,7 +78,7 @@ jobs:
 
       - name: Deactivate Arm tool license
         if: always()
-        working-directory: ./CMSIS/RTOS2/RTX/Library
+        working-directory: ./Library
         run: |
           . /home/runner/.vcpkg/vcpkg-init
           vcpkg activate
@@ -89,12 +89,12 @@ jobs:
           fi
     
       - name: Archive libraries
-        working-directory: ./CMSIS/RTOS2/RTX/Library
+        working-directory: ./Library
         run: |
           tar -cvjf RTX_Lib.tar.bz2 ARM/* GCC/* CLANG/*
     
       - name: Upload Library archive
         uses: actions/upload-artifact@v3
         with:
           name: RTX_Lib
-          path: ./CMSIS/RTOS2/RTX/Library/RTX_Lib.tar.bz2
+          path: ./Library/RTX_Lib.tar.bz2

.github/workflows/pack.yaml

@@ -27,15 +27,15 @@ jobs:
 
       - name: Fetch pre-built libs
         run: |
-          ./CMSIS/RTOS2/RTX/Library/fetch_libs.sh
+          ./Library/fetch_libs.sh
 
       - uses: Open-CMSIS-Pack/gen-pack-action@main
         with:
           doxygen-version: 1.9.6
           packchk-version: 1.4.1
-          gen-doc-script: ./CMSIS/DoxyGen/gen_doc.sh
-          check-links-script: ./CMSIS/DoxyGen/check_links.sh
-          doc-path: ./CMSIS/Documentation/html
+          gen-doc-script: ./Documentation/DoxyGen/gen_doc.sh
+          check-links-script: ./Documentation/DoxyGen/check_links.sh
+          doc-path: ./Documentation/html
           gen-pack-script: ./gen_pack.sh --no-preprocess
           gen-pack-output: ./output
           gh-pages-branch: gh-pages

.gitignore

@@ -1,6 +1,6 @@
 *.bak
-CMSIS/Documentation/html
-CMSIS/DoxyGen/rtx.dxy
+Documentation/html
+Documentation/DoxyGen/rtx.dxy
 build
 output
 **.DS_STORE

CMSIS/DoxyGen/check_links.sh → Documentation/DoxyGen/check_links.sh

@@ -55,4 +55,4 @@ find_linkchecker
 
 #########################################
 
-check_links "${DIRNAME}/../Documentation/index.html" "${DIRNAME}"
+check_links "${DIRNAME}/../index.html" "${DIRNAME}"

CMSIS/DoxyGen/gen_doc.sh → Documentation/DoxyGen/gen_doc.sh

@@ -16,7 +16,7 @@ set -o pipefail
 REQUIRED_GEN_PACK_LIB="0.8.4"
 
 DIRNAME=$(dirname $(readlink -f $0))
-GENDIR=../Documentation
+GENDIR=../
 REQ_DXY_VERSION="1.9.6"
 REQ_MSCGEN_VERSION="0.20"
 
@@ -84,7 +84,7 @@ sed -e "s/{projectNumber}/${projectNumber}/" rtx.dxy.in > rtx.dxy
 echo "\"${UTILITY_DOXYGEN}\" rtx.dxy"
 "${UTILITY_DOXYGEN}" rtx.dxy
 
-mkdir -p "${DIRNAME}/../Documentation/html/search/"
+mkdir -p "${DIRNAME}/${GENDIR}/html/search/"
 cp -f "${DIRNAME}/Doxygen_Templates/search.css" "${DIRNAME}/${GENDIR}/html/search/"
 cp -f "${DIRNAME}/Doxygen_Templates/navtree.js" "${DIRNAME}/${GENDIR}/html/"
 cp -f "${DIRNAME}/Doxygen_Templates/resize.js" "${DIRNAME}/${GENDIR}/html/"

CMSIS/DoxyGen/rtx.dxy.in → Documentation/DoxyGen/rtx.dxy.in

@@ -67,7 +67,7 @@ PROJECT_LOGO           = Doxygen_Templates/cmsis_logo_white_small.png
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ../Documentation
+OUTPUT_DIRECTORY       = ../
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -933,8 +933,8 @@ INPUT                  = ./src/mainpage.md \
                          ./src/tutorial.md \
                          ./src/rtx_os.txt \
                          ./src/rtx_evr.txt \
-                         ../RTOS2/RTX/Include/rtx_os.h \
-                         ../RTOS2/RTX/Include/rtx_evr.h
+                         ../../Include/rtx_os.h \
+                         ../../Include/rtx_evr.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1067,7 +1067,7 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           = ../RTOS2/RTX/Include
+EXAMPLE_PATH           = ../../Include
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and

CMSIS/DoxyGen/src/mainpage.md → Documentation/DoxyGen/src/mainpage.md

@@ -20,21 +20,18 @@ CMSIS-RTX kernel is actively maintained in [**CMSIS-RTX GitHub repository**](htt
 
 The table below explains the content of the **ARM::CMSIS-RTX** Pack. 
 
-File/Directory                        | Content 
-:-------------------------------------|:---------------------------------------------------------
-📄 ARM.CMSIS-RTX.pdsc                 | Pack description file in CMSIS-Pack format
-📄 LICENSE                            | License Agreement (Apache 2.0)
-📂 CMSIS                              | Software components folder
- ┣ 📂 Documentation                   | A local copy of this documentation
- ┗ 📂 RTOS2                           | RTOS implementation files
-   ┣ 📂 RTX                 | Directory with RTX specific files.
-    ┣ 📂 Config        | RTX configuration files **RTX_Config.h** and **RTX_Config.c**
-    ┣ 📂 Examples      | Example projects (MDK uVision and CMSIS-Toolbox)
-    ┣ 📂 Include       | Public header files of RTX software component
-    ┣ 📂 Library       | Project files to build pre-built libraries
-    ┣ 📂 Source        | Private header and source files of RTX software component
-    ┣ 📂 Template      | User code templates for creating application projects with CMSIS-RTX
-    ┗ 📄 RTX5.scvd     | SCVD file for RTOS-aware debugging with [Component Viewer and Event Recorder](https://arm-software.github.io/CMSIS-View/latest/index.html)
+File/Directory        | Content 
+:---------------------|:---------------------------------------------------------
+┣ 📂 Config           | RTX configuration files **RTX_Config.h** and **RTX_Config.c**
+┣ 📂 Documentation    | A local copy of this documentation
+┣ 📂 Examples         | Example projects (MDK uVision and CMSIS-Toolbox)
+┣ 📂 Include          | Public header files of RTX software component
+┣ 📂 Library          | Library project files and pre-built libraries
+┣ 📂 Source           | Private header and source files of RTX software component
+┣ 📂 Template         | User code templates for creating application projects with CMSIS-RTX
+📄 ARM.CMSIS-RTX.pdsc | Pack description file in CMSIS-Pack format
+📄 LICENSE            | License Agreement (Apache 2.0)
+📄 RTX5.scvd          | SCVD file for RTOS-aware debugging with [Component Viewer and Event Recorder](https://arm-software.github.io/CMSIS-View/latest/index.html)
 
 See [CMSIS Documentation](https://arm-software.github.io/CMSIS_6/) for an overview of CMSIS software components, tools and specifications.
 

CMSIS/RTOS2/RTX/Examples/Blinky/Blinky.uvoptx → Examples/Blinky/Blinky.uvoptx

@@ -167,7 +167,7 @@
         <SubType>1</SubType>
       </ScvdPack>
       <ScvdPack>
-        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\CMSIS\RTOS2\RTX\RTX5.scvd</Filename>
+        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\RTX5.scvd</Filename>
         <Type>ARM.CMSIS-RTX.1.0.0</Type>
         <SubType>1</SubType>
       </ScvdPack>

CMSIS/RTOS2/RTX/Examples/Blinky/Blinky.uvprojx → Examples/Blinky/Blinky.uvprojx

@@ -479,15 +479,15 @@
           <targetInfo name="Simulator"/>
         </targetInfos>
       </file>
-      <file attr="config" category="source" name="CMSIS\RTOS2\RTX\Config\RTX_Config.c" version="5.2.0">
+      <file attr="config" category="source" name="Config\RTX_Config.c" version="5.2.0">
         <instance index="0">RTE\CMSIS\RTX_Config.c</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>
         <targetInfos>
           <targetInfo name="Simulator"/>
         </targetInfos>
       </file>
-      <file attr="config" category="header" name="CMSIS\RTOS2\RTX\Config\RTX_Config.h" version="5.6.0">
+      <file attr="config" category="header" name="Config\RTX_Config.h" version="5.6.0">
         <instance index="0">RTE\CMSIS\RTX_Config.h</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>

CMSIS/RTOS2/RTX/Examples/MemPool/MemPool.uvoptx → Examples/MemPool/MemPool.uvoptx

@@ -145,7 +145,7 @@
         <SubType>1</SubType>
       </ScvdPack>
       <ScvdPack>
-        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\CMSIS\RTOS2\RTX\RTX5.scvd</Filename>
+        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\RTX5.scvd</Filename>
         <Type>ARM.CMSIS-RTX.1.0.0</Type>
         <SubType>1</SubType>
       </ScvdPack>

CMSIS/RTOS2/RTX/Examples/MemPool/MemPool.uvprojx → Examples/MemPool/MemPool.uvprojx

@@ -479,15 +479,15 @@
           <targetInfo name="Simulator"/>
         </targetInfos>
       </file>
-      <file attr="config" category="source" name="CMSIS\RTOS2\RTX\Config\RTX_Config.c" version="5.2.0">
+      <file attr="config" category="source" name="Config\RTX_Config.c" version="5.2.0">
         <instance index="0">RTE\CMSIS\RTX_Config.c</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>
         <targetInfos>
           <targetInfo name="Simulator"/>
         </targetInfos>
       </file>
-      <file attr="config" category="header" name="CMSIS\RTOS2\RTX\Config\RTX_Config.h" version="5.6.0">
+      <file attr="config" category="header" name="Config\RTX_Config.h" version="5.6.0">
         <instance index="0">RTE\CMSIS\RTX_Config.h</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>

CMSIS/RTOS2/RTX/Examples/MsgQueue/MsgQueue.uvoptx → Examples/MsgQueue/MsgQueue.uvoptx

@@ -155,7 +155,7 @@
         <SubType>1</SubType>
       </ScvdPack>
       <ScvdPack>
-        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\CMSIS\RTOS2\RTX\RTX5.scvd</Filename>
+        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\RTX5.scvd</Filename>
         <Type>ARM.CMSIS-RTX.1.0.0</Type>
         <SubType>1</SubType>
       </ScvdPack>

CMSIS/RTOS2/RTX/Examples/MsgQueue/MsgQueue.uvprojx → Examples/MsgQueue/MsgQueue.uvprojx

@@ -479,15 +479,15 @@
           <targetInfo name="Simulator"/>
         </targetInfos>
       </file>
-      <file attr="config" category="source" name="CMSIS\RTOS2\RTX\Config\RTX_Config.c" version="5.2.0">
+      <file attr="config" category="source" name="Config\RTX_Config.c" version="5.2.0">
         <instance index="0">RTE\CMSIS\RTX_Config.c</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>
         <targetInfos>
           <targetInfo name="Simulator"/>
         </targetInfos>
       </file>
-      <file attr="config" category="header" name="CMSIS\RTOS2\RTX\Config\RTX_Config.h" version="5.6.0">
+      <file attr="config" category="header" name="Config\RTX_Config.h" version="5.6.0">
         <instance index="0">RTE\CMSIS\RTX_Config.h</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>

CMSIS/RTOS2/RTX/Examples/TrustZoneV8M/RTOS/CM33_ns/CM33_ns.uvoptx → Examples/TrustZoneV8M/RTOS/CM33_ns/CM33_ns.uvoptx

@@ -172,7 +172,7 @@
         </Ww>
       </WatchWindow1>
       <ScvdPack>
-        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\CMSIS\RTOS2\RTX\RTX5.scvd</Filename>
+        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\RTX5.scvd</Filename>
         <Type>ARM.CMSIS-RTX.1.0.0</Type>
         <SubType>1</SubType>
       </ScvdPack>

CMSIS/RTOS2/RTX/Examples/TrustZoneV8M/RTOS/CM33_ns/CM33_ns.uvprojx → Examples/TrustZoneV8M/RTOS/CM33_ns/CM33_ns.uvprojx

@@ -458,15 +458,15 @@
       </component>
     </components>
     <files>
-      <file attr="config" category="source" name="CMSIS\RTOS2\RTX\Config\RTX_Config.c" version="5.2.0">
+      <file attr="config" category="source" name="Config\RTX_Config.c" version="5.2.0">
         <instance index="0">RTE\CMSIS\RTX_Config.c</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5 NS"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>
         <targetInfos>
           <targetInfo name="FVP Simulation Model"/>
         </targetInfos>
       </file>
-      <file attr="config" category="header" name="CMSIS\RTOS2\RTX\Config\RTX_Config.h" version="5.6.0">
+      <file attr="config" category="header" name="Config\RTX_Config.h" version="5.6.0">
         <instance index="0">RTE\CMSIS\RTX_Config.h</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5 NS"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>

CMSIS/RTOS2/RTX/Examples/TrustZoneV8M/RTOS_Faults/CM33_ns/CM33_ns.uvoptx → Examples/TrustZoneV8M/RTOS_Faults/CM33_ns/CM33_ns.uvoptx

@@ -182,7 +182,7 @@
         </Ww>
       </WatchWindow1>
       <ScvdPack>
-        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\CMSIS\RTOS2\RTX\RTX5.scvd</Filename>
+        <Filename>C:\Arm\Packs\ARM\CMSIS-RTX\1.0.0\RTX5.scvd</Filename>
         <Type>ARM.CMSIS-RTX.1.0.0</Type>
         <SubType>1</SubType>
       </ScvdPack>

CMSIS/RTOS2/RTX/Examples/TrustZoneV8M/RTOS_Faults/CM33_ns/CM33_ns.uvprojx → Examples/TrustZoneV8M/RTOS_Faults/CM33_ns/CM33_ns.uvprojx

@@ -453,15 +453,15 @@
       </component>
     </components>
     <files>
-      <file attr="config" category="source" name="CMSIS\RTOS2\RTX\Config\RTX_Config.c" version="5.2.0">
+      <file attr="config" category="source" name="Config\RTX_Config.c" version="5.2.0">
         <instance index="0">RTE\CMSIS\RTX_Config.c</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5 NS"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>
         <targetInfos>
           <targetInfo name="FVP Simulation Model"/>
         </targetInfos>
       </file>
-      <file attr="config" category="header" name="CMSIS\RTOS2\RTX\Config\RTX_Config.h" version="5.6.0">
+      <file attr="config" category="header" name="Config\RTX_Config.h" version="5.6.0">
         <instance index="0">RTE\CMSIS\RTX_Config.h</instance>
         <component Capiversion="2.2.0" Cclass="CMSIS" Cgroup="RTOS2" Csub="Keil RTX5" Cvariant="Source" Cvendor="ARM" Cversion="5.7.0" condition="RTX5 NS"/>
         <package name="CMSIS-RTX" schemaVersion="1.7.27" url="https://www.keil.com/pack/" vendor="ARM" version="1.0.0"/>

README.md

@@ -4,23 +4,20 @@
 
 ```txt
   📦
-  ┣ 📂 .github/workflows         GitHub Action workflows
+  ┣ 📂 .github/workflows        GitHub Action workflows
      ┣ 📄 gh-pages.yml           Deployment of static documentation from gh-pages branch to GitHub Pages
      ┣ 📄 libs.yml               Build of the RTX libraries
      ┗ 📄 pack.yml               Generation/publish of the pack and documentation
-  ┣ 📂 CMSIS                     CClass CMSIS files
-     ┣ 📂 Documentation          Target directory for generated documentation
-     ┣ 📂 DoxyGen                Source directory for documentation
+  ┣ 📂 Config                   Configuration file templates
+  ┣ 📂 Documentation            Target directory for generated documentation
+     ┗ 📂 DoxyGen                Source directory for documentation
         ┣ 📄 check_links.sh      Script to check generated html documentation for broken links
         ┗ 📄 gen_doc.sh          Documentation generation script
-     ┗ 📂 RTOS2                  CGroup RTOS2 files
-        ┣ 📂 RTX                 RTX implementation
-           ┣ 📂 Config           Configuration file templates
-           ┣ 📂 Examples         Example projects (MDK uVision and CMSIS-Toolbox)
-           ┣ 📂 Include          Public header files of RTX software component
-           ┣ 📂 Library          Project files to build pre-built libraries
-           ┣ 📂 Source           Private header and source files of RTX software component
-           ┗ 📂 Template         User code template files
+  ┣ 📂 Examples                 Example projects (MDK uVision and CMSIS-Toolbox)
+  ┣ 📂 Include                  Public header files of RTX software component
+  ┣ 📂 Library                  Project files to build pre-built libraries
+  ┣ 📂 Source                   Private header and source files of RTX software component
+  ┣ 📂 Template                 User code template files
   ┣ 📄 ARM.CMSIS-RTX.pdsc        Pack description file
   ┗ 📄 gen_pack.sh               Pack generations script, see below
 ```
@@ -34,13 +31,13 @@ Some helper scripts are provided to generate the release artifacts from this rep
 Generating the HTML-formatted documentation from its Doxygen-based source is done via
 
 ```bash
-CMSIS-RTX $ ./CMSIS/DoxyGen/gen_doc.sh
+CMSIS-RTX $ ./Documentation/DoxyGen/gen_doc.sh
 ```
 
 After generating the documentation, one can check the html output for broken links:
 
 ```bash
-CMSIS-RTX $ ./CMSIS/DoxyGen/check_links.sh
+CMSIS-RTX $ ./Documentation/DoxyGen/check_links.sh
 ```
 
 Prerequisites for these scripts to succeed are: