| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691 |
- <!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>Mutex Functions</title>
- <title>CMSIS-RTOS2: Mutex 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__mutex.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">Mutex 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 mutex 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:ga47388f06c025938facfddd95851d666f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga47388f06c025938facfddd95851d666f">EvrRtxMutexError</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, int32_t status)</td></tr>
- <tr class="memdesc:ga47388f06c025938facfddd95851d666f"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex error (Error) <a href="#ga47388f06c025938facfddd95851d666f">More...</a><br/></td></tr>
- <tr class="separator:ga47388f06c025938facfddd95851d666f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga51f59bf99b315f016ca752eddd1911d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga51f59bf99b315f016ca752eddd1911d5">EvrRtxMutexNew</a> (const <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#structosMutexAttr__t">osMutexAttr_t</a> *attr)</td></tr>
- <tr class="memdesc:ga51f59bf99b315f016ca752eddd1911d5"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex create and initialize (API) <a href="#ga51f59bf99b315f016ca752eddd1911d5">More...</a><br/></td></tr>
- <tr class="separator:ga51f59bf99b315f016ca752eddd1911d5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga712b32609cfb3ceded746ee6a86d2442"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga712b32609cfb3ceded746ee6a86d2442">EvrRtxMutexCreated</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, const char *name)</td></tr>
- <tr class="memdesc:ga712b32609cfb3ceded746ee6a86d2442"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful mutex create (Op) <a href="#ga712b32609cfb3ceded746ee6a86d2442">More...</a><br/></td></tr>
- <tr class="separator:ga712b32609cfb3ceded746ee6a86d2442"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga457302507cedf0ea969cbb110af606b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga457302507cedf0ea969cbb110af606b8">EvrRtxMutexGetName</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, const char *name)</td></tr>
- <tr class="memdesc:ga457302507cedf0ea969cbb110af606b8"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex name retrieve (API) <a href="#ga457302507cedf0ea969cbb110af606b8">More...</a><br/></td></tr>
- <tr class="separator:ga457302507cedf0ea969cbb110af606b8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga913c46223d91000fedab624d0f4e53f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga913c46223d91000fedab624d0f4e53f8">EvrRtxMutexAcquire</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, uint32_t timeout)</td></tr>
- <tr class="memdesc:ga913c46223d91000fedab624d0f4e53f8"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex acquire (API) <a href="#ga913c46223d91000fedab624d0f4e53f8">More...</a><br/></td></tr>
- <tr class="separator:ga913c46223d91000fedab624d0f4e53f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaddc9bb3c619b92a786ee5255ec65eaca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#gaddc9bb3c619b92a786ee5255ec65eaca">EvrRtxMutexAcquirePending</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, uint32_t timeout)</td></tr>
- <tr class="memdesc:gaddc9bb3c619b92a786ee5255ec65eaca"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending mutex acquire (Op) <a href="#gaddc9bb3c619b92a786ee5255ec65eaca">More...</a><br/></td></tr>
- <tr class="separator:gaddc9bb3c619b92a786ee5255ec65eaca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4c4780cf766e9d2c6e8c26f206fba607"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga4c4780cf766e9d2c6e8c26f206fba607">EvrRtxMutexAcquireTimeout</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id)</td></tr>
- <tr class="memdesc:ga4c4780cf766e9d2c6e8c26f206fba607"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex acquire timeout (Op) <a href="#ga4c4780cf766e9d2c6e8c26f206fba607">More...</a><br/></td></tr>
- <tr class="separator:ga4c4780cf766e9d2c6e8c26f206fba607"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga697ec95e014a30a3676690a8d217f546"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga697ec95e014a30a3676690a8d217f546">EvrRtxMutexAcquired</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, uint32_t lock)</td></tr>
- <tr class="memdesc:ga697ec95e014a30a3676690a8d217f546"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful mutex acquire (Op) <a href="#ga697ec95e014a30a3676690a8d217f546">More...</a><br/></td></tr>
- <tr class="separator:ga697ec95e014a30a3676690a8d217f546"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5d2b957c02fcdcc0617479b93a56f6af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga5d2b957c02fcdcc0617479b93a56f6af">EvrRtxMutexNotAcquired</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id)</td></tr>
- <tr class="memdesc:ga5d2b957c02fcdcc0617479b93a56f6af"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful mutex acquire (Op) <a href="#ga5d2b957c02fcdcc0617479b93a56f6af">More...</a><br/></td></tr>
- <tr class="separator:ga5d2b957c02fcdcc0617479b93a56f6af"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga3fe98bfc9cbea52f578aa5a202305442"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga3fe98bfc9cbea52f578aa5a202305442">EvrRtxMutexRelease</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id)</td></tr>
- <tr class="memdesc:ga3fe98bfc9cbea52f578aa5a202305442"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex release (API) <a href="#ga3fe98bfc9cbea52f578aa5a202305442">More...</a><br/></td></tr>
- <tr class="separator:ga3fe98bfc9cbea52f578aa5a202305442"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga561c8898b912ea8eace4e6ba606210e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga561c8898b912ea8eace4e6ba606210e5">EvrRtxMutexReleased</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, uint32_t lock)</td></tr>
- <tr class="memdesc:ga561c8898b912ea8eace4e6ba606210e5"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful mutex release (Op) <a href="#ga561c8898b912ea8eace4e6ba606210e5">More...</a><br/></td></tr>
- <tr class="separator:ga561c8898b912ea8eace4e6ba606210e5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga89284c1927aa646535ff804f1aeda720"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#ga89284c1927aa646535ff804f1aeda720">EvrRtxMutexGetOwner</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id, <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr>
- <tr class="memdesc:ga89284c1927aa646535ff804f1aeda720"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex owner retrieve (API) <a href="#ga89284c1927aa646535ff804f1aeda720">More...</a><br/></td></tr>
- <tr class="separator:ga89284c1927aa646535ff804f1aeda720"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaaadf1b9cf9a62f4e61742069b95daf68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#gaaadf1b9cf9a62f4e61742069b95daf68">EvrRtxMutexDelete</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id)</td></tr>
- <tr class="memdesc:gaaadf1b9cf9a62f4e61742069b95daf68"><td class="mdescLeft"> </td><td class="mdescRight">Event on mutex delete (API) <a href="#gaaadf1b9cf9a62f4e61742069b95daf68">More...</a><br/></td></tr>
- <tr class="separator:gaaadf1b9cf9a62f4e61742069b95daf68"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa3feba455090d50295cbf4b1447f3f87"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__mutex.html#gaa3feba455090d50295cbf4b1447f3f87">EvrRtxMutexDestroyed</a> (<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> mutex_id)</td></tr>
- <tr class="memdesc:gaa3feba455090d50295cbf4b1447f3f87"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful mutex delete (Op) <a href="#gaa3feba455090d50295cbf4b1447f3f87">More...</a><br/></td></tr>
- <tr class="separator:gaa3feba455090d50295cbf4b1447f3f87"><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="ga47388f06c025938facfddd95851d666f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexError </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</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>MutexError</b> is generated when <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</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>mutex_id</b> : mutex ID.</li>
- <li><b>status</b> : execution status code. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga51f59bf99b315f016ca752eddd1911d5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexNew </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#structosMutexAttr__t">osMutexAttr_t</a> * </td>
- <td class="paramname"><em>attr</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">attr</td><td>mutex attributes.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a> is called.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>attr</b> : memory address of Mutex attributes or 0 when they are not specified. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga712b32609cfb3ceded746ee6a86d2442"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexCreated </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to mutex object name.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a> successfully creates a mutex object.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga457302507cedf0ea969cbb110af606b8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexGetName </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to mutex object name.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga00b5e58cd247a412d1afd18732d8b752">osMutexGetName</a> is called and its execution result is known.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID.</li>
- <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga913c46223d91000fedab624d0f4e53f8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexAcquire </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </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>MutexAcquire</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> is called.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID.</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="gaddc9bb3c619b92a786ee5255ec65eaca"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexAcquirePending </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </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>MutexAcquirePending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> blocks current running thread and waits for mutex to become available.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID.</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="ga4c4780cf766e9d2c6e8c26f206fba607"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexAcquireTimeout </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexAcquireTimeout</b> is generated when wait for mutex to become available is aborted due to expired wait timeout.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga697ec95e014a30a3676690a8d217f546"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexAcquired </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>lock</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>current number of times mutex object is locked.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexAcquired</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> successfully acquires a mutex.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID.</li>
- <li><b>lock</b> : current lock counter state. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga5d2b957c02fcdcc0617479b93a56f6af"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexNotAcquired </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexNotAcquired</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> returns without timeout and mutex was not acquired.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga3fe98bfc9cbea52f578aa5a202305442"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexRelease </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexRelease</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gaea629705703580ff58776bf73c8db915">osMutexRelease</a> is called.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga561c8898b912ea8eace4e6ba606210e5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexReleased </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>lock</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>current number of times mutex object is locked.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexReleased</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gaea629705703580ff58776bf73c8db915">osMutexRelease</a> successfully releases a mutex.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID.</li>
- <li><b>lock</b> : current lock counter state. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga89284c1927aa646535ff804f1aeda720"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexGetOwner </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_id</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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>. </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>MutexGetOwner</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga7f9a7666df0978738cd570cb700b83fb">osMutexGetOwner</a> is called and its execution result is known.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID.</li>
- <li><b>thread_id</b> : retrieved owner thread ID (0 in case of a failure or when mutex is not locked) </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gaaadf1b9cf9a62f4e61742069b95daf68"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexDelete </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabee73ad227ba4587d3db12ef9bd582bc">osMutexDelete</a> is called.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex ID. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gaa3feba455090d50295cbf4b1447f3f87"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void EvrRtxMutexDestroyed </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a> </td>
- <td class="paramname"><em>mutex_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">mutex_id</td><td>mutex ID obtained by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8">osMutexNew</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The event <b>MutexDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabee73ad227ba4587d3db12ef9bd582bc">osMutexDelete</a> successfully deletes the mutex object.</p>
- <p><b>Value</b> in the Event Recorder shows:</p>
- <ul>
- <li><b>mutex_id</b> : mutex 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 Thu Apr 9 2020 15:50:00 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>
|