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

152 lines
37 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: SerialPacketizer.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
&#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><!-- 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('_serial_packetizer_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">SerialPacketizer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2013-14, Freescale Semiconductor, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without modification,</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * are permitted provided that the following conditions are met:</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * o Redistributions of source code must retain the above copyright notice, this list</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * of conditions and the following disclaimer.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * o Redistributions in binary form must reproduce the above copyright notice, this</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * list of conditions and the following disclaimer in the documentation and/or</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * other materials provided with the distribution.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * o Neither the name of Freescale Semiconductor, Inc. nor the names of its</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * contributors may be used to endorse or promote products derived from this</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * software without specific prior written permission.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#ifndef _serial_packetizer_h_</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define _serial_packetizer_h_</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;Packetizer.h&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;UartPeripheral.h&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;bootloader_common.h&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;packet/serial_packet.h&quot;</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceblfwk.html">blfwk</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// Forward declarations.</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">class </span>Peripheral;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classblfwk_1_1_serial_packetizer.html"> 50</a></span>&#160;<span class="keyword">class </span><a class="code" href="classblfwk_1_1_serial_packetizer.html">SerialPacketizer</a> : <span class="keyword">public</span> <a class="code" href="classblfwk_1_1_packetizer.html">Packetizer</a></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classblfwk_1_1_serial_packetizer.html#abc39cf20b8ade1c1fa8a884328e91141">SerialPacketizer</a>(<a class="code" href="classblfwk_1_1_uart_peripheral.html">UartPeripheral</a> *peripheral, uint32_t packetTimeoutMs);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a80dbfe7fbdc8f4780c23af931889c5f8">~SerialPacketizer</a>();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classblfwk_1_1_serial_packetizer.html#acb7cf492c0ac4d408c2edd37fcc7ba6a"> 60</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classblfwk_1_1_uart_peripheral.html">UartPeripheral</a> *<a class="code" href="classblfwk_1_1_serial_packetizer.html#acb7cf492c0ac4d408c2edd37fcc7ba6a">getPeripheral</a>() { <span class="keywordflow">return</span> <span class="keyword">dynamic_cast&lt;</span><a class="code" href="classblfwk_1_1_uart_peripheral.html">UartPeripheral</a> *<span class="keyword">&gt;</span>(<a class="code" href="classblfwk_1_1_packetizer.html#a5810c0358eb37df691628f47a814aab5">m_peripheral</a>); }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">virtual</span> status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#abc40bb62f022974983167f90bddb8bf0">readPacket</a>(uint8_t **packet, uint32_t *packetLength, packet_type_t packetType);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">virtual</span> status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a9a4389d57f7b99377f6ce86ae002f4eb">writePacket</a>(<span class="keyword">const</span> uint8_t *packet, uint32_t byteCount, packet_type_t packetType);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#ae8575c6573ea7c45335e2b832fbcb2e7">abortPacket</a>();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a08a23c2d1d4d1ec23052846e866d3d9e">sync</a>();</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a643048340a0c3019585205cd8351e688">finalize</a>();</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classblfwk_1_1_serial_packetizer.html#a5a06372a1380a3e0c51da181adb811ed"> 85</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a5a06372a1380a3e0c51da181adb811ed">enableSimulatorPump</a>() {}</div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classblfwk_1_1_serial_packetizer.html#a86f81a18028edbc70886e49f6599e3c3"> 87</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a86f81a18028edbc70886e49f6599e3c3">pumpSimulator</a>() {}</div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classblfwk_1_1_serial_packetizer.html#a0a777237326f971a44d0c189605fcc02"> 89</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a0a777237326f971a44d0c189605fcc02">setAborted</a>(<span class="keywordtype">bool</span> aborted) {}</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#abb0d60956fbf413095204fe74c0fc433">getMaxPacketSize</a>();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#ae78b70bdd8c67ed2649feadcf8bea656">host_delay</a>(uint32_t milliseconds);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">virtual</span> status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a01942247141e3a736caae54262829b55">ping</a>(<span class="keywordtype">int</span> retries, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> delay, ping_response_t *response, <span class="keywordtype">int</span> comSpeed);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a349a49399c7449d5d0c8c25636238de3">send_deferred_ack</a>();</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a64691cbb7f90457343e738af04ce4f89">serial_packet_read</a>(uint8_t **packet, uint32_t *packetLength, packet_type_t packetType);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a3d601318f2ee5dcffe1aef52fbe5b7d4">serial_packet_write</a>(<span class="keyword">const</span> uint8_t *packet, uint32_t byteCount, packet_type_t packetType);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classblfwk_1_1_serial_packetizer.html#a3002c8f8bb7ac25e0669563d546ff9ff">serial_packet_abort</a>();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; uint32_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a6e25fdfbea607fc5627696a7fd5ee67f">serial_packet_get_max_packet_size</a>();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#acbae3f161723bc01bb1cf520a68b2db4">serial_packet_send_sync</a>(uint8_t framingPacketType);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#ae29486dd32430ea6c5f0b2dce1687a51">serial_send_ping_response</a>();</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a82e2dd00be0f967486e38bad057ad061">wait_for_ack_packet</a>();</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#aa1dae5365ac79092253374c1bca7e006">read_data_packet</a>(framing_data_packet_t *packet, uint8_t *data, packet_type_t packetType);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a497ba9655c4e48d126465615b994b99d">read_start_byte</a>(framing_header_t *header);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a03e19ce524304ac3c92a20928f76dd55">read_header</a>(framing_header_t *header);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a0bc3e00222bf867522250e49a6fd3500">read_length</a>(framing_data_packet_t *packet);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; status_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#a03644c904727411021e645b42c0573e8">read_crc16</a>(framing_data_packet_t *packet);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; uint16_t <a class="code" href="classblfwk_1_1_serial_packetizer.html#ad7ecc097c540ca46d556daf5302f0db9">calculate_framing_crc16</a>(framing_data_packet_t *packet, <span class="keyword">const</span> uint8_t *data);</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; serial_data_t m_serialContext;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;};</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;} <span class="comment">// namespace blfwk</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="preprocessor">#endif // _serial_packetizer_h_</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="comment">// EOF</span></div><div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a08a23c2d1d4d1ec23052846e866d3d9e"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a08a23c2d1d4d1ec23052846e866d3d9e">blfwk::SerialPacketizer::sync</a></div><div class="ttdeci">virtual void sync()</div><div class="ttdoc">Send framing packet ack. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:111</div></div>
<div class="ttc" id="classblfwk_1_1_packetizer_html"><div class="ttname"><a href="classblfwk_1_1_packetizer.html">blfwk::Packetizer</a></div><div class="ttdoc">Interface class for packetization of commands and data. </div><div class="ttdef"><b>Definition:</b> Packetizer.h:59</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_ae29486dd32430ea6c5f0b2dce1687a51"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#ae29486dd32430ea6c5f0b2dce1687a51">blfwk::SerialPacketizer::serial_send_ping_response</a></div><div class="ttdeci">status_t serial_send_ping_response()</div><div class="ttdoc">Send a ping message back in response to a ping. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:470</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_ae8575c6573ea7c45335e2b832fbcb2e7"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#ae8575c6573ea7c45335e2b832fbcb2e7">blfwk::SerialPacketizer::abortPacket</a></div><div class="ttdeci">virtual void abortPacket()</div><div class="ttdoc">Abort data phase. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:105</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_ad7ecc097c540ca46d556daf5302f0db9"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#ad7ecc097c540ca46d556daf5302f0db9">blfwk::SerialPacketizer::calculate_framing_crc16</a></div><div class="ttdeci">uint16_t calculate_framing_crc16(framing_data_packet_t *packet, const uint8_t *data)</div><div class="ttdoc">Calculate crc over framing data packet. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:650</div></div>
<div class="ttc" id="namespaceblfwk_html"><div class="ttname"><a href="namespaceblfwk.html">blfwk</a></div><div class="ttdef"><b>Definition:</b> BlfwkErrors.h:16</div></div>
<div class="ttc" id="classblfwk_1_1_uart_peripheral_html"><div class="ttname"><a href="classblfwk_1_1_uart_peripheral.html">blfwk::UartPeripheral</a></div><div class="ttdoc">Peripheral that talks to the target device over COM port hardware. </div><div class="ttdef"><b>Definition:</b> UartPeripheral.h:45</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a01942247141e3a736caae54262829b55"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a01942247141e3a736caae54262829b55">blfwk::SerialPacketizer::ping</a></div><div class="ttdeci">virtual status_t ping(int retries, unsigned int delay, ping_response_t *response, int comSpeed)</div><div class="ttdoc">Send a ping packet and receive an ack. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:134</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a64691cbb7f90457343e738af04ce4f89"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a64691cbb7f90457343e738af04ce4f89">blfwk::SerialPacketizer::serial_packet_read</a></div><div class="ttdeci">status_t serial_packet_read(uint8_t **packet, uint32_t *packetLength, packet_type_t packetType)</div><div class="ttdoc">Read packet using serial framing. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:267</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a3002c8f8bb7ac25e0669563d546ff9ff"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a3002c8f8bb7ac25e0669563d546ff9ff">blfwk::SerialPacketizer::serial_packet_abort</a></div><div class="ttdeci">void serial_packet_abort()</div><div class="ttdoc">Abort data phase. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:387</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a3d601318f2ee5dcffe1aef52fbe5b7d4"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a3d601318f2ee5dcffe1aef52fbe5b7d4">blfwk::SerialPacketizer::serial_packet_write</a></div><div class="ttdeci">status_t serial_packet_write(const uint8_t *packet, uint32_t byteCount, packet_type_t packetType)</div><div class="ttdoc">Write packet using serial framing. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:330</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_abc40bb62f022974983167f90bddb8bf0"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#abc40bb62f022974983167f90bddb8bf0">blfwk::SerialPacketizer::readPacket</a></div><div class="ttdeci">virtual status_t readPacket(uint8_t **packet, uint32_t *packetLength, packet_type_t packetType)</div><div class="ttdoc">Read a packet. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:99</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a643048340a0c3019585205cd8351e688"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a643048340a0c3019585205cd8351e688">blfwk::SerialPacketizer::finalize</a></div><div class="ttdeci">virtual void finalize()</div><div class="ttdoc">Finalize. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:87</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a9a4389d57f7b99377f6ce86ae002f4eb"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a9a4389d57f7b99377f6ce86ae002f4eb">blfwk::SerialPacketizer::writePacket</a></div><div class="ttdeci">virtual status_t writePacket(const uint8_t *packet, uint32_t byteCount, packet_type_t packetType)</div><div class="ttdoc">Write a packet. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:93</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a0bc3e00222bf867522250e49a6fd3500"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a0bc3e00222bf867522250e49a6fd3500">blfwk::SerialPacketizer::read_length</a></div><div class="ttdeci">status_t read_length(framing_data_packet_t *packet)</div><div class="ttdoc">Read from peripheral until packet length found. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:618</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_abb0d60956fbf413095204fe74c0fc433"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#abb0d60956fbf413095204fe74c0fc433">blfwk::SerialPacketizer::getMaxPacketSize</a></div><div class="ttdeci">virtual uint32_t getMaxPacketSize()</div><div class="ttdoc">Return the max packet size. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:117</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a03644c904727411021e645b42c0573e8"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a03644c904727411021e645b42c0573e8">blfwk::SerialPacketizer::read_crc16</a></div><div class="ttdeci">status_t read_crc16(framing_data_packet_t *packet)</div><div class="ttdoc">Read from peripheral until crc16 is found. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:634</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_ae78b70bdd8c67ed2649feadcf8bea656"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#ae78b70bdd8c67ed2649feadcf8bea656">blfwk::SerialPacketizer::host_delay</a></div><div class="ttdeci">void host_delay(uint32_t milliseconds)</div><div class="ttdoc">Delay milliseconds. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:123</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a5a06372a1380a3e0c51da181adb811ed"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a5a06372a1380a3e0c51da181adb811ed">blfwk::SerialPacketizer::enableSimulatorPump</a></div><div class="ttdeci">virtual void enableSimulatorPump()</div><div class="ttdoc">Enable simulator command processor pump. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.h:85</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a80dbfe7fbdc8f4780c23af931889c5f8"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a80dbfe7fbdc8f4780c23af931889c5f8">blfwk::SerialPacketizer::~SerialPacketizer</a></div><div class="ttdeci">virtual ~SerialPacketizer()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:81</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a0a777237326f971a44d0c189605fcc02"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a0a777237326f971a44d0c189605fcc02">blfwk::SerialPacketizer::setAborted</a></div><div class="ttdeci">virtual void setAborted(bool aborted)</div><div class="ttdoc">Set aborted flag. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.h:89</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_abc39cf20b8ade1c1fa8a884328e91141"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#abc39cf20b8ade1c1fa8a884328e91141">blfwk::SerialPacketizer::SerialPacketizer</a></div><div class="ttdeci">SerialPacketizer(UartPeripheral *peripheral, uint32_t packetTimeoutMs)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:73</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_aa1dae5365ac79092253374c1bca7e006"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#aa1dae5365ac79092253374c1bca7e006">blfwk::SerialPacketizer::read_data_packet</a></div><div class="ttdeci">status_t read_data_packet(framing_data_packet_t *packet, uint8_t *data, packet_type_t packetType)</div><div class="ttdoc">Read from peripheral until entire data framing packet read. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:507</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a82e2dd00be0f967486e38bad057ad061"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a82e2dd00be0f967486e38bad057ad061">blfwk::SerialPacketizer::wait_for_ack_packet</a></div><div class="ttdeci">status_t wait_for_ack_packet()</div><div class="ttdoc">Wait for an ACK, handling NAKs as needed. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:420</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a86f81a18028edbc70886e49f6599e3c3"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a86f81a18028edbc70886e49f6599e3c3">blfwk::SerialPacketizer::pumpSimulator</a></div><div class="ttdeci">virtual void pumpSimulator()</div><div class="ttdoc">Pump simulator command processor. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.h:87</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_acb7cf492c0ac4d408c2edd37fcc7ba6a"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#acb7cf492c0ac4d408c2edd37fcc7ba6a">blfwk::SerialPacketizer::getPeripheral</a></div><div class="ttdeci">virtual UartPeripheral * getPeripheral()</div><div class="ttdoc">Peripheral accessor. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.h:60</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_acbae3f161723bc01bb1cf520a68b2db4"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#acbae3f161723bc01bb1cf520a68b2db4">blfwk::SerialPacketizer::serial_packet_send_sync</a></div><div class="ttdeci">status_t serial_packet_send_sync(uint8_t framingPacketType)</div><div class="ttdoc">Send a sync packet of the specified type. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:401</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a497ba9655c4e48d126465615b994b99d"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a497ba9655c4e48d126465615b994b99d">blfwk::SerialPacketizer::read_start_byte</a></div><div class="ttdeci">status_t read_start_byte(framing_header_t *header)</div><div class="ttdoc">Read from peripheral until start byte found. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:563</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html">blfwk::SerialPacketizer</a></div><div class="ttdoc">Provides source and sink for packets that go over the serial peripherals. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.h:50</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a349a49399c7449d5d0c8c25636238de3"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a349a49399c7449d5d0c8c25636238de3">blfwk::SerialPacketizer::send_deferred_ack</a></div><div class="ttdeci">status_t send_deferred_ack()</div><div class="ttdoc">Send ACK if needed. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:486</div></div>
<div class="ttc" id="classblfwk_1_1_packetizer_html_a5810c0358eb37df691628f47a814aab5"><div class="ttname"><a href="classblfwk_1_1_packetizer.html#a5810c0358eb37df691628f47a814aab5">blfwk::Packetizer::m_peripheral</a></div><div class="ttdeci">Peripheral * m_peripheral</div><div class="ttdoc">Peripheral to send/receive bytes on. </div><div class="ttdef"><b>Definition:</b> Packetizer.h:113</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a6e25fdfbea607fc5627696a7fd5ee67f"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a6e25fdfbea607fc5627696a7fd5ee67f">blfwk::SerialPacketizer::serial_packet_get_max_packet_size</a></div><div class="ttdeci">uint32_t serial_packet_get_max_packet_size()</div><div class="ttdoc">Get max packet size. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:395</div></div>
<div class="ttc" id="classblfwk_1_1_serial_packetizer_html_a03e19ce524304ac3c92a20928f76dd55"><div class="ttname"><a href="classblfwk_1_1_serial_packetizer.html#a03e19ce524304ac3c92a20928f76dd55">blfwk::SerialPacketizer::read_header</a></div><div class="ttdeci">status_t read_header(framing_header_t *header)</div><div class="ttdoc">Read from peripheral until packet header found. </div><div class="ttdef"><b>Definition:</b> SerialPacketizer.cpp:604</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_80fb9e53c172a775cab667063273d0e3.html">blfwk</a></li><li class="navelem"><b>SerialPacketizer.h</b></li>
<li class="footer">Generated on Mon Mar 7 2016 16:49:50 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>