specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_h_i_d_boot.html
Kristian Sloth Lauszus 9b34049782 Updated the documentation
2018-10-13 15:47:19 +02:00

560 lines
36 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: HIDBoot&lt; BOOT_PROTOCOL &gt; Class Template 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" 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.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_h_i_d_boot-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HIDBoot&lt; BOOT_PROTOCOL &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="hidboot_8h_source.html">hidboot.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for HIDBoot&lt; BOOT_PROTOCOL &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_h_i_d_boot__inherit__graph.png" border="0" usemap="#_h_i_d_boot_3_01_b_o_o_t___p_r_o_t_o_c_o_l_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_h_i_d_boot_3_01_b_o_o_t___p_r_o_t_o_c_o_l_01_4_inherit__map" id="_h_i_d_boot_3_01_b_o_o_t___p_r_o_t_o_c_o_l_01_4_inherit__map">
<area shape="rect" id="node2" href="class_u_s_b_h_i_d.html" title="USBHID" alt="" coords="110,79,181,104"/>
<area shape="rect" id="node3" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,133,31"/>
<area shape="rect" id="node4" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="158,5,288,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for HIDBoot&lt; BOOT_PROTOCOL &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_h_i_d_boot__coll__graph.png" border="0" usemap="#_h_i_d_boot_3_01_b_o_o_t___p_r_o_t_o_c_o_l_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="_h_i_d_boot_3_01_b_o_o_t___p_r_o_t_o_c_o_l_01_4_coll__map" id="_h_i_d_boot_3_01_b_o_o_t___p_r_o_t_o_c_o_l_01_4_coll__map">
<area shape="rect" id="node2" href="class_u_s_b_h_i_d.html" title="USBHID" alt="" coords="187,167,259,192"/>
<area shape="rect" id="node3" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,80,133,105"/>
<area shape="rect" id="node4" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="158,80,288,105"/>
<area shape="rect" id="node5" href="class_u_s_b.html" title="USB" alt="" coords="312,80,360,105"/>
<area shape="rect" id="node6" href="class_m_a_x3421e.html" title="MAX3421E" alt="" coords="292,5,380,31"/>
</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:adf4a72a406850563dcd802cff1baeddc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#adf4a72a406850563dcd802cff1baeddc">HIDBoot</a> (<a class="el" href="class_u_s_b.html">USB</a> *p, bool bRptProtoEnable=false)</td></tr>
<tr class="separator:adf4a72a406850563dcd802cff1baeddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e44d340fab7e9eedb357ef61e1c19a5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#a3e44d340fab7e9eedb357ef61e1c19a5">SetReportParser</a> (uint8_t id, <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *prs)</td></tr>
<tr class="separator:a3e44d340fab7e9eedb357ef61e1c19a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa30d7cf292378153f41d8a13380c6119"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#aa30d7cf292378153f41d8a13380c6119">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:aa30d7cf292378153f41d8a13380c6119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa21946ce7a4531c036180b5de2941502"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#aa21946ce7a4531c036180b5de2941502">Release</a> ()</td></tr>
<tr class="separator:aa21946ce7a4531c036180b5de2941502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa950fe6f7e492c2048f59c98a58ac005"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#aa950fe6f7e492c2048f59c98a58ac005">Poll</a> ()</td></tr>
<tr class="separator:aa950fe6f7e492c2048f59c98a58ac005"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fafa2711d72ff4efd6bf91984585aba"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#a6fafa2711d72ff4efd6bf91984585aba">GetAddress</a> ()</td></tr>
<tr class="separator:a6fafa2711d72ff4efd6bf91984585aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9972f402f3141b2d71c0e59602675f68"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#a9972f402f3141b2d71c0e59602675f68">isReady</a> ()</td></tr>
<tr class="separator:a9972f402f3141b2d71c0e59602675f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04475d2cd6d8ae19d4e4149714fa4bef"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#a04475d2cd6d8ae19d4e4149714fa4bef">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:a04475d2cd6d8ae19d4e4149714fa4bef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dd6ae46dfafc0e8c752c555b863e414"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#a9dd6ae46dfafc0e8c752c555b863e414">DEVCLASSOK</a> (uint8_t klass)</td></tr>
<tr class="separator:a9dd6ae46dfafc0e8c752c555b863e414"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6e5bab1841569ea5d974b1d95aae502"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html#af6e5bab1841569ea5d974b1d95aae502">DEVSUBCLASSOK</a> (uint8_t subklass)</td></tr>
<tr class="separator:af6e5bab1841569ea5d974b1d95aae502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
<tr class="memitem:a2d8aa4af4c7d0470d6643fa94e9b39dd inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a2d8aa4af4c7d0470d6643fa94e9b39dd">USBHID</a> (<a class="el" href="class_u_s_b.html">USB</a> *pusb)</td></tr>
<tr class="separator:a2d8aa4af4c7d0470d6643fa94e9b39dd inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad90bc410a083495a4ddefc2000f67dbd inherit pub_methods_class_u_s_b_h_i_d"><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_u_s_b_h_i_d.html#ad90bc410a083495a4ddefc2000f67dbd">GetUsb</a> ()</td></tr>
<tr class="separator:ad90bc410a083495a4ddefc2000f67dbd inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0af861b780529c51c97c00dc89d56149 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a0af861b780529c51c97c00dc89d56149">SetProtocol</a> (uint8_t iface, uint8_t protocol)</td></tr>
<tr class="separator:a0af861b780529c51c97c00dc89d56149 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93f4eec0d75b7abcac5f92164e588cb3 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a93f4eec0d75b7abcac5f92164e588cb3">GetProtocol</a> (uint8_t iface, uint8_t *dataptr)</td></tr>
<tr class="separator:a93f4eec0d75b7abcac5f92164e588cb3 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a564e27e86247c8e45bc2b2b037921d04 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a564e27e86247c8e45bc2b2b037921d04">GetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t *dataptr)</td></tr>
<tr class="separator:a564e27e86247c8e45bc2b2b037921d04 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefe5089655e55bd8f32c796818778d75 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#aefe5089655e55bd8f32c796818778d75">SetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t duration)</td></tr>
<tr class="separator:aefe5089655e55bd8f32c796818778d75 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69812b5f7d3b28446826d9d5ca4a62d7 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a69812b5f7d3b28446826d9d5ca4a62d7">GetReportDescr</a> (uint16_t wIndex, <a class="el" href="class_u_s_b_read_parser.html">USBReadParser</a> *parser=NULL)</td></tr>
<tr class="separator:a69812b5f7d3b28446826d9d5ca4a62d7 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7536f1ee5de5645c6df5140ca9f345a inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#af7536f1ee5de5645c6df5140ca9f345a">GetHidDescr</a> (uint8_t ep, uint16_t nbytes, uint8_t *dataptr)</td></tr>
<tr class="separator:af7536f1ee5de5645c6df5140ca9f345a inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dab89b069f2cae6a63a151b2ffdd35a inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a1dab89b069f2cae6a63a151b2ffdd35a">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:a1dab89b069f2cae6a63a151b2ffdd35a inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66e217a1d1237239514ce6149e46cc56 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a66e217a1d1237239514ce6149e46cc56">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:a66e217a1d1237239514ce6149e46cc56 inherit pub_methods_class_u_s_b_h_i_d"><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:aef77a1e62f78c04a1aad53e8795ec89e 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#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">&#160;</td></tr>
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</td></tr>
<tr class="memitem:af920743379d8c133dda4335d11601141 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#af920743379d8c133dda4335d11601141">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
<tr class="separator:af920743379d8c133dda4335d11601141 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</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_methods_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
<tr class="memitem:a046f84af88dab2e9063db0bf36308cd4 inherit pro_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a046f84af88dab2e9063db0bf36308cd4">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:a046f84af88dab2e9063db0bf36308cd4 inherit pro_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa44154dd3ee08a39ea4c70d984ff7d9f inherit pro_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#aa44154dd3ee08a39ea4c70d984ff7d9f">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:aa44154dd3ee08a39ea4c70d984ff7d9f inherit pro_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
<tr class="memitem:abb120ee1258c49b4af0fbd59ae6903f5 inherit pro_attribs_class_u_s_b_h_i_d"><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_u_s_b_h_i_d.html#abb120ee1258c49b4af0fbd59ae6903f5">pUsb</a></td></tr>
<tr class="separator:abb120ee1258c49b4af0fbd59ae6903f5 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35fe591ddd550b290d1e88c321617ab6 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a35fe591ddd550b290d1e88c321617ab6">bAddress</a></td></tr>
<tr class="separator:a35fe591ddd550b290d1e88c321617ab6 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
<tr class="memitem:a722462978813b2154698516b729e834d inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a722462978813b2154698516b729e834d">epInterruptInIndex</a> = 1</td></tr>
<tr class="separator:a722462978813b2154698516b729e834d inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9ae556d2a7a03309db403e45eab96e8 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#af9ae556d2a7a03309db403e45eab96e8">epInterruptOutIndex</a> = 2</td></tr>
<tr class="separator:af9ae556d2a7a03309db403e45eab96e8 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a47b8c02d90076852e079acfb62ae46 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a6a47b8c02d90076852e079acfb62ae46">maxHidInterfaces</a> = 3</td></tr>
<tr class="separator:a6a47b8c02d90076852e079acfb62ae46 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cd9a3226f72cc965dcac27c3bd25ed9 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a7cd9a3226f72cc965dcac27c3bd25ed9">maxEpPerInterface</a> = 2</td></tr>
<tr class="separator:a7cd9a3226f72cc965dcac27c3bd25ed9 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17c4235f411847c34c77977bbd3e3324 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a17c4235f411847c34c77977bbd3e3324">totalEndpoints</a> = (<a class="el" href="class_u_s_b_h_i_d.html#a6a47b8c02d90076852e079acfb62ae46">maxHidInterfaces</a> * <a class="el" href="class_u_s_b_h_i_d.html#a7cd9a3226f72cc965dcac27c3bd25ed9">maxEpPerInterface</a> + 1)</td></tr>
<tr class="separator:a17c4235f411847c34c77977bbd3e3324 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;const uint8_t BOOT_PROTOCOL&gt;<br />
class HIDBoot&lt; BOOT_PROTOCOL &gt;</h3>
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00201">201</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="adf4a72a406850563dcd802cff1baeddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf4a72a406850563dcd802cff1baeddc">&#9670;&nbsp;</a></span>HIDBoot()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::<a class="el" href="class_h_i_d_boot.html">HIDBoot</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>bRptProtoEnable</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00256">256</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3e44d340fab7e9eedb357ef61e1c19a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e44d340fab7e9eedb357ef61e1c19a5">&#9670;&nbsp;</a></span>SetReportParser()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::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">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_h_i_d.html#a17a732bbb37d8f21181d02d515f40499">USBHID</a>.</p>
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00224">224</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="aa30d7cf292378153f41d8a13380c6119"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa30d7cf292378153f41d8a13380c6119">&#9670;&nbsp;</a></span>Init()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::Init </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>lowspeed</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 from <a class="el" href="class_u_s_b_device_config.html#a3706cf6b18785aff823171e280bab738">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00285">285</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="aa21946ce7a4531c036180b5de2941502"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa21946ce7a4531c036180b5de2941502">&#9670;&nbsp;</a></span>Release()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::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 class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00564">564</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="aa950fe6f7e492c2048f59c98a58ac005"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa950fe6f7e492c2048f59c98a58ac005">&#9670;&nbsp;</a></span>Poll()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::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 class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00578">578</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="a6fafa2711d72ff4efd6bf91984585aba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fafa2711d72ff4efd6bf91984585aba">&#9670;&nbsp;</a></span>GetAddress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::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 class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00234">234</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="a9972f402f3141b2d71c0e59602675f68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9972f402f3141b2d71c0e59602675f68">&#9670;&nbsp;</a></span>isReady()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::isReady </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 class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00238">238</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="a04475d2cd6d8ae19d4e4149714fa4bef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04475d2cd6d8ae19d4e4149714fa4bef">&#9670;&nbsp;</a></span>EndpointXtract()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::EndpointXtract </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>conf</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>alt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</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> *&#160;</td>
<td class="paramname"><em>ep</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 from <a class="el" href="class_usb_config_xtracter.html#a7717ea27bb756568e0deb544d8331370">UsbConfigXtracter</a>.</p>
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00539">539</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="a9dd6ae46dfafc0e8c752c555b863e414"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dd6ae46dfafc0e8c752c555b863e414">&#9670;&nbsp;</a></span>DEVCLASSOK()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::DEVCLASSOK </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>klass</em></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#a2bb3e09cf128c8ecd04ea0dfce2126e1">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00246">246</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="af6e5bab1841569ea5d974b1d95aae502"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6e5bab1841569ea5d974b1d95aae502">&#9670;&nbsp;</a></span>DEVSUBCLASSOK()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t BOOT_PROTOCOL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="class_h_i_d_boot.html">HIDBoot</a>&lt; BOOT_PROTOCOL &gt;::DEVSUBCLASSOK </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>subklass</em></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#ad2d535af92d0b97e4445a6bd51d35c57">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00250">250</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="hidboot_8h_source.html">hidboot.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink