USB_Host_Shield_2.0/hiduniversal_8h_source.html

113 lines
31 KiB
HTML
Raw Normal View History

2013-01-30 22:00:18 +01:00
<!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"/>
2018-10-13 15:47:19 +02:00
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: hiduniversal.h Source File</title>
2013-01-30 22:00:18 +01:00
<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"/>
2015-04-07 16:07:33 +02:00
<script type="text/javascript" src="search/searchdata.js"></script>
2013-01-30 22:00:18 +01:00
<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"/>
2013-01-30 22:00:18 +01:00
</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;">
2016-04-19 18:16:46 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
2013-01-30 22:00:18 +01:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2018-10-13 15:47:19 +02:00
<!-- Generated by Doxygen 1.8.14 -->
2013-01-30 22:00:18 +01:00
<script type="text/javascript">
2018-10-13 15:47:19 +02:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2013-01-30 22:00:18 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2018-10-13 15:47:19 +02:00
/* @license-end */
2013-01-30 22:00:18 +01:00
</script>
2018-10-13 15:47:19 +02:00
<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>
2013-01-30 22:00:18 +01:00
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2015-04-07 16:07:33 +02:00
</div>
2013-01-30 22:00:18 +01:00
<!-- 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 id="nav-path" class="navpath">
<ul>
2016-04-19 18:16:46 +02:00
<li class="navelem"><a class="el" href="dir_69161428018e52ad84691a5947f27cc9.html">Github</a></li><li class="navelem"><a class="el" href="dir_ee762931928e29ae94e054d18c99dc9e.html">USB_Host_Shield_2_0</a></li> </ul>
2013-01-30 22:00:18 +01:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hiduniversal.h</div> </div>
</div><!--header-->
<div class="contents">
2018-10-13 15:47:19 +02:00
<a href="hiduniversal_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">This software may be distributed and modified under the terms of the GNU</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">General Public License version 2 (GPL2) as published by the Free Software</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">Foundation and appearing in the file GPL2.TXT included in the packaging of</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">this file. Please note that GPL2 Section 2[b] requires that all works based</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">on this software must also be made publicly available under the terms of</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">the GPL2 (&quot;Copyleft&quot;).</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Contact information</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">-------------------</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">Circuits At Home, LTD</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">Web : http://www.circuitsathome.com</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">e-mail : support@circuitsathome.com</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if !defined(__HIDUNIVERSAL_H__)</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define __HIDUNIVERSAL_H__</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbhid_8h.html">usbhid.h</a>&quot;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">//#include &quot;hidescriptorparser.h&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_h_i_d_universal.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_h_i_d_universal.html">HIDUniversal</a> : <span class="keyword">public</span> <a class="code" href="class_u_s_b_h_i_d.html">USBHID</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">struct </span>ReportParser {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; uint8_t rptId;</div><div class="line"><a n
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_h_i_d_universal_html_a384b0e219f763e2d6407636bfd4ccea7"><div class="ttname"><a href="class_h_i_d_universal.html#a384b0e219f763e2d6407636bfd4ccea7">HIDUniversal::Init</a></div><div class="ttdeci">uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00096">hiduniversal.cpp:96</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html_a1c333e67c1bd0e69db565d6976d063b1"><div class="ttname"><a href="class_h_i_d_universal.html#a1c333e67c1bd0e69db565d6976d063b1">HIDUniversal::bHasReportId</a></div><div class="ttdeci">bool bHasReportId</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00067">hiduniversal.h:67</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_u_s_b_h_i_d_html"><div class="ttname"><a href="class_u_s_b_h_i_d.html">USBHID</a></div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00143">usbhid.h:143</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html_aa4be95e8f5164393ea4766f68c5b0ea8"><div class="ttname"><a href="class_h_i_d_universal.html#aa4be95e8f5164393ea4766f68c5b0ea8">HIDUniversal::isReady</a></div><div class="ttdeci">virtual bool isReady()</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00097">hiduniversal.h:97</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="usbhid_8h_html_a9901c86718db1fefe5d116aa254361cf"><div class="ttname"><a href="usbhid_8h.html#a9901c86718db1fefe5d116aa254361cf">HID_MAX_HID_CLASS_DESCRIPTORS</a></div><div class="ttdeci">#define HID_MAX_HID_CLASS_DESCRIPTORS</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00024">usbhid.h:24</a></div></div>
<div class="ttc" id="usbhid_8h_html_aeeb08a8b14bc04296f1c839872abc8af"><div class="ttname"><a href="usbhid_8h.html#aeeb08a8b14bc04296f1c839872abc8af">MAX_REPORT_PARSERS</a></div><div class="ttdeci">#define MAX_REPORT_PARSERS</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00023">usbhid.h:23</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r_html"><div class="ttname"><a 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></div><div class="ttdef"><b>Definition:</b> <a href="usb__ch9_8h_source.html#l00148">usb_ch9.h:148</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_h_i_d_universal_html_a5d6e27f817d6d2c67692783a02872939"><div class="ttname"><a href="class_h_i_d_universal.html#a5d6e27f817d6d2c67692783a02872939">HIDUniversal::ParseHIDData</a></div><div class="ttdeci">virtual void ParseHIDData(USBHID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00078">hiduniversal.h:78</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="struct_h_i_d___c_l_a_s_s___d_e_s_c_r_i_p_t_o_r___l_e_n___a_n_d___t_y_p_e_html"><div class="ttname"><a href="struct_h_i_d___c_l_a_s_s___d_e_s_c_r_i_p_t_o_r___l_e_n___a_n_d___t_y_p_e.html">HID_CLASS_DESCRIPTOR_LEN_AND_TYPE</a></div><div class="ttdef"><b>Definition:</b> <a href="usb__ch9_8h_source.html#l00168">usb_ch9.h:168</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html_a542ee234ff63c01eb3dff607fb3b0def"><div class="ttname"><a href="class_h_i_d_universal.html#a542ee234ff63c01eb3dff607fb3b0def">HIDUniversal::hidInterfaces</a></div><div class="ttdeci">HIDInterface hidInterfaces[maxHidInterfaces]</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00065">hiduniversal.h:65</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_h_i_d_universal_html_af999fc50ef4b5dec0391bda79ec83bda"><div class="ttname"><a href="class_h_i_d_universal.html#af999fc50ef4b5dec0391bda79ec83bda">HIDUniversal::Release</a></div><div class="ttdeci">uint8_t Release()</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00340">hiduniversal.cpp:340</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html_a7f2123d1f20327600bb9e49a1ef5b0c7"><div class="ttname"><a href="class_h_i_d_universal.html#a7f2123d1f20327600bb9e49a1ef5b0c7">HIDUniversal::VID</a></div><div class="ttdeci">uint16_t VID</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00069">hiduniversal.h:69</a></div></div>
<div class="ttc" id="class_h_i_d_universal_html_a60f06d86767b4b2c973d08383c7a0048"><div class="ttname"><a href="class_h_i_d_universal.html#a60f06d86767b4b2c973d08383c7a0048">HIDUniversal::OnInitSuccessful</a></div><div class="ttdeci">virtual uint8_t OnInitSuccessful()</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00074">hiduniversal.h:74</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_h_i_d_universal_html_ac27e857a0d9619c8abc31be0b690c83c"><div class="ttname"><a href="class_h_i_d_universal.html#ac27e857a0d9619c8abc31be0b690c83c">HIDUniversal::Poll</a></div><div class="ttdeci">uint8_t Poll()</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00367">hiduniversal.cpp:367</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_h_i_d_universal_html_aff53de37b98aa1e4a6e45be701ddcc65"><div class="ttname"><a href="class_h_i_d_universal.html#aff53de37b98aa1e4a6e45be701ddcc65">HIDUniversal::GetReportParser</a></div><div class="ttdeci">HIDReportParser * GetReportParser(uint8_t id)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00085">hiduniversal.cpp:85</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="struct_ep_info_html"><div class="ttname"><a href="struct_ep_info.html">EpInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00039">address.h:39</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_h_i_d_universal_html_ab9b13f27eca16e0accc14fff9bd318e2"><div class="ttname"><a href="class_h_i_d_universal.html#ab9b13f27eca16e0accc14fff9bd318e2">HIDUniversal::EndpointXtract</a></div><div class="ttdeci">void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00295">hiduniversal.cpp:295</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html_abdbac688c7e4b682055cebd82e13a595"><div class="ttname"><a href="class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595">HIDUniversal::HIDUniversal</a></div><div class="ttdeci">HIDUniversal(USB *p)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00020">hiduniversal.cpp:20</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_u_s_b_h_i_d_html_a35fe591ddd550b290d1e88c321617ab6"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a35fe591ddd550b290d1e88c321617ab6">USBHID::bAddress</a></div><div class="ttdeci">uint8_t bAddress</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00146">usbhid.h:146</a></div></div>
<div class="ttc" id="class_u_s_b_h_i_d_html_a7cd9a3226f72cc965dcac27c3bd25ed9"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a7cd9a3226f72cc965dcac27c3bd25ed9">USBHID::maxEpPerInterface</a></div><div class="ttdeci">static const uint8_t maxEpPerInterface</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00153">usbhid.h:153</a></div></div>
<div class="ttc" id="class_u_s_b_h_i_d_html_a6a47b8c02d90076852e079acfb62ae46"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a6a47b8c02d90076852e079acfb62ae46">USBHID::maxHidInterfaces</a></div><div class="ttdeci">static const uint8_t maxHidInterfaces</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00152">usbhid.h:152</a></div></div>
<div class="ttc" id="class_u_s_b_h_i_d_html_a17c4235f411847c34c77977bbd3e3324"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a17c4235f411847c34c77977bbd3e3324">USBHID::totalEndpoints</a></div><div class="ttdeci">static const uint8_t totalEndpoints</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00154">usbhid.h:154</a></div></div>
<div class="ttc" id="usbhid_8h_html"><div class="ttname"><a href="usbhid_8h.html">usbhid.h</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_h_i_d_universal_html_ac88d9588f4adb6060627c3afca477fe3"><div class="ttname"><a href="class_h_i_d_universal.html#ac88d9588f4adb6060627c3afca477fe3">HIDUniversal::SndRpt</a></div><div class="ttdeci">uint8_t SndRpt(uint16_t nbytes, uint8_t *dataptr)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00423">hiduniversal.cpp:423</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_h_i_d_report_parser_html"><div class="ttname"><a href="class_h_i_d_report_parser.html">HIDReportParser</a></div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00138">usbhid.h:138</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_u_s_b_html"><div class="ttname"><a href="class_u_s_b.html">USB</a></div><div class="ttdef"><b>Definition:</b> <a href="_usb_core_8h_source.html#l00208">UsbCore.h:208</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html_abcc6921b7beaf0aac2acbcdddd535626"><div class="ttname"><a href="class_h_i_d_universal.html#abcc6921b7beaf0aac2acbcdddd535626">HIDUniversal::GetAddress</a></div><div class="ttdeci">virtual uint8_t GetAddress()</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00093">hiduniversal.h:93</a></div></div>
<div class="ttc" id="class_h_i_d_universal_html_ad26d2e63130abac2059154bf5afbf152"><div class="ttname"><a href="class_h_i_d_universal.html#ad26d2e63130abac2059154bf5afbf152">HIDUniversal::epInfo</a></div><div class="ttdeci">EpInfo epInfo[totalEndpoints]</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00064">hiduniversal.h:64</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_h_i_d_universal_html_afbd599879e9c3cdea382e87afd6ab29a"><div class="ttname"><a href="class_h_i_d_universal.html#afbd599879e9c3cdea382e87afd6ab29a">HIDUniversal::SetReportParser</a></div><div class="ttdeci">bool SetReportParser(uint8_t id, HIDReportParser *prs)</div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8cpp_source.html#l00074">hiduniversal.cpp:74</a></div></div>
2014-06-09 17:02:31 +02:00
<div class="ttc" id="class_h_i_d_universal_html"><div class="ttname"><a href="class_h_i_d_universal.html">HIDUniversal</a></div><div class="ttdef"><b>Definition:</b> <a href="hiduniversal_8h_source.html#l00024">hiduniversal.h:24</a></div></div>
2013-01-30 22:00:18 +01:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
2013-01-30 22:00:18 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
2018-10-13 15:47:19 +02:00
</a> 1.8.14
2013-01-30 22:00:18 +01:00
</small></address>
</body>
</html>