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

   1 <!-- HTML header for doxygen 1.9.2-->
   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">
   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: CMSIS-FreeRTOS</title>
   9 <link href="tabs.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="footer.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="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20 <script type="text/javascript">
  21 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  22   $(document).ready(function() { init_search(); });
  23 /* @license-end */
  24 </script>
  25 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  26 <link href="version.css" rel="stylesheet" type="text/css" />
  27 <script type="text/javascript" src="../version.js"></script>
  28 </head>
  29 <body>
  30 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  31 <div id="titlearea">
  32 <table cellspacing="0" cellpadding="0">
  33  <tbody>
  34  <tr style="height: 55px;">
  35   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  36   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  37    <div id="projectname">CMSIS-FreeRTOS
  38    &#160;<span id="projectnumber"><script type="text/javascript">
  39      <!--
  40      writeHeader.call(this);
  41      writeVersionDropdown(this);
  42      //-->
  43     </script>
  44    </span>
  45    </div>
  46    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  47   </td>
  48   <!--END !PROJECT_NAME-->
  49    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  50         <span class="left">
  51           <img id="MSearchSelect" src="search/mag_sel.svg"
  52                onmouseover="return searchBox.OnSearchSelectShow()"
  53                onmouseout="return searchBox.OnSearchSelectHide()"
  54                alt=""/>
  55           <input type="text" id="MSearchField" value="Search" accesskey="S"
  56                onfocus="searchBox.OnSearchFieldFocus(true)"
  57                onblur="searchBox.OnSearchFieldFocus(false)"
  58                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  59           </span><span class="right">
  60             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  61           </span>
  62         </div>
  63 </td>
  64  </tr>
  65  </tbody>
  66 </table>
  67 </div>
  68 <!-- end header part -->
  69 <!-- Generated by Doxygen 1.9.2 -->
  70 <script type="text/javascript">
  71 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  72 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  73 /* @license-end */
  74 </script>
  75 </div><!-- top -->
  76 <div id="side-nav" class="ui-resizable side-nav-resizable">
  77   <div id="nav-tree">
  78     <div id="nav-tree-contents">
  79       <div id="nav-sync" class="sync"></div>
  80     </div>
  81   </div>
  82   <div id="splitbar" style="-moz-user-select:none;"
  83        class="ui-resizable-handle">
  84   </div>
  85 </div>
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
  89 /* @license-end */
  90 </script>
  91 <div id="doc-content">
  92 <!-- window showing the filter options -->
  93 <div id="MSearchSelectWindow"
  94      onmouseover="return searchBox.OnSearchSelectShow()"
  95      onmouseout="return searchBox.OnSearchSelectHide()"
  96      onkeydown="return searchBox.OnSearchSelectKey(event)">
  97 </div>
  98
  99 <!-- iframe showing the search results (closed by default) -->
 100 <div id="MSearchResultsWindow">
 101 <iframe src="javascript:void(0)" frameborder="0"
 102         name="MSearchResults" id="MSearchResults">
 103 </iframe>
 104 </div>
 105
 106 <div><div class="header">
 107   <div class="headertitle"><div class="title">CMSIS-FreeRTOS </div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110 <div class="textblock"><h1><a class="anchor" id="Introduction"></a>
 111 Introduction</h1>
 112 <p ><a href="https://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="https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html" target="_blank">strictly quality controlled</a>, robust, <a href="https://forums.freertos.org/" target="_blank">supported</a> <a href="https://www.freertos.org/FreeRTOS_Support_Forum_Archive/freertos_support_forum_archive_index.html/" target="_blank">(archive)</a>, free to <a href="https://www.freertos.org/a00114.html" target="_blank">use in commercial products</a> without a requirement to expose proprietary source code, and has <a href="https://www.freertos.org/differences-between-officially-supported-and-contributed-FreeRTOS-code.html" target="_blank">no IP infringement</a> risk.</p>
 113 <p ><a href="https://arm-software.github.io/CMSIS_6/latest/RTOS2/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>
 114 <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="https://developer.arm.com/Tools%20and%20Software/Keil%20MDK/RTX5%20RTOS/" class="el">Keil RTX5</a>).</p>
 115 <p >This documentation shows you:</p><ul>
 116 <li>how to <a class="el" href="cre_freertos_proj.html">create a new microcontroller project</a> using FreeRTOS from scratch.</li>
 117 <li>Various <a class="el" href="examples.html">Example projects</a> show you the usage of FreeRTOS in native and CMSIS-RTOS2 mode.</li>
 118 <li>the <a class="el" href="tech_data.html">Technical data and limitations</a> of this implementation.</li>
 119 <li><a class="el" href="rev_hist.html">Revision History</a></li>
 120 </ul>
 121 <h2><a class="anchor" id="autotoc_md0"></a>
 122 License</h2>
 123 <p >The CMSIS-FreeRTOS implementation is provided free of charge by Arm under the <a href="LICENSE">Apache 2.0 license</a>.<br  />
 124  The FreeRTOS kernel source files are released under the <a href="LICENSE.md">MIT open source license</a>.</p>
 125 <h2><a class="anchor" id="autotoc_md1"></a>
 126 ARM::CMSIS-FreeRTOS Pack</h2>
 127 <p >The <b>ARM::CMSIS-FreeRTOS</b> pack contains the following:</p>
 128 <table class="markdownTable">
 129 <tr class="markdownTableHead">
 130 <th class="markdownTableHeadLeft">File/Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
 131 <tr class="markdownTableRowOdd">
 132 <td class="markdownTableBodyLeft"><b>CMSIS/Documentation</b>   </td><td class="markdownTableBodyLeft">This documentation.    </td></tr>
 133 <tr class="markdownTableRowEven">
 134 <td class="markdownTableBodyLeft"><b>CMSIS/RTOS2</b>   </td><td class="markdownTableBodyLeft">CMSIS-RTOS2 compliant implementation of FreeRTOS.    </td></tr>
 135 <tr class="markdownTableRowOdd">
 136 <td class="markdownTableBodyLeft"><b>License</b>   </td><td class="markdownTableBodyLeft">FreeRTOS license agreement.    </td></tr>
 137 <tr class="markdownTableRowEven">
 138 <td class="markdownTableBodyLeft"><b>Source</b>   </td><td class="markdownTableBodyLeft">FreeRTOS kernel source code.    </td></tr>
 139 <tr class="markdownTableRowOdd">
 140 <td class="markdownTableBodyLeft"><b>ARM.CMSIS-FreeRTOS.pdsc</b>   </td><td class="markdownTableBodyLeft">Package description file in CMSIS-Pack format.   </td></tr>
 141 </table>
 142 </div></div><!-- PageDoc -->
 143 </div><!-- contents -->
 144 </div><!-- doc-content -->
 145 <!-- start footer part -->
 146 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 147   <ul>
 148     <li class="footer">
 149       <script type="text/javascript">
 150         <!--
 151         writeFooter.call(this);
 152         //-->
 153       </script>
 154     </li>
 155   </ul>
 156 </div>
 157 </body>
 158 </html>