blob: 4794fc675aa4ef39903d2e9f9b3100a3c39b4225 [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: msc_cmd_block_wrapper_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('structmsc__cmd__block__wrapper__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">msc_cmd_block_wrapper_t Struct Reference<div class="ingroups"><a class="el" href="group___class_driver___m_s_c___common.html">Common Definitions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Command Block Wrapper.
<a href="structmsc__cmd__block__wrapper__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="msc_8h_source.html">msc.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:acd2a6284879dded65f0b8daa7c68485a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd2a6284879dded65f0b8daa7c68485a"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#acd2a6284879dded65f0b8daa7c68485a">signature</a></td></tr>
<tr class="memdesc:acd2a6284879dded65f0b8daa7c68485a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signature that helps identify this data packet as a CBW. The signature field shall contain the value 43425355h (little endian), indicating a CBW. <br/></td></tr>
<tr class="separator:acd2a6284879dded65f0b8daa7c68485a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c50fcd1195659821729f52af8f3bb7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c50fcd1195659821729f52af8f3bb7d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#a1c50fcd1195659821729f52af8f3bb7d">tag</a></td></tr>
<tr class="memdesc:a1c50fcd1195659821729f52af8f3bb7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag sent by the host. The device shall echo the contents of this field back to the host in the dCSWTagfield of the associated CSW. The dCSWTagpositively associates a CSW with the corresponding CBW. <br/></td></tr>
<tr class="separator:a1c50fcd1195659821729f52af8f3bb7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49ead040118be61a7b9b7649b57cb33e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49ead040118be61a7b9b7649b57cb33e"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#a49ead040118be61a7b9b7649b57cb33e">xfer_bytes</a></td></tr>
<tr class="memdesc:a49ead040118be61a7b9b7649b57cb33e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of bytes of data that the host expects to transfer on the Bulk-In or Bulk-Out endpoint (as indicated by the Directionbit) during the execution of this command. If this field is zero, the device and the host shall transfer no data between the CBW and the associated CSW, and the device shall ignore the value of the Directionbit in bmCBWFlags. <br/></td></tr>
<tr class="separator:a49ead040118be61a7b9b7649b57cb33e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92abda0bec7c1c978fe96f87aad18067"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92abda0bec7c1c978fe96f87aad18067"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#a92abda0bec7c1c978fe96f87aad18067">dir</a></td></tr>
<tr class="memdesc:a92abda0bec7c1c978fe96f87aad18067"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit 7 of this field define transfer direction <br/>
- 0 : Data-Out from host to the device. <br/>
- 1 : Data-In from the device to the host. <br/></td></tr>
<tr class="separator:a92abda0bec7c1c978fe96f87aad18067"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff43fb296e4d0ec270a77f020614f60e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff43fb296e4d0ec270a77f020614f60e"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#aff43fb296e4d0ec270a77f020614f60e">lun</a></td></tr>
<tr class="memdesc:aff43fb296e4d0ec270a77f020614f60e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The device Logical Unit Number (LUN) to which the command block is being sent. For devices that support multiple LUNs, the host shall place into this field the LUN to which this command block is addressed. Otherwise, the host shall set this field to zero. <br/></td></tr>
<tr class="separator:aff43fb296e4d0ec270a77f020614f60e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3de7cd2034819b86e635af280210f9e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3de7cd2034819b86e635af280210f9e9"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#a3de7cd2034819b86e635af280210f9e9">cmd_len</a></td></tr>
<tr class="memdesc:a3de7cd2034819b86e635af280210f9e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The valid length of the CBWCBin bytes. This defines the valid length of the command block. The only legal values are 1 through 16. <br/></td></tr>
<tr class="separator:a3de7cd2034819b86e635af280210f9e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8ff3aac51be48b0c65f172b01ef1acd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8ff3aac51be48b0c65f172b01ef1acd"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsc__cmd__block__wrapper__t.html#ac8ff3aac51be48b0c65f172b01ef1acd">command</a> [16]</td></tr>
<tr class="memdesc:ac8ff3aac51be48b0c65f172b01ef1acd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The command block to be executed by the device. The device shall interpret the first cmd_len bytes in this field as a command block. <br/></td></tr>
<tr class="separator:ac8ff3aac51be48b0c65f172b01ef1acd"><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>Command Block Wrapper. </p>
<p>Definition at line <a class="el" href="msc_8h_source.html#l00097">97</a> of file <a class="el" href="msc_8h_source.html">msc.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>tinyusb/class/<a class="el" href="msc_8h_source.html">msc.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="structmsc__cmd__block__wrapper__t.html">msc_cmd_block_wrapper_t</a></li>
<li class="footer">Generated on Mon Mar 31 2014 15:49:06 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>