2019-05-15 10:57:06 +01:00
<!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" / >
2019-10-18 15:30:02 +01:00
< title > CMSIS-RTOS API v2< / title >
< title > CMSIS-RTOS2: CMSIS-RTOS API v2< / title >
2019-05-15 10:57:06 +01:00
< 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);
2019-10-18 15:30:02 +01:00
$(window).load(resizeHeight);
2019-05-15 10:57:06 +01:00
< / 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;" >
2019-10-18 15:30:02 +01:00
< div id = "projectname" > CMSIS-RTOS2
  < span id = "projectnumber" > Version 2.1.3< / span >
2019-05-15 10:57:06 +01:00
< / div >
2019-10-18 15:30:02 +01:00
< div id = "projectbrief" > Real-Time Operating System: API and RTX Reference Implementation< / div >
2019-05-15 10:57:06 +01:00
< / 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 >
2019-10-18 15:30:02 +01:00
<!-- Generated by Doxygen 1.8.6 -->
2019-05-15 10:57:06 +01:00
< 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" >
2019-10-18 15:30:02 +01:00
$(document).ready(function(){initNavTree('group__CMSIS__RTOS.html','');});
2019-05-15 10:57:06 +01:00
< / 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 = "#groups" > Content< / a > < / div >
< div class = "headertitle" >
2019-10-18 15:30:02 +01:00
< div class = "title" > CMSIS-RTOS API v2< / div > < / div >
2019-05-15 10:57:06 +01:00
< / div > <!-- header -->
< div class = "contents" >
2019-10-18 15:30:02 +01:00
< p > C interface of < a class = "el" href = "rtos_api2.html" > CMSIS-RTOS C API v2< / a > defined in < a class = "el" href = "cmsis__os2_8h.html" > cmsis_os2.h< / a > .
< a href = "#details" > More...< / a > < / p >
2019-05-15 10:57:06 +01:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "groups" > < / a >
Content< / h2 > < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__MemoryMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__MemoryMgmt.html" > Memory Management< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__MemoryMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Information about memory management possibilities. < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:group__CMSIS__RTOS__KernelCtrl" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__KernelCtrl.html" > Kernel Information and Control< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__KernelCtrl" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Provides version/system information and starts/controls the RTOS Kernel. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__ThreadMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__ThreadMgmt.html" > Thread Management< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__ThreadMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Define, create, and control thread functions. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__ThreadFlagsMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__ThreadFlagsMgmt.html" > Thread Flags< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__ThreadFlagsMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Synchronize threads using flags. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__EventFlags" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__EventFlags.html" > Event Flags< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__EventFlags" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Synchronize threads using event flags. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__Wait" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Wait.html" > Generic Wait Functions< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__Wait" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Wait for a certain period of time. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__TimerMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__TimerMgmt.html" > Timer Management< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__TimerMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Create and control timer and timer callback functions. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__MutexMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__MutexMgmt.html" > Mutex Management< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__MutexMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Synchronize resource access using Mutual Exclusion (Mutex). < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__SemaphoreMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__SemaphoreMgmt.html" > Semaphores< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__SemaphoreMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Access shared resources simultaneously from different threads. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__PoolMgmt" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html" > Memory Pool< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__PoolMgmt" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Manage thread-safe fixed-size blocks of dynamic memory. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__Message" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Message.html" > Message Queue< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__Message" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Exchange messages between threads in a FIFO-like operation. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:group__CMSIS__RTOS__Definitions" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html" > Definitions< / a > < / td > < / tr >
< tr class = "memdesc:group__CMSIS__RTOS__Definitions" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constants and enumerations used by many CMSIS-RTOS functions. < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Description< / h2 >
2019-10-18 15:30:02 +01:00
< p > C interface of < a class = "el" href = "rtos_api2.html" > CMSIS-RTOS C API v2< / a > defined in < b > cmsis_os2.h< / b > < / p >
< p > The CMSIS-RTOS2 is a generic API layer that interfaces to an RTOS kernel.< / p >
< p > The complete API interface is defined in the < a class = "el" href = "genRTOS2IF.html#cmsis_os2_h" > cmsis_os2.h header file< / a > . When using dynamic memory allocation for objects, source code or libraries require no modifications when using on a different CMSIS-RTOS2 implementation.< / p >
< p > Refer to < a class = "el" href = "rtos_api2.html#rtos_api2_basics" > Common Design Concepts< / a > for further details. < / p >
2019-05-15 10:57:06 +01:00
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2019-10-18 15:30:02 +01:00
< li class = "footer" > Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
2019-05-15 10:57:06 +01:00
<!--
< a href = "http://www.doxygen.org/index.html" >
2019-10-18 15:30:02 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.6
2019-05-15 10:57:06 +01:00
-->
< / li >
< / ul >
< / div >
< / body >
< / html >
