| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Lightweight USB stack: USB DFU class</title>
- <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="../../jquery.js"></script>
- <script type="text/javascript" src="../../dynsections.js"></script>
- <link href="../../navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="../../resize.js"></script>
- <script type="text/javascript" src="../../navtreedata.js"></script>
- <script type="text/javascript" src="../../navtree.js"></script>
- <script type="text/javascript">
- $(document).ready(initResizable);
- </script>
- <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="../../search/searchdata.js"></script>
- <script type="text/javascript" src="../../search/search.js"></script>
- <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">Lightweight USB stack
-  <span id="projectnumber">1.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
- </script>
- <script type="text/javascript" src="../../menudata.js"></script>
- <script type="text/javascript" src="../../menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('../../',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- $(document).ready(function(){initNavTree('d1/d84/a00097.html','../../');});
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> </div>
- <div class="headertitle">
- <div class="title">USB DFU class</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>This module contains USB Device Firmware Upgrade class definitions.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d72/a00204.html">usb_dfu_func_desc</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">USB DFU functional descriptor. <a href="../../d1/d72/a00204.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d31/a00208.html">usb_dfu_status</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Payload packet to response in DFU_GETSTATUS request. <a href="../../dc/d31/a00208.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB DFU class subclass and protocol definitions</h2></td></tr>
- <tr class="memitem:ga2cc8ab485b0707e0a207199b41b2b26f"><td class="memItemLeft" align="right" valign="top"><a id="ga2cc8ab485b0707e0a207199b41b2b26f"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga2cc8ab485b0707e0a207199b41b2b26f">USB_CLASS_DFU</a>   0xFE</td></tr>
- <tr class="memdesc:ga2cc8ab485b0707e0a207199b41b2b26f"><td class="mdescLeft"> </td><td class="mdescRight">USB DFU class. <br /></td></tr>
- <tr class="separator:ga2cc8ab485b0707e0a207199b41b2b26f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6f5150400e9777bce9fde0e2265780b7"><td class="memItemLeft" align="right" valign="top"><a id="ga6f5150400e9777bce9fde0e2265780b7"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga6f5150400e9777bce9fde0e2265780b7">USB_DFU_SUBCLASS_DFU</a>   0x01</td></tr>
- <tr class="memdesc:ga6f5150400e9777bce9fde0e2265780b7"><td class="mdescLeft"> </td><td class="mdescRight">USB DFU subclass code. <br /></td></tr>
- <tr class="separator:ga6f5150400e9777bce9fde0e2265780b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga16484515b518007fc7bff87f4a722359"><td class="memItemLeft" align="right" valign="top"><a id="ga16484515b518007fc7bff87f4a722359"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga16484515b518007fc7bff87f4a722359">USB_DFU_PROTO_RUNTIME</a>   0x01</td></tr>
- <tr class="memdesc:ga16484515b518007fc7bff87f4a722359"><td class="mdescLeft"> </td><td class="mdescRight">USB DFU runtime-mode protocol. <br /></td></tr>
- <tr class="separator:ga16484515b518007fc7bff87f4a722359"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0d4aebf6881d083cfb358e142861cb08"><td class="memItemLeft" align="right" valign="top"><a id="ga0d4aebf6881d083cfb358e142861cb08"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga0d4aebf6881d083cfb358e142861cb08">USB_DFU_PROTO_DFU</a>   0x02</td></tr>
- <tr class="memdesc:ga0d4aebf6881d083cfb358e142861cb08"><td class="mdescLeft"> </td><td class="mdescRight">USB DFU DFU-mode protocol. <br /></td></tr>
- <tr class="separator:ga0d4aebf6881d083cfb358e142861cb08"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB DFU descriptor types</h2></td></tr>
- <tr class="memitem:ga00c1235b376fe41401faac08a2afc1e5"><td class="memItemLeft" align="right" valign="top"><a id="ga00c1235b376fe41401faac08a2afc1e5"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga00c1235b376fe41401faac08a2afc1e5">USB_DTYPE_DFU_FUNCTIONAL</a>   0x21</td></tr>
- <tr class="memdesc:ga00c1235b376fe41401faac08a2afc1e5"><td class="mdescLeft"> </td><td class="mdescRight">USB DFU functional descriptor type. <br /></td></tr>
- <tr class="separator:ga00c1235b376fe41401faac08a2afc1e5"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB DFU class-specific requests</h2></td></tr>
- <tr class="memitem:gab76be710887a0f98892183e2373afaa2"><td class="memItemLeft" align="right" valign="top"><a id="gab76be710887a0f98892183e2373afaa2"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gab76be710887a0f98892183e2373afaa2">USB_DFU_DETACH</a>   0x00</td></tr>
- <tr class="memdesc:gab76be710887a0f98892183e2373afaa2"><td class="mdescLeft"> </td><td class="mdescRight">Initiates a detach-attach sequence on the bus when it sees this request. <br /></td></tr>
- <tr class="separator:gab76be710887a0f98892183e2373afaa2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga88abf5a9495158487fe4940e4aac1c92"><td class="memItemLeft" align="right" valign="top"><a id="ga88abf5a9495158487fe4940e4aac1c92"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga88abf5a9495158487fe4940e4aac1c92">USB_DFU_DNLOAD</a>   0x01</td></tr>
- <tr class="memdesc:ga88abf5a9495158487fe4940e4aac1c92"><td class="mdescLeft"> </td><td class="mdescRight">Initiates firmware image downloading. <br /></td></tr>
- <tr class="separator:ga88abf5a9495158487fe4940e4aac1c92"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga600b617f24ae4d4d16856e305b41a5f1"><td class="memItemLeft" align="right" valign="top"><a id="ga600b617f24ae4d4d16856e305b41a5f1"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga600b617f24ae4d4d16856e305b41a5f1">USB_DFU_UPLOAD</a>   0x02</td></tr>
- <tr class="memdesc:ga600b617f24ae4d4d16856e305b41a5f1"><td class="mdescLeft"> </td><td class="mdescRight">This request is employed by the host to solicit firmware from the device. <br /></td></tr>
- <tr class="separator:ga600b617f24ae4d4d16856e305b41a5f1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1c8d801bcbef1f29e958b5a6325af5bd"><td class="memItemLeft" align="right" valign="top"><a id="ga1c8d801bcbef1f29e958b5a6325af5bd"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga1c8d801bcbef1f29e958b5a6325af5bd">USB_DFU_GETSTATUS</a>   0x03</td></tr>
- <tr class="memdesc:ga1c8d801bcbef1f29e958b5a6325af5bd"><td class="mdescLeft"> </td><td class="mdescRight">The host employs this request to facilitate synchronization with the device. <br /></td></tr>
- <tr class="separator:ga1c8d801bcbef1f29e958b5a6325af5bd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa2fba64c89b642ec5ac907065529ab8f"><td class="memItemLeft" align="right" valign="top"><a id="gaa2fba64c89b642ec5ac907065529ab8f"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaa2fba64c89b642ec5ac907065529ab8f">USB_DFU_CLRSTATUS</a>   0x04</td></tr>
- <tr class="memdesc:gaa2fba64c89b642ec5ac907065529ab8f"><td class="mdescLeft"> </td><td class="mdescRight">This request resets DFU machine state to DFU_IDLE. <br /></td></tr>
- <tr class="separator:gaa2fba64c89b642ec5ac907065529ab8f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga720c83a484f58f19616b511466486a9b"><td class="memItemLeft" align="right" valign="top"><a id="ga720c83a484f58f19616b511466486a9b"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga720c83a484f58f19616b511466486a9b">USB_DFU_GETSTATE</a>   0x05</td></tr>
- <tr class="memdesc:ga720c83a484f58f19616b511466486a9b"><td class="mdescLeft"> </td><td class="mdescRight">This request solicits a report about the state of the device. <br /></td></tr>
- <tr class="separator:ga720c83a484f58f19616b511466486a9b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaba44f9ef6de75e3df0e5715a5eddda6f"><td class="memItemLeft" align="right" valign="top"><a id="gaba44f9ef6de75e3df0e5715a5eddda6f"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaba44f9ef6de75e3df0e5715a5eddda6f">USB_DFU_ABORT</a>   0x06</td></tr>
- <tr class="memdesc:gaba44f9ef6de75e3df0e5715a5eddda6f"><td class="mdescLeft"> </td><td class="mdescRight">This request enables the host to exit from certain states and return to the DFU_IDLE state. <br /></td></tr>
- <tr class="separator:gaba44f9ef6de75e3df0e5715a5eddda6f"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB DFU capabilities</h2></td></tr>
- <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpcc3892006c4cc278a0ad360b48bda77f"></a><a class="anchor" id="USB_DFU_CAPAB"></a></p>
- </td></tr>
- <tr class="memitem:ga005e5b7fc18c066ee61ae393a2ba09c7"><td class="memItemLeft" align="right" valign="top"><a id="ga005e5b7fc18c066ee61ae393a2ba09c7"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga005e5b7fc18c066ee61ae393a2ba09c7">USB_DFU_ATTR_WILL_DETACH</a>   0x08</td></tr>
- <tr class="memdesc:ga005e5b7fc18c066ee61ae393a2ba09c7"><td class="mdescLeft"> </td><td class="mdescRight">Device will perform a bus detach-attach sequence when it receives a DFU_DETACH request. <br /></td></tr>
- <tr class="separator:ga005e5b7fc18c066ee61ae393a2ba09c7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga757dc48567171071714a297ae685eb5f"><td class="memItemLeft" align="right" valign="top"><a id="ga757dc48567171071714a297ae685eb5f"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga757dc48567171071714a297ae685eb5f">USB_DFU_ATTR_MANIF_TOL</a>   0x04</td></tr>
- <tr class="memdesc:ga757dc48567171071714a297ae685eb5f"><td class="mdescLeft"> </td><td class="mdescRight">Device is able to communicate via USB after Manifestation phase. <br /></td></tr>
- <tr class="separator:ga757dc48567171071714a297ae685eb5f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga40264d92194b790a6b285c1aefa0cc3c"><td class="memItemLeft" align="right" valign="top"><a id="ga40264d92194b790a6b285c1aefa0cc3c"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga40264d92194b790a6b285c1aefa0cc3c">USB_DFU_ATTR_CAN_UPLOAD</a>   0x02</td></tr>
- <tr class="memdesc:ga40264d92194b790a6b285c1aefa0cc3c"><td class="mdescLeft"> </td><td class="mdescRight">Upload capable. <br /></td></tr>
- <tr class="separator:ga40264d92194b790a6b285c1aefa0cc3c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga22c5740401995633128679a460d4a2ef"><td class="memItemLeft" align="right" valign="top"><a id="ga22c5740401995633128679a460d4a2ef"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga22c5740401995633128679a460d4a2ef">USB_DFU_ATTR_CAN_DNLOAD</a>   0x01</td></tr>
- <tr class="memdesc:ga22c5740401995633128679a460d4a2ef"><td class="mdescLeft"> </td><td class="mdescRight">Download capable. <br /></td></tr>
- <tr class="separator:ga22c5740401995633128679a460d4a2ef"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB DFU status codes</h2></td></tr>
- <tr class="memitem:ga16ed86c3a720e4bf14b14c79e4ab6cdd"><td class="memItemLeft" align="right" valign="top"><a id="ga16ed86c3a720e4bf14b14c79e4ab6cdd"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga16ed86c3a720e4bf14b14c79e4ab6cdd">USB_DFU_STATUS_OK</a>   0x00</td></tr>
- <tr class="memdesc:ga16ed86c3a720e4bf14b14c79e4ab6cdd"><td class="mdescLeft"> </td><td class="mdescRight">No error condition is present. <br /></td></tr>
- <tr class="separator:ga16ed86c3a720e4bf14b14c79e4ab6cdd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaca68ab323ffb52c795400920565aef28"><td class="memItemLeft" align="right" valign="top"><a id="gaca68ab323ffb52c795400920565aef28"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaca68ab323ffb52c795400920565aef28">USB_DFU_STATUS_ERR_TARGET</a>   0x01</td></tr>
- <tr class="memdesc:gaca68ab323ffb52c795400920565aef28"><td class="mdescLeft"> </td><td class="mdescRight">File is not targeted for use by this device. <br /></td></tr>
- <tr class="separator:gaca68ab323ffb52c795400920565aef28"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae86dc027ec6afa97ee8086147ded8380"><td class="memItemLeft" align="right" valign="top"><a id="gae86dc027ec6afa97ee8086147ded8380"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gae86dc027ec6afa97ee8086147ded8380">USB_DFU_STATUS_ERR_FILE</a>   0x02</td></tr>
- <tr class="memdesc:gae86dc027ec6afa97ee8086147ded8380"><td class="mdescLeft"> </td><td class="mdescRight">File is for this device but fails some vendor specific verification test. <br /></td></tr>
- <tr class="separator:gae86dc027ec6afa97ee8086147ded8380"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8c1d9d09df3abd90ac4b272b54418210"><td class="memItemLeft" align="right" valign="top"><a id="ga8c1d9d09df3abd90ac4b272b54418210"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga8c1d9d09df3abd90ac4b272b54418210">USB_DFU_STATUS_ERR_WRITE</a>   0x03</td></tr>
- <tr class="memdesc:ga8c1d9d09df3abd90ac4b272b54418210"><td class="mdescLeft"> </td><td class="mdescRight">Device is unable to write memory. <br /></td></tr>
- <tr class="separator:ga8c1d9d09df3abd90ac4b272b54418210"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1eed91fcbb44495c4856b19f32385068"><td class="memItemLeft" align="right" valign="top"><a id="ga1eed91fcbb44495c4856b19f32385068"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga1eed91fcbb44495c4856b19f32385068">USB_DFU_STATUS_ERR_ERASE</a>   0x04</td></tr>
- <tr class="memdesc:ga1eed91fcbb44495c4856b19f32385068"><td class="mdescLeft"> </td><td class="mdescRight">Memory erase function failed. <br /></td></tr>
- <tr class="separator:ga1eed91fcbb44495c4856b19f32385068"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6216f8f7f7668499ef5543f7787d3a23"><td class="memItemLeft" align="right" valign="top"><a id="ga6216f8f7f7668499ef5543f7787d3a23"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga6216f8f7f7668499ef5543f7787d3a23">USB_DFU_STATUS_ERR_CHECK_ERASED</a>   0x05</td></tr>
- <tr class="memdesc:ga6216f8f7f7668499ef5543f7787d3a23"><td class="mdescLeft"> </td><td class="mdescRight">Memory erase check failed. <br /></td></tr>
- <tr class="separator:ga6216f8f7f7668499ef5543f7787d3a23"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga153a41805e584facfa693129c8b94daa"><td class="memItemLeft" align="right" valign="top"><a id="ga153a41805e584facfa693129c8b94daa"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga153a41805e584facfa693129c8b94daa">USB_DFU_STATUS_ERR_PROG</a>   0x06</td></tr>
- <tr class="memdesc:ga153a41805e584facfa693129c8b94daa"><td class="mdescLeft"> </td><td class="mdescRight">Program memory function failed. <br /></td></tr>
- <tr class="separator:ga153a41805e584facfa693129c8b94daa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8163fb309be9b5067939e67255b933c3"><td class="memItemLeft" align="right" valign="top"><a id="ga8163fb309be9b5067939e67255b933c3"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga8163fb309be9b5067939e67255b933c3">USB_DFU_STATUS_ERR_VERIFY</a>   0x07</td></tr>
- <tr class="memdesc:ga8163fb309be9b5067939e67255b933c3"><td class="mdescLeft"> </td><td class="mdescRight">Programmed memory failed verification. <br /></td></tr>
- <tr class="separator:ga8163fb309be9b5067939e67255b933c3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8e4f99bb43e010ad679904facc3eac98"><td class="memItemLeft" align="right" valign="top"><a id="ga8e4f99bb43e010ad679904facc3eac98"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga8e4f99bb43e010ad679904facc3eac98">USB_DFU_STATUS_ERR_ADDRESS</a>   0x08</td></tr>
- <tr class="memdesc:ga8e4f99bb43e010ad679904facc3eac98"><td class="mdescLeft"> </td><td class="mdescRight">Cannot program memory due to received address that is out of range. <br /></td></tr>
- <tr class="separator:ga8e4f99bb43e010ad679904facc3eac98"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga98e8d8ecabdac2c95040eca3240a22ca"><td class="memItemLeft" align="right" valign="top"><a id="ga98e8d8ecabdac2c95040eca3240a22ca"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga98e8d8ecabdac2c95040eca3240a22ca">USB_DFU_STATUS_ERR_NOTDONE</a>   0x09</td></tr>
- <tr class="memdesc:ga98e8d8ecabdac2c95040eca3240a22ca"><td class="mdescLeft"> </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>
- <tr class="separator:ga98e8d8ecabdac2c95040eca3240a22ca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaec5c4d87c225d8435b9a42ce185b5370"><td class="memItemLeft" align="right" valign="top"><a id="gaec5c4d87c225d8435b9a42ce185b5370"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaec5c4d87c225d8435b9a42ce185b5370">USB_DFU_STATUS_ERR_FIRMWARE</a>   0x0A</td></tr>
- <tr class="memdesc:gaec5c4d87c225d8435b9a42ce185b5370"><td class="mdescLeft"> </td><td class="mdescRight">Device's firmware is corrupt. It cannot return to run-time (non-DFU) operations. <br /></td></tr>
- <tr class="separator:gaec5c4d87c225d8435b9a42ce185b5370"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5a7c17e2b816a4cf9c2a52911dec07c7"><td class="memItemLeft" align="right" valign="top"><a id="ga5a7c17e2b816a4cf9c2a52911dec07c7"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga5a7c17e2b816a4cf9c2a52911dec07c7">USB_DFU_STATUS_ERR_VENDOR</a>   0x0B</td></tr>
- <tr class="memdesc:ga5a7c17e2b816a4cf9c2a52911dec07c7"><td class="mdescLeft"> </td><td class="mdescRight">iString indicates a vendor-specific error. <br /></td></tr>
- <tr class="separator:ga5a7c17e2b816a4cf9c2a52911dec07c7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga65db654ca6a80d6941f7fbebf5e1e318"><td class="memItemLeft" align="right" valign="top"><a id="ga65db654ca6a80d6941f7fbebf5e1e318"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga65db654ca6a80d6941f7fbebf5e1e318">USB_DFU_STATUS_ERR_USBR</a>   0x0C</td></tr>
- <tr class="memdesc:ga65db654ca6a80d6941f7fbebf5e1e318"><td class="mdescLeft"> </td><td class="mdescRight">Device detected unexpected USB reset signaling. <br /></td></tr>
- <tr class="separator:ga65db654ca6a80d6941f7fbebf5e1e318"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga30076dc69e9f56923f80a74825dd98b6"><td class="memItemLeft" align="right" valign="top"><a id="ga30076dc69e9f56923f80a74825dd98b6"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga30076dc69e9f56923f80a74825dd98b6">USB_DFU_STATUS_ERR_POR</a>   0x0D</td></tr>
- <tr class="memdesc:ga30076dc69e9f56923f80a74825dd98b6"><td class="mdescLeft"> </td><td class="mdescRight">Device detected unexpected power on reset. <br /></td></tr>
- <tr class="separator:ga30076dc69e9f56923f80a74825dd98b6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga592544b91384c0ace8ade30358080c53"><td class="memItemLeft" align="right" valign="top"><a id="ga592544b91384c0ace8ade30358080c53"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga592544b91384c0ace8ade30358080c53">USB_DFU_STATUS_ERR_UNKNOWN</a>   0x0E</td></tr>
- <tr class="memdesc:ga592544b91384c0ace8ade30358080c53"><td class="mdescLeft"> </td><td class="mdescRight">Something went wrong, but the device does not know what it was. <br /></td></tr>
- <tr class="separator:ga592544b91384c0ace8ade30358080c53"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga71af18d43b974eb66624496751c36502"><td class="memItemLeft" align="right" valign="top"><a id="ga71af18d43b974eb66624496751c36502"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga71af18d43b974eb66624496751c36502">USB_DFU_STATUS_ERR_STALLEDPKT</a>   0x0F</td></tr>
- <tr class="memdesc:ga71af18d43b974eb66624496751c36502"><td class="mdescLeft"> </td><td class="mdescRight">Device stalled an unexpected request. <br /></td></tr>
- <tr class="separator:ga71af18d43b974eb66624496751c36502"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB DFU state codes</h2></td></tr>
- <tr class="memitem:ga331962ad44a272df1e8c11fad1ac0c9d"><td class="memItemLeft" align="right" valign="top"><a id="ga331962ad44a272df1e8c11fad1ac0c9d"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga331962ad44a272df1e8c11fad1ac0c9d">USB_DFU_STATE_APP_IDLE</a>   0x00</td></tr>
- <tr class="memdesc:ga331962ad44a272df1e8c11fad1ac0c9d"><td class="mdescLeft"> </td><td class="mdescRight">Device is running its normal application. <br /></td></tr>
- <tr class="separator:ga331962ad44a272df1e8c11fad1ac0c9d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga54d672d465c4e09c5a3e1c529d81abd8"><td class="memItemLeft" align="right" valign="top"><a id="ga54d672d465c4e09c5a3e1c529d81abd8"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga54d672d465c4e09c5a3e1c529d81abd8">USB_DFU_STATE_APP_DETACH</a>   0x01</td></tr>
- <tr class="memdesc:ga54d672d465c4e09c5a3e1c529d81abd8"><td class="mdescLeft"> </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>
- <tr class="separator:ga54d672d465c4e09c5a3e1c529d81abd8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga57fb25bc7404edbfcb2907080f1b4138"><td class="memItemLeft" align="right" valign="top"><a id="ga57fb25bc7404edbfcb2907080f1b4138"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga57fb25bc7404edbfcb2907080f1b4138">USB_DFU_STATE_DFU_IDLE</a>   0x02</td></tr>
- <tr class="memdesc:ga57fb25bc7404edbfcb2907080f1b4138"><td class="mdescLeft"> </td><td class="mdescRight">Device is operating in the DFU mode and is waiting for requests. <br /></td></tr>
- <tr class="separator:ga57fb25bc7404edbfcb2907080f1b4138"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gafb2a16e5415fa4e01a37b8aadeea587c"><td class="memItemLeft" align="right" valign="top"><a id="gafb2a16e5415fa4e01a37b8aadeea587c"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gafb2a16e5415fa4e01a37b8aadeea587c">USB_DFU_STATE_DFU_DNLOADSYNC</a>   0x03</td></tr>
- <tr class="memdesc:gafb2a16e5415fa4e01a37b8aadeea587c"><td class="mdescLeft"> </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>
- <tr class="separator:gafb2a16e5415fa4e01a37b8aadeea587c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga96c9406da324c671eb683a926eeb8a9e"><td class="memItemLeft" align="right" valign="top"><a id="ga96c9406da324c671eb683a926eeb8a9e"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga96c9406da324c671eb683a926eeb8a9e">USB_DFU_STATE_DFU_DNBUSY</a>   0x04</td></tr>
- <tr class="memdesc:ga96c9406da324c671eb683a926eeb8a9e"><td class="mdescLeft"> </td><td class="mdescRight">Device is programming a control-write block into its nonvolatile memories. <br /></td></tr>
- <tr class="separator:ga96c9406da324c671eb683a926eeb8a9e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5d637f374efc1721191bacd858f374a3"><td class="memItemLeft" align="right" valign="top"><a id="ga5d637f374efc1721191bacd858f374a3"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga5d637f374efc1721191bacd858f374a3">USB_DFU_STATE_DFU_DNLOADIDLE</a>   0x05</td></tr>
- <tr class="memdesc:ga5d637f374efc1721191bacd858f374a3"><td class="mdescLeft"> </td><td class="mdescRight">Device is processing a download operation. Expecting DFU_DNLOAD requests. <br /></td></tr>
- <tr class="separator:ga5d637f374efc1721191bacd858f374a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaad7b6553db79e84a6dc001c08a1d42d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gaad7b6553db79e84a6dc001c08a1d42d4">USB_DFU_STATE_DFU_MANIFESTSYNC</a>   0x06</td></tr>
- <tr class="memdesc:gaad7b6553db79e84a6dc001c08a1d42d4"><td class="mdescLeft"> </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>
- <tr class="separator:gaad7b6553db79e84a6dc001c08a1d42d4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad0891739d73ca00540a9623f77783aab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gad0891739d73ca00540a9623f77783aab">USB_DFU_STATE_DFU_MANIFEST</a>   0x07</td></tr>
- <tr class="memdesc:gad0891739d73ca00540a9623f77783aab"><td class="mdescLeft"> </td><td class="mdescRight">Device is in the Manifestation phase. <a href="#gad0891739d73ca00540a9623f77783aab">More...</a><br /></td></tr>
- <tr class="separator:gad0891739d73ca00540a9623f77783aab"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga49900bfec6a38db33895480875c6edc4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga49900bfec6a38db33895480875c6edc4">USB_DFU_STATE_DFU_MANIFESTWR</a>   0x08</td></tr>
- <tr class="memdesc:ga49900bfec6a38db33895480875c6edc4"><td class="mdescLeft"> </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>
- <tr class="separator:ga49900bfec6a38db33895480875c6edc4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab9c8b19dde5938faf48f6f5536da0c87"><td class="memItemLeft" align="right" valign="top"><a id="gab9c8b19dde5938faf48f6f5536da0c87"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#gab9c8b19dde5938faf48f6f5536da0c87">USB_DFU_STATE_DFU_UPLOADIDLE</a>   0x09</td></tr>
- <tr class="memdesc:gab9c8b19dde5938faf48f6f5536da0c87"><td class="mdescLeft"> </td><td class="mdescRight">The device is processing an upload operation. <br /></td></tr>
- <tr class="separator:gab9c8b19dde5938faf48f6f5536da0c87"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga126a63d05acda3823f910888f1d45475"><td class="memItemLeft" align="right" valign="top"><a id="ga126a63d05acda3823f910888f1d45475"></a>
- #define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d84/a00097.html#ga126a63d05acda3823f910888f1d45475">USB_DFU_STATE_DFU_ERROR</a>   0x0A</td></tr>
- <tr class="memdesc:ga126a63d05acda3823f910888f1d45475"><td class="mdescLeft"> </td><td class="mdescRight">An error has occurred. <br /></td></tr>
- <tr class="separator:ga126a63d05acda3823f910888f1d45475"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>This module contains USB Device Firmware Upgrade class definitions. </p>
- <p>This module based on</p><ul>
- <li><a href="https://www.usb.org/sites/default/files/DFU_1.1.pdf">USB Device Firmware Upgrade Specification, Revision 1.1</a> </li>
- </ul>
- <h2 class="groupheader">Macro Definition Documentation</h2>
- <a id="gaad7b6553db79e84a6dc001c08a1d42d4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaad7b6553db79e84a6dc001c08a1d42d4">◆ </a></span>USB_DFU_STATE_DFU_MANIFESTSYNC</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_DFU_STATE_DFU_MANIFESTSYNC   0x06</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <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>
- <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>
- </div>
- </div>
- <a id="gad0891739d73ca00540a9623f77783aab"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad0891739d73ca00540a9623f77783aab">◆ </a></span>USB_DFU_STATE_DFU_MANIFEST</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_DFU_STATE_DFU_MANIFEST   0x07</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Device is in the Manifestation phase. </p>
- <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>
- <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>
- </div>
- </div>
- <a id="ga49900bfec6a38db33895480875c6edc4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga49900bfec6a38db33895480875c6edc4">◆ </a></span>USB_DFU_STATE_DFU_MANIFESTWR</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_DFU_STATE_DFU_MANIFESTWR   0x08</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Device has programmed its memories and is waiting for a USB reset or a power on reset. </p>
- <dl class="section note"><dt>Note</dt><dd>Devices that must enter this state clear bitManifestationTolerant to 0. </dd></dl>
- <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>
- </div>
- </div>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="footer">Generated by
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
- </ul>
- </div>
- </body>
- </html>
|