Added doxygen output of current emulator branch.

This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions

View File

@@ -0,0 +1,217 @@
<!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.9.1"/>
<title>discoverpixy: discovery/libs/StmUsbHost/STM32_USB_HOST_Library/Class/HID/inc/usbh_hid_core.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" />
</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">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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_84db96586f7d962b526d6d9627d831c2.html">discovery</a></li><li class="navelem"><a class="el" href="dir_07523c13f04fd35d8848cb17a371cb5b.html">libs</a></li><li class="navelem"><a class="el" href="dir_a041ff5c2b284f3abb06af95928aadaf.html">StmUsbHost</a></li><li class="navelem"><a class="el" href="dir_bca67a7d060bcaa9c28f8aab2fffa8aa.html">STM32_USB_HOST_Library</a></li><li class="navelem"><a class="el" href="dir_0df032ba06b8eb810b5f40e1c65a502c.html">Class</a></li><li class="navelem"><a class="el" href="dir_5c16f4dfa412d091e24e9c53f0796f9c.html">HID</a></li><li class="navelem"><a class="el" href="dir_66bf18220a0388c6a03e6ac34011f996.html">inc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">usbh_hid_core.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="usbh__hid__core_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;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">/* Define to prevent recursive ----------------------------------------------*/</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef __USBH_HID_CORE_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define __USBH_HID_CORE_H</span></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="comment">/* Includes ------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbh__core_8h.html">usbh_core.h</a>&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbh__stdreq_8h.html">usbh_stdreq.h</a>&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usb__bsp_8h.html">usb_bsp.h</a>&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbh__ioreq_8h.html">usbh_ioreq.h</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbh__hcs_8h.html">usbh_hcs.h</a>&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">/* States for HID State Machine */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;{</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; HID_IDLE= 0,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; HID_SEND_DATA,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; HID_BUSY,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; HID_GET_DATA, </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; HID_POLL,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; HID_ERROR,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;}</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;HID_State;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;{</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; HID_REQ_IDLE = 0,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; HID_REQ_GET_REPORT_DESC,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; HID_REQ_GET_HID_DESC,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; HID_REQ_SET_IDLE,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; HID_REQ_SET_PROTOCOL,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; HID_REQ_SET_REPORT,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;HID_CtlState;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="struct_h_i_d__cb.html"> 80</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h_i_d__cb.html">HID_cb</a></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;{</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; void (*Init) (void); </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; void (*Decode) (uint8_t *data); </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;} <a class="code" href="struct_h_i_d__cb.html">HID_cb_TypeDef</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="struct___h_i_d___report.html"> 87</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct___h_i_d___report.html">_HID_Report</a> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;{</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; uint8_t ReportID; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; uint8_t ReportType; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; uint16_t UsagePage; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; uint32_t Usage[2]; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint32_t NbrUsage; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; uint32_t UsageMin; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; uint32_t UsageMax; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; int32_t LogMin; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; int32_t LogMax; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; int32_t PhyMin; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; int32_t PhyMax; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; int32_t UnitExp; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; uint32_t Unit; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; uint32_t ReportSize; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; uint32_t ReportCnt; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; uint32_t Flag; </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; uint32_t PhyUsage; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; uint32_t AppUsage; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; uint32_t LogUsage; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;} </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<a class="code" href="struct___h_i_d___report.html">HID_Report_TypeDef</a>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment">/* Structure for HID process */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="struct___h_i_d___process.html"> 112</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct___h_i_d___process.html">_HID_Process</a></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;{</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; uint8_t buff[64];</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; uint8_t hc_num_in; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; uint8_t hc_num_out; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; HID_State state; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; uint8_t HIDIntOutEp;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; uint8_t HIDIntInEp;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; HID_CtlState ctl_state;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; uint16_t length;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; uint8_t ep_addr;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; uint16_t poll; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <a class="code" href="core__cm4_8h.html#aec43007d9998a0a0e01faede4133d6be">__IO</a> uint16_t timer; </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <a class="code" href="struct_h_i_d__cb.html">HID_cb_TypeDef</a> *cb;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;}</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<a class="code" href="struct___h_i_d___process.html">HID_Machine_TypeDef</a>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="preprocessor">#define USB_HID_REQ_GET_REPORT 0x01</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="preprocessor">#define USB_HID_GET_IDLE 0x02</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="preprocessor">#define USB_HID_GET_PROTOCOL 0x03</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="preprocessor">#define USB_HID_SET_REPORT 0x09</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#define USB_HID_SET_IDLE 0x0A</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="preprocessor">#define USB_HID_SET_PROTOCOL 0x0B </span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="keyword">extern</span> <a class="code" href="struct___u_s_b_h___class__cb.html">USBH_Class_cb_TypeDef</a> <a class="code" href="struct_h_i_d__cb.html">HID_cb</a>;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;USBH_Status <a class="code" href="group___u_s_b_h___h_i_d___c_o_r_e___exported___functions_prototype.html#gac10798074f64963bd6265f542bfce36e">USBH_Set_Report</a> (<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev,</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <a class="code" href="struct___host___type_def.html">USBH_HOST</a> *phost,</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; uint8_t reportType,</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; uint8_t reportId,</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; uint8_t reportLen,</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; uint8_t* reportBuff);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __USBH_HID_CORE_H */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;<span class="comment">/******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div>
<div class="ttc" id="usb__bsp_8h_html"><div class="ttname"><a href="usb__bsp_8h.html">usb_bsp.h</a></div><div class="ttdoc">Specific api&#39;s relative to the used hardware platform. </div></div>
<div class="ttc" id="usbh__core_8h_html"><div class="ttname"><a href="usbh__core_8h.html">usbh_core.h</a></div><div class="ttdoc">Header file for usbh_core.c. </div></div>
<div class="ttc" id="group___u_s_b_h___h_i_d___c_o_r_e___exported___functions_prototype_html_gac10798074f64963bd6265f542bfce36e"><div class="ttname"><a href="group___u_s_b_h___h_i_d___c_o_r_e___exported___functions_prototype.html#gac10798074f64963bd6265f542bfce36e">USBH_Set_Report</a></div><div class="ttdeci">USBH_Status USBH_Set_Report(USB_OTG_CORE_HANDLE *pdev, USBH_HOST *phost, uint8_t reportType, uint8_t reportId, uint8_t reportLen, uint8_t *reportBuff)</div><div class="ttdoc">USBH_Set_Report Issues Set Report. </div><div class="ttdef"><b>Definition:</b> usbh_hid_core.c:541</div></div>
<div class="ttc" id="usbh__stdreq_8h_html"><div class="ttname"><a href="usbh__stdreq_8h.html">usbh_stdreq.h</a></div><div class="ttdoc">Header file for usbh_stdreq.c. </div></div>
<div class="ttc" id="struct___h_i_d___process_html"><div class="ttname"><a href="struct___h_i_d___process.html">_HID_Process</a></div><div class="ttdef"><b>Definition:</b> usbh_hid_core.h:112</div></div>
<div class="ttc" id="struct_h_i_d__cb_html"><div class="ttname"><a href="struct_h_i_d__cb.html">HID_cb</a></div><div class="ttdef"><b>Definition:</b> usbh_hid_core.h:80</div></div>
<div class="ttc" id="core__cm4_8h_html_aec43007d9998a0a0e01faede4133d6be"><div class="ttname"><a href="core__cm4_8h.html#aec43007d9998a0a0e01faede4133d6be">__IO</a></div><div class="ttdeci">#define __IO</div><div class="ttdef"><b>Definition:</b> core_cm4.h:222</div></div>
<div class="ttc" id="usbh__ioreq_8h_html"><div class="ttname"><a href="usbh__ioreq_8h.html">usbh_ioreq.h</a></div><div class="ttdoc">Header file for usbh_ioreq.c. </div></div>
<div class="ttc" id="struct_u_s_b___o_t_g__handle_html"><div class="ttname"><a href="struct_u_s_b___o_t_g__handle.html">USB_OTG_handle</a></div><div class="ttdef"><b>Definition:</b> usb_core.h:287</div></div>
<div class="ttc" id="struct___h_i_d___report_html"><div class="ttname"><a href="struct___h_i_d___report.html">_HID_Report</a></div><div class="ttdef"><b>Definition:</b> usbh_hid_core.h:87</div></div>
<div class="ttc" id="usbh__hcs_8h_html"><div class="ttname"><a href="usbh__hcs_8h.html">usbh_hcs.h</a></div><div class="ttdoc">Header file for usbh_hcs.c. </div></div>
<div class="ttc" id="struct___host___type_def_html"><div class="ttname"><a href="struct___host___type_def.html">_Host_TypeDef</a></div><div class="ttdef"><b>Definition:</b> usbh_core.h:215</div></div>
<div class="ttc" id="struct___u_s_b_h___class__cb_html"><div class="ttname"><a href="struct___u_s_b_h___class__cb.html">_USBH_Class_cb</a></div><div class="ttdef"><b>Definition:</b> usbh_core.h:174</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:18 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>