diff options
Diffstat (limited to 'docs/RTOS2/html/group__rtx__evr__thread__flags.html')
| -rw-r--r-- | docs/RTOS2/html/group__rtx__evr__thread__flags.html | 622 |
1 files changed, 622 insertions, 0 deletions
diff --git a/docs/RTOS2/html/group__rtx__evr__thread__flags.html b/docs/RTOS2/html/group__rtx__evr__thread__flags.html new file mode 100644 index 0000000..88c8ad3 --- /dev/null +++ b/docs/RTOS2/html/group__rtx__evr__thread__flags.html @@ -0,0 +1,622 @@ +<!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>Thread Flags Functions</title> +<title>CMSIS-RTOS2: Thread Flags 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__thread__flags.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">Thread Flags 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 thread flags 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:gad3609bfc41e1bee23b41973281096ed6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gad3609bfc41e1bee23b41973281096ed6">EvrRtxThreadFlagsError</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, int32_t status)</td></tr> +<tr class="memdesc:gad3609bfc41e1bee23b41973281096ed6"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread flags error (Error) <a href="#gad3609bfc41e1bee23b41973281096ed6">More...</a><br/></td></tr> +<tr class="separator:gad3609bfc41e1bee23b41973281096ed6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac356c777af86c2d8d9250cbffc516e1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gac356c777af86c2d8d9250cbffc516e1d">EvrRtxThreadFlagsSet</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t flags)</td></tr> +<tr class="memdesc:gac356c777af86c2d8d9250cbffc516e1d"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread flags set (API) <a href="#gac356c777af86c2d8d9250cbffc516e1d">More...</a><br/></td></tr> +<tr class="separator:gac356c777af86c2d8d9250cbffc516e1d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabd447773c02e235a8d0bb96dd9bb1c4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gabd447773c02e235a8d0bb96dd9bb1c4f">EvrRtxThreadFlagsSetDone</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t thread_flags)</td></tr> +<tr class="memdesc:gabd447773c02e235a8d0bb96dd9bb1c4f"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful thread flags set (Op) <a href="#gabd447773c02e235a8d0bb96dd9bb1c4f">More...</a><br/></td></tr> +<tr class="separator:gabd447773c02e235a8d0bb96dd9bb1c4f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac8ddc747c72f7fc5cfa58edcee56b82d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gac8ddc747c72f7fc5cfa58edcee56b82d">EvrRtxThreadFlagsClear</a> (uint32_t flags)</td></tr> +<tr class="memdesc:gac8ddc747c72f7fc5cfa58edcee56b82d"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread flags clear (API) <a href="#gac8ddc747c72f7fc5cfa58edcee56b82d">More...</a><br/></td></tr> +<tr class="separator:gac8ddc747c72f7fc5cfa58edcee56b82d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaad13b17507cc07a4a1e37a5653489943"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gaad13b17507cc07a4a1e37a5653489943">EvrRtxThreadFlagsClearDone</a> (uint32_t thread_flags)</td></tr> +<tr class="memdesc:gaad13b17507cc07a4a1e37a5653489943"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful thread flags clear (Op) <a href="#gaad13b17507cc07a4a1e37a5653489943">More...</a><br/></td></tr> +<tr class="separator:gaad13b17507cc07a4a1e37a5653489943"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaab1a30a0ac3dfa588ededbfad52bae30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gaab1a30a0ac3dfa588ededbfad52bae30">EvrRtxThreadFlagsGet</a> (uint32_t thread_flags)</td></tr> +<tr class="memdesc:gaab1a30a0ac3dfa588ededbfad52bae30"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread flags retrieve (API) <a href="#gaab1a30a0ac3dfa588ededbfad52bae30">More...</a><br/></td></tr> +<tr class="separator:gaab1a30a0ac3dfa588ededbfad52bae30"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaad860c571b9b083ff2889fb76fb619f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gaad860c571b9b083ff2889fb76fb619f1">EvrRtxThreadFlagsWait</a> (uint32_t flags, uint32_t options, uint32_t timeout)</td></tr> +<tr class="memdesc:gaad860c571b9b083ff2889fb76fb619f1"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait for thread flags (API) <a href="#gaad860c571b9b083ff2889fb76fb619f1">More...</a><br/></td></tr> +<tr class="separator:gaad860c571b9b083ff2889fb76fb619f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad09ec9317a4440e5228870b750e9860e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gad09ec9317a4440e5228870b750e9860e">EvrRtxThreadFlagsWaitPending</a> (uint32_t flags, uint32_t options, uint32_t timeout)</td></tr> +<tr class="memdesc:gad09ec9317a4440e5228870b750e9860e"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending wait for thread flags (Op) <a href="#gad09ec9317a4440e5228870b750e9860e">More...</a><br/></td></tr> +<tr class="separator:gad09ec9317a4440e5228870b750e9860e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae45ec48e082608d2ba72ce7c695899c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gae45ec48e082608d2ba72ce7c695899c6">EvrRtxThreadFlagsWaitTimeout</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr> +<tr class="memdesc:gae45ec48e082608d2ba72ce7c695899c6"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait timeout for thread flags (Op) <a href="#gae45ec48e082608d2ba72ce7c695899c6">More...</a><br/></td></tr> +<tr class="separator:gae45ec48e082608d2ba72ce7c695899c6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5e00be70234d0ca3b0d4d99fb58295bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#ga5e00be70234d0ca3b0d4d99fb58295bc">EvrRtxThreadFlagsWaitCompleted</a> (uint32_t flags, uint32_t options, uint32_t thread_flags, <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr> +<tr class="memdesc:ga5e00be70234d0ca3b0d4d99fb58295bc"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful wait for thread flags (Op) <a href="#ga5e00be70234d0ca3b0d4d99fb58295bc">More...</a><br/></td></tr> +<tr class="separator:ga5e00be70234d0ca3b0d4d99fb58295bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadf6b9f4882f62a65b4e06e1b3e5c9c5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gadf6b9f4882f62a65b4e06e1b3e5c9c5b">EvrRtxThreadFlagsWaitNotCompleted</a> (uint32_t flags, uint32_t options)</td></tr> +<tr class="memdesc:gadf6b9f4882f62a65b4e06e1b3e5c9c5b"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful wait for thread flags (Op) <a href="#gadf6b9f4882f62a65b4e06e1b3e5c9c5b">More...</a><br/></td></tr> +<tr class="separator:gadf6b9f4882f62a65b4e06e1b3e5c9c5b"><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="gad3609bfc41e1bee23b41973281096ed6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsError </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> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>status</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">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> or NULL when ID is unknown. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsError</b> is generated when <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</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>thread_id</b> : thread ID.</li> +<li><b>status</b> : execution status code. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gac356c777af86c2d8d9250cbffc516e1d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsSet </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> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>flags</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">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> + <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags of the thread that shall be set.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsSet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_id</b> : thread ID.</li> +<li><b>flags</b> : flags that shall be set. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gabd447773c02e235a8d0bb96dd9bb1c4f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsSetDone </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> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>thread_flags</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">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> + <tr><td class="paramdir">[in]</td><td class="paramname">thread_flags</td><td>thread flags after setting.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsSetDone</b> is generated when thread flags are successfully set.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_id</b> : thread ID.</li> +<li><b>thread_flags</b> : thread flags after setting. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gac8ddc747c72f7fc5cfa58edcee56b82d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsClear </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>flags</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">flags</td><td>flags of the thread that shall be cleared.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsClear</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>flags</b> : flags that shall be cleared. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaad13b17507cc07a4a1e37a5653489943"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsClearDone </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>thread_flags</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_flags</td><td>thread flags before clearing.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsClearDone</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a> successfully clears thread flags.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_flags</b> : thread flags before clearing. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaab1a30a0ac3dfa588ededbfad52bae30"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsGet </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>thread_flags</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_flags</td><td>current thread flags.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsGet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga85c8d2c89466e25abbcb545d9ddd71ba">osThreadFlagsGet</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_flags</b> : current thread flags. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaad860c571b9b083ff2889fb76fb619f1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsWait </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>options</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</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">flags</td><td>flags to wait for. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsWait</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>flags</b> : flags to wait for.</li> +<li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>).</li> +<li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gad09ec9317a4440e5228870b750e9860e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsWaitPending </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>options</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</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">flags</td><td>flags to wait for. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsWaitPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> starts waiting for thread flags to become signaled.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>flags</b> : flags to wait for.</li> +<li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>).</li> +<li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gae45ec48e082608d2ba72ce7c695899c6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsWaitTimeout </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>ThreadFlagsWaitTimeout</b> is generated when wait for thread flags to become signaled is aborted due to expired wait timeout.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_id</b> : thread ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga5e00be70234d0ca3b0d4d99fb58295bc"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsWaitCompleted </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>options</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>thread_flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></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> + </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">flags</td><td>flags to wait for. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">thread_flags</td><td>thread flags before clearing. </td></tr> + <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>ThreadFlagsWaitCompleted</b> is generated when waiting for thread flags ends because requested flags were signaled.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>flags</b> : flags thread was waiting for.</li> +<li><b>option</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>).</li> +<li><b>thread_flags</b> : thread flags before clearing.</li> +<li><b>thread_id</b> : thread ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gadf6b9f4882f62a65b4e06e1b3e5c9c5b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadFlagsWaitNotCompleted </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>flags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>options</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">flags</td><td>flags to wait for. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx).</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadFlagsWaitNotCompleted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> returns without timeout and specified thread flags were not signaled.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>flags</b> : flags thread was waiting for.</li> +<li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>). </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> |