a00236.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  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_config_descriptor 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/d40/a00236.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_config_descriptor Struct Reference<div class="ingroups"><a class="el" href="../../da/d74/a00099.html">USB Standard</a></div></div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <p>USB device configuration descriptor.
  88. <a href="../../d7/d40/a00236.html#details">More...</a></p>
  89. <p><code>#include &lt;<a class="el" href="../../da/d24/a00068_source.html">usb_std.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:aaa38eade89cca96312968258eaeade9d"><td class="memItemLeft" align="right" valign="top"><a id="aaa38eade89cca96312968258eaeade9d"></a>
  94. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#aaa38eade89cca96312968258eaeade9d">bLength</a></td></tr>
  95. <tr class="memdesc:aaa38eade89cca96312968258eaeade9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the descriptor, in bytes. <br /></td></tr>
  96. <tr class="separator:aaa38eade89cca96312968258eaeade9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a69b0a0fe8f2f9152f299a333f352982e"><td class="memItemLeft" align="right" valign="top"><a id="a69b0a0fe8f2f9152f299a333f352982e"></a>
  98. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#a69b0a0fe8f2f9152f299a333f352982e">bDescriptorType</a></td></tr>
  99. <tr class="memdesc:a69b0a0fe8f2f9152f299a333f352982e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration descriptor. <br /></td></tr>
  100. <tr class="separator:a69b0a0fe8f2f9152f299a333f352982e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a09fb7940f26366f7f0aedb496a18b97c"><td class="memItemLeft" align="right" valign="top"><a id="a09fb7940f26366f7f0aedb496a18b97c"></a>
  102. uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#a09fb7940f26366f7f0aedb496a18b97c">wTotalLength</a></td></tr>
  103. <tr class="memdesc:a09fb7940f26366f7f0aedb496a18b97c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the configuration descriptor header, and all sub descriptors inside the configuration. <br /></td></tr>
  104. <tr class="separator:a09fb7940f26366f7f0aedb496a18b97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a712744e37c3759b311131278ec2cf074"><td class="memItemLeft" align="right" valign="top"><a id="a712744e37c3759b311131278ec2cf074"></a>
  106. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#a712744e37c3759b311131278ec2cf074">bNumInterfaces</a></td></tr>
  107. <tr class="memdesc:a712744e37c3759b311131278ec2cf074"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of interfaces in the configuration. <br /></td></tr>
  108. <tr class="separator:a712744e37c3759b311131278ec2cf074"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:af50d14a1e97dab1a4483f03b969ca431"><td class="memItemLeft" align="right" valign="top"><a id="af50d14a1e97dab1a4483f03b969ca431"></a>
  110. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#af50d14a1e97dab1a4483f03b969ca431">bConfigurationValue</a></td></tr>
  111. <tr class="memdesc:af50d14a1e97dab1a4483f03b969ca431"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration index of the current configuration. <br /></td></tr>
  112. <tr class="separator:af50d14a1e97dab1a4483f03b969ca431"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ace6c0975162873b87744269bd188d297"><td class="memItemLeft" align="right" valign="top"><a id="ace6c0975162873b87744269bd188d297"></a>
  114. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#ace6c0975162873b87744269bd188d297">iConfiguration</a></td></tr>
  115. <tr class="memdesc:ace6c0975162873b87744269bd188d297"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of a string descriptor describing the configuration. <br /></td></tr>
  116. <tr class="separator:ace6c0975162873b87744269bd188d297"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:aa46182c4bc520e2c60a83c84d80d1e23"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#aa46182c4bc520e2c60a83c84d80d1e23">bmAttributes</a></td></tr>
  118. <tr class="memdesc:aa46182c4bc520e2c60a83c84d80d1e23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration attributes. <a href="#aa46182c4bc520e2c60a83c84d80d1e23">More...</a><br /></td></tr>
  119. <tr class="separator:aa46182c4bc520e2c60a83c84d80d1e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a228c71b864eef8c5b997ad49b996ae9b"><td class="memItemLeft" align="right" valign="top"><a id="a228c71b864eef8c5b997ad49b996ae9b"></a>
  121. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/a00236.html#a228c71b864eef8c5b997ad49b996ae9b">bMaxPower</a></td></tr>
  122. <tr class="memdesc:a228c71b864eef8c5b997ad49b996ae9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum power consumption of the device. <a class="el" href="../../da/d74/a00099.html#ga7b68661c679b3b44dfed37455fff2dde">USB_CFG_POWER_MA()</a> macro. <br /></td></tr>
  123. <tr class="separator:a228c71b864eef8c5b997ad49b996ae9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table>
  125. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  126. <div class="textblock"><p>USB device configuration descriptor. </p>
  127. <p>The configuration descriptor describes information about a specific device configuration. The descriptor contains a bConfigurationValue field with a value that, when used as a parameter to the SetConfiguration() request, causes the device to assume the described configuration. </p>
  128. <p class="definition">Definition at line <a class="el" href="../../da/d24/a00068_source.html#l00376">376</a> of file <a class="el" href="../../da/d24/a00068_source.html">usb_std.h</a>.</p>
  129. </div><h2 class="groupheader">Field Documentation</h2>
  130. <a id="aa46182c4bc520e2c60a83c84d80d1e23"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#aa46182c4bc520e2c60a83c84d80d1e23">&#9670;&nbsp;</a></span>bmAttributes</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">uint8_t usb_config_descriptor::bmAttributes</td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Configuration attributes. </p>
  141. <p>Comprised of a mask of <code>USB_CONFIG_ATTR_</code> masks. On all devices, this should include USB_CONFIG_ATTR_RESERVED at a minimum. </p>
  142. <p class="definition">Definition at line <a class="el" href="../../da/d24/a00068_source.html#l00384">384</a> of file <a class="el" href="../../da/d24/a00068_source.html">usb_std.h</a>.</p>
  143. </div>
  144. </div>
  145. <hr/>The documentation for this struct was generated from the following file:<ul>
  146. <li><a class="el" href="../../da/d24/a00068_source.html">usb_std.h</a></li>
  147. </ul>
  148. </div><!-- contents -->
  149. </div><!-- doc-content -->
  150. <!-- start footer part -->
  151. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  152. <ul>
  153. <li class="navelem"><a class="el" href="../../d7/d40/a00236.html">usb_config_descriptor</a></li>
  154. <li class="footer">Generated by
  155. <a href="http://www.doxygen.org/index.html">
  156. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  157. </ul>
  158. </div>
  159. </body>
  160. </html>