blob: 1af47dfdbca5d4793c3d2cf807b47a9d2a70e6ff [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_itd_t Struct Reference</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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</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('structehci__itd__t.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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ehci_itd_t Struct Reference<div class="ingroups"><a class="el" href="group___e_h_c_i.html">EHCI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Highspeed Isochronous Transfer Descriptor (section 3.3)
<a href="structehci__itd__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ehci_8h_source.html">ehci.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a8f18d97ad3c8b23a16c6b07c3ce58113"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f18d97ad3c8b23a16c6b07c3ce58113"></a>
<a class="el" href="unionehci__link__t.html">ehci_link_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__itd__t.html#a8f18d97ad3c8b23a16c6b07c3ce58113">next</a></td></tr>
<tr class="memdesc:a8f18d97ad3c8b23a16c6b07c3ce58113"><td class="mdescLeft">&#160;</td><td class="mdescRight">Word 0: Next Link Pointer. <br/></td></tr>
<tr class="separator:a8f18d97ad3c8b23a16c6b07c3ce58113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24787c55fad3cbc01477c9323ba56131"><td class="memItemLeft" ><a class="anchor" id="a24787c55fad3cbc01477c9323ba56131"></a>
struct {</td></tr>
<tr class="memitem:a2df482bb0528381abc0a05905bb5826a"><td class="memItemLeft" ><a class="anchor" id="a2df482bb0528381abc0a05905bb5826a"></a>
&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#a2df482bb0528381abc0a05905bb5826a">offset</a>: 12</td></tr>
<tr class="memdesc:a2df482bb0528381abc0a05905bb5826a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This field is a value that is an offset, expressed in bytes, from the beginning of a buffer. <br/></td></tr>
<tr class="separator:a2df482bb0528381abc0a05905bb5826a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82f879acedb3ac6ba026e7dce89fc711"><td class="memItemLeft" ><a class="anchor" id="a82f879acedb3ac6ba026e7dce89fc711"></a>
&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#a82f879acedb3ac6ba026e7dce89fc711">page_select</a>: 3</td></tr>
<tr class="memdesc:a82f879acedb3ac6ba026e7dce89fc711"><td class="mdescLeft">&#160;</td><td class="mdescRight">These bits are set by software to indicate which of the buffer page pointers the offset field in this slot should be concatenated to produce the starting memory address for this transaction. The valid range of values for this field is 0 to 6. <br/></td></tr>
<tr class="separator:a82f879acedb3ac6ba026e7dce89fc711"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0696e82e3bbfbb1798cc96c8fe0cb218"><td class="memItemLeft" ><a class="anchor" id="a0696e82e3bbfbb1798cc96c8fe0cb218"></a>
&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#a0696e82e3bbfbb1798cc96c8fe0cb218">int_on_complete</a>: 1</td></tr>
<tr class="memdesc:a0696e82e3bbfbb1798cc96c8fe0cb218"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this bit is set to a one, it specifies that when this transaction completes, the Host Controller should issue an interrupt at the next interrupt threshold. <br/></td></tr>
<tr class="separator:a0696e82e3bbfbb1798cc96c8fe0cb218"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa22e7675f77b1f89a273f53b2707fc8b"><td class="memItemLeft" >&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#aa22e7675f77b1f89a273f53b2707fc8b">length</a>: 12</td></tr>
<tr class="memdesc:aa22e7675f77b1f89a273f53b2707fc8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">For an IN, the initial value of the field is the number of bytes the host expects the endpoint to deliver. During the status update, the host controller writes back the number of bytes successfully received. The value in this register is the actual byte count. <a href="#aa22e7675f77b1f89a273f53b2707fc8b">More...</a><br/></td></tr>
<tr class="separator:aa22e7675f77b1f89a273f53b2707fc8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ce6f336cb93390d61b2fce5edc87d26"><td class="memItemLeft" ><a class="anchor" id="a5ce6f336cb93390d61b2fce5edc87d26"></a>
&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#a5ce6f336cb93390d61b2fce5edc87d26">error</a>: 1</td></tr>
<tr class="memdesc:a5ce6f336cb93390d61b2fce5edc87d26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to a one by the Host Controller during status update in the case where the host did not receive a valid response from the device (Timeout, CRC, Bad PID, etc.). This bit may only be set for isochronous IN transactions. <br/></td></tr>
<tr class="separator:a5ce6f336cb93390d61b2fce5edc87d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55dfaf1427c6b0df79f79b7b3be5990c"><td class="memItemLeft" ><a class="anchor" id="a55dfaf1427c6b0df79f79b7b3be5990c"></a>
&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#a55dfaf1427c6b0df79f79b7b3be5990c">babble_err</a>: 1</td></tr>
<tr class="memdesc:a55dfaf1427c6b0df79f79b7b3be5990c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to a 1 by the Host Controller during status update when a babble is detected during the transaction. <br/></td></tr>
<tr class="separator:a55dfaf1427c6b0df79f79b7b3be5990c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5db4563dd2d98e90747f9969a338033"><td class="memItemLeft" ><a class="anchor" id="ac5db4563dd2d98e90747f9969a338033"></a>
&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#ac5db4563dd2d98e90747f9969a338033">buffer_err</a>: 1</td></tr>
<tr class="memdesc:ac5db4563dd2d98e90747f9969a338033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to a 1 by the Host Controller during status update to indicate that the Host Controller is unable to keep up with the reception of incoming data (overrun) or is unable to supply data fast enough during transmission (underrun). <br/></td></tr>
<tr class="separator:ac5db4563dd2d98e90747f9969a338033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e55231d0adda8f7262ab94d443cc7af"><td class="memItemLeft" ><a class="anchor" id="a4e55231d0adda8f7262ab94d443cc7af"></a>
&#160;&#160;&#160;volatile uint32_t&#160;&#160;&#160;<a class="el" href="structehci__itd__t.html#a4e55231d0adda8f7262ab94d443cc7af">active</a>: 1</td></tr>
<tr class="memdesc:a4e55231d0adda8f7262ab94d443cc7af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to 1 by software to enable the execution of an isochronous transaction by the Host Controller. <br/></td></tr>
<tr class="separator:a4e55231d0adda8f7262ab94d443cc7af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24787c55fad3cbc01477c9323ba56131"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__itd__t.html#a24787c55fad3cbc01477c9323ba56131">xact</a> [8]</td></tr>
<tr class="memdesc:a24787c55fad3cbc01477c9323ba56131"><td class="mdescLeft">&#160;</td><td class="mdescRight">Word 1-8: iTD Transaction Status and Control List. <br/></td></tr>
<tr class="separator:a24787c55fad3cbc01477c9323ba56131"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2988381c89c877faa091c6ed4398de4a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2988381c89c877faa091c6ed4398de4a"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structehci__itd__t.html#a2988381c89c877faa091c6ed4398de4a">BufferPointer</a> [7]</td></tr>
<tr class="memdesc:a2988381c89c877faa091c6ed4398de4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Word 9-15 Buffer Page Pointer List (Plus) <br/></td></tr>
<tr class="separator:a2988381c89c877faa091c6ed4398de4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Highspeed Isochronous Transfer Descriptor (section 3.3) </p>
<p>Definition at line <a class="el" href="ehci_8h_source.html#l00210">210</a> of file <a class="el" href="ehci_8h_source.html">ehci.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aa22e7675f77b1f89a273f53b2707fc8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile uint32_t length</td>
</tr>
</table>
</div><div class="memdoc">
<p>For an IN, the initial value of the field is the number of bytes the host expects the endpoint to deliver. During the status update, the host controller writes back the number of bytes successfully received. The value in this register is the actual byte count. </p>
<p>For an OUT, this field is the number of data bytes the host controller will send during the transaction. The host controller is not required to update this field to reflect the actual number of bytes transferred during the transfer </p>
<p>Definition at line <a class="el" href="ehci_8h_source.html#l00220">220</a> of file <a class="el" href="ehci_8h_source.html">ehci.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>tinyusb/host/ehci/<a class="el" href="ehci_8h_source.html">ehci.h</a></li>
</ul>
</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="structehci__itd__t.html">ehci_itd_t</a></li>
<li class="footer">Generated on Mon Mar 31 2014 16:41:54 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>