diff options
Diffstat (limited to 'docs/RTOS2/html/group__rtx__evr__wait.html')
| -rw-r--r-- | docs/RTOS2/html/group__rtx__evr__wait.html | 356 |
1 files changed, 356 insertions, 0 deletions
diff --git a/docs/RTOS2/html/group__rtx__evr__wait.html b/docs/RTOS2/html/group__rtx__evr__wait.html new file mode 100644 index 0000000..ff65683 --- /dev/null +++ b/docs/RTOS2/html/group__rtx__evr__wait.html @@ -0,0 +1,356 @@ +<!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>Generic Wait Functions</title> +<title>CMSIS-RTOS2: Generic Wait 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__rtx__evr__wait.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">Generic Wait Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Events generated by generic wait 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:ga9ca2a1f7c2231057dcdb9df400284c0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__wait.html#ga9ca2a1f7c2231057dcdb9df400284c0a">EvrRtxDelayError</a> (int32_t status)</td></tr> +<tr class="memdesc:ga9ca2a1f7c2231057dcdb9df400284c0a"><td class="mdescLeft"> </td><td class="mdescRight">Event on delay error (Error) <a href="#ga9ca2a1f7c2231057dcdb9df400284c0a">More...</a><br/></td></tr> +<tr class="separator:ga9ca2a1f7c2231057dcdb9df400284c0a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaec642f6e093f6c1c9b9d7609c4b0d174"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__wait.html#gaec642f6e093f6c1c9b9d7609c4b0d174">EvrRtxDelay</a> (uint32_t ticks)</td></tr> +<tr class="memdesc:gaec642f6e093f6c1c9b9d7609c4b0d174"><td class="mdescLeft"> </td><td class="mdescRight">Event on delay for specified time (API) <a href="#gaec642f6e093f6c1c9b9d7609c4b0d174">More...</a><br/></td></tr> +<tr class="separator:gaec642f6e093f6c1c9b9d7609c4b0d174"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga16728292de4e2665248693fff603a2c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__wait.html#ga16728292de4e2665248693fff603a2c3">EvrRtxDelayUntil</a> (uint32_t ticks)</td></tr> +<tr class="memdesc:ga16728292de4e2665248693fff603a2c3"><td class="mdescLeft"> </td><td class="mdescRight">Event on delay until specified time (API) <a href="#ga16728292de4e2665248693fff603a2c3">More...</a><br/></td></tr> +<tr class="separator:ga16728292de4e2665248693fff603a2c3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad489decd779491c1f247214e541cd4e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__wait.html#gad489decd779491c1f247214e541cd4e8">EvrRtxDelayStarted</a> (uint32_t ticks)</td></tr> +<tr class="memdesc:gad489decd779491c1f247214e541cd4e8"><td class="mdescLeft"> </td><td class="mdescRight">Event on delay started (Op) <a href="#gad489decd779491c1f247214e541cd4e8">More...</a><br/></td></tr> +<tr class="separator:gad489decd779491c1f247214e541cd4e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga46ffa7cb290130a3b0d10dbd6c3faddd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__wait.html#ga46ffa7cb290130a3b0d10dbd6c3faddd">EvrRtxDelayUntilStarted</a> (uint32_t ticks)</td></tr> +<tr class="memdesc:ga46ffa7cb290130a3b0d10dbd6c3faddd"><td class="mdescLeft"> </td><td class="mdescRight">Event on delay until specified time started (Op) <a href="#ga46ffa7cb290130a3b0d10dbd6c3faddd">More...</a><br/></td></tr> +<tr class="separator:ga46ffa7cb290130a3b0d10dbd6c3faddd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaff18b7b13dc1fe87d1c9d3b23ed55208"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__wait.html#gaff18b7b13dc1fe87d1c9d3b23ed55208">EvrRtxDelayCompleted</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr> +<tr class="memdesc:gaff18b7b13dc1fe87d1c9d3b23ed55208"><td class="mdescLeft"> </td><td class="mdescRight">Event on delay completed (Op) <a href="#gaff18b7b13dc1fe87d1c9d3b23ed55208">More...</a><br/></td></tr> +<tr class="separator:gaff18b7b13dc1fe87d1c9d3b23ed55208"><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="ga9ca2a1f7c2231057dcdb9df400284c0a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxDelayError </td> + <td>(</td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>status</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">status</td><td>extended execution status.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>DelayError</b> is generated when <a class="el" href="group__CMSIS__RTOS__Wait.html">Generic Wait Functions</a> routines complete their execution due to an error.</p> +<p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p> +<table class="doxtable"> +<tr> +<th align="left">Extended Status Code </th><th align="left">Description </th></tr> +<tr> +<td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr> +<tr> +<td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr> +<tr> +<td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr> +<tr> +<td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr> +<tr> +<td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr> +<tr> +<td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr> +<tr> +<td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr> +</table> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>status</b> : execution status code. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaec642f6e093f6c1c9b9d7609c4b0d174"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxDelay </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>ticks</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">ticks</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>Delay</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>ticks</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga16728292de4e2665248693fff603a2c3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxDelayUntil </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>ticks</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">ticks</td><td>absolute time in ticks.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>DelayUntil</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1">osDelayUntil</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>ticks</b> : absolute delay time in ticks. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gad489decd779491c1f247214e541cd4e8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxDelayStarted </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>ticks</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">ticks</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>DelayStarted</b> is generated when <a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a> delay starts.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>ticks</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga46ffa7cb290130a3b0d10dbd6c3faddd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxDelayUntilStarted </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>ticks</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">ticks</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>DelayUntilStarted</b> is generated when <a class="el" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1">osDelayUntil</a> delay starts.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>ticks</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaff18b7b13dc1fe87d1c9d3b23ed55208"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxDelayCompleted </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> </td> + <td class="paramname"><em>thread_id</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">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>DelayCompleted</b> is generated when <a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a> or <a class="el" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1">osDelayUntil</a> delay expires.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_id</b> : thread ID. </li> +</ul> + +</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 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> |