321 lines
14 KiB
HTML
321 lines
14 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::Peripheral 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_peripheral.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classblfwk_1_1_peripheral-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::Peripheral Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents a peripheral.
|
|
<a href="classblfwk_1_1_peripheral.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_peripheral_8h_source.html">Peripheral.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::Peripheral:</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_peripheral__inherit__graph.svg" width="500" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:structblfwk_1_1_peripheral_1_1_peripheral_config_data"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_peripheral.html#structblfwk_1_1_peripheral_1_1_peripheral_config_data">PeripheralConfigData</a></td></tr>
|
|
<tr class="separator:structblfwk_1_1_peripheral_1_1_peripheral_config_data"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a276e207594e3b7cd9e3efbedd1d022e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a276e207594e3b7cd9e3efbedd1d022e3"></a>enum  </td><td class="memItemRight" valign="bottom"><b>_host_peripheral_types</b> { <br />
|
|
  <b>kHostPeripheralType_None</b>,
|
|
<br />
|
|
  <b>kHostPeripheralType_UART</b>,
|
|
<br />
|
|
  <b>kHostPeripheralType_BUSPAL_UART</b>,
|
|
<br />
|
|
  <b>kHostPeripheralType_USB_HID</b>,
|
|
<br />
|
|
  <b>kHostPeripheralType_SIM</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a276e207594e3b7cd9e3efbedd1d022e3"><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:ab79cfe09f48bb7f4e0394099a9f43f3c"><td class="memItemLeft" align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_peripheral.html#ab79cfe09f48bb7f4e0394099a9f43f3c">read</a> (uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t timeout)=0</td></tr>
|
|
<tr class="memdesc:ab79cfe09f48bb7f4e0394099a9f43f3c"><td class="mdescLeft"> </td><td class="mdescRight">Read bytes. <a href="#ab79cfe09f48bb7f4e0394099a9f43f3c">More...</a><br /></td></tr>
|
|
<tr class="separator:ab79cfe09f48bb7f4e0394099a9f43f3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa969e9612d082ad57dfc6d9d4047e8f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa969e9612d082ad57dfc6d9d4047e8f3"></a>
|
|
virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_peripheral.html#aa969e9612d082ad57dfc6d9d4047e8f3">write</a> (const uint8_t *buffer, uint32_t byteCount)=0</td></tr>
|
|
<tr class="memdesc:aa969e9612d082ad57dfc6d9d4047e8f3"><td class="mdescLeft"> </td><td class="mdescRight">Write bytes. <br /></td></tr>
|
|
<tr class="separator:aa969e9612d082ad57dfc6d9d4047e8f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Represents a peripheral. </p>
|
|
<p>Interface class for objects that provide the source for commands or sink for responses. </p>
|
|
</div><hr/><h2 class="groupheader">Class Documentation</h2>
|
|
<a name="structblfwk_1_1_peripheral_1_1_peripheral_config_data" id="structblfwk_1_1_peripheral_1_1_peripheral_config_data"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct blfwk::Peripheral::PeripheralConfigData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></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::Peripheral::PeripheralConfigData:</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="structblfwk_1_1_peripheral_1_1_peripheral_config_data__coll__graph.svg" width="354" height="247"><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="fieldtable">
|
|
<tr><th colspan="3">Class Members</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="afd1414947b81515adf8cb7bda4dd2a1f"></a>BusPalConfigData</td>
|
|
<td class="fieldname">
|
|
busPalConfig</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a7c168d82fc25d9daa476a93179f167c8"></a>string</td>
|
|
<td class="fieldname">
|
|
comPortName</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a6e6679d6f65de243136d69239f7d29b3"></a>long</td>
|
|
<td class="fieldname">
|
|
comPortSpeed</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="aeb06a59b931b4c167b2e938dc95991a8"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
packetTimeoutMs</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="aedeb09e3e27003471687ac75f6261e5b"></a>_host_peripheral_types</td>
|
|
<td class="fieldname">
|
|
peripheralType</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="abaea15e87d2a8ce1f3c0e6dc4c725b92"></a>bool</td>
|
|
<td class="fieldname">
|
|
ping</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a3b43f2d868ad2e02195b5e3321bbbd9e"></a>unsigned short</td>
|
|
<td class="fieldname">
|
|
usbHidPid</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ae5e93b934ffc0132e2470b3c3491dfec"></a>string</td>
|
|
<td class="fieldname">
|
|
usbHidSerialNumber</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="af41505acfda4f3c91737df71b41df6a3"></a>unsigned short</td>
|
|
<td class="fieldname">
|
|
usbHidVid</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ab79cfe09f48bb7f4e0394099a9f43f3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual status_t blfwk::Peripheral::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>requestedBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>actualBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read bytes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>Pointer to buffer </td></tr>
|
|
<tr><td class="paramname">requestedBytes</td><td>Number of bytes to read </td></tr>
|
|
<tr><td class="paramname">timeoutMs</td><td>Time in milliseconds to wait for read to complete. </td></tr>
|
|
<tr><td class="paramname">actualBytes</td><td>Number of bytes actually read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classblfwk_1_1_uart_peripheral.html#afb7fc34dadcf846b1d4dcd0809969095">blfwk::UartPeripheral</a>, <a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a869b31ace14a1aedee06066009a1ebfc">blfwk::UsbHidPeripheral</a>, <a class="el" href="classblfwk_1_1_bus_pal_uart_peripheral.html#a41d48fb4dfad70db500b1ef89b3419d2">blfwk::BusPalUartPeripheral</a>, and <a class="el" href="classblfwk_1_1_sim_peripheral.html#a6b2d9c51e9aa007f91d22d5d6b8c4ce1">blfwk::SimPeripheral</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="_peripheral_8h_source.html">Peripheral.h</a></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_peripheral.html">Peripheral</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>
|