blob: faf2d062fe7ca9088247c96ced1a7a58d35bd1fe [file]
<!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: rndis_msg_packet_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="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 cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">tinyusb
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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>
</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('structrndis__msg__packet__t.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">rndis_msg_packet_t Struct Reference<div class="ingroups"><a class="el" href="group___c_d_c___r_n_d_i_s___common.html">Common Definitions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Packet Data Message.
<a href="structrndis__msg__packet__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="cdc__rndis_8h_source.html">cdc_rndis.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:ad44b615021ed3ccb734fcaf583ef4a03"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad44b615021ed3ccb734fcaf583ef4a03"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#ad44b615021ed3ccb734fcaf583ef4a03">type</a></td></tr>
<tr class="memdesc:ad44b615021ed3ccb734fcaf583ef4a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message Type, must be <a class="el" href="group___c_d_c___r_n_d_i_s___common.html#ggaa16227b27f1dd78363fe6d7b7a4d521aa1c214c3138308ceecd73caa80034ea90">RNDIS_MSG_PACKET</a>. <br/></td></tr>
<tr class="separator:ad44b615021ed3ccb734fcaf583ef4a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb70c2aab3407a9f05334c47131a43b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebb70c2aab3407a9f05334c47131a43b"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#aebb70c2aab3407a9f05334c47131a43b">length</a></td></tr>
<tr class="memdesc:aebb70c2aab3407a9f05334c47131a43b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message length in bytes, The total length of this RNDIS message including the header, payload, and padding. <br/></td></tr>
<tr class="separator:aebb70c2aab3407a9f05334c47131a43b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e322da8c7e3d2d6292089c0432f885d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e322da8c7e3d2d6292089c0432f885d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#a0e322da8c7e3d2d6292089c0432f885d">data_offset</a></td></tr>
<tr class="memdesc:a0e322da8c7e3d2d6292089c0432f885d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the offset, in bytes, from the start of this <em>data_offset</em> field of this message to the start of the data. This MUST be an integer multiple of 4. <br/></td></tr>
<tr class="separator:a0e322da8c7e3d2d6292089c0432f885d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0cc3d1d5957cce931bb8e02130c6550"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0cc3d1d5957cce931bb8e02130c6550"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#af0cc3d1d5957cce931bb8e02130c6550">data_length</a></td></tr>
<tr class="memdesc:af0cc3d1d5957cce931bb8e02130c6550"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the number of bytes in the payload of this message. <br/></td></tr>
<tr class="separator:af0cc3d1d5957cce931bb8e02130c6550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a726e6c9552cdd89b79b7a3ba7d3d4431"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a726e6c9552cdd89b79b7a3ba7d3d4431"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#a726e6c9552cdd89b79b7a3ba7d3d4431">out_of_band_data_offet</a></td></tr>
<tr class="memdesc:a726e6c9552cdd89b79b7a3ba7d3d4431"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the offset, in bytes, of the first out-of-band data record from the start of the DataOffset field in this message. MUST be an integer multiple of 4 when out-of-band data is present or set to 0 otherwise. When there are multiple out-ofband data records, each subsequent record MUST immediately follow the previous out-of-band data record. <br/></td></tr>
<tr class="separator:a726e6c9552cdd89b79b7a3ba7d3d4431"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1daf31277a434c731161798790981d60"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1daf31277a434c731161798790981d60"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#a1daf31277a434c731161798790981d60">out_of_band_data_length</a></td></tr>
<tr class="memdesc:a1daf31277a434c731161798790981d60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies, in bytes, the total length of the out-of-band data. <br/></td></tr>
<tr class="separator:a1daf31277a434c731161798790981d60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b2a60d6c7340b74c8bdd65ccd50514c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b2a60d6c7340b74c8bdd65ccd50514c"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#a8b2a60d6c7340b74c8bdd65ccd50514c">num_out_of_band_data_elements</a></td></tr>
<tr class="memdesc:a8b2a60d6c7340b74c8bdd65ccd50514c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the number of out-of-band records in this message. <br/></td></tr>
<tr class="separator:a8b2a60d6c7340b74c8bdd65ccd50514c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7402416d5cfbf3bb462206638ab2afb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7402416d5cfbf3bb462206638ab2afb"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#ac7402416d5cfbf3bb462206638ab2afb">per_packet_info_offset</a></td></tr>
<tr class="memdesc:ac7402416d5cfbf3bb462206638ab2afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the offset, in bytes, of the start of per-packet-info data record from the start of the <em>data_offset</em> field in this message. MUST be an integer multiple of 4 when per-packet-info data record is present or MUST be set to 0 otherwise. When there are multiple per-packet-info data records, each subsequent record MUST immediately follow the previous record. <br/></td></tr>
<tr class="separator:ac7402416d5cfbf3bb462206638ab2afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44104f7aac2ca731e4bdd2844ab43dd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44104f7aac2ca731e4bdd2844ab43dd3"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#a44104f7aac2ca731e4bdd2844ab43dd3">per_packet_info_length</a></td></tr>
<tr class="memdesc:a44104f7aac2ca731e4bdd2844ab43dd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies, in bytes, the total length of per-packetinformation contained in this message. <br/></td></tr>
<tr class="separator:a44104f7aac2ca731e4bdd2844ab43dd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd040db423e61876975bb5cd1f416a59"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd040db423e61876975bb5cd1f416a59"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>reserved</b> [2]</td></tr>
<tr class="separator:acd040db423e61876975bb5cd1f416a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87b9f0c0191e87351bb42314336d6b73"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87b9f0c0191e87351bb42314336d6b73"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrndis__msg__packet__t.html#a87b9f0c0191e87351bb42314336d6b73">payload</a> [0]</td></tr>
<tr class="memdesc:a87b9f0c0191e87351bb42314336d6b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network data contained in this message. <br/></td></tr>
<tr class="separator:a87b9f0c0191e87351bb42314336d6b73"><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>Packet Data Message. </p>
<p>This message MUST be used by the host and the device to send network data to one another. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>tinyusb/class/<a class="el" href="cdc__rndis_8h_source.html">cdc_rndis.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="structrndis__msg__packet__t.html">rndis_msg_packet_t</a></li>
<li class="footer">Generated on Wed Mar 26 2014 15:26:11 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>