esp32-s2_dfu/0.4/hid__device_8h_source.html

227 lines
29 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_device.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
&#160;<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&#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>Data&#160;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&#160;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__device_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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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_device.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="hid__device_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">/**************************************************************************/</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">/**************************************************************************/</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#ifndef _TUSB_HID_DEVICE_H_</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _TUSB_HID_DEVICE_H_</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="common_8h.html">common/common.h</a>&quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbd_8h.html">device/usbd.h</a>&quot;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hid_8h.html">hid.h</a>&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment">// KEYBOARD APPLICATION API</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="group___keyboard___device.html#gadf674819657d0a75be8c4b94fb6163da">tusbd_hid_keyboard_is_busy</a>(uint8_t coreid);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> <a class="code" href="group___keyboard___device.html#ga392b2206c03d7e5a92d84e289d50fcdb">tusbd_hid_keyboard_send</a>(uint8_t coreid, <a class="code" href="structhid__keyboard__report__t.html">hid_keyboard_report_t</a> <span class="keyword">const</span> *p_report);</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"> 80</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment">// APPLICATION CALLBACK API</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___keyboard___device.html#ga0a2c21e286542d07224076d421c77381">tusbd_hid_keyboard_mounted_cb</a>(uint8_t coreid);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___keyboard___device.html#gadc3bc3b71df89affd07d569aba9d8ca1">tusbd_hid_keyboard_unmounted_cb</a>(uint8_t coreid);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___keyboard___device.html#ga325f15f403ee3572057fd6a55e28868e">tusbd_hid_keyboard_cb</a>(uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;uint16_t <a class="code" href="group___keyboard___device.html#gaf8345eebc7540356d9598554b91b1d4b">tusbd_hid_keyboard_get_report_cb</a>(uint8_t coreid, <a class="code" href="group___class_driver___h_i_d___common.html#gade40a5ae3c180ad9f543927d12d69fc8">hid_request_report_type_t</a> report_type, <span class="keywordtype">void</span>** pp_report, uint16_t requested_length);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___keyboard___device.html#gacf62354ad819d8e71894b7f096b8fc34">tusbd_hid_keyboard_set_report_cb</a>(uint8_t coreid, <a class="code" href="group___class_driver___h_i_d___common.html#gade40a5ae3c180ad9f543927d12d69fc8">hid_request_report_type_t</a> report_type, uint8_t p_report_data[], uint16_t length);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment">// MOUSE APPLICATION API</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="group___mouse___device.html#ga5e5d67756bc15892750de943ef937b51">tusbd_hid_mouse_is_busy</a>(uint8_t coreid);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> <a class="code" href="group___mouse___device.html#ga9ef46f1d6629ac7314defc26bbcd6ea9">tusbd_hid_mouse_send</a>(uint8_t coreid, <a class="code" href="structhid__mouse__report__t.html">hid_mouse_report_t</a> <span class="keyword">const</span> *p_report);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="comment">// APPLICATION CALLBACK API</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group___mouse___device.html#ga3228361526bd4a2cea32682b9bb6f036">tusbd_hid_mouse_mounted_cb</a>(uint8_t coreid);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___mouse___device.html#ga9a4d4675c736ea37eb9264d44f6f1eb4">tusbd_hid_mouse_unmounted_cb</a>(uint8_t coreid);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___mouse___device.html#ga20b34dac7e348b718b0bbb22ad2f6c57">tusbd_hid_mouse_cb</a>(uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes);</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;uint16_t <a class="code" href="group___mouse___device.html#gaa1bdb8035d9d62836705dd07199575ee">tusbd_hid_mouse_get_report_cb</a>(uint8_t coreid, <a class="code" href="group___class_driver___h_i_d___common.html#gade40a5ae3c180ad9f543927d12d69fc8">hid_request_report_type_t</a> report_type, <span class="keywordtype">void</span>** pp_report, uint16_t requested_length);</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___mouse___device.html#ga65365cdef2e7a72bcb6e49ae76e640bf">tusbd_hid_mouse_set_report_cb</a>(uint8_t coreid, <a class="code" href="group___class_driver___h_i_d___common.html#gade40a5ae3c180ad9f543927d12d69fc8">hid_request_report_type_t</a> report_type, uint8_t p_report_data[], uint16_t length);</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;<span class="comment">// USBD-CLASS DRIVER API</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;<span class="preprocessor">#ifdef _TINY_USB_SOURCE_FILE_</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;<span class="keywordtype">void</span> hidd_init(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> hidd_open(uint8_t coreid, <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);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> hidd_control_request_subtask(uint8_t coreid, <a class="code" href="structtusb__control__request__t.html">tusb_control_request_t</a> <span class="keyword">const</span> * p_request);</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> hidd_xfer_cb(<a class="code" href="structendpoint__handle__t.html">endpoint_handle_t</a> edpt_hdl, tusb_event_t event, uint32_t xferred_bytes);</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;<span class="keywordtype">void</span> hidd_close(uint8_t coreid);</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;<span class="preprocessor"></span> }</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _TUSB_HID_DEVICE_H_ */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;</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___mouse___device_html_ga65365cdef2e7a72bcb6e49ae76e640bf"><div class="ttname"><a href="group___mouse___device.html#ga65365cdef2e7a72bcb6e49ae76e640bf">tusbd_hid_mouse_set_report_cb</a></div><div class="ttdeci">void tusbd_hid_mouse_set_report_cb(uint8_t coreid, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length)</div><div class="ttdoc">Callback function that is invoked when USB host request HID_REQUEST_CONTROL_SET_REPORT via control en...</div></div>
<div class="ttc" id="group___keyboard___device_html_gaf8345eebc7540356d9598554b91b1d4b"><div class="ttname"><a href="group___keyboard___device.html#gaf8345eebc7540356d9598554b91b1d4b">tusbd_hid_keyboard_get_report_cb</a></div><div class="ttdeci">uint16_t tusbd_hid_keyboard_get_report_cb(uint8_t coreid, hid_request_report_type_t report_type, void **pp_report, uint16_t requested_length)</div><div class="ttdoc">Callback function that is invoked when USB host request HID_REQUEST_CONTROL_GET_REPORT via control en...</div></div>
<div class="ttc" id="structtusb__control__request__t_html"><div class="ttname"><a href="structtusb__control__request__t.html">tusb_control_request_t</a></div><div class="ttdef"><b>Definition:</b> <a href="std__request_8h_source.html#l00049">std_request.h:49</a></div></div>
<div class="ttc" id="group___keyboard___device_html_ga325f15f403ee3572057fd6a55e28868e"><div class="ttname"><a href="group___keyboard___device.html#ga325f15f403ee3572057fd6a55e28868e">tusbd_hid_keyboard_cb</a></div><div class="ttdeci">void tusbd_hid_keyboard_cb(uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes)</div><div class="ttdoc">Callback function that is invoked when an transferring event occurred after invoking tusbd_hid_keyboa...</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="structhid__mouse__report__t_html"><div class="ttname"><a href="structhid__mouse__report__t.html">hid_mouse_report_t</a></div><div class="ttdoc">Standard HID Boot Protocol Mouse Report. </div><div class="ttdef"><b>Definition:</b> <a href="hid_8h_source.html#l00158">hid.h:158</a></div></div>
<div class="ttc" id="group___mouse___device_html_ga9a4d4675c736ea37eb9264d44f6f1eb4"><div class="ttname"><a href="group___mouse___device.html#ga9a4d4675c736ea37eb9264d44f6f1eb4">tusbd_hid_mouse_unmounted_cb</a></div><div class="ttdeci">void tusbd_hid_mouse_unmounted_cb(uint8_t coreid)</div><div class="ttdoc">Callback function that will be invoked when this interface is unmounted (bus reset/unplugged) ...</div></div>
<div class="ttc" id="group___keyboard___device_html_gadc3bc3b71df89affd07d569aba9d8ca1"><div class="ttname"><a href="group___keyboard___device.html#gadc3bc3b71df89affd07d569aba9d8ca1">tusbd_hid_keyboard_unmounted_cb</a></div><div class="ttdeci">void tusbd_hid_keyboard_unmounted_cb(uint8_t coreid)</div><div class="ttdoc">Callback function that will be invoked when this interface is unmounted (bus reset/unplugged) ...</div></div>
<div class="ttc" id="group___mouse___device_html_ga5e5d67756bc15892750de943ef937b51"><div class="ttname"><a href="group___mouse___device.html#ga5e5d67756bc15892750de943ef937b51">tusbd_hid_mouse_is_busy</a></div><div class="ttdeci">bool tusbd_hid_mouse_is_busy(uint8_t coreid)</div><div class="ttdoc">Check if the interface is currently busy or not. </div></div>
<div class="ttc" id="group___mouse___device_html_ga3228361526bd4a2cea32682b9bb6f036"><div class="ttname"><a href="group___mouse___device.html#ga3228361526bd4a2cea32682b9bb6f036">tusbd_hid_mouse_mounted_cb</a></div><div class="ttdeci">void tusbd_hid_mouse_mounted_cb(uint8_t coreid)</div><div class="ttdoc">Callback function that will be invoked when this interface is mounted (configured) by USB host...</div></div>
<div class="ttc" id="group___mouse___device_html_ga20b34dac7e348b718b0bbb22ad2f6c57"><div class="ttname"><a href="group___mouse___device.html#ga20b34dac7e348b718b0bbb22ad2f6c57">tusbd_hid_mouse_cb</a></div><div class="ttdeci">void tusbd_hid_mouse_cb(uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes)</div><div class="ttdoc">Callback function that is invoked when an transferring event occurred after invoking tusbd_hid_mouse_...</div></div>
<div class="ttc" id="group___class_driver___h_i_d___common_html_gade40a5ae3c180ad9f543927d12d69fc8"><div class="ttname"><a href="group___class_driver___h_i_d___common.html#gade40a5ae3c180ad9f543927d12d69fc8">hid_request_report_type_t</a></div><div class="ttdeci">hid_request_report_type_t</div><div class="ttdoc">HID Request Report Type. </div><div class="ttdef"><b>Definition:</b> <a href="hid_8h_source.html#l00079">hid.h:79</a></div></div>
<div class="ttc" id="group___keyboard___device_html_ga392b2206c03d7e5a92d84e289d50fcdb"><div class="ttname"><a href="group___keyboard___device.html#ga392b2206c03d7e5a92d84e289d50fcdb">tusbd_hid_keyboard_send</a></div><div class="ttdeci">tusb_error_t tusbd_hid_keyboard_send(uint8_t coreid, hid_keyboard_report_t const *p_report)</div><div class="ttdoc">Submit USB transfer. </div></div>
<div class="ttc" id="group___keyboard___device_html_gacf62354ad819d8e71894b7f096b8fc34"><div class="ttname"><a href="group___keyboard___device.html#gacf62354ad819d8e71894b7f096b8fc34">tusbd_hid_keyboard_set_report_cb</a></div><div class="ttdeci">void tusbd_hid_keyboard_set_report_cb(uint8_t coreid, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length)</div><div class="ttdoc">Callback function that is invoked when USB host request HID_REQUEST_CONTROL_SET_REPORT via control en...</div></div>
<div class="ttc" id="group___mouse___device_html_ga9ef46f1d6629ac7314defc26bbcd6ea9"><div class="ttname"><a href="group___mouse___device.html#ga9ef46f1d6629ac7314defc26bbcd6ea9">tusbd_hid_mouse_send</a></div><div class="ttdeci">tusb_error_t tusbd_hid_mouse_send(uint8_t coreid, hid_mouse_report_t const *p_report)</div><div class="ttdoc">Perform transfer queuing. </div></div>
<div class="ttc" id="structhid__keyboard__report__t_html"><div class="ttname"><a href="structhid__keyboard__report__t.html">hid_keyboard_report_t</a></div><div class="ttdoc">Standard HID Boot Protocol Keyboard Report. </div><div class="ttdef"><b>Definition:</b> <a href="hid_8h_source.html#l00182">hid.h:182</a></div></div>
<div class="ttc" id="structendpoint__handle__t_html"><div class="ttname"><a href="structendpoint__handle__t.html">endpoint_handle_t</a></div><div class="ttdef"><b>Definition:</b> <a href="dcd_8h_source.html#l00052">dcd.h:52</a></div></div>
<div class="ttc" id="group___mouse___device_html_gaa1bdb8035d9d62836705dd07199575ee"><div class="ttname"><a href="group___mouse___device.html#gaa1bdb8035d9d62836705dd07199575ee">tusbd_hid_mouse_get_report_cb</a></div><div class="ttdeci">uint16_t tusbd_hid_mouse_get_report_cb(uint8_t coreid, hid_request_report_type_t report_type, void **pp_report, uint16_t requested_length)</div><div class="ttdoc">Callback function that is invoked when USB host request HID_REQUEST_CONTROL_GET_REPORT via control en...</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___keyboard___device_html_gadf674819657d0a75be8c4b94fb6163da"><div class="ttname"><a href="group___keyboard___device.html#gadf674819657d0a75be8c4b94fb6163da">tusbd_hid_keyboard_is_busy</a></div><div class="ttdeci">bool tusbd_hid_keyboard_is_busy(uint8_t coreid)</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___keyboard___device_html_ga0a2c21e286542d07224076d421c77381"><div class="ttname"><a href="group___keyboard___device.html#ga0a2c21e286542d07224076d421c77381">tusbd_hid_keyboard_mounted_cb</a></div><div class="ttdeci">void tusbd_hid_keyboard_mounted_cb(uint8_t coreid)</div><div class="ttdoc">Callback function that will be invoked when this interface is mounted (configured) by USB host...</div></div>
<div class="ttc" id="usbd_8h_html"><div class="ttname"><a href="usbd_8h.html">usbd.h</a></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__device_8h.html">hid_device.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>