349 lines
19 KiB
HTML
349 lines
19 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: Host</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><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><!-- 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('group___mouse___host.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="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Host<div class="ingroups"><a class="el" href="group___class_driver___h_i_d___mouse.html">Mouse</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaba99453fce746bc560b2e0742809d600"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___mouse___host.html#gaba99453fce746bc560b2e0742809d600">tusbh_hid_mouse_is_mounted</a> (uint8_t dev_addr) <a class="el" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:gaba99453fce746bc560b2e0742809d600"><td class="mdescLeft"> </td><td class="mdescRight">Check if device supports Mouse interface or not. <a href="#gaba99453fce746bc560b2e0742809d600">More...</a><br/></td></tr>
|
|
<tr class="separator:gaba99453fce746bc560b2e0742809d600"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9b967f28cc45cc09bdefa6597ce43306"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___mouse___host.html#ga9b967f28cc45cc09bdefa6597ce43306">tusbh_hid_mouse_is_busy</a> (uint8_t dev_addr) <a class="el" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:ga9b967f28cc45cc09bdefa6597ce43306"><td class="mdescLeft"> </td><td class="mdescRight">Check if the interface is currently busy or not. <a href="#ga9b967f28cc45cc09bdefa6597ce43306">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9b967f28cc45cc09bdefa6597ce43306"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab14bb230b82860297ad33a9263ada436"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___mouse___host.html#gab14bb230b82860297ad33a9263ada436">tusbh_hid_mouse_get_report</a> (uint8_t dev_addr, void *p_report)</td></tr>
|
|
<tr class="memdesc:gab14bb230b82860297ad33a9263ada436"><td class="mdescLeft"> </td><td class="mdescRight">Perform a get report from Mouse interface. <a href="#gab14bb230b82860297ad33a9263ada436">More...</a><br/></td></tr>
|
|
<tr class="separator:gab14bb230b82860297ad33a9263ada436"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaad8058b9b62955b2ce380e57b8d656af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___mouse___host.html#gaad8058b9b62955b2ce380e57b8d656af">tusbh_hid_mouse_isr</a> (uint8_t dev_addr, tusb_event_t event)</td></tr>
|
|
<tr class="memdesc:gaad8058b9b62955b2ce380e57b8d656af"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is invoked when an transferring event occurred. <a href="#gaad8058b9b62955b2ce380e57b8d656af">More...</a><br/></td></tr>
|
|
<tr class="separator:gaad8058b9b62955b2ce380e57b8d656af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeceda0ffd90fa31f1b60bb408ae334e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___mouse___host.html#gaeceda0ffd90fa31f1b60bb408ae334e0">tusbh_hid_mouse_mounted_cb</a> (uint8_t dev_addr)</td></tr>
|
|
<tr class="memdesc:gaeceda0ffd90fa31f1b60bb408ae334e0"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that will be invoked when a device with Mouse interface is mounted. <a href="#gaeceda0ffd90fa31f1b60bb408ae334e0">More...</a><br/></td></tr>
|
|
<tr class="separator:gaeceda0ffd90fa31f1b60bb408ae334e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae00e034f1f961ba5e507b6274753bbed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___mouse___host.html#gae00e034f1f961ba5e507b6274753bbed">tusbh_hid_mouse_unmounted_cb</a> (uint8_t dev_addr)</td></tr>
|
|
<tr class="memdesc:gae00e034f1f961ba5e507b6274753bbed"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that will be invoked when a device with Mouse interface is unmounted. <a href="#gae00e034f1f961ba5e507b6274753bbed">More...</a><br/></td></tr>
|
|
<tr class="separator:gae00e034f1f961ba5e507b6274753bbed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>The interface API includes status checking function, data transferring function and callback functions </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gab14bb230b82860297ad33a9263ada436"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> tusbh_hid_mouse_get_report </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dev_addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>p_report</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform a get report from Mouse interface. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>device address </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">p_report</td><td>address that is used to store data from device. Must be accessible by usb controller (see <a class="el" href="group__group__configuration.html#ga977f8e429c64d2ea49ea42b5dac8a88c">TUSB_CFG_ATTR_USBRAM</a>) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> type to indicate success or error condition. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">TUSB_ERROR_NONE</td><td>on success </td></tr>
|
|
<tr><td class="paramname">TUSB_ERROR_INTERFACE_IS_BUSY</td><td>if the interface is already transferring data with device </td></tr>
|
|
<tr><td class="paramname">TUSB_ERROR_DEVICE_NOT_READY</td><td>if device is not yet configured (by SET CONFIGURED request) </td></tr>
|
|
<tr><td class="paramname">TUSB_ERROR_INVALID_PARA</td><td>if input parameters are not correct </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is non-blocking and returns immediately. The result of usb transfer will be reported by the interface's callback function </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9b967f28cc45cc09bdefa6597ce43306"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool tusbh_hid_mouse_is_busy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dev_addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if the interface is currently busy or not. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>device address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>if the interface is busy meaning the stack is still transferring/waiting data from/to device </td></tr>
|
|
<tr><td class="paramname">false</td><td>if the interface is not busy meaning the stack successfully transferred data from/to device </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is primarily used for polling/waiting result after <a class="el" href="group___mouse___host.html#gab14bb230b82860297ad33a9263ada436">tusbh_hid_mouse_get_report</a>. Alternatively, asynchronous event API can be used </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaba99453fce746bc560b2e0742809d600"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool tusbh_hid_mouse_is_mounted </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dev_addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if device supports Mouse interface or not. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>device address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>if device supports Mouse interface </td></tr>
|
|
<tr><td class="paramname">false</td><td>if device does not support Mouse interface or is not mounted </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaad8058b9b62955b2ce380e57b8d656af"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void tusbh_hid_mouse_isr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dev_addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">tusb_event_t </td>
|
|
<td class="paramname"><em>event</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Callback function that is invoked when an transferring event occurred. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Address of device </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>an value from tusb_event_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>event can be one of following<ul>
|
|
<li>TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully.</li>
|
|
<li>TUSB_EVENT_XFER_ERROR : previously scheduled transfer encountered a transaction error.</li>
|
|
<li>TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device. </li>
|
|
</ul>
|
|
</dd>
|
|
<dd>
|
|
Application should schedule the next report by calling <a class="el" href="group___mouse___host.html#gab14bb230b82860297ad33a9263ada436">tusbh_hid_mouse_get_report</a> within this callback </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaeceda0ffd90fa31f1b60bb408ae334e0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void tusbh_hid_mouse_mounted_cb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dev_addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Callback function that will be invoked when a device with Mouse interface is mounted. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Address of newly mounted device </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This callback should be used by Application to set-up interface-related data </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae00e034f1f961ba5e507b6274753bbed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void tusbh_hid_mouse_unmounted_cb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dev_addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Callback function that will be invoked when a device with Mouse interface is unmounted. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Address of newly unmounted device </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This callback should be used by Application to tear-down interface-related data </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated on Thu Apr 17 2014 13:05:28 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>
|