begriffs open source - cmsis-freertos/blob - Docs/General/html/cre_freertos_proj.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>Create a FreeRTOS project</title>
   7 <title>CMSIS-FreeRTOS: Create a FreeRTOS project</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 9.0.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 class="current"><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('cre_freertos_proj.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="headertitle">
 111 <div class="title">Create a FreeRTOS project </div>  </div>
 112 </div><!--header-->
 113 <div class="contents">
 114 <div class="textblock"><p>You can basically choose between two option when creating a FreeRTOS project:</p>
 115 <ol type="1">
 116 <li><a class="el" href="cre_freertos_proj.html#native_freertos">Create a native FreeRTOS project</a> using the FreeRTOS API and kernel.</li>
 117 <li><a class="el" href="cre_freertos_proj.html#cmsis_freertos">Create a CMSIS-FreeRTOS project</a> using the CMSIS-RTOS2 API with an underlying FreeRTOS kernel.</li>
 118 </ol>
 119 <h1><a class="anchor" id="native_freertos"></a>
 120 Create a native FreeRTOS project</h1>
 121 <p>The steps to create a microcontroller application using FreeRTOS are:</p>
 122 <ul>
 123 <li>Create a new project and select a microcontroller device.</li>
 124 <li><p class="startli">In the Manage Run-Time Environment window, select <b>::Device:Startup</b>, <b>::RTOS:CORE</b> and <b>::RTOS:Config</b> in the <b>FreeRTOS</b> variant and an applicable <b>::RTOS:Heap</b> scheme (for more information on the heap schemes, visit the FreeRTOS documentation):</p>
 125 <div class="image">
 126 <img src="manage_rte_freertos_native.png" alt="manage_rte_freertos_native.png"/>
 127 </div>
 128 <p class="startli"><br/>
 129 </p>
 130 </li>
 131 <li>If the <b>Validation Output</b> requires other components to be present, try to use the <b>Resolve</b> button.</li>
 132 <li><p class="startli">Click <b>OK</b>. In the <b>Project</b> window, you will see the files that have been automatically added to you project, such as <b>FreeRTOSConfig.h</b>, the source code files, as well as the system and startup files:</p>
 133 <div class="image">
 134 <img src="project_window_freertos_native.png" alt="project_window_freertos_native.png"/>
 135 </div>
 136 </li>
 137 </ul>
 138 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Do we add user code templates for the native FreeRTOS implementation?</dd></dl>
 139 <ul>
 140 <li>You can add template files to the project by right-clicking on <b>Source Group 1</b> and selecting <b>Add New Item to 'Source Group 1'</b>. In the new window, click on <b>User Code Template</b>. On the right-hand side you will see all available template files for CMSIS-RTOS RTX:</li>
 141 </ul>
 142 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Do we offer an SCVD file for the native FreeRTOS implementation?</dd></dl>
 143 <h2><a class="anchor" id="native_freertos_er"></a>
 144 Add Event Recorder Visibility</h2>
 145 <ul>
 146 <li>To use the Event Recorder together with RTX5, select the software component <b>Compiler:Event Recorder</b>.</li>
 147 <li>Select the <b>Source</b> variant of the software component <b>CMSIS:RTOS2 (API):Keil RTX5</b>.</li>
 148 <li>Call the function <b>EventRecorderInitialize()</b> in your application code (ideally in <code>main()</code>).</li>
 149 <li>Build the application code and download it to the debug hardware.</li>
 150 </ul>
 151 <p>Once the target application generates event information, it can be viewed in the ÂµVision debugger using the <b>Event</b> <b>Recorder</b>.</p>
 152 <h1><a class="anchor" id="cmsis_freertos"></a>
 153 Create a CMSIS-FreeRTOS project</h1>
 154 <p>The steps to create a microcontroller application using CMSIS-FreeRTOS are:</p>
 155 <ul>
 156 <li>Create a new project and select a microcontroller device.</li>
 157 <li><p class="startli">In the Manage Run-Time Environment window, select <b>::Device:Startup</b>, <b>::CMSIS::RTOS2 (API)::FreeRTOS</b>, <b>::RTOS:CORE</b> in the <b>FreeRTOS</b> variant, <b>::RTOS:Config</b> in the <b>CMSIS</b> <b>RTOS2</b> variant, <b>::RTOS:FreeRTOS:Timers</b>, <b>::RTOS:FreeRTOS:Event Groups</b>, and an applicable <b>::RTOS:Heap</b> scheme (for more information on the heap schemes, visit the FreeRTOS documentation):</p>
 158 <div class="image">
 159 <img src="manage_rte_freertos_rtos2.png" alt="manage_rte_freertos_rtos2.png"/>
 160 </div>
 161 <p class="startli"><br/>
 162 </p>
 163 </li>
 164 <li>If the <b>Validation Output</b> requires other components to be present, try to use the <b>Resolve</b> button.</li>
 165 <li><p class="startli">Click <b>OK</b>. In the <b>Project</b> window, you will see the files that have been automatically added to you project, such as <b>FreeRTOSConfig.h</b>, the source code files, as well as the system and startup files:</p>
 166 <div class="image">
 167 <img src="project_window_freertos_rtos2.png" alt="project_window_freertos_rtos2.png"/>
 168 </div>
 169 </li>
 170 </ul>
 171 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Do we add user code templates for the RTOS2 FreeRTOS implementation?\</dd></dl>
 172 <ul>
 173 <li>You can add template files to the project by right-clicking on <b>Source Group 1</b> and selecting <b>Add New Item to 'Source Group 1'</b>. In the new window, click on <b>User Code Template</b>. On the right-hand side you will see all available template files for CMSIS-RTOS RTX:</li>
 174 </ul>
 175 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>Do we offer an SCVD file for the RTOS2 FreeRTOS implementation?</dd></dl>
 176 <h2><a class="anchor" id="cmsis_freertos_er"></a>
 177 Add Event Recorder Visibility</h2>
 178 <ul>
 179 <li>To use the Event Recorder together with RTX5, select the software component <b>Compiler:Event Recorder</b>.</li>
 180 <li>Select the <b>Source</b> variant of the software component <b>CMSIS:RTOS2 (API):Keil RTX5</b>.</li>
 181 <li>Call the function <b>EventRecorderInitialize()</b> in your application code (ideally in <code>main()</code>).</li>
 182 <li>Build the application code and download it to the debug hardware.</li>
 183 </ul>
 184 <p>Once the target application generates event information, it can be viewed in the ÂµVision debugger using the <b>Event</b> <b>Recorder</b>. </p>
 185 </div></div><!-- contents -->
 186 </div><!-- doc-content -->
 187 <!-- start footer part -->
 188 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 189   <ul>
 190     <li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
 191         <!--
 192     <a href="http://www.doxygen.org/index.html">
 193     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 194         -->
 195         </li>
 196   </ul>
 197 </div>
 198 </body>
 199 </html>