group__rtx5__specific__defines.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Macros</title>
  7. <title>CMSIS-RTOS2: Macros</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-RTOS2
  35. &#160;<span id="projectnumber">Version 2.1.3</span>
  36. </div>
  37. <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__rtx5__specific__defines.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#define-members">Macros</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Macros<div class="ingroups"><a class="el" href="group__rtx5__specific.html">RTX v5 Specific API</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>RTX5 macros.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  118. Macros</h2></td></tr>
  119. <tr class="memitem:ga30d19272204231956582ebfff69567f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga30d19272204231956582ebfff69567f6">osRtxThreadCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxThread__t">osRtxThread_t</a>)</td></tr>
  120. <tr class="memdesc:ga30d19272204231956582ebfff69567f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread Control Block size. <a href="#ga30d19272204231956582ebfff69567f6">More...</a><br/></td></tr>
  121. <tr class="separator:ga30d19272204231956582ebfff69567f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gaf8a145fdeb24fd912971f0671b1a3603"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gaf8a145fdeb24fd912971f0671b1a3603">osRtxTimerCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxTimer__t">osRtxTimer_t</a>)</td></tr>
  123. <tr class="memdesc:gaf8a145fdeb24fd912971f0671b1a3603"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer Control Block size. <a href="#gaf8a145fdeb24fd912971f0671b1a3603">More...</a><br/></td></tr>
  124. <tr class="separator:gaf8a145fdeb24fd912971f0671b1a3603"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ga68100c8c44931f03547973294c433075"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga68100c8c44931f03547973294c433075">osRtxEventFlagsCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxEventFlags__t">osRtxEventFlags_t</a>)</td></tr>
  126. <tr class="memdesc:ga68100c8c44931f03547973294c433075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event Flags Control Block size. <a href="#ga68100c8c44931f03547973294c433075">More...</a><br/></td></tr>
  127. <tr class="separator:ga68100c8c44931f03547973294c433075"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ga188bfaaf7477cf24cbc9f207feaeb53a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga188bfaaf7477cf24cbc9f207feaeb53a">osRtxMutexCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMutex__t">osRtxMutex_t</a>)</td></tr>
  129. <tr class="memdesc:ga188bfaaf7477cf24cbc9f207feaeb53a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutex Control Block size. <a href="#ga188bfaaf7477cf24cbc9f207feaeb53a">More...</a><br/></td></tr>
  130. <tr class="separator:ga188bfaaf7477cf24cbc9f207feaeb53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga0949b67063d0bd427fbee9c816b5d45a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga0949b67063d0bd427fbee9c816b5d45a">osRtxSemaphoreCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxSemaphore__t">osRtxSemaphore_t</a>)</td></tr>
  132. <tr class="memdesc:ga0949b67063d0bd427fbee9c816b5d45a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Semaphore Control Block size. <a href="#ga0949b67063d0bd427fbee9c816b5d45a">More...</a><br/></td></tr>
  133. <tr class="separator:ga0949b67063d0bd427fbee9c816b5d45a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:gab8e49e9e1eea5a015f2a3114cabceb48"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gab8e49e9e1eea5a015f2a3114cabceb48">osRtxMemoryPoolCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMemoryPool__t">osRtxMemoryPool_t</a>)</td></tr>
  135. <tr class="memdesc:gab8e49e9e1eea5a015f2a3114cabceb48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory Pool Control Block size. <a href="#gab8e49e9e1eea5a015f2a3114cabceb48">More...</a><br/></td></tr>
  136. <tr class="separator:gab8e49e9e1eea5a015f2a3114cabceb48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:gaa8d067c476faa6bfc8e5e21f3b3c844e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gaa8d067c476faa6bfc8e5e21f3b3c844e">osRtxMessageQueueCbSize</a>&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMessageQueue__t">osRtxMessageQueue_t</a>)</td></tr>
  138. <tr class="memdesc:gaa8d067c476faa6bfc8e5e21f3b3c844e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message Queue Control Block size. <a href="#gaa8d067c476faa6bfc8e5e21f3b3c844e">More...</a><br/></td></tr>
  139. <tr class="separator:gaa8d067c476faa6bfc8e5e21f3b3c844e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:gac6bea3541b458bbc79eafce42a2d87a2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gac6bea3541b458bbc79eafce42a2d87a2">osRtxMemoryPoolMemSize</a>(block_count, block_size)&#160;&#160;&#160;(4*(block_count)*(((block_size)+3)/4))</td></tr>
  141. <tr class="memdesc:gac6bea3541b458bbc79eafce42a2d87a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory Pool Memory size. <a href="#gac6bea3541b458bbc79eafce42a2d87a2">More...</a><br/></td></tr>
  142. <tr class="separator:gac6bea3541b458bbc79eafce42a2d87a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ga47eb1e21f1bf9a42281c6c89c7473e99"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga47eb1e21f1bf9a42281c6c89c7473e99">osRtxMessageQueueMemSize</a>(msg_count, msg_size)&#160;&#160;&#160;(4*(msg_count)*(3+(((msg_size)+3)/4)))</td></tr>
  144. <tr class="memdesc:ga47eb1e21f1bf9a42281c6c89c7473e99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message Queue Memory size. <a href="#ga47eb1e21f1bf9a42281c6c89c7473e99">More...</a><br/></td></tr>
  145. <tr class="separator:ga47eb1e21f1bf9a42281c6c89c7473e99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ga42206aa2524b8fab613d26bea0f73c44"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga42206aa2524b8fab613d26bea0f73c44">osRtxErrorStackUnderflow</a>&#160;&#160;&#160;1U</td></tr>
  147. <tr class="memdesc:ga42206aa2524b8fab613d26bea0f73c44"><td class="mdescLeft">&#160;</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>
  148. <tr class="separator:ga42206aa2524b8fab613d26bea0f73c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ga7377235f9fa3cedee06f682cd93f3e88"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga7377235f9fa3cedee06f682cd93f3e88">osRtxErrorISRQueueOverflow</a>&#160;&#160;&#160;2U</td></tr>
  150. <tr class="memdesc:ga7377235f9fa3cedee06f682cd93f3e88"><td class="mdescLeft">&#160;</td><td class="mdescRight">ISR Queue overflow detected when inserting object. <a href="#ga7377235f9fa3cedee06f682cd93f3e88">More...</a><br/></td></tr>
  151. <tr class="separator:ga7377235f9fa3cedee06f682cd93f3e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:gaad420018f26e751ec55d3922a283beb0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gaad420018f26e751ec55d3922a283beb0">osRtxErrorTimerQueueOverflow</a>&#160;&#160;&#160;3U</td></tr>
  153. <tr class="memdesc:gaad420018f26e751ec55d3922a283beb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">User Timer Callback Queue overflow detected for timer. <a href="#gaad420018f26e751ec55d3922a283beb0">More...</a><br/></td></tr>
  154. <tr class="separator:gaad420018f26e751ec55d3922a283beb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ga14a24724f6e87744ba84674ef76e4256"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#ga14a24724f6e87744ba84674ef76e4256">osRtxErrorClibSpace</a>&#160;&#160;&#160;4U</td></tr>
  156. <tr class="memdesc:ga14a24724f6e87744ba84674ef76e4256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard C/C++ library libspace not available. <a href="#ga14a24724f6e87744ba84674ef76e4256">More...</a><br/></td></tr>
  157. <tr class="separator:ga14a24724f6e87744ba84674ef76e4256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:gac749c24b9cf6c49b392b015ed0517cfc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__defines.html#gac749c24b9cf6c49b392b015ed0517cfc">osRtxErrorClibMutex</a>&#160;&#160;&#160;5U</td></tr>
  159. <tr class="memdesc:gac749c24b9cf6c49b392b015ed0517cfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard C/C++ library mutex initialization failed. <a href="#gac749c24b9cf6c49b392b015ed0517cfc">More...</a><br/></td></tr>
  160. <tr class="separator:gac749c24b9cf6c49b392b015ed0517cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table>
  162. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  163. <h2 class="groupheader">Macro Definition Documentation</h2>
  164. <a class="anchor" id="ga30d19272204231956582ebfff69567f6"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">#define osRtxThreadCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxThread__t">osRtxThread_t</a>)</td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <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>
  174. <p>Example: </p>
  175. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for thread control block</span></div>
  176. <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>
  177. </div><!-- fragment -->
  178. </div>
  179. </div>
  180. <a class="anchor" id="gaf8a145fdeb24fd912971f0671b1a3603"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">#define osRtxTimerCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxTimer__t">osRtxTimer_t</a>)</td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <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>
  190. <p>Example: </p>
  191. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for timer control block</span></div>
  192. <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>
  193. </div><!-- fragment -->
  194. </div>
  195. </div>
  196. <a class="anchor" id="ga68100c8c44931f03547973294c433075"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">#define osRtxEventFlagsCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxEventFlags__t">osRtxEventFlags_t</a>)</td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <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>
  206. <p>Example: </p>
  207. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for event flags control block</span></div>
  208. <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>
  209. </div><!-- fragment -->
  210. </div>
  211. </div>
  212. <a class="anchor" id="ga188bfaaf7477cf24cbc9f207feaeb53a"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">#define osRtxMutexCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMutex__t">osRtxMutex_t</a>)</td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <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>
  222. <p>Example: </p>
  223. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for mutex control block</span></div>
  224. <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>
  225. </div><!-- fragment -->
  226. </div>
  227. </div>
  228. <a class="anchor" id="ga0949b67063d0bd427fbee9c816b5d45a"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">#define osRtxSemaphoreCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxSemaphore__t">osRtxSemaphore_t</a>)</td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <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>
  238. <p>Example: </p>
  239. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for semaphore control block</span></div>
  240. <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>
  241. </div><!-- fragment -->
  242. </div>
  243. </div>
  244. <a class="anchor" id="gab8e49e9e1eea5a015f2a3114cabceb48"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">#define osRtxMemoryPoolCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMemoryPool__t">osRtxMemoryPool_t</a>)</td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <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>
  254. <p>Example: </p>
  255. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for memory pool control block</span></div>
  256. <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>
  257. </div><!-- fragment -->
  258. </div>
  259. </div>
  260. <a class="anchor" id="gaa8d067c476faa6bfc8e5e21f3b3c844e"></a>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">#define osRtxMessageQueueCbSize&#160;&#160;&#160;sizeof(<a class="el" href="rtx__os_8h.html#structosRtxMessageQueue__t">osRtxMessageQueue_t</a>)</td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <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>
  270. <p>Example: </p>
  271. <div class="fragment"><div class="line"><span class="comment">// Used-defined memory for message queue control block</span></div>
  272. <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>
  273. </div><!-- fragment -->
  274. </div>
  275. </div>
  276. <a class="anchor" id="gac6bea3541b458bbc79eafce42a2d87a2"></a>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="memname">
  280. <tr>
  281. <td class="memname">#define osRtxMemoryPoolMemSize</td>
  282. <td>(</td>
  283. <td class="paramtype">&#160;</td>
  284. <td class="paramname">block_count, </td>
  285. </tr>
  286. <tr>
  287. <td class="paramkey"></td>
  288. <td></td>
  289. <td class="paramtype">&#160;</td>
  290. <td class="paramname">block_size&#160;</td>
  291. </tr>
  292. <tr>
  293. <td></td>
  294. <td>)</td>
  295. <td></td><td>&#160;&#160;&#160;(4*(block_count)*(((block_size)+3)/4))</td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Memory size in bytes for Memory Pool storage.</p>
  300. <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>
  301. <p>Example: </p>
  302. <div class="fragment"><div class="line"><span class="comment">// Maximum number of objects</span></div>
  303. <div class="line"><span class="preprocessor">#define OBJ_COUNT 8U</span></div>
  304. <div class="line"><span class="preprocessor"></span> </div>
  305. <div class="line"><span class="comment">// Object type</span></div>
  306. <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
  307. <div class="line"> uint32_t value1;</div>
  308. <div class="line"> uint8_t value2;</div>
  309. <div class="line">} object_t;</div>
  310. <div class="line"> </div>
  311. <div class="line"><span class="comment">// Used-defined memory for memory pool memory</span></div>
  312. <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>
  313. </div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
  314. <table class="params">
  315. <tr><td class="paramname">block_count</td><td>maximum number of memory blocks in memory pool. </td></tr>
  316. <tr><td class="paramname">block_size</td><td>memory block size in bytes. </td></tr>
  317. </table>
  318. </dd>
  319. </dl>
  320. </div>
  321. </div>
  322. <a class="anchor" id="ga47eb1e21f1bf9a42281c6c89c7473e99"></a>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="memname">
  326. <tr>
  327. <td class="memname">#define osRtxMessageQueueMemSize</td>
  328. <td>(</td>
  329. <td class="paramtype">&#160;</td>
  330. <td class="paramname">msg_count, </td>
  331. </tr>
  332. <tr>
  333. <td class="paramkey"></td>
  334. <td></td>
  335. <td class="paramtype">&#160;</td>
  336. <td class="paramname">msg_size&#160;</td>
  337. </tr>
  338. <tr>
  339. <td></td>
  340. <td>)</td>
  341. <td></td><td>&#160;&#160;&#160;(4*(msg_count)*(3+(((msg_size)+3)/4)))</td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Memory size in bytes for Message Queue storage.</p>
  346. <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>
  347. <p>Example: </p>
  348. <div class="fragment"><div class="line"><span class="comment">// Maximum number of messages</span></div>
  349. <div class="line"><span class="preprocessor">#define MSG_COUNT 16U</span></div>
  350. <div class="line"><span class="preprocessor"></span> </div>
  351. <div class="line"><span class="comment">// Message data type</span></div>
  352. <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
  353. <div class="line"> uint32_t value1;</div>
  354. <div class="line"> uint8_t value2;</div>
  355. <div class="line">} msg_item_t;</div>
  356. <div class="line"> </div>
  357. <div class="line"><span class="comment">// Used-defined memory for message queue</span></div>
  358. <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>
  359. </div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
  360. <table class="params">
  361. <tr><td class="paramname">msg_count</td><td>maximum number of messages in queue. </td></tr>
  362. <tr><td class="paramname">msg_size</td><td>maximum message size in bytes. </td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. </div>
  367. </div>
  368. <a class="anchor" id="ga42206aa2524b8fab613d26bea0f73c44"></a>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">#define osRtxErrorStackUnderflow&#160;&#160;&#160;1U</td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <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>
  378. <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>
  379. <dl class="section attention"><dt>Attention</dt><dd>Whenever this error identifier is signaled memory corruption has already happened. </dd></dl>
  380. </div>
  381. </div>
  382. <a class="anchor" id="ga7377235f9fa3cedee06f682cd93f3e88"></a>
  383. <div class="memitem">
  384. <div class="memproto">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">#define osRtxErrorISRQueueOverflow&#160;&#160;&#160;2U</td>
  388. </tr>
  389. </table>
  390. </div><div class="memdoc">
  391. <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>
  392. <dl class="section attention"><dt>Attention</dt><dd>Whenever this error identifier is signaled the system state is already inconsistent. </dd></dl>
  393. </div>
  394. </div>
  395. <a class="anchor" id="gaad420018f26e751ec55d3922a283beb0"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">#define osRtxErrorTimerQueueOverflow&#160;&#160;&#160;3U</td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <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>
  405. <dl class="section attention"><dt>Attention</dt><dd>Whenever this error identifier is signaled a timer callback is already lost. </dd></dl>
  406. </div>
  407. </div>
  408. <a class="anchor" id="ga14a24724f6e87744ba84674ef76e4256"></a>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname">#define osRtxErrorClibSpace&#160;&#160;&#160;4U</td>
  414. </tr>
  415. </table>
  416. </div><div class="memdoc">
  417. <p>Standard C/C++ library libspace not available: increase <code>OS_THREAD_LIBSPACE_NUM</code>.</p>
  418. <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>
  419. </div>
  420. </div>
  421. <a class="anchor" id="gac749c24b9cf6c49b392b015ed0517cfc"></a>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">#define osRtxErrorClibMutex&#160;&#160;&#160;5U</td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <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>
  431. </div>
  432. </div>
  433. </div><!-- contents -->
  434. </div><!-- doc-content -->
  435. <!-- start footer part -->
  436. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  437. <ul>
  438. <li class="footer">Generated on Thu Apr 9 2020 15:50:00 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved.
  439. <!--
  440. <a href="http://www.doxygen.org/index.html">
  441. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  442. -->
  443. </li>
  444. </ul>
  445. </div>
  446. </body>
  447. </html>