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">
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: Sample Use of Storage Driver</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&dn=expat.txt MIT */
28 $(document).ready(function() { init_search(); });
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>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <table cellspacing="0" cellpadding="0">
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  <span id="projectnumber"><script type="text/javascript">
49 writeHeader.call(this);
50 writeVersionDropdown.call(this);
55 <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
57 <td> <div id="MSearchBox" class="MSearchBoxInactive">
59 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
69 <!--END !PROJECT_NAME-->
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
77 <script type="text/javascript">
78 writeComponentTabs.call(this);
82 <script type="text/javascript">
83 writeSubComponentTabs.call(this);
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
94 <div id="nav-tree-contents">
95 <div id="nav-sync" class="sync"></div>
98 <div id="splitbar" style="-moz-user-select:none;"
99 class="ui-resizable-handle">
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('group__SampleUseOfStorageDriver.html',''); initResizable(); });
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)">
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
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>
130 <div class="headertitle"><div class="title">Sample Use of Storage Driver<div class="ingroups"><a class="el" href="group__storage__interface__gr.html">Storage Interface</a></div></div></div>
132 <div class="contents">
133 <p><b>Example Code:</b></p>
134 <p>The following is a generic algorithm to erase and program one <a class="el" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">ARM_STORAGE_BLOCK_ATTRIBUTES::erase_unit</a> worth of storage and then read it back to be verified. It handles both synchronous and asynchronous driver implementations.</p>
135 <div class="fragment"><div class="line"><span class="comment">// Copyright (c) 2006-2016, Arm Limited, All Rights Reserved</span></div>
136 <div class="line"><span class="comment">// SPDX-License-Identifier: Apache-2.0</span></div>
137 <div class="line"><span class="comment">//</span></div>
138 <div class="line"><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div>
139 <div class="line"><span class="comment">// not use this file except in compliance with the License.</span></div>
140 <div class="line"><span class="comment">// You may obtain a copy of the License at</span></div>
141 <div class="line"><span class="comment">//</span></div>
142 <div class="line"><span class="comment">// http:// www.apache.org/licenses/LICENSE-2.0</span></div>
143 <div class="line"><span class="comment">//</span></div>
144 <div class="line"><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
145 <div class="line"><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div>
146 <div class="line"><span class="comment">// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
147 <div class="line"><span class="comment">// See the License for the specific language governing permissions and</span></div>
148 <div class="line"><span class="comment">// limitations under the License.</span></div>
149 <div class="line"> </div>
150 <div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__Storage_8h.html">Driver_Storage.h</a>"</span></div>
151 <div class="line"><span class="preprocessor">#include <stdio.h></span></div>
152 <div class="line"><span class="preprocessor">#include <string.h></span></div>
153 <div class="line"> </div>
154 <div class="line"><span class="preprocessor">#define TEST_ASSERT(Expr) if (!(Expr)) { printf("%s:%u: assertion failure\n"</span>, __FUNCTION__, __LINE__); while (1) ;}</div>
155 <div class="line"><span class="preprocessor">#define TEST_ASSERT_EQUAL(expected, actual) if ((expected) != (actual)) {printf("%s:%u: assertion failure\n"</span>, __FUNCTION__, __LINE__); while (1) ;}</div>
156 <div class="line"><span class="preprocessor">#define TEST_ASSERT_NOT_EQUAL(expected, actual) if ((expected) == (actual)) {printf("%s:%u: assertion failure\n"</span>, __FUNCTION__, __LINE__); while (1) ;}</div>
157 <div class="line"> </div>
158 <div class="line"><span class="comment">// forward declarations</span></div>
159 <div class="line"><span class="keywordtype">void</span> callbackHandler(int32_t status, <a class="code hl_enumeration" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> operation);</div>
160 <div class="line"><span class="keywordtype">void</span> progressStateMachine(<span class="keywordtype">void</span>);</div>
161 <div class="line"> </div>
162 <div class="line"><span class="keyword">static</span> <span class="keyword">enum</span> {</div>
163 <div class="line"> NEEDS_INITIALIZATION,</div>
164 <div class="line"> NEEDS_ERASE,</div>
165 <div class="line"> NEEDS_PROGRAMMING,</div>
166 <div class="line"> NEEDS_READ,</div>
167 <div class="line"> NEEDS_VERIFICATION_FOLLOWING_READ,</div>
168 <div class="line"> FINISHED</div>
169 <div class="line">} state;</div>
170 <div class="line"> </div>
171 <div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> <a class="code hl_define" href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a>(0);</div>
172 <div class="line"><a class="code hl_struct" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> *drv = &<a class="code hl_define" href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a>(0);</div>
173 <div class="line"> </div>
174 <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> BUFFER_SIZE = 16384;</div>
175 <div class="line"><span class="keyword">static</span> uint8_t buffer[BUFFER_SIZE];</div>
176 <div class="line"> </div>
177 <div class="line"><span class="keywordtype">void</span> main(<span class="keywordtype">int</span> argc __unused, <span class="keywordtype">char</span>** argv __unused)</div>
178 <div class="line">{</div>
179 <div class="line"> state = NEEDS_INITIALIZATION;</div>
180 <div class="line"> </div>
181 <div class="line"> progressStateMachine();</div>
182 <div class="line"> <span class="keywordflow">while</span> (<span class="keyword">true</span>) {</div>
183 <div class="line"> <span class="comment">// WFE(); // optional low-power sleep</span></div>
184 <div class="line"> }</div>
185 <div class="line">}</div>
186 <div class="line"> </div>
187 <div class="line"><span class="keywordtype">void</span> progressStateMachine(<span class="keywordtype">void</span>)</div>
188 <div class="line">{</div>
189 <div class="line"> int32_t rc;</div>
190 <div class="line"> </div>
191 <div class="line"> <span class="keyword">static</span> <a class="code hl_struct" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> firstBlock;</div>
192 <div class="line"> <span class="keywordflow">if</span> (!<a class="code hl_define" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(&firstBlock)) {</div>
193 <div class="line"> <span class="comment">// Get the first block. This block is entered only once.</span></div>
194 <div class="line"> rc = drv-><a class="code hl_variable" href="group__storage__interface__gr.html#a4ced44f1c827e05343481c4e56334a2b">GetNextBlock</a>(NULL, &firstBlock); <span class="comment">// get first block</span></div>
195 <div class="line"> TEST_ASSERT_EQUAL(<a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>, rc);</div>
196 <div class="line"> }</div>
197 <div class="line"> TEST_ASSERT(<a class="code hl_define" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(&firstBlock));</div>
198 <div class="line"> TEST_ASSERT(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#af931a8871310b4dad23f0f0b0f623560">size</a> > 0);</div>
199 <div class="line"> </div>
200 <div class="line"> <span class="keywordflow">switch</span> (state) {</div>
201 <div class="line"> <span class="keywordflow">case</span> NEEDS_INITIALIZATION:</div>
202 <div class="line"> rc = drv-><a class="code hl_variable" href="group__storage__interface__gr.html#a5b5455a05b9291a17e9f2c0b3d2736ef">Initialize</a>(callbackHandler);</div>
203 <div class="line"> TEST_ASSERT(rc >= <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
204 <div class="line"> <span class="keywordflow">if</span> (rc == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
205 <div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code hl_variable" href="group__storage__interface__gr.html#ab3064f39b3c42cd63367312505328f29">GetCapabilities</a>().<a class="code hl_variable" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
206 <div class="line"> state = NEEDS_ERASE;</div>
207 <div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
208 <div class="line"> }</div>
209 <div class="line"> TEST_ASSERT_EQUAL(1, rc); <span class="comment">// synchronous completion</span></div>
210 <div class="line"> </div>
211 <div class="line"> <span class="comment">// intentional fall-through</span></div>
212 <div class="line"> </div>
213 <div class="line"> <span class="keywordflow">case</span> NEEDS_ERASE:</div>
214 <div class="line"> TEST_ASSERT(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a> > 0);</div>
215 <div class="line"> rc = drv-><a class="code hl_variable" href="group__storage__interface__gr.html#a009c6f0bb746592a53ddcfd562a559b0">Erase</a>(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">addr</a>, firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
216 <div class="line"> TEST_ASSERT(rc >= <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
217 <div class="line"> <span class="keywordflow">if</span> (rc == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
218 <div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code hl_variable" href="group__storage__interface__gr.html#ab3064f39b3c42cd63367312505328f29">GetCapabilities</a>().<a class="code hl_variable" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
219 <div class="line"> state = NEEDS_PROGRAMMING;</div>
220 <div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
221 <div class="line"> }</div>
222 <div class="line"> TEST_ASSERT_EQUAL(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>, (uint32_t)rc); <span class="comment">// synchronous completion</span></div>
223 <div class="line"> </div>
224 <div class="line"> <span class="comment">// intentional fall-through</span></div>
225 <div class="line"> </div>
226 <div class="line"> <span class="keywordflow">case</span> NEEDS_PROGRAMMING:</div>
227 <div class="line"> TEST_ASSERT(BUFFER_SIZE >= firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
228 <div class="line"><span class="preprocessor"> #define PATTERN 0xAA</span></div>
229 <div class="line"> memset(buffer, PATTERN, firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
230 <div class="line"> rc = drv-><a class="code hl_variable" href="group__storage__interface__gr.html#a2055be24b59b4a6158761eff33a561c1">ProgramData</a>(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">addr</a>, buffer, firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
231 <div class="line"> TEST_ASSERT(rc >= <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
232 <div class="line"> <span class="keywordflow">if</span> (rc == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
233 <div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code hl_variable" href="group__storage__interface__gr.html#ab3064f39b3c42cd63367312505328f29">GetCapabilities</a>().<a class="code hl_variable" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
234 <div class="line"> state = NEEDS_READ;</div>
235 <div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
236 <div class="line"> }</div>
237 <div class="line"> TEST_ASSERT_EQUAL(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>, (uint32_t)rc); <span class="comment">// synchronous completion</span></div>
238 <div class="line"> </div>
239 <div class="line"> <span class="comment">// intentional fall-through</span></div>
240 <div class="line"> </div>
241 <div class="line"> <span class="keywordflow">case</span> NEEDS_READ:</div>
242 <div class="line"> rc = drv-><a class="code hl_variable" href="group__storage__interface__gr.html#aac7475b53f1356448c7312c39aa61026">ReadData</a>(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">addr</a>, buffer, firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
243 <div class="line"> TEST_ASSERT(rc >= <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
244 <div class="line"> <span class="keywordflow">if</span> (rc == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
245 <div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code hl_variable" href="group__storage__interface__gr.html#ab3064f39b3c42cd63367312505328f29">GetCapabilities</a>().<a class="code hl_variable" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
246 <div class="line"> state = NEEDS_VERIFICATION_FOLLOWING_READ;</div>
247 <div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
248 <div class="line"> }</div>
249 <div class="line"> TEST_ASSERT_EQUAL(firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>, (uint32_t)rc);</div>
250 <div class="line"> </div>
251 <div class="line"> <span class="comment">// intentional fall-through</span></div>
252 <div class="line"> </div>
253 <div class="line"> <span class="keywordflow">case</span> NEEDS_VERIFICATION_FOLLOWING_READ:</div>
254 <div class="line"> printf(<span class="stringliteral">"verifying data\r\n"</span>);</div>
255 <div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = 0; i < firstBlock.<a class="code hl_variable" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code hl_variable" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>; i++) {</div>
256 <div class="line"> TEST_ASSERT_EQUAL(PATTERN, buffer[i]);</div>
257 <div class="line"> }</div>
258 <div class="line"> state = FINISHED;</div>
259 <div class="line"> printf(<span class="stringliteral">"done\r\n"</span>);</div>
260 <div class="line"> <span class="keywordflow">break</span>;</div>
261 <div class="line"> </div>
262 <div class="line"> <span class="keywordflow">case</span> FINISHED:</div>
263 <div class="line"> <span class="keywordflow">break</span>;</div>
264 <div class="line"> } <span class="comment">// switch (state)</span></div>
265 <div class="line">}</div>
266 <div class="line"> </div>
267 <div class="line"><span class="keywordtype">void</span> callbackHandler(int32_t status, <a class="code hl_enumeration" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> operation)</div>
268 <div class="line">{</div>
269 <div class="line"> (void)status;</div>
270 <div class="line"> (void)operation;</div>
271 <div class="line"> <span class="keywordflow">switch</span> (operation) {</div>
272 <div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971">ARM_STORAGE_OPERATION_INITIALIZE</a>:</div>
273 <div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454">ARM_STORAGE_OPERATION_READ_DATA</a>:</div>
274 <div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0">ARM_STORAGE_OPERATION_PROGRAM_DATA</a>:</div>
275 <div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75">ARM_STORAGE_OPERATION_ERASE</a>:</div>
276 <div class="line"> progressStateMachine();</div>
277 <div class="line"> <span class="keywordflow">break</span>;</div>
278 <div class="line"> </div>
279 <div class="line"> <span class="keywordflow">default</span>:</div>
280 <div class="line"> printf(<span class="stringliteral">"callbackHandler: unexpected callback for opcode %u with status %ld\r\n"</span>, operation, status);</div>
281 <div class="line"> <span class="keywordflow">break</span>;</div>
282 <div class="line"> }</div>
283 <div class="line">}</div>
284 <div class="ttc" id="aDriver__Storage_8h_html"><div class="ttname"><a href="Driver__Storage_8h.html">Driver_Storage.h</a></div></div>
285 <div class="ttc" id="aDriver__Storage_8h_html_a955b1ca2ea24cfd3a8923731b581cfd4"><div class="ttname"><a href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a></div><div class="ttdeci">#define ARM_STORAGE_VALID_BLOCK(BLK)</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:100</div></div>
286 <div class="ttc" id="aDriver__Storage_8h_html_af4ce245f055ef69edd1306ef8fde37cf"><div class="ttname"><a href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a></div><div class="ttdeci">#define ARM_Driver_Storage_(n)</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:46</div></div>
287 <div class="ttc" id="aDriver__Storage_8h_html_ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454"><div class="ttname"><a href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454">ARM_STORAGE_OPERATION_READ_DATA</a></div><div class="ttdeci">@ ARM_STORAGE_OPERATION_READ_DATA</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:210</div></div>
288 <div class="ttc" id="aDriver__Storage_8h_html_ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0"><div class="ttname"><a href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0">ARM_STORAGE_OPERATION_PROGRAM_DATA</a></div><div class="ttdeci">@ ARM_STORAGE_OPERATION_PROGRAM_DATA</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:211</div></div>
289 <div class="ttc" id="aDriver__Storage_8h_html_ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75"><div class="ttname"><a href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75">ARM_STORAGE_OPERATION_ERASE</a></div><div class="ttdeci">@ ARM_STORAGE_OPERATION_ERASE</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:212</div></div>
290 <div class="ttc" id="aDriver__Storage_8h_html_ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971"><div class="ttname"><a href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971">ARM_STORAGE_OPERATION_INITIALIZE</a></div><div class="ttdeci">@ ARM_STORAGE_OPERATION_INITIALIZE</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:207</div></div>
291 <div class="ttc" id="agroup__execution__status_html_ga85752c5de59e8adeb001e35ff5be6be7"><div class="ttname"><a href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a></div><div class="ttdeci">#define ARM_DRIVER_OK</div><div class="ttdoc">Operation succeeded.</div></div>
292 <div class="ttc" id="agroup__storage__interface__gr_html_a009c6f0bb746592a53ddcfd562a559b0"><div class="ttname"><a href="group__storage__interface__gr.html#a009c6f0bb746592a53ddcfd562a559b0">ARM_DRIVER_STORAGE::Erase</a></div><div class="ttdeci">int32_t(* Erase)(uint64_t addr, uint32_t size)</div><div class="ttdoc">Pointer to ARM_Storage_Erase : Erase Storage range.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:421</div></div>
293 <div class="ttc" id="agroup__storage__interface__gr_html_a0e89cf6b9f6cd3125470b1bed2b823df"><div class="ttname"><a href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">ARM_STORAGE_BLOCK::addr</a></div><div class="ttdeci">uint64_t addr</div><div class="ttdoc">This is the start address of the storage block. It is expressed as an offset from the start of the st...</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:89</div></div>
294 <div class="ttc" id="agroup__storage__interface__gr_html_a15ade4ca762bc6ce72d435a16febb4cc"><div class="ttname"><a href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">ARM_STORAGE_CAPABILITIES::asynchronous_ops</a></div><div class="ttdeci">uint32_t asynchronous_ops</div><div class="ttdoc">Used to indicate if APIs like initialize, read, erase, program, etc. can operate in asynchronous mode...</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:189</div></div>
295 <div class="ttc" id="agroup__storage__interface__gr_html_a2055be24b59b4a6158761eff33a561c1"><div class="ttname"><a href="group__storage__interface__gr.html#a2055be24b59b4a6158761eff33a561c1">ARM_DRIVER_STORAGE::ProgramData</a></div><div class="ttdeci">int32_t(* ProgramData)(uint64_t addr, const void *data, uint32_t size)</div><div class="ttdoc">Pointer to ARM_Storage_ProgramData : Program data to Storage.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:420</div></div>
296 <div class="ttc" id="agroup__storage__interface__gr_html_a4ced44f1c827e05343481c4e56334a2b"><div class="ttname"><a href="group__storage__interface__gr.html#a4ced44f1c827e05343481c4e56334a2b">ARM_DRIVER_STORAGE::GetNextBlock</a></div><div class="ttdeci">int32_t(* GetNextBlock)(const ARM_STORAGE_BLOCK *prev, ARM_STORAGE_BLOCK *next)</div><div class="ttdoc">Pointer to ARM_Storage_GetNextBlock : fetch successor for current block.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:426</div></div>
297 <div class="ttc" id="agroup__storage__interface__gr_html_a5b5455a05b9291a17e9f2c0b3d2736ef"><div class="ttname"><a href="group__storage__interface__gr.html#a5b5455a05b9291a17e9f2c0b3d2736ef">ARM_DRIVER_STORAGE::Initialize</a></div><div class="ttdeci">int32_t(* Initialize)(ARM_Storage_Callback_t callback)</div><div class="ttdoc">Pointer to ARM_Storage_Initialize : Initialize the Storage Interface.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:416</div></div>
298 <div class="ttc" id="agroup__storage__interface__gr_html_aac21d3f798c9fcad415b99cf4157935a"><div class="ttname"><a href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">ARM_STORAGE_BLOCK_ATTRIBUTES::erase_unit</a></div><div class="ttdeci">uint32_t erase_unit</div><div class="ttdoc">Minimum erase size in bytes. The offset of the start of the erase-range should also be aligned with t...</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:75</div></div>
299 <div class="ttc" id="agroup__storage__interface__gr_html_aac7475b53f1356448c7312c39aa61026"><div class="ttname"><a href="group__storage__interface__gr.html#aac7475b53f1356448c7312c39aa61026">ARM_DRIVER_STORAGE::ReadData</a></div><div class="ttdeci">int32_t(* ReadData)(uint64_t addr, void *data, uint32_t size)</div><div class="ttdoc">Pointer to ARM_Storage_ReadData : Read data from Storage.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:419</div></div>
300 <div class="ttc" id="agroup__storage__interface__gr_html_ab3064f39b3c42cd63367312505328f29"><div class="ttname"><a href="group__storage__interface__gr.html#ab3064f39b3c42cd63367312505328f29">ARM_DRIVER_STORAGE::GetCapabilities</a></div><div class="ttdeci">ARM_STORAGE_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdoc">Pointer to ARM_Storage_GetCapabilities : Get driver capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:415</div></div>
301 <div class="ttc" id="agroup__storage__interface__gr_html_ade62c905888479b4f6d078d45cec5830"><div class="ttname"><a href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">ARM_STORAGE_BLOCK::attributes</a></div><div class="ttdeci">ARM_STORAGE_BLOCK_ATTRIBUTES attributes</div><div class="ttdoc">Attributes for this block.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:94</div></div>
302 <div class="ttc" id="agroup__storage__interface__gr_html_af931a8871310b4dad23f0f0b0f623560"><div class="ttname"><a href="group__storage__interface__gr.html#af931a8871310b4dad23f0f0b0f623560">ARM_STORAGE_BLOCK::size</a></div><div class="ttdeci">uint64_t size</div><div class="ttdoc">This is the size of the storage block, in units of bytes. Together with addr, it describes a range [a...</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:92</div></div>
303 <div class="ttc" id="agroup__storage__interface__gr_html_ga3a9277f89946d61c41b22da72e3eef7c"><div class="ttname"><a href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a></div><div class="ttdeci">ARM_STORAGE_OPERATION</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:204</div></div>
304 <div class="ttc" id="agroup__storage__interface__gr_html_structARM__DRIVER__STORAGE"><div class="ttname"><a href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a></div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:413</div></div>
305 <div class="ttc" id="agroup__storage__interface__gr_html_structARM__STORAGE__BLOCK"><div class="ttname"><a href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a></div><div class="ttdoc">A storage block is a range of memory with uniform attributes.</div><div class="ttdef"><b>Definition:</b> Driver_Storage.h:88</div></div>
306 </div><!-- fragment --> </div><!-- contents -->
307 </div><!-- doc-content -->
308 <!-- start footer part -->
309 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
312 <script type="text/javascript">
314 writeFooter.call(this);