mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
124 lines
46 KiB
HTML
124 lines
46 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||
|
|
<title>USB Host Shield 2.0: usbhid.h Source File</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>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
</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.11 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
||
|
|
<li><a href="globals.html"><span>File 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)">
|
||
|
|
</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 id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<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>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">usbhid.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="usbhid_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> <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> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <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> <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> <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> <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> <span class="comment">the GPL2 ("Copyleft").</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Contact information</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">-------------------</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">Circuits At Home, LTD</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">Web : http://www.circuitsathome.com</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">e-mail : support@circuitsathome.com</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#if !defined(__USBHID_H__)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define __USBHID_H__</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="_usb_8h.html">Usb.h</a>"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="hidusagestr_8h.html">hidusagestr.h</a>"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="usbhid_8h.html#aeeb08a8b14bc04296f1c839872abc8af"> 23</a></span> <span class="preprocessor">#define MAX_REPORT_PARSERS 2</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="usbhid_8h.html#a9901c86718db1fefe5d116aa254361cf"> 24</a></span> <span class="preprocessor">#define HID_MAX_HID_CLASS_DESCRIPTORS 5</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="usbhid_8h.html#a80a14b35dd7216f368201bbdc1cb101c"> 26</a></span> <span class="preprocessor">#define DAT
|
||
|
|
<div class="ttc" id="class_u_s_b_h_i_d_html_abb120ee1258c49b4af0fbd59ae6903f5"><div class="ttname"><a href="class_u_s_b_h_i_d.html#abb120ee1258c49b4af0fbd59ae6903f5">USBHID::pUsb</a></div><div class="ttdeci">USB * pUsb</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00145">usbhid.h:145</a></div></div>
|
||
|
|
<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#l00141">usb_ch9.h:141</a></div></div>
|
||
|
|
<div class="ttc" id="class_u_s_b_device_config_html"><div class="ttname"><a href="class_u_s_b_device_config.html">USBDeviceConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="_usb_core_8h_source.html#l00121">UsbCore.h:121</a></div></div>
|
||
|
|
<div class="ttc" id="_usb_8h_html"><div class="ttname"><a href="_usb_8h.html">Usb.h</a></div></div>
|
||
|
|
<div class="ttc" id="struct_hid_item_prefix_html_a9c8a256ca8e493adfce8772445fef01e"><div class="ttname"><a href="struct_hid_item_prefix.html#a9c8a256ca8e493adfce8772445fef01e">HidItemPrefix::bTag</a></div><div class="ttdeci">uint8_t bTag</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00122">usbhid.h:122</a></div></div>
|
||
|
|
<div class="ttc" id="struct_hid_item_prefix_html_a16874c73fdb809e4c46407ca83684927"><div class="ttname"><a href="struct_hid_item_prefix.html#a16874c73fdb809e4c46407ca83684927">HidItemPrefix::bType</a></div><div class="ttdeci">uint8_t bType</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00121">usbhid.h:121</a></div></div>
|
||
|
|
<div class="ttc" id="struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r_html"><div class="ttname"><a href="struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r.html">USB_HID_DESCRIPTOR</a></div><div class="ttdef"><b>Definition:</b> <a href="usb__ch9_8h_source.html#l00151">usb_ch9.h:151</a></div></div>
|
||
|
|
<div class="ttc" id="struct_hid_item_prefix_html_a4b0af0a3d7ac50bdbedcd5fae929200d"><div class="ttname"><a href="struct_hid_item_prefix.html#a4b0af0a3d7ac50bdbedcd5fae929200d">HidItemPrefix::bSize</a></div><div class="ttdeci">uint8_t bSize</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00120">usbhid.h:120</a></div></div>
|
||
|
|
<div class="ttc" id="class_u_s_b_h_i_d_html_ad90bc410a083495a4ddefc2000f67dbd"><div class="ttname"><a href="class_u_s_b_h_i_d.html#ad90bc410a083495a4ddefc2000f67dbd">USBHID::GetUsb</a></div><div class="ttdeci">const USB * GetUsb()</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00168">usbhid.h:168</a></div></div>
|
||
|
|
<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="hidusagestr_8h_html"><div class="ttname"><a href="hidusagestr_8h.html">hidusagestr.h</a></div></div>
|
||
|
|
<div class="ttc" id="class_u_s_b_h_i_d_html_a2d8aa4af4c7d0470d6643fa94e9b39dd"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a2d8aa4af4c7d0470d6643fa94e9b39dd">USBHID::USBHID</a></div><div class="ttdeci">USBHID(USB *pusb)</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00165">usbhid.h:165</a></div></div>
|
||
|
|
<div class="ttc" id="class_u_s_b_read_parser_html"><div class="ttname"><a href="class_u_s_b_read_parser.html">USBReadParser</a></div><div class="ttdef"><b>Definition:</b> <a href="_usb_core_8h_source.html#l00192">UsbCore.h:192</a></div></div>
|
||
|
|
<div class="ttc" id="class_usb_config_xtracter_html"><div class="ttname"><a href="class_usb_config_xtracter.html">UsbConfigXtracter</a></div><div class="ttdef"><b>Definition:</b> <a href="confdescparser_8h_source.html#l00023">confdescparser.h:23</a></div></div>
|
||
|
|
<div class="ttc" id="hidboot_8h_html_aa1e198c16d2e9fad0e5c025e801f2fae"><div class="ttname"><a href="hidboot_8h.html#aa1e198c16d2e9fad0e5c025e801f2fae">totalEndpoints</a></div><div class="ttdeci">#define totalEndpoints(p)</div><div class="ttdef"><b>Definition:</b> <a href="hidboot_8h_source.html#l00033">hidboot.h:33</a></div></div>
|
||
|
|
<div class="ttc" id="struct_hid_item_prefix_html"><div class="ttname"><a href="struct_hid_item_prefix.html">HidItemPrefix</a></div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00119">usbhid.h:119</a></div></div>
|
||
|
|
<div class="ttc" id="struct_main_item_i_o_feature_html"><div class="ttname"><a href="struct_main_item_i_o_feature.html">MainItemIOFeature</a></div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00125">usbhid.h:125</a></div></div>
|
||
|
|
<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>
|
||
|
|
<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#l00197">UsbCore.h:197</a></div></div>
|
||
|
|
<div class="ttc" id="class_u_s_b_h_i_d_html_a17a732bbb37d8f21181d02d515f40499"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a17a732bbb37d8f21181d02d515f40499">USBHID::SetReportParser</a></div><div class="ttdeci">virtual bool SetReportParser(uint8_t id, HIDReportParser *prs)</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00172">usbhid.h:172</a></div></div>
|
||
|
|
<div class="ttc" id="class_u_s_b_h_i_d_html_a4be1a2ac35ac7c4babca78b8148116ec"><div class="ttname"><a href="class_u_s_b_h_i_d.html#a4be1a2ac35ac7c4babca78b8148116ec">USBHID::GetReportParser</a></div><div class="ttdeci">virtual HIDReportParser * GetReportParser(uint8_t id)</div><div class="ttdef"><b>Definition:</b> <a href="usbhid_8h_source.html#l00159">usbhid.h:159</a></div></div>
|
||
|
|
</div><!-- fragment --></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.11
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|