mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
526 lines
35 KiB
HTML
526 lines
35 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.4"/>
|
|
<title>USB Host Shield 2.0: HIDUniversal 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" />
|
|
<link href="imageStyle.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.4 -->
|
|
<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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 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>
|
|
<!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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="#nested-classes">Classes</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="class_h_i_d_universal-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">HIDUniversal Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="hiduniversal_8h_source.html">hiduniversal.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for HIDUniversal:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_h_i_d_universal__inherit__graph.png" border="0" usemap="#_h_i_d_universal_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_h_i_d_universal_inherit__map" id="_h_i_d_universal_inherit__map">
|
|
<area shape="rect" id="node2" href="class_h_i_d.html" title="HID" alt="" coords="85,75,123,96"/><area shape="rect" id="node3" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,91,27"/><area shape="rect" id="node4" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="116,5,204,27"/></map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for HIDUniversal:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_h_i_d_universal__coll__graph.png" border="0" usemap="#_h_i_d_universal_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="_h_i_d_universal_coll__map" id="_h_i_d_universal_coll__map">
|
|
<area shape="rect" id="node2" href="class_h_i_d.html" title="HID" alt="" coords="141,157,179,179"/><area shape="rect" id="node3" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,77,91,99"/><area shape="rect" id="node4" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="116,77,204,99"/><area shape="rect" id="node5" href="class_u_s_b.html" title="USB" alt="" coords="229,77,267,99"/><area shape="rect" id="node6" 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:abdbac688c7e4b682055cebd82e13a595"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595">HIDUniversal</a> (<a class="el" href="class_u_s_b.html">USB</a> *p)</td></tr>
|
|
<tr class="separator:abdbac688c7e4b682055cebd82e13a595"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbd599879e9c3cdea382e87afd6ab29a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#afbd599879e9c3cdea382e87afd6ab29a">SetReportParser</a> (uint8_t id, <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *prs)</td></tr>
|
|
<tr class="separator:afbd599879e9c3cdea382e87afd6ab29a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a384b0e219f763e2d6407636bfd4ccea7"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a384b0e219f763e2d6407636bfd4ccea7">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:a384b0e219f763e2d6407636bfd4ccea7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af999fc50ef4b5dec0391bda79ec83bda"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#af999fc50ef4b5dec0391bda79ec83bda">Release</a> ()</td></tr>
|
|
<tr class="separator:af999fc50ef4b5dec0391bda79ec83bda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac27e857a0d9619c8abc31be0b690c83c"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#ac27e857a0d9619c8abc31be0b690c83c">Poll</a> ()</td></tr>
|
|
<tr class="separator:ac27e857a0d9619c8abc31be0b690c83c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcc6921b7beaf0aac2acbcdddd535626"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#abcc6921b7beaf0aac2acbcdddd535626">GetAddress</a> ()</td></tr>
|
|
<tr class="separator:abcc6921b7beaf0aac2acbcdddd535626"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9b13f27eca16e0accc14fff9bd318e2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#ab9b13f27eca16e0accc14fff9bd318e2">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)</td></tr>
|
|
<tr class="separator:ab9b13f27eca16e0accc14fff9bd318e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_h_i_d')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:acea6b13146dc6fb351a912382ce806fd inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top"> </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd4bcb073a263f662dd5433139d6ebf3 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#afd4bcb073a263f662dd5433139d6ebf3">GetUsb</a> ()</td></tr>
|
|
<tr class="separator:afd4bcb073a263f662dd5433139d6ebf3 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a276ec67d360b59c3144d7ea2e2f5149e inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70be6b7ad992954b8648d7d06e2d4e2b inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52f9c963ffe4715829ff1b84a9eac24c inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b27ed48d16c6ab09a5ea9a97a628149 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a343e92e353615fab16f639b016c214a6 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13dccfb3aa8144626ba587969e3ef3b0 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b59be9ba5dbdc09d2e47cf734c02fdc inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58ca963ba0f12d2a457cb247595f38e9 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </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 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </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="-"/> Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
|
|
<tr class="memitem:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e">ConfigureDevice</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a12bb63558ded5bb6661bb173b07ff391">ResetHubPort</a> (uint8_t port)</td></tr>
|
|
<tr class="separator:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1cf695242e2e22893eea9c892282221b inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a1cf695242e2e22893eea9c892282221b">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
|
|
<tr class="separator:a1cf695242e2e22893eea9c892282221b inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f13c42ed2c8e72e1f63562576ca82d2 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a7f13c42ed2c8e72e1f63562576ca82d2">DEVCLASSOK</a> (uint8_t klass)</td></tr>
|
|
<tr class="separator:a7f13c42ed2c8e72e1f63562576ca82d2 inherit pub_methods_class_u_s_b_device_config"><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:aff53de37b98aa1e4a6e45be701ddcc65"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#aff53de37b98aa1e4a6e45be701ddcc65">GetReportParser</a> (uint8_t id)</td></tr>
|
|
<tr class="separator:aff53de37b98aa1e4a6e45be701ddcc65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60f06d86767b4b2c973d08383c7a0048"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a60f06d86767b4b2c973d08383c7a0048">OnInitSuccessful</a> ()</td></tr>
|
|
<tr class="separator:a60f06d86767b4b2c973d08383c7a0048"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_h_i_d')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:a9e2e57ffd2701ebd171842fa9a3f54bd inherit pro_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">void </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 inherit pro_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a733e3944b51dced26ef257f047c227dc inherit pro_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">void </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 inherit pro_methods_class_h_i_d"><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:a1c333e67c1bd0e69db565d6976d063b1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a1c333e67c1bd0e69db565d6976d063b1">bHasReportId</a></td></tr>
|
|
<tr class="separator:a1c333e67c1bd0e69db565d6976d063b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_h_i_d')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:a1583e665c2b930e8683c10dc271f013f inherit pro_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a1583e665c2b930e8683c10dc271f013f">pUsb</a></td></tr>
|
|
<tr class="separator:a1583e665c2b930e8683c10dc271f013f inherit pro_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a525edb36c2cd8470eae703d3b236e4a7 inherit pro_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a525edb36c2cd8470eae703d3b236e4a7">bAddress</a></td></tr>
|
|
<tr class="separator:a525edb36c2cd8470eae703d3b236e4a7 inherit pro_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_static_attribs_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_class_h_i_d')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:a845b9961830a6778c296e8571759dd38 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </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 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb7fc07fe6dbc98d518967fdbc441ab3 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </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 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe5186f46ac7b580bb3dc289e3f237b2 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </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 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd92969682030cd5cac310dd7746c7c7 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </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 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a884aa67312324e7d23a052a6dc80337e inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </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 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </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="hiduniversal_8h_source.html#l00007">7</a> of file <a class="el" href="hiduniversal_8h_source.html">hiduniversal.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="abdbac688c7e4b682055cebd82e13a595"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">HIDUniversal::HIDUniversal </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> * </td>
|
|
<td class="paramname"><em>p</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00003">3</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aff53de37b98aa1e4a6e45be701ddcc65"></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_h_i_d_report_parser.html">HIDReportParser</a> * HIDUniversal::GetReportParser </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </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 from <a class="el" href="class_h_i_d.html#ac51c88a0be514a748598008d312adc1d">HID</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00065">65</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a60f06d86767b4b2c973d08383c7a0048"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual uint8_t HIDUniversal::OnInitSuccessful </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 class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8h_source.html#l00056">56</a> of file <a class="el" href="hiduniversal_8h_source.html">hiduniversal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afbd599879e9c3cdea382e87afd6ab29a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool HIDUniversal::SetReportParser </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </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> * </td>
|
|
<td class="paramname"><em>prs</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>Reimplemented from <a class="el" href="class_h_i_d.html#ae3b964d20c828fb27076f50d220fe275">HID</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00054">54</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a384b0e219f763e2d6407636bfd4ccea7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t HIDUniversal::Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>parent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>port</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>lowspeed</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>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a3706cf6b18785aff823171e280bab738">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00076">76</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af999fc50ef4b5dec0391bda79ec83bda"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t HIDUniversal::Release </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</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 from <a class="el" href="class_u_s_b_device_config.html#a61e301efedae55c6ac12c6cce154e432">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00312">312</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac27e857a0d9619c8abc31be0b690c83c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t HIDUniversal::Poll </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</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 from <a class="el" href="class_u_s_b_device_config.html#a893ea73deab98be837c257201e7da25a">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00339">339</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abcc6921b7beaf0aac2acbcdddd535626"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual uint8_t HIDUniversal::GetAddress </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 class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a2bfde6c290d32888a6f4e97fa1e222f1">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8h_source.html#l00071">71</a> of file <a class="el" href="hiduniversal_8h_source.html">hiduniversal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab9b13f27eca16e0accc14fff9bd318e2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void HIDUniversal::EndpointXtract </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>conf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>iface</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>alt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>proto</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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> * </td>
|
|
<td class="paramname"><em>ep</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>Implements <a class="el" href="class_usb_config_xtracter.html#aceb5da8339172cbb2e9ce2064e34e5ef">UsbConfigXtracter</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="hiduniversal_8cpp_source.html#l00269">269</a> of file <a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a1c333e67c1bd0e69db565d6976d063b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool HIDUniversal::bHasReportId</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="hiduniversal_8h_source.html#l00051">51</a> of file <a class="el" href="hiduniversal_8h_source.html">hiduniversal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="hiduniversal_8h_source.html">hiduniversal.h</a></li>
|
|
<li><a class="el" href="hiduniversal_8cpp_source.html">hiduniversal.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|