begriffs open source - cmsis-freertos/blob - docs/General/html/examples.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>Example projects</title>
   7 <title>CMSIS-FreeRTOS: Example projects</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.1</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('examples.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">Example projects </div>  </div>
 112 </div><!--header-->
 113 <div class="contents">
 114 <div class="textblock"><p>This pack contains two example projects:</p>
 115 <ul>
 116 <li><a class="el" href="examples.html#examples_native">Blinky example using FreeRTOS natively</a></li>
 117 <li><a class="el" href="examples.html#examples_cmsis">Blinky example using CMSIS-FreeRTOS</a></li>
 118 </ul>
 119 <p>The first example shows how to use FreeRTOS standalone, whereas the second example shows how to use the CMSIS-RTOS2 API with an underlying FreeRTOS.</p>
 120 <p>The examples simulate a step-motor driver. Four phase variables are simulating the activation of the four output driver stages. The state changes are shown in the Watch window variable <code>g_phases</code>. All four phases are displayed in the Logic Analyzer:</p>
 121 <div class="image">
 122 <img src="blinky_example_simu.png" alt="blinky_example_simu.png"/>
 123 </div>
 124 <h1><a class="anchor" id="examples_native"></a>
 125 Blinky example using FreeRTOS natively</h1>
 126 <p>This example shows how to use FreeRTOS natively in a ÂµVision project. This makes your code portable and you can choose to use a different RTOS kernel anytime during development (even only for evaluation purposes).</p>
 127 <p>To open the example, go to Pack Installer, select <b>ARM</b> in the <b>Devices</b> tab, and click on <b>Copy</b> next to the <b>Native FreeRTOS Blinky (uVision Simulator)</b> project on the <b>Examples</b> tab. Select the location on your hard drive where you want to copy the project to and press OK. ÂµVision opens.</p>
 128 <h1><a class="anchor" id="examples_cmsis"></a>
 129 Blinky example using CMSIS-FreeRTOS</h1>
 130 <p>This example shows how to use the CMSIS-RTOS2 API with an underlying FreeRTOS. This makes your code portable and you can choose to use a different RTOS kernel anytime during development (even only for evaluation purposes).</p>
 131 <p>To open the example, go to Pack Installer, select <b>ARM</b> in the <b>Devices</b> tab, and click on <b>Copy</b> next to the <b>CMSIS-RTOS2 FreeRTOS Blinky (uVision Simulator)</b> project on the <b>Examples</b> tab. Select the location on your hard drive where you want to copy the project to and press OK. ÂµVision opens.</p>
 132 <h1><a class="anchor" id="examples_cmsis_a9"></a>
 133 Blinky example using CMSIS-FreeRTOS running on Arm Cortex-A9</h1>
 134 <p>This example shows how to use the CMSIS-RTOS2 API with an underlying FreeRTOS running on an NXP i.MX6 equipped with an Arm Cortex-A9 code. This example only works in <a href="http://www.keil.com/mdk5/ds-mdk">DS-MDK</a>, the Eclipse-based development environment from Arm. For information on setting up the target connection, please refer to <a href="http://www2.keil.com/mdk5/ds-mdk/imx6sxsabrereference">NXP i.MX 6SoloX SABRE Reference</a>.</p>
 135 <dl class="section note"><dt>Note</dt><dd>you need to have the i.MX6 device family pack installed to see the example in the <b>Examples</b> tab of Pack Installer.</dd></dl>
 136 <p>To open the example, open the Pack Installer perspective, select <b>NXP</b> in the <b>Devices</b> tab, and click on <b>Copy</b> next to the <b>CMSIS-RTOS2 FreeRTOS Blinky CA9 (MCIMX6SX-SABRE)</b> project on the <b>Examples</b> tab.</p>
 137 <div class="image">
 138 <img src="copy_a9_example.png" alt="copy_a9_example.png"/>
 139 </div>
 140 <p>Confirm the default location in the Eclipse Workspace by pressing Copy.</p>
 141 <div class="image">
 142 <img src="copy_a9_example_ws.png" alt="copy_a9_example_ws.png"/>
 143 </div>
 144 <p>Right-click on the project and select <b>Build</b> <b>Project</b>. Then, right-click on the project and select <b>Debug</b> <b>As</b> and then <b>Debug</b> <b>Configurations</b>. The Debug Configurations dialog opens:</p>
 145 <div class="image">
 146 <img src="dbg_conf.png" alt="dbg_conf.png"/>
 147 </div>
 148 <p>The project is already set up for running from the SDRAM of the i.MX6 SABRE board. Press <b>Debug</b>. DS-MDK will switch to the debug perspective. After a successful connection to the target, press <b>F8</b> to run the application. In the <b>App</b> <b>Console</b> you will see the output of the phases:</p>
 149 <div class="image">
 150 <img src="dbg_output.png" alt="dbg_output.png"/>
 151 </div>
 152  </div></div><!-- contents -->
 153 </div><!-- doc-content -->
 154 <!-- start footer part -->
 155 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 156   <ul>
 157     <li class="footer">Generated on Thu Apr 30 2020 11:16:53 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
 158         <!--
 159     <a href="http://www.doxygen.org/index.html">
 160     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 161         -->
 162         </li>
 163   </ul>
 164 </div>
 165 </body>
 166 </html>