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

143 lines
6.9 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: Introduction</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 class="current"><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><!-- 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('index.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">Introduction </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2>Getting Started </h2>
<p>For each supported target there is a demo application user's guide available in the package. This guide includes information about the tool chain required to build the bootloader and a guide to getting started using the supported board platform.</p>
<h2>Features </h2>
<p>The bootloader code base contains source code and tool chain projects for building flash-resident bootloaders and flashloaders for the supported platforms. A flash-resident bootloader stays resident in flash along with the user application. A flahloader is loaded to RAM by a small program residing in flash. The bootloader can be used to download and program an initial application image into a blank area on the flash, and to later to update the application.</p>
<p>The bootloader supports the following communication interfaces for downloading an application:</p>
<ul>
<li>USB HID</li>
<li>USB MSC</li>
<li>UART</li>
<li>I2C</li>
<li>SPI</li>
<li>CAN</li>
</ul>
<p>The exact interfaces available depend on the target platform.</p>
<p>Typically, USB and UART connections are made directly to a PC, whereas I2C, SPI and CAN require additional hardware. The bootloader, running on the target platform, acts as a communication slave. The bootloader can automatically detect which peripheral is being used to download the application and, in the case of UART and CAN, automatically detect the baud rate.</p>
<p>See the <code>apps/bus_pal</code> project for an example using pass-through hardware to connect to a target bootloader over I2C, SPI, and CAN. See the <code>validation/embedded_host</code> project for an example of a full embedded host application.</p>
<p>The application image is downloaded to the target through a series of command and data packets sent from a host PC or embedded host platform. For more information on the packet protocol, see the code documentation in the doc directory.</p>
<h2>Host tools </h2>
<p>The code base also contains source code and build projects for the following PC-based host tools:</p>
<ul>
<li>Kinetis blhost - command line debug tool to send individual commands to the bootloader</li>
<li>KinetisFlashTool - GUI application to download and flash an application image</li>
<li>Kinetis elftosb - command line tool to encrpyt an application image for download</li>
</ul>
<p>The blhost and elftosb applications run on Windows XP and higher, Linux, and Mac OS X. The KinetisFlashTool application runs on Windows XP and higher. </p>
</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:49:52 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>