begriffs open source - cmsis-freertos/blob - docs/General/html/group__freertos__setup.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>Event Recorder Setup</title>
   7 <title>CMSIS-FreeRTOS: Event Recorder Setup</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="cmsis.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="printComponentTabs.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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 </head>
  26 <body>
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr style="height: 46px;">
  32   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33   <td style="padding-left: 0.5em;">
  34    <div id="projectname">CMSIS-FreeRTOS
  35    &#160;<span id="projectnumber">Version 10.3.0</span>
  36    </div>
  37    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  38   </td>
  39  </tr>
  40  </tbody>
  41 </table>
  42 </div>
  43 <!-- end header part -->
  44 <div id="CMSISnav" class="tabs1">
  45     <ul class="tablist">
  46       <script type="text/javascript">
  47                 <!--
  48                 writeComponentTabs.call(this);
  49                 //-->
  50       </script>
  51           </ul>
  52 </div>
  53 <!-- Generated by Doxygen 1.8.6 -->
  54 <script type="text/javascript">
  55 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56 </script>
  57   <div id="navrow1" class="tabs">
  58     <ul class="tablist">
  59       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61       <li><a href="modules.html"><span>Reference</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80 </div><!-- top -->
  81 <div id="side-nav" class="ui-resizable side-nav-resizable">
  82   <div id="nav-tree">
  83     <div id="nav-tree-contents">
  84       <div id="nav-sync" class="sync"></div>
  85     </div>
  86   </div>
  87   <div id="splitbar" style="-moz-user-select:none;"
  88        class="ui-resizable-handle">
  89   </div>
  90 </div>
  91 <script type="text/javascript">
  92 $(document).ready(function(){initNavTree('group__freertos__setup.html','');});
  93 </script>
  94 <div id="doc-content">
  95 <!-- window showing the filter options -->
  96 <div id="MSearchSelectWindow"
  97      onmouseover="return searchBox.OnSearchSelectShow()"
  98      onmouseout="return searchBox.OnSearchSelectHide()"
  99      onkeydown="return searchBox.OnSearchSelectKey(event)">
 100 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 101
 102 <!-- iframe showing the search results (closed by default) -->
 103 <div id="MSearchResultsWindow">
 104 <iframe src="javascript:void(0)" frameborder="0"
 105         name="MSearchResults" id="MSearchResults">
 106 </iframe>
 107 </div>
 108
 109 <div class="header">
 110   <div class="summary">
 111 <a href="#func-members">Functions</a>  </div>
 112   <div class="headertitle">
 113 <div class="title">Event Recorder Setup<div class="ingroups"><a class="el" href="group__freertos__specific.html">CMSIS-FreeRTOS Specifics</a></div></div>  </div>
 114 </div><!--header-->
 115 <div class="contents">
 116
 117 <p>Information about Event Recorder configuration and setup.
 118 <a href="#details">More...</a></p>
 119 <table class="memberdecls">
 120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 121 Functions</h2></td></tr>
 122 <tr class="memitem:ga943f40b05c79f40c73d67b1adcbe3dbe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__setup.html#ga943f40b05c79f40c73d67b1adcbe3dbe">EvrFreeRTOSSetup</a> (uint32_t reset)</td></tr>
 123 <tr class="memdesc:ga943f40b05c79f40c73d67b1adcbe3dbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup Event Recorder configuration.  <a href="#ga943f40b05c79f40c73d67b1adcbe3dbe">More...</a><br/></td></tr>
 124 <tr class="separator:ga943f40b05c79f40c73d67b1adcbe3dbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 </table>
 126 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 127 <p>CMSIS-FreeRTOS interfaces to the <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a> to provide event information which helps you to understand and analyze the operation.</p>
 128 <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="cre_freertos_proj.html">Create a FreeRTOS project</a>. </p>
 129 <h2 class="groupheader">Function Documentation</h2>
 130 <a class="anchor" id="ga943f40b05c79f40c73d67b1adcbe3dbe"></a>
 131 <div class="memitem">
 132 <div class="memproto">
 133       <table class="memname">
 134         <tr>
 135           <td class="memname">void EvrFreeRTOSSetup </td>
 136           <td>(</td>
 137           <td class="paramtype">uint32_t&#160;</td>
 138           <td class="paramname"><em>reset</em></td><td>)</td>
 139           <td></td>
 140         </tr>
 141       </table>
 142 </div><div class="memdoc">
 143 <dl class="params"><dt>Parameters</dt><dd>
 144   <table class="params">
 145     <tr><td class="paramdir">[in]</td><td class="paramname">reset</td><td>reset if already configured (0:no reset, 1:reset)</td></tr>
 146   </table>
 147   </dd>
 148 </dl>
 149 <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>
 150 <p>The argument <em>reset</em> specifies if reset of previously applied configuration is performed in case if EvrFreeRTOSSetup was already called.</p>
 151 <p>Behavior of this function execution is defined with Event Recorder Configuration (<a class="el" href="cre_freertos_proj.html#cmsis_freertos_evr_config">Configure Event Recorder</a>). Calling this function has no effect when Event Recorder component is not selected.</p>
 152 <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>
 153
 154 </div>
 155 </div>
 156 </div><!-- contents -->
 157 </div><!-- doc-content -->
 158 <!-- start footer part -->
 159 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 160   <ul>
 161     <li class="footer">Generated on Wed Dec 4 2019 07:44:08 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
 162         <!--
 163     <a href="http://www.doxygen.org/index.html">
 164     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 165         -->
 166         </li>
 167   </ul>
 168 </div>
 169 </body>
 170 </html>