Files
bootloader/doc/host_html/classelftosb_1_1_data_target.html
László Monda e6c1fce5b4 Add KBOOT.
2016-08-10 01:45:15 +02:00

235 lines
15 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: elftosb::DataTarget 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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('classelftosb_1_1_data_target.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">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classelftosb_1_1_data_target-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">elftosb::DataTarget Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract base class for the target address or range of data.
<a href="classelftosb_1_1_data_target.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="apps_2elftosb_2common_2_data_target_8h_source.html">DataTarget.h</a>&gt;</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 elftosb::DataTarget:</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="classelftosb_1_1_data_target__inherit__graph.svg" width="390" 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 elftosb::DataTarget:</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="classelftosb_1_1_data_target__coll__graph.svg" width="155" height="127"><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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:structelftosb_1_1_data_target_1_1_address_range"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_data_target.html#structelftosb_1_1_data_target_1_1_address_range">AddressRange</a></td></tr>
<tr class="memdesc:structelftosb_1_1_data_target_1_1_address_range"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple structure that describes an addressed region of memory. <a href="classelftosb_1_1_data_target.html#structelftosb_1_1_data_target_1_1_address_range">More...</a><br /></td></tr>
<tr class="separator:structelftosb_1_1_data_target_1_1_address_range"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a61ae76166b0e9fa08a7daced3e8f3ac7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61ae76166b0e9fa08a7daced3e8f3ac7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_data_target.html#a61ae76166b0e9fa08a7daced3e8f3ac7">DataTarget</a> ()</td></tr>
<tr class="memdesc:a61ae76166b0e9fa08a7daced3e8f3ac7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a61ae76166b0e9fa08a7daced3e8f3ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fecc67ca65e22d84df632e3360831a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fecc67ca65e22d84df632e3360831a5"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_data_target.html#a6fecc67ca65e22d84df632e3360831a5">~DataTarget</a> ()</td></tr>
<tr class="memdesc:a6fecc67ca65e22d84df632e3360831a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a6fecc67ca65e22d84df632e3360831a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a504732009e9528999a95b416f5941dca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a504732009e9528999a95b416f5941dca"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_data_target.html#a504732009e9528999a95b416f5941dca">isBounded</a> ()</td></tr>
<tr class="memdesc:a504732009e9528999a95b416f5941dca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the target is just a single address or has an end to it. <br /></td></tr>
<tr class="separator:a504732009e9528999a95b416f5941dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d690ed5242ee30e16faee64e42066aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d690ed5242ee30e16faee64e42066aa"></a>
virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>getBeginAddress</b> ()</td></tr>
<tr class="separator:a7d690ed5242ee30e16faee64e42066aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc9d0321d12b39e8e19517577e7ca1d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4bc9d0321d12b39e8e19517577e7ca1d"></a>
virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>getEndAddress</b> ()</td></tr>
<tr class="separator:a4bc9d0321d12b39e8e19517577e7ca1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c6d6da716a0f0a0de14307309a5b2e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c6d6da716a0f0a0de14307309a5b2e9"></a>
virtual <a class="el" href="classelftosb_1_1_data_target.html#structelftosb_1_1_data_target_1_1_address_range">DataTarget::AddressRange</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_data_target.html#a0c6d6da716a0f0a0de14307309a5b2e9">getRangeForSegment</a> (<a class="el" href="classelftosb_1_1_data_source.html">DataSource</a> &amp;source, <a class="el" href="classelftosb_1_1_data_source_1_1_segment.html">DataSource::Segment</a> &amp;segment)=0</td></tr>
<tr class="memdesc:a0c6d6da716a0f0a0de14307309a5b2e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the address range for a segment of a data source. <br /></td></tr>
<tr class="separator:a0c6d6da716a0f0a0de14307309a5b2e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d36d0d379f0e0ee2b62e3704e9db473"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d36d0d379f0e0ee2b62e3704e9db473"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setSource</b> (<a class="el" href="classelftosb_1_1_data_source.html">DataSource</a> *source)</td></tr>
<tr class="separator:a4d36d0d379f0e0ee2b62e3704e9db473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affc8d9869872fc9fdc96cc77f5920039"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affc8d9869872fc9fdc96cc77f5920039"></a>
<a class="el" href="classelftosb_1_1_data_source.html">DataSource</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getSource</b> () const </td></tr>
<tr class="separator:affc8d9869872fc9fdc96cc77f5920039"><td class="memSeparator" colspan="2">&#160;</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:a953016d52475396de1774dd027cfa934"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a953016d52475396de1774dd027cfa934"></a>
<a class="el" href="classelftosb_1_1_data_source.html">DataSource</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_data_target.html#a953016d52475396de1774dd027cfa934">m_source</a></td></tr>
<tr class="memdesc:a953016d52475396de1774dd027cfa934"><td class="mdescLeft">&#160;</td><td class="mdescRight">Corresponding data source for this target. <br /></td></tr>
<tr class="separator:a953016d52475396de1774dd027cfa934"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base class for the target address or range of data. </p>
<p>Targets at the most basic level have a single address, and potentially an address range. Unbounded targets have a beginning address but no specific end address, while bounded targets do have an end address.</p>
<p>Users of a data target can access the begin and end addresses directly. However, the most powerful way to use a target is with the <a class="el" href="classelftosb_1_1_data_target.html#a0c6d6da716a0f0a0de14307309a5b2e9" title="Return the address range for a segment of a data source. ">getRangeForSegment()</a> method. This method returns the target address range for a segment of a data source. The value of the resulting range can be completely dependent upon the segment's properties, those of its data source, and the type of data target.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classelftosb_1_1_data_source.html" title="Abstract base class for data sources. ">elftosb::DataSource</a> </dd></dl>
</div><hr/><h2 class="groupheader">Class Documentation</h2>
<a name="structelftosb_1_1_data_target_1_1_address_range" id="structelftosb_1_1_data_target_1_1_address_range"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct elftosb::DataTarget::AddressRange</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Simple structure that describes an addressed region of memory. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a4a0e705219371ed50c4f8bc126ad565e"></a>uint32_t</td>
<td class="fieldname">
m_begin</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac2d0c8ba3912fd5dbe65e43b95c1fcd3"></a>uint32_t</td>
<td class="fieldname">
m_end</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="apps_2elftosb_2common_2_data_target_8h_source.html">apps/elftosb/common/DataTarget.h</a></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>elftosb</b></li><li class="navelem"><a class="el" href="classelftosb_1_1_data_target.html">DataTarget</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>