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
|
<!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>Macros</title>
<title>CMSIS-RTOS2: Macros</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><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('group__rtx5__specific__defines.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="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Macros<div class="ingroups"><a class="el" href="group__rtx5__specific.html">RTX v5 Specific API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>RTX5 macros.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga30d19272204231956582ebfff69567f6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga30d19272204231956582ebfff69567f6">osRtxThreadCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxThread__t">osRtxThread_t</a>)</td></tr>
<tr class="memdesc:ga30d19272204231956582ebfff69567f6"><td class="mdescLeft"> </td><td class="mdescRight">Thread Control Block size. <a href="#ga30d19272204231956582ebfff69567f6">More...</a><br/></td></tr>
<tr class="separator:ga30d19272204231956582ebfff69567f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf8a145fdeb24fd912971f0671b1a3603"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gaf8a145fdeb24fd912971f0671b1a3603">osRtxTimerCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxTimer__t">osRtxTimer_t</a>)</td></tr>
<tr class="memdesc:gaf8a145fdeb24fd912971f0671b1a3603"><td class="mdescLeft"> </td><td class="mdescRight">Timer Control Block size. <a href="#gaf8a145fdeb24fd912971f0671b1a3603">More...</a><br/></td></tr>
<tr class="separator:gaf8a145fdeb24fd912971f0671b1a3603"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68100c8c44931f03547973294c433075"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga68100c8c44931f03547973294c433075">osRtxEventFlagsCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxEventFlags__t">osRtxEventFlags_t</a>)</td></tr>
<tr class="memdesc:ga68100c8c44931f03547973294c433075"><td class="mdescLeft"> </td><td class="mdescRight">Event Flags Control Block size. <a href="#ga68100c8c44931f03547973294c433075">More...</a><br/></td></tr>
<tr class="separator:ga68100c8c44931f03547973294c433075"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga188bfaaf7477cf24cbc9f207feaeb53a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga188bfaaf7477cf24cbc9f207feaeb53a">osRtxMutexCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMutex__t">osRtxMutex_t</a>)</td></tr>
<tr class="memdesc:ga188bfaaf7477cf24cbc9f207feaeb53a"><td class="mdescLeft"> </td><td class="mdescRight">Mutex Control Block size. <a href="#ga188bfaaf7477cf24cbc9f207feaeb53a">More...</a><br/></td></tr>
<tr class="separator:ga188bfaaf7477cf24cbc9f207feaeb53a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0949b67063d0bd427fbee9c816b5d45a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga0949b67063d0bd427fbee9c816b5d45a">osRtxSemaphoreCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxSemaphore__t">osRtxSemaphore_t</a>)</td></tr>
<tr class="memdesc:ga0949b67063d0bd427fbee9c816b5d45a"><td class="mdescLeft"> </td><td class="mdescRight">Semaphore Control Block size. <a href="#ga0949b67063d0bd427fbee9c816b5d45a">More...</a><br/></td></tr>
<tr class="separator:ga0949b67063d0bd427fbee9c816b5d45a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab8e49e9e1eea5a015f2a3114cabceb48"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gab8e49e9e1eea5a015f2a3114cabceb48">osRtxMemoryPoolCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMemoryPool__t">osRtxMemoryPool_t</a>)</td></tr>
<tr class="memdesc:gab8e49e9e1eea5a015f2a3114cabceb48"><td class="mdescLeft"> </td><td class="mdescRight">Memory Pool Control Block size. <a href="#gab8e49e9e1eea5a015f2a3114cabceb48">More...</a><br/></td></tr>
<tr class="separator:gab8e49e9e1eea5a015f2a3114cabceb48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa8d067c476faa6bfc8e5e21f3b3c844e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gaa8d067c476faa6bfc8e5e21f3b3c844e">osRtxMessageQueueCbSize</a>   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMessageQueue__t">osRtxMessageQueue_t</a>)</td></tr>
<tr class="memdesc:gaa8d067c476faa6bfc8e5e21f3b3c844e"><td class="mdescLeft"> </td><td class="mdescRight">Message Queue Control Block size. <a href="#gaa8d067c476faa6bfc8e5e21f3b3c844e">More...</a><br/></td></tr>
<tr class="separator:gaa8d067c476faa6bfc8e5e21f3b3c844e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac6bea3541b458bbc79eafce42a2d87a2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gac6bea3541b458bbc79eafce42a2d87a2">osRtxMemoryPoolMemSize</a>(block_count, block_size)   (4*(block_count)*(((block_size)+3)/4))</td></tr>
<tr class="memdesc:gac6bea3541b458bbc79eafce42a2d87a2"><td class="mdescLeft"> </td><td class="mdescRight">Memory Pool Memory size. <a href="#gac6bea3541b458bbc79eafce42a2d87a2">More...</a><br/></td></tr>
<tr class="separator:gac6bea3541b458bbc79eafce42a2d87a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga47eb1e21f1bf9a42281c6c89c7473e99"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga47eb1e21f1bf9a42281c6c89c7473e99">osRtxMessageQueueMemSize</a>(msg_count, msg_size)   (4*(msg_count)*(3+(((msg_size)+3)/4)))</td></tr>
<tr class="memdesc:ga47eb1e21f1bf9a42281c6c89c7473e99"><td class="mdescLeft"> </td><td class="mdescRight">Message Queue Memory size. <a href="#ga47eb1e21f1bf9a42281c6c89c7473e99">More...</a><br/></td></tr>
<tr class="separator:ga47eb1e21f1bf9a42281c6c89c7473e99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42206aa2524b8fab613d26bea0f73c44"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga42206aa2524b8fab613d26bea0f73c44">osRtxErrorStackUnderflow</a>   1U</td></tr>
<tr class="memdesc:ga42206aa2524b8fab613d26bea0f73c44"><td class="mdescLeft"> </td><td class="mdescRight">Stack overflow, i.e. stack pointer below its lower memory limit for descending stacks. <a href="#ga42206aa2524b8fab613d26bea0f73c44">More...</a><br/></td></tr>
<tr class="separator:ga42206aa2524b8fab613d26bea0f73c44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7377235f9fa3cedee06f682cd93f3e88"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga7377235f9fa3cedee06f682cd93f3e88">osRtxErrorISRQueueOverflow</a>   2U</td></tr>
<tr class="memdesc:ga7377235f9fa3cedee06f682cd93f3e88"><td class="mdescLeft"> </td><td class="mdescRight">ISR Queue overflow detected when inserting object. <a href="#ga7377235f9fa3cedee06f682cd93f3e88">More...</a><br/></td></tr>
<tr class="separator:ga7377235f9fa3cedee06f682cd93f3e88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaad420018f26e751ec55d3922a283beb0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gaad420018f26e751ec55d3922a283beb0">osRtxErrorTimerQueueOverflow</a>   3U</td></tr>
<tr class="memdesc:gaad420018f26e751ec55d3922a283beb0"><td class="mdescLeft"> </td><td class="mdescRight">User Timer Callback Queue overflow detected for timer. <a href="#gaad420018f26e751ec55d3922a283beb0">More...</a><br/></td></tr>
<tr class="separator:gaad420018f26e751ec55d3922a283beb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga14a24724f6e87744ba84674ef76e4256"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga14a24724f6e87744ba84674ef76e4256">osRtxErrorClibSpace</a>   4U</td></tr>
<tr class="memdesc:ga14a24724f6e87744ba84674ef76e4256"><td class="mdescLeft"> </td><td class="mdescRight">Standard C/C++ library libspace not available. <a href="#ga14a24724f6e87744ba84674ef76e4256">More...</a><br/></td></tr>
<tr class="separator:ga14a24724f6e87744ba84674ef76e4256"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac749c24b9cf6c49b392b015ed0517cfc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gac749c24b9cf6c49b392b015ed0517cfc">osRtxErrorClibMutex</a>   5U</td></tr>
<tr class="memdesc:gac749c24b9cf6c49b392b015ed0517cfc"><td class="mdescLeft"> </td><td class="mdescRight">Standard C/C++ library mutex initialization failed. <a href="#gac749c24b9cf6c49b392b015ed0517cfc">More...</a><br/></td></tr>
<tr class="separator:gac749c24b9cf6c49b392b015ed0517cfc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga30d19272204231956582ebfff69567f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxThreadCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxThread__t">osRtxThread_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Thread Control Block, see <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osThreadAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#aa55a4335d12dc2785dc00fdc292d1159">osThreadAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for thread control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t thread_cb[<a class="code" href="group__rtx5__specific__defines.html#ga30d19272204231956582ebfff69567f6">osRtxThreadCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaf8a145fdeb24fd912971f0671b1a3603"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxTimerCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxTimer__t">osRtxTimer_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Timer Control Block, see <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osTimerAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#aa55a4335d12dc2785dc00fdc292d1159">osTimerAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for timer control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t timer_cb[<a class="code" href="group__rtx5__specific__defines.html#gaf8a145fdeb24fd912971f0671b1a3603">osRtxTimerCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga68100c8c44931f03547973294c433075"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxEventFlagsCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxEventFlags__t">osRtxEventFlags_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Event Flags Control Block, see <a class="el" href="group__CMSIS__RTOS__EventFlags.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osEventFlagsAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__EventFlags.html#aa55a4335d12dc2785dc00fdc292d1159">osEventFlagsAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for event flags control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t evflags_cb[<a class="code" href="group__rtx5__specific__defines.html#ga68100c8c44931f03547973294c433075">osRtxEventFlagsCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga188bfaaf7477cf24cbc9f207feaeb53a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxMutexCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMutex__t">osRtxMutex_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Mutex Control Block, see <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osMutexAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#aa55a4335d12dc2785dc00fdc292d1159">osMutexAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for mutex control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t mutex_cb[<a class="code" href="group__rtx5__specific__defines.html#ga188bfaaf7477cf24cbc9f207feaeb53a">osRtxMutexCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga0949b67063d0bd427fbee9c816b5d45a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxSemaphoreCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxSemaphore__t">osRtxSemaphore_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Semaphore Control Block, see <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osSemaphoreAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#aa55a4335d12dc2785dc00fdc292d1159" title="size of provided memory for control block ">osSemaphoreAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for semaphore control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t sema_cb[<a class="code" href="group__rtx5__specific__defines.html#ga0949b67063d0bd427fbee9c816b5d45a">osRtxSemaphoreCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gab8e49e9e1eea5a015f2a3114cabceb48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxMemoryPoolCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMemoryPool__t">osRtxMemoryPool_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Memory Pool Control Block, see <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osMemoryPoolAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#aa55a4335d12dc2785dc00fdc292d1159" title="size of provided memory for control block ">osMemoryPoolAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for memory pool control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t mempool_cb[<a class="code" href="group__rtx5__specific__defines.html#gab8e49e9e1eea5a015f2a3114cabceb48">osRtxMemoryPoolCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaa8d067c476faa6bfc8e5e21f3b3c844e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxMessageQueueCbSize   sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMessageQueue__t">osRtxMessageQueue_t</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro exposes the minimum amount of memory needed for an RTX5 Message Queue Control Block, see <a class="el" href="group__CMSIS__RTOS__Message.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block ">osMessageQueueAttr_t::cb_mem</a> and <a class="el" href="group__CMSIS__RTOS__Message.html#aa55a4335d12dc2785dc00fdc292d1159" title="size of provided memory for control block ">osMessageQueueAttr_t::cb_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Used-defined memory for message queue control block</span></div>
<div class="line"><span class="keyword">static</span> uint32_t msgqueue_cb[<a class="code" href="group__rtx5__specific__defines.html#gaa8d067c476faa6bfc8e5e21f3b3c844e">osRtxMessageQueueCbSize</a>/4U];</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gac6bea3541b458bbc79eafce42a2d87a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxMemoryPoolMemSize</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">block_count, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">block_size </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (4*(block_count)*(((block_size)+3)/4))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory size in bytes for Memory Pool storage.</p>
<p>This macro exposes the minimum amount of memory needed for an RTX5 Memory Pool Memory, see <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#a5799465cca9c71c5587ceb0986f5b06a" title="memory for data storage ">osMemoryPoolAttr_t::mp_mem</a> and <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#a66c26015c0ac8e88a4ad907c120aee4f" title="size of provided memory for data storage ">osMemoryPoolAttr_t::mp_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Maximum number of objects</span></div>
<div class="line"><span class="preprocessor">#define OBJ_COUNT 8U</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"><span class="comment">// Object type</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> uint32_t value1;</div>
<div class="line"> uint8_t value2;</div>
<div class="line">} object_t;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Used-defined memory for memory pool memory</span></div>
<div class="line"><span class="keyword">static</span> uint32_t mempool_mem[<a class="code" href="group__rtx5__specific__defines.html#gac6bea3541b458bbc79eafce42a2d87a2">osRtxMemoryPoolMemSize</a>(OBJ_COUNT, <span class="keyword">sizeof</span>(object_t))/4U];</div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block_count</td><td>maximum number of memory blocks in memory pool. </td></tr>
<tr><td class="paramname">block_size</td><td>memory block size in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga47eb1e21f1bf9a42281c6c89c7473e99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxMessageQueueMemSize</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">msg_count, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">msg_size </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (4*(msg_count)*(3+(((msg_size)+3)/4)))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory size in bytes for Message Queue storage.</p>
<p>This macro exposes the minimum amount of memory needed for an RTX5 Message Queue Memory, see <a class="el" href="group__CMSIS__RTOS__Message.html#a4e208dc0fb049b42c4b90cbd2791c5ad" title="memory for data storage ">osMessageQueueAttr_t::mq_mem</a> and <a class="el" href="group__CMSIS__RTOS__Message.html#ac1cc09f875e20c926920b57bb83c70ee" title="size of provided memory for data storage ">osMessageQueueAttr_t::mq_size</a>.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="comment">// Maximum number of messages</span></div>
<div class="line"><span class="preprocessor">#define MSG_COUNT 16U</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"><span class="comment">// Message data type</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> uint32_t value1;</div>
<div class="line"> uint8_t value2;</div>
<div class="line">} msg_item_t;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Used-defined memory for message queue</span></div>
<div class="line"><span class="keyword">static</span> uint32_t mq_mem[<a class="code" href="group__rtx5__specific__defines.html#ga47eb1e21f1bf9a42281c6c89c7473e99">osRtxMessageQueueMemSize</a>(MSG_COUNT, <span class="keyword">sizeof</span>(msg_item_t))/4U];</div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg_count</td><td>maximum number of messages in queue. </td></tr>
<tr><td class="paramname">msg_size</td><td>maximum message size in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga42206aa2524b8fab613d26bea0f73c44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxErrorStackUnderflow   1U</td>
</tr>
</table>
</div><div class="memdoc">
<p>This error identifier is used with <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> when RTX5 detects a thread stack overflow. The object_id announced along this error can be used to identify the affected thread.</p>
<p><a class="el" href="config_rtx5.html#threadConfig_watermark">Stack Usage Watermark</a> used together with larger stack sizes can help to figure out actual memory requirements for threads.</p>
<dl class="section attention"><dt>Attention</dt><dd>Whenever this error identifier is signaled memory corruption has already happened. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7377235f9fa3cedee06f682cd93f3e88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxErrorISRQueueOverflow   2U</td>
</tr>
</table>
</div><div class="memdoc">
<p>This error identifier is used with <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> when RTX5 detects an overflow of the interrupt post processing message queue. The object_id can be used to identify the affected object.</p>
<dl class="section attention"><dt>Attention</dt><dd>Whenever this error identifier is signaled the system state is already inconsistent. </dd></dl>
</div>
</div>
<a class="anchor" id="gaad420018f26e751ec55d3922a283beb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxErrorTimerQueueOverflow   3U</td>
</tr>
</table>
</div><div class="memdoc">
<p>This error identifier is used with <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> when RTX5 detects an overflow of the timer callback queue. The object_id can be used to identify the affected timer.</p>
<dl class="section attention"><dt>Attention</dt><dd>Whenever this error identifier is signaled a timer callback is already lost. </dd></dl>
</div>
</div>
<a class="anchor" id="ga14a24724f6e87744ba84674ef76e4256"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxErrorClibSpace   4U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard C/C++ library libspace not available: increase <code>OS_THREAD_LIBSPACE_NUM</code>.</p>
<p>This error identifier is used with <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> when RTX5 detects usage of libspace but not enough memory was reserved using <code>OS_THREAD_LIBSPACE_NUM</code>. </p>
</div>
</div>
<a class="anchor" id="gac749c24b9cf6c49b392b015ed0517cfc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define osRtxErrorClibMutex   5U</td>
</tr>
</table>
</div><div class="memdoc">
<p>This error identifier is used with <a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> when RTX5 fails to create mutexes needed to lock global C/C++ library resources. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 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>
|
