blob: d8a31b3cc1b55b1b76bc71c26f6f86fb6c686219 [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: EHCI</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___e_h_c_i.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="#nested-classes">Data Structures</a> </div>
<div class="headertitle">
<div class="title">EHCI<div class="ingroups"><a class="el" href="group___group___h_c_d.html">Host Controller Driver (HCD)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise.
<a href="#details">More...</a></p>
<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">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionehci__link__t.html">ehci_link_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Link pointer. <a href="unionehci__link__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__qtd__t.html">ehci_qtd_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queue Element Transfer Descriptor (section 3.5) <a href="structehci__qtd__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__qhd__t.html">ehci_qhd_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queue Head (section 3.6) <a href="structehci__qhd__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__itd__t.html">ehci_itd_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highspeed Isochronous Transfer Descriptor (section 3.3) <a href="structehci__itd__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__sitd__t.html">ehci_sitd_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Split (Full-Speed) Isochronous Transfer Descriptor. <a href="structehci__sitd__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__registers__t.html">ehci_registers_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__data__t.html">ehci_data_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabfcbcb5ac86a1edac4035264bc7d2b8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>EHCI_MAX_ITD</b> = 4,
<b>EHCI_MAX_SITD</b> = 16
}</td></tr>
<tr class="separator:gaabfcbcb5ac86a1edac4035264bc7d2b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6cbf3d3e87d6fa2221fc0b467a985aae"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_h_c_i.html#ga6cbf3d3e87d6fa2221fc0b467a985aae">ehci_queue_element_type_</a> { <a class="el" href="group___e_h_c_i.html#gga6cbf3d3e87d6fa2221fc0b467a985aaea74403c018b0ab2c2391e7d09a97218ac">EHCI_QUEUE_ELEMENT_ITD</a> = 0,
<a class="el" href="group___e_h_c_i.html#gga6cbf3d3e87d6fa2221fc0b467a985aaeae77dec640b6e35bfd1afb7832e5d5ced">EHCI_QUEUE_ELEMENT_QHD</a>,
<a class="el" href="group___e_h_c_i.html#gga6cbf3d3e87d6fa2221fc0b467a985aaeaedf6f4454f16369d7283f0495d746017">EHCI_QUEUE_ELEMENT_SITD</a>,
<a class="el" href="group___e_h_c_i.html#gga6cbf3d3e87d6fa2221fc0b467a985aaeaab40dae76d9558b2b54d9f1d0cc40055">EHCI_QUEUE_ELEMENT_FSTN</a>
}</td></tr>
<tr class="separator:ga6cbf3d3e87d6fa2221fc0b467a985aae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1e3305e65f94c6b12023de02563b284"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_h_c_i.html#gab1e3305e65f94c6b12023de02563b284">tusb_pid_</a> { <b>EHCI_PID_OUT</b> = 0,
<b>EHCI_PID_IN</b>,
<b>EHCI_PID_SETUP</b>
}</td></tr>
<tr class="memdesc:gab1e3305e65f94c6b12023de02563b284"><td class="mdescLeft">&#160;</td><td class="mdescRight">EHCI PID. <br/></td></tr>
<tr class="separator:gab1e3305e65f94c6b12023de02563b284"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeeb4a4981a7b454f0f12a9ab344dbe34"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>ehci_interrupt_mask_</b> { <br/>
&#160;&#160;<b>EHCI_INT_MASK_USB</b> = BIT_(0),
<b>EHCI_INT_MASK_ERROR</b> = BIT_(1),
<b>EHCI_INT_MASK_PORT_CHANGE</b> = BIT_(2),
<b>EHCI_INT_MASK_FRAMELIST_ROLLOVER</b> = BIT_(3),
<br/>
&#160;&#160;<b>EHCI_INT_MASK_PCI_HOST_SYSTEM_ERROR</b> = BIT_(4),
<b>EHCI_INT_MASK_ASYNC_ADVANCE</b> = BIT_(5),
<b>EHCI_INT_MASK_NXP_SOF</b> = BIT_(7),
<b>EHCI_INT_MASK_NXP_ASYNC</b> = BIT_(18),
<br/>
&#160;&#160;<b>EHCI_INT_MASK_NXP_PERIODIC</b> = BIT_(19),
<b>EHCI_INT_MASK_ALL</b>
<br/>
}</td></tr>
<tr class="separator:gaeeb4a4981a7b454f0f12a9ab344dbe34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga053efb2bd286df606171aa34942d5939"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>ehci_usbcmd_pos_</b> { <br/>
&#160;&#160;<b>EHCI_USBCMD_POS_RUN_STOP</b> = 0,
<b>EHCI_USBCMD_POS_FRAMELIST_SZIE</b> = 2,
<b>EHCI_USBCMD_POS_PERIOD_ENABLE</b> = 4,
<b>EHCI_USBCMD_POS_ASYNC_ENABLE</b> = 5,
<br/>
&#160;&#160;<b>EHCI_USBCMD_POS_NXP_FRAMELIST_SIZE_MSB</b> = 15,
<b>EHCI_USBCMD_POS_INTERRUPT_THRESHOLD</b> = 16
<br/>
}</td></tr>
<tr class="separator:ga053efb2bd286df606171aa34942d5939"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06a2dfc5fbeb1c2b8c1121ce6489e140"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>ehci_portsc_change_mask_</b> { <b>EHCI_PORTSC_MASK_CONNECT_STATUS_CHANGE</b> = BIT_(1),
<b>EHCI_PORTSC_MASK_PORT_ENABLE_CHAGNE</b> = BIT_(3),
<b>EHCI_PORTSC_MASK_OVER_CURRENT_CHANGE</b> = BIT_(5),
<b>EHCI_PORTSC_MASK_ALL</b>
}</td></tr>
<tr class="separator:ga06a2dfc5fbeb1c2b8c1121ce6489e140"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0a1c30234f67fed5688ad14c8ac42288"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0a1c30234f67fed5688ad14c8ac42288"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (EHCI_CFG_FRAMELIST_SIZE_BITS&lt;=7,&quot;incorrect value&quot;)</td></tr>
<tr class="separator:ga0a1c30234f67fed5688ad14c8ac42288"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a4c4441ba72be282bf7422fc5903182"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9a4c4441ba72be282bf7422fc5903182"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structehci__qtd__t.html">ehci_qtd_t</a>)==32,&quot;size is not correct&quot;)</td></tr>
<tr class="separator:ga9a4c4441ba72be282bf7422fc5903182"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac11735ce6bf2b15a374b090ae0a8f2db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac11735ce6bf2b15a374b090ae0a8f2db"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structehci__qhd__t.html">ehci_qhd_t</a>)==64,&quot;size is not correct&quot;)</td></tr>
<tr class="separator:gac11735ce6bf2b15a374b090ae0a8f2db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf59911bac8cbcd310c518a8829de2ad5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf59911bac8cbcd310c518a8829de2ad5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structehci__itd__t.html">ehci_itd_t</a>)==64,&quot;size is not correct&quot;)</td></tr>
<tr class="separator:gaf59911bac8cbcd310c518a8829de2ad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga574d46919dc81534448bcd941309e55e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga574d46919dc81534448bcd941309e55e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STATIC_ASSERT</b> (sizeof(<a class="el" href="structehci__sitd__t.html">ehci_sitd_t</a>)==32,&quot;size is not correct&quot;)</td></tr>
<tr class="separator:ga574d46919dc81534448bcd941309e55e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga92822d83eb6fb408005b2096422b8705"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga92822d83eb6fb408005b2096422b8705"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOST_HCD_XFER_INTERRUPT</b></td></tr>
<tr class="separator:ga92822d83eb6fb408005b2096422b8705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc57e97af5c794b7631e50b5b29e55d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacc57e97af5c794b7631e50b5b29e55d0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>EHCI_PERIODIC_LIST</b>&#160;&#160;&#160;(defined HOST_HCD_XFER_INTERRUPT || defined HOST_HCD_XFER_ISOCHRONOUS)</td></tr>
<tr class="separator:gacc57e97af5c794b7631e50b5b29e55d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9987d7d2d0bc2f3e09c1730d456b6a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab9987d7d2d0bc2f3e09c1730d456b6a7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>EHCI_CFG_FRAMELIST_SIZE_BITS</b>&#160;&#160;&#160;7</td></tr>
<tr class="separator:gab9987d7d2d0bc2f3e09c1730d456b6a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f69a5aba5c4b0dba12f4d18dfabea36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5f69a5aba5c4b0dba12f4d18dfabea36"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>EHCI_FRAMELIST_SIZE</b>&#160;&#160;&#160;(1024 &gt;&gt; EHCI_CFG_FRAMELIST_SIZE_BITS)</td></tr>
<tr class="separator:ga5f69a5aba5c4b0dba12f4d18dfabea36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga6cbf3d3e87d6fa2221fc0b467a985aae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___e_h_c_i.html#ga6cbf3d3e87d6fa2221fc0b467a985aae">ehci_queue_element_type_</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga6cbf3d3e87d6fa2221fc0b467a985aaea74403c018b0ab2c2391e7d09a97218ac"></a>EHCI_QUEUE_ELEMENT_ITD</em>&#160;</td><td class="fielddoc">
<p>0 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6cbf3d3e87d6fa2221fc0b467a985aaeae77dec640b6e35bfd1afb7832e5d5ced"></a>EHCI_QUEUE_ELEMENT_QHD</em>&#160;</td><td class="fielddoc">
<p>1 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6cbf3d3e87d6fa2221fc0b467a985aaeaedf6f4454f16369d7283f0495d746017"></a>EHCI_QUEUE_ELEMENT_SITD</em>&#160;</td><td class="fielddoc">
<p>2 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6cbf3d3e87d6fa2221fc0b467a985aaeaab40dae76d9558b2b54d9f1d0cc40055"></a>EHCI_QUEUE_ELEMENT_FSTN</em>&#160;</td><td class="fielddoc">
<p>3 </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ehci_8h_source.html#l00089">89</a> of file <a class="el" href="ehci_8h_source.html">ehci.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: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>