USB_Host_Shield_2.0/class_h_i_d.html
Kristian Sloth Lauszus c59318fe51 defined Arduino=100
2013-02-05 21:05:03 +01:00

803 lines
39 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.3.1"/>
<title>USB_Host_Shield_2.0: HID 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">USB_Host_Shield_2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<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>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="class_h_i_d-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HID Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="hid_8h_source.html">hid.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for HID:</div>
<div class="dyncontent">
<div class="center"><img src="class_h_i_d__inherit__graph.png" border="0" usemap="#_h_i_d_inherit__map" alt="Inheritance graph"/></div>
<map name="_h_i_d_inherit__map" id="_h_i_d_inherit__map">
<area shape="rect" id="node4" href="class_h_i_d_boot.html" title="HIDBoot\&lt; BOOT_PROTOCOL \&gt;" alt="" coords="5,144,144,165"/><area shape="rect" id="node5" href="class_h_i_d_universal.html" title="HIDUniversal" alt="" coords="168,144,237,165"/><area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="39,5,125,27"/><area shape="rect" id="node3" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="151,5,239,27"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for HID:</div>
<div class="dyncontent">
<div class="center"><img src="class_h_i_d__coll__graph.png" border="0" usemap="#_h_i_d_coll__map" alt="Collaboration graph"/></div>
<map name="_h_i_d_coll__map" id="_h_i_d_coll__map">
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,77,91,99"/><area shape="rect" id="node3" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="116,77,204,99"/><area shape="rect" id="node4" href="class_u_s_b.html" title="USB" alt="" coords="229,77,267,99"/><area shape="rect" id="node5" href="class_m_a_x3421e.html" title="MAX3421E" alt="" coords="217,5,279,27"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acea6b13146dc6fb351a912382ce806fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#acea6b13146dc6fb351a912382ce806fd">HID</a> (<a class="el" href="class_u_s_b.html">USB</a> *pusb)</td></tr>
<tr class="separator:acea6b13146dc6fb351a912382ce806fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd4bcb073a263f662dd5433139d6ebf3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_u_s_b.html">USB</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#afd4bcb073a263f662dd5433139d6ebf3">GetUsb</a> ()</td></tr>
<tr class="separator:afd4bcb073a263f662dd5433139d6ebf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3b964d20c828fb27076f50d220fe275"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#ae3b964d20c828fb27076f50d220fe275">SetReportParser</a> (uint8_t id, <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *prs)</td></tr>
<tr class="separator:ae3b964d20c828fb27076f50d220fe275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a276ec67d360b59c3144d7ea2e2f5149e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a276ec67d360b59c3144d7ea2e2f5149e">SetProtocol</a> (uint8_t iface, uint8_t protocol)</td></tr>
<tr class="separator:a276ec67d360b59c3144d7ea2e2f5149e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70be6b7ad992954b8648d7d06e2d4e2b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a70be6b7ad992954b8648d7d06e2d4e2b">GetProtocol</a> (uint8_t iface, uint8_t *dataptr)</td></tr>
<tr class="separator:a70be6b7ad992954b8648d7d06e2d4e2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52f9c963ffe4715829ff1b84a9eac24c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a52f9c963ffe4715829ff1b84a9eac24c">GetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t *dataptr)</td></tr>
<tr class="separator:a52f9c963ffe4715829ff1b84a9eac24c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b27ed48d16c6ab09a5ea9a97a628149"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a6b27ed48d16c6ab09a5ea9a97a628149">SetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t duration)</td></tr>
<tr class="separator:a6b27ed48d16c6ab09a5ea9a97a628149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a343e92e353615fab16f639b016c214a6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a343e92e353615fab16f639b016c214a6">GetReportDescr</a> (uint8_t ep, <a class="el" href="class_u_s_b_read_parser.html">USBReadParser</a> *parser=NULL)</td></tr>
<tr class="separator:a343e92e353615fab16f639b016c214a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13dccfb3aa8144626ba587969e3ef3b0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a13dccfb3aa8144626ba587969e3ef3b0">GetHidDescr</a> (uint8_t ep, uint16_t nbytes, uint8_t *dataptr)</td></tr>
<tr class="separator:a13dccfb3aa8144626ba587969e3ef3b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b59be9ba5dbdc09d2e47cf734c02fdc"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a4b59be9ba5dbdc09d2e47cf734c02fdc">GetReport</a> (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)</td></tr>
<tr class="separator:a4b59be9ba5dbdc09d2e47cf734c02fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58ca963ba0f12d2a457cb247595f38e9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a58ca963ba0f12d2a457cb247595f38e9">SetReport</a> (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)</td></tr>
<tr class="separator:a58ca963ba0f12d2a457cb247595f38e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_u_s_b_device_config"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_device_config')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
<tr class="memitem:a391dc824a3271671890cebeb829b35ed inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a391dc824a3271671890cebeb829b35ed">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)=0</td></tr>
<tr class="separator:a391dc824a3271671890cebeb829b35ed inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74c06c5fe641b20faeeebd39e33248b3 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a74c06c5fe641b20faeeebd39e33248b3">Release</a> ()=0</td></tr>
<tr class="separator:a74c06c5fe641b20faeeebd39e33248b3 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4961e92df3e75c38e6953fb08b11f8b6 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a4961e92df3e75c38e6953fb08b11f8b6">Poll</a> ()=0</td></tr>
<tr class="separator:a4961e92df3e75c38e6953fb08b11f8b6 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae3130517514c902bad5f153849b3811 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#aae3130517514c902bad5f153849b3811">GetAddress</a> ()=0</td></tr>
<tr class="separator:aae3130517514c902bad5f153849b3811 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_usb_config_xtracter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_usb_config_xtracter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_usb_config_xtracter.html">UsbConfigXtracter</a></td></tr>
<tr class="memitem:aceb5da8339172cbb2e9ce2064e34e5ef inherit pub_methods_class_usb_config_xtracter"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_usb_config_xtracter.html#aceb5da8339172cbb2e9ce2064e34e5ef">EndpointXtract</a> (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep)=0</td></tr>
<tr class="separator:aceb5da8339172cbb2e9ce2064e34e5ef inherit pub_methods_class_usb_config_xtracter"><td class="memSeparator" colspan="2">&#160;</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:a9e2e57ffd2701ebd171842fa9a3f54bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a9e2e57ffd2701ebd171842fa9a3f54bd">PrintEndpointDescriptor</a> (const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep_ptr)</td></tr>
<tr class="separator:a9e2e57ffd2701ebd171842fa9a3f54bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a733e3944b51dced26ef257f047c227dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a733e3944b51dced26ef257f047c227dc">PrintHidDescriptor</a> (const <a class="el" href="struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r.html">USB_HID_DESCRIPTOR</a> *pDesc)</td></tr>
<tr class="separator:a733e3944b51dced26ef257f047c227dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac51c88a0be514a748598008d312adc1d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#ac51c88a0be514a748598008d312adc1d">GetReportParser</a> (uint8_t id)</td></tr>
<tr class="separator:ac51c88a0be514a748598008d312adc1d"><td class="memSeparator" colspan="2">&#160;</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:a1583e665c2b930e8683c10dc271f013f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a1583e665c2b930e8683c10dc271f013f">pUsb</a></td></tr>
<tr class="separator:a1583e665c2b930e8683c10dc271f013f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a525edb36c2cd8470eae703d3b236e4a7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a525edb36c2cd8470eae703d3b236e4a7">bAddress</a></td></tr>
<tr class="separator:a525edb36c2cd8470eae703d3b236e4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a845b9961830a6778c296e8571759dd38"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a845b9961830a6778c296e8571759dd38">epInterruptInIndex</a> = 1</td></tr>
<tr class="separator:a845b9961830a6778c296e8571759dd38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb7fc07fe6dbc98d518967fdbc441ab3"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#aeb7fc07fe6dbc98d518967fdbc441ab3">epInterruptOutIndex</a> = 2</td></tr>
<tr class="separator:aeb7fc07fe6dbc98d518967fdbc441ab3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe5186f46ac7b580bb3dc289e3f237b2"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#afe5186f46ac7b580bb3dc289e3f237b2">maxHidInterfaces</a> = 3</td></tr>
<tr class="separator:afe5186f46ac7b580bb3dc289e3f237b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd92969682030cd5cac310dd7746c7c7"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#acd92969682030cd5cac310dd7746c7c7">maxEpPerInterface</a> = 2</td></tr>
<tr class="separator:acd92969682030cd5cac310dd7746c7c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a884aa67312324e7d23a052a6dc80337e"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a884aa67312324e7d23a052a6dc80337e">totalEndpoints</a> = (<a class="el" href="class_h_i_d.html#afe5186f46ac7b580bb3dc289e3f237b2">maxHidInterfaces</a> * <a class="el" href="class_h_i_d.html#acd92969682030cd5cac310dd7746c7c7">maxEpPerInterface</a> + 1)</td></tr>
<tr class="separator:a884aa67312324e7d23a052a6dc80337e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00164">164</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acea6b13146dc6fb351a912382ce806fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">HID::HID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td>
<td class="paramname"><em>pusb</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00184">184</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a13dccfb3aa8144626ba587969e3ef3b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::GetHidDescr </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a52f9c963ffe4715829ff1b84a9eac24c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::GetIdle </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00027">27</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a70be6b7ad992954b8648d7d06e2d4e2b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::GetProtocol </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00039">39</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4b59be9ba5dbdc09d2e47cf734c02fdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::GetReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>report_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>report_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00023">23</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a343e92e353615fab16f639b016c214a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::GetReportDescr </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_u_s_b_read_parser.html">USBReadParser</a> *&#160;</td>
<td class="paramname"><em>parser</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00004">4</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac51c88a0be514a748598008d312adc1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a>* HID::GetReportParser </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="class_h_i_d_universal.html#aff53de37b98aa1e4a6e45be701ddcc65">HIDUniversal</a>.</p>
</div>
</div>
<a class="anchor" id="afd4bcb073a263f662dd5433139d6ebf3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_u_s_b.html">USB</a>* HID::GetUsb </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00186">186</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9e2e57ffd2701ebd171842fa9a3f54bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void HID::PrintEndpointDescriptor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *&#160;</td>
<td class="paramname"><em>ep_ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00044">44</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a733e3944b51dced26ef257f047c227dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void HID::PrintHidDescriptor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r.html">USB_HID_DESCRIPTOR</a> *&#160;</td>
<td class="paramname"><em>pDesc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00061">61</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6b27ed48d16c6ab09a5ea9a97a628149"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::SetIdle </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>duration</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00031">31</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a276ec67d360b59c3144d7ea2e2f5149e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::SetProtocol </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>protocol</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00035">35</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a58ca963ba0f12d2a457cb247595f38e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::SetReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>report_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>report_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8cpp_source.html#l00019">19</a> of file <a class="el" href="hid_8cpp_source.html">hid.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae3b964d20c828fb27076f50d220fe275"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool HID::SetReportParser </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *&#160;</td>
<td class="paramname"><em>prs</em>&#160;</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>Reimplemented in <a class="el" href="class_h_i_d_boot.html#a3e44d340fab7e9eedb357ef61e1c19a5">HIDBoot&lt; BOOT_PROTOCOL &gt;</a>, and <a class="el" href="class_h_i_d_universal.html#afbd599879e9c3cdea382e87afd6ab29a">HIDUniversal</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a525edb36c2cd8470eae703d3b236e4a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t HID::bAddress</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00168">168</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="a845b9961830a6778c296e8571759dd38"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t HID::epInterruptInIndex = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00171">171</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeb7fc07fe6dbc98d518967fdbc441ab3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t HID::epInterruptOutIndex = 2</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00172">172</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="acd92969682030cd5cac310dd7746c7c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t HID::maxEpPerInterface = 2</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00175">175</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="afe5186f46ac7b580bb3dc289e3f237b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t HID::maxHidInterfaces = 3</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00174">174</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1583e665c2b930e8683c10dc271f013f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_u_s_b.html">USB</a>* HID::pUsb</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00167">167</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a class="anchor" id="a884aa67312324e7d23a052a6dc80337e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t HID::totalEndpoints = (<a class="el" href="class_h_i_d.html#afe5186f46ac7b580bb3dc289e3f237b2">maxHidInterfaces</a> * <a class="el" href="class_h_i_d.html#acd92969682030cd5cac310dd7746c7c7">maxEpPerInterface</a> + 1)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hid_8h_source.html#l00176">176</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="hid_8h_source.html">hid.h</a></li>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="hid_8cpp_source.html">hid.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 5 2013 20:57:23 for USB_Host_Shield_2.0 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>