diff options
Diffstat (limited to 'docs/RTOS2/html/group__rtx5__specific__functions.html')
| -rw-r--r-- | docs/RTOS2/html/group__rtx5__specific__functions.html | 265 |
1 files changed, 265 insertions, 0 deletions
diff --git a/docs/RTOS2/html/group__rtx5__specific__functions.html b/docs/RTOS2/html/group__rtx5__specific__functions.html new file mode 100644 index 0000000..be6d83d --- /dev/null +++ b/docs/RTOS2/html/group__rtx5__specific__functions.html @@ -0,0 +1,265 @@ +<!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>Functions</title> +<title>CMSIS-RTOS2: Functions</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__functions.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="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Functions<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 functions. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gaf1745a88f9cc60b609ab1c8076bd346d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> (uint32_t code, void *object_id)</td></tr> +<tr class="memdesc:gaf1745a88f9cc60b609ab1c8076bd346d"><td class="mdescLeft"> </td><td class="mdescRight">OS Error Callback function. <a href="#gaf1745a88f9cc60b609ab1c8076bd346d">More...</a><br/></td></tr> +<tr class="separator:gaf1745a88f9cc60b609ab1c8076bd346d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga074068b8efa7074cee68a71481d0b072"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx5__specific__functions.html#ga074068b8efa7074cee68a71481d0b072">osRtxIdleThread</a> (void *argument)</td></tr> +<tr class="memdesc:ga074068b8efa7074cee68a71481d0b072"><td class="mdescLeft"> </td><td class="mdescRight">OS Idle Thread. <a href="#ga074068b8efa7074cee68a71481d0b072">More...</a><br/></td></tr> +<tr class="separator:ga074068b8efa7074cee68a71481d0b072"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="gaf1745a88f9cc60b609ab1c8076bd346d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t osRtxErrorNotify </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>code</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>object_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>The code to identify the error condition. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>A reference to any RTX object to identify the object that caused the issue, can be <span class="XML-Token">NULL</span>.</td></tr> + </table> + </dd> +</dl> +<p>Some system error conditions can be detected during runtime. If the RTX kernel detects a runtime error, it calls the runtime error function <b>osRtxErrorNotify</b> for an object specified by parameter <em>object_id</em>.</p> +<p>The parameter <em>code</em> passes the actual error code to this function: </p> +<table class="doxtable"> +<tr> +<th>Error Code </th><th>Description </th></tr> +<tr> +<td><a class="el" href="group__rtx5__specific__defines.html#ga42206aa2524b8fab613d26bea0f73c44">osRtxErrorStackUnderflow</a> </td><td>Stack overflow detected for thread (thread_id=object_id) </td></tr> +<tr> +<td><a class="el" href="group__rtx5__specific__defines.html#ga7377235f9fa3cedee06f682cd93f3e88">osRtxErrorISRQueueOverflow</a> </td><td>ISR Queue overflow detected when inserting object (object_id) </td></tr> +<tr> +<td><a class="el" href="group__rtx5__specific__defines.html#gaad420018f26e751ec55d3922a283beb0">osRtxErrorTimerQueueOverflow</a> </td><td>User Timer Callback Queue overflow detected for timer (timer_id=object_id) </td></tr> +<tr> +<td><a class="el" href="group__rtx5__specific__defines.html#ga14a24724f6e87744ba84674ef76e4256">osRtxErrorClibSpace</a> </td><td>Standard C/C++ library libspace not available: increase <code>OS_THREAD_LIBSPACE_NUM</code> </td></tr> +<tr> +<td><a class="el" href="group__rtx5__specific__defines.html#gac749c24b9cf6c49b392b015ed0517cfc">osRtxErrorClibMutex</a> </td><td>Standard C/C++ library mutex initialization failed </td></tr> +</table> +<p>The function <b>osRtxErrorNotify</b> must contain an infinite loop to prevent further program execution. You can use an emulator to step over the infinite loop and trace into the code introducing a runtime error. For the overflow errors this means you need to increase the size of the object causing an overflow.</p> +<p><b>Code Example</b> </p> +<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="rtx__os_8h.html">rtx_os.h</a>"</span></div> +<div class="line"> </div> +<div class="line">uint32_t <a class="code" href="group__rtx5__specific__functions.html#gaf1745a88f9cc60b609ab1c8076bd346d">osRtxErrorNotify</a> (uint32_t code, <span class="keywordtype">void</span> *object_id) {</div> +<div class="line"> (void)object_id;</div> +<div class="line"> </div> +<div class="line"> <span class="keywordflow">switch</span> (code) {</div> +<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__rtx5__specific__defines.html#ga42206aa2524b8fab613d26bea0f73c44">osRtxErrorStackUnderflow</a>:</div> +<div class="line"> <span class="comment">// Stack overflow detected for thread (thread_id=object_id)</span></div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__rtx5__specific__defines.html#ga7377235f9fa3cedee06f682cd93f3e88">osRtxErrorISRQueueOverflow</a>:</div> +<div class="line"> <span class="comment">// ISR Queue overflow detected when inserting object (object_id)</span></div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__rtx5__specific__defines.html#gaad420018f26e751ec55d3922a283beb0">osRtxErrorTimerQueueOverflow</a>:</div> +<div class="line"> <span class="comment">// User Timer Callback Queue overflow detected for timer (timer_id=object_id)</span></div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__rtx5__specific__defines.html#ga14a24724f6e87744ba84674ef76e4256">osRtxErrorClibSpace</a>:</div> +<div class="line"> <span class="comment">// Standard C/C++ library libspace not available: increase OS_THREAD_LIBSPACE_NUM</span></div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__rtx5__specific__defines.html#gac749c24b9cf6c49b392b015ed0517cfc">osRtxErrorClibMutex</a>:</div> +<div class="line"> <span class="comment">// Standard C/C++ library mutex initialization failed</span></div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> <span class="keywordflow">default</span>:</div> +<div class="line"> <span class="keywordflow">break</span>;</div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">for</span> (;;) {}</div> +<div class="line"><span class="comment">//return 0U;</span></div> +<div class="line">}</div> +</div><!-- fragment --> +</div> +</div> +<a class="anchor" id="ga074068b8efa7074cee68a71481d0b072"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void osRtxIdleThread </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>argument</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">argument</td><td>Unused parameter, always set to <span class="XML-Token">NULL</span>.</td></tr> + </table> + </dd> +</dl> +<p>The function <b>osRtxIdleThread</b> is executed by the RTX kernel when no other threads are ready to run.</p> +<p>By default, this thread is an empty end-less loop that does nothing. It only waits until another task becomes ready to run. You may change the code of the <b>osRtxIdleThread</b> function to put the CPU into a power-saving or idle mode, see <a class="el" href="theory_of_operation.html#TickLess">Tick-less Low-Power Operation</a>.</p> +<p>The default stack size for this thread is defined in the file RTX_Config.h. Refer to <a class="el" href="config_rtx5.html#threadConfig">Thread Configuration</a>.</p> +<dl class="section attention"><dt>Attention</dt><dd>The idle thread should never be blocked nor terminated! <b>Do not</b> call <ul> +<li> +blocking functions, </li> +<li> +<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga2f8ba6dba6e9c065a6e236ffd410d74a">osThreadTerminate</a>, or </li> +<li> +<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaddaa452dd7610e4096647a566d3556fc">osThreadExit</a> </li> +</ul> +and <b>do not</b> return from this function when providing a user defined implementation.</dd></dl> +<p><b>Code Example</b> </p> +<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="rtx__os_8h.html">rtx_os.h</a>"</span></div> +<div class="line"> </div> +<div class="line"><a class="code" href="cmsis__os2_8h.html#a153a4a31b276a9758959580538720a51">__NO_RETURN</a> <span class="keywordtype">void</span> <a class="code" href="group__rtx5__specific__functions.html#ga074068b8efa7074cee68a71481d0b072">osRtxIdleThread</a> (<span class="keywordtype">void</span> *argument) {</div> +<div class="line"> (void)argument;</div> +<div class="line"></div> +<div class="line"> <span class="keywordflow">for</span> (;;) {}</div> +<div class="line">}</div> +</div><!-- fragment --> +</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> |