]> begriffs open source - cmsis/blob - v6.0.0/Core_A/group__CMSIS__Core__FunctionInterface.html
Update documentation for release v6.0.0
[cmsis] / v6.0.0 / Core_A / group__CMSIS__Core__FunctionInterface.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-Core (Cortex-A): Core Peripherals</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="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
24   $(document).ready(function() { init_search(); });
25 /* @license-end */
26 </script>
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 55px;">
41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43    <div id="projectname">CMSIS-Core (Cortex-A)
44    &#160;<span id="projectnumber"><script type="text/javascript">
45      <!--
46      writeHeader.call(this);
47      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
48      //-->
49     </script>
50    </span>
51    </div>
52    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
53   </td>
54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
55         <span class="left">
56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
58                onfocus="searchBox.OnSearchFieldFocus(true)" 
59                onblur="searchBox.OnSearchFieldFocus(false)" 
60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
61           </span><span class="right">
62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
63           </span>
64         </div>
65 </td>
66   <!--END !PROJECT_NAME-->
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 <script type="text/javascript">
80   writeSubComponentTabs.call(this);
81 </script>
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
86 /* @license-end */
87 </script>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__CMSIS__Core__FunctionInterface.html',''); initResizable(); });
102 /* @license-end */
103 </script>
104 <div id="doc-content">
105 <!-- window showing the filter options -->
106 <div id="MSearchSelectWindow"
107      onmouseover="return searchBox.OnSearchSelectShow()"
108      onmouseout="return searchBox.OnSearchSelectHide()"
109      onkeydown="return searchBox.OnSearchSelectKey(event)">
110 </div>
111
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
115 <div class="SRPage">
116 <div id="SRIndex">
117 <div id="SRResults"></div>
118 <div class="SRStatus" id="Loading">Loading...</div>
119 <div class="SRStatus" id="Searching">Searching...</div>
120 <div class="SRStatus" id="NoMatches">No Matches</div>
121 </div>
122 </div>
123 </div>
124 </div>
125
126 <div class="header">
127   <div class="summary">
128 <a href="#groups">Content</a>  </div>
129   <div class="headertitle"><div class="title">Core Peripherals</div></div>
130 </div><!--header-->
131 <div class="contents">
132 <table class="memberdecls">
133 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
134 Content</h2></td></tr>
135 <tr class="memitem:group__GIC__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__GIC__functions.html">Generic Interrupt Controller Functions</a></td></tr>
136 <tr class="memdesc:group__GIC__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Generic Interrupt Controller Functions grant access to the configuration, control and status registers of the Generic Interrupt Controller (GIC). <br /></td></tr>
137 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:group__L1__cache__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__L1__cache__functions.html">L1 Cache Functions</a></td></tr>
139 <tr class="memdesc:group__L1__cache__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">L1 Cache Functions give support to enable, clean and invalidate level 1 instruction and data caches, as well as to enable branch target address cache. <br /></td></tr>
140 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:group__L2__cache__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__L2__cache__functions.html">L2C-310 Cache Controller Functions</a></td></tr>
142 <tr class="memdesc:group__L2__cache__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">L2C-310 Cache Controller gives access to functions for level 2 cache maintenance.<br  />
143 Reference: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0246h/index.html">Level 2 Cache Controller L2C-310 Technical Reference Manual</a>. <br /></td></tr>
144 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:group__PL1__timer__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html">Generic Physical Timer Functions</a></td></tr>
146 <tr class="memdesc:group__PL1__timer__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic Physical Timer Functions allow to control privilege level 1 physical timer registers on Generic Timer for Cortex-A7 class devices.<br  />
147 Reference: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0464f/index.html">Cortex-A7 MPCore Technical Reference Manual</a>. <br /></td></tr>
148 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:group__PTM__timer__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html">Private Timer Functions</a></td></tr>
150 <tr class="memdesc:group__PTM__timer__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Private Timer Functions controls private timer registers present on Cortex-A5 and A9 class devices.<br  />
151 References: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0434c/index.html">Cortex-A5 MPCore Technical Reference Manual</a>, <a href="http://infocenter.arm.com/help/topic/com.arm.doc.100486_0401_10_en/index.html">Cortex-A9 MPCore Technical Reference Manual</a>. <br /></td></tr>
152 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:group__MMU__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMU__functions.html">Memory Management Unit Functions</a></td></tr>
154 <tr class="memdesc:group__MMU__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">MMU Functions provide control of the Memory Management Unit using translation tables and attributes of different regions of the physical memory map.<br  />
155 Reference: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0406c/index.html">Architecture Reference Manual Reference Manual - Armv7-A and Armv7-R edition</a>. <br /></td></tr>
156 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memitem:group__FPU__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FPU__functions.html">Floating Point Unit Functions</a></td></tr>
158 <tr class="memdesc:group__FPU__functions"><td class="mdescLeft">&#160;</td><td class="mdescRight">FPU Functions enable the use of Floating Point instructions and extensions.<br  />
159 Reference: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0406c/index.html">Architecture Reference Manual Reference Manual - Armv7-A and Armv7-R edition</a>. <br /></td></tr>
160 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 </table>
162 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
163 <p>Hardware Abstraction Layer. The Core-A function interface contains:</p><ul>
164 <li><a class="el" href="group__FPU__functions.html">Floating Point Unit Functions</a></li>
165 <li><a class="el" href="group__GIC__functions.html">Generic Interrupt Controller Functions</a></li>
166 <li><a class="el" href="group__L1__cache__functions.html">L1 Cache Functions</a></li>
167 <li><a class="el" href="group__L2__cache__functions.html">L2C-310 Cache Controller Functions</a></li>
168 <li><a class="el" href="group__MMU__functions.html">Memory Management Unit Functions</a></li>
169 <li><a class="el" href="group__PL1__timer__functions.html">Generic Physical Timer Functions</a></li>
170 <li><a class="el" href="group__PTM__timer__functions.html">Private Timer Functions</a> </li>
171 </ul>
172 </div><!-- contents -->
173 </div><!-- doc-content -->
174 <!-- start footer part -->
175 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
176   <ul>
177     <li class="footer">
178       <script type="text/javascript">
179         <!--
180         writeFooter.call(this);
181         //-->
182       </script> 
183     </li>
184   </ul>
185 </div>
186 </body>
187 </html>