a00152.html 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  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_cdc_proto_unit_desc 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('d7/d9a/a00152.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_cdc_proto_unit_desc Struct Reference<div class="ingroups"><a class="el" href="../../da/d82/a00091.html">USB CDC class</a> &raquo; <a class="el" href="../../dc/d54/a00094.html">USB CDC ISDN subclass</a></div></div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <p>Protocol Unit Functional Descriptor.
  88. <a href="../../d7/d9a/a00152.html#details">More...</a></p>
  89. <p><code>#include &lt;<a class="el" href="../../dc/dee/a00053_source.html">usb_cdci.h</a>&gt;</code></p>
  90. <table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  92. Data Fields</h2></td></tr>
  93. <tr class="memitem:acc187d1d6bae5f5454a12828067de780"><td class="memItemLeft" align="right" valign="top"><a id="acc187d1d6bae5f5454a12828067de780"></a>
  94. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d9a/a00152.html#acc187d1d6bae5f5454a12828067de780">bFunctionLength</a></td></tr>
  95. <tr class="memdesc:acc187d1d6bae5f5454a12828067de780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of this functional descriptor, in bytes. <br /></td></tr>
  96. <tr class="separator:acc187d1d6bae5f5454a12828067de780"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a042c772732b30b5046af597d3d0d15ee"><td class="memItemLeft" align="right" valign="top"><a id="a042c772732b30b5046af597d3d0d15ee"></a>
  98. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d9a/a00152.html#a042c772732b30b5046af597d3d0d15ee">bDescriptorType</a></td></tr>
  99. <tr class="memdesc:a042c772732b30b5046af597d3d0d15ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">CS_INTERFACE descriptor type. <br /></td></tr>
  100. <tr class="separator:a042c772732b30b5046af597d3d0d15ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ad73613512de1d1dc0faabdee3d91f4ce"><td class="memItemLeft" align="right" valign="top"><a id="ad73613512de1d1dc0faabdee3d91f4ce"></a>
  102. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d9a/a00152.html#ad73613512de1d1dc0faabdee3d91f4ce">bDescriptorSubType</a></td></tr>
  103. <tr class="memdesc:ad73613512de1d1dc0faabdee3d91f4ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network Channel Terminal Functional Descriptor. <br /></td></tr>
  104. <tr class="separator:ad73613512de1d1dc0faabdee3d91f4ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a4866a5606a084770c2a741cc357f324e"><td class="memItemLeft" align="right" valign="top"><a id="a4866a5606a084770c2a741cc357f324e"></a>
  106. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d9a/a00152.html#a4866a5606a084770c2a741cc357f324e">bEntityId</a></td></tr>
  107. <tr class="memdesc:a4866a5606a084770c2a741cc357f324e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant uniquely identifying the Unit. <br /></td></tr>
  108. <tr class="separator:a4866a5606a084770c2a741cc357f324e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:aab1af56dafaa99c5be8354dde4ebb390"><td class="memItemLeft" align="right" valign="top"><a id="aab1af56dafaa99c5be8354dde4ebb390"></a>
  110. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d9a/a00152.html#aab1af56dafaa99c5be8354dde4ebb390">bProtocol</a></td></tr>
  111. <tr class="memdesc:aab1af56dafaa99c5be8354dde4ebb390"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protocol code. <br /></td></tr>
  112. <tr class="separator:aab1af56dafaa99c5be8354dde4ebb390"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table>
  114. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  115. <div class="textblock"><p>Protocol Unit Functional Descriptor. </p>
  116. <p>A communication protocol stack is a combination of communication functions (protocols) into a layered structure. Each layer in the stack presents some abstract function for the layer above according to some layer-interface-standard, making it possible to replace a function with another as long as it conforms to the standard. Each layer may have a set of protocol parameters, defined in Appendix E, to configure it for proper operation in the actual environment and the parameters may be retrieved and/or modified. The Unit state is initially reset. See Section 6.2.23 “SetUnitParameter”, Section 6.2.24 “GetUnitParameter”, and 6.2.25 “ClearUnitParameter” for details. A Protocol Unit Functional Descriptor identifies with bEntityId a specific protocol instance of bProtocol in a stack. It can only occur within the class-specific portion of an Interface descriptor. </p>
  117. <p class="definition">Definition at line <a class="el" href="../../dc/dee/a00053_source.html#l00142">142</a> of file <a class="el" href="../../dc/dee/a00053_source.html">usb_cdci.h</a>.</p>
  118. </div><hr/>The documentation for this struct was generated from the following file:<ul>
  119. <li><a class="el" href="../../dc/dee/a00053_source.html">usb_cdci.h</a></li>
  120. </ul>
  121. </div><!-- contents -->
  122. </div><!-- doc-content -->
  123. <!-- start footer part -->
  124. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  125. <ul>
  126. <li class="navelem"><a class="el" href="../../d7/d9a/a00152.html">usb_cdc_proto_unit_desc</a></li>
  127. <li class="footer">Generated by
  128. <a href="http://www.doxygen.org/index.html">
  129. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  130. </ul>
  131. </div>
  132. </body>
  133. </html>