251 lines
17 KiB
HTML
251 lines
17 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 Host: blfwk::Bootloader Class Reference</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 Host
|
|
 <span id="projectnumber">2.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Host Tools 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><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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></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('classblfwk_1_1_bootloader.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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classblfwk_1_1_bootloader-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::Bootloader Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents the host bootloader.
|
|
<a href="classblfwk_1_1_bootloader.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="src_2blfwk_2_bootloader_8h_source.html">Bootloader.h</a>></code></p>
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for blfwk::Bootloader:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_bootloader__inherit__graph.svg" width="254" height="112"><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>
|
|
<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 blfwk::Bootloader:</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="classblfwk_1_1_bootloader__coll__graph.svg" width="655" height="550"><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="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4d576bc36952fcec62139e4b14446f31"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d576bc36952fcec62139e4b14446f31"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#a4d576bc36952fcec62139e4b14446f31">Bootloader</a> ()</td></tr>
|
|
<tr class="memdesc:a4d576bc36952fcec62139e4b14446f31"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor for <a class="el" href="classblfwk_1_1_simulator.html" title="Represents the host bootloader. ">Simulator</a>. <br /></td></tr>
|
|
<tr class="separator:a4d576bc36952fcec62139e4b14446f31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04f46665c081101a75cf3b2320b864be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04f46665c081101a75cf3b2320b864be"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#a04f46665c081101a75cf3b2320b864be">Bootloader</a> (const <a class="el" href="classblfwk_1_1_peripheral.html#structblfwk_1_1_peripheral_1_1_peripheral_config_data">Peripheral::PeripheralConfigData</a> &config)</td></tr>
|
|
<tr class="memdesc:a04f46665c081101a75cf3b2320b864be"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
|
|
<tr class="separator:a04f46665c081101a75cf3b2320b864be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a970f16331dc25948fd59d269dccc5e4a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a970f16331dc25948fd59d269dccc5e4a"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#a970f16331dc25948fd59d269dccc5e4a">~Bootloader</a> ()</td></tr>
|
|
<tr class="memdesc:a970f16331dc25948fd59d269dccc5e4a"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a970f16331dc25948fd59d269dccc5e4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34979a4bffa66b56cc7323ea44f9f834"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#a34979a4bffa66b56cc7323ea44f9f834">inject</a> (<a class="el" href="classblfwk_1_1_command.html">Command</a> &cmd)</td></tr>
|
|
<tr class="memdesc:a34979a4bffa66b56cc7323ea44f9f834"><td class="mdescLeft"> </td><td class="mdescRight">Inject a command into the bootloader. <a href="#a34979a4bffa66b56cc7323ea44f9f834">More...</a><br /></td></tr>
|
|
<tr class="separator:a34979a4bffa66b56cc7323ea44f9f834"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac249931195a33bfe4573cd2256046ee8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac249931195a33bfe4573cd2256046ee8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#ac249931195a33bfe4573cd2256046ee8">flush</a> ()</td></tr>
|
|
<tr class="memdesc:ac249931195a33bfe4573cd2256046ee8"><td class="mdescLeft"> </td><td class="mdescRight">Flush state. <br /></td></tr>
|
|
<tr class="separator:ac249931195a33bfe4573cd2256046ee8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0af861cd04b89f416ceeef198a6b3e22"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0af861cd04b89f416ceeef198a6b3e22"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#a0af861cd04b89f416ceeef198a6b3e22">execute</a> (uint32_t entry_point, uint32_t param=0, uint32_t stack_pointer=0)</td></tr>
|
|
<tr class="memdesc:a0af861cd04b89f416ceeef198a6b3e22"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classblfwk_1_1_execute.html" title="Represents the bootloader Execute command. ">Execute</a> the execute command. <br /></td></tr>
|
|
<tr class="separator:a0af861cd04b89f416ceeef198a6b3e22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a889c54a8c2a7db7f6cf0fc10dd8ffcec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a889c54a8c2a7db7f6cf0fc10dd8ffcec"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#a889c54a8c2a7db7f6cf0fc10dd8ffcec">reset</a> ()</td></tr>
|
|
<tr class="memdesc:a889c54a8c2a7db7f6cf0fc10dd8ffcec"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classblfwk_1_1_execute.html" title="Represents the bootloader Execute command. ">Execute</a> the reset command. <br /></td></tr>
|
|
<tr class="separator:a889c54a8c2a7db7f6cf0fc10dd8ffcec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd0b4bd84fa8cd78ed1d432cd5f465c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd0b4bd84fa8cd78ed1d432cd5f465c4"></a>
|
|
<a class="el" href="group__qspi__driver.html#unionstandard__version__t">standard_version_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#abd0b4bd84fa8cd78ed1d432cd5f465c4">getVersion</a> ()</td></tr>
|
|
<tr class="memdesc:abd0b4bd84fa8cd78ed1d432cd5f465c4"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classblfwk_1_1_execute.html" title="Represents the bootloader Execute command. ">Execute</a> the get-property(current-version) command. <br /></td></tr>
|
|
<tr class="separator:abd0b4bd84fa8cd78ed1d432cd5f465c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9bb137646fffa3ec6bfa3f5dedb0a68"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9bb137646fffa3ec6bfa3f5dedb0a68"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#ac9bb137646fffa3ec6bfa3f5dedb0a68">getSecurityState</a> ()</td></tr>
|
|
<tr class="memdesc:ac9bb137646fffa3ec6bfa3f5dedb0a68"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classblfwk_1_1_execute.html" title="Represents the bootloader Execute command. ">Execute</a> the get-property(flash-security-state) command. <br /></td></tr>
|
|
<tr class="separator:ac9bb137646fffa3ec6bfa3f5dedb0a68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab5b8a68398d12a6981454a757ca8f2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab5b8a68398d12a6981454a757ca8f2d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#aab5b8a68398d12a6981454a757ca8f2d">ping</a> (int retries, unsigned int delay, int comSpeed)</td></tr>
|
|
<tr class="memdesc:aab5b8a68398d12a6981454a757ca8f2d"><td class="mdescLeft"> </td><td class="mdescRight">Send a ping if applicable. <br /></td></tr>
|
|
<tr class="separator:aab5b8a68398d12a6981454a757ca8f2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Accessors.</div></td></tr>
|
|
<tr class="memitem:ad4979ed9ee49244cee56ede994732a38"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4979ed9ee49244cee56ede994732a38"></a>
|
|
<a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#ad4979ed9ee49244cee56ede994732a38">getPacketizer</a> () const </td></tr>
|
|
<tr class="memdesc:ad4979ed9ee49244cee56ede994732a38"><td class="mdescLeft"> </td><td class="mdescRight">Get the host packetizer. <br /></td></tr>
|
|
<tr class="separator:ad4979ed9ee49244cee56ede994732a38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:aa27c01ea4b6a3e12091088e8b83e95f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa27c01ea4b6a3e12091088e8b83e95f0"></a>
|
|
<a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#aa27c01ea4b6a3e12091088e8b83e95f0">m_hostPacketizer</a></td></tr>
|
|
<tr class="memdesc:aa27c01ea4b6a3e12091088e8b83e95f0"><td class="mdescLeft"> </td><td class="mdescRight">Packet interface to send commands on. <br /></td></tr>
|
|
<tr class="separator:aa27c01ea4b6a3e12091088e8b83e95f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af44eb458e050e54155a6955ce13841cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af44eb458e050e54155a6955ce13841cf"></a>
|
|
<a class="el" href="group__logging.html#class_file_logger">FileLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_bootloader.html#af44eb458e050e54155a6955ce13841cf">m_logger</a></td></tr>
|
|
<tr class="memdesc:af44eb458e050e54155a6955ce13841cf"><td class="mdescLeft"> </td><td class="mdescRight">Singleton logger instance. <br /></td></tr>
|
|
<tr class="separator:af44eb458e050e54155a6955ce13841cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Represents the host bootloader. </p>
|
|
<p>This class provides a convenient way to access other bootloader framework objects. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a34979a4bffa66b56cc7323ea44f9f834"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void blfwk::Bootloader::inject </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classblfwk_1_1_command.html">Command</a> & </td>
|
|
<td class="paramname"><em>cmd</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Inject a command into the bootloader. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cmd</td><td>The command to send </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="src_2blfwk_2_bootloader_8h_source.html">src/blfwk/Bootloader.h</a></li>
|
|
<li>src/blfwk/src/Bootloader.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>blfwk</b></li><li class="navelem"><a class="el" href="classblfwk_1_1_bootloader.html">Bootloader</a></li>
|
|
<li class="footer">Generated on Mon Mar 7 2016 16:49:51 for Kinetis Bootloader Host 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>
|