204 lines
14 KiB
HTML
204 lines
14 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: Hub (Host only)</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___class_driver___hub.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="#nested-classes">Data Structures</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Hub (Host only)<div class="ingroups"><a class="el" href="group__group__class.html">Application - Class Driver API</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdescriptor__hub__desc__t.html">descriptor_hub_desc_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhub__status__response__t.html">hub_status_response_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhub__port__status__response__t.html">hub_port_status_response_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gafb730582952b7ceec73d7dc9bf7bef39"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
|
|
  <b>HUB_REQUEST_GET_STATUS</b> = 0,
|
|
<b>HUB_REQUEST_CLEAR_FEATURE</b> = 1,
|
|
<b>HUB_REQUEST_SET_FEATURE</b> = 3,
|
|
<b>HUB_REQUEST_GET_DESCRIPTOR</b> = 6,
|
|
<br/>
|
|
  <b>HUB_REQUEST_SET_DESCRIPTOR</b> = 7,
|
|
<b>HUB_REQUEST_CLEAR_TT_BUFFER</b> = 8,
|
|
<b>HUB_REQUEST_RESET_TT</b> = 9,
|
|
<b>HUB_REQUEST_GET_TT_STATE</b> = 10,
|
|
<br/>
|
|
  <b>HUB_REQUEST_STOP_TT</b> = 11
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="separator:gafb730582952b7ceec73d7dc9bf7bef39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafccd240f973cf154952fb917c9209719"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <b>HUB_FEATURE_HUB_LOCAL_POWER_CHANGE</b> = 0,
|
|
<b>HUB_FEATURE_HUB_OVER_CURRENT_CHANGE</b>
|
|
}</td></tr>
|
|
<tr class="separator:gafccd240f973cf154952fb917c9209719"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7cc2e4244ca368f68e5746185eda6c4a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
|
|
  <b>HUB_FEATURE_PORT_CONNECTION</b> = 0,
|
|
<b>HUB_FEATURE_PORT_ENABLE</b> = 1,
|
|
<b>HUB_FEATURE_PORT_SUSPEND</b> = 2,
|
|
<b>HUB_FEATURE_PORT_OVER_CURRENT</b> = 3,
|
|
<br/>
|
|
  <b>HUB_FEATURE_PORT_RESET</b> = 4,
|
|
<b>HUB_FEATURE_PORT_POWER</b> = 8,
|
|
<b>HUB_FEATURE_PORT_LOW_SPEED</b> = 9,
|
|
<b>HUB_FEATURE_PORT_CONNECTION_CHANGE</b> = 16,
|
|
<br/>
|
|
  <b>HUB_FEATURE_PORT_ENABLE_CHANGE</b> = 17,
|
|
<b>HUB_FEATURE_PORT_SUSPEND_CHANGE</b> = 18,
|
|
<b>HUB_FEATURE_PORT_OVER_CURRENT_CHANGE</b> = 19,
|
|
<b>HUB_FEATURE_PORT_RESET_CHANGE</b> = 20,
|
|
<br/>
|
|
  <b>HUB_FEATURE_PORT_TEST</b> = 21,
|
|
<b>HUB_FEATURE_PORT_INDICATOR</b> = 22
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="separator:ga7cc2e4244ca368f68e5746185eda6c4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga96682f6032db9ed117e70dc121ae570d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga96682f6032db9ed117e70dc121ae570d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structdescriptor__hub__desc__t.html">descriptor_hub_desc_t</a>)==9,"size is not correct")</td></tr>
|
|
<tr class="separator:ga96682f6032db9ed117e70dc121ae570d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8050e8d27b5b45a84d507d2d29f2df8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8050e8d27b5b45a84d507d2d29f2df8b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structhub__status__response__t.html">hub_status_response_t</a>)==4,"size is not correct")</td></tr>
|
|
<tr class="separator:ga8050e8d27b5b45a84d507d2d29f2df8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga52fb9513cd5f248045299b6cc8049bb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga52fb9513cd5f248045299b6cc8049bb6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structhub__port__status__response__t.html">hub_port_status_response_t</a>)==4,"size is not correct")</td></tr>
|
|
<tr class="separator:ga52fb9513cd5f248045299b6cc8049bb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac6f546b4a56991b0790faa2aa8ae40d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac6f546b4a56991b0790faa2aa8ae40d0"></a>
|
|
<a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><b>hub_port_reset_subtask</b> (uint8_t hub_addr, uint8_t hub_port)</td></tr>
|
|
<tr class="separator:gac6f546b4a56991b0790faa2aa8ae40d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9e7e1e20d08d753e6efc0524e8c1a9e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e7e1e20d08d753e6efc0524e8c1a9e9"></a>
|
|
<a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><b>hub_port_clear_feature_subtask</b> (uint8_t hub_addr, uint8_t hub_port, uint8_t feature)</td></tr>
|
|
<tr class="separator:ga9e7e1e20d08d753e6efc0524e8c1a9e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga990c20f49ce707938a8ee266d0fc4609"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga990c20f49ce707938a8ee266d0fc4609"></a>
|
|
<a class="el" href="group___u_s_b_def___type.html#ga13298e8a91e362e9b4ed452d86f4671b">tusb_speed_t</a> </td><td class="memItemRight" valign="bottom"><b>hub_port_get_speed</b> (void)</td></tr>
|
|
<tr class="separator:ga990c20f49ce707938a8ee266d0fc4609"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8ab160ae6ab48885e62099cb2ae63260"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8ab160ae6ab48885e62099cb2ae63260"></a>
|
|
<a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><b>hub_status_pipe_queue</b> (uint8_t dev_addr)</td></tr>
|
|
<tr class="separator:ga8ab160ae6ab48885e62099cb2ae63260"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Like most PC's OS, Hub support is completely hidden from Application. In fact, application cannot determine whether a device is mounted directly via roothub or via a hub's port. All Hub-related procedures are performed and managed by tinyusb stack. Unless you are trying to develop the stack itself, there are nothing else can be used by Application. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Due to my laziness, only 1-level of Hub is supported. In other way, the stack cannot mount a hub via another hub. </dd></dl>
|
|
</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:29 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>
|