1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Driver_Storage.h File Reference</title>
<title>CMSIS-Driver: Driver_Storage.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
 <span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Usage and Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('Driver__Storage_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Driver_Storage.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="memItemLeft" align="right" valign="top">struct  </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>
<tr class="memdesc:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="mdescLeft"> </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>
<tr class="separator:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__BLOCK"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a></td></tr>
<tr class="memdesc:structARM__STORAGE__BLOCK"><td class="mdescLeft"> </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>
<tr class="separator:structARM__STORAGE__BLOCK"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__SECURITY__FEATURES"><td class="memItemLeft" align="right" valign="top">struct  </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>
<tr class="separator:structARM__STORAGE__SECURITY__FEATURES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__INFO"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a></td></tr>
<tr class="separator:structARM__STORAGE__INFO"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a></td></tr>
<tr class="memdesc:structARM__STORAGE__STATUS"><td class="mdescLeft"> </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>
<tr class="separator:structARM__STORAGE__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__STORAGE__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">Storage Driver API Capabilities. <a href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__STORAGE__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__DRIVER__STORAGE"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a></td></tr>
<tr class="separator:structARM__DRIVER__STORAGE"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a2ec531cd9d7d4916f2479efd4ff65b96"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a2ec531cd9d7d4916f2479efd4ff65b96">ARM_STORAGE_API_VERSION</a>   <a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(1,1) /* API version */</td></tr>
<tr class="separator:a2ec531cd9d7d4916f2479efd4ff65b96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21777a6487158bdc1f113996e65ff0bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a21777a6487158bdc1f113996e65ff0bd">_ARM_Driver_Storage_</a>(n)   Driver_Storage##n</td></tr>
<tr class="separator:a21777a6487158bdc1f113996e65ff0bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4ce245f055ef69edd1306ef8fde37cf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a>(n)   <a class="el" href="Driver__Storage_8h.html#a21777a6487158bdc1f113996e65ff0bd">_ARM_Driver_Storage_</a>(n)</td></tr>
<tr class="separator:af4ce245f055ef69edd1306ef8fde37cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8112c1c73ba434c93d19fa1a445c6bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#ab8112c1c73ba434c93d19fa1a445c6bf">ARM_STORAGE_INVALID_OFFSET</a>   (0xFFFFFFFFFFFFFFFFULL)</td></tr>
<tr class="memdesc:ab8112c1c73ba434c93d19fa1a445c6bf"><td class="mdescLeft"> </td><td class="mdescRight">Invalid address (relative to a storage controller's address space). A storage block may never start at this address. <a href="#ab8112c1c73ba434c93d19fa1a445c6bf">More...</a><br/></td></tr>
<tr class="separator:ab8112c1c73ba434c93d19fa1a445c6bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5499f02c78acaccb22d6ecc6be195058"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a5499f02c78acaccb22d6ecc6be195058">ARM_STORAGE_INVALID_ADDRESS</a>   (0xFFFFFFFFUL)</td></tr>
<tr class="memdesc:a5499f02c78acaccb22d6ecc6be195058"><td class="mdescLeft"> </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#a6e1b3f9abb40bb5c70c6141587ee6e6a">ARM_DRIVER_STORAGE::ResolveAddress()</a>. <a href="#a5499f02c78acaccb22d6ecc6be195058">More...</a><br/></td></tr>
<tr class="separator:a5499f02c78acaccb22d6ecc6be195058"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d81999c123625db0e66b8a2c2b0e1b9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a7d81999c123625db0e66b8a2c2b0e1b9">ARM_STORAGE_ERROR_NOT_ERASABLE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
<tr class="memdesc:a7d81999c123625db0e66b8a2c2b0e1b9"><td class="mdescLeft"> </td><td class="mdescRight">Part (or all) of the range provided to Erase() isn't erasable. <a href="#a7d81999c123625db0e66b8a2c2b0e1b9">More...</a><br/></td></tr>
<tr class="separator:a7d81999c123625db0e66b8a2c2b0e1b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a97bf8a1813abdf6fef26f0d777a252"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a5a97bf8a1813abdf6fef26f0d777a252">ARM_STORAGE_ERROR_NOT_PROGRAMMABLE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td></tr>
<tr class="memdesc:a5a97bf8a1813abdf6fef26f0d777a252"><td class="mdescLeft"> </td><td class="mdescRight">Part (or all) of the range provided to ProgramData() isn't programmable. <a href="#a5a97bf8a1813abdf6fef26f0d777a252">More...</a><br/></td></tr>
<tr class="separator:a5a97bf8a1813abdf6fef26f0d777a252"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71f6e5ed403c06a5c99c4882bacdf76e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a71f6e5ed403c06a5c99c4882bacdf76e">ARM_STORAGE_ERROR_PROTECTED</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td></tr>
<tr class="memdesc:a71f6e5ed403c06a5c99c4882bacdf76e"><td class="mdescLeft"> </td><td class="mdescRight">Part (or all) of the range to Erase() or ProgramData() is protected. <a href="#a71f6e5ed403c06a5c99c4882bacdf76e">More...</a><br/></td></tr>
<tr class="separator:a71f6e5ed403c06a5c99c4882bacdf76e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a955b1ca2ea24cfd3a8923731b581cfd4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(BLK)   (((BLK)->addr != <a class="el" href="Driver__Storage_8h.html#ab8112c1c73ba434c93d19fa1a445c6bf">ARM_STORAGE_INVALID_OFFSET</a>) && ((BLK)->size != 0))</td></tr>
<tr class="separator:a955b1ca2ea24cfd3a8923731b581cfd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66cd2a20f084db2d28f6a98cbc503d8a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a66cd2a20f084db2d28f6a98cbc503d8a">ARM_STORAGE_PROGRAMMABILITY_RAM</a>   (0x0)</td></tr>
<tr class="memdesc:a66cd2a20f084db2d28f6a98cbc503d8a"><td class="mdescLeft"> </td><td class="mdescRight">Values for encoding storage memory-types with respect to programmability. <a href="#a66cd2a20f084db2d28f6a98cbc503d8a">More...</a><br/></td></tr>
<tr class="separator:a66cd2a20f084db2d28f6a98cbc503d8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af232495db19beb7025aebc6e3f9e7553"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#af232495db19beb7025aebc6e3f9e7553">ARM_STORAGE_PROGRAMMABILITY_ROM</a>   (0x1)</td></tr>
<tr class="memdesc:af232495db19beb7025aebc6e3f9e7553"><td class="mdescLeft"> </td><td class="mdescRight">Read-only memory. <a href="#af232495db19beb7025aebc6e3f9e7553">More...</a><br/></td></tr>
<tr class="separator:af232495db19beb7025aebc6e3f9e7553"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a373cda87e59c51b2a04f46f4d31d5dd8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a373cda87e59c51b2a04f46f4d31d5dd8">ARM_STORAGE_PROGRAMMABILITY_WORM</a>   (0x2)</td></tr>
<tr class="memdesc:a373cda87e59c51b2a04f46f4d31d5dd8"><td class="mdescLeft"> </td><td class="mdescRight">write-once-read-only-memory (WORM). <a href="#a373cda87e59c51b2a04f46f4d31d5dd8">More...</a><br/></td></tr>
<tr class="separator:a373cda87e59c51b2a04f46f4d31d5dd8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08670c9b9270eba2e030d90c4af9317c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a08670c9b9270eba2e030d90c4af9317c">ARM_STORAGE_PROGRAMMABILITY_ERASABLE</a>   (0x3)</td></tr>
<tr class="memdesc:a08670c9b9270eba2e030d90c4af9317c"><td class="mdescLeft"> </td><td class="mdescRight">re-programmable based on erase. Supports multiple writes. <a href="#a08670c9b9270eba2e030d90c4af9317c">More...</a><br/></td></tr>
<tr class="separator:a08670c9b9270eba2e030d90c4af9317c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb918a33a4b8655321c45dfb99b86339"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#afb918a33a4b8655321c45dfb99b86339">ARM_RETENTION_WHILE_DEVICE_ACTIVE</a>   (0x0)</td></tr>
<tr class="memdesc:afb918a33a4b8655321c45dfb99b86339"><td class="mdescLeft"> </td><td class="mdescRight">Data is retained only during device activity. <a href="#afb918a33a4b8655321c45dfb99b86339">More...</a><br/></td></tr>
<tr class="separator:afb918a33a4b8655321c45dfb99b86339"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42cdcdcda35d29552ed4558542770dbe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a42cdcdcda35d29552ed4558542770dbe">ARM_RETENTION_ACROSS_SLEEP</a>   (0x1)</td></tr>
<tr class="memdesc:a42cdcdcda35d29552ed4558542770dbe"><td class="mdescLeft"> </td><td class="mdescRight">Data is retained across processor sleep. <a href="#a42cdcdcda35d29552ed4558542770dbe">More...</a><br/></td></tr>
<tr class="separator:a42cdcdcda35d29552ed4558542770dbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd3c172f37d0c13ac5d5c1477837c638"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#acd3c172f37d0c13ac5d5c1477837c638">ARM_RETENTION_ACROSS_DEEP_SLEEP</a>   (0x2)</td></tr>
<tr class="memdesc:acd3c172f37d0c13ac5d5c1477837c638"><td class="mdescLeft"> </td><td class="mdescRight">Data is retained across processor deep-sleep. <a href="#acd3c172f37d0c13ac5d5c1477837c638">More...</a><br/></td></tr>
<tr class="separator:acd3c172f37d0c13ac5d5c1477837c638"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b8e7fc9ce024ef2e7d2efb24793c101"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#a1b8e7fc9ce024ef2e7d2efb24793c101">ARM_RETENTION_BATTERY_BACKED</a>   (0x3)</td></tr>
<tr class="memdesc:a1b8e7fc9ce024ef2e7d2efb24793c101"><td class="mdescLeft"> </td><td class="mdescRight">Data is battery-backed. Device can be powered off. <a href="#a1b8e7fc9ce024ef2e7d2efb24793c101">More...</a><br/></td></tr>
<tr class="separator:a1b8e7fc9ce024ef2e7d2efb24793c101"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec136119f63303cf9309e1d787e02ca3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#aec136119f63303cf9309e1d787e02ca3">ARM_RETENTION_NVM</a>   (0x4)</td></tr>
<tr class="memdesc:aec136119f63303cf9309e1d787e02ca3"><td class="mdescLeft"> </td><td class="mdescRight">Data is retained in non-volatile memory. <a href="#aec136119f63303cf9309e1d787e02ca3">More...</a><br/></td></tr>
<tr class="separator:aec136119f63303cf9309e1d787e02ca3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6f380932e1a8e7802be024a224faf93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Storage_8h.html#ab6f380932e1a8e7802be024a224faf93">ARM_STORAGE_PROGRAM_CYCLES_INFINITE</a>   (0UL)</td></tr>
<tr class="separator:ab6f380932e1a8e7802be024a224faf93"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4b290224fea782e6d2ad06f541b28a98"><td class="memItemLeft" align="right" valign="top">typedef void(* </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>
<tr class="separator:ga4b290224fea782e6d2ad06f541b28a98"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga3a9277f89946d61c41b22da72e3eef7c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> { <br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cac82e2ca0f9b7ec94e24ae56c45f12f8c">ARM_STORAGE_OPERATION_GET_VERSION</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca314621ae4384fef7094d8724d59b65c4">ARM_STORAGE_OPERATION_GET_CAPABILITIES</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971">ARM_STORAGE_OPERATION_INITIALIZE</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cab9488e567ad58b16c5df2637df3902e9">ARM_STORAGE_OPERATION_UNINITIALIZE</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca213a74ac5a692a80f17fd6d8e6565e05">ARM_STORAGE_OPERATION_POWER_CONTROL</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454">ARM_STORAGE_OPERATION_READ_DATA</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0">ARM_STORAGE_OPERATION_PROGRAM_DATA</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75">ARM_STORAGE_OPERATION_ERASE</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca60a0511bd5e32db2a22d3ab2023a601e">ARM_STORAGE_OPERATION_ERASE_ALL</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca7c595cd3c439753efe0a0b17efd7bb7f">ARM_STORAGE_OPERATION_GET_STATUS</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca0fe0ef7c0a9e69d053a0419282248f40">ARM_STORAGE_OPERATION_GET_INFO</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca3292512d0222e4119d0cdf77de1508df">ARM_STORAGE_OPERATION_RESOLVE_ADDRESS</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca9bfab6ee9caa3ace32338d4ef2d856f5">ARM_STORAGE_OPERATION_GET_NEXT_BLOCK</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cac75096931c3d29af1029f25fc44e7523">ARM_STORAGE_OPERATION_GET_BLOCK</a>
<br/>
}</td></tr>
<tr class="separator:ga3a9277f89946d61c41b22da72e3eef7c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__STORAGE__SECURITY__FEATURES" id="structARM__STORAGE__SECURITY__FEATURES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_STORAGE_SECURITY_FEATURES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Device Data Security Protection Features. Applicable mostly to EXTERNAL_NVM. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abbd64eb8edcf2263db5c8ac140dc0448"></a>uint32_t</td>
<td class="fieldname">
acls: 1</td>
<td class="fielddoc">
Protection against internal software attacks using ACLs. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="affe0253b35f41c44ea06ae1e87d91012"></a>uint32_t</td>
<td class="fieldname">
rollback_protection: 1</td>
<td class="fielddoc">
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>
<tr><td class="fieldtype">
<a class="anchor" id="ac6f64a064cb84e29a631706586d6000c"></a>uint32_t</td>
<td class="fieldname">
tamper_proof: 1</td>
<td class="fielddoc">
Tamper-proof memory (will be deleted on tamper-attempts using board level or chip level sensors). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a47dd9737459c9c5ce48f3e8a04995b9a"></a>uint32_t</td>
<td class="fieldname">
internal_flash: 1</td>
<td class="fielddoc">
Internal flash. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aef9bb556c1530f5d648fd57e73b9a105"></a>uint32_t</td>
<td class="fieldname">
reserved1: 12</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1b6a0329dd65f25a0ab22496ab708306"></a>uint32_t</td>
<td class="fieldname">
software_attacks: 1</td>
<td class="fielddoc">
device software (malware running on the device). <p>Encode support for hardening against various classes of attacks. </p>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3981b8fafe1520f11518f2b6e12ef644"></a>uint32_t</td>
<td class="fieldname">
board_level_attacks: 1</td>
<td class="fielddoc">
board level attacks (debug probes, copy protection fuses.) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a19a70a7636956745f75a1f1bbb9cc478"></a>uint32_t</td>
<td class="fieldname">
chip_level_attacks: 1</td>
<td class="fielddoc">
chip level attacks (tamper-protection). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acd90f369373d7551174a981c4083fef1"></a>uint32_t</td>
<td class="fieldname">
side_channel_attacks: 1</td>
<td class="fielddoc">
side channel attacks. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae673672452e4741c4ab7c174af880a87"></a>uint32_t</td>
<td class="fieldname">
reserved2: 12</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a2ec531cd9d7d4916f2479efd4ff65b96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_API_VERSION   <a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(1,1) /* API version */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a21777a6487158bdc1f113996e65ff0bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _ARM_Driver_Storage_</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   Driver_Storage##n</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af4ce245f055ef69edd1306ef8fde37cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_Driver_Storage_</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   <a class="el" href="Driver__Storage_8h.html#a21777a6487158bdc1f113996e65ff0bd">_ARM_Driver_Storage_</a>(n)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab8112c1c73ba434c93d19fa1a445c6bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_INVALID_OFFSET   (0xFFFFFFFFFFFFFFFFULL)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalid address (relative to a storage controller's address space). A storage block may never start at this address. </p>
</div>
</div>
<a class="anchor" id="a5499f02c78acaccb22d6ecc6be195058"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_INVALID_ADDRESS   (0xFFFFFFFFUL)</td>
</tr>
</table>
</div><div class="memdoc">
<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#a6e1b3f9abb40bb5c70c6141587ee6e6a">ARM_DRIVER_STORAGE::ResolveAddress()</a>. </p>
</div>
</div>
<a class="anchor" id="a7d81999c123625db0e66b8a2c2b0e1b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_ERROR_NOT_ERASABLE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Part (or all) of the range provided to Erase() isn't erasable. </p>
</div>
</div>
<a class="anchor" id="a5a97bf8a1813abdf6fef26f0d777a252"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_ERROR_NOT_PROGRAMMABLE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Part (or all) of the range provided to ProgramData() isn't programmable. </p>
</div>
</div>
<a class="anchor" id="a71f6e5ed403c06a5c99c4882bacdf76e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_ERROR_PROTECTED   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Part (or all) of the range to Erase() or ProgramData() is protected. </p>
</div>
</div>
<a class="anchor" id="a955b1ca2ea24cfd3a8923731b581cfd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_VALID_BLOCK</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">BLK</td><td>)</td>
<td>   (((BLK)->addr != <a class="el" href="Driver__Storage_8h.html#ab8112c1c73ba434c93d19fa1a445c6bf">ARM_STORAGE_INVALID_OFFSET</a>) && ((BLK)->size != 0))</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a66cd2a20f084db2d28f6a98cbc503d8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_RAM   (0x0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Values for encoding storage memory-types with respect to programmability. </p>
<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>
</div>
</div>
<a class="anchor" id="af232495db19beb7025aebc6e3f9e7553"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_ROM   (0x1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read-only memory. </p>
</div>
</div>
<a class="anchor" id="a373cda87e59c51b2a04f46f4d31d5dd8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_WORM   (0x2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>write-once-read-only-memory (WORM). </p>
</div>
</div>
<a class="anchor" id="a08670c9b9270eba2e030d90c4af9317c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_PROGRAMMABILITY_ERASABLE   (0x3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>re-programmable based on erase. Supports multiple writes. </p>
</div>
</div>
<a class="anchor" id="afb918a33a4b8655321c45dfb99b86339"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_RETENTION_WHILE_DEVICE_ACTIVE   (0x0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is retained only during device activity. </p>
<p>Values for encoding data-retention levels for storage blocks.</p>
<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>
</div>
</div>
<a class="anchor" id="a42cdcdcda35d29552ed4558542770dbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_RETENTION_ACROSS_SLEEP   (0x1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is retained across processor sleep. </p>
</div>
</div>
<a class="anchor" id="acd3c172f37d0c13ac5d5c1477837c638"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_RETENTION_ACROSS_DEEP_SLEEP   (0x2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is retained across processor deep-sleep. </p>
</div>
</div>
<a class="anchor" id="a1b8e7fc9ce024ef2e7d2efb24793c101"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_RETENTION_BATTERY_BACKED   (0x3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is battery-backed. Device can be powered off. </p>
</div>
</div>
<a class="anchor" id="aec136119f63303cf9309e1d787e02ca3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_RETENTION_NVM   (0x4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data is retained in non-volatile memory. </p>
</div>
</div>
<a class="anchor" id="ab6f380932e1a8e7802be024a224faf93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_STORAGE_PROGRAM_CYCLES_INFINITE   (0UL)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Infinite or unknown endurance for reprogramming. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<li class="footer">Generated on Wed Jul 10 2019 15:20:30 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
|
