<!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>Semaphore Functions</title> <title>CMSIS-RTOS2: Semaphore 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.0</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__semaphore.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">Semaphore 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 semaphore 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:ga96a0209384296a283c7b1d23a3395fa1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga96a0209384296a283c7b1d23a3395fa1">EvrRtxSemaphoreError</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id, int32_t status)</td></tr> <tr class="memdesc:ga96a0209384296a283c7b1d23a3395fa1"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore error (Error) <a href="#ga96a0209384296a283c7b1d23a3395fa1">More...</a><br/></td></tr> <tr class="separator:ga96a0209384296a283c7b1d23a3395fa1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5639f03e935ab79844777664a518c2ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga5639f03e935ab79844777664a518c2ec">EvrRtxSemaphoreNew</a> (uint32_t max_count, uint32_t initial_count, const <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#structosSemaphoreAttr__t">osSemaphoreAttr_t</a> *attr)</td></tr> <tr class="memdesc:ga5639f03e935ab79844777664a518c2ec"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore create and initialize (API) <a href="#ga5639f03e935ab79844777664a518c2ec">More...</a><br/></td></tr> <tr class="separator:ga5639f03e935ab79844777664a518c2ec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad46ee88b57aed4c666aec773560aebad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#gad46ee88b57aed4c666aec773560aebad">EvrRtxSemaphoreCreated</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:gad46ee88b57aed4c666aec773560aebad"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful semaphore create (Op) <a href="#gad46ee88b57aed4c666aec773560aebad">More...</a><br/></td></tr> <tr class="separator:gad46ee88b57aed4c666aec773560aebad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga17d8aa861b6e669cc68c3c41e3e12332"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga17d8aa861b6e669cc68c3c41e3e12332">EvrRtxSemaphoreGetName</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id, const char *name)</td></tr> <tr class="memdesc:ga17d8aa861b6e669cc68c3c41e3e12332"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore name retrieve (API) <a href="#ga17d8aa861b6e669cc68c3c41e3e12332">More...</a><br/></td></tr> <tr class="separator:ga17d8aa861b6e669cc68c3c41e3e12332"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafd91c9bb268a48b394571a9fc1809019"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#gafd91c9bb268a48b394571a9fc1809019">EvrRtxSemaphoreAcquire</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id, uint32_t timeout)</td></tr> <tr class="memdesc:gafd91c9bb268a48b394571a9fc1809019"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore acquire (API) <a href="#gafd91c9bb268a48b394571a9fc1809019">More...</a><br/></td></tr> <tr class="separator:gafd91c9bb268a48b394571a9fc1809019"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabbaaf85deaf4645414987fc1c3289343"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#gabbaaf85deaf4645414987fc1c3289343">EvrRtxSemaphoreAcquirePending</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id, uint32_t timeout)</td></tr> <tr class="memdesc:gabbaaf85deaf4645414987fc1c3289343"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending semaphore acquire (Op) <a href="#gabbaaf85deaf4645414987fc1c3289343">More...</a><br/></td></tr> <tr class="separator:gabbaaf85deaf4645414987fc1c3289343"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga852798d5e14cda14484564ac4d7f5a4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga852798d5e14cda14484564ac4d7f5a4b">EvrRtxSemaphoreAcquireTimeout</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:ga852798d5e14cda14484564ac4d7f5a4b"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore acquire timeout (Op) <a href="#ga852798d5e14cda14484564ac4d7f5a4b">More...</a><br/></td></tr> <tr class="separator:ga852798d5e14cda14484564ac4d7f5a4b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga97de1ac0437425129f0eb28eea74e993"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga97de1ac0437425129f0eb28eea74e993">EvrRtxSemaphoreAcquired</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:ga97de1ac0437425129f0eb28eea74e993"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful semaphore acquire (Op) <a href="#ga97de1ac0437425129f0eb28eea74e993">More...</a><br/></td></tr> <tr class="separator:ga97de1ac0437425129f0eb28eea74e993"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga53eb40f5251e9464b46cc153fe8b26d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga53eb40f5251e9464b46cc153fe8b26d8">EvrRtxSemaphoreNotAcquired</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:ga53eb40f5251e9464b46cc153fe8b26d8"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful semaphore acquire (Op) <a href="#ga53eb40f5251e9464b46cc153fe8b26d8">More...</a><br/></td></tr> <tr class="separator:ga53eb40f5251e9464b46cc153fe8b26d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0a9f3c7dbf89d3f155a96524e7195630"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga0a9f3c7dbf89d3f155a96524e7195630">EvrRtxSemaphoreRelease</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:ga0a9f3c7dbf89d3f155a96524e7195630"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore release (API) <a href="#ga0a9f3c7dbf89d3f155a96524e7195630">More...</a><br/></td></tr> <tr class="separator:ga0a9f3c7dbf89d3f155a96524e7195630"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga684b0e0956cf664c9342e2242c258eea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga684b0e0956cf664c9342e2242c258eea">EvrRtxSemaphoreReleased</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:ga684b0e0956cf664c9342e2242c258eea"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful semaphore release (Op) <a href="#ga684b0e0956cf664c9342e2242c258eea">More...</a><br/></td></tr> <tr class="separator:ga684b0e0956cf664c9342e2242c258eea"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga17f21ffa4ec39c50ce203e6985dd0deb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#ga17f21ffa4ec39c50ce203e6985dd0deb">EvrRtxSemaphoreGetCount</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id, uint32_t count)</td></tr> <tr class="memdesc:ga17f21ffa4ec39c50ce203e6985dd0deb"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore token count retrieval (API) <a href="#ga17f21ffa4ec39c50ce203e6985dd0deb">More...</a><br/></td></tr> <tr class="separator:ga17f21ffa4ec39c50ce203e6985dd0deb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaeb0605679ad9f686dd0f40610c8af772"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#gaeb0605679ad9f686dd0f40610c8af772">EvrRtxSemaphoreDelete</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:gaeb0605679ad9f686dd0f40610c8af772"><td class="mdescLeft"> </td><td class="mdescRight">Event on semaphore delete (API) <a href="#gaeb0605679ad9f686dd0f40610c8af772">More...</a><br/></td></tr> <tr class="separator:gaeb0605679ad9f686dd0f40610c8af772"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaad8d8a2844e948b00f02e8620c431c9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__semaphore.html#gaad8d8a2844e948b00f02e8620c431c9c">EvrRtxSemaphoreDestroyed</a> (<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> semaphore_id)</td></tr> <tr class="memdesc:gaad8d8a2844e948b00f02e8620c431c9c"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful semaphore delete (Op) <a href="#gaad8d8a2844e948b00f02e8620c431c9c">More...</a><br/></td></tr> <tr class="separator:gaad8d8a2844e948b00f02e8620c431c9c"><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="ga96a0209384296a283c7b1d23a3395fa1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreError </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</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>SemaphoreError</b> is generated when <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</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>semaphore_id</b> : semaphore ID.</li> <li><b>status</b> : execution status code. </li> </ul> </div> </div> <a class="anchor" id="ga5639f03e935ab79844777664a518c2ec"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreNew </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>max_count</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>initial_count</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#structosSemaphoreAttr__t">osSemaphoreAttr_t</a> * </td> <td class="paramname"><em>attr</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">max_count</td><td>maximum number of available tokens. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">initial_count</td><td>initial number of available tokens. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>semaphore attributes.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a> is called.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>max_count</b> : maximum number of available tokens.</li> <li><b>initial_count</b> : initial number of available tokens.</li> <li><b>attr</b> : memory address of Semaphore attributes or 0 when they are not specified.</li> </ul> <p>In case when <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#structosSemaphoreAttr__t">semaphore attributes</a> are provided in the API call they are also detailed in the Event Recorder. </p> </div> </div> <a class="anchor" id="gad46ee88b57aed4c666aec773560aebad"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreCreated </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a> successfully creates a semaphore object.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="ga17d8aa861b6e669cc68c3c41e3e12332"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreGetName </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to semaphore object name.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga9586952051f00285f1482dbe6695bbc4">osSemaphoreGetName</a> is called and its execution result is known.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore 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="gafd91c9bb268a48b394571a9fc1809019"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreAcquire </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</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>SemaphoreAcquire</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7e94c8b242a0c81f2cc79ec22895c87b">osSemaphoreAcquire</a> is called.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore 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="gabbaaf85deaf4645414987fc1c3289343"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreAcquirePending </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</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>SemaphoreAcquirePending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7e94c8b242a0c81f2cc79ec22895c87b">osSemaphoreAcquire</a> blocks current running thread and waits for semaphore token to become available.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore 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="ga852798d5e14cda14484564ac4d7f5a4b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreAcquireTimeout </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreAcquireTimeout</b> is generated when wait for semaphore to become available is aborted due to expired wait timeout.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="ga97de1ac0437425129f0eb28eea74e993"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreAcquired </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreAcquired</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7e94c8b242a0c81f2cc79ec22895c87b">osSemaphoreAcquire</a> successfully acquires the semaphore token.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="ga53eb40f5251e9464b46cc153fe8b26d8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreNotAcquired </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreNotAcquired</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a> returns without timeout and semaphore token was not acquired.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="ga0a9f3c7dbf89d3f155a96524e7195630"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreRelease </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreRelease</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga0abcee1b5449d7a6928fb9248c690bb6">osSemaphoreRelease</a> is called.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="ga684b0e0956cf664c9342e2242c258eea"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreReleased </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreReleased</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga0abcee1b5449d7a6928fb9248c690bb6">osSemaphoreRelease</a> successfully releases the semaphore token.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="ga17f21ffa4ec39c50ce203e6985dd0deb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreGetCount </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>count</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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>current number of available tokens.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreGetCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7559d4dff3cda9992fc5ab5de3e74c70">osSemaphoreGetCount</a> is called and its execution result is known.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID.</li> <li><b>count</b> : retrieved current number of available tokens. </li> </ul> </div> </div> <a class="anchor" id="gaeb0605679ad9f686dd0f40610c8af772"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreDelete </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga81258ce9c67fa89f07cc49d2e136cd88">osSemaphoreDelete</a> is called.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore ID. </li> </ul> </div> </div> <a class="anchor" id="gaad8d8a2844e948b00f02e8620c431c9c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void EvrRtxSemaphoreDestroyed </td> <td>(</td> <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a> </td> <td class="paramname"><em>semaphore_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">semaphore_id</td><td>semaphore ID obtained by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a">osSemaphoreNew</a>.</td></tr> </table> </dd> </dl> <p>The event <b>SemaphoreDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga81258ce9c67fa89f07cc49d2e136cd88">osSemaphoreDelete</a> successfully deletes the semaphore object.</p> <p><b>Value</b> in the Event Recorder shows:</p> <ul> <li><b>semaphore_id</b> : semaphore 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 Feb 8 2017 10:21:04 for CMSIS-RTOS2 by ARM Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 --> </li> </ul> </div> </body> </html>