begriffs open source - cmsis-freertos/blob - main/group__freertos__setup.html

   1 <!-- HTML header for doxygen 1.9.6-->
   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" lang="en-US">
   4 <head>
   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: Event Recorder Setup</title>
   9 <link href="doxygen.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="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="navtreedata.js"></script>
  17 <script type="text/javascript" src="navtree.js"></script>
  18 <script type="text/javascript" src="resize.js"></script>
  19 <script type="text/javascript" src="cookie.js"></script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/searchdata.js"></script>
  22 <script type="text/javascript" src="search/search.js"></script>
  23 <script type="text/javascript">
  24 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  25   $(function() { init_search(); });
  26 /* @license-end */
  27 </script>
  28 <script type="text/javascript" src="darkmode_toggle.js"></script>
  29 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  32 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  33 <link href="version.css" rel="stylesheet" type="text/css"/>
  34 <script type="text/javascript" src="../version.js"></script>
  35 </head>
  36 <body>
  37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  38 <div id="titlearea">
  39 <table cellspacing="0" cellpadding="0">
  40  <tbody>
  41  <tr style="height: 55px;">
  42   <td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="cmsis_logo_white_small.png"/</a></td>
  43   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  44    <div id="projectname">CMSIS-FreeRTOS
  45    &#160;<span id="projectnumber"><script type="text/javascript">
  46      <!--
  47      writeHeader.call(this);
  48      writeVersionDropdown.call(this, "CMSIS-FreeRTOS");
  49      //-->
  50     </script>
  51    </span>
  52    </div>
  53    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  54   </td>
  55    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  56         <span class="left">
  57           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  58           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  59                onfocus="searchBox.OnSearchFieldFocus(true)"
  60                onblur="searchBox.OnSearchFieldFocus(false)"
  61                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  62           </span><span class="right">
  63             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  64           </span>
  65         </div>
  66 </td>
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <!-- Generated by Doxygen 1.13.2 -->
  80 <script type="text/javascript">
  81 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82 var searchBox = new SearchBox("searchBox", "search/",'.html');
  83 /* @license-end */
  84 </script>
  85 <script type="text/javascript">
  86 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  87 $(function() { codefold.init(0); });
  88 /* @license-end */
  89 </script>
  90 </div><!-- top -->
  91 <div id="side-nav" class="ui-resizable side-nav-resizable">
  92   <div id="nav-tree">
  93     <div id="nav-tree-contents">
  94       <div id="nav-sync" class="sync"></div>
  95     </div>
  96   </div>
  97   <div id="splitbar" style="-moz-user-select:none;"
  98        class="ui-resizable-handle">
  99   </div>
 100 </div>
 101 <script type="text/javascript">
 102 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 103 $(function(){initNavTree('group__freertos__setup.html',''); initResizable(true); });
 104 /* @license-end */
 105 </script>
 106 <div id="doc-content">
 107 <!-- window showing the filter options -->
 108 <div id="MSearchSelectWindow"
 109      onmouseover="return searchBox.OnSearchSelectShow()"
 110      onmouseout="return searchBox.OnSearchSelectHide()"
 111      onkeydown="return searchBox.OnSearchSelectKey(event)">
 112 </div>
 113
 114 <!-- iframe showing the search results (closed by default) -->
 115 <div id="MSearchResultsWindow">
 116 <div id="MSearchResults">
 117 <div class="SRPage">
 118 <div id="SRIndex">
 119 <div id="SRResults"></div>
 120 <div class="SRStatus" id="Loading">Loading...</div>
 121 <div class="SRStatus" id="Searching">Searching...</div>
 122 <div class="SRStatus" id="NoMatches">No Matches</div>
 123 </div>
 124 </div>
 125 </div>
 126 </div>
 127
 128 <div class="header">
 129   <div class="summary">
 130 <a href="#func-members">Functions</a>  </div>
 131   <div class="headertitle"><div class="title">Event Recorder Setup<div class="ingroups"><a class="el" href="group__freertos__specific.html">CMSIS-FreeRTOS Specifics</a></div></div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>Information about Event Recorder configuration and setup.
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 139 Functions</h2></td></tr>
 140 <tr class="memitem:ga943f40b05c79f40c73d67b1adcbe3dbe" id="r_ga943f40b05c79f40c73d67b1adcbe3dbe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga943f40b05c79f40c73d67b1adcbe3dbe">EvrFreeRTOSSetup</a> (uint32_t reset)</td></tr>
 141 <tr class="memdesc:ga943f40b05c79f40c73d67b1adcbe3dbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup Event Recorder configuration.  <br /></td></tr>
 142 <tr class="separator:ga943f40b05c79f40c73d67b1adcbe3dbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table>
 144 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 145 <p>Information about Event Recorder configuration and setup. </p>
 146 <p>CMSIS-FreeRTOS interfaces to the <a href="https://arm-software.github.io/CMSIS-View/latest/evr.html" target="_blank"><b>Event Recorder</b></a> to provide event information which helps you to understand and analyze the operation.</p>
 147 <p>To use the Event Recorder together with CMSIS-FreeRTOS, it is required to create an image that generates event information. The steps are described under <a class="el" href="page_create_project.html">Create a FreeRTOS Project</a>. </p>
 148 <h2 class="groupheader">Function Documentation</h2>
 149 <a id="ga943f40b05c79f40c73d67b1adcbe3dbe" name="ga943f40b05c79f40c73d67b1adcbe3dbe"></a>
 150 <h2 class="memtitle"><span class="permalink"><a href="#ga943f40b05c79f40c73d67b1adcbe3dbe">&#9670;&#160;</a></span>EvrFreeRTOSSetup()</h2>
 151
 152 <div class="memitem">
 153 <div class="memproto">
 154 <table class="mlabels">
 155   <tr>
 156   <td class="mlabels-left">
 157       <table class="memname">
 158         <tr>
 159           <td class="memname">void EvrFreeRTOSSetup </td>
 160           <td>(</td>
 161           <td class="paramtype">uint32_t</td>          <td class="paramname"><span class="paramname"><em>reset</em></span></td><td>)</td>
 162           <td></td>
 163         </tr>
 164       </table>
 165   </td>
 166   <td class="mlabels-right">
 167 <span class="mlabels"><span class="mlabel extern">extern</span></span>  </td>
 168   </tr>
 169 </table>
 170 </div><div class="memdoc">
 171
 172 <p>Setup Event Recorder configuration. </p>
 173 <dl class="params"><dt>Parameters</dt><dd>
 174   <table class="params">
 175     <tr><td class="paramdir">[in]</td><td class="paramname">reset</td><td>reset if already configured (0:no reset, 1:reset)</td></tr>
 176   </table>
 177   </dd>
 178 </dl>
 179 <p>The function <b>EvrFreeRTOSSetup</b> initializes Event Recorder and configures recording level filter. It must be called before any event is sent to the Event Recorder.</p>
 180 <p>The argument <em class="arg">reset</em> specifies if reset of previously applied configuration is performed in case if EvrFreeRTOSSetup was already called.</p>
 181 <p>Behavior of this function execution is defined with Event Recorder Configuration (<a class="el" href="page_create_project.html#configure_evr">Configure Event Recorder</a>). Calling this function has no effect when Event Recorder component is not selected.</p>
 182 <dl class="section note"><dt>Note</dt><dd><b>EvrFreeRTOSSetup</b> is called by function <b>osKernelInitialize</b> when CMSIS-RTOS2 API is in use and should not be called explicitly. </dd></dl>
 183
 184 </div>
 185 </div>
 186 </div><!-- contents -->
 187 </div><!-- doc-content -->
 188 <!-- start footer part -->
 189 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 190   <ul>
 191     <li class="footer">
 192       <script type="text/javascript">
 193         <!--
 194         writeFooter.call(this);
 195         //-->
 196       </script>
 197     </li>
 198   </ul>
 199 </div>
 200 </body>
 201 </html>