web/docs/picoboot_8h_source.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/boot/picoboot.h Source File</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('picoboot_8h_source.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="headertitle"><div class="title">picoboot.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="picoboot_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
 109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.</span></div>
 110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
 111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
 112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
 113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
 114 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _BOOT_PICOBOOT_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _BOOT_PICOBOOT_H</span></div>
 116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
 117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &lt;assert.h&gt;</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#ifndef NO_PICO_PLATFORM</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#include &quot;<a class="code" href="platform_8h.html">pico/platform.h</a>&quot;</span></div>
 123 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#endif</span></div>
 124 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
 125 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;picoboot_constants.h&quot;</span></div>
 126 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
 127 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#define PICOBOOT_MAGIC 0x431fd10bu</span></div>
 128 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
 129 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">// --------------------------------------------</span></div>
 130 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// CONTROL REQUESTS FOR THE PICOBOOT INTERFACE</span></div>
 131 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">// --------------------------------------------</span></div>
 132 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
 133 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">// size 0 OUT - un-stall EPs and reset</span></div>
 134 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define PICOBOOT_IF_RESET 0x41</span></div>
 135 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
 136 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">// size 16 IN - return the status of the last command</span></div>
 137 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#define PICOBOOT_IF_CMD_STATUS 0x42</span></div>
 138 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
 139 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">// --------------------------------------------------</span></div>
 140 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">// COMMAND REQUESTS SENT TO THE PICOBOOT OUT ENDPOINT</span></div>
 141 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment">// --------------------------------------------------</span></div>
 142 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment">//</span></div>
 143 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">// picoboot_cmd structure of size 32 is sent to OUT endpoint</span></div>
 144 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">// transfer_length bytes are transferred via IN/OUT</span></div>
 145 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">// device responds on success with 0 length ACK packet set via OUT/IN</span></div>
 146 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">// device may stall the transferring endpoint in case of error</span></div>
 147 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
 148 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="keyword">enum</span> picoboot_cmd_id {</div>
 149 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    PC_EXCLUSIVE_ACCESS = 0x1,</div>
 150 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>    PC_REBOOT = 0x2,</div>
 151 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>    PC_FLASH_ERASE = 0x3,</div>
 152 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    PC_READ = 0x84, <span class="comment">// either RAM or FLASH</span></div>
 153 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    PC_WRITE = 0x5, <span class="comment">// either RAM or FLASH (does no erase)</span></div>
 154 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>    PC_EXIT_XIP = 0x6,</div>
 155 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>    PC_ENTER_CMD_XIP = 0x7,</div>
 156 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>    PC_EXEC = 0x8,</div>
 157 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>    PC_VECTORIZE_FLASH = 0x9,</div>
 158 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    <span class="comment">// RP2350 only below here</span></div>
 159 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    PC_REBOOT2 = 0xa,</div>
 160 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    PC_GET_INFO = 0x8b,</div>
 161 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    PC_OTP_READ = 0x8c,</div>
 162 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    PC_OTP_WRITE = 0xd,</div>
 163 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>    <span class="comment">//PC_EXEC2 = 0xe, // currently unused</span></div>
 164 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>};</div>
 165 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
 166 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="keyword">enum</span> picoboot_status {</div>
 167 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>    PICOBOOT_OK = 0,</div>
 168 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>    PICOBOOT_UNKNOWN_CMD = 1,</div>
 169 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>    PICOBOOT_INVALID_CMD_LENGTH = 2,</div>
 170 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>    PICOBOOT_INVALID_TRANSFER_LENGTH = 3,</div>
 171 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>    PICOBOOT_INVALID_ADDRESS = 4,</div>
 172 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>    PICOBOOT_BAD_ALIGNMENT = 5,</div>
 173 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    PICOBOOT_INTERLEAVED_WRITE = 6,</div>
 174 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>    PICOBOOT_REBOOTING = 7,</div>
 175 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>    PICOBOOT_UNKNOWN_ERROR = 8,</div>
 176 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>    PICOBOOT_INVALID_STATE = 9,</div>
 177 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>    PICOBOOT_NOT_PERMITTED = 10,</div>
 178 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>    PICOBOOT_INVALID_ARG = 11,</div>
 179 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>    PICOBOOT_BUFFER_TOO_SMALL = 12,</div>
 180 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>    PICOBOOT_PRECONDITION_NOT_MET = 13,</div>
 181 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>    PICOBOOT_MODIFIED_DATA = 14,</div>
 182 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>    PICOBOOT_INVALID_DATA = 15,</div>
 183 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>    PICOBOOT_NOT_FOUND = 16,</div>
 184 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>    PICOBOOT_UNSUPPORTED_MODIFICATION = 17,</div>
 185 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>};</div>
 186 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
 187 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="structpicoboot__reboot__cmd.html">   86</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__reboot__cmd.html">picoboot_reboot_cmd</a> {</div>
 188 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>    uint32_t dPC; <span class="comment">// 0 means reset into regular boot path</span></div>
 189 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>    uint32_t dSP;</div>
 190 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    uint32_t dDelayMS;</div>
 191 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>};</div>
 192 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span> </div>
 193 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
 194 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">// note this (with pc_sp) union member has the same layout as picoboot_reboot_cmd except with extra dFlags</span></div>
 195 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structpicoboot__reboot2__cmd.html">   94</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__reboot2__cmd.html">picoboot_reboot2_cmd</a> {</div>
 196 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    uint32_t dFlags;</div>
 197 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>    uint32_t dDelayMS;</div>
 198 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>    uint32_t dParam0;</div>
 199 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>    uint32_t dParam1;</div>
 200 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>};</div>
 201 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
 202 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">// used for EXEC, VECTORIZE_FLASH</span></div>
 203 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="structpicoboot__address__only__cmd.html">  102</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__address__only__cmd.html">picoboot_address_only_cmd</a> {</div>
 204 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>    uint32_t dAddr;</div>
 205 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>};</div>
 206 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
 207 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">// used for READ, WRITE, FLASH_ERASE</span></div>
 208 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="structpicoboot__range__cmd.html">  107</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__range__cmd.html">picoboot_range_cmd</a> {</div>
 209 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>    uint32_t dAddr;</div>
 210 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>    uint32_t dSize;</div>
 211 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>};</div>
 212 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
 213 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structpicoboot__exec2__cmd.html">  112</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__exec2__cmd.html">picoboot_exec2_cmd</a> {</div>
 214 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>    uint32_t image_base;</div>
 215 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>    uint32_t image_size;</div>
 216 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>    uint32_t workarea_base;</div>
 217 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>    uint32_t workarea_size;</div>
 218 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>};</div>
 219 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
 220 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="keyword">enum</span> picoboot_exclusive_type {</div>
 221 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>    NOT_EXCLUSIVE = 0,</div>
 222 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>    EXCLUSIVE,</div>
 223 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>    EXCLUSIVE_AND_EJECT</div>
 224 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>};</div>
 225 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span> </div>
 226 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="structpicoboot__exclusive__cmd.html">  125</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__exclusive__cmd.html">picoboot_exclusive_cmd</a> {</div>
 227 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>    uint8_t bExclusive;</div>
 228 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>};</div>
 229 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span> </div>
 230 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="structpicoboot__otp__cmd.html">  129</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__otp__cmd.html">picoboot_otp_cmd</a> {</div>
 231 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>    uint16_t wRow; <span class="comment">// OTP row</span></div>
 232 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>    uint16_t wRowCount; <span class="comment">// number of rows to transfer</span></div>
 233 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>    uint8_t bEcc; <span class="comment">// use error correction (16 bit per register vs 24 (stored as 32) bit raw)</span></div>
 234 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>};</div>
 235 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span> </div>
 236 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span> </div>
 237 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="structpicoboot__get__info__cmd.html">  136</a></span><span class="keyword">struct </span>__packed <a class="code hl_struct" href="structpicoboot__get__info__cmd.html">picoboot_get_info_cmd</a> {</div>
 238 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>    uint8_t bType;</div>
 239 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>    uint8_t bParam;</div>
 240 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>    uint16_t wParam;</div>
 241 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>    uint32_t dParams[3];</div>
 242 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>};</div>
 243 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span> </div>
 244 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">// little endian</span></div>
 245 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="keyword">struct </span>__packed __aligned(4) picoboot_cmd {</div>
 246 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>    uint32_t dMagic;</div>
 247 <div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>    uint32_t dToken; <span class="comment">// an identifier for this token to correlate with a status response</span></div>
 248 <div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>    uint8_t bCmdId; <span class="comment">// top bit set for IN</span></div>
 249 <div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>    uint8_t bCmdSize; <span class="comment">// bytes of actual data in the arg part of this structure</span></div>
 250 <div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>    uint16_t _unused;</div>
 251 <div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>    uint32_t dTransferLength; <span class="comment">// length of IN/OUT transfer (or 0) if none</span></div>
 252 <div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>    <span class="keyword">union </span>{</div>
 253 <div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>        uint8_t args[16];</div>
 254 <div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__reboot__cmd.html">picoboot_reboot_cmd</a> reboot_cmd;</div>
 255 <div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__range__cmd.html">picoboot_range_cmd</a> range_cmd;</div>
 256 <div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__address__only__cmd.html">picoboot_address_only_cmd</a> address_only_cmd;</div>
 257 <div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__exclusive__cmd.html">picoboot_exclusive_cmd</a> exclusive_cmd;</div>
 258 <div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__reboot2__cmd.html">picoboot_reboot2_cmd</a> reboot2_cmd;</div>
 259 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__otp__cmd.html">picoboot_otp_cmd</a> <a class="code hl_struct" href="structotp__cmd.html">otp_cmd</a>;</div>
 260 <div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__get__info__cmd.html">picoboot_get_info_cmd</a> get_info_cmd;</div>
 261 <div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>        <span class="keyword">struct </span><a class="code hl_struct" href="structpicoboot__exec2__cmd.html">picoboot_exec2_cmd</a> exec2_cmd;</div>
 262 <div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>    };</div>
 263 <div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>};</div>
 264 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="keyword">static_assert</span>(32 == <span class="keyword">sizeof</span>(<span class="keyword">struct </span>picoboot_cmd), &quot;picoboot_cmd must be 32 bytes big&quot;);</div>
 265 <div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span> </div>
 266 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="keyword">struct </span>__packed __aligned(4) picoboot_cmd_status {</div>
 267 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>    uint32_t dToken;</div>
 268 <div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>    uint32_t dStatusCode;</div>
 269 <div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>    uint8_t bCmdId;</div>
 270 <div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>    uint8_t bInProgress;</div>
 271 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>    uint8_t _pad[6];</div>
 272 <div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>};</div>
 273 <div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span> </div>
 274 <div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="keyword">static_assert</span>(16 == <span class="keyword">sizeof</span>(<span class="keyword">struct </span>picoboot_cmd_status), &quot;picoboot_cmd_status must be 16 bytes big&quot;);</div>
 275 <div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span> </div>
 276 <div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="preprocessor">#endif</span></div>
 277 <div class="ttc" id="aplatform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></div></div>
 278 <div class="ttc" id="astructotp__cmd_html"><div class="ttname"><a href="structotp__cmd.html">otp_cmd</a></div><div class="ttdef"><b>Definition:</b> bootrom_constants.h:273</div></div>
 279 <div class="ttc" id="astructpicoboot__address__only__cmd_html"><div class="ttname"><a href="structpicoboot__address__only__cmd.html">picoboot_address_only_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:102</div></div>
 280 <div class="ttc" id="astructpicoboot__exclusive__cmd_html"><div class="ttname"><a href="structpicoboot__exclusive__cmd.html">picoboot_exclusive_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:125</div></div>
 281 <div class="ttc" id="astructpicoboot__exec2__cmd_html"><div class="ttname"><a href="structpicoboot__exec2__cmd.html">picoboot_exec2_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:112</div></div>
 282 <div class="ttc" id="astructpicoboot__get__info__cmd_html"><div class="ttname"><a href="structpicoboot__get__info__cmd.html">picoboot_get_info_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:136</div></div>
 283 <div class="ttc" id="astructpicoboot__otp__cmd_html"><div class="ttname"><a href="structpicoboot__otp__cmd.html">picoboot_otp_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:129</div></div>
 284 <div class="ttc" id="astructpicoboot__range__cmd_html"><div class="ttname"><a href="structpicoboot__range__cmd.html">picoboot_range_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:107</div></div>
 285 <div class="ttc" id="astructpicoboot__reboot2__cmd_html"><div class="ttname"><a href="structpicoboot__reboot2__cmd.html">picoboot_reboot2_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:94</div></div>
 286 <div class="ttc" id="astructpicoboot__reboot__cmd_html"><div class="ttname"><a href="structpicoboot__reboot__cmd.html">picoboot_reboot_cmd</a></div><div class="ttdef"><b>Definition:</b> picoboot.h:86</div></div>
 287 </div><!-- fragment --></div><!-- contents -->
 288 </div><!-- doc-content -->
 289
 290         <script src="main.js"></script>
 291 </body>
 292 </html>