]> begriffs open source - cmsis/blob - main/Compiler/html/index.html
Update documentation for branch main
[cmsis] / main / Compiler / html / 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-Compiler: CMSIS-Compiler</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="jquery.js"></script>
15 <script type="text/javascript" src="dynsections.js"></script>
16 <script type="text/javascript" src="printComponentTabs.js"></script>
17 <script type="text/javascript" src="footer.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="resize.js"></script>
21 <script type="text/javascript" src="navtreedata.js"></script>
22 <script type="text/javascript" src="navtree.js"></script>
23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
24 <script type="text/javascript" src="search/searchdata.js"></script>
25 <script type="text/javascript" src="search/search.js"></script>
26 <script type="text/javascript">
27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
28   $(document).ready(function() { init_search(); });
29 /* @license-end */
30 </script>
31 <script type="text/javascript" src="darkmode_toggle.js"></script>
32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
35 <link href="version.css" rel="stylesheet" type="text/css" />
36 <script type="text/javascript" src="../../version.js"></script>
37 </head>
38 <body>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
40 <div id="titlearea">
41 <table cellspacing="0" cellpadding="0">
42  <tbody>
43  <tr style="height: 55px;">
44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
46    <div id="projectname">CMSIS-Compiler
47    </div>
48    <div id="projectbrief">Retarget standard C library file, I/O and OS functions</div>
49   </td>
50    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
51         <span class="left">
52           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
53           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
54                onfocus="searchBox.OnSearchFieldFocus(true)" 
55                onblur="searchBox.OnSearchFieldFocus(false)" 
56                onkeyup="searchBox.OnSearchFieldChange(event)"/>
57           </span><span class="right">
58             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
59           </span>
60         </div>
61 </td>
62   <!--END !PROJECT_NAME-->
63  </tr>
64  </tbody>
65 </table>
66 </div>
67 <!-- end header part -->
68 <div id="CMSISnav" class="tabs1">
69   <ul class="tablist">
70     <script type="text/javascript">
71       writeComponentTabs.call(this);
72     </script>
73   </ul>
74 </div>
75 <script type="text/javascript">
76   writeSubComponentTabs.call(this);
77 </script>
78 <!-- Generated by Doxygen 1.9.6 -->
79 <script type="text/javascript">
80 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
81 var searchBox = new SearchBox("searchBox", "search/",'.html');
82 /* @license-end */
83 </script>
84 </div><!-- top -->
85 <div id="side-nav" class="ui-resizable side-nav-resizable">
86   <div id="nav-tree">
87     <div id="nav-tree-contents">
88       <div id="nav-sync" class="sync"></div>
89     </div>
90   </div>
91   <div id="splitbar" style="-moz-user-select:none;" 
92        class="ui-resizable-handle">
93   </div>
94 </div>
95 <script type="text/javascript">
96 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
97 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
98 /* @license-end */
99 </script>
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103      onmouseover="return searchBox.OnSearchSelectShow()"
104      onmouseout="return searchBox.OnSearchSelectHide()"
105      onkeydown="return searchBox.OnSearchSelectKey(event)">
106 </div>
107
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <div id="MSearchResults">
111 <div class="SRPage">
112 <div id="SRIndex">
113 <div id="SRResults"></div>
114 <div class="SRStatus" id="Loading">Loading...</div>
115 <div class="SRStatus" id="Searching">Searching...</div>
116 <div class="SRStatus" id="NoMatches">No Matches</div>
117 </div>
118 </div>
119 </div>
120 </div>
121
122 <div><div class="header">
123   <div class="headertitle"><div class="title">CMSIS-Compiler </div></div>
124 </div><!--header-->
125 <div class="contents">
126 <div class="textblock"><p><a class="anchor" id="mainpage"></a> <b>CMSIS-Compiler</b> provides software components for retargeting I/O operations in standard C run-time libraries. Following interfaces are supported for retargeting:</p>
127 <ul>
128 <li>File interface for reading and writing files.</li>
129 <li>I/O interface for standard I/O stream retargeting (stderr, stdin, stdout).</li>
130 <li>OS interface for multithread safety using an arbitrary RTOS.</li>
131 </ul>
132 <div class="image">
133 <img src="cmsis_compiler_overview.png" alt=""/>
134 <div class="caption">
135 Overview of CMSIS-Compiler</div></div>
136     <p>Standard C library functions are platform independent, but the implementations of the low-level I/O and multithreading support are tailored to the target compiler toolchains.</p>
137 <h1><a class="anchor" id="autotoc_md0"></a>
138 Access to CMSIS-Compiler</h1>
139 <p>CMSIS-Compiler is maintained in a GitHub repository and is also released as a standalone package in CMSIS Pack format.</p>
140 <ul>
141 <li><a href="https://github.com/Arm-Software/CMSIS-Compiler"><b>CMSIS-Compiler GitHub Repo</b></a> provides the full source code as well as releases in CMSIS-Pack format.</li>
142 <li><a href="https://arm-software.github.io/CMSIS-Compiler/latest/"><b>CMSIS-Compiler Documentation</b></a> explains how to use the library and describes the implemented functions in details.</li>
143 </ul>
144 <h1><a class="anchor" id="autotoc_md1"></a>
145 Key Features and Benefits</h1>
146 <ul>
147 <li>CMSIS-Compiler allows individual retargeting configuration for common I/O interfaces: file, stderr, stdin, stdout.</li>
148 <li>Implements several ready-to-use retarget variants: into File, Breakpoint, Event Recorder, ITM, as well as user-specific variant.</li>
149 <li>Supports common standard C libraries, such as from Arm Compiler and GCC (Newlib) toolchains. IAR support is planned.</li>
150 <li>Provides implementation templates and examples to get started. </li>
151 </ul>
152 </div></div><!-- PageDoc -->
153 </div><!-- contents -->
154 </div><!-- doc-content -->
155 <!-- start footer part -->
156 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
157   <ul>
158     <li class="footer">
159       <script type="text/javascript">
160         <!--
161         writeFooter.call(this);
162         //-->
163       </script> 
164     </li>
165   </ul>
166 </div>
167 </body>
168 </html>