235 lines
30 KiB
HTML
235 lines
30 KiB
HTML
<!-- HTML header for doxygen 1.8.6-->
|
|
<!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.6"/>
|
|
<title>tinyusb: tinyusb/class/hid_host.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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table width="100%" cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">tinyusb
|
|
 <span id="projectnumber">0.4</span>
|
|
</div>
|
|
</td>
|
|
<td align="right">
|
|
<a href="https://pledgie.com/campaigns/24694"><img border="0" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com"></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<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="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</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>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('hid__host_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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>Data Structures</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>Groups</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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">hid_host.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="hid__host_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">/**************************************************************************/</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/**************************************************************************/</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifndef _TUSB_HID_HOST_H_</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#define _TUSB_HID_HOST_H_</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include "<a class="code" href="common_8h.html">common/common.h</a>"</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="usbh_8h.html">host/usbh.h</a>"</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include "<a class="code" href="hid_8h.html">hid.h</a>"</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// KEYBOARD Application API</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span><span class="keyword">extern</span> uint8_t <span class="keyword">const</span> hid_keycode_to_ascii_tbl[2][128]; <span class="comment">// TODO used weak attr if build failed without KEYBOARD enabled</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">bool</span> <a class="code" href="group___keyboard___host.html#ga9b7f3a8071c150c992e27f9770b448e0">tusbh_hid_keyboard_is_mounted</a>(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">bool</span> <a class="code" href="group___keyboard___host.html#ga163bd0effa54d7a9b3b6498db687f51e">tusbh_hid_keyboard_is_busy</a>(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> <a class="code" href="group___keyboard___host.html#ga4d86bb2f2a64790bbfe59be915e817d4">tusbh_hid_keyboard_get_report</a>(uint8_t dev_addr, <span class="keywordtype">void</span> * p_report) <span class="comment">/*ATTR_WARN_UNUSED_RESULT*/</span>;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">//------------- Application Callback -------------//</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group___keyboard___host.html#gae79ff54a479069714b3f0394654fcb58">tusbh_hid_keyboard_isr</a>(uint8_t dev_addr, tusb_event_t event);</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">void</span> <a class="code" href="group___keyboard___host.html#gaa2ad3b3612d7fb245a901a541cdce0d7">tusbh_hid_keyboard_mounted_cb</a>(uint8_t dev_addr);</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">void</span> <a class="code" href="group___keyboard___host.html#ga5d576f50c00cad7355fe6151573ff7f1">tusbh_hid_keyboard_unmounted_cb</a>(uint8_t dev_addr);</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// Keyboard_Host // ClassDriver_HID_Keyboard</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">// MOUSE Application API</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="group___mouse___host.html#gaba99453fce746bc560b2e0742809d600">tusbh_hid_mouse_is_mounted</a>(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keywordtype">bool</span> <a class="code" href="group___mouse___host.html#ga9b967f28cc45cc09bdefa6597ce43306">tusbh_hid_mouse_is_busy</a>(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> <a class="code" href="group___mouse___host.html#gab14bb230b82860297ad33a9263ada436">tusbh_hid_mouse_get_report</a>(uint8_t dev_addr, <span class="keywordtype">void</span>* p_report) <span class="comment">/*ATTR_WARN_UNUSED_RESULT*/</span>;</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">//------------- Application Callback -------------//</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group___mouse___host.html#gaad8058b9b62955b2ce380e57b8d656af">tusbh_hid_mouse_isr</a>(uint8_t dev_addr, tusb_event_t event);</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">void</span> <a class="code" href="group___mouse___host.html#gaeceda0ffd90fa31f1b60bb408ae334e0">tusbh_hid_mouse_mounted_cb</a>(uint8_t dev_addr);</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="keywordtype">void</span> <a class="code" href="group___mouse___host.html#gae00e034f1f961ba5e507b6274753bbed">tusbh_hid_mouse_unmounted_cb</a>(uint8_t dev_addr);</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="comment">// Mouse_Host // ClassDriver_HID_Mouse</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">// GENERIC Application API</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"></span><span class="keywordtype">bool</span> tusbh_hid_generic_is_mounted(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> tusbh_hid_generic_get_report(uint8_t dev_addr, <span class="keywordtype">void</span>* p_report, <span class="keywordtype">bool</span> int_on_complete) <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> tusbh_hid_generic_set_report(uint8_t dev_addr, <span class="keywordtype">void</span>* p_report, <span class="keywordtype">bool</span> int_on_complete) <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <a class="code" href="group__group__usbh.html#gab0cdb8d740ea760cb336a5661df527e6">tusb_interface_status_t</a> tusbh_hid_generic_get_status(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <a class="code" href="group__group__usbh.html#gab0cdb8d740ea760cb336a5661df527e6">tusb_interface_status_t</a> tusbh_hid_generic_set_status(uint8_t dev_addr) <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">//------------- Application Callback -------------//</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="keywordtype">void</span> tusbh_hid_generic_isr(uint8_t dev_addr, tusb_event_t event);</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="comment">// Generic_Host // ClassDriver_HID_Generic</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">// USBH-CLASS DRIVER API</span></div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="preprocessor">#ifdef _TINY_USB_SOURCE_FILE_</span></div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <a class="code" href="structpipe__handle__t.html">pipe_handle_t</a> pipe_hdl;</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  uint16_t report_size;</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  uint8_t interface_number;</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> }hidh_interface_info_t;</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="keywordtype">void</span> hidh_init(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> hidh_open_subtask(uint8_t dev_addr, <a class="code" href="structtusb__descriptor__interface__t.html">tusb_descriptor_interface_t</a> <span class="keyword">const</span> *p_interface_desc, uint16_t *p_length) <a class="code" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a>;</div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="keywordtype">void</span> hidh_isr(<a class="code" href="structpipe__handle__t.html">pipe_handle_t</a> pipe_hdl, tusb_event_t event, uint32_t xferred_bytes);</div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="keywordtype">void</span> hidh_close(uint8_t dev_addr);</div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor"></span>}</div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="preprocessor">#endif </span><span class="comment">/* _TUSB_HID_HOST_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="preprocessor"></span> <span class="comment">// ClassDriver_HID</span></div>
|
|
<div class="ttc" id="structtusb__descriptor__interface__t_html"><div class="ttname"><a href="structtusb__descriptor__interface__t.html">tusb_descriptor_interface_t</a></div><div class="ttdoc">USB Standard Interface Descriptor (section 9.6.1 table 9-12) </div><div class="ttdef"><b>Definition:</b> <a href="std__descriptors_8h_source.html#l00090">std_descriptors.h:90</a></div></div>
|
|
<div class="ttc" id="group___keyboard___host_html_gae79ff54a479069714b3f0394654fcb58"><div class="ttname"><a href="group___keyboard___host.html#gae79ff54a479069714b3f0394654fcb58">tusbh_hid_keyboard_isr</a></div><div class="ttdeci">void tusbh_hid_keyboard_isr(uint8_t dev_addr, tusb_event_t event)</div><div class="ttdoc">Callback function that is invoked when an transferring event occurred. </div></div>
|
|
<div class="ttc" id="usbh_8h_html"><div class="ttname"><a href="usbh_8h.html">usbh.h</a></div></div>
|
|
<div class="ttc" id="group___group___func_attr_html_gaa61f3d1a169c3d97d95072b1ee6493fd"><div class="ttname"><a href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></div><div class="ttdeci">#define ATTR_WARN_UNUSED_RESULT</div><div class="ttdoc">The warn_unused_result attribute causes a warning to be emitted if a caller of the function with this...</div><div class="ttdef"><b>Definition:</b> <a href="compiler__gcc_8h_source.html#l00118">compiler_gcc.h:118</a></div></div>
|
|
<div class="ttc" id="hid_8h_html"><div class="ttname"><a href="hid_8h.html">hid.h</a></div></div>
|
|
<div class="ttc" id="group___mouse___host_html_gaeceda0ffd90fa31f1b60bb408ae334e0"><div class="ttname"><a href="group___mouse___host.html#gaeceda0ffd90fa31f1b60bb408ae334e0">tusbh_hid_mouse_mounted_cb</a></div><div class="ttdeci">void tusbh_hid_mouse_mounted_cb(uint8_t dev_addr)</div><div class="ttdoc">Callback function that will be invoked when a device with Mouse interface is mounted. </div></div>
|
|
<div class="ttc" id="structpipe__handle__t_html"><div class="ttname"><a href="structpipe__handle__t.html">pipe_handle_t</a></div><div class="ttdef"><b>Definition:</b> <a href="hcd_8h_source.html#l00063">hcd.h:63</a></div></div>
|
|
<div class="ttc" id="group___keyboard___host_html_ga4d86bb2f2a64790bbfe59be915e817d4"><div class="ttname"><a href="group___keyboard___host.html#ga4d86bb2f2a64790bbfe59be915e817d4">tusbh_hid_keyboard_get_report</a></div><div class="ttdeci">tusb_error_t tusbh_hid_keyboard_get_report(uint8_t dev_addr, void *p_report)</div><div class="ttdoc">Perform a get report from Keyboard interface. </div></div>
|
|
<div class="ttc" id="group___keyboard___host_html_gaa2ad3b3612d7fb245a901a541cdce0d7"><div class="ttname"><a href="group___keyboard___host.html#gaa2ad3b3612d7fb245a901a541cdce0d7">tusbh_hid_keyboard_mounted_cb</a></div><div class="ttdeci">void tusbh_hid_keyboard_mounted_cb(uint8_t dev_addr)</div><div class="ttdoc">Callback function that will be invoked when a device with Keyboard interface is mounted. </div></div>
|
|
<div class="ttc" id="group___group___func_attr_html_ga477faefde32bfd89d5b5b40d70b1a998"><div class="ttname"><a href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a></div><div class="ttdeci">#define ATTR_PURE</div><div class="ttdoc">Many functions have no effects except the return value and their return value depends only on the par...</div><div class="ttdef"><b>Definition:</b> <a href="compiler__gcc_8h_source.html#l00096">compiler_gcc.h:96</a></div></div>
|
|
<div class="ttc" id="group___keyboard___host_html_ga5d576f50c00cad7355fe6151573ff7f1"><div class="ttname"><a href="group___keyboard___host.html#ga5d576f50c00cad7355fe6151573ff7f1">tusbh_hid_keyboard_unmounted_cb</a></div><div class="ttdeci">void tusbh_hid_keyboard_unmounted_cb(uint8_t dev_addr)</div><div class="ttdoc">Callback function that will be invoked when a device with Keyboard interface is unmounted. </div></div>
|
|
<div class="ttc" id="group__group__usbh_html_gab0cdb8d740ea760cb336a5661df527e6"><div class="ttname"><a href="group__group__usbh.html#gab0cdb8d740ea760cb336a5661df527e6">tusb_interface_status_t</a></div><div class="ttdeci">enum tusb_interface_status_ tusb_interface_status_t</div></div>
|
|
<div class="ttc" id="group___keyboard___host_html_ga9b7f3a8071c150c992e27f9770b448e0"><div class="ttname"><a href="group___keyboard___host.html#ga9b7f3a8071c150c992e27f9770b448e0">tusbh_hid_keyboard_is_mounted</a></div><div class="ttdeci">bool tusbh_hid_keyboard_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT</div><div class="ttdoc">Check if device supports Keyboard interface or not. </div></div>
|
|
<div class="ttc" id="group___mouse___host_html_gaba99453fce746bc560b2e0742809d600"><div class="ttname"><a href="group___mouse___host.html#gaba99453fce746bc560b2e0742809d600">tusbh_hid_mouse_is_mounted</a></div><div class="ttdeci">bool tusbh_hid_mouse_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT</div><div class="ttdoc">Check if device supports Mouse interface or not. </div></div>
|
|
<div class="ttc" id="group___mouse___host_html_ga9b967f28cc45cc09bdefa6597ce43306"><div class="ttname"><a href="group___mouse___host.html#ga9b967f28cc45cc09bdefa6597ce43306">tusbh_hid_mouse_is_busy</a></div><div class="ttdeci">bool tusbh_hid_mouse_is_busy(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT</div><div class="ttdoc">Check if the interface is currently busy or not. </div></div>
|
|
<div class="ttc" id="group___group___error_html_ga225612897c510054ef4026586562f716"><div class="ttname"><a href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a></div><div class="ttdeci">tusb_error_t</div><div class="ttdoc">Error Code returned. </div><div class="ttdef"><b>Definition:</b> <a href="tusb__errors_8h_source.html#l00097">tusb_errors.h:97</a></div></div>
|
|
<div class="ttc" id="group___mouse___host_html_gab14bb230b82860297ad33a9263ada436"><div class="ttname"><a href="group___mouse___host.html#gab14bb230b82860297ad33a9263ada436">tusbh_hid_mouse_get_report</a></div><div class="ttdeci">tusb_error_t tusbh_hid_mouse_get_report(uint8_t dev_addr, void *p_report)</div><div class="ttdoc">Perform a get report from Mouse interface. </div></div>
|
|
<div class="ttc" id="group___keyboard___host_html_ga163bd0effa54d7a9b3b6498db687f51e"><div class="ttname"><a href="group___keyboard___host.html#ga163bd0effa54d7a9b3b6498db687f51e">tusbh_hid_keyboard_is_busy</a></div><div class="ttdeci">bool tusbh_hid_keyboard_is_busy(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT</div><div class="ttdoc">Check if the interface is currently busy or not. </div></div>
|
|
<div class="ttc" id="common_8h_html"><div class="ttname"><a href="common_8h.html">common.h</a></div></div>
|
|
<div class="ttc" id="group___mouse___host_html_gae00e034f1f961ba5e507b6274753bbed"><div class="ttname"><a href="group___mouse___host.html#gae00e034f1f961ba5e507b6274753bbed">tusbh_hid_mouse_unmounted_cb</a></div><div class="ttdeci">void tusbh_hid_mouse_unmounted_cb(uint8_t dev_addr)</div><div class="ttdoc">Callback function that will be invoked when a device with Mouse interface is unmounted. </div></div>
|
|
<div class="ttc" id="group___mouse___host_html_gaad8058b9b62955b2ce380e57b8d656af"><div class="ttname"><a href="group___mouse___host.html#gaad8058b9b62955b2ce380e57b8d656af">tusbh_hid_mouse_isr</a></div><div class="ttdeci">void tusbh_hid_mouse_isr(uint8_t dev_addr, tusb_event_t event)</div><div class="ttdoc">Callback function that is invoked when an transferring event occurred. </div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_f44c0f1c8d3a85cc1de1e7f4648a56e6.html">tinyusb</a></li><li class="navelem"><a class="el" href="dir_c0cc4bd312f8dff81e67f48a71e5871f.html">class</a></li><li class="navelem"><a class="el" href="hid__host_8h.html">hid_host.h</a></li>
|
|
<li class="footer">Generated on Thu Apr 17 2014 13:05:23 for tinyusb by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|