Skip to content

Commit

Permalink
Update main documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 12, 2025
1 parent 6f97fe0 commit 7e06933
Show file tree
Hide file tree
Showing 89 changed files with 2,533 additions and 2,917 deletions.
90 changes: 47 additions & 43 deletions main/html/algorithmFunc.html
View file

Large diffs are not rendered by default.

Binary file added main/html/bc_sd.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion main/html/cmsis_footer.js
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Mon Jan 27 2025 15:58:31 for Open-CMSIS-Pack Version 1.7.45 by Arm Ltd. All rights reserved.');
document.write('Generated on Wed Feb 12 2025 15:00:36 for Open-CMSIS-Pack Version 1.7.45 by Arm Ltd. All rights reserved.');
};
46 changes: 25 additions & 21 deletions main/html/configWizard.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
Expand All @@ -54,11 +54,8 @@
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
Expand Down Expand Up @@ -95,9 +92,16 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div><div class="header">
Expand All @@ -106,7 +110,7 @@
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="configWizard_annotations"></a>
Annotation Rules</h1>
<p ><b>Configuration Wizard Annotations</b> consist of annotation items and annotation modifiers. They create GUI-like elements in IDEs for configuration files (see <a class="el" href="configWizard.html#configWizard_display">Tool-specific display</a>). Using a GUI-like approach makes it easier for the user to check and adapt configuration files to the application needs. The following rules apply:</p><ul>
<p><b>Configuration Wizard Annotations</b> consist of annotation items and annotation modifiers. They create GUI-like elements in IDEs for configuration files (see <a class="el" href="configWizard.html#configWizard_display">Tool-specific display</a>). Using a GUI-like approach makes it easier for the user to check and adapt configuration files to the application needs. The following rules apply:</p><ul>
<li>The Configuration Wizard section must begin within the first 100 lines of code and must start with the following comment line: <div class="fragment"><div class="line"><span class="comment">// &lt;&lt;&lt; Use Configuration Wizard in Context Menu &gt;&gt;&gt;</span></div>
</div><!-- fragment --></li>
<li>The Configuration Wizard section can end with the following optional comment: <div class="fragment"><div class="line"><span class="comment">// &lt;&lt;&lt; end of configuration section &gt;&gt;&gt;</span></div>
Expand All @@ -119,7 +123,7 @@
<li>Whitespace characters are ignored in annotation items or annotation modifiers (text excluded).</li>
<li>You must not use &lt; or &gt; within configuration wizard lines other than for enclosing annotation items.</li>
</ul>
<p >The following table lists the Configuration Wizard Annotations:</p>
<p>The following table lists the Configuration Wizard Annotations:</p>
<table class="cmtable" summary="Annotations Tab">
<tr>
<th>Item </th><th>Text </th><th>Description </th></tr>
Expand All @@ -144,7 +148,7 @@
<div class="line"><span class="preprocessor">#ifndef OS_ROBINTOUT</span></div>
<div class="line"><span class="preprocessor">#define OS_ROBINTOUT 5</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
<div class="line"><span class="preprocessor"></span><span class="comment">// &lt;/e&gt;</span></div>
<div class="line"><span class="comment">// &lt;/e&gt;</span></div>
</div><!-- fragment --> The entry <code>&lt;e&gt;Round-Robin Thread switching ... &lt;/e&gt;</code> sets OS_ROBIN to <span class="XML-Token">1</span> (checkbox enabled) or <span class="XML-Token">0</span> (checkbox disabled) and encloses the <em>OS_ROBINTOUT</em> (Round-Robin Timeout) setting. See screen outcome in <a class="el" href="configWizard.html#configWizard_display">Tool-specific display</a>. </td></tr>
<tr>
<td>&lt;e.<em>i</em>&gt;<sup>*+</sup> </td><td>yes </td><td>Heading with Enable: modifies a specific bit (<em>i</em>) (example: &lt;e.4&gt; - changes bit 4 of a value). <div class="fragment"><div class="line"><span class="comment">// &lt;e.4&gt;Serial Number</span></div>
Expand Down Expand Up @@ -204,7 +208,7 @@
<div class="line"><span class="preprocessor">#ifndef OS_ROBINTOUT</span></div>
<div class="line"><span class="preprocessor">#define OS_ROBINTOUT 5</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
<div class="line"><span class="preprocessor"></span><span class="comment">// &lt;/e&gt;</span></div>
<div class="line"><span class="comment">// &lt;/e&gt;</span></div>
</div><!-- fragment --> The example creates an option with the text <span class="XML-Token">Round-Robin Timeout [ticks]</span> and a field to enter values that can range between [1..1000]. </td></tr>
<tr>
<td>&lt;o.<em>i</em>&gt;<sup>*+</sup> </td><td>yes </td><td>Modify a single bit (example: &lt;e.4&gt; - modifies bit 4). <div class="fragment"><div class="line"><span class="comment">// &lt;o.4&gt; &lt;o.0&gt;High-speed</span></div>
Expand All @@ -226,7 +230,7 @@
<div class="line"> </div>
<div class="line"><span class="comment">// &lt;y FAT_MAX_OPEN_FILES&gt;Value or Define Symbol that specifies number of open files &lt;1-16&gt;</span></div>
<div class="line"><span class="preprocessor">#define OTHER_SYMBOL &quot;This is a text&quot;</span></div>
<div class="line">#define FAT_MAX_OPEN_FILES 8</div>
<div class="line"><span class="preprocessor">#define FAT_MAX_OPEN_FILES 8</span></div>
</div><!-- fragment --> The example creates an option with the text <span class="XML-Token">Value or Define Symbol that specifies number of open files</span> and a field to enter a symbol or values that can range between [1..16]. The second example is identical, except that it locates the symbol <span class="XML-Token">FAT_MAX_OPEN_FILES</span> to locate the input value. </td></tr>
<tr>
<td>&lt;s&gt;<sup>*+</sup> </td><td>yes </td><td>Option with ASCII string entry. <div class="fragment"><div class="line"><span class="comment">// &lt;s&gt;Manufacturer String</span></div>
Expand Down Expand Up @@ -345,10 +349,10 @@
<div class="line"><span class="preprocessor">#define MY_HEX 52 -- displayed as hexadecimal &quot;0x34&quot;</span> in the tool</div>
</div><!-- fragment --> </td></tr>
</table>
<p ><sup>1</sup> Tools are expected to continue support of deprecated features but annotated files shall be updated to the new version.</p>
<p><sup>1</sup> Tools are expected to continue support of deprecated features but annotated files shall be updated to the new version.</p>
<h1><a class="anchor" id="configWizard_codeExample"></a>
Code Example</h1>
<p >You can copy the code into a C-file and check the outcome in the uVision Editor.</p>
<p>You can copy the code into a C-file and check the outcome in the uVision Editor.</p>
<div class="fragment"><div class="line"><span class="comment">//-------- &lt;&lt;&lt; Use Configuration Wizard in Context Menu &gt;&gt;&gt; -----------------</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// &lt;h&gt;Thread Configuration</span></div>
Expand Down Expand Up @@ -501,14 +505,14 @@ <h1><a class="anchor" id="configWizard_codeExample"></a>
<div class="line"><span class="comment">//------------- &lt;&lt;&lt; end of configuration section &gt;&gt;&gt; -----------------------</span></div>
</div><!-- fragment --><h1><a class="anchor" id="configWizard_display"></a>
Tool-specific display</h1>
<p >It is left to the development tool to interpret and display Configuration Wizard Annotations. The uVision IDE displays the code above in the following way:</p>
<p>It is left to the development tool to interpret and display Configuration Wizard Annotations. The uVision IDE displays the code above in the following way:</p>
<div class="image">
<img src="RTX_Conf_CM_Wizard_View.png" alt=""/>
<div class="caption">
Configuration Wizard Display</div></div>
<p ><b>Where</b></p>
<p ><em>Option</em> are device properties, which can be represented in a tree structure. Each item can have an explanatory tooltip.</p>
<p ><em>Value</em> sets the option value. Can contain controls to encapsulate data in predefined drop-down lists. </p>
<p><b>Where</b></p>
<p><em>Option</em> are device properties, which can be represented in a tree structure. Each item can have an explanatory tooltip.</p>
<p><em>Value</em> sets the option value. Can contain controls to encapsulate data in predefined drop-down lists. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
Expand Down
26 changes: 15 additions & 11 deletions main/html/coresight_setup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
Expand All @@ -54,11 +54,8 @@
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
Expand Down Expand Up @@ -95,16 +92,23 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div><div class="header">
<div class="headertitle"><div class="title">Debug Setup with CMSIS-Pack </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p >CMSIS-Pack offers two ways to simplify the debug setup:</p><ul>
<div class="textblock"><p>CMSIS-Pack offers two ways to simplify the debug setup:</p><ul>
<li>A <a class="el" href="debug_description.html">Debug Description</a> declares a set of standardized debug and trace methods are automatically executed by the debugger. Implementation-specific steps can be described using an XML syntax. This concept is easy to implement for basic chip configurations that mostly rely on a standard implementation of the CoreSight architecture. Most single-core devices should be able to be specified completely with debug descriptions.</li>
<li>For more complex topologies and multi-core devices, a <a class="el" href="sdf_pg.html">System Description File</a> helps debuggers to connect to the target and access all available cores via trace. An SDF file is more complex (although also specified in XML), but is also more flexible with regards to the underlying debug architecture.</li>
<li><a class="el" href="dbg_setup_tutorial.html">Debug Setup Tutorial</a> provides a guide on how to implement the debug descriptions for a microcontroller device. It explains the options for configuring debug connection. Gives examples on implementing debug access sequences in specific scenarios such as trace support, bootloader handling, multi-core systems and others. And finally shows how debug descriptions can be used in various IDE debuggers.<br />
Expand Down
34 changes: 19 additions & 15 deletions main/html/cp_PackTutorial.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
Expand All @@ -54,11 +54,8 @@
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
Expand Down Expand Up @@ -95,31 +92,38 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div><div class="header">
<div class="headertitle"><div class="title">Pack tutorials </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p >These are the basic steps that are required to create a software pack:</p>
<div class="textblock"><p>These are the basic steps that are required to create a software pack:</p>
<ol type="1">
<li><b>Produce input:</b> Create the files that will be delivered with the pack (source code, header and library files, documentation).</li>
<li><b>Organize files:</b> For better maintainability, use directories to separate the content of the pack.</li>
<li><b>Create PDSC file:</b> The XML based PDSC file can be created using any text editor. Editors that can validate XML code against a schema file help to find bugs early in the pack development stage.</li>
<li><b>Generate pack:</b> Any compression tool supporting the ZIP format can be used to create a pack file. <a href="https://github.com/Open-CMSIS-Pack/devtools/tree/main/tools/packchk"><b>packchk</b></a> is helpful for the validation of the contents of a pack.</li>
</ol>
<p >Steps 3 and 4 above are covered automatically if you are using the <a class="el" href="createPackPublish.html#createPackUtil">gen_pack.sh</a> script to generate the pack.</p>
<p ><b>Online tutorials</b></p>
<p >The <a href="https://github.com/Open-CMSIS-Pack" target="_blank">Open-CMSIS-Pack GitHub presence</a> contains three pack tutorials that show how to create different types of packs:</p><ul>
<p>Steps 3 and 4 above are covered automatically if you are using the <a class="el" href="createPackPublish.html#createPackUtil">gen_pack.sh</a> script to generate the pack.</p>
<p><b>Online tutorials</b></p>
<p>The <a href="https://github.com/Open-CMSIS-Pack" target="_blank">Open-CMSIS-Pack GitHub presence</a> contains three pack tutorials that show how to create different types of packs:</p><ul>
<li><a href="https://github.com/Open-CMSIS-Pack/SW-Pack-HandsOn" target="_blank">Software pack hands-on</a> - explains the steps to create a simple software pack. <br />
</li>
<li><a href="https://github.com/Open-CMSIS-Pack/DFP-Pack-HandsOn" target="_blank">Device family pack hands-on</a> - shows how to create a device family pack (DFP).</li>
<li><a href="https://github.com/Open-CMSIS-Pack/BSP-Pack-HandsOn" target="_blank">Board support pack hands-on</a> - runs through the steps to create a board support pack (BSP).</li>
</ul>
<p >To work with these tutorials, make sure that you have installed the environment that is required for <a class="el" href="createPackPublish.html#createPackUtil">Checking CMSIS-Packs</a> as this will be used to verify and create the tutorial packs. </p>
<p>To work with these tutorials, make sure that you have installed the environment that is required for <a class="el" href="createPackPublish.html#createPackUtil">Checking CMSIS-Packs</a> as this will be used to verify and create the tutorial packs. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
Expand Down
Loading

0 comments on commit 7e06933

Please sign in to comment.