begriffs open source - cmsis/blob - main/Core/group__sau__trustzone__functions.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-M): SAU Functions</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-Core (Cortex-M)
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-M)");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">CMSIS-Core support for Cortex-M processor-based devices</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__sau__trustzone__functions.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#func-members">Functions</a>  </div>
 132   <div class="headertitle"><div class="title">SAU Functions<div class="ingroups"><a class="el" href="group__trustzone__functions.html">TrustZone for Armv8-M/v8.1-M</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Secure Attribution Unit (SAU) functions related to TrustZone for Armv8-M.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 140 Functions</h2></td></tr>
 141 <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>
 142 <tr class="memdesc:ga6093bc5939ea8924fbcfdffb8f0553f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup Secure Attribute Unit (SAU) and non-secure interrupts.  <br /></td></tr>
 143 <tr class="separator:ga6093bc5939ea8924fbcfdffb8f0553f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:ga187377409289e34838225ce801fb102c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable Security Attribution Unit (SAU)  <br /></td></tr>
 146 <tr class="separator:ga187377409289e34838225ce801fb102c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <tr class="memdesc:ga42e201cea0a4b09f588a28b751f726fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable Security Attribution Unit (SAU)  <br /></td></tr>
 149 <tr class="separator:ga42e201cea0a4b09f588a28b751f726fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 152 <p>Secure Attribution Unit (SAU) functions related to TrustZone for Armv8-M. </p>
 153 <p>The Secure Attribution Unit (SAU) functions SAU</p>
 154 <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>
 155 <h2 class="groupheader">Function Documentation</h2>
 156 <a id="ga42e201cea0a4b09f588a28b751f726fb" name="ga42e201cea0a4b09f588a28b751f726fb"></a>
 157 <h2 class="memtitle"><span class="permalink"><a href="#ga42e201cea0a4b09f588a28b751f726fb">&#9670;&#160;</a></span>TZ_SAU_Disable()</h2>
 158
 159 <div class="memitem">
 160 <div class="memproto">
 161       <table class="memname">
 162         <tr>
 163           <td class="memname">void TZ_SAU_Disable </td>
 164           <td>(</td>
 165           <td class="paramtype">void&#160;</td>
 166           <td class="paramname"></td><td>)</td>
 167           <td></td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171
 172 <p>Disable Security Attribution Unit (SAU) </p>
 173 <p>Disables the Security Attribution Unit (SAU). </p>
 174
 175 </div>
 176 </div>
 177 <a id="ga187377409289e34838225ce801fb102c" name="ga187377409289e34838225ce801fb102c"></a>
 178 <h2 class="memtitle"><span class="permalink"><a href="#ga187377409289e34838225ce801fb102c">&#9670;&#160;</a></span>TZ_SAU_Enable()</h2>
 179
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">void TZ_SAU_Enable </td>
 185           <td>(</td>
 186           <td class="paramtype">void&#160;</td>
 187           <td class="paramname"></td><td>)</td>
 188           <td></td>
 189         </tr>
 190       </table>
 191 </div><div class="memdoc">
 192
 193 <p>Enable Security Attribution Unit (SAU) </p>
 194 <p>Enables the Security Attribution Unit (SAU). </p>
 195
 196 </div>
 197 </div>
 198 <a id="ga6093bc5939ea8924fbcfdffb8f0553f1" name="ga6093bc5939ea8924fbcfdffb8f0553f1"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#ga6093bc5939ea8924fbcfdffb8f0553f1">&#9670;&#160;</a></span>TZ_SAU_Setup()</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">void TZ_SAU_Setup </td>
 206           <td>(</td>
 207           <td class="paramtype">void&#160;</td>
 208           <td class="paramname"></td><td>)</td>
 209           <td></td>
 210         </tr>
 211       </table>
 212 </div><div class="memdoc">
 213
 214 <p>Setup Secure Attribute Unit (SAU) and non-secure interrupts. </p>
 215 <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">TrustZone setup: 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>
 216
 217 </div>
 218 </div>
 219 </div><!-- contents -->
 220 </div><!-- doc-content -->
 221 <!-- start footer part -->
 222 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 223   <ul>
 224     <li class="footer">
 225       <script type="text/javascript">
 226         <!--
 227         writeFooter.call(this);
 228         //-->
 229       </script>
 230     </li>
 231   </ul>
 232 </div>
 233 </body>
 234 </html>