227 lines
12 KiB
HTML
227 lines
12 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: Reliable_update</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__reliable__update.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="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Reliable_update</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gac1caa8f1f9d090124db6096e215d6264"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__reliable__update.html#gac1caa8f1f9d090124db6096e215d6264">reliable_update_option_t</a> { <br />
|
|
  <a class="el" href="group__reliable__update.html#ggac1caa8f1f9d090124db6096e215d6264a49c48a9795ca4957316d7a5ab104b971">kReliableUpdateOption_Normal</a> = 0x0U,
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#ggac1caa8f1f9d090124db6096e215d6264aacd722efdf3a77290e79cff41beb3926">kReliableUpdateOption_Swap</a> = 0x1U
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:gac1caa8f1f9d090124db6096e215d6264"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3d788f9cd100595dba59c163c9ad037d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3d788f9cd100595dba59c163c9ad037d"></a>enum  </td><td class="memItemRight" valign="bottom"><b>specified_application_type_t</b> { <br />
|
|
  <b>kSpecifiedApplicationType_Main</b> = 0x0U,
|
|
<br />
|
|
  <b>kSpecifiedApplicationType_Backup</b> = 0x1U
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ga3d788f9cd100595dba59c163c9ad037d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4508d32b228f362eaf83344d944f6293"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__reliable__update.html#ga4508d32b228f362eaf83344d944f6293">_reliable_update_status</a> { <br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293ab36812ace967baaa54d3956bab0d3050">kStatus_ReliableUpdateSuccess</a> = MAKE_STATUS(kStatusGroup_ReliableUpdate, 0),
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293adce67064d2c6a9f34149d40cca684ce0">kStatus_ReliableUpdateFail</a> = MAKE_STATUS(kStatusGroup_ReliableUpdate, 1),
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293a3f24fb5e812a90e300cfce0d84974ac0">kStatus_ReliableUpdateInacive</a>,
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293ad86b2069003a11fed383312db72f2d6f">kStatus_ReliableUpdateBackupApplicationInvalid</a>,
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293a42d55c9be4c85603cd92923d163e316c">kStatus_ReliableUpdateStillInMainApplication</a>,
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293a47f1da088ed5420f3e2e8250f6b46455">kStatus_ReliableUpdateSwapSystemNotReady</a>,
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293a478710d2db098c22ecaea9219a2c980c">kStatus_ReliableUpdateBackupBootloaderNotReady</a>,
|
|
<br />
|
|
  <a class="el" href="group__reliable__update.html#gga4508d32b228f362eaf83344d944f6293a97a5c0af9947631c3c30dd6d1eb2143b">kStatus_ReliableUpdateSwapIndicatorAddressInvalid</a>
|
|
<br />
|
|
}<tr class="memdesc:ga4508d32b228f362eaf83344d944f6293"><td class="mdescLeft"> </td><td class="mdescRight">Application crc check status codes. <a href="group__reliable__update.html#ga4508d32b228f362eaf83344d944f6293">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga4508d32b228f362eaf83344d944f6293"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga85bb8e8c737a576d1c5c58ebe23f90e2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga85bb8e8c737a576d1c5c58ebe23f90e2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>bootloader_reliable_update_as_requested</b> (<a class="el" href="group__reliable__update.html#gac1caa8f1f9d090124db6096e215d6264">reliable_update_option_t</a> option, uint32_t address)</td></tr>
|
|
<tr class="separator:ga85bb8e8c737a576d1c5c58ebe23f90e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga4508d32b228f362eaf83344d944f6293"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__reliable__update.html#ga4508d32b228f362eaf83344d944f6293">_reliable_update_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Application crc check status codes. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293ab36812ace967baaa54d3956bab0d3050"></a>kStatus_ReliableUpdateSuccess </td><td class="fielddoc">
|
|
<p>Reliable Update succeeded. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293adce67064d2c6a9f34149d40cca684ce0"></a>kStatus_ReliableUpdateFail </td><td class="fielddoc">
|
|
<p>Reliable Update failed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293a3f24fb5e812a90e300cfce0d84974ac0"></a>kStatus_ReliableUpdateInacive </td><td class="fielddoc">
|
|
<p>Reliable Update Feature is inactive. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293ad86b2069003a11fed383312db72f2d6f"></a>kStatus_ReliableUpdateBackupApplicationInvalid </td><td class="fielddoc">
|
|
<p>Backup Application is invalid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293a42d55c9be4c85603cd92923d163e316c"></a>kStatus_ReliableUpdateStillInMainApplication </td><td class="fielddoc">
|
|
<p>Next boot will be still in Main Application. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293a47f1da088ed5420f3e2e8250f6b46455"></a>kStatus_ReliableUpdateSwapSystemNotReady </td><td class="fielddoc">
|
|
<p>Cannot swap flash by default because swap system is not ready. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293a478710d2db098c22ecaea9219a2c980c"></a>kStatus_ReliableUpdateBackupBootloaderNotReady </td><td class="fielddoc">
|
|
<p>Cannot swap flash because there is no valid backup bootloader. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga4508d32b228f362eaf83344d944f6293a97a5c0af9947631c3c30dd6d1eb2143b"></a>kStatus_ReliableUpdateSwapIndicatorAddressInvalid </td><td class="fielddoc">
|
|
<p>Cannot swap flash because provided swap indicator is invalid. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac1caa8f1f9d090124db6096e215d6264"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__reliable__update.html#gac1caa8f1f9d090124db6096e215d6264">reliable_update_option_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggac1caa8f1f9d090124db6096e215d6264a49c48a9795ca4957316d7a5ab104b971"></a>kReliableUpdateOption_Normal </td><td class="fielddoc">
|
|
<p>Normal option, Update main appliction only if it is invalid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggac1caa8f1f9d090124db6096e215d6264aacd722efdf3a77290e79cff41beb3926"></a>kReliableUpdateOption_Swap </td><td class="fielddoc">
|
|
<p>Swap option, Always update main appliction. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</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>
|