127 lines
12 KiB
HTML
127 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 Host: BootImage.h Source File</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><!-- 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('_boot_image_8h_source.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="headertitle">
|
|
<div class="title">BootImage.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * File: BootImage.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) Freescale Semiconductor, Inc. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * See included license file for license details.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#if !defined(_BootImage_h_)</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define _BootImage_h_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "Version.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span><a class="code" href="namespaceelftosb.html">elftosb</a></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classelftosb_1_1_boot_image.html"> 25</a></span> <span class="keyword">class </span><a class="code" href="classelftosb_1_1_boot_image.html">BootImage</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classelftosb_1_1_boot_image.html#aeddebff1301da30a651ee1cdd05abbe2"> 29</a></span>  <a class="code" href="classelftosb_1_1_boot_image.html#aeddebff1301da30a651ee1cdd05abbe2">BootImage</a>() {}</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classelftosb_1_1_boot_image.html#aa6b430732e272b586ce7447dc1acce63"> 31</a></span>  <span class="keyword">virtual</span> <a class="code" href="classelftosb_1_1_boot_image.html#aa6b430732e272b586ce7447dc1acce63">~BootImage</a>() {}</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setProductVersion(<span class="keyword">const</span> <a class="code" href="structelftosb_1_1version__t.html">version_t</a> &version) = 0;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setComponentVersion(<span class="keyword">const</span> <a class="code" href="structelftosb_1_1version__t.html">version_t</a> &version) = 0;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classelftosb_1_1_boot_image.html#ad480f6dc3bcafb288c9872a4d68ac136">setDriveTag</a>(uint16_t tag) = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">virtual</span> std::string <a class="code" href="classelftosb_1_1_boot_image.html#a6200d3a2e011c89b1d2ce11831e7d82e">getFileExtension</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classelftosb_1_1_boot_image.html#a5432533735fff9ad3156e6fc5b96981c">writeToStream</a>(std::ostream &stream) = 0;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> };</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }; <span class="comment">// namespace elftosb</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif // _BootImage_h_</span></div><div class="ttc" id="classelftosb_1_1_boot_image_html_aa6b430732e272b586ce7447dc1acce63"><div class="ttname"><a href="classelftosb_1_1_boot_image.html#aa6b430732e272b586ce7447dc1acce63">elftosb::BootImage::~BootImage</a></div><div class="ttdeci">virtual ~BootImage()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> BootImage.h:31</div></div>
|
|
<div class="ttc" id="classelftosb_1_1_boot_image_html_a6200d3a2e011c89b1d2ce11831e7d82e"><div class="ttname"><a href="classelftosb_1_1_boot_image.html#a6200d3a2e011c89b1d2ce11831e7d82e">elftosb::BootImage::getFileExtension</a></div><div class="ttdeci">virtual std::string getFileExtension() const =0</div><div class="ttdoc">Returns a string containing the preferred file extension for image format. </div></div>
|
|
<div class="ttc" id="classelftosb_1_1_boot_image_html_a5432533735fff9ad3156e6fc5b96981c"><div class="ttname"><a href="classelftosb_1_1_boot_image.html#a5432533735fff9ad3156e6fc5b96981c">elftosb::BootImage::writeToStream</a></div><div class="ttdeci">virtual void writeToStream(std::ostream &stream)=0</div><div class="ttdoc">Write the boot image to an output stream. </div></div>
|
|
<div class="ttc" id="namespaceelftosb_html"><div class="ttname"><a href="namespaceelftosb.html">elftosb</a></div><div class="ttdef"><b>Definition:</b> BootImage.h:13</div></div>
|
|
<div class="ttc" id="classelftosb_1_1_boot_image_html_aeddebff1301da30a651ee1cdd05abbe2"><div class="ttname"><a href="classelftosb_1_1_boot_image.html#aeddebff1301da30a651ee1cdd05abbe2">elftosb::BootImage::BootImage</a></div><div class="ttdeci">BootImage()</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> BootImage.h:29</div></div>
|
|
<div class="ttc" id="classelftosb_1_1_boot_image_html"><div class="ttname"><a href="classelftosb_1_1_boot_image.html">elftosb::BootImage</a></div><div class="ttdoc">Abstract base class for all boot image format classes. </div><div class="ttdef"><b>Definition:</b> BootImage.h:25</div></div>
|
|
<div class="ttc" id="structelftosb_1_1version__t_html"><div class="ttname"><a href="structelftosb_1_1version__t.html">elftosb::version_t</a></div><div class="ttdoc">Same version struct used for 3600 boot image. </div><div class="ttdef"><b>Definition:</b> Version.h:16</div></div>
|
|
<div class="ttc" id="classelftosb_1_1_boot_image_html_ad480f6dc3bcafb288c9872a4d68ac136"><div class="ttname"><a href="classelftosb_1_1_boot_image.html#ad480f6dc3bcafb288c9872a4d68ac136">elftosb::BootImage::setDriveTag</a></div><div class="ttdeci">virtual void setDriveTag(uint16_t tag)=0</div><div class="ttdoc">Specify the drive tag to be set in the output file header. </div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_96c2f84c885cff71a930b6845f88cdd3.html">elftosb</a></li><li class="navelem"><a class="el" href="dir_c476059e18722267e10e2fb2cca6f785.html">common</a></li><li class="navelem"><b>BootImage.h</b></li>
|
|
<li class="footer">Generated on Mon Mar 7 2016 16:49:49 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>
|