1
0

a00097.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  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 DFU class</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/d84/a00097.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 DFU class</div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <p>This module contains USB Device Firmware Upgrade class 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="../../d1/d72/a00204.html">usb_dfu_func_desc</a></td></tr>
  93. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB DFU functional descriptor. <a href="../../d1/d72/a00204.html#details">More...</a><br /></td></tr>
  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d31/a00208.html">usb_dfu_status</a></td></tr>
  96. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload packet to response in DFU_GETSTATUS request. <a href="../../dc/d31/a00208.html#details">More...</a><br /></td></tr>
  97. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  100. USB DFU class subclass and protocol definitions</h2></td></tr>
  101. <tr class="memitem:ga2cc8ab485b0707e0a207199b41b2b26f"><td class="memItemLeft" align="right" valign="top"><a id="ga2cc8ab485b0707e0a207199b41b2b26f"></a>
  102. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga2cc8ab485b0707e0a207199b41b2b26f">USB_CLASS_DFU</a>&#160;&#160;&#160;0xFE</td></tr>
  103. <tr class="memdesc:ga2cc8ab485b0707e0a207199b41b2b26f"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB DFU class. <br /></td></tr>
  104. <tr class="separator:ga2cc8ab485b0707e0a207199b41b2b26f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ga6f5150400e9777bce9fde0e2265780b7"><td class="memItemLeft" align="right" valign="top"><a id="ga6f5150400e9777bce9fde0e2265780b7"></a>
  106. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga6f5150400e9777bce9fde0e2265780b7">USB_DFU_SUBCLASS_DFU</a>&#160;&#160;&#160;0x01</td></tr>
  107. <tr class="memdesc:ga6f5150400e9777bce9fde0e2265780b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB DFU subclass code. <br /></td></tr>
  108. <tr class="separator:ga6f5150400e9777bce9fde0e2265780b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ga16484515b518007fc7bff87f4a722359"><td class="memItemLeft" align="right" valign="top"><a id="ga16484515b518007fc7bff87f4a722359"></a>
  110. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga16484515b518007fc7bff87f4a722359">USB_DFU_PROTO_RUNTIME</a>&#160;&#160;&#160;0x01</td></tr>
  111. <tr class="memdesc:ga16484515b518007fc7bff87f4a722359"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB DFU runtime-mode protocol. <br /></td></tr>
  112. <tr class="separator:ga16484515b518007fc7bff87f4a722359"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ga0d4aebf6881d083cfb358e142861cb08"><td class="memItemLeft" align="right" valign="top"><a id="ga0d4aebf6881d083cfb358e142861cb08"></a>
  114. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga0d4aebf6881d083cfb358e142861cb08">USB_DFU_PROTO_DFU</a>&#160;&#160;&#160;0x02</td></tr>
  115. <tr class="memdesc:ga0d4aebf6881d083cfb358e142861cb08"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB DFU DFU-mode protocol. <br /></td></tr>
  116. <tr class="separator:ga0d4aebf6881d083cfb358e142861cb08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table><table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  119. USB DFU descriptor types</h2></td></tr>
  120. <tr class="memitem:ga00c1235b376fe41401faac08a2afc1e5"><td class="memItemLeft" align="right" valign="top"><a id="ga00c1235b376fe41401faac08a2afc1e5"></a>
  121. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga00c1235b376fe41401faac08a2afc1e5">USB_DTYPE_DFU_FUNCTIONAL</a>&#160;&#160;&#160;0x21</td></tr>
  122. <tr class="memdesc:ga00c1235b376fe41401faac08a2afc1e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB DFU functional descriptor type. <br /></td></tr>
  123. <tr class="separator:ga00c1235b376fe41401faac08a2afc1e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table><table class="memberdecls">
  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  126. USB DFU class-specific requests</h2></td></tr>
  127. <tr class="memitem:gab76be710887a0f98892183e2373afaa2"><td class="memItemLeft" align="right" valign="top"><a id="gab76be710887a0f98892183e2373afaa2"></a>
  128. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gab76be710887a0f98892183e2373afaa2">USB_DFU_DETACH</a>&#160;&#160;&#160;0x00</td></tr>
  129. <tr class="memdesc:gab76be710887a0f98892183e2373afaa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiates a detach-attach sequence on the bus when it sees this request. <br /></td></tr>
  130. <tr class="separator:gab76be710887a0f98892183e2373afaa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga88abf5a9495158487fe4940e4aac1c92"><td class="memItemLeft" align="right" valign="top"><a id="ga88abf5a9495158487fe4940e4aac1c92"></a>
  132. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga88abf5a9495158487fe4940e4aac1c92">USB_DFU_DNLOAD</a>&#160;&#160;&#160;0x01</td></tr>
  133. <tr class="memdesc:ga88abf5a9495158487fe4940e4aac1c92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiates firmware image downloading. <br /></td></tr>
  134. <tr class="separator:ga88abf5a9495158487fe4940e4aac1c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ga600b617f24ae4d4d16856e305b41a5f1"><td class="memItemLeft" align="right" valign="top"><a id="ga600b617f24ae4d4d16856e305b41a5f1"></a>
  136. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga600b617f24ae4d4d16856e305b41a5f1">USB_DFU_UPLOAD</a>&#160;&#160;&#160;0x02</td></tr>
  137. <tr class="memdesc:ga600b617f24ae4d4d16856e305b41a5f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This request is employed by the host to solicit firmware from the device. <br /></td></tr>
  138. <tr class="separator:ga600b617f24ae4d4d16856e305b41a5f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ga1c8d801bcbef1f29e958b5a6325af5bd"><td class="memItemLeft" align="right" valign="top"><a id="ga1c8d801bcbef1f29e958b5a6325af5bd"></a>
  140. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga1c8d801bcbef1f29e958b5a6325af5bd">USB_DFU_GETSTATUS</a>&#160;&#160;&#160;0x03</td></tr>
  141. <tr class="memdesc:ga1c8d801bcbef1f29e958b5a6325af5bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The host employs this request to facilitate synchronization with the device. <br /></td></tr>
  142. <tr class="separator:ga1c8d801bcbef1f29e958b5a6325af5bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gaa2fba64c89b642ec5ac907065529ab8f"><td class="memItemLeft" align="right" valign="top"><a id="gaa2fba64c89b642ec5ac907065529ab8f"></a>
  144. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaa2fba64c89b642ec5ac907065529ab8f">USB_DFU_CLRSTATUS</a>&#160;&#160;&#160;0x04</td></tr>
  145. <tr class="memdesc:gaa2fba64c89b642ec5ac907065529ab8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This request resets DFU machine state to DFU_IDLE. <br /></td></tr>
  146. <tr class="separator:gaa2fba64c89b642ec5ac907065529ab8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ga720c83a484f58f19616b511466486a9b"><td class="memItemLeft" align="right" valign="top"><a id="ga720c83a484f58f19616b511466486a9b"></a>
  148. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga720c83a484f58f19616b511466486a9b">USB_DFU_GETSTATE</a>&#160;&#160;&#160;0x05</td></tr>
  149. <tr class="memdesc:ga720c83a484f58f19616b511466486a9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This request solicits a report about the state of the device. <br /></td></tr>
  150. <tr class="separator:ga720c83a484f58f19616b511466486a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:gaba44f9ef6de75e3df0e5715a5eddda6f"><td class="memItemLeft" align="right" valign="top"><a id="gaba44f9ef6de75e3df0e5715a5eddda6f"></a>
  152. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaba44f9ef6de75e3df0e5715a5eddda6f">USB_DFU_ABORT</a>&#160;&#160;&#160;0x06</td></tr>
  153. <tr class="memdesc:gaba44f9ef6de75e3df0e5715a5eddda6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This request enables the host to exit from certain states and return to the DFU_IDLE state. <br /></td></tr>
  154. <tr class="separator:gaba44f9ef6de75e3df0e5715a5eddda6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table><table class="memberdecls">
  156. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  157. USB DFU capabilities</h2></td></tr>
  158. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpcc3892006c4cc278a0ad360b48bda77f"></a><a class="anchor" id="USB_DFU_CAPAB"></a></p>
  159. </td></tr>
  160. <tr class="memitem:ga005e5b7fc18c066ee61ae393a2ba09c7"><td class="memItemLeft" align="right" valign="top"><a id="ga005e5b7fc18c066ee61ae393a2ba09c7"></a>
  161. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga005e5b7fc18c066ee61ae393a2ba09c7">USB_DFU_ATTR_WILL_DETACH</a>&#160;&#160;&#160;0x08</td></tr>
  162. <tr class="memdesc:ga005e5b7fc18c066ee61ae393a2ba09c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device will perform a bus detach-attach sequence when it receives a DFU_DETACH request. <br /></td></tr>
  163. <tr class="separator:ga005e5b7fc18c066ee61ae393a2ba09c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:ga757dc48567171071714a297ae685eb5f"><td class="memItemLeft" align="right" valign="top"><a id="ga757dc48567171071714a297ae685eb5f"></a>
  165. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga757dc48567171071714a297ae685eb5f">USB_DFU_ATTR_MANIF_TOL</a>&#160;&#160;&#160;0x04</td></tr>
  166. <tr class="memdesc:ga757dc48567171071714a297ae685eb5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is able to communicate via USB after Manifestation phase. <br /></td></tr>
  167. <tr class="separator:ga757dc48567171071714a297ae685eb5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ga40264d92194b790a6b285c1aefa0cc3c"><td class="memItemLeft" align="right" valign="top"><a id="ga40264d92194b790a6b285c1aefa0cc3c"></a>
  169. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga40264d92194b790a6b285c1aefa0cc3c">USB_DFU_ATTR_CAN_UPLOAD</a>&#160;&#160;&#160;0x02</td></tr>
  170. <tr class="memdesc:ga40264d92194b790a6b285c1aefa0cc3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Upload capable. <br /></td></tr>
  171. <tr class="separator:ga40264d92194b790a6b285c1aefa0cc3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:ga22c5740401995633128679a460d4a2ef"><td class="memItemLeft" align="right" valign="top"><a id="ga22c5740401995633128679a460d4a2ef"></a>
  173. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga22c5740401995633128679a460d4a2ef">USB_DFU_ATTR_CAN_DNLOAD</a>&#160;&#160;&#160;0x01</td></tr>
  174. <tr class="memdesc:ga22c5740401995633128679a460d4a2ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Download capable. <br /></td></tr>
  175. <tr class="separator:ga22c5740401995633128679a460d4a2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. </table><table class="memberdecls">
  177. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  178. USB DFU status codes</h2></td></tr>
  179. <tr class="memitem:ga16ed86c3a720e4bf14b14c79e4ab6cdd"><td class="memItemLeft" align="right" valign="top"><a id="ga16ed86c3a720e4bf14b14c79e4ab6cdd"></a>
  180. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga16ed86c3a720e4bf14b14c79e4ab6cdd">USB_DFU_STATUS_OK</a>&#160;&#160;&#160;0x00</td></tr>
  181. <tr class="memdesc:ga16ed86c3a720e4bf14b14c79e4ab6cdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">No error condition is present. <br /></td></tr>
  182. <tr class="separator:ga16ed86c3a720e4bf14b14c79e4ab6cdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:gaca68ab323ffb52c795400920565aef28"><td class="memItemLeft" align="right" valign="top"><a id="gaca68ab323ffb52c795400920565aef28"></a>
  184. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaca68ab323ffb52c795400920565aef28">USB_DFU_STATUS_ERR_TARGET</a>&#160;&#160;&#160;0x01</td></tr>
  185. <tr class="memdesc:gaca68ab323ffb52c795400920565aef28"><td class="mdescLeft">&#160;</td><td class="mdescRight">File is not targeted for use by this device. <br /></td></tr>
  186. <tr class="separator:gaca68ab323ffb52c795400920565aef28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:gae86dc027ec6afa97ee8086147ded8380"><td class="memItemLeft" align="right" valign="top"><a id="gae86dc027ec6afa97ee8086147ded8380"></a>
  188. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gae86dc027ec6afa97ee8086147ded8380">USB_DFU_STATUS_ERR_FILE</a>&#160;&#160;&#160;0x02</td></tr>
  189. <tr class="memdesc:gae86dc027ec6afa97ee8086147ded8380"><td class="mdescLeft">&#160;</td><td class="mdescRight">File is for this device but fails some vendor specific verification test. <br /></td></tr>
  190. <tr class="separator:gae86dc027ec6afa97ee8086147ded8380"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:ga8c1d9d09df3abd90ac4b272b54418210"><td class="memItemLeft" align="right" valign="top"><a id="ga8c1d9d09df3abd90ac4b272b54418210"></a>
  192. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga8c1d9d09df3abd90ac4b272b54418210">USB_DFU_STATUS_ERR_WRITE</a>&#160;&#160;&#160;0x03</td></tr>
  193. <tr class="memdesc:ga8c1d9d09df3abd90ac4b272b54418210"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is unable to write memory. <br /></td></tr>
  194. <tr class="separator:ga8c1d9d09df3abd90ac4b272b54418210"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:ga1eed91fcbb44495c4856b19f32385068"><td class="memItemLeft" align="right" valign="top"><a id="ga1eed91fcbb44495c4856b19f32385068"></a>
  196. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga1eed91fcbb44495c4856b19f32385068">USB_DFU_STATUS_ERR_ERASE</a>&#160;&#160;&#160;0x04</td></tr>
  197. <tr class="memdesc:ga1eed91fcbb44495c4856b19f32385068"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory erase function failed. <br /></td></tr>
  198. <tr class="separator:ga1eed91fcbb44495c4856b19f32385068"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:ga6216f8f7f7668499ef5543f7787d3a23"><td class="memItemLeft" align="right" valign="top"><a id="ga6216f8f7f7668499ef5543f7787d3a23"></a>
  200. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga6216f8f7f7668499ef5543f7787d3a23">USB_DFU_STATUS_ERR_CHECK_ERASED</a>&#160;&#160;&#160;0x05</td></tr>
  201. <tr class="memdesc:ga6216f8f7f7668499ef5543f7787d3a23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory erase check failed. <br /></td></tr>
  202. <tr class="separator:ga6216f8f7f7668499ef5543f7787d3a23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:ga153a41805e584facfa693129c8b94daa"><td class="memItemLeft" align="right" valign="top"><a id="ga153a41805e584facfa693129c8b94daa"></a>
  204. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga153a41805e584facfa693129c8b94daa">USB_DFU_STATUS_ERR_PROG</a>&#160;&#160;&#160;0x06</td></tr>
  205. <tr class="memdesc:ga153a41805e584facfa693129c8b94daa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Program memory function failed. <br /></td></tr>
  206. <tr class="separator:ga153a41805e584facfa693129c8b94daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:ga8163fb309be9b5067939e67255b933c3"><td class="memItemLeft" align="right" valign="top"><a id="ga8163fb309be9b5067939e67255b933c3"></a>
  208. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga8163fb309be9b5067939e67255b933c3">USB_DFU_STATUS_ERR_VERIFY</a>&#160;&#160;&#160;0x07</td></tr>
  209. <tr class="memdesc:ga8163fb309be9b5067939e67255b933c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programmed memory failed verification. <br /></td></tr>
  210. <tr class="separator:ga8163fb309be9b5067939e67255b933c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:ga8e4f99bb43e010ad679904facc3eac98"><td class="memItemLeft" align="right" valign="top"><a id="ga8e4f99bb43e010ad679904facc3eac98"></a>
  212. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga8e4f99bb43e010ad679904facc3eac98">USB_DFU_STATUS_ERR_ADDRESS</a>&#160;&#160;&#160;0x08</td></tr>
  213. <tr class="memdesc:ga8e4f99bb43e010ad679904facc3eac98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cannot program memory due to received address that is out of range. <br /></td></tr>
  214. <tr class="separator:ga8e4f99bb43e010ad679904facc3eac98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. <tr class="memitem:ga98e8d8ecabdac2c95040eca3240a22ca"><td class="memItemLeft" align="right" valign="top"><a id="ga98e8d8ecabdac2c95040eca3240a22ca"></a>
  216. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga98e8d8ecabdac2c95040eca3240a22ca">USB_DFU_STATUS_ERR_NOTDONE</a>&#160;&#160;&#160;0x09</td></tr>
  217. <tr class="memdesc:ga98e8d8ecabdac2c95040eca3240a22ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Received DFU_DNLOAD with wLength = 0, but device does not think it has all of the data yet. <br /></td></tr>
  218. <tr class="separator:ga98e8d8ecabdac2c95040eca3240a22ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:gaec5c4d87c225d8435b9a42ce185b5370"><td class="memItemLeft" align="right" valign="top"><a id="gaec5c4d87c225d8435b9a42ce185b5370"></a>
  220. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaec5c4d87c225d8435b9a42ce185b5370">USB_DFU_STATUS_ERR_FIRMWARE</a>&#160;&#160;&#160;0x0A</td></tr>
  221. <tr class="memdesc:gaec5c4d87c225d8435b9a42ce185b5370"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device's firmware is corrupt. It cannot return to run-time (non-DFU) operations. <br /></td></tr>
  222. <tr class="separator:gaec5c4d87c225d8435b9a42ce185b5370"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr class="memitem:ga5a7c17e2b816a4cf9c2a52911dec07c7"><td class="memItemLeft" align="right" valign="top"><a id="ga5a7c17e2b816a4cf9c2a52911dec07c7"></a>
  224. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga5a7c17e2b816a4cf9c2a52911dec07c7">USB_DFU_STATUS_ERR_VENDOR</a>&#160;&#160;&#160;0x0B</td></tr>
  225. <tr class="memdesc:ga5a7c17e2b816a4cf9c2a52911dec07c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">iString indicates a vendor-specific error. <br /></td></tr>
  226. <tr class="separator:ga5a7c17e2b816a4cf9c2a52911dec07c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  227. <tr class="memitem:ga65db654ca6a80d6941f7fbebf5e1e318"><td class="memItemLeft" align="right" valign="top"><a id="ga65db654ca6a80d6941f7fbebf5e1e318"></a>
  228. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga65db654ca6a80d6941f7fbebf5e1e318">USB_DFU_STATUS_ERR_USBR</a>&#160;&#160;&#160;0x0C</td></tr>
  229. <tr class="memdesc:ga65db654ca6a80d6941f7fbebf5e1e318"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device detected unexpected USB reset signaling. <br /></td></tr>
  230. <tr class="separator:ga65db654ca6a80d6941f7fbebf5e1e318"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. <tr class="memitem:ga30076dc69e9f56923f80a74825dd98b6"><td class="memItemLeft" align="right" valign="top"><a id="ga30076dc69e9f56923f80a74825dd98b6"></a>
  232. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga30076dc69e9f56923f80a74825dd98b6">USB_DFU_STATUS_ERR_POR</a>&#160;&#160;&#160;0x0D</td></tr>
  233. <tr class="memdesc:ga30076dc69e9f56923f80a74825dd98b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device detected unexpected power on reset. <br /></td></tr>
  234. <tr class="separator:ga30076dc69e9f56923f80a74825dd98b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  235. <tr class="memitem:ga592544b91384c0ace8ade30358080c53"><td class="memItemLeft" align="right" valign="top"><a id="ga592544b91384c0ace8ade30358080c53"></a>
  236. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga592544b91384c0ace8ade30358080c53">USB_DFU_STATUS_ERR_UNKNOWN</a>&#160;&#160;&#160;0x0E</td></tr>
  237. <tr class="memdesc:ga592544b91384c0ace8ade30358080c53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Something went wrong, but the device does not know what it was. <br /></td></tr>
  238. <tr class="separator:ga592544b91384c0ace8ade30358080c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  239. <tr class="memitem:ga71af18d43b974eb66624496751c36502"><td class="memItemLeft" align="right" valign="top"><a id="ga71af18d43b974eb66624496751c36502"></a>
  240. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga71af18d43b974eb66624496751c36502">USB_DFU_STATUS_ERR_STALLEDPKT</a>&#160;&#160;&#160;0x0F</td></tr>
  241. <tr class="memdesc:ga71af18d43b974eb66624496751c36502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device stalled an unexpected request. <br /></td></tr>
  242. <tr class="separator:ga71af18d43b974eb66624496751c36502"><td class="memSeparator" colspan="2">&#160;</td></tr>
  243. </table><table class="memberdecls">
  244. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  245. USB DFU state codes</h2></td></tr>
  246. <tr class="memitem:ga331962ad44a272df1e8c11fad1ac0c9d"><td class="memItemLeft" align="right" valign="top"><a id="ga331962ad44a272df1e8c11fad1ac0c9d"></a>
  247. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga331962ad44a272df1e8c11fad1ac0c9d">USB_DFU_STATE_APP_IDLE</a>&#160;&#160;&#160;0x00</td></tr>
  248. <tr class="memdesc:ga331962ad44a272df1e8c11fad1ac0c9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is running its normal application. <br /></td></tr>
  249. <tr class="separator:ga331962ad44a272df1e8c11fad1ac0c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  250. <tr class="memitem:ga54d672d465c4e09c5a3e1c529d81abd8"><td class="memItemLeft" align="right" valign="top"><a id="ga54d672d465c4e09c5a3e1c529d81abd8"></a>
  251. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga54d672d465c4e09c5a3e1c529d81abd8">USB_DFU_STATE_APP_DETACH</a>&#160;&#160;&#160;0x01</td></tr>
  252. <tr class="memdesc:ga54d672d465c4e09c5a3e1c529d81abd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is running its normal application, has received the DFU_DETACH request, and is waiting for a USB reset. <br /></td></tr>
  253. <tr class="separator:ga54d672d465c4e09c5a3e1c529d81abd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  254. <tr class="memitem:ga57fb25bc7404edbfcb2907080f1b4138"><td class="memItemLeft" align="right" valign="top"><a id="ga57fb25bc7404edbfcb2907080f1b4138"></a>
  255. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga57fb25bc7404edbfcb2907080f1b4138">USB_DFU_STATE_DFU_IDLE</a>&#160;&#160;&#160;0x02</td></tr>
  256. <tr class="memdesc:ga57fb25bc7404edbfcb2907080f1b4138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is operating in the DFU mode and is waiting for requests. <br /></td></tr>
  257. <tr class="separator:ga57fb25bc7404edbfcb2907080f1b4138"><td class="memSeparator" colspan="2">&#160;</td></tr>
  258. <tr class="memitem:gafb2a16e5415fa4e01a37b8aadeea587c"><td class="memItemLeft" align="right" valign="top"><a id="gafb2a16e5415fa4e01a37b8aadeea587c"></a>
  259. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gafb2a16e5415fa4e01a37b8aadeea587c">USB_DFU_STATE_DFU_DNLOADSYNC</a>&#160;&#160;&#160;0x03</td></tr>
  260. <tr class="memdesc:gafb2a16e5415fa4e01a37b8aadeea587c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device has received a block and is waiting for the host to solicit the status via DFU_GETSTATUS. <br /></td></tr>
  261. <tr class="separator:gafb2a16e5415fa4e01a37b8aadeea587c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  262. <tr class="memitem:ga96c9406da324c671eb683a926eeb8a9e"><td class="memItemLeft" align="right" valign="top"><a id="ga96c9406da324c671eb683a926eeb8a9e"></a>
  263. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga96c9406da324c671eb683a926eeb8a9e">USB_DFU_STATE_DFU_DNBUSY</a>&#160;&#160;&#160;0x04</td></tr>
  264. <tr class="memdesc:ga96c9406da324c671eb683a926eeb8a9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is programming a control-write block into its nonvolatile memories. <br /></td></tr>
  265. <tr class="separator:ga96c9406da324c671eb683a926eeb8a9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  266. <tr class="memitem:ga5d637f374efc1721191bacd858f374a3"><td class="memItemLeft" align="right" valign="top"><a id="ga5d637f374efc1721191bacd858f374a3"></a>
  267. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga5d637f374efc1721191bacd858f374a3">USB_DFU_STATE_DFU_DNLOADIDLE</a>&#160;&#160;&#160;0x05</td></tr>
  268. <tr class="memdesc:ga5d637f374efc1721191bacd858f374a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is processing a download operation. Expecting DFU_DNLOAD requests. <br /></td></tr>
  269. <tr class="separator:ga5d637f374efc1721191bacd858f374a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  270. <tr class="memitem:gaad7b6553db79e84a6dc001c08a1d42d4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaad7b6553db79e84a6dc001c08a1d42d4">USB_DFU_STATE_DFU_MANIFESTSYNC</a>&#160;&#160;&#160;0x06</td></tr>
  271. <tr class="memdesc:gaad7b6553db79e84a6dc001c08a1d42d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device has received the final block of firmware from the host and is waiting for receipt of DFU_GETSTATUS to begin the Manifestation phase; or device has completed the Manifestation phase and is waiting for receipt of DFU_GETSTATUS. <a href="#gaad7b6553db79e84a6dc001c08a1d42d4">More...</a><br /></td></tr>
  272. <tr class="separator:gaad7b6553db79e84a6dc001c08a1d42d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  273. <tr class="memitem:gad0891739d73ca00540a9623f77783aab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gad0891739d73ca00540a9623f77783aab">USB_DFU_STATE_DFU_MANIFEST</a>&#160;&#160;&#160;0x07</td></tr>
  274. <tr class="memdesc:gad0891739d73ca00540a9623f77783aab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is in the Manifestation phase. <a href="#gad0891739d73ca00540a9623f77783aab">More...</a><br /></td></tr>
  275. <tr class="separator:gad0891739d73ca00540a9623f77783aab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  276. <tr class="memitem:ga49900bfec6a38db33895480875c6edc4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga49900bfec6a38db33895480875c6edc4">USB_DFU_STATE_DFU_MANIFESTWR</a>&#160;&#160;&#160;0x08</td></tr>
  277. <tr class="memdesc:ga49900bfec6a38db33895480875c6edc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device has programmed its memories and is waiting for a USB reset or a power on reset. <a href="#ga49900bfec6a38db33895480875c6edc4">More...</a><br /></td></tr>
  278. <tr class="separator:ga49900bfec6a38db33895480875c6edc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  279. <tr class="memitem:gab9c8b19dde5938faf48f6f5536da0c87"><td class="memItemLeft" align="right" valign="top"><a id="gab9c8b19dde5938faf48f6f5536da0c87"></a>
  280. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gab9c8b19dde5938faf48f6f5536da0c87">USB_DFU_STATE_DFU_UPLOADIDLE</a>&#160;&#160;&#160;0x09</td></tr>
  281. <tr class="memdesc:gab9c8b19dde5938faf48f6f5536da0c87"><td class="mdescLeft">&#160;</td><td class="mdescRight">The device is processing an upload operation. <br /></td></tr>
  282. <tr class="separator:gab9c8b19dde5938faf48f6f5536da0c87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  283. <tr class="memitem:ga126a63d05acda3823f910888f1d45475"><td class="memItemLeft" align="right" valign="top"><a id="ga126a63d05acda3823f910888f1d45475"></a>
  284. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga126a63d05acda3823f910888f1d45475">USB_DFU_STATE_DFU_ERROR</a>&#160;&#160;&#160;0x0A</td></tr>
  285. <tr class="memdesc:ga126a63d05acda3823f910888f1d45475"><td class="mdescLeft">&#160;</td><td class="mdescRight">An error has occurred. <br /></td></tr>
  286. <tr class="separator:ga126a63d05acda3823f910888f1d45475"><td class="memSeparator" colspan="2">&#160;</td></tr>
  287. </table>
  288. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  289. <p>This module contains USB Device Firmware Upgrade class definitions. </p>
  290. <p>This module based on</p><ul>
  291. <li><a href="https://www.usb.org/sites/default/files/DFU_1.1.pdf">USB Device Firmware Upgrade Specification, Revision 1.1</a> </li>
  292. </ul>
  293. <h2 class="groupheader">Macro Definition Documentation</h2>
  294. <a id="gaad7b6553db79e84a6dc001c08a1d42d4"></a>
  295. <h2 class="memtitle"><span class="permalink"><a href="#gaad7b6553db79e84a6dc001c08a1d42d4">&#9670;&nbsp;</a></span>USB_DFU_STATE_DFU_MANIFESTSYNC</h2>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">#define USB_DFU_STATE_DFU_MANIFESTSYNC&#160;&#160;&#160;0x06</td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>Device has received the final block of firmware from the host and is waiting for receipt of DFU_GETSTATUS to begin the Manifestation phase; or device has completed the Manifestation phase and is waiting for receipt of DFU_GETSTATUS. </p>
  305. <dl class="section note"><dt>Note</dt><dd>Devices that can enter this state after the Manifestation phase set bmAttributes bit bitManifestationTolerant to 1. </dd></dl>
  306. <p class="definition">Definition at line <a class="el" href="../../df/d03/a00062_source.html#l00127">127</a> of file <a class="el" href="../../df/d03/a00062_source.html">usb_dfu.h</a>.</p>
  307. </div>
  308. </div>
  309. <a id="gad0891739d73ca00540a9623f77783aab"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#gad0891739d73ca00540a9623f77783aab">&#9670;&nbsp;</a></span>USB_DFU_STATE_DFU_MANIFEST</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">#define USB_DFU_STATE_DFU_MANIFEST&#160;&#160;&#160;0x07</td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Device is in the Manifestation phase. </p>
  320. <dl class="section note"><dt>Note</dt><dd>Not all devices will be able to respond to DFU_GETSTATUS when in this state. </dd></dl>
  321. <p class="definition">Definition at line <a class="el" href="../../df/d03/a00062_source.html#l00142">142</a> of file <a class="el" href="../../df/d03/a00062_source.html">usb_dfu.h</a>.</p>
  322. </div>
  323. </div>
  324. <a id="ga49900bfec6a38db33895480875c6edc4"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#ga49900bfec6a38db33895480875c6edc4">&#9670;&nbsp;</a></span>USB_DFU_STATE_DFU_MANIFESTWR</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">#define USB_DFU_STATE_DFU_MANIFESTWR&#160;&#160;&#160;0x08</td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Device has programmed its memories and is waiting for a USB reset or a power on reset. </p>
  335. <dl class="section note"><dt>Note</dt><dd>Devices that must enter this state clear bitManifestationTolerant to 0. </dd></dl>
  336. <p class="definition">Definition at line <a class="el" href="../../df/d03/a00062_source.html#l00147">147</a> of file <a class="el" href="../../df/d03/a00062_source.html">usb_dfu.h</a>.</p>
  337. </div>
  338. </div>
  339. </div><!-- contents -->
  340. </div><!-- doc-content -->
  341. <!-- start footer part -->
  342. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  343. <ul>
  344. <li class="footer">Generated by
  345. <a href="http://www.doxygen.org/index.html">
  346. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  347. </ul>
  348. </div>
  349. </body>
  350. </html>