3439 lines
238 KiB
HTML
3439 lines
238 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Kinetis Bootloader: C90TFS Flash Driver</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.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/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</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: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Kinetis Bootloader
|
|
 <span id="projectnumber">2.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Common bootloader for Kinetis devices</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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>Introduction</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="modules.html"><span>Modules</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('group__flash__driver.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)">
|
|
</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="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">C90TFS Flash Driver</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for C90TFS Flash Driver:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<center><table><tr><td><div class="center"><iframe scrolling="no" frameborder="0" src="group__flash__driver.svg" width="442" height="68"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
</td></tr></table></center>
|
|
</div>
|
|
<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:structflash__execute__in__ram__function__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#structflash__execute__in__ram__function__config__t">flash_execute_in_ram_function_config_t</a></td></tr>
|
|
<tr class="memdesc:structflash__execute__in__ram__function__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Flash execute-in-ram function information. <a href="group__flash__driver.html#structflash__execute__in__ram__function__config__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structflash__execute__in__ram__function__config__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structflash__swap__state__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#structflash__swap__state__config__t">flash_swap_state_config_t</a></td></tr>
|
|
<tr class="memdesc:structflash__swap__state__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Flash Swap information. <a href="group__flash__driver.html#structflash__swap__state__config__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structflash__swap__state__config__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structflash__swap__ifr__field__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#structflash__swap__ifr__field__config__t">flash_swap_ifr_field_config_t</a></td></tr>
|
|
<tr class="memdesc:structflash__swap__ifr__field__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Flash Swap IFR fields. <a href="group__flash__driver.html#structflash__swap__ifr__field__config__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structflash__swap__ifr__field__config__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:unionflash__swap__ifr__field__data__t"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#unionflash__swap__ifr__field__data__t">flash_swap_ifr_field_data_t</a></td></tr>
|
|
<tr class="memdesc:unionflash__swap__ifr__field__data__t"><td class="mdescLeft"> </td><td class="mdescRight">Flash Swap IFR field data. <a href="group__flash__driver.html#unionflash__swap__ifr__field__data__t">More...</a><br /></td></tr>
|
|
<tr class="separator:unionflash__swap__ifr__field__data__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structflash__operation__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#structflash__operation__config__t">flash_operation_config_t</a></td></tr>
|
|
<tr class="memdesc:structflash__operation__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Active flash information for current operation. <a href="group__flash__driver.html#structflash__operation__config__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structflash__operation__config__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structflash__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a></td></tr>
|
|
<tr class="memdesc:structflash__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Flash driver state information. <a href="group__flash__driver.html#structflash__config__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structflash__config__t"><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:ga67c22466713ef09903b07a56e1c2a050"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga67c22466713ef09903b07a56e1c2a050"></a>
|
|
typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga67c22466713ef09903b07a56e1c2a050">flash_callback_t</a>) (void)</td></tr>
|
|
<tr class="memdesc:ga67c22466713ef09903b07a56e1c2a050"><td class="mdescLeft"> </td><td class="mdescRight">callback type used for pflash block <br /></td></tr>
|
|
<tr class="separator:ga67c22466713ef09903b07a56e1c2a050"><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:ga2105f5de393a06479e62141dab8dd3fc"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fca9071189977c1f756d42d710288cfb6be">kFLASH_MarginValueNormal</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fca1c1271a7e38d4e062e202730f6a5ebed">kFLASH_MarginValueUser</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fcadc331ba6a0e6de26eb5c1e755136608d">kFLASH_MarginValueFactory</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fcaa297e7607bb0ccefbe181d1f1d828deb">kFLASH_MarginValueInvalid</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fca9071189977c1f756d42d710288cfb6be">kFLASH_MarginValueNormal</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fca1c1271a7e38d4e062e202730f6a5ebed">kFLASH_MarginValueUser</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fcadc331ba6a0e6de26eb5c1e755136608d">kFLASH_MarginValueFactory</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2105f5de393a06479e62141dab8dd3fcaa297e7607bb0ccefbe181d1f1d828deb">kFLASH_MarginValueInvalid</a>
|
|
<br />
|
|
}<tr class="memdesc:ga2105f5de393a06479e62141dab8dd3fc"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for supported flash margin levels. <a href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga2105f5de393a06479e62141dab8dd3fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga00b3eb2666116e617f6e45a10218f6a9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga00b3eb2666116e617f6e45a10218f6a9">flash_security_state_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga00b3eb2666116e617f6e45a10218f6a9ad48939abe53a98896541d2ee1e7bf752">kFLASH_SecurityStateNotSecure</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga00b3eb2666116e617f6e45a10218f6a9a4c4da1c4c06977cc999930f75f38ecc7">kFLASH_SecurityStateBackdoorEnabled</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga00b3eb2666116e617f6e45a10218f6a9a5c7043f3abad4e8d65f12179c4636dc2">kFLASH_SecurityStateBackdoorDisabled</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga00b3eb2666116e617f6e45a10218f6a9ad48939abe53a98896541d2ee1e7bf752">kFLASH_SecurityStateNotSecure</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga00b3eb2666116e617f6e45a10218f6a9a4c4da1c4c06977cc999930f75f38ecc7">kFLASH_SecurityStateBackdoorEnabled</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga00b3eb2666116e617f6e45a10218f6a9a5c7043f3abad4e8d65f12179c4636dc2">kFLASH_SecurityStateBackdoorDisabled</a>
|
|
<br />
|
|
}<tr class="memdesc:ga00b3eb2666116e617f6e45a10218f6a9"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the three possible flash security states. <a href="group__flash__driver.html#ga00b3eb2666116e617f6e45a10218f6a9">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga00b3eb2666116e617f6e45a10218f6a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9378245c649eebea9451367d6b8f9ce2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga9378245c649eebea9451367d6b8f9ce2">flash_protection_state_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga9378245c649eebea9451367d6b8f9ce2ace4690203221c04a4e00de6278a59f1e">kFLASH_ProtectionStateUnprotected</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga9378245c649eebea9451367d6b8f9ce2a2c73fefaf7e6e3a065744be1aab71149">kFLASH_ProtectionStateProtected</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga9378245c649eebea9451367d6b8f9ce2aca2ca63f9c507495e7b0f510b69497bb">kFLASH_ProtectionStateMixed</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga9378245c649eebea9451367d6b8f9ce2ace4690203221c04a4e00de6278a59f1e">kFLASH_ProtectionStateUnprotected</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga9378245c649eebea9451367d6b8f9ce2a2c73fefaf7e6e3a065744be1aab71149">kFLASH_ProtectionStateProtected</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga9378245c649eebea9451367d6b8f9ce2aca2ca63f9c507495e7b0f510b69497bb">kFLASH_ProtectionStateMixed</a>
|
|
<br />
|
|
}<tr class="memdesc:ga9378245c649eebea9451367d6b8f9ce2"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the three possible flash protection levels. <a href="group__flash__driver.html#ga9378245c649eebea9451367d6b8f9ce2">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga9378245c649eebea9451367d6b8f9ce2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad38961e5692f64548dbf84d652b9ccde"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gad38961e5692f64548dbf84d652b9ccde">flash_execute_only_access_state_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggad38961e5692f64548dbf84d652b9ccdea38101c1bc20b060f8fa2f5ac43a04f66">kFLASH_AccessStateUnLimited</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggad38961e5692f64548dbf84d652b9ccdeae275896979de1eca572ae3c7449148f1">kFLASH_AccessStateExecuteOnly</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggad38961e5692f64548dbf84d652b9ccdea0b22f0d8b1f43e064f04d12659293c38">kFLASH_AccessStateMixed</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggad38961e5692f64548dbf84d652b9ccdea38101c1bc20b060f8fa2f5ac43a04f66">kFLASH_AccessStateUnLimited</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggad38961e5692f64548dbf84d652b9ccdeae275896979de1eca572ae3c7449148f1">kFLASH_AccessStateExecuteOnly</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggad38961e5692f64548dbf84d652b9ccdea0b22f0d8b1f43e064f04d12659293c38">kFLASH_AccessStateMixed</a>
|
|
<br />
|
|
}<tr class="memdesc:gad38961e5692f64548dbf84d652b9ccde"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the three possible flash execute access levels. <a href="group__flash__driver.html#gad38961e5692f64548dbf84d652b9ccde">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gad38961e5692f64548dbf84d652b9ccde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7b6766fe08a63cf92a5e2a90dd6d010f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga7b6766fe08a63cf92a5e2a90dd6d010f">flash_property_tag_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010faa6c433411ecb4bfea9d74504e266e219">kFLASH_PropertyPflashSectorSize</a> = 0x00U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa68caa1558315b7704b08d85c42869eb5">kFLASH_PropertyPflashTotalSize</a> = 0x01U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fad8c3b85ca1dc8fc5ef03e1954aef873e">kFLASH_PropertyPflashBlockSize</a> = 0x02U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fabb40541593520b9c1a87648a26e81957">kFLASH_PropertyPflashBlockCount</a> = 0x03U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa0159abfba4e6ca47c70a89ea2fc24ab9">kFLASH_PropertyPflashBlockBaseAddr</a> = 0x04U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa82ed61ee8b06813070ded3e06675e07c">kFLASH_PropertyPflashFacSupport</a> = 0x05U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fab1ff313c13a7c4c9794c97d894c784d1">kFLASH_PropertyPflashAccessSegmentSize</a> = 0x06U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fad73e31438b9bf8ea5d95e4807371e414">kFLASH_PropertyPflashAccessSegmentCount</a> = 0x07U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa9ca389a1c885600feb6900b0d34f7c14">kFLASH_PropertyFlexRamBlockBaseAddr</a> = 0x08U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa062cdf2d78e722b71b6037eb6f60cbf4">kFLASH_PropertyFlexRamTotalSize</a> = 0x09U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa51190ea2cbee3594588931079b0c7fc6">kFLASH_PropertyDflashSectorSize</a> = 0x10U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa4a988286f54bb8572af9487870bbb32c">kFLASH_PropertyDflashTotalSize</a> = 0x11U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa4229b9f10be15a5169dc4b6e011536e3">kFLASH_PropertyDflashBlockSize</a> = 0x12U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fad6ce4a3ff01396a5d61fdba8bbd2bb9d">kFLASH_PropertyDflashBlockCount</a> = 0x13U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa8ec2b47abac2083b760dd47d9bebcde0">kFLASH_PropertyDflashBlockBaseAddr</a> = 0x14U,
|
|
<br />
|
|
  <b>kFLASH_PropertyEepromTotalSize</b> = 0x15U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010faa6c433411ecb4bfea9d74504e266e219">kFLASH_PropertyPflashSectorSize</a> = 0x00U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa68caa1558315b7704b08d85c42869eb5">kFLASH_PropertyPflashTotalSize</a> = 0x01U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fad8c3b85ca1dc8fc5ef03e1954aef873e">kFLASH_PropertyPflashBlockSize</a> = 0x02U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fabb40541593520b9c1a87648a26e81957">kFLASH_PropertyPflashBlockCount</a> = 0x03U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa0159abfba4e6ca47c70a89ea2fc24ab9">kFLASH_PropertyPflashBlockBaseAddr</a> = 0x04U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa82ed61ee8b06813070ded3e06675e07c">kFLASH_PropertyPflashFacSupport</a> = 0x05U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fab1ff313c13a7c4c9794c97d894c784d1">kFLASH_PropertyPflashAccessSegmentSize</a> = 0x06U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fad73e31438b9bf8ea5d95e4807371e414">kFLASH_PropertyPflashAccessSegmentCount</a> = 0x07U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa9ca389a1c885600feb6900b0d34f7c14">kFLASH_PropertyFlexRamBlockBaseAddr</a> = 0x08U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa062cdf2d78e722b71b6037eb6f60cbf4">kFLASH_PropertyFlexRamTotalSize</a> = 0x09U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa51190ea2cbee3594588931079b0c7fc6">kFLASH_PropertyDflashSectorSize</a> = 0x10U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa4a988286f54bb8572af9487870bbb32c">kFLASH_PropertyDflashTotalSize</a> = 0x11U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa4229b9f10be15a5169dc4b6e011536e3">kFLASH_PropertyDflashBlockSize</a> = 0x12U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fad6ce4a3ff01396a5d61fdba8bbd2bb9d">kFLASH_PropertyDflashBlockCount</a> = 0x13U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fa8ec2b47abac2083b760dd47d9bebcde0">kFLASH_PropertyDflashBlockBaseAddr</a> = 0x14U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fab3520a58d0f8494d3d7e987d30cee6ed">kFLASH_PropertyEepromTotalSize</a> = 0x15U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga7b6766fe08a63cf92a5e2a90dd6d010fab97130fd3296506b436e5ded0313ce33">kFLASH_PropertyVersion</a> = 0x20U
|
|
<br />
|
|
}<tr class="memdesc:ga7b6766fe08a63cf92a5e2a90dd6d010f"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for various flash properties. <a href="group__flash__driver.html#ga7b6766fe08a63cf92a5e2a90dd6d010f">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga7b6766fe08a63cf92a5e2a90dd6d010f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae76bb8924742f0483f66c4d3917bb31e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gae76bb8924742f0483f66c4d3917bb31e">_flash_execute_in_ram_function_constants</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggae76bb8924742f0483f66c4d3917bb31ea44c47300abac0defba3c515df8d531cd">kFLASH_ExecuteInRamFunctionMaxSize</a> = 64U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggae76bb8924742f0483f66c4d3917bb31ea2e18b9dc426a3146df8f959c1c874ce0">kFLASH_ExecuteInRamFunctionTotalNum</a> = 2U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggae76bb8924742f0483f66c4d3917bb31ea44c47300abac0defba3c515df8d531cd">kFLASH_ExecuteInRamFunctionMaxSize</a> = 64U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggae76bb8924742f0483f66c4d3917bb31ea2e18b9dc426a3146df8f959c1c874ce0">kFLASH_ExecuteInRamFunctionTotalNum</a> = 2U
|
|
<br />
|
|
}<tr class="memdesc:gae76bb8924742f0483f66c4d3917bb31e"><td class="mdescLeft"> </td><td class="mdescRight">Constants for execute-in-ram flash function. <a href="group__flash__driver.html#gae76bb8924742f0483f66c4d3917bb31e">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gae76bb8924742f0483f66c4d3917bb31e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga70d45ebc64d50e9868f7016c8a417c51"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga70d45ebc64d50e9868f7016c8a417c51">flash_read_resource_option_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga70d45ebc64d50e9868f7016c8a417c51a80bd0a5fe1432c2a97a3bd8e4a5320ab">kFLASH_ResourceOptionFlashIfr</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga70d45ebc64d50e9868f7016c8a417c51a900b2f3a7dbd7260d7883fe9fa816c6d">kFLASH_ResourceOptionVersionId</a> = 0x01U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga70d45ebc64d50e9868f7016c8a417c51a80bd0a5fe1432c2a97a3bd8e4a5320ab">kFLASH_ResourceOptionFlashIfr</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga70d45ebc64d50e9868f7016c8a417c51a900b2f3a7dbd7260d7883fe9fa816c6d">kFLASH_ResourceOptionVersionId</a> = 0x01U
|
|
<br />
|
|
}<tr class="memdesc:ga70d45ebc64d50e9868f7016c8a417c51"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the two possible options of flash read resource command. <a href="group__flash__driver.html#ga70d45ebc64d50e9868f7016c8a417c51">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga70d45ebc64d50e9868f7016c8a417c51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4fcca89ee32fbd2497a2ee1f8425a0ea"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga4fcca89ee32fbd2497a2ee1f8425a0ea">_flash_read_resource_range</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaaad7a834987d4e5be188a6b47d23b4090">kFLASH_ResourceRangePflashIfrSizeInBytes</a> = 1024U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaab6daa4d8f775afeaf1a63908ebc7cd97">kFLASH_ResourceRangeVersionIdSizeInBytes</a> = 8U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa4cd6d6f08778ae4733d7e705ae61aa49">kFLASH_ResourceRangeVersionIdStart</a> = 0x08U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa67d0ba0165e2c13ad736e78da17146a3">kFLASH_ResourceRangeVersionIdEnd</a> = 0x0FU,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb">kFLASH_ResourceRangePflashSwapIfrStart</a> = 0x40000U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa15a530256f7e19bff28a572cf1d1b53d">kFLASH_ResourceRangePflashSwapIfrEnd</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaaad7a834987d4e5be188a6b47d23b4090">kFLASH_ResourceRangePflashIfrSizeInBytes</a> = 1024U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaab6daa4d8f775afeaf1a63908ebc7cd97">kFLASH_ResourceRangeVersionIdSizeInBytes</a> = 8U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa4cd6d6f08778ae4733d7e705ae61aa49">kFLASH_ResourceRangeVersionIdStart</a> = 0x08U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa67d0ba0165e2c13ad736e78da17146a3">kFLASH_ResourceRangeVersionIdEnd</a> = 0x0FU,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb">kFLASH_ResourceRangePflashSwapIfrStart</a> = 0x40000U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb">kFLASH_ResourceRangePflashSwapIfrStart</a> = 0x40000U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb">kFLASH_ResourceRangePflashSwapIfrStart</a> = 0x40000U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb">kFLASH_ResourceRangePflashSwapIfrStart</a> = 0x40000U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa15a530256f7e19bff28a572cf1d1b53d">kFLASH_ResourceRangePflashSwapIfrEnd</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaaab7328ad8167382b6f954439416d819a">kFLASH_ResourceRangeDflashIfrStart</a> = 0x800000U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga4fcca89ee32fbd2497a2ee1f8425a0eaa1186524c65263c078d37ea5156af2d9b">kFLASH_ResourceRangeDflashIfrEnd</a> = 0x8003FFU
|
|
<br />
|
|
}<tr class="memdesc:ga4fcca89ee32fbd2497a2ee1f8425a0ea"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the range of special-purpose flash resource. <a href="group__flash__driver.html#ga4fcca89ee32fbd2497a2ee1f8425a0ea">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga4fcca89ee32fbd2497a2ee1f8425a0ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3812bab3ef6aacfbe889b1a81e25c76d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga3812bab3ef6aacfbe889b1a81e25c76d">flash_flexram_function_option_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#gga3812bab3ef6aacfbe889b1a81e25c76dae2deac28c06aeebad0a1449006055042">kFLASH_FlexramFunctionOptionAvailableAsRam</a> = 0xFFU,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga3812bab3ef6aacfbe889b1a81e25c76daf87c9b48af2e57f1b390934473f3a05d">kFLASH_FlexramFunctionOptionAvailableForEeprom</a> = 0x00U
|
|
<br />
|
|
}<tr class="memdesc:ga3812bab3ef6aacfbe889b1a81e25c76d"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the two possilbe options of set flexram function command. <a href="group__flash__driver.html#ga3812bab3ef6aacfbe889b1a81e25c76d">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga3812bab3ef6aacfbe889b1a81e25c76d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabcfe38ad71d8e03bac192b4f3d217fa7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabcfe38ad71d8e03bac192b4f3d217fa7"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gabcfe38ad71d8e03bac192b4f3d217fa7">_flash_acceleration_ram_property</a> { <b>kFLASH_AccelerationRamSize</b> = 0x400U
|
|
}<tr class="memdesc:gabcfe38ad71d8e03bac192b4f3d217fa7"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for acceleration ram property. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gabcfe38ad71d8e03bac192b4f3d217fa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga799e1be1686e21a35457d674fc746728"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga799e1be1686e21a35457d674fc746728">flash_swap_function_option_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#gga799e1be1686e21a35457d674fc746728ac633995521391aa0d8c50ec6f0d9b51d">kFLASH_SwapFunctionOptionEnable</a> = 0x00U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga799e1be1686e21a35457d674fc746728a3e7f48ea919486120b3e12f045f70856">kFLASH_SwapFunctionOptionDisable</a> = 0x01U
|
|
<br />
|
|
}<tr class="memdesc:ga799e1be1686e21a35457d674fc746728"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the possible options of Swap function. <a href="group__flash__driver.html#ga799e1be1686e21a35457d674fc746728">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga799e1be1686e21a35457d674fc746728"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac4c39d832a41bddec3f2953df588adeb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gac4c39d832a41bddec3f2953df588adeb">flash_swap_control_option_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#ggac4c39d832a41bddec3f2953df588adeba7ff8249d311051d01d7d82cf8d5c697c">kFLASH_SwapControlOptionIntializeSystem</a> = 0x01U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggac4c39d832a41bddec3f2953df588adeba1f12897efebbc3eb661baa12d9d68f3a">kFLASH_SwapControlOptionSetInUpdateState</a> = 0x02U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggac4c39d832a41bddec3f2953df588adebae6b96fa981926920018e86905146c15d">kFLASH_SwapControlOptionSetInCompleteState</a> = 0x04U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggac4c39d832a41bddec3f2953df588adebacba9f04f370da73a53f123a5ff7b78a7">kFLASH_SwapControlOptionReportStatus</a> = 0x08U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggac4c39d832a41bddec3f2953df588adeba871265364e63fa96388c0434e7528697">kFLASH_SwapControlOptionDisableSystem</a> = 0x10U
|
|
<br />
|
|
}<tr class="memdesc:gac4c39d832a41bddec3f2953df588adeb"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the possible options of Swap Control commands. <a href="group__flash__driver.html#gac4c39d832a41bddec3f2953df588adeb">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gac4c39d832a41bddec3f2953df588adeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabbbbdf78a0245100d29ad83bd6f0d141"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gabbbbdf78a0245100d29ad83bd6f0d141">flash_swap_state_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#ggabbbbdf78a0245100d29ad83bd6f0d141acb872b5aad441b829eacd3a2f62f1e5b">kFLASH_SwapStateUninitialized</a> = 0x00U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggabbbbdf78a0245100d29ad83bd6f0d141a969d0802a8bcb2eef29797f9b709c219">kFLASH_SwapStateReady</a> = 0x01U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggabbbbdf78a0245100d29ad83bd6f0d141aef30cba32280c7666c4e4432c12b477b">kFLASH_SwapStateUpdate</a> = 0x02U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggabbbbdf78a0245100d29ad83bd6f0d141af2fecdb89c4ca80ba7a4550d529af174">kFLASH_SwapStateUpdateErased</a> = 0x03U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggabbbbdf78a0245100d29ad83bd6f0d141a34e8e14bf7d3915ab4b10331b9e964f6">kFLASH_SwapStateComplete</a> = 0x04U,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggabbbbdf78a0245100d29ad83bd6f0d141aac58ee8947ef084ac3b1be621ab08328">kFLASH_SwapStateDisabled</a> = 0x05U
|
|
<br />
|
|
}<tr class="memdesc:gabbbbdf78a0245100d29ad83bd6f0d141"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the possible flash swap status. <a href="group__flash__driver.html#gabbbbdf78a0245100d29ad83bd6f0d141">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gabbbbdf78a0245100d29ad83bd6f0d141"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafa125571c739fe8d5c41cfe9402cb063"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gafa125571c739fe8d5c41cfe9402cb063">flash_swap_block_status_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#ggafa125571c739fe8d5c41cfe9402cb063a8ddfa234a76fbc404ff79bf6f39cc14a">kFLASH_SwapBlockStatusLowerHalfProgramBlocksAtZero</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#ggafa125571c739fe8d5c41cfe9402cb063a3068333e63702a882c3638d4eeee56c6">kFLASH_SwapBlockStatusUpperHalfProgramBlocksAtZero</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:gafa125571c739fe8d5c41cfe9402cb063"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga46a69f0afbc5ceaae3748429aa2d7901"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga46a69f0afbc5ceaae3748429aa2d7901">flash_partition_flexram_load_option_t</a> { <br />
|
|
  <a class="el" href="group__flash__driver.html#gga46a69f0afbc5ceaae3748429aa2d7901aac927695cefaca6a14f393c9e51cb162">kFLASH_PartitionFlexramLoadOptionLoadedWithValidEepromData</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver.html#gga46a69f0afbc5ceaae3748429aa2d7901a90872ebb415ec51f16de8e798f95c0d3">kFLASH_PartitionFlexramLoadOptionNotLoaded</a> = 0x01U
|
|
<br />
|
|
}<tr class="memdesc:ga46a69f0afbc5ceaae3748429aa2d7901"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for FlexRAM load during reset option. <a href="group__flash__driver.html#ga46a69f0afbc5ceaae3748429aa2d7901">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga46a69f0afbc5ceaae3748429aa2d7901"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Flash version</h2></td></tr>
|
|
<tr class="memitem:ga2cdaf5b1f6b03013e2f0cf2c6d26adae"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga2cdaf5b1f6b03013e2f0cf2c6d26adae">_flash_driver_version_constants</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaea599e22575bcd9a7aa32a1c7b43591f0b">kFLASH_DriverVersionName</a> = 'F',
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaea4735add39aa49ca212b24fbef9fcb952">kFLASH_DriverVersionMajor</a> = 2,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaeab54b9127ada5f04373dd17edc4e005f4">kFLASH_DriverVersionMinor</a> = 1,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaea1a3661a27450809aa90f49d6b01781b3">kFLASH_DriverVersionBugfix</a> = 0,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaea599e22575bcd9a7aa32a1c7b43591f0b">kFLASH_DriverVersionName</a> = 'F',
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaea4735add39aa49ca212b24fbef9fcb952">kFLASH_DriverVersionMajor</a> = 2,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaeab54b9127ada5f04373dd17edc4e005f4">kFLASH_DriverVersionMinor</a> = 1,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga2cdaf5b1f6b03013e2f0cf2c6d26adaea1a3661a27450809aa90f49d6b01781b3">kFLASH_DriverVersionBugfix</a> = 0
|
|
<br />
|
|
}<tr class="memdesc:ga2cdaf5b1f6b03013e2f0cf2c6d26adae"><td class="mdescLeft"> </td><td class="mdescRight">FLASH driver version for ROM. <a href="group__flash__driver.html#ga2cdaf5b1f6b03013e2f0cf2c6d26adae">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga2cdaf5b1f6b03013e2f0cf2c6d26adae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Flash status</h2></td></tr>
|
|
<tr class="memitem:gaa4639fd4d4503c0dec9925f749d308b2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gaa4639fd4d4503c0dec9925f749d308b2">_flash_status</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a> = MAKE_STATUS(kStatusGroupGeneric, 0),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a> = MAKE_STATUS(kStatusGroupGeneric, 4),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a6735801bd1fbd61f7d96a07c2c2f9a76">kStatus_FLASH_SizeError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 0),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 2),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a0ac435d9c4aa24ccb8ab983de1979780">kStatus_FLASH_UnknownProperty</a> = MAKE_STATUS(kStatusGroupFlashDriver, 6),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92">kStatus_FLASH_EraseKeyError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 7),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aa3ace4bf14ea333efd6189b8ddf47aca">kStatus_FLASH_RegionExecuteOnly</a> = MAKE_STATUS(kStatusGroupFlashDriver, 8),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53">kStatus_FLASH_PartitionStatusUpdateFailure</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab8b9f6c116209a00338a430e741a1a40">kStatus_FLASH_SetFlexramAsEepromError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a128d2d13d9674d46619a5c698bc7a7b9">kStatus_FLASH_RecoverFlexramAsRamError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2abf40cb19a8c5af9880414ef5f9be1c6d">kStatus_FLASH_SetFlexramAsRamError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 13),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aa7652faf3cc559ccda57f8aea502045b">kStatus_FLASH_RecoverFlexramAsEepromError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25">kStatus_FLASH_CommandNotSupported</a> = MAKE_STATUS(kStatusGroupFlashDriver, 15),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a5e0c3747a74458caefc231b995f09679">kStatus_FLASH_SwapSystemNotInUninitialized</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aefaeaf1008f0361fb3ff2d051720cd82">kStatus_FLASH_SwapIndicatorAddressError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a> = MAKE_STATUS(kStatusGroupGeneric, 0),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a> = MAKE_STATUS(kStatusGroupGeneric, 4),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a6735801bd1fbd61f7d96a07c2c2f9a76">kStatus_FLASH_SizeError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 0),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 2),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a0ac435d9c4aa24ccb8ab983de1979780">kStatus_FLASH_UnknownProperty</a> = MAKE_STATUS(kStatusGroupFlashDriver, 6),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92">kStatus_FLASH_EraseKeyError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 7),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aa3ace4bf14ea333efd6189b8ddf47aca">kStatus_FLASH_RegionExecuteOnly</a> = MAKE_STATUS(kStatusGroupFlashDriver, 8),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53">kStatus_FLASH_PartitionStatusUpdateFailure</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab8b9f6c116209a00338a430e741a1a40">kStatus_FLASH_SetFlexramAsEepromError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a128d2d13d9674d46619a5c698bc7a7b9">kStatus_FLASH_RecoverFlexramAsRamError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2abf40cb19a8c5af9880414ef5f9be1c6d">kStatus_FLASH_SetFlexramAsRamError</a> = MAKE_STATUS(kStatusGroupFlashDriver, 13),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aa7652faf3cc559ccda57f8aea502045b">kStatus_FLASH_RecoverFlexramAsEepromError</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25">kStatus_FLASH_CommandNotSupported</a> = MAKE_STATUS(kStatusGroupFlashDriver, 15),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a5e0c3747a74458caefc231b995f09679">kStatus_FLASH_SwapSystemNotInUninitialized</a>,
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aefaeaf1008f0361fb3ff2d051720cd82">kStatus_FLASH_SwapIndicatorAddressError</a>
|
|
<br />
|
|
}<tr class="memdesc:gaa4639fd4d4503c0dec9925f749d308b2"><td class="mdescLeft"> </td><td class="mdescRight">Flash driver status codes. <a href="group__flash__driver.html#gaa4639fd4d4503c0dec9925f749d308b2">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gaa4639fd4d4503c0dec9925f749d308b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Flash API key</h2></td></tr>
|
|
<tr class="memitem:ga95539796ed8672eda06bfc363883a508"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga95539796ed8672eda06bfc363883a508">_flash_driver_api_keys</a> { <br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga95539796ed8672eda06bfc363883a508a5b52819ce5c4ed6cb099b6f89b7eac56">kFLASH_ApiEraseKey</a> = FOUR_CHAR_CODE('k', 'f', 'e', 'k'),
|
|
<br />
|
|
  <a class="el" href="group__flash__driver__api.html#gga95539796ed8672eda06bfc363883a508a5b52819ce5c4ed6cb099b6f89b7eac56">kFLASH_ApiEraseKey</a> = FOUR_CHAR_CODE('k', 'f', 'e', 'k')
|
|
<br />
|
|
}<tr class="memdesc:ga95539796ed8672eda06bfc363883a508"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for flash driver API keys. <a href="group__flash__driver.html#ga95539796ed8672eda06bfc363883a508">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga95539796ed8672eda06bfc363883a508"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Initialization</h2></td></tr>
|
|
<tr class="memitem:ga19c10d3524010a2d33369855d74a5c04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga19c10d3524010a2d33369855d74a5c04">FLASH_Init</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga19c10d3524010a2d33369855d74a5c04"><td class="mdescLeft"> </td><td class="mdescRight">Initializes global flash properties structure members. <a href="#ga19c10d3524010a2d33369855d74a5c04">More...</a><br /></td></tr>
|
|
<tr class="separator:ga19c10d3524010a2d33369855d74a5c04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa89a4c7704b471af58c2d0f629a87ff4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gaa89a4c7704b471af58c2d0f629a87ff4">FLASH_SetCallback</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver__api.html#ga67c22466713ef09903b07a56e1c2a050">flash_callback_t</a> callback)</td></tr>
|
|
<tr class="memdesc:gaa89a4c7704b471af58c2d0f629a87ff4"><td class="mdescLeft"> </td><td class="mdescRight">Set the desired flash callback function. <a href="#gaa89a4c7704b471af58c2d0f629a87ff4">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa89a4c7704b471af58c2d0f629a87ff4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab69bf91c617921217e0c5f302cc33daf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gab69bf91c617921217e0c5f302cc33daf">FLASH_PrepareExecuteInRamFunctions</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:gab69bf91c617921217e0c5f302cc33daf"><td class="mdescLeft"> </td><td class="mdescRight">Prepare flash execute-in-ram functions. <a href="#gab69bf91c617921217e0c5f302cc33daf">More...</a><br /></td></tr>
|
|
<tr class="separator:gab69bf91c617921217e0c5f302cc33daf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Erasing</h2></td></tr>
|
|
<tr class="memitem:ga620aad3b28de9e89e3297bd1bbcd5618"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga620aad3b28de9e89e3297bd1bbcd5618">FLASH_EraseAll</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t key)</td></tr>
|
|
<tr class="memdesc:ga620aad3b28de9e89e3297bd1bbcd5618"><td class="mdescLeft"> </td><td class="mdescRight">Erases entire flash. <a href="#ga620aad3b28de9e89e3297bd1bbcd5618">More...</a><br /></td></tr>
|
|
<tr class="separator:ga620aad3b28de9e89e3297bd1bbcd5618"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae9cb58f4cf76fec37631c4f344e2fb10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gae9cb58f4cf76fec37631c4f344e2fb10">FLASH_Erase</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t lengthInBytes, uint32_t key)</td></tr>
|
|
<tr class="memdesc:gae9cb58f4cf76fec37631c4f344e2fb10"><td class="mdescLeft"> </td><td class="mdescRight">Erases flash sectors encompassed by parameters passed into function. <a href="#gae9cb58f4cf76fec37631c4f344e2fb10">More...</a><br /></td></tr>
|
|
<tr class="separator:gae9cb58f4cf76fec37631c4f344e2fb10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga922c2d91287b65b805e2b6f115340af4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga922c2d91287b65b805e2b6f115340af4">FLASH_EraseAllUnsecure</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t key)</td></tr>
|
|
<tr class="memdesc:ga922c2d91287b65b805e2b6f115340af4"><td class="mdescLeft"> </td><td class="mdescRight">Erases entire flash, including protected sectors. <a href="#ga922c2d91287b65b805e2b6f115340af4">More...</a><br /></td></tr>
|
|
<tr class="separator:ga922c2d91287b65b805e2b6f115340af4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad39d36451aef62e097b545518ef984f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gad39d36451aef62e097b545518ef984f6">FLASH_EraseAllExecuteOnlySegments</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t key)</td></tr>
|
|
<tr class="memdesc:gad39d36451aef62e097b545518ef984f6"><td class="mdescLeft"> </td><td class="mdescRight">Erases all program flash execute-only segments defined by the FXACC registers. <a href="#gad39d36451aef62e097b545518ef984f6">More...</a><br /></td></tr>
|
|
<tr class="separator:gad39d36451aef62e097b545518ef984f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Programming</h2></td></tr>
|
|
<tr class="memitem:gaac44aa0a054e62adb306bf4910a99bd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gaac44aa0a054e62adb306bf4910a99bd4">FLASH_Program</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t *src, uint32_t lengthInBytes)</td></tr>
|
|
<tr class="memdesc:gaac44aa0a054e62adb306bf4910a99bd4"><td class="mdescLeft"> </td><td class="mdescRight">Programs flash with data at locations passed in through parameters. <a href="#gaac44aa0a054e62adb306bf4910a99bd4">More...</a><br /></td></tr>
|
|
<tr class="separator:gaac44aa0a054e62adb306bf4910a99bd4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7e45501b1e1c6ddd5b10a76e422c4d29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga7e45501b1e1c6ddd5b10a76e422c4d29">FLASH_ProgramOnce</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t index, uint32_t *src, uint32_t lengthInBytes)</td></tr>
|
|
<tr class="memdesc:ga7e45501b1e1c6ddd5b10a76e422c4d29"><td class="mdescLeft"> </td><td class="mdescRight">Programs Program Once Field through parameters. <a href="#ga7e45501b1e1c6ddd5b10a76e422c4d29">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7e45501b1e1c6ddd5b10a76e422c4d29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga69c3d8a59c582bbded7369eba1db1356"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga69c3d8a59c582bbded7369eba1db1356">FLASH_ProgramSection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t *src, uint32_t lengthInBytes)</td></tr>
|
|
<tr class="memdesc:ga69c3d8a59c582bbded7369eba1db1356"><td class="mdescLeft"> </td><td class="mdescRight">Programs flash with data at locations passed in through parameters via Program Section command. <a href="#ga69c3d8a59c582bbded7369eba1db1356">More...</a><br /></td></tr>
|
|
<tr class="separator:ga69c3d8a59c582bbded7369eba1db1356"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga61e66caff2d9be2d23310f6084f7965a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga61e66caff2d9be2d23310f6084f7965a">FLASH_EepromWrite</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes)</td></tr>
|
|
<tr class="memdesc:ga61e66caff2d9be2d23310f6084f7965a"><td class="mdescLeft"> </td><td class="mdescRight">Programs EEPROM with data at locations passed in through parameters. <a href="#ga61e66caff2d9be2d23310f6084f7965a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga61e66caff2d9be2d23310f6084f7965a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Reading</h2></td></tr>
|
|
<tr class="memitem:gad9ffbb7b82028934b864dd6fb359df92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gad9ffbb7b82028934b864dd6fb359df92">FLASH_ReadResource</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t *dst, uint32_t lengthInBytes, <a class="el" href="group__flash__driver.html#ga70d45ebc64d50e9868f7016c8a417c51">flash_read_resource_option_t</a> option)</td></tr>
|
|
<tr class="memdesc:gad9ffbb7b82028934b864dd6fb359df92"><td class="mdescLeft"> </td><td class="mdescRight">Read resource with data at locations passed in through parameters. <a href="#gad9ffbb7b82028934b864dd6fb359df92">More...</a><br /></td></tr>
|
|
<tr class="separator:gad9ffbb7b82028934b864dd6fb359df92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3921a84a4dc5f7f824d6816d17cbc55b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga3921a84a4dc5f7f824d6816d17cbc55b">FLASH_ReadOnce</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t index, uint32_t *dst, uint32_t lengthInBytes)</td></tr>
|
|
<tr class="memdesc:ga3921a84a4dc5f7f824d6816d17cbc55b"><td class="mdescLeft"> </td><td class="mdescRight">Read Program Once Field through parameters. <a href="#ga3921a84a4dc5f7f824d6816d17cbc55b">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3921a84a4dc5f7f824d6816d17cbc55b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Security</h2></td></tr>
|
|
<tr class="memitem:gac228a2b25c575e489b47ac3c0652a50a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gac228a2b25c575e489b47ac3c0652a50a">FLASH_GetSecurityState</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver.html#ga00b3eb2666116e617f6e45a10218f6a9">flash_security_state_t</a> *state)</td></tr>
|
|
<tr class="memdesc:gac228a2b25c575e489b47ac3c0652a50a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the security state via the pointer passed into the function. <a href="#gac228a2b25c575e489b47ac3c0652a50a">More...</a><br /></td></tr>
|
|
<tr class="separator:gac228a2b25c575e489b47ac3c0652a50a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae54de3df1d9c73f19b1bd2ad713c2607"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gae54de3df1d9c73f19b1bd2ad713c2607">FLASH_SecurityBypass</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, const uint8_t *backdoorKey)</td></tr>
|
|
<tr class="memdesc:gae54de3df1d9c73f19b1bd2ad713c2607"><td class="mdescLeft"> </td><td class="mdescRight">Allows user to bypass security with a backdoor key. <a href="#gae54de3df1d9c73f19b1bd2ad713c2607">More...</a><br /></td></tr>
|
|
<tr class="separator:gae54de3df1d9c73f19b1bd2ad713c2607"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Verification</h2></td></tr>
|
|
<tr class="memitem:ga85a55ca1a9dcdd134989e6c722007db6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga85a55ca1a9dcdd134989e6c722007db6">FLASH_VerifyEraseAll</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> margin)</td></tr>
|
|
<tr class="memdesc:ga85a55ca1a9dcdd134989e6c722007db6"><td class="mdescLeft"> </td><td class="mdescRight">Verifies erasure of entire flash at specified margin level. <a href="#ga85a55ca1a9dcdd134989e6c722007db6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga85a55ca1a9dcdd134989e6c722007db6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf88e46a975e29f113fd29798aeb5b66c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gaf88e46a975e29f113fd29798aeb5b66c">FLASH_VerifyErase</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t lengthInBytes, <a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> margin)</td></tr>
|
|
<tr class="memdesc:gaf88e46a975e29f113fd29798aeb5b66c"><td class="mdescLeft"> </td><td class="mdescRight">Verifies erasure of desired flash area at specified margin level. <a href="#gaf88e46a975e29f113fd29798aeb5b66c">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf88e46a975e29f113fd29798aeb5b66c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga17820a03a93127cf52f6e7b5ed830c8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga17820a03a93127cf52f6e7b5ed830c8b">FLASH_VerifyProgram</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t lengthInBytes, const uint32_t *expectedData, <a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> margin, uint32_t *failedAddress, uint32_t *failedData)</td></tr>
|
|
<tr class="memdesc:ga17820a03a93127cf52f6e7b5ed830c8b"><td class="mdescLeft"> </td><td class="mdescRight">Verifies programming of desired flash area at specified margin level. <a href="#ga17820a03a93127cf52f6e7b5ed830c8b">More...</a><br /></td></tr>
|
|
<tr class="separator:ga17820a03a93127cf52f6e7b5ed830c8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab15b9e74df82e1ebc15c802c34eaeaab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gab15b9e74df82e1ebc15c802c34eaeaab">FLASH_VerifyEraseAllExecuteOnlySegments</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> margin)</td></tr>
|
|
<tr class="memdesc:gab15b9e74df82e1ebc15c802c34eaeaab"><td class="mdescLeft"> </td><td class="mdescRight">Verifies if the program flash executeonly segments have been erased to the specified read margin level. <a href="#gab15b9e74df82e1ebc15c802c34eaeaab">More...</a><br /></td></tr>
|
|
<tr class="separator:gab15b9e74df82e1ebc15c802c34eaeaab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Protection</h2></td></tr>
|
|
<tr class="memitem:ga3c28d781a630bb833e469cd11342f03a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga3c28d781a630bb833e469cd11342f03a">FLASH_IsProtected</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t lengthInBytes, <a class="el" href="group__flash__driver.html#ga9378245c649eebea9451367d6b8f9ce2">flash_protection_state_t</a> *protection_state)</td></tr>
|
|
<tr class="memdesc:ga3c28d781a630bb833e469cd11342f03a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the protection state of desired flash area via the pointer passed into the function. <a href="#ga3c28d781a630bb833e469cd11342f03a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3c28d781a630bb833e469cd11342f03a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga288c88008135094a458b0464aca7724a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga288c88008135094a458b0464aca7724a">FLASH_IsExecuteOnly</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t start, uint32_t lengthInBytes, <a class="el" href="group__flash__driver.html#gad38961e5692f64548dbf84d652b9ccde">flash_execute_only_access_state_t</a> *access_state)</td></tr>
|
|
<tr class="memdesc:ga288c88008135094a458b0464aca7724a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the access state of desired flash area via the pointer passed into the function. <a href="#ga288c88008135094a458b0464aca7724a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga288c88008135094a458b0464aca7724a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Properties</h2></td></tr>
|
|
<tr class="memitem:gafd0d83bc8fec50fe9a9121d2ec906697"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gafd0d83bc8fec50fe9a9121d2ec906697">FLASH_GetProperty</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver.html#ga7b6766fe08a63cf92a5e2a90dd6d010f">flash_property_tag_t</a> whichProperty, uint32_t *value)</td></tr>
|
|
<tr class="memdesc:gafd0d83bc8fec50fe9a9121d2ec906697"><td class="mdescLeft"> </td><td class="mdescRight">Returns the desired flash property. <a href="#gafd0d83bc8fec50fe9a9121d2ec906697">More...</a><br /></td></tr>
|
|
<tr class="separator:gafd0d83bc8fec50fe9a9121d2ec906697"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
FlexRAM</h2></td></tr>
|
|
<tr class="memitem:ga12148e241d36aca578ced750f9fce3b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga12148e241d36aca578ced750f9fce3b1">FLASH_SetFlexramFunction</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver.html#ga3812bab3ef6aacfbe889b1a81e25c76d">flash_flexram_function_option_t</a> option)</td></tr>
|
|
<tr class="memdesc:ga12148e241d36aca578ced750f9fce3b1"><td class="mdescLeft"> </td><td class="mdescRight">Set FlexRAM Function command. <a href="#ga12148e241d36aca578ced750f9fce3b1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga12148e241d36aca578ced750f9fce3b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Swap</h2></td></tr>
|
|
<tr class="memitem:gaa79e26d877434ae6e0291050efaa0b57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gaa79e26d877434ae6e0291050efaa0b57">FLASH_SwapControl</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t address, <a class="el" href="group__flash__driver.html#gac4c39d832a41bddec3f2953df588adeb">flash_swap_control_option_t</a> option, <a class="el" href="group__flash__driver.html#structflash__swap__state__config__t">flash_swap_state_config_t</a> *returnInfo)</td></tr>
|
|
<tr class="memdesc:gaa79e26d877434ae6e0291050efaa0b57"><td class="mdescLeft"> </td><td class="mdescRight">Configure Swap function or Check the swap state of Flash Module. <a href="#gaa79e26d877434ae6e0291050efaa0b57">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa79e26d877434ae6e0291050efaa0b57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaccf22207665595189702b55c719437a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gaccf22207665595189702b55c719437a8">FLASH_Swap</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t address, <a class="el" href="group__flash__driver.html#ga799e1be1686e21a35457d674fc746728">flash_swap_function_option_t</a> option)</td></tr>
|
|
<tr class="memdesc:gaccf22207665595189702b55c719437a8"><td class="mdescLeft"> </td><td class="mdescRight">Swap the lower half flash with the higher half flaock. <a href="#gaccf22207665595189702b55c719437a8">More...</a><br /></td></tr>
|
|
<tr class="separator:gaccf22207665595189702b55c719437a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
FlexNVM</h2></td></tr>
|
|
<tr class="memitem:ga2cdb77b1c529729c39c89c11fea4f67d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga2cdb77b1c529729c39c89c11fea4f67d">FLASH_ProgramPartition</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, <a class="el" href="group__flash__driver.html#ga46a69f0afbc5ceaae3748429aa2d7901">flash_partition_flexram_load_option_t</a> option, uint32_t eepromDataSizeCode, uint32_t flexnvmPartitionCode)</td></tr>
|
|
<tr class="memdesc:ga2cdb77b1c529729c39c89c11fea4f67d"><td class="mdescLeft"> </td><td class="mdescRight">Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the FlexRAM. <a href="#ga2cdb77b1c529729c39c89c11fea4f67d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2cdb77b1c529729c39c89c11fea4f67d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Flash Protection Utilities</h2></td></tr>
|
|
<tr class="memitem:ga005996f64ae3b43e613ace953d613841"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga005996f64ae3b43e613ace953d613841">FLASH_PflashSetProtection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t protectStatus)</td></tr>
|
|
<tr class="memdesc:ga005996f64ae3b43e613ace953d613841"><td class="mdescLeft"> </td><td class="mdescRight">Set PFLASH Protection to the intended protection status. <a href="#ga005996f64ae3b43e613ace953d613841">More...</a><br /></td></tr>
|
|
<tr class="separator:ga005996f64ae3b43e613ace953d613841"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga381fa81510e9aa0f83e117dc9b8ebcef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga381fa81510e9aa0f83e117dc9b8ebcef">FLASH_PflashGetProtection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint32_t *protectStatus)</td></tr>
|
|
<tr class="memdesc:ga381fa81510e9aa0f83e117dc9b8ebcef"><td class="mdescLeft"> </td><td class="mdescRight">Get PFLASH Protection Status. <a href="#ga381fa81510e9aa0f83e117dc9b8ebcef">More...</a><br /></td></tr>
|
|
<tr class="separator:ga381fa81510e9aa0f83e117dc9b8ebcef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac392665f1a2b3c257d987ac76055cd6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#gac392665f1a2b3c257d987ac76055cd6f">FLASH_DflashSetProtection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint8_t protectStatus)</td></tr>
|
|
<tr class="memdesc:gac392665f1a2b3c257d987ac76055cd6f"><td class="mdescLeft"> </td><td class="mdescRight">Set DFLASH Protection to the intended protection status. <a href="#gac392665f1a2b3c257d987ac76055cd6f">More...</a><br /></td></tr>
|
|
<tr class="separator:gac392665f1a2b3c257d987ac76055cd6f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga77dd5df6837dcaa45af098fbd72ba6f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga77dd5df6837dcaa45af098fbd72ba6f3">FLASH_DflashGetProtection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint8_t *protectStatus)</td></tr>
|
|
<tr class="memdesc:ga77dd5df6837dcaa45af098fbd72ba6f3"><td class="mdescLeft"> </td><td class="mdescRight">Get DFLASH Protection Status. <a href="#ga77dd5df6837dcaa45af098fbd72ba6f3">More...</a><br /></td></tr>
|
|
<tr class="separator:ga77dd5df6837dcaa45af098fbd72ba6f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga55f6e3cc28deda0ed9fca618c473fa6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga55f6e3cc28deda0ed9fca618c473fa6f">FLASH_EepromSetProtection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint8_t protectStatus)</td></tr>
|
|
<tr class="memdesc:ga55f6e3cc28deda0ed9fca618c473fa6f"><td class="mdescLeft"> </td><td class="mdescRight">Set EEPROM Protection to the intended protection status. <a href="#ga55f6e3cc28deda0ed9fca618c473fa6f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga55f6e3cc28deda0ed9fca618c473fa6f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9d1f2471c2693adad5856e745fa01b9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__driver.html#ga9d1f2471c2693adad5856e745fa01b9c">FLASH_EepromGetProtection</a> (<a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> *config, uint8_t *protectStatus)</td></tr>
|
|
<tr class="memdesc:ga9d1f2471c2693adad5856e745fa01b9c"><td class="mdescLeft"> </td><td class="mdescRight">Get DFLASH Protection Status. <a href="#ga9d1f2471c2693adad5856e745fa01b9c">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9d1f2471c2693adad5856e745fa01b9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
|
|
<p>The flash provides the C90TFS Flash driver of Kinetis devices with the C90TFS Flash module inside. The flash provides general APIs to handle specific operations on C90TFS/FTFx Flash module. The user can use those APIs directly in the application. In addition, it provides internal functions called by the driver. Although these functions are not meant to be called from the user's application directly, the APIs can still be used. </p>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structflash__execute__in__ram__function__config__t" id="structflash__execute__in__ram__function__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct flash_execute_in_ram_function_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Flash execute-in-ram function information. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a117b7a2a9cf9fdb06661d7163c33b2af"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
activeFunctionCount</td>
|
|
<td class="fielddoc">
|
|
<p>Number of available execute-in-ram functions. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ac97d40e6006d6166c14dc11ce9e13a0d"></a>uint8_t *</td>
|
|
<td class="fieldname">
|
|
flashCacheClearCommand</td>
|
|
<td class="fielddoc">
|
|
<p>execute-in-ram function: flash_cache_clear_command. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ab7ca2d1bc1695f82fe490ee90b7776ce"></a>uint8_t *</td>
|
|
<td class="fieldname">
|
|
flashRunCommand</td>
|
|
<td class="fielddoc">
|
|
<p>execute-in-ram function: flash_run_command. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structflash__swap__state__config__t" id="structflash__swap__state__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct flash_swap_state_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Flash Swap information. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ab5d1712ddc507a4ba81116cd9f1818cb"></a><a class="el" href="group__flash__driver.html#gafa125571c739fe8d5c41cfe9402cb063">flash_swap_block_status_t</a></td>
|
|
<td class="fieldname">
|
|
currentSwapBlockStatus</td>
|
|
<td class="fielddoc">
|
|
<p>Current swap block status. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ada86e4c834609690667f56557dd3ee7f"></a><a class="el" href="group__flash__driver.html#gabbbbdf78a0245100d29ad83bd6f0d141">flash_swap_state_t</a></td>
|
|
<td class="fieldname">
|
|
flashSwapState</td>
|
|
<td class="fielddoc">
|
|
<p>Current swap system status. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a0df065d44f921cc0fc305ed556bbe96d"></a><a class="el" href="group__flash__driver.html#gafa125571c739fe8d5c41cfe9402cb063">flash_swap_block_status_t</a></td>
|
|
<td class="fieldname">
|
|
nextSwapBlockStatus</td>
|
|
<td class="fielddoc">
|
|
<p>Next swap block status. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structflash__swap__ifr__field__config__t" id="structflash__swap__ifr__field__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct flash_swap_ifr_field_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Flash Swap IFR fields. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a1c810c3a64736fa1cd54e51fb8451d28"></a>uint8_t</td>
|
|
<td class="fieldname">
|
|
reserved0[4]</td>
|
|
<td class="fielddoc">
|
|
<p>Reserved field. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a68b2c1ce5f422562447dcf89db31fe25"></a>uint8_t</td>
|
|
<td class="fieldname">
|
|
reserved1[2]</td>
|
|
<td class="fielddoc">
|
|
<p>Reserved field. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a3d0f8c07755dd4ed0c7d63d3e04e8c93"></a>uint8_t</td>
|
|
<td class="fieldname">
|
|
reserved2[4]</td>
|
|
<td class="fielddoc">
|
|
<p>Reserved field. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a2c73a8dc51884415bff98031b2ebf556"></a>uint16_t</td>
|
|
<td class="fieldname">
|
|
swapDisableWord</td>
|
|
<td class="fielddoc">
|
|
<p>Swap disable word field. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ab3827822ca99eb59cf30798bb7f0436d"></a>uint16_t</td>
|
|
<td class="fieldname">
|
|
swapEnableWord</td>
|
|
<td class="fielddoc">
|
|
<p>Swap enable word field. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="af1c38e81d5b8f25aa0309ed92d79eb02"></a>uint16_t</td>
|
|
<td class="fieldname">
|
|
swapIndicatorAddress</td>
|
|
<td class="fielddoc">
|
|
<p>Swap indicator address field. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="unionflash__swap__ifr__field__data__t" id="unionflash__swap__ifr__field__data__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">union flash_swap_ifr_field_data_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Flash Swap IFR field data. </p>
|
|
</div><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for flash_swap_ifr_field_data_t:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="unionflash__swap__ifr__field__data__t__coll__graph.svg" width="179" height="156"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a20fe7bfd2403f7667ab895054935c69e"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
flashSwapIfrData[2]</td>
|
|
<td class="fielddoc">
|
|
<p>Flash Swap IFR field data . </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a46cfe515f120a1950a1d465e732dbd8d"></a><a class="el" href="group__flash__driver.html#structflash__swap__ifr__field__config__t">flash_swap_ifr_field_config_t</a></td>
|
|
<td class="fieldname">
|
|
flashSwapIfrField</td>
|
|
<td class="fielddoc">
|
|
<p>Flash Swap IFR field struct. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structflash__operation__config__t" id="structflash__operation__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct flash_operation_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Active flash information for current operation. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a7bde70c9645241bf75eabc3cffd5a972"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
activeBlockSize</td>
|
|
<td class="fielddoc">
|
|
<p>Block size of current flash type. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a2608d4d2b12f2787ec689e9d8fa9cedb"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
activeSectorSize</td>
|
|
<td class="fielddoc">
|
|
<p>Sector size of current flash type. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a487d58b6f7fc0a26f0c2be196b9c3a47"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
blockWriteUnitSize</td>
|
|
<td class="fielddoc">
|
|
<p>write unit size. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a90803183712121135986ec88bb4e3b66"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
checkCmdAddressAligment</td>
|
|
<td class="fielddoc">
|
|
<p>Program check command address alignment. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a103f050a0770fca8ee73b78a283337a1"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
convertedAddress</td>
|
|
<td class="fielddoc">
|
|
<p>Converted address for current flash type. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a0676a2e9bc17063e637f2ac43ed2ebe6"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
resourceCmdAddressAligment</td>
|
|
<td class="fielddoc">
|
|
<p>Read resource command address alignment. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a595f8955b571b75ea1043683a4e34896"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
sectionCmdAddressAligment</td>
|
|
<td class="fielddoc">
|
|
<p>Program/Verify section command address alignment. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a2776fd1aa6102fd70cc8762cb81c8bd8"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
sectorCmdAddressAligment</td>
|
|
<td class="fielddoc">
|
|
<p>Erase sector command address alignment. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structflash__config__t" id="structflash__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct flash_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Flash driver state information. </p>
|
|
<p>An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a7e640be58919174a50948abd4557668a"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
DFlashBlockBase</td>
|
|
<td class="fielddoc">
|
|
<p>For FlexNVM device, this is the base address of D-Flash memory (FlexNVM memory); For non-FlexNVM device, this field is unused </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a7f003f8a626eb6157412261e0729c40e"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
DFlashTotalSize</td>
|
|
<td class="fielddoc">
|
|
<p>For FlexNVM device, this is total size of the FlexNVM memory; For non-FlexNVM device, this field is unused </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="aa4584e2da546de0d98e2360dce279b13"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
EEpromTotalSize</td>
|
|
<td class="fielddoc">
|
|
<p>For FlexNVM device, this is the size in byte of EEPROM area which was partitioned from FlexRAM; For non-FlexNVM device, this field is unused </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a405e0d401c18d48e9a0c1f7aa55f9e57"></a>uint32_t *</td>
|
|
<td class="fieldname">
|
|
flashExecuteInRamFunctionInfo</td>
|
|
<td class="fielddoc">
|
|
<p>Info struct of flash execute-in-ram function. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a2b7bcbaeba50469f2e1e2c00cb644d8b"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
FlexRAMBlockBase</td>
|
|
<td class="fielddoc">
|
|
<p>For FlexNVM device, this is the base address of FlexRAM For non-FlexNVM device, this is the base address of acceleration RAM memory </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ab432a27d20db93660dd231158448cec6"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
FlexRAMTotalSize</td>
|
|
<td class="fielddoc">
|
|
<p>For FlexNVM device, this is the size of FlexRAM For non-FlexNVM device, this is the size of acceleration RAM memory </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a22c15035fac410bd06bc1f7bad18fb18"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
PFlashAccessSegmentCount</td>
|
|
<td class="fielddoc">
|
|
<p>Number of PFlash access segments. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ab51aad9e4cdb446b7e9f31ded8272cd1"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
PFlashAccessSegmentSize</td>
|
|
<td class="fielddoc">
|
|
<p>Size in bytes of a access segment of PFlash. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a3ebd02013230935b40d11bba77fdd2c8"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
PFlashBlockBase</td>
|
|
<td class="fielddoc">
|
|
<p>Base address of the first PFlash block </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a5b8758c7260d1f19749a3811f4498148"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
PFlashBlockCount</td>
|
|
<td class="fielddoc">
|
|
<p>Number of PFlash blocks. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="adadc482ede6281f5fa1ad31900051aed"></a><a class="el" href="group__flash__driver__api.html#ga67c22466713ef09903b07a56e1c2a050">flash_callback_t</a></td>
|
|
<td class="fieldname">
|
|
PFlashCallback</td>
|
|
<td class="fielddoc">
|
|
<p>Callback function for flash API. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a670ded313d978acfb3602ed2e5cfec68"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
PFlashSectorSize</td>
|
|
<td class="fielddoc">
|
|
<p>Size in bytes of a sector of PFlash. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a84412bcc9676bc99eb517ffcc9a29783"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
PFlashTotalSize</td>
|
|
<td class="fielddoc">
|
|
<p>Size of all combined PFlash block. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga95539796ed8672eda06bfc363883a508"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga95539796ed8672eda06bfc363883a508">_flash_driver_api_keys</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for flash driver API keys. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>The resulting value is built with a byte order such that the string being readable in expected order when viewed in a hex editor, if the value is treated as a 32-bit little endian value. </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga95539796ed8672eda06bfc363883a508a5b52819ce5c4ed6cb099b6f89b7eac56"></a>kFLASH_ApiEraseKey </td><td class="fielddoc">
|
|
<p>Key value used to validate all flash erase APIs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga95539796ed8672eda06bfc363883a508a5b52819ce5c4ed6cb099b6f89b7eac56"></a>kFLASH_ApiEraseKey </td><td class="fielddoc">
|
|
<p>Key value used to validate all flash erase APIs. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2cdaf5b1f6b03013e2f0cf2c6d26adae"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga2cdaf5b1f6b03013e2f0cf2c6d26adae">_flash_driver_version_constants</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>FLASH driver version for ROM. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaea599e22575bcd9a7aa32a1c7b43591f0b"></a>kFLASH_DriverVersionName </td><td class="fielddoc">
|
|
<p>Flash driver version name. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaea4735add39aa49ca212b24fbef9fcb952"></a>kFLASH_DriverVersionMajor </td><td class="fielddoc">
|
|
<p>Major flash driver version. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaeab54b9127ada5f04373dd17edc4e005f4"></a>kFLASH_DriverVersionMinor </td><td class="fielddoc">
|
|
<p>Minor flash driver version. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaea1a3661a27450809aa90f49d6b01781b3"></a>kFLASH_DriverVersionBugfix </td><td class="fielddoc">
|
|
<p>Bugfix for flash driver version. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaea599e22575bcd9a7aa32a1c7b43591f0b"></a>kFLASH_DriverVersionName </td><td class="fielddoc">
|
|
<p>Flash driver version name. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaea4735add39aa49ca212b24fbef9fcb952"></a>kFLASH_DriverVersionMajor </td><td class="fielddoc">
|
|
<p>Major flash driver version. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaeab54b9127ada5f04373dd17edc4e005f4"></a>kFLASH_DriverVersionMinor </td><td class="fielddoc">
|
|
<p>Minor flash driver version. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2cdaf5b1f6b03013e2f0cf2c6d26adaea1a3661a27450809aa90f49d6b01781b3"></a>kFLASH_DriverVersionBugfix </td><td class="fielddoc">
|
|
<p>Bugfix for flash driver version. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae76bb8924742f0483f66c4d3917bb31e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#gae76bb8924742f0483f66c4d3917bb31e">_flash_execute_in_ram_function_constants</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constants for execute-in-ram flash function. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggae76bb8924742f0483f66c4d3917bb31ea44c47300abac0defba3c515df8d531cd"></a>kFLASH_ExecuteInRamFunctionMaxSize </td><td class="fielddoc">
|
|
<p>Max size of execute-in-ram function. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggae76bb8924742f0483f66c4d3917bb31ea2e18b9dc426a3146df8f959c1c874ce0"></a>kFLASH_ExecuteInRamFunctionTotalNum </td><td class="fielddoc">
|
|
<p>Total number of execute-in-ram functions. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggae76bb8924742f0483f66c4d3917bb31ea44c47300abac0defba3c515df8d531cd"></a>kFLASH_ExecuteInRamFunctionMaxSize </td><td class="fielddoc">
|
|
<p>Max size of execute-in-ram function. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggae76bb8924742f0483f66c4d3917bb31ea2e18b9dc426a3146df8f959c1c874ce0"></a>kFLASH_ExecuteInRamFunctionTotalNum </td><td class="fielddoc">
|
|
<p>Total number of execute-in-ram functions. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4fcca89ee32fbd2497a2ee1f8425a0ea"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga4fcca89ee32fbd2497a2ee1f8425a0ea">_flash_read_resource_range</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the range of special-purpose flash resource. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaaad7a834987d4e5be188a6b47d23b4090"></a>kFLASH_ResourceRangePflashIfrSizeInBytes </td><td class="fielddoc">
|
|
<p>Pflash IFR size in byte. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaab6daa4d8f775afeaf1a63908ebc7cd97"></a>kFLASH_ResourceRangeVersionIdSizeInBytes </td><td class="fielddoc">
|
|
<p>Version ID IFR size in byte. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa4cd6d6f08778ae4733d7e705ae61aa49"></a>kFLASH_ResourceRangeVersionIdStart </td><td class="fielddoc">
|
|
<p>Version ID IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa67d0ba0165e2c13ad736e78da17146a3"></a>kFLASH_ResourceRangeVersionIdEnd </td><td class="fielddoc">
|
|
<p>Version ID IFR end address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb"></a>kFLASH_ResourceRangePflashSwapIfrStart </td><td class="fielddoc">
|
|
<p>Pflash swap IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa15a530256f7e19bff28a572cf1d1b53d"></a>kFLASH_ResourceRangePflashSwapIfrEnd </td><td class="fielddoc">
|
|
<p>Pflash swap IFR end address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaaad7a834987d4e5be188a6b47d23b4090"></a>kFLASH_ResourceRangePflashIfrSizeInBytes </td><td class="fielddoc">
|
|
<p>Pflash IFR size in byte. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaab6daa4d8f775afeaf1a63908ebc7cd97"></a>kFLASH_ResourceRangeVersionIdSizeInBytes </td><td class="fielddoc">
|
|
<p>Version ID IFR size in byte. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa4cd6d6f08778ae4733d7e705ae61aa49"></a>kFLASH_ResourceRangeVersionIdStart </td><td class="fielddoc">
|
|
<p>Version ID IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa67d0ba0165e2c13ad736e78da17146a3"></a>kFLASH_ResourceRangeVersionIdEnd </td><td class="fielddoc">
|
|
<p>Version ID IFR end address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb"></a>kFLASH_ResourceRangePflashSwapIfrStart </td><td class="fielddoc">
|
|
<p>Pflash swap IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb"></a>kFLASH_ResourceRangePflashSwapIfrStart </td><td class="fielddoc">
|
|
<p>Pflash swap IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb"></a>kFLASH_ResourceRangePflashSwapIfrStart </td><td class="fielddoc">
|
|
<p>Pflash swap IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa9bc6e119d21b254c08816ac01514aafb"></a>kFLASH_ResourceRangePflashSwapIfrStart </td><td class="fielddoc">
|
|
<p>Pflash swap IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa15a530256f7e19bff28a572cf1d1b53d"></a>kFLASH_ResourceRangePflashSwapIfrEnd </td><td class="fielddoc">
|
|
<p>Pflash swap IFR end address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaaab7328ad8167382b6f954439416d819a"></a>kFLASH_ResourceRangeDflashIfrStart </td><td class="fielddoc">
|
|
<p>Dflash IFR start address. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4fcca89ee32fbd2497a2ee1f8425a0eaa1186524c65263c078d37ea5156af2d9b"></a>kFLASH_ResourceRangeDflashIfrEnd </td><td class="fielddoc">
|
|
<p>Dflash IFR end address. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa4639fd4d4503c0dec9925f749d308b2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#gaa4639fd4d4503c0dec9925f749d308b2">_flash_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Flash driver status codes. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c"></a>kStatus_FLASH_Success </td><td class="fielddoc">
|
|
<p>Api is executed successfully </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867"></a>kStatus_FLASH_InvalidArgument </td><td class="fielddoc">
|
|
<p>Invalid argument </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a6735801bd1fbd61f7d96a07c2c2f9a76"></a>kStatus_FLASH_SizeError </td><td class="fielddoc">
|
|
<p>Error size </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea"></a>kStatus_FLASH_AlignmentError </td><td class="fielddoc">
|
|
<p>Parameter is not aligned with specified baseline </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211"></a>kStatus_FLASH_AddressError </td><td class="fielddoc">
|
|
<p>Address is out of range </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528"></a>kStatus_FLASH_AccessError </td><td class="fielddoc">
|
|
<p>Invalid instruction codes and out-of bounds addresses </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3"></a>kStatus_FLASH_ProtectionViolation </td><td class="fielddoc">
|
|
<p>The program/erase operation is requested to execute on protected areas </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed"></a>kStatus_FLASH_CommandFailure </td><td class="fielddoc">
|
|
<p>Run-time error during command execution. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a0ac435d9c4aa24ccb8ab983de1979780"></a>kStatus_FLASH_UnknownProperty </td><td class="fielddoc">
|
|
<p>Unknown property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92"></a>kStatus_FLASH_EraseKeyError </td><td class="fielddoc">
|
|
<p>Api erase key is invalid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aa3ace4bf14ea333efd6189b8ddf47aca"></a>kStatus_FLASH_RegionExecuteOnly </td><td class="fielddoc">
|
|
<p>Current region is execute only. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32"></a>kStatus_FLASH_ExecuteInRamFunctionNotReady </td><td class="fielddoc">
|
|
<p>Execute-in-ram function is not available. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53"></a>kStatus_FLASH_PartitionStatusUpdateFailure </td><td class="fielddoc">
|
|
<p>Failed to update partition status. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab8b9f6c116209a00338a430e741a1a40"></a>kStatus_FLASH_SetFlexramAsEepromError </td><td class="fielddoc">
|
|
<p>Failed to set flexram as eeprom. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a128d2d13d9674d46619a5c698bc7a7b9"></a>kStatus_FLASH_RecoverFlexramAsRamError </td><td class="fielddoc">
|
|
<p>Failed to recover flexram as ram. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2abf40cb19a8c5af9880414ef5f9be1c6d"></a>kStatus_FLASH_SetFlexramAsRamError </td><td class="fielddoc">
|
|
<p>Failed to set flexram as ram. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aa7652faf3cc559ccda57f8aea502045b"></a>kStatus_FLASH_RecoverFlexramAsEepromError </td><td class="fielddoc">
|
|
<p>Failed to recover flexram as eeprom. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25"></a>kStatus_FLASH_CommandNotSupported </td><td class="fielddoc">
|
|
<p>Flash api is not supported. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a5e0c3747a74458caefc231b995f09679"></a>kStatus_FLASH_SwapSystemNotInUninitialized </td><td class="fielddoc">
|
|
<p>Swap system is not in uninitialzed state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aefaeaf1008f0361fb3ff2d051720cd82"></a>kStatus_FLASH_SwapIndicatorAddressError </td><td class="fielddoc">
|
|
<p>Swap indicator address is invalid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c"></a>kStatus_FLASH_Success </td><td class="fielddoc">
|
|
<p>Api is executed successfully </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867"></a>kStatus_FLASH_InvalidArgument </td><td class="fielddoc">
|
|
<p>Invalid argument </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a6735801bd1fbd61f7d96a07c2c2f9a76"></a>kStatus_FLASH_SizeError </td><td class="fielddoc">
|
|
<p>Error size </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea"></a>kStatus_FLASH_AlignmentError </td><td class="fielddoc">
|
|
<p>Parameter is not aligned with specified baseline </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211"></a>kStatus_FLASH_AddressError </td><td class="fielddoc">
|
|
<p>Address is out of range </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528"></a>kStatus_FLASH_AccessError </td><td class="fielddoc">
|
|
<p>Invalid instruction codes and out-of bounds addresses </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3"></a>kStatus_FLASH_ProtectionViolation </td><td class="fielddoc">
|
|
<p>The program/erase operation is requested to execute on protected areas </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed"></a>kStatus_FLASH_CommandFailure </td><td class="fielddoc">
|
|
<p>Run-time error during command execution. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a0ac435d9c4aa24ccb8ab983de1979780"></a>kStatus_FLASH_UnknownProperty </td><td class="fielddoc">
|
|
<p>Unknown property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92"></a>kStatus_FLASH_EraseKeyError </td><td class="fielddoc">
|
|
<p>Api erase key is invalid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aa3ace4bf14ea333efd6189b8ddf47aca"></a>kStatus_FLASH_RegionExecuteOnly </td><td class="fielddoc">
|
|
<p>Current region is execute only. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32"></a>kStatus_FLASH_ExecuteInRamFunctionNotReady </td><td class="fielddoc">
|
|
<p>Execute-in-ram function is not available. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53"></a>kStatus_FLASH_PartitionStatusUpdateFailure </td><td class="fielddoc">
|
|
<p>Failed to update partition status. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab8b9f6c116209a00338a430e741a1a40"></a>kStatus_FLASH_SetFlexramAsEepromError </td><td class="fielddoc">
|
|
<p>Failed to set flexram as eeprom. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a128d2d13d9674d46619a5c698bc7a7b9"></a>kStatus_FLASH_RecoverFlexramAsRamError </td><td class="fielddoc">
|
|
<p>Failed to recover flexram as ram. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2abf40cb19a8c5af9880414ef5f9be1c6d"></a>kStatus_FLASH_SetFlexramAsRamError </td><td class="fielddoc">
|
|
<p>Failed to set flexram as ram. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aa7652faf3cc559ccda57f8aea502045b"></a>kStatus_FLASH_RecoverFlexramAsEepromError </td><td class="fielddoc">
|
|
<p>Failed to recover flexram as eeprom. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25"></a>kStatus_FLASH_CommandNotSupported </td><td class="fielddoc">
|
|
<p>Flash api is not supported. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2a5e0c3747a74458caefc231b995f09679"></a>kStatus_FLASH_SwapSystemNotInUninitialized </td><td class="fielddoc">
|
|
<p>Swap system is not in uninitialzed state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa4639fd4d4503c0dec9925f749d308b2aefaeaf1008f0361fb3ff2d051720cd82"></a>kStatus_FLASH_SwapIndicatorAddressError </td><td class="fielddoc">
|
|
<p>Swap indicator address is invalid. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad38961e5692f64548dbf84d652b9ccde"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#gad38961e5692f64548dbf84d652b9ccde">flash_execute_only_access_state_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the three possible flash execute access levels. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggad38961e5692f64548dbf84d652b9ccdea38101c1bc20b060f8fa2f5ac43a04f66"></a>kFLASH_AccessStateUnLimited </td><td class="fielddoc">
|
|
<p>Flash region is unLimited. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggad38961e5692f64548dbf84d652b9ccdeae275896979de1eca572ae3c7449148f1"></a>kFLASH_AccessStateExecuteOnly </td><td class="fielddoc">
|
|
<p>Flash region is execute only. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggad38961e5692f64548dbf84d652b9ccdea0b22f0d8b1f43e064f04d12659293c38"></a>kFLASH_AccessStateMixed </td><td class="fielddoc">
|
|
<p>Flash is mixed with unLimited and execute only region. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggad38961e5692f64548dbf84d652b9ccdea38101c1bc20b060f8fa2f5ac43a04f66"></a>kFLASH_AccessStateUnLimited </td><td class="fielddoc">
|
|
<p>Flash region is unLimited. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggad38961e5692f64548dbf84d652b9ccdeae275896979de1eca572ae3c7449148f1"></a>kFLASH_AccessStateExecuteOnly </td><td class="fielddoc">
|
|
<p>Flash region is execute only. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggad38961e5692f64548dbf84d652b9ccdea0b22f0d8b1f43e064f04d12659293c38"></a>kFLASH_AccessStateMixed </td><td class="fielddoc">
|
|
<p>Flash is mixed with unLimited and execute only region. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3812bab3ef6aacfbe889b1a81e25c76d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga3812bab3ef6aacfbe889b1a81e25c76d">flash_flexram_function_option_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the two possilbe options of set flexram function command. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga3812bab3ef6aacfbe889b1a81e25c76dae2deac28c06aeebad0a1449006055042"></a>kFLASH_FlexramFunctionOptionAvailableAsRam </td><td class="fielddoc">
|
|
<p>Option used to make FlexRAM available as RAM </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga3812bab3ef6aacfbe889b1a81e25c76daf87c9b48af2e57f1b390934473f3a05d"></a>kFLASH_FlexramFunctionOptionAvailableForEeprom </td><td class="fielddoc">
|
|
<p>Option used to make FlexRAM available for EEPROM </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2105f5de393a06479e62141dab8dd3fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for supported flash margin levels. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fca9071189977c1f756d42d710288cfb6be"></a>kFLASH_MarginValueNormal </td><td class="fielddoc">
|
|
<p>Use the 'normal' read level for 1s. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fca1c1271a7e38d4e062e202730f6a5ebed"></a>kFLASH_MarginValueUser </td><td class="fielddoc">
|
|
<p>Apply the 'User' margin to the normal read-1 level. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fcadc331ba6a0e6de26eb5c1e755136608d"></a>kFLASH_MarginValueFactory </td><td class="fielddoc">
|
|
<p>Apply the 'Factory' margin to the normal read-1 level. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fcaa297e7607bb0ccefbe181d1f1d828deb"></a>kFLASH_MarginValueInvalid </td><td class="fielddoc">
|
|
<p>Not real margin level, Used to determine the range of valid margin level. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fca9071189977c1f756d42d710288cfb6be"></a>kFLASH_MarginValueNormal </td><td class="fielddoc">
|
|
<p>Use the 'normal' read level for 1s. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fca1c1271a7e38d4e062e202730f6a5ebed"></a>kFLASH_MarginValueUser </td><td class="fielddoc">
|
|
<p>Apply the 'User' margin to the normal read-1 level. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fcadc331ba6a0e6de26eb5c1e755136608d"></a>kFLASH_MarginValueFactory </td><td class="fielddoc">
|
|
<p>Apply the 'Factory' margin to the normal read-1 level. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga2105f5de393a06479e62141dab8dd3fcaa297e7607bb0ccefbe181d1f1d828deb"></a>kFLASH_MarginValueInvalid </td><td class="fielddoc">
|
|
<p>Not real margin level, Used to determine the range of valid margin level. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga46a69f0afbc5ceaae3748429aa2d7901"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga46a69f0afbc5ceaae3748429aa2d7901">flash_partition_flexram_load_option_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for FlexRAM load during reset option. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga46a69f0afbc5ceaae3748429aa2d7901aac927695cefaca6a14f393c9e51cb162"></a>kFLASH_PartitionFlexramLoadOptionLoadedWithValidEepromData </td><td class="fielddoc">
|
|
<p>FlexRAM is loaded with valid EEPROM data during reset sequence. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga46a69f0afbc5ceaae3748429aa2d7901a90872ebb415ec51f16de8e798f95c0d3"></a>kFLASH_PartitionFlexramLoadOptionNotLoaded </td><td class="fielddoc">
|
|
<p>FlexRAM is not loaded during reset sequence. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7b6766fe08a63cf92a5e2a90dd6d010f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga7b6766fe08a63cf92a5e2a90dd6d010f">flash_property_tag_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for various flash properties. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010faa6c433411ecb4bfea9d74504e266e219"></a>kFLASH_PropertyPflashSectorSize </td><td class="fielddoc">
|
|
<p>Pflash sector size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa68caa1558315b7704b08d85c42869eb5"></a>kFLASH_PropertyPflashTotalSize </td><td class="fielddoc">
|
|
<p>Pflash total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fad8c3b85ca1dc8fc5ef03e1954aef873e"></a>kFLASH_PropertyPflashBlockSize </td><td class="fielddoc">
|
|
<p>Pflash block size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fabb40541593520b9c1a87648a26e81957"></a>kFLASH_PropertyPflashBlockCount </td><td class="fielddoc">
|
|
<p>Pflash block count property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa0159abfba4e6ca47c70a89ea2fc24ab9"></a>kFLASH_PropertyPflashBlockBaseAddr </td><td class="fielddoc">
|
|
<p>Pflash block base address property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa82ed61ee8b06813070ded3e06675e07c"></a>kFLASH_PropertyPflashFacSupport </td><td class="fielddoc">
|
|
<p>Pflash fac support property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fab1ff313c13a7c4c9794c97d894c784d1"></a>kFLASH_PropertyPflashAccessSegmentSize </td><td class="fielddoc">
|
|
<p>Pflash access segment size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fad73e31438b9bf8ea5d95e4807371e414"></a>kFLASH_PropertyPflashAccessSegmentCount </td><td class="fielddoc">
|
|
<p>Pflash access segment count property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa9ca389a1c885600feb6900b0d34f7c14"></a>kFLASH_PropertyFlexRamBlockBaseAddr </td><td class="fielddoc">
|
|
<p>FlexRam block base address property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa062cdf2d78e722b71b6037eb6f60cbf4"></a>kFLASH_PropertyFlexRamTotalSize </td><td class="fielddoc">
|
|
<p>FlexRam total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa51190ea2cbee3594588931079b0c7fc6"></a>kFLASH_PropertyDflashSectorSize </td><td class="fielddoc">
|
|
<p>Dflash sector size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa4a988286f54bb8572af9487870bbb32c"></a>kFLASH_PropertyDflashTotalSize </td><td class="fielddoc">
|
|
<p>Dflash total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa4229b9f10be15a5169dc4b6e011536e3"></a>kFLASH_PropertyDflashBlockSize </td><td class="fielddoc">
|
|
<p>Dflash block count property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fad6ce4a3ff01396a5d61fdba8bbd2bb9d"></a>kFLASH_PropertyDflashBlockCount </td><td class="fielddoc">
|
|
<p>Dflash block base address property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa8ec2b47abac2083b760dd47d9bebcde0"></a>kFLASH_PropertyDflashBlockBaseAddr </td><td class="fielddoc">
|
|
<p>Eeprom total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010faa6c433411ecb4bfea9d74504e266e219"></a>kFLASH_PropertyPflashSectorSize </td><td class="fielddoc">
|
|
<p>Pflash sector size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa68caa1558315b7704b08d85c42869eb5"></a>kFLASH_PropertyPflashTotalSize </td><td class="fielddoc">
|
|
<p>Pflash total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fad8c3b85ca1dc8fc5ef03e1954aef873e"></a>kFLASH_PropertyPflashBlockSize </td><td class="fielddoc">
|
|
<p>Pflash block size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fabb40541593520b9c1a87648a26e81957"></a>kFLASH_PropertyPflashBlockCount </td><td class="fielddoc">
|
|
<p>Pflash block count property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa0159abfba4e6ca47c70a89ea2fc24ab9"></a>kFLASH_PropertyPflashBlockBaseAddr </td><td class="fielddoc">
|
|
<p>Pflash block base address property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa82ed61ee8b06813070ded3e06675e07c"></a>kFLASH_PropertyPflashFacSupport </td><td class="fielddoc">
|
|
<p>Pflash fac support property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fab1ff313c13a7c4c9794c97d894c784d1"></a>kFLASH_PropertyPflashAccessSegmentSize </td><td class="fielddoc">
|
|
<p>Pflash access segment size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fad73e31438b9bf8ea5d95e4807371e414"></a>kFLASH_PropertyPflashAccessSegmentCount </td><td class="fielddoc">
|
|
<p>Pflash access segment count property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa9ca389a1c885600feb6900b0d34f7c14"></a>kFLASH_PropertyFlexRamBlockBaseAddr </td><td class="fielddoc">
|
|
<p>FlexRam block base address property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa062cdf2d78e722b71b6037eb6f60cbf4"></a>kFLASH_PropertyFlexRamTotalSize </td><td class="fielddoc">
|
|
<p>FlexRam total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa51190ea2cbee3594588931079b0c7fc6"></a>kFLASH_PropertyDflashSectorSize </td><td class="fielddoc">
|
|
<p>Dflash sector size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa4a988286f54bb8572af9487870bbb32c"></a>kFLASH_PropertyDflashTotalSize </td><td class="fielddoc">
|
|
<p>Dflash total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa4229b9f10be15a5169dc4b6e011536e3"></a>kFLASH_PropertyDflashBlockSize </td><td class="fielddoc">
|
|
<p>Dflash block size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fad6ce4a3ff01396a5d61fdba8bbd2bb9d"></a>kFLASH_PropertyDflashBlockCount </td><td class="fielddoc">
|
|
<p>Dflash block count property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fa8ec2b47abac2083b760dd47d9bebcde0"></a>kFLASH_PropertyDflashBlockBaseAddr </td><td class="fielddoc">
|
|
<p>Dflash block base property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fab3520a58d0f8494d3d7e987d30cee6ed"></a>kFLASH_PropertyEepromTotalSize </td><td class="fielddoc">
|
|
<p>Eeprom total size property. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7b6766fe08a63cf92a5e2a90dd6d010fab97130fd3296506b436e5ded0313ce33"></a>kFLASH_PropertyVersion </td><td class="fielddoc">
|
|
<p>Flash driver version property. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9378245c649eebea9451367d6b8f9ce2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga9378245c649eebea9451367d6b8f9ce2">flash_protection_state_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the three possible flash protection levels. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga9378245c649eebea9451367d6b8f9ce2ace4690203221c04a4e00de6278a59f1e"></a>kFLASH_ProtectionStateUnprotected </td><td class="fielddoc">
|
|
<p>Flash region is not protected. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga9378245c649eebea9451367d6b8f9ce2a2c73fefaf7e6e3a065744be1aab71149"></a>kFLASH_ProtectionStateProtected </td><td class="fielddoc">
|
|
<p>Flash region is protected. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga9378245c649eebea9451367d6b8f9ce2aca2ca63f9c507495e7b0f510b69497bb"></a>kFLASH_ProtectionStateMixed </td><td class="fielddoc">
|
|
<p>Flash is mixed with protected and unprotected region. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga9378245c649eebea9451367d6b8f9ce2ace4690203221c04a4e00de6278a59f1e"></a>kFLASH_ProtectionStateUnprotected </td><td class="fielddoc">
|
|
<p>Flash region is not protected. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga9378245c649eebea9451367d6b8f9ce2a2c73fefaf7e6e3a065744be1aab71149"></a>kFLASH_ProtectionStateProtected </td><td class="fielddoc">
|
|
<p>Flash region is protected. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga9378245c649eebea9451367d6b8f9ce2aca2ca63f9c507495e7b0f510b69497bb"></a>kFLASH_ProtectionStateMixed </td><td class="fielddoc">
|
|
<p>Flash is mixed with protected and unprotected region. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga70d45ebc64d50e9868f7016c8a417c51"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga70d45ebc64d50e9868f7016c8a417c51">flash_read_resource_option_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the two possible options of flash read resource command. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga70d45ebc64d50e9868f7016c8a417c51a80bd0a5fe1432c2a97a3bd8e4a5320ab"></a>kFLASH_ResourceOptionFlashIfr </td><td class="fielddoc">
|
|
<p>Select code for Program flash 0 IFR, Program flash swap 0 IFR, Data flash 0 IFR </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga70d45ebc64d50e9868f7016c8a417c51a900b2f3a7dbd7260d7883fe9fa816c6d"></a>kFLASH_ResourceOptionVersionId </td><td class="fielddoc">
|
|
<p>Select code for Version ID </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga70d45ebc64d50e9868f7016c8a417c51a80bd0a5fe1432c2a97a3bd8e4a5320ab"></a>kFLASH_ResourceOptionFlashIfr </td><td class="fielddoc">
|
|
<p>Select code for Program flash 0 IFR, Program flash swap 0 IFR, Data flash 0 IFR </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga70d45ebc64d50e9868f7016c8a417c51a900b2f3a7dbd7260d7883fe9fa816c6d"></a>kFLASH_ResourceOptionVersionId </td><td class="fielddoc">
|
|
<p>Select code for Version ID </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga00b3eb2666116e617f6e45a10218f6a9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga00b3eb2666116e617f6e45a10218f6a9">flash_security_state_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the three possible flash security states. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga00b3eb2666116e617f6e45a10218f6a9ad48939abe53a98896541d2ee1e7bf752"></a>kFLASH_SecurityStateNotSecure </td><td class="fielddoc">
|
|
<p>Flash is not secure. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga00b3eb2666116e617f6e45a10218f6a9a4c4da1c4c06977cc999930f75f38ecc7"></a>kFLASH_SecurityStateBackdoorEnabled </td><td class="fielddoc">
|
|
<p>Flash backdoor is enabled. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga00b3eb2666116e617f6e45a10218f6a9a5c7043f3abad4e8d65f12179c4636dc2"></a>kFLASH_SecurityStateBackdoorDisabled </td><td class="fielddoc">
|
|
<p>Flash backdoor is disabled. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga00b3eb2666116e617f6e45a10218f6a9ad48939abe53a98896541d2ee1e7bf752"></a>kFLASH_SecurityStateNotSecure </td><td class="fielddoc">
|
|
<p>Flash is not secure. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga00b3eb2666116e617f6e45a10218f6a9a4c4da1c4c06977cc999930f75f38ecc7"></a>kFLASH_SecurityStateBackdoorEnabled </td><td class="fielddoc">
|
|
<p>Flash backdoor is enabled. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga00b3eb2666116e617f6e45a10218f6a9a5c7043f3abad4e8d65f12179c4636dc2"></a>kFLASH_SecurityStateBackdoorDisabled </td><td class="fielddoc">
|
|
<p>Flash backdoor is disabled. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafa125571c739fe8d5c41cfe9402cb063"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#gafa125571c739fe8d5c41cfe9402cb063">flash_swap_block_status_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Enumeration for the possible flash swap block status </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggafa125571c739fe8d5c41cfe9402cb063a8ddfa234a76fbc404ff79bf6f39cc14a"></a>kFLASH_SwapBlockStatusLowerHalfProgramBlocksAtZero </td><td class="fielddoc">
|
|
<p>Swap block status is that lower half program block at zero. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggafa125571c739fe8d5c41cfe9402cb063a3068333e63702a882c3638d4eeee56c6"></a>kFLASH_SwapBlockStatusUpperHalfProgramBlocksAtZero </td><td class="fielddoc">
|
|
<p>Swap block status is that upper half program block at zero. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac4c39d832a41bddec3f2953df588adeb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#gac4c39d832a41bddec3f2953df588adeb">flash_swap_control_option_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the possible options of Swap Control commands. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggac4c39d832a41bddec3f2953df588adeba7ff8249d311051d01d7d82cf8d5c697c"></a>kFLASH_SwapControlOptionIntializeSystem </td><td class="fielddoc">
|
|
<p>Option used to Intialize Swap System </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggac4c39d832a41bddec3f2953df588adeba1f12897efebbc3eb661baa12d9d68f3a"></a>kFLASH_SwapControlOptionSetInUpdateState </td><td class="fielddoc">
|
|
<p>Option used to Set Swap in Update State </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggac4c39d832a41bddec3f2953df588adebae6b96fa981926920018e86905146c15d"></a>kFLASH_SwapControlOptionSetInCompleteState </td><td class="fielddoc">
|
|
<p>Option used to Set Swap in Complete State </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggac4c39d832a41bddec3f2953df588adebacba9f04f370da73a53f123a5ff7b78a7"></a>kFLASH_SwapControlOptionReportStatus </td><td class="fielddoc">
|
|
<p>Option used to Report Swap Status </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggac4c39d832a41bddec3f2953df588adeba871265364e63fa96388c0434e7528697"></a>kFLASH_SwapControlOptionDisableSystem </td><td class="fielddoc">
|
|
<p>Option used to Disable Swap Status </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga799e1be1686e21a35457d674fc746728"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#ga799e1be1686e21a35457d674fc746728">flash_swap_function_option_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the possible options of Swap function. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga799e1be1686e21a35457d674fc746728ac633995521391aa0d8c50ec6f0d9b51d"></a>kFLASH_SwapFunctionOptionEnable </td><td class="fielddoc">
|
|
<p>Option used to enable Swap function </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga799e1be1686e21a35457d674fc746728a3e7f48ea919486120b3e12f045f70856"></a>kFLASH_SwapFunctionOptionDisable </td><td class="fielddoc">
|
|
<p>Option used to Disable Swap function </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabbbbdf78a0245100d29ad83bd6f0d141"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__flash__driver.html#gabbbbdf78a0245100d29ad83bd6f0d141">flash_swap_state_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration for the possible flash swap status. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggabbbbdf78a0245100d29ad83bd6f0d141acb872b5aad441b829eacd3a2f62f1e5b"></a>kFLASH_SwapStateUninitialized </td><td class="fielddoc">
|
|
<p>Flash swap system is in uninitialized state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggabbbbdf78a0245100d29ad83bd6f0d141a969d0802a8bcb2eef29797f9b709c219"></a>kFLASH_SwapStateReady </td><td class="fielddoc">
|
|
<p>Flash swap system is in ready state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggabbbbdf78a0245100d29ad83bd6f0d141aef30cba32280c7666c4e4432c12b477b"></a>kFLASH_SwapStateUpdate </td><td class="fielddoc">
|
|
<p>Flash swap system is in update state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggabbbbdf78a0245100d29ad83bd6f0d141af2fecdb89c4ca80ba7a4550d529af174"></a>kFLASH_SwapStateUpdateErased </td><td class="fielddoc">
|
|
<p>Flash swap system is in updateErased state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggabbbbdf78a0245100d29ad83bd6f0d141a34e8e14bf7d3915ab4b10331b9e964f6"></a>kFLASH_SwapStateComplete </td><td class="fielddoc">
|
|
<p>Flash swap system is in complete state. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggabbbbdf78a0245100d29ad83bd6f0d141aac58ee8947ef084ac3b1be621ab08328"></a>kFLASH_SwapStateDisabled </td><td class="fielddoc">
|
|
<p>Flash swap system is in disabled state. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga77dd5df6837dcaa45af098fbd72ba6f3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_DflashGetProtection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>protectStatus</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get DFLASH Protection Status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">protectStatus</td><td>DFlash Protect status returned by PFlash IP. Each bit is corresponding to protection of 1/8 of the total DFlash. The least significant bit is corresponding to the lowest address area of DFlash. The most significant bit is corresponding to the highest address area of DFlash and so on. There are two possible cases as below: 0: this area is protected. 1: this area is unprotected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25">kStatus_FLASH_CommandNotSupported</a></td><td>Flash api is not supported </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac392665f1a2b3c257d987ac76055cd6f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_DflashSetProtection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>protectStatus</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set DFLASH Protection to the intended protection status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">protectStatus</td><td>The expected protect status user wants to set to DFlash protection register. Each bit is corresponding to protection of 1/8 of the total DFlash. The least significant bit is corresponding to the lowest address area of DFlash. The most significant bit is corresponding to the highest address area of DFlash. There are two possible cases as shown below: 0: this area is protected. 1: this area is unprotected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25">kStatus_FLASH_CommandNotSupported</a></td><td>Flash api is not supported </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9d1f2471c2693adad5856e745fa01b9c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_EepromGetProtection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>protectStatus</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get DFLASH Protection Status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">protectStatus</td><td>DFlash Protect status returned by PFlash IP. Each bit is corresponding to protection of 1/8 of the total EEPROM. The least significant bit is corresponding to the lowest address area of EEPROM. The most significant bit is corresponding to the highest address area of EEPROM. There are two possible cases as below: 0: this area is protected. 1: this area is unprotected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25">kStatus_FLASH_CommandNotSupported</a></td><td>Flash api is not supported. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga55f6e3cc28deda0ed9fca618c473fa6f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_EepromSetProtection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>protectStatus</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set EEPROM Protection to the intended protection status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">protectStatus</td><td>The expected protect status user wants to set to EEPROM protection register. Each bit is corresponding to protection of 1/8 of the total EEPROM. The least significant bit is corresponding to the lowest address area of EEPROM. The most significant bit is corresponding to the highest address area of EEPROM, and so on. There are two possible cases as shown below: 0: this area is protected. 1: this area is unprotected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab032e11743a3397f9c81afac3faa9c25">kStatus_FLASH_CommandNotSupported</a></td><td>Flash api is not supported </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga61e66caff2d9be2d23310f6084f7965a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_EepromWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>src</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Programs EEPROM with data at locations passed in through parameters. </p>
|
|
<p>This function programs the Emulated EEPROM with desired data for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be programmed. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">src</td><td>Pointer to the source buffer of data that is to be programmed into the flash. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab8b9f6c116209a00338a430e741a1a40">kStatus_FLASH_SetFlexramAsEepromError</a></td><td>Failed to set flexram as eeprom. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a128d2d13d9674d46619a5c698bc7a7b9">kStatus_FLASH_RecoverFlexramAsRamError</a></td><td>Failed to recover flexram as ram </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae9cb58f4cf76fec37631c4f344e2fb10"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_Erase </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>key</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases flash sectors encompassed by parameters passed into function. </p>
|
|
<p>This function erases the appropriate number of flash sectors based on the desired start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be erased. The start address does not need to be sector aligned but must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be erased. Must be word aligned. </td></tr>
|
|
<tr><td class="paramname">key</td><td>value used to validate all flash erase APIs.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92">kStatus_FLASH_EraseKeyError</a></td><td>Api erase key is invalid. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga620aad3b28de9e89e3297bd1bbcd5618"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_EraseAll </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>key</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases entire flash. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">key</td><td>value used to validate all flash erase APIs.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92">kStatus_FLASH_EraseKeyError</a></td><td>Api erase key is invalid. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53">kStatus_FLASH_PartitionStatusUpdateFailure</a></td><td>Failed to update partition status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad39d36451aef62e097b545518ef984f6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_EraseAllExecuteOnlySegments </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>key</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases all program flash execute-only segments defined by the FXACC registers. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">key</td><td>value used to validate all flash erase APIs.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92">kStatus_FLASH_EraseKeyError</a></td><td>Api erase key is invalid. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga922c2d91287b65b805e2b6f115340af4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_EraseAllUnsecure </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>key</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases entire flash, including protected sectors. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">key</td><td>value used to validate all flash erase APIs.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a9741e88e6013710b11b81e2af7071a92">kStatus_FLASH_EraseKeyError</a></td><td>Api erase key is invalid. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53">kStatus_FLASH_PartitionStatusUpdateFailure</a></td><td>Failed to update partition status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafd0d83bc8fec50fe9a9121d2ec906697"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_GetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga7b6766fe08a63cf92a5e2a90dd6d010f">flash_property_tag_t</a> </td>
|
|
<td class="paramname"><em>whichProperty</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the desired flash property. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">whichProperty</td><td>The desired property from the list of properties in enum flash_property_tag_t </td></tr>
|
|
<tr><td class="paramname">value</td><td>Pointer to the value returned for the desired flash property</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a0ac435d9c4aa24ccb8ab983de1979780">kStatus_FLASH_UnknownProperty</a></td><td>unknown property tag </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac228a2b25c575e489b47ac3c0652a50a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_GetSecurityState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga00b3eb2666116e617f6e45a10218f6a9">flash_security_state_t</a> * </td>
|
|
<td class="paramname"><em>state</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the security state via the pointer passed into the function. </p>
|
|
<p>This function retrieves the current Flash security status, including the security enabling state and the backdoor key enabling state.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">state</td><td>Pointer to the value returned for the current security status code:</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga19c10d3524010a2d33369855d74a5c04"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes global flash properties structure members. </p>
|
|
<p>This function checks and initializes Flash module for the other Flash APIs.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a91eb156935e27973454eb8df37a36c53">kStatus_FLASH_PartitionStatusUpdateFailure</a></td><td>Failed to update partition status. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga288c88008135094a458b0464aca7724a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_IsExecuteOnly </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#gad38961e5692f64548dbf84d652b9ccde">flash_execute_only_access_state_t</a> * </td>
|
|
<td class="paramname"><em>access_state</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the access state of desired flash area via the pointer passed into the function. </p>
|
|
<p>This function retrieves the current Flash access status for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be checked. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be checked. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">access_state</td><td>Pointer to the value returned for the current access status code for the desired flash area.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3c28d781a630bb833e469cd11342f03a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_IsProtected </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga9378245c649eebea9451367d6b8f9ce2">flash_protection_state_t</a> * </td>
|
|
<td class="paramname"><em>protection_state</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the protection state of desired flash area via the pointer passed into the function. </p>
|
|
<p>This function retrieves the current Flash protect status for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be checked. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be checked. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">protection_state</td><td>Pointer to the value returned for the current protection status code for the desired flash area.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga381fa81510e9aa0f83e117dc9b8ebcef"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_PflashGetProtection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>protectStatus</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get PFLASH Protection Status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">protectStatus</td><td>Protect status returned by PFlash IP. Each bit is corresponding to protection of 1/32 of the total PFlash. The least significant bit is corresponding to the lowest address area of PFlash. The most significant bit is corresponding to the highest address area of PFlash. Thee are two possible cases as below: 0: this area is protected. 1: this area is unprotected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga005996f64ae3b43e613ace953d613841"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_PflashSetProtection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>protectStatus</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set PFLASH Protection to the intended protection status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">protectStatus</td><td>The expected protect status user wants to set to PFlash protection register. Each bit is corresponding to protection of 1/32 of the total PFlash. The least significant bit is corresponding to the lowest address area of P-Flash. The most significant bit is corresponding to the highest address area of PFlash. There are two possible cases as shown below: 0: this area is protected. 1: this area is unprotected.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab69bf91c617921217e0c5f302cc33daf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_PrepareExecuteInRamFunctions </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Prepare flash execute-in-ram functions. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaac44aa0a054e62adb306bf4910a99bd4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_Program </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>src</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Programs flash with data at locations passed in through parameters. </p>
|
|
<p>This function programs the flash memory with desired data for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be programmed. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">src</td><td>Pointer to the source buffer of data that is to be programmed into the flash. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7e45501b1e1c6ddd5b10a76e422c4d29"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_ProgramOnce </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>src</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Programs Program Once Field through parameters. </p>
|
|
<p>This function programs the Program Once Field with desired data for a given flash area as determined by the index and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">index</td><td>The index indicating which area of Program Once Field to be programmed. </td></tr>
|
|
<tr><td class="paramname">src</td><td>Pointer to the source buffer of data that is to be programmed into the Program Once Field. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2cdb77b1c529729c39c89c11fea4f67d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_ProgramPartition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga46a69f0afbc5ceaae3748429aa2d7901">flash_partition_flexram_load_option_t</a> </td>
|
|
<td class="paramname"><em>option</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>eepromDataSizeCode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>flexnvmPartitionCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Prepares the FlexNVM block for use as data flash, EEPROM backup, or a combination of both and initializes the FlexRAM. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">option</td><td>The option used to set FlexRAM load behavior during reset. </td></tr>
|
|
<tr><td class="paramname">eepromDataSizeCode</td><td>Determines the amount of FlexRAM used in each of the available EEPROM subsystems. </td></tr>
|
|
<tr><td class="paramname">flexnvmPartitionCode</td><td>Specifies how to split the FlexNVM block between data flash memory and EEPROM backup memory supporting EEPROM functions.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga69c3d8a59c582bbded7369eba1db1356"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_ProgramSection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>src</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Programs flash with data at locations passed in through parameters via Program Section command. </p>
|
|
<p>This function programs the flash memory with desired data for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be programmed. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">src</td><td>Pointer to the source buffer of data that is to be programmed into the flash. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2abf40cb19a8c5af9880414ef5f9be1c6d">kStatus_FLASH_SetFlexramAsRamError</a></td><td>Failed to set flexram as ram </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aa7652faf3cc559ccda57f8aea502045b">kStatus_FLASH_RecoverFlexramAsEepromError</a></td><td>Failed to recover flexram as eeprom </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3921a84a4dc5f7f824d6816d17cbc55b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_ReadOnce </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>dst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read Program Once Field through parameters. </p>
|
|
<p>This function reads the read once feild with given index and length</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">index</td><td>The index indicating the area of program once field to be read. </td></tr>
|
|
<tr><td class="paramname">dst</td><td>Pointer to the destination buffer of data that is used to store data to be read. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be programmed. Must be word-aligned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad9ffbb7b82028934b864dd6fb359df92"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_ReadResource </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>dst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga70d45ebc64d50e9868f7016c8a417c51">flash_read_resource_option_t</a> </td>
|
|
<td class="paramname"><em>option</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read resource with data at locations passed in through parameters. </p>
|
|
<p>This function reads the flash memory with desired location for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be programmed. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">dst</td><td>Pointer to the destination buffer of data that is used to store data to be read. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be read. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">option</td><td>The resource option which indicates which area should be read back.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae54de3df1d9c73f19b1bd2ad713c2607"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_SecurityBypass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>backdoorKey</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allows user to bypass security with a backdoor key. </p>
|
|
<p>If the MCU is in secured state, this function will unsecure the MCU by comparing the provided backdoor key with ones in the Flash Configuration Field.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">backdoorKey</td><td>Pointer to the user buffer containing the backdoor key.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa89a4c7704b471af58c2d0f629a87ff4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_SetCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver__api.html#ga67c22466713ef09903b07a56e1c2a050">flash_callback_t</a> </td>
|
|
<td class="paramname"><em>callback</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the desired flash callback function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>callback function to be stored in driver</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga12148e241d36aca578ced750f9fce3b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_SetFlexramFunction </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga3812bab3ef6aacfbe889b1a81e25c76d">flash_flexram_function_option_t</a> </td>
|
|
<td class="paramname"><em>option</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set FlexRAM Function command. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">option</td><td>The option used to set work mode of FlexRAM</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaccf22207665595189702b55c719437a8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_Swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga799e1be1686e21a35457d674fc746728">flash_swap_function_option_t</a> </td>
|
|
<td class="paramname"><em>option</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Swap the lower half flash with the higher half flaock. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">address</td><td>Address used to configure the flash swap function </td></tr>
|
|
<tr><td class="paramname">option</td><td>The possible option used to configure Flash Swap function or check the flash swap status</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aefaeaf1008f0361fb3ff2d051720cd82">kStatus_FLASH_SwapIndicatorAddressError</a></td><td>Swap indicator address is invalid </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a5e0c3747a74458caefc231b995f09679">kStatus_FLASH_SwapSystemNotInUninitialized</a></td><td>Swap system is not in uninitialzed state </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa79e26d877434ae6e0291050efaa0b57"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_SwapControl </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#gac4c39d832a41bddec3f2953df588adeb">flash_swap_control_option_t</a> </td>
|
|
<td class="paramname"><em>option</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__swap__state__config__t">flash_swap_state_config_t</a> * </td>
|
|
<td class="paramname"><em>returnInfo</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure Swap function or Check the swap state of Flash Module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">address</td><td>Address used to configure the flash swap function </td></tr>
|
|
<tr><td class="paramname">option</td><td>The possible option used to configure Flash Swap function or check the flash swap status </td></tr>
|
|
<tr><td class="paramname">returnInfo</td><td>Pointer to the data which is used to return the information of flash swap.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aefaeaf1008f0361fb3ff2d051720cd82">kStatus_FLASH_SwapIndicatorAddressError</a></td><td>Swap indicator address is invalid </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf88e46a975e29f113fd29798aeb5b66c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_VerifyErase </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> </td>
|
|
<td class="paramname"><em>margin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Verifies erasure of desired flash area at specified margin level. </p>
|
|
<p>This function will check the appropriate number of flash sectors based on the desired start address and length to see if the flash have been erased to the specified read margin level.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be verified. The start address does not need to be sector aligned but must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be verified. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">margin</td><td>Read margin choice</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga85a55ca1a9dcdd134989e6c722007db6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_VerifyEraseAll </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> </td>
|
|
<td class="paramname"><em>margin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Verifies erasure of entire flash at specified margin level. </p>
|
|
<p>This function will check to see if the flash have been erased to the specified read margin level.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">margin</td><td>Read margin choice</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab15b9e74df82e1ebc15c802c34eaeaab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_VerifyEraseAllExecuteOnlySegments </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> </td>
|
|
<td class="paramname"><em>margin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Verifies if the program flash executeonly segments have been erased to the specified read margin level. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">margin</td><td>Read margin choice</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga17820a03a93127cf52f6e7b5ed830c8b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLASH_VerifyProgram </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#structflash__config__t">flash_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>lengthInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint32_t * </td>
|
|
<td class="paramname"><em>expectedData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__flash__driver.html#ga2105f5de393a06479e62141dab8dd3fc">flash_margin_value_t</a> </td>
|
|
<td class="paramname"><em>margin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>failedAddress</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>failedData</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Verifies programming of desired flash area at specified margin level. </p>
|
|
<p>This function verifies the data programed in the flash memory using the Flash Program Check Command and compares it with expected data for a given flash area as determined by the start address and length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to storage for the driver runtime state. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The start address of the desired flash memory to be verified. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">lengthInBytes</td><td>The length, given in bytes (not words or long-words) to be verified. Must be word-aligned. </td></tr>
|
|
<tr><td class="paramname">expectedData</td><td>Pointer to the expected data that is to be verified against. </td></tr>
|
|
<tr><td class="paramname">margin</td><td>Read margin choice </td></tr>
|
|
<tr><td class="paramname">failedAddress</td><td>Pointer to returned failing address. </td></tr>
|
|
<tr><td class="paramname">failedData</td><td>Pointer to returned failing data. Some derivitives do not included failed data as part of the FCCOBx registers. In this case, zeros are returned upon failure.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2aacee5186bbe9db2e091dc5c36531cd7c">kStatus_FLASH_Success</a></td><td>Api was executed successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a85c375f1213ec36dd2cf60e8d9851867">kStatus_FLASH_InvalidArgument</a></td><td>Invalid argument is provided. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a098148af25679d78133103cace7580ea">kStatus_FLASH_AlignmentError</a></td><td>Parameter is not aligned with specified baseline. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2acc367a368270606eae83264f59b55211">kStatus_FLASH_AddressError</a></td><td>Address is out of range. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a87d744021836148574383ddcae44db32">kStatus_FLASH_ExecuteInRamFunctionNotReady</a></td><td>Execute-in-ram function is not available. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab9e32512512c1ea1508bc2832f2bd528">kStatus_FLASH_AccessError</a></td><td>Invalid instruction codes and out-of bounds addresses. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2ab406157d740ab0a07df1fc5d2b159fc3">kStatus_FLASH_ProtectionViolation</a></td><td>The program/erase operation is requested to execute on protected areas. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__flash__driver__api.html#ggaa4639fd4d4503c0dec9925f749d308b2a42567b719be83f23619c498da80643ed">kStatus_FLASH_CommandFailure</a></td><td>Run-time error during command execution. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</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="footer">Generated on Mon Mar 7 2016 16:48:23 for Kinetis Bootloader by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|