553 lines
42 KiB
HTML
553 lines
42 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::SerialPacketizer 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_serial_packetizer.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-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classblfwk_1_1_serial_packetizer-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::SerialPacketizer Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides source and sink for packets that go over the serial peripherals.
|
|
<a href="classblfwk_1_1_serial_packetizer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_serial_packetizer_8h_source.html">SerialPacketizer.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::SerialPacketizer:</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_serial_packetizer__inherit__graph.svg" width="166" 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::SerialPacketizer:</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_serial_packetizer__coll__graph.svg" width="283" height="203"><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:abc39cf20b8ade1c1fa8a884328e91141"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc39cf20b8ade1c1fa8a884328e91141"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#abc39cf20b8ade1c1fa8a884328e91141">SerialPacketizer</a> (<a class="el" href="classblfwk_1_1_uart_peripheral.html">UartPeripheral</a> *peripheral, uint32_t packetTimeoutMs)</td></tr>
|
|
<tr class="memdesc:abc39cf20b8ade1c1fa8a884328e91141"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
|
|
<tr class="separator:abc39cf20b8ade1c1fa8a884328e91141"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80dbfe7fbdc8f4780c23af931889c5f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80dbfe7fbdc8f4780c23af931889c5f8"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a80dbfe7fbdc8f4780c23af931889c5f8">~SerialPacketizer</a> ()</td></tr>
|
|
<tr class="memdesc:a80dbfe7fbdc8f4780c23af931889c5f8"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a80dbfe7fbdc8f4780c23af931889c5f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb7cf492c0ac4d408c2edd37fcc7ba6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb7cf492c0ac4d408c2edd37fcc7ba6a"></a>
|
|
virtual <a class="el" href="classblfwk_1_1_uart_peripheral.html">UartPeripheral</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#acb7cf492c0ac4d408c2edd37fcc7ba6a">getPeripheral</a> ()</td></tr>
|
|
<tr class="memdesc:acb7cf492c0ac4d408c2edd37fcc7ba6a"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classblfwk_1_1_peripheral.html" title="Represents a peripheral. ">Peripheral</a> accessor. <br /></td></tr>
|
|
<tr class="separator:acb7cf492c0ac4d408c2edd37fcc7ba6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc40bb62f022974983167f90bddb8bf0"><td class="memItemLeft" align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#abc40bb62f022974983167f90bddb8bf0">readPacket</a> (uint8_t **packet, uint32_t *packetLength, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:abc40bb62f022974983167f90bddb8bf0"><td class="mdescLeft"> </td><td class="mdescRight">Read a packet. <a href="#abc40bb62f022974983167f90bddb8bf0">More...</a><br /></td></tr>
|
|
<tr class="separator:abc40bb62f022974983167f90bddb8bf0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a4389d57f7b99377f6ce86ae002f4eb"><td class="memItemLeft" align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a9a4389d57f7b99377f6ce86ae002f4eb">writePacket</a> (const uint8_t *packet, uint32_t byteCount, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:a9a4389d57f7b99377f6ce86ae002f4eb"><td class="mdescLeft"> </td><td class="mdescRight">Write a packet. <a href="#a9a4389d57f7b99377f6ce86ae002f4eb">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a4389d57f7b99377f6ce86ae002f4eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8575c6573ea7c45335e2b832fbcb2e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8575c6573ea7c45335e2b832fbcb2e7"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#ae8575c6573ea7c45335e2b832fbcb2e7">abortPacket</a> ()</td></tr>
|
|
<tr class="memdesc:ae8575c6573ea7c45335e2b832fbcb2e7"><td class="mdescLeft"> </td><td class="mdescRight">Abort data phase. <br /></td></tr>
|
|
<tr class="separator:ae8575c6573ea7c45335e2b832fbcb2e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08a23c2d1d4d1ec23052846e866d3d9e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08a23c2d1d4d1ec23052846e866d3d9e"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a08a23c2d1d4d1ec23052846e866d3d9e">sync</a> ()</td></tr>
|
|
<tr class="memdesc:a08a23c2d1d4d1ec23052846e866d3d9e"><td class="mdescLeft"> </td><td class="mdescRight">Send framing packet ack. <br /></td></tr>
|
|
<tr class="separator:a08a23c2d1d4d1ec23052846e866d3d9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a643048340a0c3019585205cd8351e688"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a643048340a0c3019585205cd8351e688"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a643048340a0c3019585205cd8351e688">finalize</a> ()</td></tr>
|
|
<tr class="memdesc:a643048340a0c3019585205cd8351e688"><td class="mdescLeft"> </td><td class="mdescRight">Finalize. <br /></td></tr>
|
|
<tr class="separator:a643048340a0c3019585205cd8351e688"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a06372a1380a3e0c51da181adb811ed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a06372a1380a3e0c51da181adb811ed"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a5a06372a1380a3e0c51da181adb811ed">enableSimulatorPump</a> ()</td></tr>
|
|
<tr class="memdesc:a5a06372a1380a3e0c51da181adb811ed"><td class="mdescLeft"> </td><td class="mdescRight">Enable simulator command processor pump. <br /></td></tr>
|
|
<tr class="separator:a5a06372a1380a3e0c51da181adb811ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86f81a18028edbc70886e49f6599e3c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86f81a18028edbc70886e49f6599e3c3"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a86f81a18028edbc70886e49f6599e3c3">pumpSimulator</a> ()</td></tr>
|
|
<tr class="memdesc:a86f81a18028edbc70886e49f6599e3c3"><td class="mdescLeft"> </td><td class="mdescRight">Pump simulator command processor. <br /></td></tr>
|
|
<tr class="separator:a86f81a18028edbc70886e49f6599e3c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a777237326f971a44d0c189605fcc02"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a777237326f971a44d0c189605fcc02"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a0a777237326f971a44d0c189605fcc02">setAborted</a> (bool aborted)</td></tr>
|
|
<tr class="memdesc:a0a777237326f971a44d0c189605fcc02"><td class="mdescLeft"> </td><td class="mdescRight">Set aborted flag. <br /></td></tr>
|
|
<tr class="separator:a0a777237326f971a44d0c189605fcc02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb0d60956fbf413095204fe74c0fc433"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb0d60956fbf413095204fe74c0fc433"></a>
|
|
virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#abb0d60956fbf413095204fe74c0fc433">getMaxPacketSize</a> ()</td></tr>
|
|
<tr class="memdesc:abb0d60956fbf413095204fe74c0fc433"><td class="mdescLeft"> </td><td class="mdescRight">Return the max packet size. <br /></td></tr>
|
|
<tr class="separator:abb0d60956fbf413095204fe74c0fc433"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae78b70bdd8c67ed2649feadcf8bea656"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae78b70bdd8c67ed2649feadcf8bea656"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#ae78b70bdd8c67ed2649feadcf8bea656">host_delay</a> (uint32_t milliseconds)</td></tr>
|
|
<tr class="memdesc:ae78b70bdd8c67ed2649feadcf8bea656"><td class="mdescLeft"> </td><td class="mdescRight">Delay milliseconds. <br /></td></tr>
|
|
<tr class="separator:ae78b70bdd8c67ed2649feadcf8bea656"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01942247141e3a736caae54262829b55"><td class="memItemLeft" align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a01942247141e3a736caae54262829b55">ping</a> (int retries, unsigned int delay, ping_response_t *response, int comSpeed)</td></tr>
|
|
<tr class="memdesc:a01942247141e3a736caae54262829b55"><td class="mdescLeft"> </td><td class="mdescRight">Send a ping packet and receive an ack. <a href="#a01942247141e3a736caae54262829b55">More...</a><br /></td></tr>
|
|
<tr class="separator:a01942247141e3a736caae54262829b55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classblfwk_1_1_packetizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classblfwk_1_1_packetizer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classblfwk_1_1_packetizer.html">blfwk::Packetizer</a></td></tr>
|
|
<tr class="memitem:a551c4f77195f103fe5381a46022b7181 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a551c4f77195f103fe5381a46022b7181"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Packetizer</b> (<a class="el" href="classblfwk_1_1_peripheral.html">Peripheral</a> *peripheral, uint32_t packetTimeoutMs)</td></tr>
|
|
<tr class="separator:a551c4f77195f103fe5381a46022b7181 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f3bc78bc5e017c724bc74ab4e152865 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f3bc78bc5e017c724bc74ab4e152865"></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_packetizer.html#a5f3bc78bc5e017c724bc74ab4e152865">getVersion</a> ()</td></tr>
|
|
<tr class="memdesc:a5f3bc78bc5e017c724bc74ab4e152865 inherit pub_methods_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Get Framing Protocol Version. <br /></td></tr>
|
|
<tr class="separator:a5f3bc78bc5e017c724bc74ab4e152865 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3e3b79adae45dcb52180a3074324f60 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3e3b79adae45dcb52180a3074324f60"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#ad3e3b79adae45dcb52180a3074324f60">getOptions</a> ()</td></tr>
|
|
<tr class="memdesc:ad3e3b79adae45dcb52180a3074324f60 inherit pub_methods_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Get Framing Protocol <a class="el" href="class_options.html" title="parse command-line options ">Options</a>. <br /></td></tr>
|
|
<tr class="separator:ad3e3b79adae45dcb52180a3074324f60 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc8562612432eb8015032c0285fb3ef9 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc8562612432eb8015032c0285fb3ef9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#abc8562612432eb8015032c0285fb3ef9">setAbortEnabled</a> (bool isEnabled)</td></tr>
|
|
<tr class="memdesc:abc8562612432eb8015032c0285fb3ef9 inherit pub_methods_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Set abort packet check enable. <br /></td></tr>
|
|
<tr class="separator:abc8562612432eb8015032c0285fb3ef9 inherit pub_methods_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3ff3f9195463356abd95070501d52ae inherit pub_methods_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3ff3f9195463356abd95070501d52ae"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#aa3ff3f9195463356abd95070501d52ae">isAbortEnabled</a> ()</td></tr>
|
|
<tr class="memdesc:aa3ff3f9195463356abd95070501d52ae inherit pub_methods_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Check if abort data phase is enabled. <br /></td></tr>
|
|
<tr class="separator:aa3ff3f9195463356abd95070501d52ae inherit pub_methods_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a349a49399c7449d5d0c8c25636238de3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a349a49399c7449d5d0c8c25636238de3"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a349a49399c7449d5d0c8c25636238de3">send_deferred_ack</a> ()</td></tr>
|
|
<tr class="memdesc:a349a49399c7449d5d0c8c25636238de3"><td class="mdescLeft"> </td><td class="mdescRight">Send ACK if needed. <br /></td></tr>
|
|
<tr class="separator:a349a49399c7449d5d0c8c25636238de3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a64691cbb7f90457343e738af04ce4f89"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a64691cbb7f90457343e738af04ce4f89">serial_packet_read</a> (uint8_t **packet, uint32_t *packetLength, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:a64691cbb7f90457343e738af04ce4f89"><td class="mdescLeft"> </td><td class="mdescRight">Read packet using serial framing. <a href="#a64691cbb7f90457343e738af04ce4f89">More...</a><br /></td></tr>
|
|
<tr class="separator:a64691cbb7f90457343e738af04ce4f89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d601318f2ee5dcffe1aef52fbe5b7d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d601318f2ee5dcffe1aef52fbe5b7d4"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a3d601318f2ee5dcffe1aef52fbe5b7d4">serial_packet_write</a> (const uint8_t *packet, uint32_t byteCount, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:a3d601318f2ee5dcffe1aef52fbe5b7d4"><td class="mdescLeft"> </td><td class="mdescRight">Write packet using serial framing. <br /></td></tr>
|
|
<tr class="separator:a3d601318f2ee5dcffe1aef52fbe5b7d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3002c8f8bb7ac25e0669563d546ff9ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a3002c8f8bb7ac25e0669563d546ff9ff">serial_packet_abort</a> ()</td></tr>
|
|
<tr class="memdesc:a3002c8f8bb7ac25e0669563d546ff9ff"><td class="mdescLeft"> </td><td class="mdescRight">Abort data phase. <a href="#a3002c8f8bb7ac25e0669563d546ff9ff">More...</a><br /></td></tr>
|
|
<tr class="separator:a3002c8f8bb7ac25e0669563d546ff9ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e25fdfbea607fc5627696a7fd5ee67f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e25fdfbea607fc5627696a7fd5ee67f"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a6e25fdfbea607fc5627696a7fd5ee67f">serial_packet_get_max_packet_size</a> ()</td></tr>
|
|
<tr class="memdesc:a6e25fdfbea607fc5627696a7fd5ee67f"><td class="mdescLeft"> </td><td class="mdescRight">Get max packet size. <br /></td></tr>
|
|
<tr class="separator:a6e25fdfbea607fc5627696a7fd5ee67f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbae3f161723bc01bb1cf520a68b2db4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbae3f161723bc01bb1cf520a68b2db4"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#acbae3f161723bc01bb1cf520a68b2db4">serial_packet_send_sync</a> (uint8_t framingPacketType)</td></tr>
|
|
<tr class="memdesc:acbae3f161723bc01bb1cf520a68b2db4"><td class="mdescLeft"> </td><td class="mdescRight">Send a sync packet of the specified type. <br /></td></tr>
|
|
<tr class="separator:acbae3f161723bc01bb1cf520a68b2db4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae29486dd32430ea6c5f0b2dce1687a51"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae29486dd32430ea6c5f0b2dce1687a51"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#ae29486dd32430ea6c5f0b2dce1687a51">serial_send_ping_response</a> ()</td></tr>
|
|
<tr class="memdesc:ae29486dd32430ea6c5f0b2dce1687a51"><td class="mdescLeft"> </td><td class="mdescRight">Send a ping message back in response to a ping. <br /></td></tr>
|
|
<tr class="separator:ae29486dd32430ea6c5f0b2dce1687a51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82e2dd00be0f967486e38bad057ad061"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82e2dd00be0f967486e38bad057ad061"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a82e2dd00be0f967486e38bad057ad061">wait_for_ack_packet</a> ()</td></tr>
|
|
<tr class="memdesc:a82e2dd00be0f967486e38bad057ad061"><td class="mdescLeft"> </td><td class="mdescRight">Wait for an ACK, handling NAKs as needed. <br /></td></tr>
|
|
<tr class="separator:a82e2dd00be0f967486e38bad057ad061"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1dae5365ac79092253374c1bca7e006"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1dae5365ac79092253374c1bca7e006"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#aa1dae5365ac79092253374c1bca7e006">read_data_packet</a> (framing_data_packet_t *packet, uint8_t *data, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:aa1dae5365ac79092253374c1bca7e006"><td class="mdescLeft"> </td><td class="mdescRight">Read from peripheral until entire data framing packet read. <br /></td></tr>
|
|
<tr class="separator:aa1dae5365ac79092253374c1bca7e006"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a497ba9655c4e48d126465615b994b99d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a497ba9655c4e48d126465615b994b99d"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a497ba9655c4e48d126465615b994b99d">read_start_byte</a> (framing_header_t *header)</td></tr>
|
|
<tr class="memdesc:a497ba9655c4e48d126465615b994b99d"><td class="mdescLeft"> </td><td class="mdescRight">Read from peripheral until start byte found. <br /></td></tr>
|
|
<tr class="separator:a497ba9655c4e48d126465615b994b99d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03e19ce524304ac3c92a20928f76dd55"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03e19ce524304ac3c92a20928f76dd55"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a03e19ce524304ac3c92a20928f76dd55">read_header</a> (framing_header_t *header)</td></tr>
|
|
<tr class="memdesc:a03e19ce524304ac3c92a20928f76dd55"><td class="mdescLeft"> </td><td class="mdescRight">Read from peripheral until packet header found. <br /></td></tr>
|
|
<tr class="separator:a03e19ce524304ac3c92a20928f76dd55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bc3e00222bf867522250e49a6fd3500"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bc3e00222bf867522250e49a6fd3500"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a0bc3e00222bf867522250e49a6fd3500">read_length</a> (framing_data_packet_t *packet)</td></tr>
|
|
<tr class="memdesc:a0bc3e00222bf867522250e49a6fd3500"><td class="mdescLeft"> </td><td class="mdescRight">Read from peripheral until packet length found. <br /></td></tr>
|
|
<tr class="separator:a0bc3e00222bf867522250e49a6fd3500"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03644c904727411021e645b42c0573e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03644c904727411021e645b42c0573e8"></a>
|
|
status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#a03644c904727411021e645b42c0573e8">read_crc16</a> (framing_data_packet_t *packet)</td></tr>
|
|
<tr class="memdesc:a03644c904727411021e645b42c0573e8"><td class="mdescLeft"> </td><td class="mdescRight">Read from peripheral until crc16 is found. <br /></td></tr>
|
|
<tr class="separator:a03644c904727411021e645b42c0573e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7ecc097c540ca46d556daf5302f0db9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7ecc097c540ca46d556daf5302f0db9"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_serial_packetizer.html#ad7ecc097c540ca46d556daf5302f0db9">calculate_framing_crc16</a> (framing_data_packet_t *packet, const uint8_t *data)</td></tr>
|
|
<tr class="memdesc:ad7ecc097c540ca46d556daf5302f0db9"><td class="mdescLeft"> </td><td class="mdescRight">Calculate crc over framing data packet. <br /></td></tr>
|
|
<tr class="separator:ad7ecc097c540ca46d556daf5302f0db9"><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:ad9e1aa56a89d4e2dfa7b74ccc4c03cf8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9e1aa56a89d4e2dfa7b74ccc4c03cf8"></a>
|
|
serial_data_t </td><td class="memItemRight" valign="bottom"><b>m_serialContext</b></td></tr>
|
|
<tr class="separator:ad9e1aa56a89d4e2dfa7b74ccc4c03cf8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classblfwk_1_1_packetizer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classblfwk_1_1_packetizer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classblfwk_1_1_packetizer.html">blfwk::Packetizer</a></td></tr>
|
|
<tr class="memitem:a5810c0358eb37df691628f47a814aab5 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5810c0358eb37df691628f47a814aab5"></a>
|
|
<a class="el" href="classblfwk_1_1_peripheral.html">Peripheral</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#a5810c0358eb37df691628f47a814aab5">m_peripheral</a></td></tr>
|
|
<tr class="memdesc:a5810c0358eb37df691628f47a814aab5 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classblfwk_1_1_peripheral.html" title="Represents a peripheral. ">Peripheral</a> to send/receive bytes on. <br /></td></tr>
|
|
<tr class="separator:a5810c0358eb37df691628f47a814aab5 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4a91e40cb3e0b7b105741a727342b66 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4a91e40cb3e0b7b105741a727342b66"></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_packetizer.html#aa4a91e40cb3e0b7b105741a727342b66">m_version</a></td></tr>
|
|
<tr class="memdesc:aa4a91e40cb3e0b7b105741a727342b66 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Framing protocol version. <br /></td></tr>
|
|
<tr class="separator:aa4a91e40cb3e0b7b105741a727342b66 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b494eb927573f018377fadc485c6fb4 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b494eb927573f018377fadc485c6fb4"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#a1b494eb927573f018377fadc485c6fb4">m_options</a></td></tr>
|
|
<tr class="memdesc:a1b494eb927573f018377fadc485c6fb4 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Framing protocol options bitfield. <br /></td></tr>
|
|
<tr class="separator:a1b494eb927573f018377fadc485c6fb4 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b7ee3af4d435190f237f1fda7dd9888 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b7ee3af4d435190f237f1fda7dd9888"></a>
|
|
clock_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#a3b7ee3af4d435190f237f1fda7dd9888">m_startTime</a></td></tr>
|
|
<tr class="memdesc:a3b7ee3af4d435190f237f1fda7dd9888 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">Beginning time of packet transaction. <br /></td></tr>
|
|
<tr class="separator:a3b7ee3af4d435190f237f1fda7dd9888 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12071087e82d9fb40937d9ec9749516e inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12071087e82d9fb40937d9ec9749516e"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>m_packetTimeoutMs</b></td></tr>
|
|
<tr class="separator:a12071087e82d9fb40937d9ec9749516e inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a110f9c4e693c828b94e39a7466b6feb1 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a110f9c4e693c828b94e39a7466b6feb1"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_packetizer.html#a110f9c4e693c828b94e39a7466b6feb1">m_isAbortEnabled</a></td></tr>
|
|
<tr class="memdesc:a110f9c4e693c828b94e39a7466b6feb1 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="mdescLeft"> </td><td class="mdescRight">True if allowing abort packet. Not used by all packetizers. <br /></td></tr>
|
|
<tr class="separator:a110f9c4e693c828b94e39a7466b6feb1 inherit pro_attribs_classblfwk_1_1_packetizer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides source and sink for packets that go over the serial peripherals. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a01942247141e3a736caae54262829b55"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t SerialPacketizer::ping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>retries</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>delay</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ping_response_t * </td>
|
|
<td class="paramname"><em>response</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>comSpeed</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a ping packet and receive an ack. </p>
|
|
<p>This is a method for host only side pinging of the target. The reponse from the target to a ping packet is a ping response packet. Since the target may or may not be online there is optionally a series of retries to make the best attempt at communication possible</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">retries</td><td>The number of attempts that should be made. </td></tr>
|
|
<tr><td class="paramname">delay</td><td>The time in milliseconds between each attempt. </td></tr>
|
|
<tr><td class="paramname">comSpeed</td><td>The peripheral baud rate. Used in order to calculate the receive delay in the case of low com speeds such as 100 and 300 which need nearly a second to complete </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abc40bb62f022974983167f90bddb8bf0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t SerialPacketizer::readPacket </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t ** </td>
|
|
<td class="paramname"><em>packet</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>packetLength</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">packet_type_t </td>
|
|
<td class="paramname"><em>packetType</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a packet. </p>
|
|
<p>Provides the address of a buffer containing the packet.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">packet</td><td>Pointer location to write packet pointer </td></tr>
|
|
<tr><td class="paramname">packetLength</td><td>Number of bytes in returned packet. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implements <a class="el" href="classblfwk_1_1_packetizer.html#a4fe566f670dfdc840312771a8e9e2ce5">blfwk::Packetizer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3002c8f8bb7ac25e0669563d546ff9ff"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SerialPacketizer::serial_packet_abort </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Abort data phase. </p>
|
|
<p>Respond to next host data packet with AckAbort instead of Ack (i.e. receiver data phase abort). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a64691cbb7f90457343e738af04ce4f89"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t SerialPacketizer::serial_packet_read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t ** </td>
|
|
<td class="paramname"><em>packet</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>packetLength</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">packet_type_t </td>
|
|
<td class="paramname"><em>packetType</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read packet using serial framing. </p>
|
|
<p>On return, caller must call flow control method to send AckContinue or AckWait followed by Continue. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9a4389d57f7b99377f6ce86ae002f4eb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t SerialPacketizer::writePacket </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>packet</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">packet_type_t </td>
|
|
<td class="paramname"><em>packetType</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a packet. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">packet</td><td>Pointer to packet to write. </td></tr>
|
|
<tr><td class="paramname">byteCount</td><td>Number of bytes in packet. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implements <a class="el" href="classblfwk_1_1_packetizer.html#aa17a7ad8b02191c4297da55e0fa7de72">blfwk::Packetizer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_serial_packetizer_8h_source.html">SerialPacketizer.h</a></li>
|
|
<li>SerialPacketizer.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_serial_packetizer.html">SerialPacketizer</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>
|