]> begriffs open source - cmsis/blob - CMSIS/Documentation/Core/html/group__sau__trustzone__functions.html
adding documentation for section 'Core'
[cmsis] / CMSIS / Documentation / Core / html / group__sau__trustzone__functions.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>SAU Functions</title>
7 <title>CMSIS-CORE: SAU Functions</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-CORE
35    &#160;<span id="projectnumber">Version 5.0.0 - Beta</span>
36    </div>
37    <div id="projectbrief">CMSIS-CORE support for Cortex-M processor-based devices</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><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('group__sau__trustzone__functions.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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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="summary">
111 <a href="#func-members">Functions</a>  </div>
112   <div class="headertitle">
113 <div class="title">SAU Functions<div class="ingroups"><a class="el" href="group__trustzone__functions.html">TrustZone for ARMv8-M</a></div></div>  </div>
114 </div><!--header-->
115 <div class="contents">
116
117 <p>Secure Attribution Unit (SAU) functions related to TrustZone for ARMv8-M.  
118 <a href="#details">More...</a></p>
119 <table class="memberdecls">
120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
121 Functions</h2></td></tr>
122 <tr class="memitem:ga6093bc5939ea8924fbcfdffb8f0553f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sau__trustzone__functions.html#ga6093bc5939ea8924fbcfdffb8f0553f1">TZ_SAU_Setup</a> (void)</td></tr>
123 <tr class="memdesc:ga6093bc5939ea8924fbcfdffb8f0553f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup Secure Attribute Unit (SAU) and non-secure interrupts.  <a href="#ga6093bc5939ea8924fbcfdffb8f0553f1">More...</a><br/></td></tr>
124 <tr class="separator:ga6093bc5939ea8924fbcfdffb8f0553f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
125 <tr class="memitem:ga187377409289e34838225ce801fb102c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sau__trustzone__functions.html#ga187377409289e34838225ce801fb102c">TZ_SAU_Enable</a> (void)</td></tr>
126 <tr class="memdesc:ga187377409289e34838225ce801fb102c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable Security Attribution Unit (SAU)  <a href="#ga187377409289e34838225ce801fb102c">More...</a><br/></td></tr>
127 <tr class="separator:ga187377409289e34838225ce801fb102c"><td class="memSeparator" colspan="2">&#160;</td></tr>
128 <tr class="memitem:ga42e201cea0a4b09f588a28b751f726fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sau__trustzone__functions.html#ga42e201cea0a4b09f588a28b751f726fb">TZ_SAU_Disable</a> (void)</td></tr>
129 <tr class="memdesc:ga42e201cea0a4b09f588a28b751f726fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable Security Attribution Unit (SAU)  <a href="#ga42e201cea0a4b09f588a28b751f726fb">More...</a><br/></td></tr>
130 <tr class="separator:ga42e201cea0a4b09f588a28b751f726fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 </table>
132 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
133 <p>The Secure Attribution Unit (SAU) functions SAU</p>
134 <dl class="section note"><dt>Note</dt><dd>A SAU is always present if the security extension is available. The functionality differs if the SAU contains SAU regions. If SAU regions are available is configured with the macro __SAUREGION_PRESENT (see <a class="el" href="device_h_pg.html#core_config_sect">Configuration of the Processor and Core Peripherals</a>). </dd></dl>
135 <h2 class="groupheader">Function Documentation</h2>
136 <a class="anchor" id="ga42e201cea0a4b09f588a28b751f726fb"></a>
137 <div class="memitem">
138 <div class="memproto">
139       <table class="memname">
140         <tr>
141           <td class="memname">void TZ_SAU_Disable </td>
142           <td>(</td>
143           <td class="paramtype">void&#160;</td>
144           <td class="paramname"></td><td>)</td>
145           <td></td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149 <p>Disables the Security Attribution Unit (SAU). </p>
150
151 </div>
152 </div>
153 <a class="anchor" id="ga187377409289e34838225ce801fb102c"></a>
154 <div class="memitem">
155 <div class="memproto">
156       <table class="memname">
157         <tr>
158           <td class="memname">void TZ_SAU_Enable </td>
159           <td>(</td>
160           <td class="paramtype">void&#160;</td>
161           <td class="paramname"></td><td>)</td>
162           <td></td>
163         </tr>
164       </table>
165 </div><div class="memdoc">
166 <p>Enables the Security Attribution Unit (SAU). </p>
167
168 </div>
169 </div>
170 <a class="anchor" id="ga6093bc5939ea8924fbcfdffb8f0553f1"></a>
171 <div class="memitem">
172 <div class="memproto">
173       <table class="memname">
174         <tr>
175           <td class="memname">void TZ_SAU_Setup </td>
176           <td>(</td>
177           <td class="paramtype">void&#160;</td>
178           <td class="paramname"></td><td>)</td>
179           <td></td>
180         </tr>
181       </table>
182 </div><div class="memdoc">
183 <p>The function <a class="el" href="group__sau__trustzone__functions.html#ga6093bc5939ea8924fbcfdffb8f0553f1">TZ_SAU_Setup</a> uses the settings in the <a class="el" href="partition_h_pg.html">System Partition Header File partition_&lt;device&gt;.h</a> to initialize the Secure Attribute Unit (SAU) and define non-secure interrupts. It is called from the function <a class="el" href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2">SystemInit</a>. </p>
184
185 </div>
186 </div>
187 </div><!-- contents -->
188 </div><!-- doc-content -->
189 <!-- start footer part -->
190 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
191   <ul>
192     <li class="footer">Generated on Tue Sep 13 2016 16:45:26 for CMSIS-CORE by ARM Ltd. All rights reserved.
193         <!--
194     <a href="http://www.doxygen.org/index.html">
195     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
196         -->
197         </li>
198   </ul>
199 </div>
200 </body>
201 </html>