Google GitGoogle Git
Sign in
pigweed/third_party/github/hathach/tinyusb/3f6f8ab9610cc52b4f187908623f7dadb19a61d8/./0.4/group__group__usbh.html
blob: 6fccfa44ef1f9e7015b0d3495802cd406f1f11b8 [file]
<!-- 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: USB Host Core (USBH)</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><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__group__usbh.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="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">USB Host Core (USBH)</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group___group___h_c_d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___group___h_c_d.html">Host Controller Driver (HCD)</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa489879d67aa165689dcd0e7f5528541"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbh.html#gaa489879d67aa165689dcd0e7f5528541">tusb_interface_status_</a> { <br/>
&#160;&#160;<b>TUSB_INTERFACE_STATUS_READY</b> = 0,
<b>TUSB_INTERFACE_STATUS_BUSY</b>,
<b>TUSB_INTERFACE_STATUS_COMPLETE</b>,
<b>TUSB_INTERFACE_STATUS_ERROR</b>,
<br/>
&#160;&#160;<b>TUSB_INTERFACE_STATUS_INVALID_PARA</b>
<br/>
}</td></tr>
<tr class="separator:gaa489879d67aa165689dcd0e7f5528541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0cdb8d740ea760cb336a5661df527e6"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__group__usbh.html#gaa489879d67aa165689dcd0e7f5528541">tusb_interface_status_</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbh.html#gab0cdb8d740ea760cb336a5661df527e6">tusb_interface_status_t</a></td></tr>
<tr class="separator:gab0cdb8d740ea760cb336a5661df527e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae356a557ac1e3ed2d4dc89992260723"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaae356a557ac1e3ed2d4dc89992260723"></a>
<a class="el" href="group___u_s_b_def___type.html#ga338a80b2964f1b2fd8ce2bc6b349579d">tusb_device_state_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>tusbh_device_get_state</b> (uint8_t dev_addr) <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a> <a class="el" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a></td></tr>
<tr class="separator:gaae356a557ac1e3ed2d4dc89992260723"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd2eb5e774bcfc038aab4ba60a7d8c82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacd2eb5e774bcfc038aab4ba60a7d8c82"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>tusbh_device_is_configured</b> (uint8_t dev_addr) <a class="el" href="group___group___i_a_r.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a> <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a> <a class="el" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a></td></tr>
<tr class="separator:gacd2eb5e774bcfc038aab4ba60a7d8c82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4b622f909e3585ecf50cd0c5eafc6af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae4b622f909e3585ecf50cd0c5eafc6af"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>tusbh_device_get_mounted_class_flag</b> (uint8_t dev_addr)</td></tr>
<tr class="separator:gae4b622f909e3585ecf50cd0c5eafc6af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae22f303f65572eb91e7dbf300745b43e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae22f303f65572eb91e7dbf300745b43e"></a>
<a class="el" href="group___group___func_attr.html#gae4043b1626e70fabe467ba912b7596aa">ATTR_WEAK</a> uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>tusbh_device_attached_cb</b> (<a class="el" href="structtusb__descriptor__device__t.html">tusb_descriptor_device_t</a> const *p_desc_device) <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
<tr class="separator:gae22f303f65572eb91e7dbf300745b43e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga648757cd2a7d09b8ab7ad1a570bed908"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga648757cd2a7d09b8ab7ad1a570bed908"></a>
<a class="el" href="group___group___func_attr.html#gae4043b1626e70fabe467ba912b7596aa">ATTR_WEAK</a> void&#160;</td><td class="memItemRight" valign="bottom"><b>tusbh_device_mount_succeed_cb</b> (uint8_t dev_addr)</td></tr>
<tr class="separator:ga648757cd2a7d09b8ab7ad1a570bed908"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0cbf57211075db0710cdd3319dc45d62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0cbf57211075db0710cdd3319dc45d62"></a>
<a class="el" href="group___group___func_attr.html#gae4043b1626e70fabe467ba912b7596aa">ATTR_WEAK</a> void&#160;</td><td class="memItemRight" valign="bottom"><b>tusbh_device_mount_failed_cb</b> (<a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> error, <a class="el" href="structtusb__descriptor__device__t.html">tusb_descriptor_device_t</a> const *p_desc_device)</td></tr>
<tr class="separator:ga0cbf57211075db0710cdd3319dc45d62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31741aa665533810733217fd1d904211"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga31741aa665533810733217fd1d904211"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>usbh_hub_port_plugged_isr</b> (uint8_t hub_addr, uint8_t hub_port)</td></tr>
<tr class="separator:ga31741aa665533810733217fd1d904211"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gab0cdb8d740ea760cb336a5661df527e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__group__usbh.html#gaa489879d67aa165689dcd0e7f5528541">tusb_interface_status_</a> <a class="el" href="group__group__usbh.html#gab0cdb8d740ea760cb336a5661df527e6">tusb_interface_status_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>() </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaa489879d67aa165689dcd0e7f5528541"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__group__usbh.html#gaa489879d67aa165689dcd0e7f5528541">tusb_interface_status_</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>() </p>
<p>Definition at line <a class="el" href="usbh_8h_source.html#l00058">58</a> of file <a class="el" href="usbh_8h_source.html">usbh.h</a>.</p>
</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>