1
0

a00292.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Lightweight USB stack: usb_tmc_bulk_header Struct Reference</title>
  9. <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="../../jquery.js"></script>
  11. <script type="text/javascript" src="../../dynsections.js"></script>
  12. <link href="../../navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="../../resize.js"></script>
  14. <script type="text/javascript" src="../../navtreedata.js"></script>
  15. <script type="text/javascript" src="../../navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="../../search/searchdata.js"></script>
  21. <script type="text/javascript" src="../../search/search.js"></script>
  22. <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectalign" style="padding-left: 0.5em;">
  31. <div id="projectname">Lightweight USB stack
  32. &#160;<span id="projectnumber">1.0</span>
  33. </div>
  34. </td>
  35. </tr>
  36. </tbody>
  37. </table>
  38. </div>
  39. <!-- end header part -->
  40. <!-- Generated by Doxygen 1.8.13 -->
  41. <script type="text/javascript">
  42. var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
  43. </script>
  44. <script type="text/javascript" src="../../menudata.js"></script>
  45. <script type="text/javascript" src="../../menu.js"></script>
  46. <script type="text/javascript">
  47. $(function() {
  48. initMenu('../../',true,false,'search.php','Search');
  49. $(document).ready(function() { init_search(); });
  50. });
  51. </script>
  52. <div id="main-nav"></div>
  53. </div><!-- top -->
  54. <div id="side-nav" class="ui-resizable side-nav-resizable">
  55. <div id="nav-tree">
  56. <div id="nav-tree-contents">
  57. <div id="nav-sync" class="sync"></div>
  58. </div>
  59. </div>
  60. <div id="splitbar" style="-moz-user-select:none;"
  61. class="ui-resizable-handle">
  62. </div>
  63. </div>
  64. <script type="text/javascript">
  65. $(document).ready(function(){initNavTree('d8/d0a/a00292.html','../../');});
  66. </script>
  67. <div id="doc-content">
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div class="header">
  81. <div class="summary">
  82. <a href="#pub-attribs">Data Fields</a> </div>
  83. <div class="headertitle">
  84. <div class="title">usb_tmc_bulk_header Struct Reference<div class="ingroups"><a class="el" href="../../d4/d3a/a00101.html">USB TMC class</a></div></div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <p><code>#include &lt;<a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>&gt;</code></p>
  88. <table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  90. Data Fields</h2></td></tr>
  91. <tr class="memitem:aa145afb979d299ec97bf98850f500746"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d0a/a00292.html#aa145afb979d299ec97bf98850f500746">MsgId</a></td></tr>
  92. <tr class="separator:aa145afb979d299ec97bf98850f500746"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a6a867a46ec6d60b3640286c320c50420"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d0a/a00292.html#a6a867a46ec6d60b3640286c320c50420">bTag</a></td></tr>
  94. <tr class="separator:a6a867a46ec6d60b3640286c320c50420"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:aa907cb14813049fbd788e88c3a22b6d9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d0a/a00292.html#aa907cb14813049fbd788e88c3a22b6d9">bTagInverse</a></td></tr>
  96. <tr class="separator:aa907cb14813049fbd788e88c3a22b6d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ab791343b0c7dccf680272a23c0e43442"><td class="memItemLeft" align="right" valign="top"><a id="ab791343b0c7dccf680272a23c0e43442"></a>
  98. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>Reserved</b></td></tr>
  99. <tr class="separator:ab791343b0c7dccf680272a23c0e43442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a4c0fb1582e86b78e9c767571e0ba1d33"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="../../d3/dcc/a00264.html">usb_tmc_bulk_header_specific</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d0a/a00292.html#a4c0fb1582e86b78e9c767571e0ba1d33">MsgSpecific</a></td></tr>
  101. <tr class="separator:a4c0fb1582e86b78e9c767571e0ba1d33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  104. <div class="textblock"><p>Host must begin the first USB transaction in each Bulk transfer of command message content with a Bulk Header. </p>
  105. <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00132">132</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
  106. </div><h2 class="groupheader">Field Documentation</h2>
  107. <a id="aa145afb979d299ec97bf98850f500746"></a>
  108. <h2 class="memtitle"><span class="permalink"><a href="#aa145afb979d299ec97bf98850f500746">&#9670;&nbsp;</a></span>MsgId</h2>
  109. <div class="memitem">
  110. <div class="memproto">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">uint8_t usb_tmc_bulk_header::MsgId</td>
  114. </tr>
  115. </table>
  116. </div><div class="memdoc">
  117. <p>Specifies the USBTMC message and the type of the USBTMC message. </p>
  118. <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00134">134</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
  119. </div>
  120. </div>
  121. <a id="a6a867a46ec6d60b3640286c320c50420"></a>
  122. <h2 class="memtitle"><span class="permalink"><a href="#a6a867a46ec6d60b3640286c320c50420">&#9670;&nbsp;</a></span>bTag</h2>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">uint8_t usb_tmc_bulk_header::bTag</td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>A transfer identifier. The Host must set bTag different than the bTag used in the previous Bulk-OUT Header. The Host should increment the bTag by 1 each time it sends a new Bulk-OUT Header. </p>
  132. <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00138">138</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
  133. </div>
  134. </div>
  135. <a id="aa907cb14813049fbd788e88c3a22b6d9"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#aa907cb14813049fbd788e88c3a22b6d9">&#9670;&nbsp;</a></span>bTagInverse</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">uint8_t usb_tmc_bulk_header::bTagInverse</td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>The inverse (one's complement) of the bTag </p>
  146. <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00140">140</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
  147. </div>
  148. </div>
  149. <a id="a4c0fb1582e86b78e9c767571e0ba1d33"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#a4c0fb1582e86b78e9c767571e0ba1d33">&#9670;&nbsp;</a></span>MsgSpecific</h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">union <a class="el" href="../../d3/dcc/a00264.html">usb_tmc_bulk_header_specific</a> usb_tmc_bulk_header::MsgSpecific</td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>USBTMC command message specific </p>
  160. <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00143">143</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
  161. </div>
  162. </div>
  163. <hr/>The documentation for this struct was generated from the following file:<ul>
  164. <li><a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a></li>
  165. </ul>
  166. </div><!-- contents -->
  167. </div><!-- doc-content -->
  168. <!-- start footer part -->
  169. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  170. <ul>
  171. <li class="navelem"><a class="el" href="../../d8/d0a/a00292.html">usb_tmc_bulk_header</a></li>
  172. <li class="footer">Generated by
  173. <a href="http://www.doxygen.org/index.html">
  174. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  175. </ul>
  176. </div>
  177. </body>
  178. </html>