406 lines
22 KiB
HTML
406 lines
22 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::UsbHidPeripheral 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_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="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classblfwk_1_1_usb_hid_peripheral-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::UsbHidPeripheral Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents a USB HID peripheral.
|
|
<a href="classblfwk_1_1_usb_hid_peripheral.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_usb_hid_peripheral_8h_source.html">UsbHidPeripheral.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::UsbHidPeripheral:</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_peripheral__inherit__graph.svg" width="170" 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::UsbHidPeripheral:</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_peripheral__coll__graph.svg" width="170" 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>
|
|
<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:a72945cac39899cdde717c9ff760e4885"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a72945cac39899cdde717c9ff760e4885">_usbhid_contants</a> { <br />
|
|
  <a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a72945cac39899cdde717c9ff760e4885ae2e50652a2d50669ec5e5882356d9a29">kDefault_Vid</a> = 0x15a2,
|
|
<br />
|
|
  <a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a72945cac39899cdde717c9ff760e4885a9a737f730f2f57d248b7995dfff1453f">kDefault_Pid</a> = 0x0073
|
|
<br />
|
|
}<tr class="memdesc:a72945cac39899cdde717c9ff760e4885"><td class="mdescLeft"> </td><td class="mdescRight">Constants. <a href="classblfwk_1_1_usb_hid_peripheral.html#a72945cac39899cdde717c9ff760e4885">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:a72945cac39899cdde717c9ff760e4885"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_types_classblfwk_1_1_peripheral"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classblfwk_1_1_peripheral')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classblfwk_1_1_peripheral.html">blfwk::Peripheral</a></td></tr>
|
|
<tr class="memitem:a276e207594e3b7cd9e3efbedd1d022e3 inherit pub_types_classblfwk_1_1_peripheral"><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 inherit pub_types_classblfwk_1_1_peripheral"><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:aed9c81513064cf7156bdf7b3e9e3d8b7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#aed9c81513064cf7156bdf7b3e9e3d8b7">UsbHidPeripheral</a> ()</td></tr>
|
|
<tr class="memdesc:aed9c81513064cf7156bdf7b3e9e3d8b7"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aed9c81513064cf7156bdf7b3e9e3d8b7">More...</a><br /></td></tr>
|
|
<tr class="separator:aed9c81513064cf7156bdf7b3e9e3d8b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeedb32ac69ef013a68499ae128e8565d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#aeedb32ac69ef013a68499ae128e8565d">UsbHidPeripheral</a> (unsigned short vendor_id, unsigned short product_id, const char *serial_number)</td></tr>
|
|
<tr class="memdesc:aeedb32ac69ef013a68499ae128e8565d"><td class="mdescLeft"> </td><td class="mdescRight">Parameterized constructor. <a href="#aeedb32ac69ef013a68499ae128e8565d">More...</a><br /></td></tr>
|
|
<tr class="separator:aeedb32ac69ef013a68499ae128e8565d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a4d97184384d799a99e8202b36927c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a4d97184384d799a99e8202b36927c4"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a0a4d97184384d799a99e8202b36927c4">~UsbHidPeripheral</a> ()</td></tr>
|
|
<tr class="memdesc:a0a4d97184384d799a99e8202b36927c4"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a0a4d97184384d799a99e8202b36927c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a869b31ace14a1aedee06066009a1ebfc"><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_peripheral.html#a869b31ace14a1aedee06066009a1ebfc">read</a> (uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t timeoutMS)</td></tr>
|
|
<tr class="memdesc:a869b31ace14a1aedee06066009a1ebfc"><td class="mdescLeft"> </td><td class="mdescRight">Read bytes. <a href="#a869b31ace14a1aedee06066009a1ebfc">More...</a><br /></td></tr>
|
|
<tr class="separator:a869b31ace14a1aedee06066009a1ebfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a574775db4290e73bc6b209704120d06c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a574775db4290e73bc6b209704120d06c"></a>
|
|
virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a574775db4290e73bc6b209704120d06c">write</a> (const uint8_t *buffer, uint32_t byteCount)</td></tr>
|
|
<tr class="memdesc:a574775db4290e73bc6b209704120d06c"><td class="mdescLeft"> </td><td class="mdescRight">Write bytes. This is a do nothing function implemented here to satisfy abstract base class requirements. This function is not used. The write(buffer, count, timeout) function is used in this child class instead of the write(buffer, cout) function declared in the base class. <br /></td></tr>
|
|
<tr class="separator:a574775db4290e73bc6b209704120d06c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49274d91e980719197c0884723d509d5"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a49274d91e980719197c0884723d509d5">write</a> (const uint8_t *buffer, uint32_t byteCount, uint32_t timeoutMS)</td></tr>
|
|
<tr class="memdesc:a49274d91e980719197c0884723d509d5"><td class="mdescLeft"> </td><td class="mdescRight">Write bytes. <a href="#a49274d91e980719197c0884723d509d5">More...</a><br /></td></tr>
|
|
<tr class="separator:a49274d91e980719197c0884723d509d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16cec5e8eff54c30ceaa9fa8343116a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16cec5e8eff54c30ceaa9fa8343116a9"></a>
|
|
unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a16cec5e8eff54c30ceaa9fa8343116a9">getVendorId</a> ()</td></tr>
|
|
<tr class="memdesc:a16cec5e8eff54c30ceaa9fa8343116a9"><td class="mdescLeft"> </td><td class="mdescRight">Return USB Vendor ID. <br /></td></tr>
|
|
<tr class="separator:a16cec5e8eff54c30ceaa9fa8343116a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a5776cf0afa40acce3bc8eaef59fb15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a5776cf0afa40acce3bc8eaef59fb15"></a>
|
|
unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a6a5776cf0afa40acce3bc8eaef59fb15">getProductId</a> ()</td></tr>
|
|
<tr class="memdesc:a6a5776cf0afa40acce3bc8eaef59fb15"><td class="mdescLeft"> </td><td class="mdescRight">Return USB Product ID. <br /></td></tr>
|
|
<tr class="separator:a6a5776cf0afa40acce3bc8eaef59fb15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6cfd09eacdf6ae13a7ae2f65f575f53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6cfd09eacdf6ae13a7ae2f65f575f53"></a>
|
|
const wchar_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#ae6cfd09eacdf6ae13a7ae2f65f575f53">getSerialNumber</a> ()</td></tr>
|
|
<tr class="memdesc:ae6cfd09eacdf6ae13a7ae2f65f575f53"><td class="mdescLeft"> </td><td class="mdescRight">Return USB Serial Number. <br /></td></tr>
|
|
<tr class="separator:ae6cfd09eacdf6ae13a7ae2f65f575f53"><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 USB HID peripheral. </p>
|
|
<p>Interface class for objects that provide the source for commands or sink for responses. </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a class="anchor" id="a72945cac39899cdde717c9ff760e4885"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classblfwk_1_1_usb_hid_peripheral.html#a72945cac39899cdde717c9ff760e4885">blfwk::UsbHidPeripheral::_usbhid_contants</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constants. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a72945cac39899cdde717c9ff760e4885ae2e50652a2d50669ec5e5882356d9a29"></a>kDefault_Vid </td><td class="fielddoc">
|
|
<p>Freescale VID. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="a72945cac39899cdde717c9ff760e4885a9a737f730f2f57d248b7995dfff1453f"></a>kDefault_Pid </td><td class="fielddoc">
|
|
<p>PID for KL25Z48M. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="aed9c81513064cf7156bdf7b3e9e3d8b7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">UsbHidPeripheral::UsbHidPeripheral </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Uses vendor_id = kDefault_Vid and product_id = kDefault_Pid. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeedb32ac69ef013a68499ae128e8565d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">UsbHidPeripheral::UsbHidPeripheral </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned short </td>
|
|
<td class="paramname"><em>vendor_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned short </td>
|
|
<td class="paramname"><em>product_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>serial_number</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parameterized constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vendor_id</td><td>The Vendor ID of the USB HID device. </td></tr>
|
|
<tr><td class="paramname">product_id</td><td>The Product ID of the USB HID device. </td></tr>
|
|
<tr><td class="paramname">serial_number</td><td>The Serial Number of the USB HID device. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a869b31ace14a1aedee06066009a1ebfc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t UsbHidPeripheral::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>timeoutMS</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 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>Implements <a class="el" href="classblfwk_1_1_peripheral.html#ab79cfe09f48bb7f4e0394099a9f43f3c">blfwk::Peripheral</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a49274d91e980719197c0884723d509d5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t UsbHidPeripheral::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const 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>byteCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeoutMS</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write bytes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>Pointer to buffer to write </td></tr>
|
|
<tr><td class="paramname">byteCount</td><td>Number of bytes to write </td></tr>
|
|
<tr><td class="paramname">timeoutMs</td><td>Time in milliseconds to wait for write to complete. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_usb_hid_peripheral_8h_source.html">UsbHidPeripheral.h</a></li>
|
|
<li>UsbHidPeripheral.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_peripheral.html">UsbHidPeripheral</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>
|