a00092.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  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 ATM subclass</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('d1/dc1/a00092.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="#nested-classes">Data Structures</a> </div>
  83. <div class="headertitle">
  84. <div class="title">USB CDC ATM subclass<div class="ingroups"><a class="el" href="../../da/d82/a00091.html">USB CDC class</a></div></div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <p>USB CDC ATM subclass definitions.
  88. <a href="#details">More...</a></p>
  89. <table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  91. Data Structures</h2></td></tr>
  92. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d5e/a00136.html">usb_cdc_atm_desc</a></td></tr>
  93. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">ATM Networking Functional Descriptor. <a href="../../d0/d5e/a00136.html#details">More...</a><br /></td></tr>
  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  97. Communications Class Subclass Codes</h2></td></tr>
  98. <tr class="memitem:ga34be4f23cd40469b1e13e2b8a1b3cec4"><td class="memItemLeft" align="right" valign="top"><a id="ga34be4f23cd40469b1e13e2b8a1b3cec4"></a>
  99. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga34be4f23cd40469b1e13e2b8a1b3cec4">USB_CDC_SUBCLASS_ATM</a>&#160;&#160;&#160;0x07</td></tr>
  100. <tr class="memdesc:ga34be4f23cd40469b1e13e2b8a1b3cec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">ATM Networking Control Model. <br /></td></tr>
  101. <tr class="separator:ga34be4f23cd40469b1e13e2b8a1b3cec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  104. CDC ATM subclass specific Functional Descriptors codes</h2></td></tr>
  105. <tr class="memitem:ga2c6773ee281345251e2f1e68e7c3847d"><td class="memItemLeft" align="right" valign="top"><a id="ga2c6773ee281345251e2f1e68e7c3847d"></a>
  106. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga2c6773ee281345251e2f1e68e7c3847d">USB_DTYPE_CDC_ATM</a>&#160;&#160;&#160;0x10</td></tr>
  107. <tr class="memdesc:ga2c6773ee281345251e2f1e68e7c3847d"><td class="mdescLeft">&#160;</td><td class="mdescRight">ATM Networking Functional Descriptor. <br /></td></tr>
  108. <tr class="separator:ga2c6773ee281345251e2f1e68e7c3847d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  111. CDC ATM subclass specific requests</h2></td></tr>
  112. <tr class="memitem:ga47d6fe077ce700d4b4d5ae834c797013"><td class="memItemLeft" align="right" valign="top"><a id="ga47d6fe077ce700d4b4d5ae834c797013"></a>
  113. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga47d6fe077ce700d4b4d5ae834c797013">USB_CDC_SET_ATM_DATA_FORMAT</a>&#160;&#160;&#160;0x50</td></tr>
  114. <tr class="memdesc:ga47d6fe077ce700d4b4d5ae834c797013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chooses which ATM data format will be exchanged between the host and the ATM Networking device. <br /></td></tr>
  115. <tr class="separator:ga47d6fe077ce700d4b4d5ae834c797013"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ga61c7944bbfba81d3bdc7b6fc0ae8aba4"><td class="memItemLeft" align="right" valign="top"><a id="ga61c7944bbfba81d3bdc7b6fc0ae8aba4"></a>
  117. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga61c7944bbfba81d3bdc7b6fc0ae8aba4">USB_CDC_GET_ATM_DEVICE_STATISTICS</a>&#160;&#160;&#160;0x51</td></tr>
  118. <tr class="memdesc:ga61c7944bbfba81d3bdc7b6fc0ae8aba4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves global statistics from the ATM Networking device. <br /></td></tr>
  119. <tr class="separator:ga61c7944bbfba81d3bdc7b6fc0ae8aba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ga717280207722e17bd9d692ccd4396eb8"><td class="memItemLeft" align="right" valign="top"><a id="ga717280207722e17bd9d692ccd4396eb8"></a>
  121. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga717280207722e17bd9d692ccd4396eb8">USB_CDC_SET_ATM_DEFAULT_VC</a>&#160;&#160;&#160;0x52</td></tr>
  122. <tr class="memdesc:ga717280207722e17bd9d692ccd4396eb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pre-selects the VPI/VCI value for subsequent GET_ATM_DEVICE_STATISTICS requests. <br /></td></tr>
  123. <tr class="separator:ga717280207722e17bd9d692ccd4396eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ga16b7a3b1d055325159868a6ddd06af42"><td class="memItemLeft" align="right" valign="top"><a id="ga16b7a3b1d055325159868a6ddd06af42"></a>
  125. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga16b7a3b1d055325159868a6ddd06af42">USB_CDC_GET_ATM_VC_STATISTICS</a>&#160;&#160;&#160;0x53</td></tr>
  126. <tr class="memdesc:ga16b7a3b1d055325159868a6ddd06af42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves statistics from the ATM Networking device for a particular VPI/VCI. <br /></td></tr>
  127. <tr class="separator:ga16b7a3b1d055325159868a6ddd06af42"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  130. ATM Device Statistics Feature Selector Codes</h2></td></tr>
  131. <tr class="memitem:ga72109022ca486eed278cbc8cb11a211a"><td class="memItemLeft" align="right" valign="top"><a id="ga72109022ca486eed278cbc8cb11a211a"></a>
  132. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga72109022ca486eed278cbc8cb11a211a">ATM_STAT_US_CELLS_SENT</a>&#160;&#160;&#160;0x01</td></tr>
  133. <tr class="memdesc:ga72109022ca486eed278cbc8cb11a211a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cells that have been sent upstream to the WAN link by the ATM layer. <br /></td></tr>
  134. <tr class="separator:ga72109022ca486eed278cbc8cb11a211a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ga01185a8a0b6964d5ace386515f474cae"><td class="memItemLeft" align="right" valign="top"><a id="ga01185a8a0b6964d5ace386515f474cae"></a>
  136. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga01185a8a0b6964d5ace386515f474cae">ATM_STAT_DS_CELLS_RECEIVED</a>&#160;&#160;&#160;0x02</td></tr>
  137. <tr class="memdesc:ga01185a8a0b6964d5ace386515f474cae"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cells that have been received downstream from the WAN link by the ATM layer. <br /></td></tr>
  138. <tr class="separator:ga01185a8a0b6964d5ace386515f474cae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ga030e8f72a14075a02f8efe2a633caed8"><td class="memItemLeft" align="right" valign="top"><a id="ga030e8f72a14075a02f8efe2a633caed8"></a>
  140. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga030e8f72a14075a02f8efe2a633caed8">ATM_STAT_DS_CELLS_USB_CONGESTION</a>&#160;&#160;&#160;0x03</td></tr>
  141. <tr class="memdesc:ga030e8f72a14075a02f8efe2a633caed8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cells that have been received downstream from the WAN link by the ATM layer and discarded due to congestion on the USB link. <br /></td></tr>
  142. <tr class="separator:ga030e8f72a14075a02f8efe2a633caed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ga3dc76790db55d6c16851090707a7476f"><td class="memItemLeft" align="right" valign="top"><a id="ga3dc76790db55d6c16851090707a7476f"></a>
  144. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga3dc76790db55d6c16851090707a7476f">ATM_STAT_DS_CELLS_AAL5_CRC_ERROR</a>&#160;&#160;&#160;0x04</td></tr>
  145. <tr class="memdesc:ga3dc76790db55d6c16851090707a7476f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cells that have been received downstream from the WAN link by the ATM layer and discarded due to AAL5 CRC errors. <br /></td></tr>
  146. <tr class="separator:ga3dc76790db55d6c16851090707a7476f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ga1f7df7795ac7fe47db348bb91dae3e46"><td class="memItemLeft" align="right" valign="top"><a id="ga1f7df7795ac7fe47db348bb91dae3e46"></a>
  148. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#ga1f7df7795ac7fe47db348bb91dae3e46">ATM_STAT_DS_CELLS_HEC_ERROR</a>&#160;&#160;&#160;0x05</td></tr>
  149. <tr class="memdesc:ga1f7df7795ac7fe47db348bb91dae3e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cells that have been received downstream from the WAN link and discarded due to HEC errors in the cell header. <br /></td></tr>
  150. <tr class="separator:ga1f7df7795ac7fe47db348bb91dae3e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:gad57b29f60f953d86e644a579e6803341"><td class="memItemLeft" align="right" valign="top"><a id="gad57b29f60f953d86e644a579e6803341"></a>
  152. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc1/a00092.html#gad57b29f60f953d86e644a579e6803341">ATM_STAT_DS_CELLS_HEC_ERROR_CORRT</a>&#160;&#160;&#160;0x06</td></tr>
  153. <tr class="memdesc:gad57b29f60f953d86e644a579e6803341"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cells that have been received downstream from the WAN link and have been detected with HEC errors in the cell header and successfully corrected. <br /></td></tr>
  154. <tr class="separator:gad57b29f60f953d86e644a579e6803341"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table>
  156. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  157. <p>USB CDC ATM subclass definitions. </p>
  158. <p>This module based on "Universal Serial Bus Communications Class Subclass Specification
  159. for Asynchronous Transfer Mode Devices" Revision 1.2 </p>
  160. </div><!-- contents -->
  161. </div><!-- doc-content -->
  162. <!-- start footer part -->
  163. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  164. <ul>
  165. <li class="footer">Generated by
  166. <a href="http://www.doxygen.org/index.html">
  167. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  168. </ul>
  169. </div>
  170. </body>
  171. </html>