Skip to content

Commit 8ecae4c

Browse files
JonatanAntoniJonatanAntoni
committed
Updated documentation for release.
1 parent 5a48e15 commit 8ecae4c

27 files changed

Lines changed: 221 additions & 287 deletions

‎docs/General/html/cm_revisionHistory.html‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -113,14 +113,35 @@
113113
<div class="contents">
114114
<div class="textblock"><table class="cmtable" summary="Revision History">
115115
<tr>
116-
<td>1.0.0 </td><td>Initial release </td></tr>
116+
<td>9.1.0 </td><td><p class="starttd"></p>
117+
<p><b>FreeRTOS 9.0.0</b></p>
118+
<p></p>
119+
<p>Maintenance release for CMSIS 5.1.0: </p>
120+
<ul>
121+
<li>
122+
Added support for ARM Compiler 6 (Limitations: Not available for Cortex-M0!) </li>
123+
<li>
124+
Updated Cortex-A example to use IRQ Controller component </li>
125+
<li>
126+
Corrected stack size allocation in RTOS2 osThreadNew function </li>
127+
<li>
128+
Added support for OS Tick component </li>
129+
<li>
130+
Added documentation for configuration options (native/CMSIS-RTOS2) </li>
131+
<li>
132+
Debug event TaskIncrementTick level set to Detail </li>
133+
</ul>
134+
<p class="endtd"></p>
135+
</td></tr>
136+
<tr>
137+
<td>9.0.0 </td><td>Initial release </td></tr>
117138
</table>
118139
</div></div><!-- contents -->
119140
</div><!-- doc-content -->
120141
<!-- start footer part -->
121142
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
122143
<ul>
123-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
144+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
124145
<!--
125146
<a href="http://www.doxygen.org/index.html">
126147
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/cre_freertos_proj.html‎

Lines changed: 72 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -135,26 +135,36 @@ <h1><a class="anchor" id="native_freertos"></a>
135135
</div>
136136
</li>
137137
</ul>
138-
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Do we add user code templates for the native FreeRTOS implementation?</dd></dl>
139-
<ul>
140-
<li>You can add template files to the project by right-clicking on <b>Source Group 1</b> and selecting <b>Add New Item to 'Source Group 1'</b>. In the new window, click on <b>User Code Template</b>. On the right-hand side you will see all available template files for CMSIS-RTOS RTX:</li>
141-
</ul>
142-
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Do we offer an SCVD file for the native FreeRTOS implementation?</dd></dl>
138+
<h2><a class="anchor" id="native_freertos_config"></a>
139+
Configure FreeRTOS</h2>
140+
<p>When you have created the native FreeRTOS project, you can configure the real-time operating system using the <b>FreeRTOSConfig.h</b> file. Please refer to the <a href="http://www.freertos.org/a00110.html" target="_blank">FreeRTOS documentation</a> for more information on the specific settings.</p>
141+
<div class="image">
142+
<img src="freertos_config_h_native.png" alt="freertos_config_h_native.png"/>
143+
</div>
143144
<h2><a class="anchor" id="native_freertos_er"></a>
144145
Add Event Recorder Visibility</h2>
145146
<ul>
146-
<li>To use the Event Recorder together with RTX5, select the software component <b>Compiler:Event Recorder</b>.</li>
147-
<li>Select the <b>Source</b> variant of the software component <b>CMSIS:RTOS2 (API):Keil RTX5</b>.</li>
148-
<li>Call the function <b>EventRecorderInitialize()</b> in your application code (ideally in <code>main()</code>).</li>
149-
<li>Build the application code and download it to the debug hardware.</li>
147+
<li>To use the Event Recorder together with FreeRTOS, add the software components <b>::Compiler:Event Recorder</b> and <b>::RTOS:Event Groups</b> to your project.</li>
148+
<li>Add this include: <code>#include</code> <code>"EventRecorder.h"</code> </li>
149+
<li>Call <b>EventRecorderInitialize(EventRecordAll, 1);</b> in your application code (ideally in <code>main()</code>).</li>
150+
<li>If you are using simulation mode, add an initialization file with the following content: <div class="fragment"><div class="line">MAP 0xE0001000, 0xE0001007 READ WRITE </div>
151+
<div class="line">signal <span class="keywordtype">void</span> DWT_CYCCNT (<span class="keywordtype">void</span>) {</div>
152+
<div class="line"><span class="keywordflow">while</span> (1) {</div>
153+
<div class="line"> rwatch(0xE0001004);</div>
154+
<div class="line"> _WWORD(0xE0001004, states);</div>
155+
<div class="line"> }</div>
156+
<div class="line">}</div>
157+
<div class="line">DWT_CYCCNT()</div>
158+
</div><!-- fragment --></li>
159+
<li>Build the application code and download it to the debug hardware or run it in simulation.</li>
150160
</ul>
151161
<p>Once the target application generates event information, it can be viewed in the µVision debugger using the <b>Event</b> <b>Recorder</b>.</p>
152162
<h1><a class="anchor" id="cmsis_freertos"></a>
153163
Create a CMSIS-FreeRTOS project</h1>
154164
<p>The steps to create a microcontroller application using CMSIS-FreeRTOS are:</p>
155165
<ul>
156166
<li>Create a new project and select a microcontroller device.</li>
157-
<li><p class="startli">In the Manage Run-Time Environment window, select <b>::Device:Startup</b>, <b>::CMSIS::RTOS2 (API)::FreeRTOS</b>, <b>::RTOS:CORE</b> in the <b>FreeRTOS</b> variant, <b>::RTOS:Config</b> in the <b>CMSIS</b> <b>RTOS2</b> variant, <b>::RTOS:FreeRTOS:Timers</b>, <b>::RTOS:FreeRTOS:Event Groups</b>, and an applicable <b>::RTOS:Heap</b> scheme (for more information on the heap schemes, visit the FreeRTOS documentation):</p>
167+
<li><p class="startli">In the Manage Run-Time Environment window, select <b>::Device:Startup</b>, <b>::CMSIS::RTOS2 (API)::FreeRTOS</b>, <b>::RTOS:CORE</b> in the <b>FreeRTOS</b> variant, <b>::RTOS:Config</b> in the <b>CMSIS</b> <b>RTOS2</b> variant, <b>::RTOS:Timers</b>, <b>::RTOS:Event Groups</b>, and an applicable <b>::RTOS:Heap</b> scheme (for more information on the heap schemes, visit the FreeRTOS documentation):</p>
158168
<div class="image">
159169
<img src="manage_rte_freertos_rtos2.png" alt="manage_rte_freertos_rtos2.png"/>
160170
</div>
@@ -168,26 +178,67 @@ <h1><a class="anchor" id="cmsis_freertos"></a>
168178
</div>
169179
</li>
170180
</ul>
171-
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Do we add user code templates for the RTOS2 FreeRTOS implementation?\</dd></dl>
172-
<ul>
173-
<li>You can add template files to the project by right-clicking on <b>Source Group 1</b> and selecting <b>Add New Item to 'Source Group 1'</b>. In the new window, click on <b>User Code Template</b>. On the right-hand side you will see all available template files for CMSIS-RTOS RTX:</li>
174-
</ul>
175-
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>Do we offer an SCVD file for the RTOS2 FreeRTOS implementation?</dd></dl>
181+
<h2><a class="anchor" id="cmsis_freertos_config"></a>
182+
Configure CMSIS-FreeRTOS</h2>
183+
<p>When you have created the CMSIS-FreeRTOS project, you can configure the real-time operating system using the <b>FreeRTOSConfig.h</b> file. It can be opened using the Configuration Wizard view:</p>
184+
<div class="image">
185+
<img src="freertos_config_h_cmsis_rtos.png" alt="freertos_config_h_cmsis_rtos.png"/>
186+
</div>
187+
<p>The following settings are available:</p>
188+
<table class="doxtable">
189+
<tr>
190+
<th>Name </th><th>#define </th><th>Description </th></tr>
191+
<tr>
192+
<td>Minimal stack size [words] </td><td>configMINIMAL_STACK_SIZE </td><td>Stack for idle task and default task stack in words. </td></tr>
193+
<tr>
194+
<td>Total heap size [bytes] </td><td>configTOTAL_HEAP_SIZE </td><td>Heap memory size in bytes. </td></tr>
195+
<tr>
196+
<td>Kernel tick frequency [Hz] </td><td>configTICK_RATE_HZ </td><td>Kernel tick rate in Hz. </td></tr>
197+
<tr>
198+
<td>Timer task stack depth [words] </td><td>configTIMER_TASK_STACK_DEPTH </td><td>Stack for timer task in words. </td></tr>
199+
<tr>
200+
<td>Timer task priority </td><td>configTIMER_TASK_PRIORITY </td><td>Timer task priority. </td></tr>
201+
<tr>
202+
<td>Timer queue length </td><td>configTIMER_QUEUE_LENGTH </td><td>Timer command queue length. </td></tr>
203+
<tr>
204+
<td>Use time slicing </td><td>configUSE_TIME_SLICING </td><td>Enable setting to use time slicing. </td></tr>
205+
<tr>
206+
<td>Idle should yield </td><td>configIDLE_SHOULD_YIELD </td><td>Control Yield behavior of the idle task. </td></tr>
207+
<tr>
208+
<td>Check for stack overflow </td><td>configCHECK_FOR_STACK_OVERFLOW </td><td>Enable or disable stack overflow checking. </td></tr>
209+
<tr>
210+
<td>Use idle hook </td><td>configUSE_IDLE_HOOK </td><td>Enable callback function call on each idle task iteration. </td></tr>
211+
<tr>
212+
<td>Use tick hook </td><td>configUSE_TICK_HOOK </td><td>Enable callback function call during each tick interrupt. </td></tr>
213+
<tr>
214+
<td>Use daemon task startup hook </td><td>configUSE_DAEMON_TASK_STARTUP_HOOK </td><td>Enable callback function call when timer service starts. </td></tr>
215+
<tr>
216+
<td>Use malloc failed hook </td><td>configUSE_MALLOC_FAILED_HOOK </td><td>Enable callback function call when out of dynamic memory. </td></tr>
217+
</table>
176218
<h2><a class="anchor" id="cmsis_freertos_er"></a>
177219
Add Event Recorder Visibility</h2>
178220
<ul>
179-
<li>To use the Event Recorder together with RTX5, select the software component <b>Compiler:Event Recorder</b>.</li>
180-
<li>Select the <b>Source</b> variant of the software component <b>CMSIS:RTOS2 (API):Keil RTX5</b>.</li>
181-
<li>Call the function <b>EventRecorderInitialize()</b> in your application code (ideally in <code>main()</code>).</li>
182-
<li>Build the application code and download it to the debug hardware.</li>
221+
<li>To use the Event Recorder together with FreeRTOS, add the software component <b>::Compiler:Event Recorder</b> to your project.</li>
222+
<li>Add this include: <code>#include</code> <code>"EventRecorder.h"</code> </li>
223+
<li>Call <b>EventRecorderInitialize(EventRecordAll, 1);</b> in your application code (ideally in <code>main()</code>).</li>
224+
<li>If you are using simulation mode, add an initialization file with the following content: <div class="fragment"><div class="line">MAP 0xE0001000, 0xE0001007 READ WRITE </div>
225+
<div class="line">signal <span class="keywordtype">void</span> DWT_CYCCNT (<span class="keywordtype">void</span>) {</div>
226+
<div class="line"><span class="keywordflow">while</span> (1) {</div>
227+
<div class="line"> rwatch(0xE0001004);</div>
228+
<div class="line"> _WWORD(0xE0001004, states);</div>
229+
<div class="line"> }</div>
230+
<div class="line">}</div>
231+
<div class="line">DWT_CYCCNT()</div>
232+
</div><!-- fragment --></li>
233+
<li>Build the application code and download it to the debug hardware or run it in simulation.</li>
183234
</ul>
184235
<p>Once the target application generates event information, it can be viewed in the µVision debugger using the <b>Event</b> <b>Recorder</b>. </p>
185236
</div></div><!-- contents -->
186237
</div><!-- doc-content -->
187238
<!-- start footer part -->
188239
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
189240
<ul>
190-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
241+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
191242
<!--
192243
<a href="http://www.doxygen.org/index.html">
193244
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/dir_46cf4373772806b8331687559c626178.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -123,7 +123,7 @@
123123
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
124124
<ul>
125125
<li class="navelem"><a class="el" href="dir_e7fa9f9ff84ec6f18f923fb2418bfd4b.html">CMSIS</a></li><li class="navelem"><a class="el" href="dir_6fbc6882f8daffdaafc25c2f1839223d.html">RTOS2</a></li><li class="navelem"><a class="el" href="dir_4c727e77617e41be30cca75e10c711ee.html">FreeRTOS</a></li><li class="navelem"><a class="el" href="dir_46cf4373772806b8331687559c626178.html">Include</a></li>
126-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
126+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
127127
<!--
128128
<a href="http://www.doxygen.org/index.html">
129129
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/dir_4c727e77617e41be30cca75e10c711ee.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -123,7 +123,7 @@
123123
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
124124
<ul>
125125
<li class="navelem"><a class="el" href="dir_e7fa9f9ff84ec6f18f923fb2418bfd4b.html">CMSIS</a></li><li class="navelem"><a class="el" href="dir_6fbc6882f8daffdaafc25c2f1839223d.html">RTOS2</a></li><li class="navelem"><a class="el" href="dir_4c727e77617e41be30cca75e10c711ee.html">FreeRTOS</a></li>
126-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
126+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
127127
<!--
128128
<a href="http://www.doxygen.org/index.html">
129129
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/dir_6fbc6882f8daffdaafc25c2f1839223d.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -123,7 +123,7 @@
123123
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
124124
<ul>
125125
<li class="navelem"><a class="el" href="dir_e7fa9f9ff84ec6f18f923fb2418bfd4b.html">CMSIS</a></li><li class="navelem"><a class="el" href="dir_6fbc6882f8daffdaafc25c2f1839223d.html">RTOS2</a></li>
126-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
126+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
127127
<!--
128128
<a href="http://www.doxygen.org/index.html">
129129
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/dir_e7fa9f9ff84ec6f18f923fb2418bfd4b.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -123,7 +123,7 @@
123123
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
124124
<ul>
125125
<li class="navelem"><a class="el" href="dir_e7fa9f9ff84ec6f18f923fb2418bfd4b.html">CMSIS</a></li>
126-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
126+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
127127
<!--
128128
<a href="http://www.doxygen.org/index.html">
129129
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/examples.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -154,7 +154,7 @@ <h1><a class="anchor" id="examples_cmsis_a9"></a>
154154
<!-- start footer part -->
155155
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
156156
<ul>
157-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
157+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
158158
<!--
159159
<a href="http://www.doxygen.org/index.html">
160160
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

‎docs/General/html/freertos_config_h_cmsis_rtos.png‎

14 KB
Loading

‎docs/General/html/freertos_config_h_native.png‎

116 KB
Loading

‎docs/General/html/functionOverview.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
3333
<td style="padding-left: 0.5em;">
3434
<div id="projectname">CMSIS-FreeRTOS
35-
&#160;<span id="projectnumber">Version 9.0.0</span>
35+
&#160;<span id="projectnumber">Version 9.1.0</span>
3636
</div>
3737
<div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
3838
</td>
@@ -233,7 +233,7 @@ <h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS
233233
<!-- start footer part -->
234234
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
235235
<ul>
236-
<li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
236+
<li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
237237
<!--
238238
<a href="http://www.doxygen.org/index.html">
239239
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6

0 commit comments

Comments
 (0)