1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Configure RTX v5</title>
<title>CMSIS-RTOS2: Configure RTX v5</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-RTOS2
 <span id="projectnumber">Version 2.1.3</span>
</div>
<div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('config_rtx5.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Configure RTX v5 </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The file "RTX_Config.h" defines the configuration parameters of CMSIS-RTOS RTX and must be part of every project that is using the CMSIS-RTOS RTX kernel. The configuration options are explained in detail in the following sections:</p>
<ul>
<li><a class="el" href="config_rtx5.html#systemConfig">System Configuration</a> covers system-wide settings for the global memory pool, tick frequency, ISR event buffer and round-robin thread switching.</li>
<li><a class="el" href="config_rtx5.html#threadConfig">Thread Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> functions.</li>
<li><a class="el" href="config_rtx5.html#timerConfig">Timer Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> functions.</li>
<li><a class="el" href="config_rtx5.html#eventFlagsConfig">Event Flags Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> functions.</li>
<li><a class="el" href="config_rtx5.html#mutexConfig">Mutex Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</a> functions.</li>
<li><a class="el" href="config_rtx5.html#semaphoreConfig">Semaphore Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</a> functions.</li>
<li><a class="el" href="config_rtx5.html#memPoolConfig">Memory Pool Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a> functions.</li>
<li><a class="el" href="config_rtx5.html#msgQueueConfig">Message Queue Configuration</a> provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a> functions.</li>
<li><a class="el" href="config_rtx5.html#evtrecConfig">Event Recorder Configuration</a> provides several parameters to configure RTX for usage with <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a>.</li>
</ul>
<p>The file "RTX_Config.c" contains default implementations of the functions <a class="el" href="group__rtx5__specific__functions.html#ga074068b8efa7074cee68a71481d0b072">osRtxIdleThread</a> and <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a>. Both functions can simply be overwritten with a customized behavior by redefining them as part of the user code.</p>
<p>The configuration file uses <b>Configuration Wizard Annotations</b>. Refer to <b>Pack - Configuration Wizard Annotations</b> for details. Depending on the development tool, the annotations might lead to a more user-friendly graphical representation of the settings. The picture below shows the µVision <b>Configuration</b> <b>Wizard</b> view in MDK:</p>
<div class="image">
<img src="config_wizard.png" alt="config_wizard.png"/>
<div class="caption">
RTX_Config.h in Configuration Wizard View</div></div>
<p> Alternatively one can provide configuration options using the compiler command line.</p>
<p>For example one can customize the used tick frequency to 100us by (overwriting) the configuration using </p>
<div class="fragment"><div class="line">cc -DOS_TICK_FREQ=100</div>
</div><!-- fragment --><h1><a class="anchor" id="systemConfig"></a>
System Configuration</h1>
<p>The system configuration covers system-wide settings for the global memory pool, tick frequency, ISR event buffer and round-robin thread switching.</p>
<p><b>System Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_system.png" alt="config_wizard_system.png"/>
<div class="caption">
RTX_Config.h: System Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Global Dynamic Memory size [bytes] </td><td><code>OS_DYNAMIC_MEM_SIZE</code> </td><td>Defines the combined global dynamic memory size for the <a class="el" href="theory_of_operation.html#GlobalMemoryPool">Global Memory Pool</a>. Default value is <span class="XML-Token">4096</span>. Value range is <span class="XML-Token">[0-1073741824]</span> bytes, in multiples of <span class="XML-Token">8</span> bytes. </td></tr>
<tr>
<td>Kernel Tick Frequency (Hz) </td><td><code>OS_TICK_FREQ</code> </td><td>Defines base time unit for delays and timeouts in Hz. Default: 1000Hz = 1ms period. </td></tr>
<tr>
<td>Round-Robin Thread switching </td><td><code>OS_ROBIN_ENABLE</code> </td><td>Enables Round-Robin Thread switching. </td></tr>
<tr>
<td>Round-Robin Timeout </td><td><code>OS_ROBIN_TIMEOUT</code> </td><td>Defines how long a thread will execute before a thread switch. Default value is <span class="XML-Token">5</span>. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
<tr>
<td>ISR FIFO Queue </td><td><code>OS_ISR_FIFO_QUEUE</code> </td><td>RTOS Functions called from ISR store requests to this buffer. Default value is <span class="XML-Token">16 entries</span>. Value range is <span class="XML-Token">[4-256]</span> entries in multiples of <span class="XML-Token">4</span>. </td></tr>
<tr>
<td>Object Memory usage counters </td><td><code>OS_OBJ_MEM_USAGE</code> </td><td>Enables object memory usage counters to evaluate the maximum memory pool requirements individually for each RTOS object type. </td></tr>
</table>
<h2><a class="anchor" id="systemConfig_glob_mem"></a>
Global dynamic memory</h2>
<p>Refer to <a class="el" href="theory_of_operation.html#GlobalMemoryPool">Global Memory Pool</a>.</p>
<h2><a class="anchor" id="systemConfig_rr"></a>
Round-Robin Thread Switching</h2>
<p>RTX5 may be configured to use round-robin multitasking thread switching. Round-robin allows quasi-parallel execution of several threads of the <em>same</em> priority. Threads are not really executed concurrently, but are scheduled where the available CPU time is divided into time slices and RTX5 assigns a time slice to each thread. Because the time slice is typically short (only a few milliseconds), it appears as though threads execute simultaneously.</p>
<p>Round-robin thread switching functions as follows:</p>
<ul>
<li>the tick is preloaded with the timeout value when a thread switch occurs</li>
<li>the tick is decremented (if not already zero) each system tick if the same thread is still executing</li>
<li>when the tick reaches 0 it indicates that a timeout has occurred. If there is another thread ready with the <em>same</em> priority, then the system switches to that thread and the tick is preloaded with timeout again.</li>
</ul>
<p>In other words, threads execute for the duration of their time slice (unless a thread's time slice is given up). Then, RTX switches to the next thread that is in <b>READY</b> state and has the same priority. If no other thread with the same priority is ready to run, the current running thread resumes it execution.</p>
<dl class="section note"><dt>Note</dt><dd>When switching to higher priority threads, the round-robin timeout value is reset.</dd></dl>
<p>Round-Robin multitasking is controlled with the <b>#define OS_ROBIN_ENABLE</b>. The time slice period is configured (in RTX timer ticks) with the <b>#define OS_ROBIN_TIMEOUT</b>.</p>
<h2><a class="anchor" id="systemConfig_isr_fifo"></a>
ISR FIFO Queue</h2>
<p>The RTX functions (<a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Calls from Interrupt Service Routines</a>), when called from and interrupt handler, store the request type and optional parameter to the ISR FIFO queue buffer to be processed later, after the interrupt handler exits.</p>
<p>The scheduler is activated immediately after the IRQ handler has finished its execution to process the requests stored to the FIFO queue buffer. The required size of this buffer depends on the number of functions that are called within the interrupt handler. An insufficient queue size will be caught by <b>osRtxErrorNotify</b> with error code <b>osRtxErrorISRQueueOverflow</b>.</p>
<h2><a class="anchor" id="systemConfig_usage_counters"></a>
Object Memory Usage Counters</h2>
<p>Object memory usage counters help to evaluate the maximum memory pool requirements for each object type, just like stack watermarking does for threads. The initial setup starts with a global memory pool for all object types. Consecutive runs of the application with object memory usage counters enabled, help to introduce object specific memory pools for each object type. Normally, this is required for applications that require a functional safety certification as global memory pools are not allowed in this case.</p>
<h1><a class="anchor" id="threadConfig"></a>
Thread Configuration</h1>
<p>The RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> functions.</p>
<p><b>Thread Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_threads.png" alt="config_wizard_threads.png"/>
<div class="caption">
RTX_Config.h: Thread Configuration</div></div>
<p> <br/>
</p>
<table class="doxtable">
<tr>
<th align="left">Option </th><th align="left">#define </th><th align="left">Description </th></tr>
<tr>
<td align="left">Object specific Memory allocation </td><td align="left"><code>OS_THREAD_OBJ_MEM</code> </td><td align="left">Enables object specific memory allocation. See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>. </td></tr>
<tr>
<td align="left">Number of user Threads </td><td align="left"><code>OS_THREAD_NUM</code> </td><td align="left">Defines maximum number of user threads that can be active at the same time. Applies to user threads with system provided memory for control blocks. Default value is <span class="XML-Token">1</span>. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
<tr>
<td align="left">Number of user Threads with default Stack size </td><td align="left"><code>OS_THREAD_DEF_STACK_NUM</code> </td><td align="left">Defines maximum number of user threads with default stack size and applies to user threads with <span class="XML-Token">0</span> stack size specified. Value range is <span class="XML-Token">[0-1000]</span>. </td></tr>
<tr>
<td align="left">Total Stack size [bytes] for user Threads with user-provided Stack size </td><td align="left"><code>OS_THREAD_USER_STACK_SIZE</code> </td><td align="left">Defines the combined stack size for user threads with user-provided stack size. Default value is <span class="XML-Token">0</span>. Value range is <span class="XML-Token">[0-1073741824]</span> Bytes, in multiples of <span class="XML-Token">8</span>. </td></tr>
<tr>
<td align="left">Default Thread Stack size [bytes] </td><td align="left"><code>OS_STACK_SIZE</code> </td><td align="left">Defines stack size for threads with zero stack size specified. Default value is <span class="XML-Token">200</span>. Value range is <span class="XML-Token">[96-1073741824]</span> Bytes, in multiples of <span class="XML-Token">8</span>. </td></tr>
<tr>
<td align="left">Idle Thread Stack size [bytes] </td><td align="left"><code>OS_IDLE_THREAD_STACK_SIZE</code> </td><td align="left">Defines stack size for Idle thread. Default value is <span class="XML-Token">200</span>. Value range is <span class="XML-Token">[72-1073741824]</span> bytes, in multiples of <span class="XML-Token">8</span>. </td></tr>
<tr>
<td align="left">Idle Thread TrustZone Module ID </td><td align="left"><code>OS_IDLE_THREAD_TZ_MOD_ID</code> </td><td align="left">Defines the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#a697f2aad6119d655d212ea10245ae394">TrustZone Module ID</a> the Idle Thread shall use. This needs to be set to a non-zero value if the Idle Thread need to call secure functions. Default value is <span class="XML-Token">0</span>. </td></tr>
<tr>
<td align="left">Stack overrun checking </td><td align="left"><code>OS_STACK_CHECK</code> </td><td align="left">Enable stack overrun checks at thread switch. </td></tr>
<tr>
<td align="left">Stack usage watermark </td><td align="left"><code>OS_STACK_WATERMARK</code> </td><td align="left">Initialize thread stack with watermark pattern for analyzing stack usage. Enabling this option increases significantly the execution time of thread creation. </td></tr>
<tr>
<td align="left">Processor mode for Thread execution </td><td align="left"><code>OS_PRIVILEGE_MODE</code> </td><td align="left">Controls the processor mode. Default value is <span class="XML-Token">Privileged</span> mode. Value range is <span class="XML-Token">[0=Unprivileged; 1=Privileged]</span> mode. </td></tr>
</table>
<h2><a class="anchor" id="threadConfig_countstack"></a>
Configuration of Thread Count and Stack Space</h2>
<p>The RTX5 kernel uses a separate stack space for each thread and provides two methods for defining the stack requirements:</p>
<ul>
<li><b>Static allocation</b>: when <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ad7c9b42355a4c8b9467130ab3fb19e43">osThreadAttr_t::stack_mem</a> and <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#aacbc9a219f2d6870e9ce89bb93f975c9">osThreadAttr_t::stack_size</a> specify a memory area which is used for the thread stack. <b>Attention:</b> The stack memory provided must be 64-bit aligned, i.e. by using uint64_t for declaration.</li>
<li><b>Dynamic allocation</b>: when <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#structosThreadAttr__t">osThreadAttr_t</a> is NULL or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ad7c9b42355a4c8b9467130ab3fb19e43">osThreadAttr_t::stack_mem</a> is NULL, the system allocates the stack memory from:<ul>
<li>Object-specific Memory Pool (default Stack size) when "Object specific Memory allocation" is enabled and "Number of
user Threads with default Stack size" is not <span class="XML-Token">0</span> and <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#aacbc9a219f2d6870e9ce89bb93f975c9">osThreadAttr_t::stack_size</a> is <span class="XML-Token">0</span> (or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#structosThreadAttr__t">osThreadAttr_t</a> is NULL).</li>
<li>Object-specific Memory Pool (user-provided Stack size) when "Object specific Memory allocation" is enabled and "Total
Stack size for user..." is not <span class="XML-Token">0</span> and <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#aacbc9a219f2d6870e9ce89bb93f975c9">osThreadAttr_t::stack_size</a> is not <span class="XML-Token">0</span>.</li>
<li>Global Memory Pool when "Object specific Memory allocation" is disabled or (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#aacbc9a219f2d6870e9ce89bb93f975c9">osThreadAttr_t::stack_size</a> is not <span class="XML-Token">0</span> and "Total Stack size for user..." is <span class="XML-Token">0</span>) or (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#aacbc9a219f2d6870e9ce89bb93f975c9">osThreadAttr_t::stack_size</a> is <span class="XML-Token">0</span> and "Number of user Threads with default Stack size" is <span class="XML-Token">0</span>).</li>
</ul>
</li>
</ul>
<p><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#structosThreadAttr__t">osThreadAttr_t</a> is a parameter of the function <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>.</p>
<dl class="section note"><dt>Note</dt><dd>Before the RTX kernel is started by the <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart()</a> function, the main stack defined in startup_<em>device</em>.s is used. The main stack is also used for:<ul>
<li>user application calls to RTX functions in <b>thread</b> <b>mode</b> using SVC calls</li>
<li>interrupt/exception handlers.</li>
</ul>
</dd></dl>
<h2><a class="anchor" id="threadConfig_ovfcheck"></a>
Stack Overflow Checking</h2>
<p>RTX5 implements a software stack overflow checking that traps stack overruns. Stack is used for return addresses and automatic variables. Extensive usage or incorrect stack configuration may cause a stack overflow. Software stack overflow checking is controlled with the define <code>OS_STACK_CHECK</code>.</p>
<p>If a stack overflow is detected, the function <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> with error code <a class="el" href="group__rtx5__specific__defines.html#ga42206aa2524b8fab613d26bea0f73c44">osRtxErrorStackUnderflow</a> is called. By default, this function is implemented as an endless loop and will practically stop code execution.</p>
<h2><a class="anchor" id="threadConfig_watermark"></a>
Stack Usage Watermark</h2>
<p>RTX5 initializes thread stack with a watermark pattern (0xCC) when a thread is created. This allows the debugger to determine the maximum stack usage for each thread. It is typically used during development but removed from the final application. Stack usage watermark is controlled with the define <code>OS_STACK_WATERMARK</code>.</p>
<p>Enabling this option significantly increases the execution time of <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> (depends on thread stack size).</p>
<h2><a class="anchor" id="threadConfig_procmode"></a>
Processor Mode for Thread Execution</h2>
<p>RTX5 allows to execute threads in unprivileged or privileged processor mode. The processor mode is controlled with the define <code>OS_PRIVILEGE_MODE</code>.</p>
<p>In <b>unprivileged</b> processor mode, the application software:</p>
<ul>
<li>has limited access to the MSR and MRS instructions, and cannot use the CPS instruction.</li>
<li>cannot access the system timer, NVIC, or system control block.</li>
<li>might have restricted access to memory or peripherals.</li>
</ul>
<p>In <b>privileged</b> processor mode, the application software can use all the instructions and has access to all resources.</p>
<h1><a class="anchor" id="timerConfig"></a>
Timer Configuration</h1>
<p>RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> functions.</p>
<p><b>Timer Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_timer.png" alt="config_wizard_timer.png"/>
<div class="caption">
RTX_Config.h: Timer Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Object specific Memory allocation </td><td><code>OS_TIMER_OBJ_MEM</code> </td><td>Enables object specific memory allocation. </td></tr>
<tr>
<td>Number of Timer objects </td><td><code>OS_TIMER_NUM</code> </td><td>Defines maximum number of objects that can be active at the same time. Applies to objects with system provided memory for control blocks. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
<tr>
<td>Timer Thread Priority </td><td><code>OS_TIMER_THREAD_PRIO</code> </td><td>Defines priority for timer thread. Default value is <span class="XML-Token">40</span>. Value range is <span class="XML-Token">[8-48]</span>, in multiples of <span class="XML-Token">8</span>. The numbers have the following priority correlation: <span class="XML-Token">8=Low</span>; <span class="XML-Token">16=Below Normal</span>; <span class="XML-Token">24=Normal</span>; <span class="XML-Token">32=Above Normal</span>; <span class="XML-Token">40=High</span>; <span class="XML-Token">48=Realtime</span> </td></tr>
<tr>
<td>Timer Thread Stack size [bytes] </td><td><code>OS_TIMER_THREAD_STACK_SIZE</code> </td><td>Defines stack size for Timer thread. May be set to 0 when timers are not used. Default value is <span class="XML-Token">200</span>. Value range is <span class="XML-Token">[0-1073741824]</span>, in multiples of <span class="XML-Token">8</span>. </td></tr>
<tr>
<td>Timer Thread TrustZone Module ID </td><td><code>OS_TIMER_THREAD_TZ_MOD_ID</code> </td><td>Defines the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#a697f2aad6119d655d212ea10245ae394">TrustZone Module ID</a> the Timer Thread shall use. This needs to be set to a non-zero value if any Timer Callbacks need to call secure functions. Default value is <span class="XML-Token">0</span>. </td></tr>
<tr>
<td>Timer Callback Queue entries </td><td><code>OS_TIMER_CB_QUEUE</code> </td><td>Number of concurrent active timer callback functions. May be set to 0 when timers are not used. Default value is <span class="XML-Token">4</span>. Value range is <span class="XML-Token">[0-256]</span>. </td></tr>
</table>
<h2><a class="anchor" id="timerConfig_obj"></a>
Object-specific memory allocation</h2>
<p>See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>.</p>
<h2><a class="anchor" id="timerConfig_user"></a>
User Timer Thread</h2>
<p>The RTX5 function <b>osRtxTimerThread</b> executes callback functions when a time period expires. The priority of the timer subsystem within the complete RTOS system is inherited from the priority of the <b>osRtxTimerThread</b>. This is configured by <code>OS_TIMER_THREAD_PRIO</code>. Stack for callback functions is supplied by <b>osRtxTimerThread</b>. <code>OS_TIMER_THREAD_STACK_SIZE</code> must satisfy the stack requirements of the callback function with the highest stack usage.</p>
<h1><a class="anchor" id="eventFlagsConfig"></a>
Event Flags Configuration</h1>
<p>RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> functions.</p>
<p><b>Event Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_eventFlags.png" alt="config_wizard_eventFlags.png"/>
<div class="caption">
RTX_Config.h: Event Flags Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Object specific Memory allocation </td><td><code>OS_EVFLAGS_OBJ_MEM</code> </td><td>Enables object specific memory allocation. See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>. </td></tr>
<tr>
<td>Number of Event Flags objects </td><td><code>OS_EVFLAGS_NUM</code> </td><td>Defines maximum number of objects that can be active at the same time. Applies to objects with system provided memory for control blocks. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
</table>
<h2><a class="anchor" id="eventFlagsConfig_obj"></a>
Object-specific memory allocation</h2>
<p>When object-specific memory is used, the pool size for all Event objects is specified by <code>OS_EVFLAGS_NUM</code>. Refer to <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>.</p>
<h1><a class="anchor" id="mutexConfig"></a>
Mutex Configuration</h1>
<p>RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</a> functions.</p>
<p><b>Mutex Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_mutex.png" alt="config_wizard_mutex.png"/>
<div class="caption">
RTX_Config.h: Mutex Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Object specific Memory allocation </td><td><code>OS_MUTEX_OBJ_MEM</code> </td><td>Enables object specific memory allocation. See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>. </td></tr>
<tr>
<td>Number of Mutex objects </td><td><code>OS_MUTEX_NUM</code> </td><td>Defines maximum number of objects that can be active at the same time. Applies to objects with system provided memory for control blocks. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
</table>
<h2><a class="anchor" id="mutexConfig_obj"></a>
Object-specific Memory Allocation</h2>
<p>When object-specific memory is used, the pool size for all Mutex objects is specified by <code>OS_MUTEX_NUM</code>. Refer to <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>.</p>
<h1><a class="anchor" id="semaphoreConfig"></a>
Semaphore Configuration</h1>
<p>RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</a> functions.</p>
<p><b>Semaphore Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_semaphore.png" alt="config_wizard_semaphore.png"/>
<div class="caption">
RTX_Config.h: Semaphore Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Object specific Memory allocation </td><td><code>OS_SEMAPHORE_OBJ_MEM</code> </td><td>Enables object specific memory allocation. See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>. </td></tr>
<tr>
<td>Number of Semaphore objects </td><td><code>OS_SEMAPHORE_NUM</code> </td><td>Defines maximum number of objects that can be active at the same time. Applies to objects with system provided memory for control blocks. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
</table>
<h2><a class="anchor" id="semaphoreConfig_obj"></a>
Object-specific memory allocation</h2>
<p>When Object-specific Memory is used, the pool size for all Semaphore objects is specified by <code>OS_SEMAPHORE_NUM</code>. Refer to <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>.</p>
<h1><a class="anchor" id="memPoolConfig"></a>
Memory Pool Configuration</h1>
<p>RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a> functions.</p>
<p><b>Memory Pool Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_memPool.png" alt="config_wizard_memPool.png"/>
<div class="caption">
RTX_Config.h: Memory Pool Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Object specific Memory allocation </td><td><code>OS_MEMPOOL_OBJ_MEM</code> </td><td>Enables object specific memory allocation. See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>. </td></tr>
<tr>
<td>Number of Memory Pool objects </td><td><code>OS_MEMPOOL_NUM</code> </td><td>Defines maximum number of objects that can be active at the same time. Applies to objects with system provided memory for control blocks. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
<tr>
<td>Data Storage Memory size [bytes] </td><td><code>OS_MEMPOOL_DATA_SIZE</code> </td><td>Defines the combined data storage memory size. Applies to objects with system provided memory for data storage. Default value is <span class="XML-Token">0</span>. Value range is <span class="XML-Token">[0-1073741824]</span>, in multiples of <span class="XML-Token">8</span>. </td></tr>
</table>
<h2><a class="anchor" id="memPoolConfig_obj"></a>
Object-specific memory allocation</h2>
<p>When object-specific memory is used, the number of pools for all MemoryPool objects is specified by <code>OS_MEMPOOL_NUM</code>. The total storage size reserved for all pools is configured in <code>OS_MEMPOOL_DATA_SIZE</code>. Refer to <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>.</p>
<h1><a class="anchor" id="msgQueueConfig"></a>
Message Queue Configuration</h1>
<p>RTX5 provides several parameters to configure the <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a> functions.</p>
<p><b>MessageQueue Configuration Options</b> </p>
<div class="image">
<img src="config_wizard_msgQueue.png" alt="config_wizard_msgQueue.png"/>
<div class="caption">
RTX_Config.h: Message Queue Configuration</div></div>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Object specific Memory allocation </td><td><code>OS_MSGQUEUE_OBJ_MEM</code> </td><td>Enables object specific memory allocation. See <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>. </td></tr>
<tr>
<td>Number of Message Queue objects </td><td><code>OS_MSGQUEUE_NUM</code> </td><td>Defines maximum number of objects that can be active at the same time. Applies to objects with system provided memory for control blocks. Value range is <span class="XML-Token">[1-1000]</span>. </td></tr>
<tr>
<td>Data Storage Memory size [bytes] </td><td><code>OS_MSGQUEUE_DATA_SIZE</code> </td><td>Defines the combined data storage memory size. Applies to objects with system provided memory for data storage. Default value is <span class="XML-Token">0</span>. Value range is <span class="XML-Token">[0-1073741824]</span>, in multiples of <span class="XML-Token">8</span>. </td></tr>
</table>
<h2><a class="anchor" id="msgQueueConfig_obj"></a>
Object-specific memory allocation</h2>
<p>When Object-specific Memory is used, the number of queues for all Message Queue objects is specified by <code>OS_MSGQUEUE_NUM</code>. The total storage size reserved for all queues is configured in <code>OS_MSGQUEUE_DATA_SIZE</code>. Refer to <a class="el" href="theory_of_operation.html#ObjectMemoryPool">Object-specific Memory Pools</a>.</p>
<h1><a class="anchor" id="evtrecConfig"></a>
Event Recorder Configuration</h1>
<p>This section describes the configuration settings for the <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank">Event Recorder</a> annotations. The usage requires the source variant of RTX5; refer to <a class="el" href="cre_rtx_proj.html#cre_rtx_proj_er">Add Event Recorder Visibility</a> for more information.</p>
<h2><a class="anchor" id="evtrecConfigGlobIni"></a>
Global Configuration</h2>
<p>Initialize Event Recorder during the <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> and optionally start event recording.</p>
<div class="image">
<img src="config_wizard_evtrecGlobIni.png" alt="config_wizard_evtrecGlobIni.png"/>
<div class="caption">
RTX_Config.h: Global Configuration</div></div>
<p> <br/>
</p>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Global Initialization </td><td><code>OS_EVR_INIT</code> </td><td>Initialize Event Recorder during <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>. </td></tr>
<tr>
<td>Start Recording </td><td><code>OS_EVR_START</code> </td><td>Start event recording after initialization. </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>If <b>Global Initialization (<code>OS_EVR_INIT</code>)</b> is set, an explicit call to <code>EventRecorderInitialize</code> is not required.</li>
<li>If <b>Start Recording (<code>OS_EVR_START</code>)</b> is set, an explicit call to <code>EventRecorderStart</code> is not required. You may call the function <code>EventRecorderStop</code> to stop recording.</li>
</ul>
</dd></dl>
<p><b>Global Event Filter Setup</b></p>
<p>These event filter settings are applied to all software component numbers, including MDK middleware and user components.</p>
<div class="image">
<img src="config_wizard_evtrecGlobEvtFiltSetup.png" alt="config_wizard_evtrecGlobEvtFiltSetup.png"/>
<div class="caption">
RTX_Config.h: Global Event Filter Setup</div></div>
<p> <br/>
</p>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Error events </td><td><code>OS_EVR_LEVEL</code> </td><td>Enable error events. </td></tr>
<tr>
<td>API function call events </td><td><code>OS_EVR_LEVEL</code> </td><td>Enable API function call events. </td></tr>
<tr>
<td>Operation events </td><td><code>OS_EVR_LEVEL</code> </td><td>Enable operation events. </td></tr>
<tr>
<td>Detailed operation events </td><td><code>OS_EVR_LEVEL</code> </td><td>Enable detailed operation events. </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd>You may disable event recording for specific software components by calling the function <code>EventRecorderDisable</code>.</dd></dl>
<p><b>RTOS Event Filter Setup</b></p>
<p>These event filter settings are applied to specific RTX component groups with sub-options for:</p>
<ul>
<li>Error events</li>
<li>API function call events</li>
<li>Operation events</li>
<li>Detailed operation events</li>
</ul>
<p>The generation of events must be enabled as explained under <a class="el" href="config_rtx5.html#evtrecConfigEvtGen">RTOS Event Generation</a>.</p>
<div class="image">
<img src="config_wizard_evtrecRTOSEvtFilterSetup.png" alt="config_wizard_evtrecRTOSEvtFilterSetup.png"/>
<div class="caption">
RTX_Config.h: RTOS Event Filter Setup</div></div>
<p> <br/>
</p>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Memory Management </td><td><code>OS_EVR_MEMORY_LEVEL</code> </td><td>Recording level for Memory Management events. </td></tr>
<tr>
<td>Kernel </td><td><code>OS_EVR_KERNEL_LEVEL</code> </td><td>Recording level for Kernel events. </td></tr>
<tr>
<td>Thread </td><td><code>OS_EVR_THREAD_LEVEL</code> </td><td>Recording level for Thread events. </td></tr>
<tr>
<td>Generic Wait </td><td><code>OS_EVR_WAIT_LEVEL</code> </td><td>Recording level for Generic Wait events. </td></tr>
<tr>
<td>Thread Flags </td><td><code>OS_EVR_THFLAGS_LEVEL</code> </td><td>Recording level for Thread Flags events. </td></tr>
<tr>
<td>Event Flags </td><td><code>OS_EVR_EVFLAGS_LEVEL</code> </td><td>Recording level for Event Flags events. </td></tr>
<tr>
<td>Timer </td><td><code>OS_EVR_TIMER_LEVEL</code> </td><td>Recording level for Timer events. </td></tr>
<tr>
<td>Mutex </td><td><code>OS_EVR_MUTEX_LEVEL</code> </td><td>Recording level for Mutex events. </td></tr>
<tr>
<td>Semaphore </td><td><code>OS_EVR_SEMAPHORE_LEVEL</code> </td><td>Recording level for Semaphore events. </td></tr>
<tr>
<td>Memory Pool </td><td><code>OS_EVR_MEMPOOL_LEVEL</code> </td><td>Recording level for Memory Pool events. </td></tr>
<tr>
<td>Message Queue </td><td><code>OS_EVR_MSGQUEUE_LEVEL</code> </td><td>Recording level for Message Queue events. </td></tr>
</table>
<h2><a class="anchor" id="evtrecConfigEvtGen"></a>
RTOS Event Generation</h2>
<p>Enable the event generation for specific RTX component groups. This requires the RTX source variant (refer to <a class="el" href="cre_rtx_proj.html#cre_rtx_proj_er">Add Event Recorder Visibility</a> for more information).</p>
<div class="image">
<img src="config_wizard_evtrecGeneration.png" alt="config_wizard_evtrecGeneration.png"/>
<div class="caption">
RTX_Config.h: Event generation configuration</div></div>
<p> <br/>
</p>
<table class="doxtable">
<tr>
<th>Name </th><th>#define </th><th>Description </th></tr>
<tr>
<td>Memory Management </td><td><code>OS_EVR_MEMORY</code> </td><td>Enables Memory Management events generation. </td></tr>
<tr>
<td>Kernel </td><td><code>OS_EVR_KERNEL</code> </td><td>Enables Kernel events generation. </td></tr>
<tr>
<td>Thread </td><td><code>OS_EVR_THREAD</code> </td><td>Enables Thread events generation. </td></tr>
<tr>
<td>Generic Wait </td><td><code>OS_EVR_WAIT</code> </td><td>Enables Generic Wait events generation. </td></tr>
<tr>
<td>Thread Flags </td><td><code>OS_EVR_THFLAGS</code> </td><td>Enables Thread Flags events generation. </td></tr>
<tr>
<td>Event Flags </td><td><code>OS_EVR_EVFLAGS</code> </td><td>Enables Event Flags events generation. </td></tr>
<tr>
<td>Timer </td><td><code>OS_EVR_TIMER</code> </td><td>Enables Timer events generation. </td></tr>
<tr>
<td>Mutex </td><td><code>OS_EVR_MUTEX</code> </td><td>Enables Mutex events generation. </td></tr>
<tr>
<td>Semaphore </td><td><code>OS_EVR_SEMAPHORE</code> </td><td>Enables Semaphore events generation. </td></tr>
<tr>
<td>Memory Pool </td><td><code>OS_EVR_MEMPOOL</code> </td><td>Enables Memory Pool events generation. </td></tr>
<tr>
<td>Message Queue </td><td><code>OS_EVR_MSGQUEUE</code> </td><td>Enables Message Queue events generation. </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd>If event generation for a component is disabled, the code that generates the related events is not included. Thus, <a class="el" href="config_rtx5.html#evtrecConfigGlobIni">filters</a> for this component will have no effect and the debugger is unable to display any events for the related component group.</dd></dl>
<h2><a class="anchor" id="systemConfig_event_recording"></a>
Manual event configuration</h2>
<p>To disable the generation of events for a specific RTX API call, use the following #define settings (from <b>rtx_evrt.h</b>) and add these manually to the <b>RTX_Config.h</b> file:</p>
<p><b>Memory</b> <b>events</b> <br/>
<code>EVR_RTX_MEMORY_INIT_DISABLE</code>, <code>EVR_RTX_MEMORY_ALLOC_DISABLE</code>, <code>EVR_RTX_MEMORY_FREE_DISABLE</code>, <code>EVR_RTX_MEMORY_BLOCK_INIT_DISABLE</code>, <code>EVR_RTX_MEMORY_BLOCK_ALLOC_DISABLE</code>, <code>EVR_RTX_MEMORY_BLOCK_FREE_DISABLE</code> </p>
<p><b>Kernel</b> <b>events</b> <br/>
<code>EVR_RTX_KERNEL_ERROR_DISABLE</code>, <code>EVR_RTX_KERNEL_INITIALIZE_DISABLE</code>, <code>EVR_RTX_KERNEL_INITIALIZED_DISABLE</code>, <code>EVR_RTX_KERNEL_GET_INFO_DISABLE</code>, <code>EVR_RTX_KERNEL_INFO_RETRIEVED_DISABLE</code>, <code>EVR_RTX_KERNEL_GET_STATE_DISABLE</code>, <code>EVR_RTX_KERNEL_START_DISABLE</code>, <code>EVR_RTX_KERNEL_STARTED_DISABLE</code>, <code>EVR_RTX_KERNEL_LOCK_DISABLE</code>, <code>EVR_RTX_KERNEL_LOCKED_DISABLE</code>, <code>EVR_RTX_KERNEL_UNLOCK_DISABLE</code>, <code>EVR_RTX_KERNEL_UNLOCKED_DISABLE</code>, <code>EVR_RTX_KERNEL_RESTORE_LOCK_DISABLE</code>, <code>EVR_RTX_KERNEL_LOCK_RESTORED_DISABLE</code>, <code>EVR_RTX_KERNEL_SUSPEND_DISABLE</code>, <code>EVR_RTX_KERNEL_SUSPENDED_DISABLE</code>, <code>EVR_RTX_KERNEL_RESUME_DISABLE</code>, <code>EVR_RTX_KERNEL_RESUMED_DISABLE</code>, <code>EVR_RTX_KERNEL_GET_TICK_COUNT_DISABLE</code>, <code>EVR_RTX_KERNEL_GET_TICK_FREQ_DISABLE</code>, <code>EVR_RTX_KERNEL_GET_SYS_TIMER_COUNT_DISABLE</code>, <code>EVR_RTX_KERNEL_GET_SYS_TIMER_FREQ_DISABLE</code> </p>
<p><b>Thread</b> <b>events</b> <br/>
<code>EVR_RTX_THREAD_ERROR_DISABLE</code>, <code>EVR_RTX_THREAD_NEW_DISABLE</code>, <code>EVR_RTX_THREAD_CREATED_DISABLE</code>, <code>EVR_RTX_THREAD_GET_NAME_DISABLE</code>, <code>EVR_RTX_THREAD_GET_ID_DISABLE</code>, <code>EVR_RTX_THREAD_GET_STATE_DISABLE</code>, <code>EVR_RTX_THREAD_GET_STACK_SIZE_DISABLE</code>, <code>EVR_RTX_THREAD_GET_STACK_SPACE_DISABLE</code>, <code>EVR_RTX_THREAD_SET_PRIORITY_DISABLE</code>, <code>EVR_RTX_THREAD_PRIORITY_UPDATED_DISABLE</code>, <code>EVR_RTX_THREAD_GET_PRIORITY_DISABLE</code>, <code>EVR_RTX_THREAD_YIELD_DISABLE</code>, <code>EVR_RTX_THREAD_SUSPEND_DISABLE</code>, <code>EVR_RTX_THREAD_SUSPENDED_DISABLE</code>, <code>EVR_RTX_THREAD_RESUME_DISABLE</code>, <code>EVR_RTX_THREAD_RESUMED_DISABLE</code>, <code>EVR_RTX_THREAD_DETACH_DISABLE</code>, <code>EVR_RTX_THREAD_DETACHED_DISABLE</code>, <code>EVR_RTX_THREAD_JOIN_DISABLE</code>, <code>EVR_RTX_THREAD_JOIN_PENDING_DISABLE</code>, <code>EVR_RTX_THREAD_JOINED_DISABLE</code>, <code>EVR_RTX_THREAD_BLOCKED_DISABLE</code>, <code>EVR_RTX_THREAD_UNBLOCKED_DISABLE</code>, <code>EVR_RTX_THREAD_PREEMPTED_DISABLE</code>, <code>EVR_RTX_THREAD_SWITCHED_DISABLE</code>, <code>EVR_RTX_THREAD_EXIT_DISABLE</code>, <code>EVR_RTX_THREAD_TERMINATE_DISABLE</code>, <code>EVR_RTX_THREAD_DESTROYED_DISABLE</code>, <code>EVR_RTX_THREAD_GET_COUNT_DISABLE</code>, <code>EVR_RTX_THREAD_ENUMERATE_DISABLE</code> </p>
<p><b>Generic</b> <b>wait</b> <b>events</b> <br/>
<code>EVR_RTX_DELAY_ERROR_DISABLE</code>, <code>EVR_RTX_DELAY_DISABLE</code>, <code>EVR_RTX_DELAY_UNTIL_DISABLE</code>, <code>EVR_RTX_DELAY_STARTED_DISABLE</code>, <code>EVR_RTX_DELAY_UNTIL_STARTED_DISABLE</code>, <code>EVR_RTX_DELAY_COMPLETED_DISABLE</code> </p>
<p><b>Thread</b> <b>flag</b> <b>events</b> <br/>
<code>EVR_RTX_THREAD_FLAGS_ERROR_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_SET_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_SET_DONE_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_CLEAR_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_CLEAR_DONE_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_GET_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_WAIT_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_WAIT_PENDING_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_WAIT_TIMEOUT_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_WAIT_COMPLETED_DISABLE</code>, <code>EVR_RTX_THREAD_FLAGS_WAIT_NOT_COMPLETED_DISABLE</code> </p>
<p><b>Event</b> <b>flag</b> <b>events</b> <br/>
<code>EVR_RTX_EVENT_FLAGS_ERROR_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_NEW_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_CREATED_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_GET_NAME_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_SET_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_SET_DONE_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_CLEAR_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_CLEAR_DONE_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_GET_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_WAIT_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_WAIT_PENDING_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_WAIT_TIMEOUT_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_WAIT_COMPLETED_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_WAIT_NOT_COMPLETED_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_DELETE_DISABLE</code>, <code>EVR_RTX_EVENT_FLAGS_DESTROYED_DISABLE</code> </p>
<p><b>Timer</b> <b>events</b> <br/>
<code>EVR_RTX_TIMER_ERROR_DISABLE</code>, <code>EVR_RTX_TIMER_CALLBACK_DISABLE</code>, <code>EVR_RTX_TIMER_NEW_DISABLE</code>, <code>EVR_RTX_TIMER_CREATED_DISABLE</code>, <code>EVR_RTX_TIMER_GET_NAME_DISABLE</code>, <code>EVR_RTX_TIMER_START_DISABLE</code>, <code>EVR_RTX_TIMER_STARTED_DISABLE</code>, <code>EVR_RTX_TIMER_STOP_DISABLE</code>, <code>EVR_RTX_TIMER_STOPPED_DISABLE</code>, <code>EVR_RTX_TIMER_IS_RUNNING_DISABLE</code>, <code>EVR_RTX_TIMER_DELETE_DISABLE</code>, <code>EVR_RTX_TIMER_DESTROYED_DISABLE</code> </p>
<p><b>Mutex</b> <b>events</b> <br/>
<code>EVR_RTX_MUTEX_ERROR_DISABLE</code>, <code>EVR_RTX_MUTEX_NEW_DISABLE</code>, <code>EVR_RTX_MUTEX_CREATED_DISABLE</code>, <code>EVR_RTX_MUTEX_GET_NAME_DISABLE</code>, <code>EVR_RTX_MUTEX_ACQUIRE_DISABLE</code>, <code>EVR_RTX_MUTEX_ACQUIRE_PENDING_DISABLE</code>, <code>EVR_RTX_MUTEX_ACQUIRE_TIMEOUT_DISABLE</code>, <code>EVR_RTX_MUTEX_ACQUIRED_DISABLE</code>, <code>EVR_RTX_MUTEX_NOT_ACQUIRED_DISABLE</code>, <code>EVR_RTX_MUTEX_RELEASE_DISABLE</code>, <code>EVR_RTX_MUTEX_RELEASED_DISABLE</code>, <code>EVR_RTX_MUTEX_GET_OWNER_DISABLE</code>, <code>EVR_RTX_MUTEX_DELETE_DISABLE</code>, <code>EVR_RTX_MUTEX_DESTROYED_DISABLE</code> </p>
<p><b>Semaphore</b> <b>events</b> <br/>
<code>EVR_RTX_SEMAPHORE_ERROR_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_NEW_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_CREATED_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_GET_NAME_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_ACQUIRE_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_ACQUIRE_PENDING_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_ACQUIRE_TIMEOUT_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_ACQUIRED_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_NOT_ACQUIRED_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_RELEASE_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_RELEASED_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_GET_COUNT_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_DELETE_DISABLE</code>, <code>EVR_RTX_SEMAPHORE_DESTROYED_DISABLE</code> </p>
<p><b>Memory</b> <b>pool</b> <b>events</b> <br/>
<code>EVR_RTX_MEMORY_POOL_ERROR_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_NEW_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_CREATED_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_GET_NAME_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_ALLOC_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_ALLOC_PENDING_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_ALLOC_TIMEOUT_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_ALLOCATED_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_ALLOC_FAILED_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_FREE_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_DEALLOCATED_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_FREE_FAILED_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_GET_CAPACITY_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_GET_BLOCK_SZIE_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_GET_COUNT_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_GET_SPACE_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_DELETE_DISABLE</code>, <code>EVR_RTX_MEMORY_POOL_DESTROYED_DISABLE</code> </p>
<p><b>Message</b> <b>queue</b> <b>events</b> <br/>
<code>EVR_RTX_MESSAGE_QUEUE_ERROR_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_NEW_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_CREATED_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_NAME_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_PUT_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_PUT_PENDING_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_PUT_TIMEOUT_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_INSERT_PENDING_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_INSERTED_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_NOT_INSERTED_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_PENDING_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_TIMEOUT_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_RETRIEVED_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_NOT_RETRIEVED_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_CAPACITY_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_MSG_SIZE_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_COUNT_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_GET_SPACE_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_RESET_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_RESET_DONE_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_DELETE_DISABLE</code>, <code>EVR_RTX_MESSAGE_QUEUE_DESTROYED_DISABLE</code> </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="rtx5_impl.html">RTX v5 Implementation</a></li>
<li class="footer">Generated on Wed Jul 10 2019 15:21:04 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
|
