From d47145c20b52b4f9145a86e9a6c37262c4233890 Mon Sep 17 00:00:00 2001 From: Vladimir Marchenko Date: Tue, 31 Oct 2023 16:01:00 +0100 Subject: [PATCH] Doc: Varios alignment updates --- .../Doxygen/Compiler/Compiler.dxy.in | 28 +++++++++--------- .../Doxygen/Compiler/src/mainpage.md | 3 +- CMSIS/Documentation/Doxygen/Core/Core.dxy.in | 28 +++++++++--------- .../Doxygen/Core_A/Core_A.dxy.in | 28 +++++++++--------- .../Doxygen/Core_A/src/Ref_CoreRegister.txt | 4 +-- CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in | 28 +++++++++--------- CMSIS/Documentation/Doxygen/DSP/DSP.dxy.in | 28 +++++++++--------- .../Documentation/Doxygen/DSP/src/mainpage.md | 3 +- .../Doxygen/Driver/Driver.dxy.in | 28 +++++++++--------- .../Doxygen/General/General.dxy.in | 28 +++++++++--------- CMSIS/Documentation/Doxygen/NN/NN.dxy.in | 28 +++++++++--------- .../Documentation/Doxygen/NN/src/mainpage.md | 3 +- .../Documentation/Doxygen/RTOS2/RTOS2.dxy.in | 28 +++++++++--------- .../Doxygen/RTOS2/src/cmsis_os2_Thread.txt | 17 +++++------ .../Doxygen/RTOS2/src/mainpage.md | 21 ++++++++----- .../Doxygen/Stream/Stream.dxy.in | 28 +++++++++--------- .../Doxygen/Toolbox/Toolbox.dxy.in | 28 +++++++++--------- CMSIS/Documentation/Doxygen/View/View.dxy.in | 28 +++++++++--------- .../Doxygen/View/src/mainpage.md | 3 +- CMSIS/Documentation/Doxygen/Zone/Zone.dxy.in | 28 +++++++++--------- CMSIS/Documentation/Doxygen/gen_doc.sh | 8 ++--- .../Layout_forUser.xml | 0 .../Layout_forUser_Core.xml | 0 .../cmsis_logo_white_small.png | Bin .../darkmode_toggle.js | 0 .../dropdown.png | Bin .../extra_navtree.css | 0 .../extra_search.css | 0 .../extra_stylesheet.css | 0 .../footer.html | 0 .../footer.js.in | 0 .../header.html | 0 .../navtree.css | 0 .../navtree.js | 0 .../printComponentTabs.js | 0 .../resize.js | 0 .../search.css | 0 .../tab_b.png | Bin .../tab_topnav.png | Bin .../tabs.css | 0 .../version.css | 0 CMSIS/RTOS2/Include/cmsis_os2.h | 4 +-- 42 files changed, 219 insertions(+), 211 deletions(-) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/Layout_forUser.xml (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/Layout_forUser_Core.xml (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/cmsis_logo_white_small.png (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/darkmode_toggle.js (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/dropdown.png (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/extra_navtree.css (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/extra_search.css (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/extra_stylesheet.css (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/footer.html (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/footer.js.in (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/header.html (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/navtree.css (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/navtree.js (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/printComponentTabs.js (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/resize.js (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/search.css (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/tab_b.png (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/tab_topnav.png (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/tabs.css (100%) rename CMSIS/Documentation/Doxygen/{Doxygen_Templates => style_template}/version.css (100%) diff --git a/CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in b/CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in index cce5d12ea..3648f5b4b 100644 --- a/CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in +++ b/CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Retarget standard C library file, I/O and OS functions # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/Compiler/src/mainpage.md b/CMSIS/Documentation/Doxygen/Compiler/src/mainpage.md index 5f6c28d34..b87d0400d 100644 --- a/CMSIS/Documentation/Doxygen/Compiler/src/mainpage.md +++ b/CMSIS/Documentation/Doxygen/Compiler/src/mainpage.md @@ -14,8 +14,9 @@ Standard C library functions are platform independent, but the implementations o CMSIS-Compiler is maintained in a GitHub repository and is also released as a standalone package in CMSIS Pack format. - - [**CMSIS-Compiler GitHub Repo**](https://github.com/Arm-Software/CMSIS-Compiler) provides the full source code as well as releases in CMSIS-Pack format. + - [**CMSIS-Compiler GitHub Repo**](https://github.com/Arm-Software/CMSIS-Compiler) provides the full source code of CMSIS-Compiler components. - [**CMSIS-Compiler Documentation**](https://arm-software.github.io/CMSIS-Compiler/latest/) explains how to use the library and describes the implemented functions in details. + - [**CMSIS-Compiler Pack**](https://www.keil.arm.com/packs/cmsis-compiler-arm/versions/) delivers CMSIS-Compiler components and examples in [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). ## Key Features and Benefits diff --git a/CMSIS/Documentation/Doxygen/Core/Core.dxy.in b/CMSIS/Documentation/Doxygen/Core/Core.dxy.in index 351b81b6c..2b8d03810 100644 --- a/CMSIS/Documentation/Doxygen/Core/Core.dxy.in +++ b/CMSIS/Documentation/Doxygen/Core/Core.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "CMSIS-Core support for Cortex-M processor-based device # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -797,7 +797,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser_Core.xml +LAYOUT_FILE = ../style_template/Layout_forUser_Core.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1366,7 +1366,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1376,7 +1376,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1406,9 +1406,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1418,13 +1418,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in b/CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in index 4e7d96a13..f0d283e86 100644 --- a/CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in +++ b/CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "CMSIS-Core support for Cortex-A processor-based device # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser_Core.xml +LAYOUT_FILE = ../style_template/Layout_forUser_Core.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1349,7 +1349,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1359,7 +1359,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1389,9 +1389,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1401,13 +1401,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/Core_A/src/Ref_CoreRegister.txt b/CMSIS/Documentation/Doxygen/Core_A/src/Ref_CoreRegister.txt index 2c3acee18..e254f2a37 100644 --- a/CMSIS/Documentation/Doxygen/Core_A/src/Ref_CoreRegister.txt +++ b/CMSIS/Documentation/Doxygen/Core_A/src/Ref_CoreRegister.txt @@ -66,13 +66,13 @@ The ACTLR characteristics are differs between various Armv7-A implementations. | [1] | - | Reserved. | | [0] | FW | Cache and TLB maintenance broadcast. | -Consider using \ref __get_ACTLR and \ref __set_ACTRL to access ACTRL register. +Consider using \ref __get_ACTLR and \ref __set_ACTLR to access ACTRL register. @{ */ /** -\fn __STATIC_INLINE void __set_ACTRL(uint32_t actrl) +\fn __STATIC_INLINE void __set_ACTLR(uint32_t actlr) \details This function assigns the given value to the \ref CMSIS_ACTLR. diff --git a/CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in b/CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in index b5015412b..67e8b74a8 100644 --- a/CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in +++ b/CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Interface Firmware for CoreSight Debug Access Port" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/DSP/DSP.dxy.in b/CMSIS/Documentation/Doxygen/DSP/DSP.dxy.in index f67b987a9..94c45e530 100644 --- a/CMSIS/Documentation/Doxygen/DSP/DSP.dxy.in +++ b/CMSIS/Documentation/Doxygen/DSP/DSP.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "CMSIS DSP Software Library" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/DSP/src/mainpage.md b/CMSIS/Documentation/Doxygen/DSP/src/mainpage.md index adc981fd2..f33a83cde 100644 --- a/CMSIS/Documentation/Doxygen/DSP/src/mainpage.md +++ b/CMSIS/Documentation/Doxygen/DSP/src/mainpage.md @@ -12,8 +12,9 @@ CMSIS-DSP is actively maintained in a dedicated GitHub repository and is also published as a standalone release in [CMSIS Pack format](). - - [**CMSIS-DSP GitHub Repo**](https://github.com/ARM-software/CMSIS-DSP) provides the full source code as well as releases in CMSIS-Pack format. + - [**CMSIS-DSP GitHub Repo**](https://github.com/ARM-software/CMSIS-DSP) provides the full source code of CMSIS-DSP functions. - [**CMSIS-DSP Documentation**](https://arm-software.github.io/CMSIS-DSP/latest/) explains how to use the library and describes the implemented functions in details. + - [**CMSIS-DSP Pack**](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/) delivers CMSIS-DSP components and examples in [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). ## Key Features and Benefits diff --git a/CMSIS/Documentation/Doxygen/Driver/Driver.dxy.in b/CMSIS/Documentation/Doxygen/Driver/Driver.dxy.in index b280a1623..e5741d533 100644 --- a/CMSIS/Documentation/Doxygen/Driver/Driver.dxy.in +++ b/CMSIS/Documentation/Doxygen/Driver/Driver.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Peripheral Interface for Middleware and Application Co # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -797,7 +797,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1374,7 +1374,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1384,7 +1384,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1414,9 +1414,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1426,13 +1426,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/General/General.dxy.in b/CMSIS/Documentation/Doxygen/General/General.dxy.in index 62ba04572..522ff78ba 100644 --- a/CMSIS/Documentation/Doxygen/General/General.dxy.in +++ b/CMSIS/Documentation/Doxygen/General/General.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Common Microcontroller Software Interface Standard" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1332,7 +1332,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1342,7 +1342,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1372,9 +1372,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1384,13 +1384,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/NN/NN.dxy.in b/CMSIS/Documentation/Doxygen/NN/NN.dxy.in index c36a18e5f..d671554e2 100644 --- a/CMSIS/Documentation/Doxygen/NN/NN.dxy.in +++ b/CMSIS/Documentation/Doxygen/NN/NN.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "CMSIS NN Software Library" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/NN/src/mainpage.md b/CMSIS/Documentation/Doxygen/NN/src/mainpage.md index 546672da2..9849c2fdc 100644 --- a/CMSIS/Documentation/Doxygen/NN/src/mainpage.md +++ b/CMSIS/Documentation/Doxygen/NN/src/mainpage.md @@ -14,8 +14,9 @@ CMSIS-NN functions are implemented in several variants and the optimal solution CMSIS-NN is actively maintained in a GitHub repository and is also released as a standalone package in CMSIS Pack format. - - [**CMSIS-NN GitHub Repo**](https://github.com/ARM-software/CMSIS-NN) provides the full source code as well as releases in CMSIS-Pack format. + - [**CMSIS-NN GitHub Repo**](https://github.com/ARM-software/CMSIS-NN) provides the full source code of CMSIS-NN kernels. - [**CMSIS-NN Documentation**](https://arm-software.github.io/CMSIS-NN/latest/) explains how to use the library and describes the implemented functions in details. + - [**CMSIS-NN Pack**](https://www.keil.arm.com/packs/cmsis-nn-arm/versions/) delivers CMSIS-NN components and examples in [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). ## Key Features and Benefits diff --git a/CMSIS/Documentation/Doxygen/RTOS2/RTOS2.dxy.in b/CMSIS/Documentation/Doxygen/RTOS2/RTOS2.dxy.in index 1047ec2ee..02930f31b 100644 --- a/CMSIS/Documentation/Doxygen/RTOS2/RTOS2.dxy.in +++ b/CMSIS/Documentation/Doxygen/RTOS2/RTOS2.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Real-Time Operating System API" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -802,7 +802,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1357,7 +1357,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1367,7 +1367,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1397,9 +1397,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1409,13 +1409,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/RTOS2/src/cmsis_os2_Thread.txt b/CMSIS/Documentation/Doxygen/RTOS2/src/cmsis_os2_Thread.txt index 4f62efeb0..39752b590 100644 --- a/CMSIS/Documentation/Doxygen/RTOS2/src/cmsis_os2_Thread.txt +++ b/CMSIS/Documentation/Doxygen/RTOS2/src/cmsis_os2_Thread.txt @@ -272,7 +272,7 @@ the higher priority until it releases the resource. entry function. The optional argument can be used to hand over arbitrary user data to the thread, i.e. to identify the thread or for runtime parameters. -\param[in] argument Arbitrary user data set on \ref osThreadNew. +\param[in] argument arbitrary user data set on \ref osThreadNew. */ /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ @@ -347,7 +347,6 @@ In \b privileged processor mode, the application software can use all the instru /** \def osThreadZone(n) \param n MPU Protected Zone value. -\brief MPU zone value in attribute bit field format. \details The preprocessor macro \b osThreadZone constructs attribute bitmask with MPU zone bits set to \a n. @@ -365,11 +364,10 @@ const osThreadAttr_t thread_B_attr = { /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ /** \def osThreadProcessor(n) -\param n Processor number. -\brief Thread processor affinity mask value in attribute affinity_mask format. +\param n processor number, starting with n=0 for processor #0. The number of supported processors depend on the hardware. \details -The preprocessor macro \b osThreadProcessor constructs attribute affinity_mask derived from \a n. +The preprocessor macro \b osThreadProcessor constructs the value for the osThreadAttr_t::affinity_mask derived from \a n. */ @@ -913,7 +911,7 @@ The mask indicates on which processor(s) the thread should run (\token{0} indica Possible \ref osStatus_t return values: - \em osOK: the affinity mask of the specified thread has been set successfully. - - \em osErrorParameter: \a thread_id is \token{NULL} or invalid or \a priority is incorrect. + - \em osErrorParameter: \a thread_id is \token{NULL} or invalid or \a affinity_mask is incorrect. - \em osErrorResource: the thread is in an invalid state. - \em osErrorISR: the function \b osThreadSetAffinityMask cannot be called from interrupt service routines. - \em osErrorSafetyClass: the calling thread safety class is lower than the safety class of the specified thread. @@ -930,7 +928,7 @@ void Thread_1 (void const *arg) { // Thread function id = osThreadGetId(); // Obtain ID of current running thread - status = osThreadSetAffinityMask(id, osThreadProcessor(1)); // Set thread affinity mask + status = osThreadSetAffinityMask(id, osThreadProcessor(1)); // run thread processor #1 if (status == osOK) { // Thread affinity mask set to processor number 1 } @@ -1096,8 +1094,7 @@ Applicable only for devices on Armv8-M architecture. Ignored on others. \var osThreadAttr_t::affinity_mask \details -The affinity mask specified by \ref osThreadProcessor macro (multiple processors can be specified by OR-ing macros). - -Default: \token{0} to run on any processor. +Use the \ref osThreadProcessor macro to create the mask value. Multiple processors can be specified by OR-ing values. +Default: value \token{0} is RTOS implementation specific and may map to running on processor #0 or on any processor. */ diff --git a/CMSIS/Documentation/Doxygen/RTOS2/src/mainpage.md b/CMSIS/Documentation/Doxygen/RTOS2/src/mainpage.md index 4d8a5936c..c08fff470 100644 --- a/CMSIS/Documentation/Doxygen/RTOS2/src/mainpage.md +++ b/CMSIS/Documentation/Doxygen/RTOS2/src/mainpage.md @@ -24,24 +24,31 @@ CMSIS-RTOS2 provides great benefits to the embedded developers and software vend ## Supported RTOS kernels {#rtos2_kernels} -Several popular RTOS kernels include support for CMSIS-RTOS2 API: +Many popular RTOS kernels include support for CMSIS-RTOS2 API: **CMSIS-RTX** (or Keil RTX5): provides most complete support for CMSIS-RTOS2 API and uses it as native interface. For more information see: - [CMSIS-RTX GitHub repository](https://github.com/ARM-software/CMSIS-RTX) - - [CMSIS-RTX Documentation](https://arm-software.github.io/CMSIS-RTX/) + - [CMSIS-RTX documentation](https://arm-software.github.io/CMSIS-RTX/) + - [CMSIS-RTX pack](https://www.keil.arm.com/packs/cmsis-rtx-arm/versions/) **FreeRTOS** : this popular RTOS kernel is enabled with CMSIS-RTOS2 API in the *CMSIS-FreeRTOS* variant. To learn more see: - [CMSIS-FreeRTOS GitHub repository](https://github.com/ARM-software/CMSIS-FreeRTOS) - - [CMSIS-FreeRTOS Documentation](https://arm-software.github.io/CMSIS-FreeRTOS/) + - [CMSIS-FreeRTOS documentation](https://arm-software.github.io/CMSIS-FreeRTOS/) + - [CMSIS-FreeRTOS pack](https://www.keil.arm.com/packs/cmsis-freertos-arm/versions/) -**Zephyr RTOS**: is developed under governance of Linux Foundation and includes CMSIS-RTOS2 support. See more at: +**Zephyr RTOS**: is developed under governance of Linux Foundation and includes CMSIS-RTOS2 API support. See more at: - [Zephyr GitHub repository](https://github.com/zephyrproject-rtos/zephyr), see folder *subsys/portability/cmsis_rtos_v2/* - [Zephyr documentation about CMSIS-RTOS2 support](https://docs.zephyrproject.org/latest/services/portability/cmsis_rtos_v2.html) -**Micrium OS** is developed and maintained by Silicon Labs. See more at: +**embOS**: is a preemptive RTOS designed by Segger, and provides support for CMSIS-RTOS2 API. + + - [Using embOS in CMSIS-Pack projects](https://wiki.segger.com/Using_embOS_in_CMSIS-Pack_projects) + - [CMSIS-embOS pack](https://www.keil.arm.com/packs/cmsis-embos-segger/versions/) + +**Micrium OS** is developed and maintained by Silicon Labs. - [Micrium OS overview and comparison](https://www.silabs.com/developers/rtos) @@ -49,11 +56,11 @@ Several popular RTOS kernels include support for CMSIS-RTOS2 API: CMSIS-RTOS2 and OS Tick intefaces are actively maintained in [**CMSIS 6 GitHub repository**](https://github.com/ARM-software/CMSIS_6) and provided as part of the [CMSIS Software Pack](../General/cmsis_pack.html). -The following files relevant to CMSIS-RTOS2 are present in the **ARM::CMSIS** Pack directories: +The following files and directories relevant to CMSIS-RTOS2 are present in the **ARM::CMSIS** Pack: File/Directory | Content :-------------------------------------|:---------------------------------------------------- -📂 CMSIS | CMSIS Base software components folder +📂 CMSIS | CMSIS Base software components folder ┣ 📂 Documentation/html/RTOS2 | A local copy of this CMSIS-RTOS2 documentation â”— 📂 RTOS2 | CMSIS-RTOS2 API header files and OS tick implementations    ┣ 📂 Include | API header files diff --git a/CMSIS/Documentation/Doxygen/Stream/Stream.dxy.in b/CMSIS/Documentation/Doxygen/Stream/Stream.dxy.in index d59854834..a8561ad56 100644 --- a/CMSIS/Documentation/Doxygen/Stream/Stream.dxy.in +++ b/CMSIS/Documentation/Doxygen/Stream/Stream.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Optimized pipelines for data stream processing" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/Toolbox/Toolbox.dxy.in b/CMSIS/Documentation/Doxygen/Toolbox/Toolbox.dxy.in index 9158cadbb..f4aa45431 100644 --- a/CMSIS/Documentation/Doxygen/Toolbox/Toolbox.dxy.in +++ b/CMSIS/Documentation/Doxygen/Toolbox/Toolbox.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Command line tools for project build with packs" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/View/View.dxy.in b/CMSIS/Documentation/Doxygen/View/View.dxy.in index 948b8522c..cf213004d 100644 --- a/CMSIS/Documentation/Doxygen/View/View.dxy.in +++ b/CMSIS/Documentation/Doxygen/View/View.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Record program events, display status information, and # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/View/src/mainpage.md b/CMSIS/Documentation/Doxygen/View/src/mainpage.md index 8cf803d1a..7761407bf 100644 --- a/CMSIS/Documentation/Doxygen/View/src/mainpage.md +++ b/CMSIS/Documentation/Doxygen/View/src/mainpage.md @@ -12,8 +12,9 @@ Key elements of CMSIS-View are: CMSIS-View is maintained in a GitHub repository and is also released as a standalone package in CMSIS Software Pack format. - - [**CMSIS-View GitHub Repo**](https://github.com/Arm-Software/CMSIS-View) provides the full source code as well as releases in CMSIS-Pack format. + - [**CMSIS-View GitHub Repo**](https://github.com/Arm-Software/CMSIS-View) provides the full source code of CMSIS-View software, example projects and documentation. - [**CMSIS-View Documentation**](https://arm-software.github.io/CMSIS-View/latest/) explains how to use the library and describes the implemented functions in details. + - [**CMSIS-View Pack**](https://www.keil.arm.com/packs/cmsis-view-arm/versions/) delivers CMSIS-View firmware components and examples in [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). ## Key Features and Benefits diff --git a/CMSIS/Documentation/Doxygen/Zone/Zone.dxy.in b/CMSIS/Documentation/Doxygen/Zone/Zone.dxy.in index 157d023f3..96c89793d 100644 --- a/CMSIS/Documentation/Doxygen/Zone/Zone.dxy.in +++ b/CMSIS/Documentation/Doxygen/Zone/Zone.dxy.in @@ -60,7 +60,7 @@ PROJECT_BRIEF = "System Resource Management" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ../Doxygen_Templates/cmsis_logo_white_small.png +PROJECT_LOGO = ../style_template/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -795,7 +795,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = ../Doxygen_Templates/Layout_forUser.xml +LAYOUT_FILE = ../style_template/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1329,7 +1329,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = ../Doxygen_Templates/header.html +HTML_HEADER = ../style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1339,7 +1339,7 @@ HTML_HEADER = ../Doxygen_Templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = ../Doxygen_Templates/footer.html +HTML_FOOTER = ../style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1369,9 +1369,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ - ../Doxygen_Templates/extra_navtree.css \ - ../Doxygen_Templates/extra_search.css \ +HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \ + ../style_template/extra_navtree.css \ + ../style_template/extra_search.css \ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/extra_stylesheet.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ - ../Doxygen_Templates/version.css \ - ../Doxygen_Templates/tab_b.png \ - ../Doxygen_Templates/printComponentTabs.js \ - ../Doxygen_Templates/darkmode_toggle.js \ - ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ +HTML_EXTRA_FILES = ../style_template/tabs.css \ + ../style_template/version.css \ + ../style_template/tab_b.png \ + ../style_template/printComponentTabs.js \ + ../style_template/darkmode_toggle.js \ + ../style_template/navtree.js \ + ../style_template/dropdown.png \ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/Documentation/Doxygen/gen_doc.sh b/CMSIS/Documentation/Doxygen/gen_doc.sh index 93452954f..b9c4b60d4 100755 --- a/CMSIS/Documentation/Doxygen/gen_doc.sh +++ b/CMSIS/Documentation/Doxygen/gen_doc.sh @@ -95,11 +95,11 @@ function generate() { "${UTILITY_DOXYGEN}" $1.dxy mkdir -p "${DIRNAME}/${GENDIR}/$1/search/" - cp -f "${DIRNAME}/Doxygen_Templates/search.css" "${DIRNAME}/${GENDIR}/$1/search/" - cp -f "${DIRNAME}/Doxygen_Templates/navtree.js" "${DIRNAME}/${GENDIR}/$1/" - cp -f "${DIRNAME}/Doxygen_Templates/resize.js" "${DIRNAME}/${GENDIR}/$1/" + cp -f "${DIRNAME}/style_template/search.css" "${DIRNAME}/${GENDIR}/$1/search/" + cp -f "${DIRNAME}/style_template/navtree.js" "${DIRNAME}/${GENDIR}/$1/" + cp -f "${DIRNAME}/style_template/resize.js" "${DIRNAME}/${GENDIR}/$1/" - sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/Doxygen_Templates/footer.js.in" \ + sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/style_template/footer.js.in" \ | sed -e "s/{year}/${year}/" \ | sed -e "s/{projectName}/${projectName}/" \ | sed -e "s/{projectNumber}/${projectNumber}/" \ diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/Layout_forUser.xml b/CMSIS/Documentation/Doxygen/style_template/Layout_forUser.xml similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/Layout_forUser.xml rename to CMSIS/Documentation/Doxygen/style_template/Layout_forUser.xml diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/Layout_forUser_Core.xml b/CMSIS/Documentation/Doxygen/style_template/Layout_forUser_Core.xml similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/Layout_forUser_Core.xml rename to CMSIS/Documentation/Doxygen/style_template/Layout_forUser_Core.xml diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/cmsis_logo_white_small.png b/CMSIS/Documentation/Doxygen/style_template/cmsis_logo_white_small.png similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/cmsis_logo_white_small.png rename to CMSIS/Documentation/Doxygen/style_template/cmsis_logo_white_small.png diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/darkmode_toggle.js b/CMSIS/Documentation/Doxygen/style_template/darkmode_toggle.js similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/darkmode_toggle.js rename to CMSIS/Documentation/Doxygen/style_template/darkmode_toggle.js diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/dropdown.png b/CMSIS/Documentation/Doxygen/style_template/dropdown.png similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/dropdown.png rename to CMSIS/Documentation/Doxygen/style_template/dropdown.png diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/extra_navtree.css b/CMSIS/Documentation/Doxygen/style_template/extra_navtree.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/extra_navtree.css rename to CMSIS/Documentation/Doxygen/style_template/extra_navtree.css diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/extra_search.css b/CMSIS/Documentation/Doxygen/style_template/extra_search.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/extra_search.css rename to CMSIS/Documentation/Doxygen/style_template/extra_search.css diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/extra_stylesheet.css b/CMSIS/Documentation/Doxygen/style_template/extra_stylesheet.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/extra_stylesheet.css rename to CMSIS/Documentation/Doxygen/style_template/extra_stylesheet.css diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/footer.html b/CMSIS/Documentation/Doxygen/style_template/footer.html similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/footer.html rename to CMSIS/Documentation/Doxygen/style_template/footer.html diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/footer.js.in b/CMSIS/Documentation/Doxygen/style_template/footer.js.in similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/footer.js.in rename to CMSIS/Documentation/Doxygen/style_template/footer.js.in diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/header.html b/CMSIS/Documentation/Doxygen/style_template/header.html similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/header.html rename to CMSIS/Documentation/Doxygen/style_template/header.html diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/navtree.css b/CMSIS/Documentation/Doxygen/style_template/navtree.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/navtree.css rename to CMSIS/Documentation/Doxygen/style_template/navtree.css diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/navtree.js b/CMSIS/Documentation/Doxygen/style_template/navtree.js similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/navtree.js rename to CMSIS/Documentation/Doxygen/style_template/navtree.js diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/printComponentTabs.js b/CMSIS/Documentation/Doxygen/style_template/printComponentTabs.js similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/printComponentTabs.js rename to CMSIS/Documentation/Doxygen/style_template/printComponentTabs.js diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/resize.js b/CMSIS/Documentation/Doxygen/style_template/resize.js similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/resize.js rename to CMSIS/Documentation/Doxygen/style_template/resize.js diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/search.css b/CMSIS/Documentation/Doxygen/style_template/search.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/search.css rename to CMSIS/Documentation/Doxygen/style_template/search.css diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/tab_b.png b/CMSIS/Documentation/Doxygen/style_template/tab_b.png similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/tab_b.png rename to CMSIS/Documentation/Doxygen/style_template/tab_b.png diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/tab_topnav.png b/CMSIS/Documentation/Doxygen/style_template/tab_topnav.png similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/tab_topnav.png rename to CMSIS/Documentation/Doxygen/style_template/tab_topnav.png diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/tabs.css b/CMSIS/Documentation/Doxygen/style_template/tabs.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/tabs.css rename to CMSIS/Documentation/Doxygen/style_template/tabs.css diff --git a/CMSIS/Documentation/Doxygen/Doxygen_Templates/version.css b/CMSIS/Documentation/Doxygen/style_template/version.css similarity index 100% rename from CMSIS/Documentation/Doxygen/Doxygen_Templates/version.css rename to CMSIS/Documentation/Doxygen/style_template/version.css diff --git a/CMSIS/RTOS2/Include/cmsis_os2.h b/CMSIS/RTOS2/Include/cmsis_os2.h index b70974323..c490b7bf6 100644 --- a/CMSIS/RTOS2/Include/cmsis_os2.h +++ b/CMSIS/RTOS2/Include/cmsis_os2.h @@ -216,7 +216,7 @@ typedef enum { #define osThreadZone_Msk (0x3FUL << osThreadZone_Pos) ///< MPU protected zone mask #define osThreadZone_Valid (0x80UL << osThreadZone_Pos) ///< MPU protected zone valid flag #define osThreadZone(n) ((((n) << osThreadZone_Pos) & osThreadZone_Msk) | \ - osThreadZone_Valid) ///< MPU protected zone + osThreadZone_Valid) ///< MPU zone value in attribute bit field format // Thread processor affinity (affinity_mask in \ref osThreadAttr_t). #define osThreadProcessor(n) (1UL << (n)) ///< Thread processor number for SMP systems @@ -293,7 +293,7 @@ typedef struct { uint32_t stack_size; ///< size of stack osPriority_t priority; ///< initial thread priority (default: osPriorityNormal) TZ_ModuleId_t tz_module; ///< TrustZone module identifier - uint32_t affinity_mask; ///< processor affinity mask (0 when not used) + uint32_t affinity_mask; ///< processor affinity mask for binding the thread to a CPU in a SMP system (0 when not used) } osThreadAttr_t; /// Attributes structure for timer.