begriffs open source - cmsis-freertos/blob - Docs/General/html/index.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>Introduction</title>
   7 <title>CMSIS-FreeRTOS: Introduction</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 class="current"><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('index.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">Introduction </div>  </div>
 112 </div><!--header-->
 113 <div class="contents">
 114 <div class="textblock"><p><a href="http://www.freertos.org/" target="_blank">FreeRTOS</a> is one of the market leading real-time operating systems (RTOS) for embedded microcontrollers. It is professionally developed, <a href="http://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html" target="_blank">strictly quality controlled</a>, robust, <a href="http://www.freertos.org/FreeRTOS_Support_Forum_Archive/freertos_support_forum_archive_index.html" target="_blank">supported</a>, free to <a href="http://www.freertos.org/a00114.html" target="_blank">use in commercial products</a> without a requirement to expose proprietary source code, and has <a href="http://www.freertos.org/differences-between-officially-supported-and-contributed-FreeRTOS-code.html" target="_blank">no IP infringement</a> risk.</p>
 115 <p><a href="https://arm-software.github.io/CMSIS_5/RTOS2/html/index.html"><b>CMSIS-RTOS v2</b></a> is a common API for real-time operating systems (RTOS). It provides a standardized programming interface that is portable to many RTOS and enables software components that can work across multiple RTOS systems. It supports the ARMv8-M architecture, dynamic object creation, for multi-core systems, and has a binary compatible interface across ABI compliant compilers.</p>
 116 <p>Using this software pack, users can choose between a native FreeRTOS implementation or one that is adhering to the CMSIS-RTOS2 API and using FreeRTOS under the hood. The CMSIS-RTOS2 API enables programmers to create portable application code to be used with different RTOS kernels (for example <a href="http://www.keil.com/mdk5/cmsis/rtx" class="el">Keil RTX5</a>).</p>
 117 <p><b>Note:</b> FreeRTOS does not support ARM Compiler v6, yet! Please refere to the <a href="http://www.freertos.org/FreeRTOS_Support_Forum_Archive/May_2016/freertos_Anyone_Working_on_a_Port_to_Keil_ARM_Compiler_6.4_ARMCLANG_9deb244ej.html" target="_blank">FreeRTOS Support Archive.</a></p>
 118 <p>This documentation shows you:</p>
 119 <ul>
 120 <li>how to <a class="el" href="cre_freertos_proj.html">create a new microcontroller project</a> using FreeRTOS from scratch.</li>
 121 <li>Various <a class="el" href="examples.html">Example projects</a> show you the usage of FreeRTOS in native and CMSIS-RTOS2 mode.</li>
 122 <li>the <a class="el" href="tech_data.html">Technical data and limitations</a> of this implementation.</li>
 123 </ul>
 124 <h1><a class="anchor" id="License"></a>
 125 License</h1>
 126 <p>The CMSIS-FreeRTOS implementation is provided free of charge by ARM under the <a href="license.txt">FreeRTOS license</a>.</p>
 127 <h1><a class="anchor" id="CMFR_Pack_Content"></a>
 128 ARM::CMSIS-FreeRTOS Pack</h1>
 129 <p>The <b>ARM::CMSIS-FreeRTOS</b> pack contains the following:</p>
 130 <table class="doxtable">
 131 <tr>
 132 <th align="left">File/Directory </th><th align="left">Content  </th></tr>
 133 <tr>
 134 <td align="left"><b>ARM.CMSIS-FreeRTOS.pdsc</b> </td><td align="left">Package description file in CMSIS-Pack format. </td></tr>
 135 <tr>
 136 <td align="left"><b>License</b> </td><td align="left">FreeRTOS license agreement. </td></tr>
 137 <tr>
 138 <td align="left"><b>CMSIS</b> </td><td align="left">CMSIS-RTOS2 compliant implementation of FreeRTOS. </td></tr>
 139 <tr>
 140 <td align="left"><b>Config</b> </td><td align="left">FreeRTOS configuration header file. </td></tr>
 141 <tr>
 142 <td align="left"><b>Demo</b> </td><td align="left">FreeRTOS demo projects. </td></tr>
 143 <tr>
 144 <td align="left"><b>Documentation</b> </td><td align="left">This documentation. </td></tr>
 145 <tr>
 146 <td align="left"><b>DoxyGen</b> </td><td align="left">Source of the documentation. </td></tr>
 147 <tr>
 148 <td align="left"><b>Source</b> </td><td align="left">FreeRTOS source code. </td></tr>
 149 <tr>
 150 <td align="left"><b>Utilities</b> </td><td align="left">Utilities to build the pack. </td></tr>
 151 </table>
 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 Mon Mar 13 2017 09:48:26 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>