]> begriffs open source - cmsis/blob - main/Driver/Driver__Storage_8c.html
Update documentation for branch main
[cmsis] / main / Driver / Driver__Storage_8c.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.c File Reference</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-Driver
47    &#160;<span id="projectnumber"><script type="text/javascript">
48      <!--
49      writeHeader.call(this);
50      writeVersionDropdown.call(this);
51      //-->
52     </script>
53    </span>
54    </div>
55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</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('Driver__Storage_8c.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">Driver_Storage.c 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="func-members" name="func-members"></a>
137 Functions</h2></td></tr>
138 <tr class="memitem:gaf28193431b1a2ee64b22bfb36aed27e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gaf28193431b1a2ee64b22bfb36aed27e3">ARM_Storage_GetVersion</a> (void)</td></tr>
139 <tr class="memdesc:gaf28193431b1a2ee64b22bfb36aed27e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver version.  <br /></td></tr>
140 <tr class="separator:gaf28193431b1a2ee64b22bfb36aed27e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga8378b3901dfe76d8f31728a50e10dae2"><td class="memItemLeft" align="right" valign="top">ARM_STOR_CAPABILITIES&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2">ARM_Storage_GetCapabilities</a> (void)</td></tr>
142 <tr class="memdesc:ga8378b3901dfe76d8f31728a50e10dae2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver capabilities.  <br /></td></tr>
143 <tr class="separator:ga8378b3901dfe76d8f31728a50e10dae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:gacc5dc090a35ac16caff8957030eaa174"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174">ARM_Storage_Initialize</a> (<a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> callback)</td></tr>
145 <tr class="memdesc:gacc5dc090a35ac16caff8957030eaa174"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the Storage interface.  <br /></td></tr>
146 <tr class="separator:gacc5dc090a35ac16caff8957030eaa174"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:ga1d14b15ddcda2836c6e3c1d0b5e60dca"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca">ARM_Storage_Uninitialize</a> (void)</td></tr>
148 <tr class="memdesc:ga1d14b15ddcda2836c6e3c1d0b5e60dca"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize the Storage Interface.  <br /></td></tr>
149 <tr class="separator:ga1d14b15ddcda2836c6e3c1d0b5e60dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:ga979a2484bf05b2986de95a5d98307d54"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54">ARM_Storage_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
151 <tr class="memdesc:ga979a2484bf05b2986de95a5d98307d54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control the Storage interface power.  <br /></td></tr>
152 <tr class="separator:ga979a2484bf05b2986de95a5d98307d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:gabaa24553c165add98020434c980b3ab4"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gabaa24553c165add98020434c980b3ab4">ARM_Storage_ReadData</a> (uint64_t addr, void *data, uint32_t size)</td></tr>
154 <tr class="memdesc:gabaa24553c165add98020434c980b3ab4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from Storage.  <br /></td></tr>
155 <tr class="separator:gabaa24553c165add98020434c980b3ab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:gabd20d561854c06918b0515b6c1bba230"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230">ARM_Storage_ProgramData</a> (uint64_t addr, const void *data, uint32_t size)</td></tr>
157 <tr class="memdesc:gabd20d561854c06918b0515b6c1bba230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Program data to Storage.  <br /></td></tr>
158 <tr class="separator:gabd20d561854c06918b0515b6c1bba230"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:gaceef4851d9181cce65c8b2d05f4429bc"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gaceef4851d9181cce65c8b2d05f4429bc">ARM_Storage_Erase</a> (uint64_t addr, uint32_t size)</td></tr>
160 <tr class="memdesc:gaceef4851d9181cce65c8b2d05f4429bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erase Storage range.  <br /></td></tr>
161 <tr class="separator:gaceef4851d9181cce65c8b2d05f4429bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:ga04e77387a3c628d6fc661e82f7daddaa"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a> (void)</td></tr>
163 <tr class="memdesc:ga04e77387a3c628d6fc661e82f7daddaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erase complete Storage.  <br /></td></tr>
164 <tr class="separator:ga04e77387a3c628d6fc661e82f7daddaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:ga29e7bfe78f41abb16973bdb4e0188a20"><td class="memItemLeft" align="right" valign="top">ARM_Storage_STATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20">ARM_Storage_GetStatus</a> (void)</td></tr>
166 <tr class="memdesc:ga29e7bfe78f41abb16973bdb4e0188a20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Storage status.  <br /></td></tr>
167 <tr class="separator:ga29e7bfe78f41abb16973bdb4e0188a20"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:gad557e8e6e33cd4528d398ecf4dddc747"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747">ARM_Storage_GetInfo</a> (<a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> *info)</td></tr>
169 <tr class="memdesc:gad557e8e6e33cd4528d398ecf4dddc747"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Storage information.  <br /></td></tr>
170 <tr class="separator:gad557e8e6e33cd4528d398ecf4dddc747"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:ga5a1934750a51c74b8b0fea52588a3b9a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga5a1934750a51c74b8b0fea52588a3b9a">ARM_Storage_ResolveAddress</a> (uint64_t addr)</td></tr>
172 <tr class="memdesc:ga5a1934750a51c74b8b0fea52588a3b9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve an address relative to the storage controller into a memory address.  <br /></td></tr>
173 <tr class="separator:ga5a1934750a51c74b8b0fea52588a3b9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:gad318f8cb38626cbeea1fcf36a0977c44"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gad318f8cb38626cbeea1fcf36a0977c44">ARM_Storage_GetNextBlock</a> (const <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *prev_block, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *next_block)</td></tr>
175 <tr class="memdesc:gad318f8cb38626cbeea1fcf36a0977c44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance to the successor of the current block (iterator).  <br /></td></tr>
176 <tr class="separator:gad318f8cb38626cbeea1fcf36a0977c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memitem:ga5fe9d27ce8afe65124dec62566114073"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga5fe9d27ce8afe65124dec62566114073">ARM_Storage_GetBlock</a> (uint64_t addr, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *block)</td></tr>
178 <tr class="memdesc:ga5fe9d27ce8afe65124dec62566114073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the storage block (iterator) encompassing a given storage address.  <br /></td></tr>
179 <tr class="separator:ga5fe9d27ce8afe65124dec62566114073"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 </table>
181 </div><!-- contents -->
182 </div><!-- doc-content -->
183 <!-- start footer part -->
184 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
185   <ul>
186     <li class="navelem"><a class="el" href="dir_482bc3caff44068389d36dd5c1e36768.html">src</a></li><li class="navelem"><a class="el" href="Driver__Storage_8c.html">Driver_Storage.c</a></li>
187     <li class="footer">
188       <script type="text/javascript">
189         <!--
190         writeFooter.call(this);
191         //-->
192       </script> 
193     </li>
194   </ul>
195 </div>
196 </body>
197 </html>