397 lines
31 KiB
HTML
397 lines
31 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::UsbHidPacketizer 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_usb_hid_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-types">Public Types</a> |
|
|
<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_usb_hid_packetizer-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::UsbHidPacketizer Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides source and sink for packets that go over USB HID class.
|
|
<a href="classblfwk_1_1_usb_hid_packetizer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_usb_hid_packetizer_8h_source.html">UsbHidPacketizer.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::UsbHidPacketizer:</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_usb_hid_packetizer__inherit__graph.svg" width="174" 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::UsbHidPacketizer:</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_usb_hid_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-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:abc80fa75d62e56390726b565bbe59f69"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc80fa75d62e56390726b565bbe59f69"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#abc80fa75d62e56390726b565bbe59f69">_usbhid_contants</a> { <br />
|
|
  <b>kReadFlushTimeoutMs</b> = 100000,
|
|
<br />
|
|
  <b>kPollAbortTimeoutMs</b> = 0,
|
|
<br />
|
|
  <b>kPollAbortTimeoutMs</b> = 0,
|
|
<br />
|
|
  <b>kPollPacketMaxRetryCnt</b> = 50,
|
|
<br />
|
|
  <b>kContinuousReadMargin</b> = 2
|
|
<br />
|
|
}<tr class="memdesc:abc80fa75d62e56390726b565bbe59f69"><td class="mdescLeft"> </td><td class="mdescRight">Constants. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:abc80fa75d62e56390726b565bbe59f69"><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:aae0db144a716a474a33ec0f6d5f86635"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae0db144a716a474a33ec0f6d5f86635"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#aae0db144a716a474a33ec0f6d5f86635">UsbHidPacketizer</a> (<a class="el" href="classblfwk_1_1_usb_hid_peripheral.html">UsbHidPeripheral</a> *peripheral, uint32_t readPacketTimeoutMs)</td></tr>
|
|
<tr class="memdesc:aae0db144a716a474a33ec0f6d5f86635"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <br /></td></tr>
|
|
<tr class="separator:aae0db144a716a474a33ec0f6d5f86635"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc9d22622a974cd55724c413ba19400e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc9d22622a974cd55724c413ba19400e"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#abc9d22622a974cd55724c413ba19400e">~UsbHidPacketizer</a> ()</td></tr>
|
|
<tr class="memdesc:abc9d22622a974cd55724c413ba19400e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:abc9d22622a974cd55724c413ba19400e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b016c133bf37e49e0736e6901c0822a"><td class="memItemLeft" align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#a8b016c133bf37e49e0736e6901c0822a">readPacket</a> (uint8_t **packet, uint32_t *packetLength, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:a8b016c133bf37e49e0736e6901c0822a"><td class="mdescLeft"> </td><td class="mdescRight">Read a packet. <a href="#a8b016c133bf37e49e0736e6901c0822a">More...</a><br /></td></tr>
|
|
<tr class="separator:a8b016c133bf37e49e0736e6901c0822a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12b52aefb7be63e34bde4bdd06c8e12e"><td class="memItemLeft" align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#a12b52aefb7be63e34bde4bdd06c8e12e">writePacket</a> (const uint8_t *packet, uint32_t byteCount, packet_type_t packetType)</td></tr>
|
|
<tr class="memdesc:a12b52aefb7be63e34bde4bdd06c8e12e"><td class="mdescLeft"> </td><td class="mdescRight">Write a packet. <a href="#a12b52aefb7be63e34bde4bdd06c8e12e">More...</a><br /></td></tr>
|
|
<tr class="separator:a12b52aefb7be63e34bde4bdd06c8e12e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefa45f36e5bd9b061d564c93db0ec496"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefa45f36e5bd9b061d564c93db0ec496"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#aefa45f36e5bd9b061d564c93db0ec496">abortPacket</a> ()</td></tr>
|
|
<tr class="memdesc:aefa45f36e5bd9b061d564c93db0ec496"><td class="mdescLeft"> </td><td class="mdescRight">Abort data phase. <br /></td></tr>
|
|
<tr class="separator:aefa45f36e5bd9b061d564c93db0ec496"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29e252401c7b251b2304d59d9a068ad5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29e252401c7b251b2304d59d9a068ad5"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#a29e252401c7b251b2304d59d9a068ad5">sync</a> ()</td></tr>
|
|
<tr class="memdesc:a29e252401c7b251b2304d59d9a068ad5"><td class="mdescLeft"> </td><td class="mdescRight">Send framing packet ack/nak. <br /></td></tr>
|
|
<tr class="separator:a29e252401c7b251b2304d59d9a068ad5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af44755c52597a38e6b683a37f8fc2f3b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af44755c52597a38e6b683a37f8fc2f3b"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#af44755c52597a38e6b683a37f8fc2f3b">finalize</a> ()</td></tr>
|
|
<tr class="memdesc:af44755c52597a38e6b683a37f8fc2f3b"><td class="mdescLeft"> </td><td class="mdescRight">Finalize. <br /></td></tr>
|
|
<tr class="separator:af44755c52597a38e6b683a37f8fc2f3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8ae3d3eaa3e3216db28b8f4d27ffc56"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8ae3d3eaa3e3216db28b8f4d27ffc56"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#ab8ae3d3eaa3e3216db28b8f4d27ffc56">enableSimulatorPump</a> ()</td></tr>
|
|
<tr class="memdesc:ab8ae3d3eaa3e3216db28b8f4d27ffc56"><td class="mdescLeft"> </td><td class="mdescRight">Enable simulator command processor pump. <br /></td></tr>
|
|
<tr class="separator:ab8ae3d3eaa3e3216db28b8f4d27ffc56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8f1397f49638e9e56a44584dcec7b8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8f1397f49638e9e56a44584dcec7b8f"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#ae8f1397f49638e9e56a44584dcec7b8f">pumpSimulator</a> ()</td></tr>
|
|
<tr class="memdesc:ae8f1397f49638e9e56a44584dcec7b8f"><td class="mdescLeft"> </td><td class="mdescRight">Pump simulator command processor. <br /></td></tr>
|
|
<tr class="separator:ae8f1397f49638e9e56a44584dcec7b8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e36185f91ff736fa27250fb8d849d27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e36185f91ff736fa27250fb8d849d27"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#a6e36185f91ff736fa27250fb8d849d27">setAborted</a> (bool aborted)</td></tr>
|
|
<tr class="memdesc:a6e36185f91ff736fa27250fb8d849d27"><td class="mdescLeft"> </td><td class="mdescRight">Set aborted flag. <br /></td></tr>
|
|
<tr class="separator:a6e36185f91ff736fa27250fb8d849d27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcd37ff2eb614f02c73d6c69808e61e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcd37ff2eb614f02c73d6c69808e61e4"></a>
|
|
virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#abcd37ff2eb614f02c73d6c69808e61e4">getMaxPacketSize</a> ()</td></tr>
|
|
<tr class="memdesc:abcd37ff2eb614f02c73d6c69808e61e4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the max packet size supported. <br /></td></tr>
|
|
<tr class="separator:abcd37ff2eb614f02c73d6c69808e61e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa64c70eb1e5d8552cfedb31f35e5755d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa64c70eb1e5d8552cfedb31f35e5755d"></a>
|
|
virtual <a class="el" href="classblfwk_1_1_usb_hid_peripheral.html">UsbHidPeripheral</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#aa64c70eb1e5d8552cfedb31f35e5755d">getPeripheral</a> ()</td></tr>
|
|
<tr class="memdesc:aa64c70eb1e5d8552cfedb31f35e5755d"><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:aa64c70eb1e5d8552cfedb31f35e5755d"><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:af8d91add86d40ec65cd19cd403026fe5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8d91add86d40ec65cd19cd403026fe5"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#af8d91add86d40ec65cd19cd403026fe5">flushInput</a> ()</td></tr>
|
|
<tr class="memdesc:af8d91add86d40ec65cd19cd403026fe5"><td class="mdescLeft"> </td><td class="mdescRight">Flush input from device. <br /></td></tr>
|
|
<tr class="separator:af8d91add86d40ec65cd19cd403026fe5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b22785f42d54327ede20fe2a433e1c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b22785f42d54327ede20fe2a433e1c5"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#a6b22785f42d54327ede20fe2a433e1c5">pollForAbortPacket</a> ()</td></tr>
|
|
<tr class="memdesc:a6b22785f42d54327ede20fe2a433e1c5"><td class="mdescLeft"> </td><td class="mdescRight">Poll overlapped read for receiver data phase abort. <br /></td></tr>
|
|
<tr class="separator:a6b22785f42d54327ede20fe2a433e1c5"><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:a29afc6f581805ce9246c7309cd449119"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29afc6f581805ce9246c7309cd449119"></a>
|
|
bl_hid_report_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#a29afc6f581805ce9246c7309cd449119">m_report</a></td></tr>
|
|
<tr class="memdesc:a29afc6f581805ce9246c7309cd449119"><td class="mdescLeft"> </td><td class="mdescRight">Used for building and receiving the report. <br /></td></tr>
|
|
<tr class="separator:a29afc6f581805ce9246c7309cd449119"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afaa917a3920a19adeb5d8176445373b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaa917a3920a19adeb5d8176445373b2"></a>
|
|
bl_hid_report_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_packetizer.html#afaa917a3920a19adeb5d8176445373b2">m_abortReport</a></td></tr>
|
|
<tr class="memdesc:afaa917a3920a19adeb5d8176445373b2"><td class="mdescLeft"> </td><td class="mdescRight">Used for received abort report. <br /></td></tr>
|
|
<tr class="separator:afaa917a3920a19adeb5d8176445373b2"><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 USB HID class. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a8b016c133bf37e49e0736e6901c0822a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t UsbHidPacketizer::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="a12b52aefb7be63e34bde4bdd06c8e12e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t UsbHidPacketizer::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="_usb_hid_packetizer_8h_source.html">UsbHidPacketizer.h</a></li>
|
|
<li>UsbHidPacketizer.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_usb_hid_packetizer.html">UsbHidPacketizer</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>
|