1 <!-- HTML header for doxygen 1.9.2-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-FreeRTOS: API Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="footer.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
18 <script type="text/javascript" src="search/searchdata.js"></script>
19 <script type="text/javascript" src="search/search.js"></script>
20 <script type="text/javascript">
21 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
22 $(document).ready(function() { init_search(); });
25 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
26 <link href="version.css" rel="stylesheet" type="text/css" />
27 <script type="text/javascript" src="../version.js"></script>
30 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32 <table cellspacing="0" cellpadding="0">
34 <tr style="height: 55px;">
35 <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
36 <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
37 <div id="projectname">CMSIS-FreeRTOS
38  <span id="projectnumber"><script type="text/javascript">
40 writeHeader.call(this);
41 writeVersionDropdown(this);
46 <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
48 <!--END !PROJECT_NAME-->
49 <td> <div id="MSearchBox" class="MSearchBoxInactive">
51 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
52 <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
53 onfocus="searchBox.OnSearchFieldFocus(true)"
54 onblur="searchBox.OnSearchFieldFocus(false)"
55 onkeyup="searchBox.OnSearchFieldChange(event)"/>
56 </span><span class="right">
57 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
65 <!-- end header part -->
66 <!-- Generated by Doxygen 1.9.6 -->
67 <script type="text/javascript">
68 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
69 var searchBox = new SearchBox("searchBox", "search/",'.html');
73 <div id="side-nav" class="ui-resizable side-nav-resizable">
75 <div id="nav-tree-contents">
76 <div id="nav-sync" class="sync"></div>
79 <div id="splitbar" style="-moz-user-select:none;"
80 class="ui-resizable-handle">
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
85 $(document).ready(function(){initNavTree('modules.html',''); initResizable(); });
88 <div id="doc-content">
89 <!-- window showing the filter options -->
90 <div id="MSearchSelectWindow"
91 onmouseover="return searchBox.OnSearchSelectShow()"
92 onmouseout="return searchBox.OnSearchSelectHide()"
93 onkeydown="return searchBox.OnSearchSelectKey(event)">
96 <!-- iframe showing the search results (closed by default) -->
97 <div id="MSearchResultsWindow">
98 <div id="MSearchResults">
101 <div id="SRResults"></div>
102 <div class="SRStatus" id="Loading">Loading...</div>
103 <div class="SRStatus" id="Searching">Searching...</div>
104 <div class="SRStatus" id="NoMatches">No Matches</div>
111 <div class="headertitle"><div class="title">API Reference</div></div>
113 <div class="contents">
114 <div class="textblock">Here is a list of all modules:</div><div class="directory">
115 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
116 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><a class="el" href="group__freertos__specific.html" target="_self">CMSIS-FreeRTOS Specifics</a></td><td class="desc">This section describes CMSIS-FreeRTOS specifics </td></tr>
117 <tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__freertos__setup.html" target="_self">Event Recorder Setup</a></td><td class="desc">Information about Event Recorder configuration and setup </td></tr>
118 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">▼</span><a class="el" href="group__freertos__evr.html" target="_self">Event functions</a></td><td class="desc">FreeRTOS Event Recorder functions </td></tr>
119 <tr id="row_0_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a class="el" href="group__freertos__evr__tasks.html" target="_self">Tasks Functions</a></td><td class="desc">Events generated by tasks functions </td></tr>
120 <tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a class="el" href="group__freertos__evr__queue.html" target="_self">Message Queue Functions</a></td><td class="desc">Events generated by message queue functions </td></tr>
121 <tr id="row_0_1_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a class="el" href="group__freertos__evr__timers.html" target="_self">Timer Functions</a></td><td class="desc">Events generated by timer functions </td></tr>
122 <tr id="row_0_1_3_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a class="el" href="group__freertos__evr__event__groups.html" target="_self">Event Groups Functions</a></td><td class="desc">Events generated by event groups functions </td></tr>
123 <tr id="row_0_1_4_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a class="el" href="group__freertos__evr__streambuf.html" target="_self">Stream Buffer Functions</a></td><td class="desc">Events generated by Stream Buffer and Message Buffer functions </td></tr>
124 <tr id="row_0_1_5_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a class="el" href="group__freertos__evr__heap.html" target="_self">Heap Functions</a></td><td class="desc">Events generated by heap functions </td></tr>
126 </div><!-- directory -->
127 </div><!-- contents -->
128 </div><!-- doc-content -->
129 <!-- start footer part -->
130 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
133 <script type="text/javascript">
135 writeFooter.call(this);