]> begriffs open source - cmsis/blob - main/Driver/Driver__Storage_8h.html
Update documentation for branch main
[cmsis] / main / Driver / Driver__Storage_8h.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-Driver: Driver_Storage.h File Reference</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-Driver
44    &#160;<span id="projectnumber"><script type="text/javascript">
45      <!--
46      writeHeader.call(this);
47      writeVersionDropdown.call(this, "CMSIS-Driver");
48      //-->
49     </script>
50    </span>
51    </div>
52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</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('Driver__Storage_8h.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="#nested-classes">Data Structures</a> &#124;
129 <a href="#define-members">Macros</a> &#124;
130 <a href="#typedef-members">Typedefs</a> &#124;
131 <a href="#enum-members">Enumerations</a>  </div>
132   <div class="headertitle"><div class="title">Driver_Storage.h File Reference</div></div>
133 </div><!--header-->
134 <div class="contents">
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
137 Data Structures</h2></td></tr>
138 <tr class="memitem:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES">ARM_STORAGE_BLOCK_ATTRIBUTES</a></td></tr>
139 <tr class="memdesc:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attributes of the storage range within a storage block.  <a href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES">More...</a><br /></td></tr>
140 <tr class="separator:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:structARM__STORAGE__BLOCK"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a></td></tr>
142 <tr class="memdesc:structARM__STORAGE__BLOCK"><td class="mdescLeft">&#160;</td><td class="mdescRight">A storage block is a range of memory with uniform attributes.  <a href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">More...</a><br /></td></tr>
143 <tr class="separator:structARM__STORAGE__BLOCK"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:structARM__STORAGE__SECURITY__FEATURES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#structARM__STORAGE__SECURITY__FEATURES">ARM_STORAGE_SECURITY_FEATURES</a></td></tr>
145 <tr class="separator:structARM__STORAGE__SECURITY__FEATURES"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:structARM__STORAGE__INFO"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a></td></tr>
147 <tr class="separator:structARM__STORAGE__INFO"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:structARM__STORAGE__STATUS"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a></td></tr>
149 <tr class="memdesc:structARM__STORAGE__STATUS"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operating status of the storage controller.  <a href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">More...</a><br /></td></tr>
150 <tr class="separator:structARM__STORAGE__STATUS"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:structARM__STORAGE__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a></td></tr>
152 <tr class="memdesc:structARM__STORAGE__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">Storage Driver API Capabilities.  <a href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">More...</a><br /></td></tr>
153 <tr class="separator:structARM__STORAGE__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:structARM__DRIVER__STORAGE"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a></td></tr>
155 <tr class="separator:structARM__DRIVER__STORAGE"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 </table><table class="memberdecls">
157 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
158 Macros</h2></td></tr>
159 <tr class="memitem:a2ec531cd9d7d4916f2479efd4ff65b96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a2ec531cd9d7d4916f2479efd4ff65b96">ARM_STORAGE_API_VERSION</a>&#160;&#160;&#160;<a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(1,2)  /* API version */</td></tr>
160 <tr class="separator:a2ec531cd9d7d4916f2479efd4ff65b96"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:a21777a6487158bdc1f113996e65ff0bd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a21777a6487158bdc1f113996e65ff0bd">_ARM_Driver_Storage_</a>(n)&#160;&#160;&#160;Driver_Storage##n</td></tr>
162 <tr class="separator:a21777a6487158bdc1f113996e65ff0bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:af4ce245f055ef69edd1306ef8fde37cf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a>(n)&#160;&#160;&#160;<a class="el" href="Driver__Storage_8h.html#a21777a6487158bdc1f113996e65ff0bd">_ARM_Driver_Storage_</a>(n)</td></tr>
164 <tr class="separator:af4ce245f055ef69edd1306ef8fde37cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:ab8112c1c73ba434c93d19fa1a445c6bf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#ab8112c1c73ba434c93d19fa1a445c6bf">ARM_STORAGE_INVALID_OFFSET</a>&#160;&#160;&#160;(0xFFFFFFFFFFFFFFFFULL)</td></tr>
166 <tr class="memdesc:ab8112c1c73ba434c93d19fa1a445c6bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid address (relative to a storage controller's address space). A storage block may never start at this address.  <br /></td></tr>
167 <tr class="separator:ab8112c1c73ba434c93d19fa1a445c6bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:a5499f02c78acaccb22d6ecc6be195058"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a5499f02c78acaccb22d6ecc6be195058">ARM_STORAGE_INVALID_ADDRESS</a>&#160;&#160;&#160;(0xFFFFFFFFUL)</td></tr>
169 <tr class="memdesc:a5499f02c78acaccb22d6ecc6be195058"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid address within the processor's memory address space. Refer to memory-mapped storage, i.e. <a class="el" href="group__storage__interface__gr.html#a974a1edf42132d42beccc9819417307b">ARM_DRIVER_STORAGE::ResolveAddress()</a>.  <br /></td></tr>
170 <tr class="separator:a5499f02c78acaccb22d6ecc6be195058"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:a7d81999c123625db0e66b8a2c2b0e1b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a7d81999c123625db0e66b8a2c2b0e1b9">ARM_STORAGE_ERROR_NOT_ERASABLE</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
172 <tr class="memdesc:a7d81999c123625db0e66b8a2c2b0e1b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Part (or all) of the range provided to Erase() isn't erasable.  <br /></td></tr>
173 <tr class="separator:a7d81999c123625db0e66b8a2c2b0e1b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:a5a97bf8a1813abdf6fef26f0d777a252"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a5a97bf8a1813abdf6fef26f0d777a252">ARM_STORAGE_ERROR_NOT_PROGRAMMABLE</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td></tr>
175 <tr class="memdesc:a5a97bf8a1813abdf6fef26f0d777a252"><td class="mdescLeft">&#160;</td><td class="mdescRight">Part (or all) of the range provided to ProgramData() isn't programmable.  <br /></td></tr>
176 <tr class="separator:a5a97bf8a1813abdf6fef26f0d777a252"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memitem:a71f6e5ed403c06a5c99c4882bacdf76e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a71f6e5ed403c06a5c99c4882bacdf76e">ARM_STORAGE_ERROR_PROTECTED</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td></tr>
178 <tr class="memdesc:a71f6e5ed403c06a5c99c4882bacdf76e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Part (or all) of the range to Erase() or ProgramData() is protected.  <br /></td></tr>
179 <tr class="separator:a71f6e5ed403c06a5c99c4882bacdf76e"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <tr class="memitem:a955b1ca2ea24cfd3a8923731b581cfd4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(BLK)&#160;&#160;&#160;(((BLK)-&gt;addr != <a class="el" href="Driver__Storage_8h.html#ab8112c1c73ba434c93d19fa1a445c6bf">ARM_STORAGE_INVALID_OFFSET</a>) &amp;&amp; ((BLK)-&gt;size != 0))</td></tr>
181 <tr class="separator:a955b1ca2ea24cfd3a8923731b581cfd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <tr class="memitem:a66cd2a20f084db2d28f6a98cbc503d8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a66cd2a20f084db2d28f6a98cbc503d8a">ARM_STORAGE_PROGRAMMABILITY_RAM</a>&#160;&#160;&#160;(0U)</td></tr>
183 <tr class="memdesc:a66cd2a20f084db2d28f6a98cbc503d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Values for encoding storage memory-types with respect to programmability.  <br /></td></tr>
184 <tr class="separator:a66cd2a20f084db2d28f6a98cbc503d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
185 <tr class="memitem:af232495db19beb7025aebc6e3f9e7553"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#af232495db19beb7025aebc6e3f9e7553">ARM_STORAGE_PROGRAMMABILITY_ROM</a>&#160;&#160;&#160;(1U)</td></tr>
186 <tr class="memdesc:af232495db19beb7025aebc6e3f9e7553"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read-only memory.  <br /></td></tr>
187 <tr class="separator:af232495db19beb7025aebc6e3f9e7553"><td class="memSeparator" colspan="2">&#160;</td></tr>
188 <tr class="memitem:a373cda87e59c51b2a04f46f4d31d5dd8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a373cda87e59c51b2a04f46f4d31d5dd8">ARM_STORAGE_PROGRAMMABILITY_WORM</a>&#160;&#160;&#160;(2U)</td></tr>
189 <tr class="memdesc:a373cda87e59c51b2a04f46f4d31d5dd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">write-once-read-only-memory (WORM).  <br /></td></tr>
190 <tr class="separator:a373cda87e59c51b2a04f46f4d31d5dd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
191 <tr class="memitem:a08670c9b9270eba2e030d90c4af9317c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a08670c9b9270eba2e030d90c4af9317c">ARM_STORAGE_PROGRAMMABILITY_ERASABLE</a>&#160;&#160;&#160;(3U)</td></tr>
192 <tr class="memdesc:a08670c9b9270eba2e030d90c4af9317c"><td class="mdescLeft">&#160;</td><td class="mdescRight">re-programmable based on erase. Supports multiple writes.  <br /></td></tr>
193 <tr class="separator:a08670c9b9270eba2e030d90c4af9317c"><td class="memSeparator" colspan="2">&#160;</td></tr>
194 <tr class="memitem:afb918a33a4b8655321c45dfb99b86339"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#afb918a33a4b8655321c45dfb99b86339">ARM_RETENTION_WHILE_DEVICE_ACTIVE</a>&#160;&#160;&#160;(0U)</td></tr>
195 <tr class="memdesc:afb918a33a4b8655321c45dfb99b86339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data is retained only during device activity.  <br /></td></tr>
196 <tr class="separator:afb918a33a4b8655321c45dfb99b86339"><td class="memSeparator" colspan="2">&#160;</td></tr>
197 <tr class="memitem:a42cdcdcda35d29552ed4558542770dbe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a42cdcdcda35d29552ed4558542770dbe">ARM_RETENTION_ACROSS_SLEEP</a>&#160;&#160;&#160;(1U)</td></tr>
198 <tr class="memdesc:a42cdcdcda35d29552ed4558542770dbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data is retained across processor sleep.  <br /></td></tr>
199 <tr class="separator:a42cdcdcda35d29552ed4558542770dbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
200 <tr class="memitem:acd3c172f37d0c13ac5d5c1477837c638"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#acd3c172f37d0c13ac5d5c1477837c638">ARM_RETENTION_ACROSS_DEEP_SLEEP</a>&#160;&#160;&#160;(2U)</td></tr>
201 <tr class="memdesc:acd3c172f37d0c13ac5d5c1477837c638"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data is retained across processor deep-sleep.  <br /></td></tr>
202 <tr class="separator:acd3c172f37d0c13ac5d5c1477837c638"><td class="memSeparator" colspan="2">&#160;</td></tr>
203 <tr class="memitem:a1b8e7fc9ce024ef2e7d2efb24793c101"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a1b8e7fc9ce024ef2e7d2efb24793c101">ARM_RETENTION_BATTERY_BACKED</a>&#160;&#160;&#160;(3U)</td></tr>
204 <tr class="memdesc:a1b8e7fc9ce024ef2e7d2efb24793c101"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data is battery-backed. Device can be powered off.  <br /></td></tr>
205 <tr class="separator:a1b8e7fc9ce024ef2e7d2efb24793c101"><td class="memSeparator" colspan="2">&#160;</td></tr>
206 <tr class="memitem:aec136119f63303cf9309e1d787e02ca3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#aec136119f63303cf9309e1d787e02ca3">ARM_RETENTION_NVM</a>&#160;&#160;&#160;(4U)</td></tr>
207 <tr class="memdesc:aec136119f63303cf9309e1d787e02ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data is retained in non-volatile memory.  <br /></td></tr>
208 <tr class="separator:aec136119f63303cf9309e1d787e02ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
209 <tr class="memitem:ab6f380932e1a8e7802be024a224faf93"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#ab6f380932e1a8e7802be024a224faf93">ARM_STORAGE_PROGRAM_CYCLES_INFINITE</a>&#160;&#160;&#160;(0UL)</td></tr>
210 <tr class="separator:ab6f380932e1a8e7802be024a224faf93"><td class="memSeparator" colspan="2">&#160;</td></tr>
211 </table><table class="memberdecls">
212 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
213 Typedefs</h2></td></tr>
214 <tr class="memitem:ga4b290224fea782e6d2ad06f541b28a98"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a>) (int32_t status, <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> operation)</td></tr>
215 <tr class="separator:ga4b290224fea782e6d2ad06f541b28a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
216 </table><table class="memberdecls">
217 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
218 Enumerations</h2></td></tr>
219 <tr class="memitem:ga3a9277f89946d61c41b22da72e3eef7c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> { <br />
220 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cac82e2ca0f9b7ec94e24ae56c45f12f8c">ARM_STORAGE_OPERATION_GET_VERSION</a>
221 , <br />
222 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca314621ae4384fef7094d8724d59b65c4">ARM_STORAGE_OPERATION_GET_CAPABILITIES</a>
223 , <br />
224 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971">ARM_STORAGE_OPERATION_INITIALIZE</a>
225 , <br />
226 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cab9488e567ad58b16c5df2637df3902e9">ARM_STORAGE_OPERATION_UNINITIALIZE</a>
227 , <br />
228 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca213a74ac5a692a80f17fd6d8e6565e05">ARM_STORAGE_OPERATION_POWER_CONTROL</a>
229 , <br />
230 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454">ARM_STORAGE_OPERATION_READ_DATA</a>
231 , <br />
232 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0">ARM_STORAGE_OPERATION_PROGRAM_DATA</a>
233 , <br />
234 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75">ARM_STORAGE_OPERATION_ERASE</a>
235 , <br />
236 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca60a0511bd5e32db2a22d3ab2023a601e">ARM_STORAGE_OPERATION_ERASE_ALL</a>
237 , <br />
238 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca7c595cd3c439753efe0a0b17efd7bb7f">ARM_STORAGE_OPERATION_GET_STATUS</a>
239 , <br />
240 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca0fe0ef7c0a9e69d053a0419282248f40">ARM_STORAGE_OPERATION_GET_INFO</a>
241 , <br />
242 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca3292512d0222e4119d0cdf77de1508df">ARM_STORAGE_OPERATION_RESOLVE_ADDRESS</a>
243 , <br />
244 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca9bfab6ee9caa3ace32338d4ef2d856f5">ARM_STORAGE_OPERATION_GET_NEXT_BLOCK</a>
245 , <br />
246 &#160;&#160;<a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cac75096931c3d29af1029f25fc44e7523">ARM_STORAGE_OPERATION_GET_BLOCK</a>
247 <br />
248  }</td></tr>
249 <tr class="separator:ga3a9277f89946d61c41b22da72e3eef7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
250 </table>
251 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
252 <a name="structARM__STORAGE__SECURITY__FEATURES" id="structARM__STORAGE__SECURITY__FEATURES"></a>
253 <h2 class="memtitle"><span class="permalink"><a href="#structARM__STORAGE__SECURITY__FEATURES">&#9670;&#160;</a></span>ARM_STORAGE_SECURITY_FEATURES</h2>
254
255 <div class="memitem">
256 <div class="memproto">
257       <table class="memname">
258         <tr>
259           <td class="memname">struct ARM_STORAGE_SECURITY_FEATURES</td>
260         </tr>
261       </table>
262 </div><div class="memdoc">
263 <div class="textblock"><p>Device Data Security Protection Features. Applicable mostly to EXTERNAL_NVM. </p>
264 </div><table class="fieldtable">
265 <tr><th colspan="3">Data Fields</th></tr>
266 <tr><td class="fieldtype">
267 <a id="abbd64eb8edcf2263db5c8ac140dc0448" name="abbd64eb8edcf2263db5c8ac140dc0448"></a>uint32_t</td>
268 <td class="fieldname">
269 acls: 1</td>
270 <td class="fielddoc">
271 Protection against internal software attacks using ACLs. </td></tr>
272 <tr><td class="fieldtype">
273 <a id="affe0253b35f41c44ea06ae1e87d91012" name="affe0253b35f41c44ea06ae1e87d91012"></a>uint32_t</td>
274 <td class="fieldname">
275 rollback_protection: 1</td>
276 <td class="fielddoc">
277 Roll-back protection. Set to true if the creator of the storage can ensure that an external attacker can't force an older firmware to run or to revert back to a previous state. </td></tr>
278 <tr><td class="fieldtype">
279 <a id="ac6f64a064cb84e29a631706586d6000c" name="ac6f64a064cb84e29a631706586d6000c"></a>uint32_t</td>
280 <td class="fieldname">
281 tamper_proof: 1</td>
282 <td class="fielddoc">
283 Tamper-proof memory (will be deleted on tamper-attempts using board level or chip level sensors). </td></tr>
284 <tr><td class="fieldtype">
285 <a id="a47dd9737459c9c5ce48f3e8a04995b9a" name="a47dd9737459c9c5ce48f3e8a04995b9a"></a>uint32_t</td>
286 <td class="fieldname">
287 internal_flash: 1</td>
288 <td class="fielddoc">
289 Internal flash. </td></tr>
290 <tr><td class="fieldtype">
291 <a id="aef9bb556c1530f5d648fd57e73b9a105" name="aef9bb556c1530f5d648fd57e73b9a105"></a>uint32_t</td>
292 <td class="fieldname">
293 reserved1: 12</td>
294 <td class="fielddoc">
295 </td></tr>
296 <tr><td class="fieldtype">
297 <a id="a1b6a0329dd65f25a0ab22496ab708306" name="a1b6a0329dd65f25a0ab22496ab708306"></a>uint32_t</td>
298 <td class="fieldname">
299 software_attacks: 1</td>
300 <td class="fielddoc">
301 device software (malware running on the device). <p>Encode support for hardening against various classes of attacks. </p>
302 </td></tr>
303 <tr><td class="fieldtype">
304 <a id="a3981b8fafe1520f11518f2b6e12ef644" name="a3981b8fafe1520f11518f2b6e12ef644"></a>uint32_t</td>
305 <td class="fieldname">
306 board_level_attacks: 1</td>
307 <td class="fielddoc">
308 board level attacks (debug probes, copy protection fuses.) </td></tr>
309 <tr><td class="fieldtype">
310 <a id="a19a70a7636956745f75a1f1bbb9cc478" name="a19a70a7636956745f75a1f1bbb9cc478"></a>uint32_t</td>
311 <td class="fieldname">
312 chip_level_attacks: 1</td>
313 <td class="fielddoc">
314 chip level attacks (tamper-protection). </td></tr>
315 <tr><td class="fieldtype">
316 <a id="acd90f369373d7551174a981c4083fef1" name="acd90f369373d7551174a981c4083fef1"></a>uint32_t</td>
317 <td class="fieldname">
318 side_channel_attacks: 1</td>
319 <td class="fielddoc">
320 side channel attacks. </td></tr>
321 <tr><td class="fieldtype">
322 <a id="ae673672452e4741c4ab7c174af880a87" name="ae673672452e4741c4ab7c174af880a87"></a>uint32_t</td>
323 <td class="fieldname">
324 reserved2: 12</td>
325 <td class="fielddoc">
326 </td></tr>
327 </table>
328
329 </div>
330 </div>
331 <h2 class="groupheader">Macro Definition Documentation</h2>
332 <a id="a2ec531cd9d7d4916f2479efd4ff65b96" name="a2ec531cd9d7d4916f2479efd4ff65b96"></a>
333 <h2 class="memtitle"><span class="permalink"><a href="#a2ec531cd9d7d4916f2479efd4ff65b96">&#9670;&#160;</a></span>ARM_STORAGE_API_VERSION</h2>
334
335 <div class="memitem">
336 <div class="memproto">
337       <table class="memname">
338         <tr>
339           <td class="memname">#define ARM_STORAGE_API_VERSION&#160;&#160;&#160;<a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(1,2)  /* API version */</td>
340         </tr>
341       </table>
342 </div><div class="memdoc">
343
344 </div>
345 </div>
346 <a id="a21777a6487158bdc1f113996e65ff0bd" name="a21777a6487158bdc1f113996e65ff0bd"></a>
347 <h2 class="memtitle"><span class="permalink"><a href="#a21777a6487158bdc1f113996e65ff0bd">&#9670;&#160;</a></span>_ARM_Driver_Storage_</h2>
348
349 <div class="memitem">
350 <div class="memproto">
351       <table class="memname">
352         <tr>
353           <td class="memname">#define _ARM_Driver_Storage_</td>
354           <td>(</td>
355           <td class="paramtype">&#160;</td>
356           <td class="paramname">n</td><td>)</td>
357           <td>&#160;&#160;&#160;Driver_Storage##n</td>
358         </tr>
359       </table>
360 </div><div class="memdoc">
361
362 </div>
363 </div>
364 <a id="af4ce245f055ef69edd1306ef8fde37cf" name="af4ce245f055ef69edd1306ef8fde37cf"></a>
365 <h2 class="memtitle"><span class="permalink"><a href="#af4ce245f055ef69edd1306ef8fde37cf">&#9670;&#160;</a></span>ARM_Driver_Storage_</h2>
366
367 <div class="memitem">
368 <div class="memproto">
369       <table class="memname">
370         <tr>
371           <td class="memname">#define ARM_Driver_Storage_</td>
372           <td>(</td>
373           <td class="paramtype">&#160;</td>
374           <td class="paramname">n</td><td>)</td>
375           <td>&#160;&#160;&#160;<a class="el" href="Driver__Storage_8h.html#a21777a6487158bdc1f113996e65ff0bd">_ARM_Driver_Storage_</a>(n)</td>
376         </tr>
377       </table>
378 </div><div class="memdoc">
379
380 </div>
381 </div>
382 <a id="ab8112c1c73ba434c93d19fa1a445c6bf" name="ab8112c1c73ba434c93d19fa1a445c6bf"></a>
383 <h2 class="memtitle"><span class="permalink"><a href="#ab8112c1c73ba434c93d19fa1a445c6bf">&#9670;&#160;</a></span>ARM_STORAGE_INVALID_OFFSET</h2>
384
385 <div class="memitem">
386 <div class="memproto">
387       <table class="memname">
388         <tr>
389           <td class="memname">#define ARM_STORAGE_INVALID_OFFSET&#160;&#160;&#160;(0xFFFFFFFFFFFFFFFFULL)</td>
390         </tr>
391       </table>
392 </div><div class="memdoc">
393
394 <p>Invalid address (relative to a storage controller's address space). A storage block may never start at this address. </p>
395
396 </div>
397 </div>
398 <a id="a5499f02c78acaccb22d6ecc6be195058" name="a5499f02c78acaccb22d6ecc6be195058"></a>
399 <h2 class="memtitle"><span class="permalink"><a href="#a5499f02c78acaccb22d6ecc6be195058">&#9670;&#160;</a></span>ARM_STORAGE_INVALID_ADDRESS</h2>
400
401 <div class="memitem">
402 <div class="memproto">
403       <table class="memname">
404         <tr>
405           <td class="memname">#define ARM_STORAGE_INVALID_ADDRESS&#160;&#160;&#160;(0xFFFFFFFFUL)</td>
406         </tr>
407       </table>
408 </div><div class="memdoc">
409
410 <p>Invalid address within the processor's memory address space. Refer to memory-mapped storage, i.e. <a class="el" href="group__storage__interface__gr.html#a974a1edf42132d42beccc9819417307b">ARM_DRIVER_STORAGE::ResolveAddress()</a>. </p>
411
412 </div>
413 </div>
414 <a id="a7d81999c123625db0e66b8a2c2b0e1b9" name="a7d81999c123625db0e66b8a2c2b0e1b9"></a>
415 <h2 class="memtitle"><span class="permalink"><a href="#a7d81999c123625db0e66b8a2c2b0e1b9">&#9670;&#160;</a></span>ARM_STORAGE_ERROR_NOT_ERASABLE</h2>
416
417 <div class="memitem">
418 <div class="memproto">
419       <table class="memname">
420         <tr>
421           <td class="memname">#define ARM_STORAGE_ERROR_NOT_ERASABLE&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
422         </tr>
423       </table>
424 </div><div class="memdoc">
425
426 <p>Part (or all) of the range provided to Erase() isn't erasable. </p>
427
428 </div>
429 </div>
430 <a id="a5a97bf8a1813abdf6fef26f0d777a252" name="a5a97bf8a1813abdf6fef26f0d777a252"></a>
431 <h2 class="memtitle"><span class="permalink"><a href="#a5a97bf8a1813abdf6fef26f0d777a252">&#9670;&#160;</a></span>ARM_STORAGE_ERROR_NOT_PROGRAMMABLE</h2>
432
433 <div class="memitem">
434 <div class="memproto">
435       <table class="memname">
436         <tr>
437           <td class="memname">#define ARM_STORAGE_ERROR_NOT_PROGRAMMABLE&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td>
438         </tr>
439       </table>
440 </div><div class="memdoc">
441
442 <p>Part (or all) of the range provided to ProgramData() isn't programmable. </p>
443
444 </div>
445 </div>
446 <a id="a71f6e5ed403c06a5c99c4882bacdf76e" name="a71f6e5ed403c06a5c99c4882bacdf76e"></a>
447 <h2 class="memtitle"><span class="permalink"><a href="#a71f6e5ed403c06a5c99c4882bacdf76e">&#9670;&#160;</a></span>ARM_STORAGE_ERROR_PROTECTED</h2>
448
449 <div class="memitem">
450 <div class="memproto">
451       <table class="memname">
452         <tr>
453           <td class="memname">#define ARM_STORAGE_ERROR_PROTECTED&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td>
454         </tr>
455       </table>
456 </div><div class="memdoc">
457
458 <p>Part (or all) of the range to Erase() or ProgramData() is protected. </p>
459
460 </div>
461 </div>
462 <a id="a955b1ca2ea24cfd3a8923731b581cfd4" name="a955b1ca2ea24cfd3a8923731b581cfd4"></a>
463 <h2 class="memtitle"><span class="permalink"><a href="#a955b1ca2ea24cfd3a8923731b581cfd4">&#9670;&#160;</a></span>ARM_STORAGE_VALID_BLOCK</h2>
464
465 <div class="memitem">
466 <div class="memproto">
467       <table class="memname">
468         <tr>
469           <td class="memname">#define ARM_STORAGE_VALID_BLOCK</td>
470           <td>(</td>
471           <td class="paramtype">&#160;</td>
472           <td class="paramname">BLK</td><td>)</td>
473           <td>&#160;&#160;&#160;(((BLK)-&gt;addr != <a class="el" href="Driver__Storage_8h.html#ab8112c1c73ba434c93d19fa1a445c6bf">ARM_STORAGE_INVALID_OFFSET</a>) &amp;&amp; ((BLK)-&gt;size != 0))</td>
474         </tr>
475       </table>
476 </div><div class="memdoc">
477 <p>The check for a valid <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK" title="A storage block is a range of memory with uniform attributes.">ARM_STORAGE_BLOCK</a>. </p>
478
479 </div>
480 </div>
481 <a id="a66cd2a20f084db2d28f6a98cbc503d8a" name="a66cd2a20f084db2d28f6a98cbc503d8a"></a>
482 <h2 class="memtitle"><span class="permalink"><a href="#a66cd2a20f084db2d28f6a98cbc503d8a">&#9670;&#160;</a></span>ARM_STORAGE_PROGRAMMABILITY_RAM</h2>
483
484 <div class="memitem">
485 <div class="memproto">
486       <table class="memname">
487         <tr>
488           <td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_RAM&#160;&#160;&#160;(0U)</td>
489         </tr>
490       </table>
491 </div><div class="memdoc">
492
493 <p>Values for encoding storage memory-types with respect to programmability. </p>
494 <p>Please ensure that the maximum of the following memory types doesn't exceed 16; we encode this in a 4-bit field within <a class="el" href="group__storage__interface__gr.html#aac0da06bf0775bd9b877aafbc4bcad77" title="A value to indicate storage programmability.">ARM_STORAGE_INFO::programmability</a>. </p>
495
496 </div>
497 </div>
498 <a id="af232495db19beb7025aebc6e3f9e7553" name="af232495db19beb7025aebc6e3f9e7553"></a>
499 <h2 class="memtitle"><span class="permalink"><a href="#af232495db19beb7025aebc6e3f9e7553">&#9670;&#160;</a></span>ARM_STORAGE_PROGRAMMABILITY_ROM</h2>
500
501 <div class="memitem">
502 <div class="memproto">
503       <table class="memname">
504         <tr>
505           <td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_ROM&#160;&#160;&#160;(1U)</td>
506         </tr>
507       </table>
508 </div><div class="memdoc">
509
510 <p>Read-only memory. </p>
511
512 </div>
513 </div>
514 <a id="a373cda87e59c51b2a04f46f4d31d5dd8" name="a373cda87e59c51b2a04f46f4d31d5dd8"></a>
515 <h2 class="memtitle"><span class="permalink"><a href="#a373cda87e59c51b2a04f46f4d31d5dd8">&#9670;&#160;</a></span>ARM_STORAGE_PROGRAMMABILITY_WORM</h2>
516
517 <div class="memitem">
518 <div class="memproto">
519       <table class="memname">
520         <tr>
521           <td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_WORM&#160;&#160;&#160;(2U)</td>
522         </tr>
523       </table>
524 </div><div class="memdoc">
525
526 <p>write-once-read-only-memory (WORM). </p>
527
528 </div>
529 </div>
530 <a id="a08670c9b9270eba2e030d90c4af9317c" name="a08670c9b9270eba2e030d90c4af9317c"></a>
531 <h2 class="memtitle"><span class="permalink"><a href="#a08670c9b9270eba2e030d90c4af9317c">&#9670;&#160;</a></span>ARM_STORAGE_PROGRAMMABILITY_ERASABLE</h2>
532
533 <div class="memitem">
534 <div class="memproto">
535       <table class="memname">
536         <tr>
537           <td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_ERASABLE&#160;&#160;&#160;(3U)</td>
538         </tr>
539       </table>
540 </div><div class="memdoc">
541
542 <p>re-programmable based on erase. Supports multiple writes. </p>
543
544 </div>
545 </div>
546 <a id="afb918a33a4b8655321c45dfb99b86339" name="afb918a33a4b8655321c45dfb99b86339"></a>
547 <h2 class="memtitle"><span class="permalink"><a href="#afb918a33a4b8655321c45dfb99b86339">&#9670;&#160;</a></span>ARM_RETENTION_WHILE_DEVICE_ACTIVE</h2>
548
549 <div class="memitem">
550 <div class="memproto">
551       <table class="memname">
552         <tr>
553           <td class="memname">#define ARM_RETENTION_WHILE_DEVICE_ACTIVE&#160;&#160;&#160;(0U)</td>
554         </tr>
555       </table>
556 </div><div class="memdoc">
557
558 <p>Data is retained only during device activity. </p>
559 <p>Values for encoding data-retention levels for storage blocks.</p>
560 <p>Please ensure that the maximum of the following retention types doesn't exceed 16; we encode this in a 4-bit field within <a class="el" href="group__storage__interface__gr.html#a16d1a2aead689ffa28fd89cb6779e5a7">ARM_STORAGE_INFO::retention_level</a>. </p>
561
562 </div>
563 </div>
564 <a id="a42cdcdcda35d29552ed4558542770dbe" name="a42cdcdcda35d29552ed4558542770dbe"></a>
565 <h2 class="memtitle"><span class="permalink"><a href="#a42cdcdcda35d29552ed4558542770dbe">&#9670;&#160;</a></span>ARM_RETENTION_ACROSS_SLEEP</h2>
566
567 <div class="memitem">
568 <div class="memproto">
569       <table class="memname">
570         <tr>
571           <td class="memname">#define ARM_RETENTION_ACROSS_SLEEP&#160;&#160;&#160;(1U)</td>
572         </tr>
573       </table>
574 </div><div class="memdoc">
575
576 <p>Data is retained across processor sleep. </p>
577
578 </div>
579 </div>
580 <a id="acd3c172f37d0c13ac5d5c1477837c638" name="acd3c172f37d0c13ac5d5c1477837c638"></a>
581 <h2 class="memtitle"><span class="permalink"><a href="#acd3c172f37d0c13ac5d5c1477837c638">&#9670;&#160;</a></span>ARM_RETENTION_ACROSS_DEEP_SLEEP</h2>
582
583 <div class="memitem">
584 <div class="memproto">
585       <table class="memname">
586         <tr>
587           <td class="memname">#define ARM_RETENTION_ACROSS_DEEP_SLEEP&#160;&#160;&#160;(2U)</td>
588         </tr>
589       </table>
590 </div><div class="memdoc">
591
592 <p>Data is retained across processor deep-sleep. </p>
593
594 </div>
595 </div>
596 <a id="a1b8e7fc9ce024ef2e7d2efb24793c101" name="a1b8e7fc9ce024ef2e7d2efb24793c101"></a>
597 <h2 class="memtitle"><span class="permalink"><a href="#a1b8e7fc9ce024ef2e7d2efb24793c101">&#9670;&#160;</a></span>ARM_RETENTION_BATTERY_BACKED</h2>
598
599 <div class="memitem">
600 <div class="memproto">
601       <table class="memname">
602         <tr>
603           <td class="memname">#define ARM_RETENTION_BATTERY_BACKED&#160;&#160;&#160;(3U)</td>
604         </tr>
605       </table>
606 </div><div class="memdoc">
607
608 <p>Data is battery-backed. Device can be powered off. </p>
609
610 </div>
611 </div>
612 <a id="aec136119f63303cf9309e1d787e02ca3" name="aec136119f63303cf9309e1d787e02ca3"></a>
613 <h2 class="memtitle"><span class="permalink"><a href="#aec136119f63303cf9309e1d787e02ca3">&#9670;&#160;</a></span>ARM_RETENTION_NVM</h2>
614
615 <div class="memitem">
616 <div class="memproto">
617       <table class="memname">
618         <tr>
619           <td class="memname">#define ARM_RETENTION_NVM&#160;&#160;&#160;(4U)</td>
620         </tr>
621       </table>
622 </div><div class="memdoc">
623
624 <p>Data is retained in non-volatile memory. </p>
625
626 </div>
627 </div>
628 <a id="ab6f380932e1a8e7802be024a224faf93" name="ab6f380932e1a8e7802be024a224faf93"></a>
629 <h2 class="memtitle"><span class="permalink"><a href="#ab6f380932e1a8e7802be024a224faf93">&#9670;&#160;</a></span>ARM_STORAGE_PROGRAM_CYCLES_INFINITE</h2>
630
631 <div class="memitem">
632 <div class="memproto">
633       <table class="memname">
634         <tr>
635           <td class="memname">#define ARM_STORAGE_PROGRAM_CYCLES_INFINITE&#160;&#160;&#160;(0UL)</td>
636         </tr>
637       </table>
638 </div><div class="memdoc">
639 <p>Infinite or unknown endurance for reprogramming. </p>
640
641 </div>
642 </div>
643 </div><!-- contents -->
644 </div><!-- doc-content -->
645 <!-- start footer part -->
646 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
647   <ul>
648     <li class="navelem"><a class="el" href="dir_7151b3cc910409bb744bd274374c738d.html">Driver</a></li><li class="navelem"><a class="el" href="dir_9c39448ea46a8e15f1aabc7dec307fcf.html">Include</a></li><li class="navelem"><a class="el" href="Driver__Storage_8h.html">Driver_Storage.h</a></li>
649     <li class="footer">
650       <script type="text/javascript">
651         <!--
652         writeFooter.call(this);
653         //-->
654       </script> 
655     </li>
656   </ul>
657 </div>
658 </body>
659 </html>