<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Generic Data Types and Definitions</title> <title>CMSIS-RTOS: Generic Data Types and Definitions</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-RTOS  <span id="projectnumber">Version 1.03</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__CMSIS__RTOS__Definitions.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="#nested-classes">Data Structures</a> </div> <div class="headertitle"> <div class="title">Generic Data Types and Definitions<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Data Type Definitions used by the CMSIS-RTOS API functions. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:structosEvent"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#structosEvent">osEvent</a></td></tr> <tr class="memdesc:structosEvent"><td class="mdescLeft"> </td><td class="mdescRight">Event structure contains detailed information about an event. <a href="group__CMSIS__RTOS__Definitions.html#structosEvent">More...</a><br/></td></tr> <tr class="separator:structosEvent"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:structos__mailQ"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#structos__mailQ">os_mailQ</a></td></tr> <tr class="separator:structos__mailQ"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>The Data Type section lists all data types that are used to exchange information with CMSIS-RTOS functions. </p> <hr/><h2 class="groupheader">Data Structure Documentation</h2> <a name="structosEvent" id="structosEvent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct osEvent</td> </tr> </table> </div><div class="memdoc"> <div class="textblock"><dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>os_event</b> shall be consistent in every CMSIS-RTOS. However the struct may be extended at the end.</dd></dl> <p>The <b><a class="el" href="group__CMSIS__RTOS__Definitions.html#structosEvent" title="Event structure contains detailed information about an event. ">osEvent</a></b> structure describes the events returned by CMSIS-RTOS functions. </p> </div><table class="memberdecls"> <tr><td colspan="2"><h3>Data Fields</h3></td></tr> <tr class="memitem:ad477a289f1f03ac45407b64268d707d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e">osStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ad477a289f1f03ac45407b64268d707d3">status</a></td></tr> <tr class="memdesc:ad477a289f1f03ac45407b64268d707d3"><td class="mdescLeft"> </td><td class="mdescRight">status code: event or error information <a href="#ad477a289f1f03ac45407b64268d707d3">More...</a><br/></td></tr> <tr class="separator:ad477a289f1f03ac45407b64268d707d3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0b9f8fd3645f01d8cb09cae82add2d7f"><td class="memItemLeft" >union {</td></tr> <tr class="memitem:a9e0a00edabf3b8a5dafff624fff7bbfc"><td class="memItemLeft" >   uint32_t   <a class="el" href="group__CMSIS__RTOS__Definitions.html#a9e0a00edabf3b8a5dafff624fff7bbfc">v</a></td></tr> <tr class="memdesc:a9e0a00edabf3b8a5dafff624fff7bbfc"><td class="mdescLeft"> </td><td class="mdescRight">message as 32-bit value <a href="#a9e0a00edabf3b8a5dafff624fff7bbfc">More...</a><br/></td></tr> <tr class="separator:a9e0a00edabf3b8a5dafff624fff7bbfc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a117104b82864d3b23ec174af6d392709"><td class="memItemLeft" >   void *   <a class="el" href="group__CMSIS__RTOS__Definitions.html#a117104b82864d3b23ec174af6d392709">p</a></td></tr> <tr class="memdesc:a117104b82864d3b23ec174af6d392709"><td class="mdescLeft"> </td><td class="mdescRight">message or mail as void pointer <a href="#a117104b82864d3b23ec174af6d392709">More...</a><br/></td></tr> <tr class="separator:a117104b82864d3b23ec174af6d392709"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad0dda1bf7e74f1576261d493fba232b6"><td class="memItemLeft" >   int32_t   <a class="el" href="group__CMSIS__RTOS__Definitions.html#ad0dda1bf7e74f1576261d493fba232b6">signals</a></td></tr> <tr class="memdesc:ad0dda1bf7e74f1576261d493fba232b6"><td class="mdescLeft"> </td><td class="mdescRight">signal flags <a href="#ad0dda1bf7e74f1576261d493fba232b6">More...</a><br/></td></tr> <tr class="separator:ad0dda1bf7e74f1576261d493fba232b6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0b9f8fd3645f01d8cb09cae82add2d7f"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#a0b9f8fd3645f01d8cb09cae82add2d7f">value</a></td></tr> <tr class="memdesc:a0b9f8fd3645f01d8cb09cae82add2d7f"><td class="mdescLeft"> </td><td class="mdescRight">event value <a href="#a0b9f8fd3645f01d8cb09cae82add2d7f">More...</a><br/></td></tr> <tr class="separator:a0b9f8fd3645f01d8cb09cae82add2d7f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a596b6d55c3321db19239256bbe403df6"><td class="memItemLeft" >union {</td></tr> <tr class="memitem:ac86175a4b1706bee596f3018322df26e"><td class="memItemLeft" >   <a class="el" href="cmsis__os_8h.html#a1dac049fb7725a8af8b26c71cbb373b5">osMailQId</a>   <a class="el" href="group__CMSIS__RTOS__Definitions.html#ac86175a4b1706bee596f3018322df26e">mail_id</a></td></tr> <tr class="memdesc:ac86175a4b1706bee596f3018322df26e"><td class="mdescLeft"> </td><td class="mdescRight">mail id obtained by <a class="el" href="group__CMSIS__RTOS__Mail.html#gaa177e7fe5820dd70d8c9e46ded131174">osMailCreate</a> <a href="#ac86175a4b1706bee596f3018322df26e">More...</a><br/></td></tr> <tr class="separator:ac86175a4b1706bee596f3018322df26e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af394cbe21dde7377974e63af38cd87b0"><td class="memItemLeft" >   <a class="el" href="cmsis__os_8h.html#ad9ec70c32c6c521970636b521e12d17f">osMessageQId</a>   <a class="el" href="group__CMSIS__RTOS__Definitions.html#af394cbe21dde7377974e63af38cd87b0">message_id</a></td></tr> <tr class="memdesc:af394cbe21dde7377974e63af38cd87b0"><td class="mdescLeft"> </td><td class="mdescRight">message id obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#gaf3b9345cf426304d46565152bc26fb78">osMessageCreate</a> <a href="#af394cbe21dde7377974e63af38cd87b0">More...</a><br/></td></tr> <tr class="separator:af394cbe21dde7377974e63af38cd87b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a596b6d55c3321db19239256bbe403df6"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Definitions.html#a596b6d55c3321db19239256bbe403df6">def</a></td></tr> <tr class="memdesc:a596b6d55c3321db19239256bbe403df6"><td class="mdescLeft"> </td><td class="mdescRight">event definition <a href="#a596b6d55c3321db19239256bbe403df6">More...</a><br/></td></tr> <tr class="separator:a596b6d55c3321db19239256bbe403df6"><td class="memSeparator" colspan="2"> </td></tr> </table> <h4 class="groupheader">Field Documentation</h4> <a class="anchor" id="a596b6d55c3321db19239256bbe403df6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">union { ... } def</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ac86175a4b1706bee596f3018322df26e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cmsis__os_8h.html#a1dac049fb7725a8af8b26c71cbb373b5">osMailQId</a> mail_id</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="af394cbe21dde7377974e63af38cd87b0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cmsis__os_8h.html#ad9ec70c32c6c521970636b521e12d17f">osMessageQId</a> message_id</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a117104b82864d3b23ec174af6d392709"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* p</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ad0dda1bf7e74f1576261d493fba232b6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int32_t signals</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ad477a289f1f03ac45407b64268d707d3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e">osStatus</a> status</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a9e0a00edabf3b8a5dafff624fff7bbfc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t v</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a0b9f8fd3645f01d8cb09cae82add2d7f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">union { ... } value</td> </tr> </table> </div><div class="memdoc"> </div> </div> </div> </div> <a name="structos__mailQ" id="structos__mailQ"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct os_mailQ</td> </tr> </table> </div><div class="memdoc"> <div class="textblock"><p>The <b><a class="el" href="group__CMSIS__RTOS__Definitions.html#structosEvent" title="Event structure contains detailed information about an event. ">osEvent</a></b> structure describes the events returned by CMSIS-RTOS functions. </p> </div> </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:02 for CMSIS-RTOS 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>