begriffs open source - cmsis-freertos/blob - v11.2.0/index.html

   1 <!-- HTML header for doxygen 1.9.6-->
   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" lang="en-US">
   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: Introduction</title>
   9 <link href="doxygen.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="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="navtreedata.js"></script>
  17 <script type="text/javascript" src="navtree.js"></script>
  18 <script type="text/javascript" src="resize.js"></script>
  19 <script type="text/javascript" src="cookie.js"></script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/searchdata.js"></script>
  22 <script type="text/javascript" src="search/search.js"></script>
  23 <script type="text/javascript">
  24 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  25   $(function() { init_search(); });
  26 /* @license-end */
  27 </script>
  28 <script type="text/javascript" src="darkmode_toggle.js"></script>
  29 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  32 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  33 <link href="version.css" rel="stylesheet" type="text/css"/>
  34 <script type="text/javascript" src="../version.js"></script>
  35 </head>
  36 <body>
  37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  38 <div id="titlearea">
  39 <table cellspacing="0" cellpadding="0">
  40  <tbody>
  41  <tr style="height: 55px;">
  42   <td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="cmsis_logo_white_small.png"/</a></td>
  43   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  44    <div id="projectname">CMSIS-FreeRTOS
  45    &#160;<span id="projectnumber"><script type="text/javascript">
  46      <!--
  47      writeHeader.call(this);
  48      writeVersionDropdown.call(this, "CMSIS-FreeRTOS");
  49      //-->
  50     </script>
  51    </span>
  52    </div>
  53    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  54   </td>
  55    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  56         <span class="left">
  57           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  58           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  59                onfocus="searchBox.OnSearchFieldFocus(true)"
  60                onblur="searchBox.OnSearchFieldFocus(false)"
  61                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  62           </span><span class="right">
  63             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  64           </span>
  65         </div>
  66 </td>
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <!-- Generated by Doxygen 1.13.2 -->
  80 <script type="text/javascript">
  81 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82 var searchBox = new SearchBox("searchBox", "search/",'.html');
  83 /* @license-end */
  84 </script>
  85 <script type="text/javascript">
  86 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  87 $(function() { codefold.init(0); });
  88 /* @license-end */
  89 </script>
  90 </div><!-- top -->
  91 <div id="side-nav" class="ui-resizable side-nav-resizable">
  92   <div id="nav-tree">
  93     <div id="nav-tree-contents">
  94       <div id="nav-sync" class="sync"></div>
  95     </div>
  96   </div>
  97   <div id="splitbar" style="-moz-user-select:none;"
  98        class="ui-resizable-handle">
  99   </div>
 100 </div>
 101 <script type="text/javascript">
 102 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 103 $(function(){initNavTree('index.html',''); initResizable(true); });
 104 /* @license-end */
 105 </script>
 106 <div id="doc-content">
 107 <!-- window showing the filter options -->
 108 <div id="MSearchSelectWindow"
 109      onmouseover="return searchBox.OnSearchSelectShow()"
 110      onmouseout="return searchBox.OnSearchSelectHide()"
 111      onkeydown="return searchBox.OnSearchSelectKey(event)">
 112 </div>
 113
 114 <!-- iframe showing the search results (closed by default) -->
 115 <div id="MSearchResultsWindow">
 116 <div id="MSearchResults">
 117 <div class="SRPage">
 118 <div id="SRIndex">
 119 <div id="SRResults"></div>
 120 <div class="SRStatus" id="Loading">Loading...</div>
 121 <div class="SRStatus" id="Searching">Searching...</div>
 122 <div class="SRStatus" id="NoMatches">No Matches</div>
 123 </div>
 124 </div>
 125 </div>
 126 </div>
 127
 128 <div><div class="header">
 129   <div class="headertitle"><div class="title">Introduction </div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132 <div class="textblock"><p><a class="anchor" id="mainpage"></a></p>
 133 <p><a href="https://www.freertos.org/">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">strictly quality controlled</a>, robust, <a href="https://forums.freertos.org/">supported</a> <a href="https://www.freertos.org/FreeRTOS_Support_Forum_Archive/freertos_support_forum_archive_index.html/">(archive)</a>, free to <a href="https://www.freertos.org/a00114.html">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">no IP infringement</a> risk.</p>
 134 <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, multi-core systems, and has a binary-compatible interface across ABI-compliant compilers.</p>
 135 <p>Using this software pack, users can choose between a native FreeRTOS implementation or one that adheres to the CMSIS-RTOS2 API and uses 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/">Keil RTX5</a>).</p>
 136 <p>This documentation shows you:</p>
 137 <ul>
 138 <li>how to <a class="el" href="page_create_project.html">create a new microcontroller project</a> using FreeRTOS from scratch.</li>
 139 <li>various <a class="el" href="page_example_projects.html">examples</a> show you the usage of FreeRTOS in native and CMSIS-RTOS2 mode.</li>
 140 <li>the <a class="el" href="page_technical_data.html">technical data</a> of this implementation.</li>
 141 <li><a class="el" href="rev_hist.html">Revision history</a>.</li>
 142 </ul>
 143 <h1><a class="anchor" id="autotoc_md0"></a>
 144 License</h1>
 145 <p>The CMSIS-FreeRTOS implementation is provided free of charge by Arm under the <b>Apache 2.0 License</b>. <br  />
 146  See the <a href="https://raw.githubusercontent.com/ARM-software/CMSIS-FreeRTOS/refs/heads/main/LICENSE">Apache 2.0 License</a>.</p>
 147 <p>The FreeRTOS kernel source files are released under the <b>MIT License</b>. <br  />
 148  See the <a href="https://github.com/ARM-software/CMSIS-FreeRTOS/blob/main/Source/LICENSE.md">MIT License</a>.</p>
 149 <h1><a class="anchor" id="autotoc_md1"></a>
 150 CMSIS-FreeRTOS Pack</h1>
 151 <p>The <b>ARM::CMSIS-FreeRTOS</b> pack contains the following:</p>
 152 <table class="markdownTable">
 153 <tr class="markdownTableHead">
 154 <th class="markdownTableHeadLeft">File/Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
 155 <tr class="markdownTableRowOdd">
 156 <td class="markdownTableBodyLeft">📂 CMSIS/RTOS2   </td><td class="markdownTableBodyLeft">CMSIS-RTOS2 compliant implementation of FreeRTOS.    </td></tr>
 157 <tr class="markdownTableRowEven">
 158 <td class="markdownTableBodyLeft">📂 Documentation   </td><td class="markdownTableBodyLeft">This documentation.    </td></tr>
 159 <tr class="markdownTableRowOdd">
 160 <td class="markdownTableBodyLeft">📂 Source   </td><td class="markdownTableBodyLeft">FreeRTOS kernel source code.    </td></tr>
 161 <tr class="markdownTableRowEven">
 162 <td class="markdownTableBodyLeft">📄 ARM.CMSIS-FreeRTOS.pdsc   </td><td class="markdownTableBodyLeft">Pack description file in CMSIS-Pack format.    </td></tr>
 163 <tr class="markdownTableRowOdd">
 164 <td class="markdownTableBodyLeft">📄 LICENSE   </td><td class="markdownTableBodyLeft">License Agreement (Apache 2.0 + MIT).   </td></tr>
 165 </table>
 166 </div></div><!-- PageDoc -->
 167 <a href="doxygen_crawl.html"></a>
 168 </div><!-- contents -->
 169 </div><!-- doc-content -->
 170 <!-- start footer part -->
 171 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 172   <ul>
 173     <li class="footer">
 174       <script type="text/javascript">
 175         <!--
 176         writeFooter.call(this);
 177         //-->
 178       </script>
 179     </li>
 180   </ul>
 181 </div>
 182 </body>
 183 </html>