282 lines
18 KiB
HTML
282 lines
18 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::DataPacket 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_data_packet.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> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classblfwk_1_1_data_packet-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::DataPacket Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Data packet operations.
|
|
<a href="classblfwk_1_1_data_packet.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_command_8h_source.html">Command.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="+"/> Collaboration diagram for blfwk::DataPacket:</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_data_packet__coll__graph.svg" width="318" height="142"><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:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_data_consumer.html">DataConsumer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract class to consume data from data phase. <a href="classblfwk_1_1_data_packet_1_1_data_consumer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_data_producer.html">DataProducer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract class to provide data for data phase. <a href="classblfwk_1_1_data_packet_1_1_data_producer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_file_data_consumer.html">FileDataConsumer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Write file data for data phase receive. <a href="classblfwk_1_1_data_packet_1_1_file_data_consumer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_file_data_producer.html">FileDataProducer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Provide file data for data phase. <a href="classblfwk_1_1_data_packet_1_1_file_data_producer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_hex_data_producer.html">HexDataProducer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Provide data from hex string for data phase. <a href="classblfwk_1_1_data_packet_1_1_hex_data_producer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_segment_data_producer.html">SegmentDataProducer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Provide <a class="el" href="classblfwk_1_1_data_source_1_1_segment.html" title="Discrete, contiguous part of the source's data. ">DataSource::Segment</a> data for data phase. <a href="classblfwk_1_1_data_packet_1_1_segment_data_producer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet_1_1_std_out_data_consumer.html">StdOutDataConsumer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Print data for data phase receive. <a href="classblfwk_1_1_data_packet_1_1_std_out_data_consumer.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:ac3c58eed3f22bc481534d58c96e2aff8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3c58eed3f22bc481534d58c96e2aff8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#ac3c58eed3f22bc481534d58c96e2aff8">DataPacket</a> (<a class="el" href="classblfwk_1_1_data_packet_1_1_data_producer.html">DataProducer</a> *dataProducer)</td></tr>
|
|
<tr class="memdesc:ac3c58eed3f22bc481534d58c96e2aff8"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that takes a <a class="el" href="classblfwk_1_1_data_packet_1_1_data_producer.html" title="Abstract class to provide data for data phase. ">DataProducer</a>. <br /></td></tr>
|
|
<tr class="separator:ac3c58eed3f22bc481534d58c96e2aff8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae959185de331aca28b7d37ac018ba78e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae959185de331aca28b7d37ac018ba78e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#ae959185de331aca28b7d37ac018ba78e">DataPacket</a> (<a class="el" href="classblfwk_1_1_data_packet_1_1_data_consumer.html">DataConsumer</a> *dataConsumer)</td></tr>
|
|
<tr class="memdesc:ae959185de331aca28b7d37ac018ba78e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that takes a <a class="el" href="classblfwk_1_1_data_packet_1_1_data_consumer.html" title="Abstract class to consume data from data phase. ">DataConsumer</a>. <br /></td></tr>
|
|
<tr class="separator:ae959185de331aca28b7d37ac018ba78e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0406808cb5c37f40cfb5a8b66075241b"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#a0406808cb5c37f40cfb5a8b66075241b">sendTo</a> (<a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> &device, uint32_t *bytesWritten, <a class="el" href="classblfwk_1_1_progress.html">Progress</a> *progress)</td></tr>
|
|
<tr class="memdesc:a0406808cb5c37f40cfb5a8b66075241b"><td class="mdescLeft"> </td><td class="mdescRight">Send data packet to device. <a href="#a0406808cb5c37f40cfb5a8b66075241b">More...</a><br /></td></tr>
|
|
<tr class="separator:a0406808cb5c37f40cfb5a8b66075241b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a590399048008566f309b6591da502401"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#a590399048008566f309b6591da502401">receiveFrom</a> (<a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> &device, uint32_t *byteCount, <a class="el" href="classblfwk_1_1_progress.html">Progress</a> *progress)</td></tr>
|
|
<tr class="memdesc:a590399048008566f309b6591da502401"><td class="mdescLeft"> </td><td class="mdescRight">Receive data packet from device. <a href="#a590399048008566f309b6591da502401">More...</a><br /></td></tr>
|
|
<tr class="separator:a590399048008566f309b6591da502401"><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:ab5ba6cd0eaac51de22f7dea20db06e0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5ba6cd0eaac51de22f7dea20db06e0d"></a>
|
|
<a class="el" href="classblfwk_1_1_data_packet_1_1_data_producer.html">DataProducer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#ab5ba6cd0eaac51de22f7dea20db06e0d">m_dataProducer</a></td></tr>
|
|
<tr class="memdesc:ab5ba6cd0eaac51de22f7dea20db06e0d"><td class="mdescLeft"> </td><td class="mdescRight">Provides data for the packet. <br /></td></tr>
|
|
<tr class="separator:ab5ba6cd0eaac51de22f7dea20db06e0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aded94e04d37e645c818ac5934067e4ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aded94e04d37e645c818ac5934067e4ca"></a>
|
|
<a class="el" href="classblfwk_1_1_data_packet_1_1_data_consumer.html">DataConsumer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#aded94e04d37e645c818ac5934067e4ca">m_dataConsumer</a></td></tr>
|
|
<tr class="memdesc:aded94e04d37e645c818ac5934067e4ca"><td class="mdescLeft"> </td><td class="mdescRight">Process the data in the packet. <br /></td></tr>
|
|
<tr class="separator:aded94e04d37e645c818ac5934067e4ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9be86a98ab81a6bd157132f860d28c0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9be86a98ab81a6bd157132f860d28c0b"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_packet.html#a9be86a98ab81a6bd157132f860d28c0b">m_packet</a> [kMinPacketBufferSize]</td></tr>
|
|
<tr class="memdesc:a9be86a98ab81a6bd157132f860d28c0b"><td class="mdescLeft"> </td><td class="mdescRight">The data packet. <br /></td></tr>
|
|
<tr class="separator:a9be86a98ab81a6bd157132f860d28c0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Data packet operations. </p>
|
|
<p>Formats data packets and runs data phase. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a590399048008566f309b6591da502401"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t * blfwk::DataPacket::receiveFrom </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> & </td>
|
|
<td class="paramname"><em>device</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>byteCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classblfwk_1_1_progress.html">Progress</a> * </td>
|
|
<td class="paramname"><em>progress</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receive data packet from device. </p>
|
|
<p>See host_command.h for documentation on this function.</p>
|
|
<p>Calls the data consumer to process the receied data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0406808cb5c37f40cfb5a8b66075241b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t * blfwk::DataPacket::sendTo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> & </td>
|
|
<td class="paramname"><em>device</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>bytesWritten</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classblfwk_1_1_progress.html">Progress</a> * </td>
|
|
<td class="paramname"><em>progress</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send data packet to device. </p>
|
|
<p>See host_command.h for documentation on this function.</p>
|
|
<p>Calls the data provide to get the data to send. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_command_8h_source.html">Command.h</a></li>
|
|
<li>Command.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_data_packet.html">DataPacket</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>
|