web/docs/picobin_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/picobin.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('picobin_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">picobin.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="picobin_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_PICOBIN_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _BOOT_PICOBIN_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">#ifndef NO_PICO_PLATFORM</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="platform_8h.html">pico/platform.h</a>&quot;</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#else</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#ifndef _u</span></div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#define _u(x) x ## u</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#endif</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="comment">// these are designed to not look like (likely) 16/32-bit ARM or RISC-V instructions or look like valid pointers</span></div>
 126 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#define PICOBIN_BLOCK_MARKER_START _u(0xffffded3)</span></div>
 127 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#define PICOBIN_BLOCK_MARKER_END   _u(0xab123579)</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="preprocessor">#define PICOBIN_MAX_BLOCK_SIZE _u(0x280)</span></div>
 130 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#define PICOBIN_MAX_IMAGE_DEF_BLOCK_SIZE _u(0x180)</span></div>
 131 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#define PICOBIN_MAX_PARTITION_TABLE_BLOCK_SIZE _u(0x280)</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">// note bit 6 is used to make parity even</span></div>
 134 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_NEXT_BLOCK_OFFSET        _u(0x41)</span></div>
 135 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_IMAGE_TYPE               _u(0x42)</span></div>
 136 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_VECTOR_TABLE             _u(0x03)</span></div>
 137 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_ENTRY_POINT              _u(0x44)</span></div>
 138 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_ROLLING_WINDOW_DELTA     _u(0x05)</span></div>
 139 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_LOAD_MAP                     _u(0x06)</span></div>
 140 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_HASH_DEF                 _u(0x47)</span></div>
 141 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_1BS_VERSION                  _u(0x48)</span></div>
 142 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_SIGNATURE                    _u(0x09)</span></div>
 143 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_PARTITION_TABLE              _u(0x0a)</span></div>
 144 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_HASH_VALUE                   _u(0x4b)</span></div>
 145 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_SALT                         _u(0x0c)</span></div>
 146 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
 147 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_2BS_IGNORED          (_u(0x80) | _u(0x7e))</span></div>
 148 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#define PICOBIN_BLOCK_ITEM_2BS_LAST             (_u(0x80) | _u(0x7f))</span></div>
 149 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
 150 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">// ----</span></div>
 151 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
 152 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#define PICOBIN_INDEX_TO_BITS(y, x) (y ## _ ## x &lt;&lt; y ## _LSB)</span></div>
 153 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
 154 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_IMAGE_TYPE_LSB            _u(0)</span></div>
 155 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_IMAGE_TYPE_BITS           _u(0x000f)</span></div>
 156 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_IMAGE_TYPE_INVALID        _u(0x0)</span></div>
 157 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_IMAGE_TYPE_EXE            _u(0x1)</span></div>
 158 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_IMAGE_TYPE_DATA           _u(0x2)</span></div>
 159 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_IMAGE_TYPE_AS_BITS(x) PICOBIN_INDEX_TO_BITS(PICOBIN_IMAGE_TYPE_IMAGE_TYPE, x)</span></div>
 160 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
 161 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_SECURITY_LSB          _u(4)</span></div>
 162 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_SECURITY_BITS         _u(0x0030)</span></div>
 163 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_SECURITY_UNSPECIFIED  _u(0x0)</span></div>
 164 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_SECURITY_NS           _u(0x1)</span></div>
 165 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_SECURITY_S            _u(0x2)</span></div>
 166 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_SECURITY_AS_BITS(x) PICOBIN_INDEX_TO_BITS(PICOBIN_IMAGE_TYPE_EXE_SECURITY, x)</span></div>
 167 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
 168 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CPU_LSB               _u(8)</span></div>
 169 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CPU_BITS              _u(0x0700)</span></div>
 170 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CPU_ARM               _u(0)</span></div>
 171 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CPU_RISCV             _u(1)</span></div>
 172 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CPU_VARMULET          _u(2)</span></div>
 173 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CPU_AS_BITS(x) PICOBIN_INDEX_TO_BITS(PICOBIN_IMAGE_TYPE_EXE_CPU, x)</span></div>
 174 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
 175 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CHIP_LSB              _u(12)</span></div>
 176 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CHIP_BITS             _u(0x7000)</span></div>
 177 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CHIP_RP2040           _u(0)</span></div>
 178 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CHIP_RP2350           _u(1)</span></div>
 179 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_CHIP_AS_BITS(x) PICOBIN_INDEX_TO_BITS(PICOBIN_IMAGE_TYPE_EXE_CHIP, x)</span></div>
 180 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
 181 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="preprocessor">#define PICOBIN_IMAGE_TYPE_EXE_TBYB_BITS             _u(0x8000)</span></div>
 182 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span> </div>
 183 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">// todo assert no overlap ^</span></div>
 184 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
 185 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSIONS_LSB                                   _u(26)</span></div>
 186 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSIONS_BITS                                  _u(0xfc000000)</span></div>
 187 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
 188 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSION_S_R_BITS                               _u(0x04000000)</span></div>
 189 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSION_S_W_BITS                               _u(0x08000000)</span></div>
 190 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSION_NS_R_BITS                              _u(0x10000000)</span></div>
 191 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSION_NS_W_BITS                              _u(0x20000000)</span></div>
 192 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSION_NSBOOT_R_BITS                          _u(0x40000000)</span></div>
 193 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="preprocessor">#define PICOBIN_PARTITION_PERMISSION_NSBOOT_W_BITS                          _u(0x80000000)</span></div>
 194 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span> </div>
 195 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="preprocessor">#define PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_LSB                         _u(0)</span></div>
 196 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="preprocessor">#define PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_BITS                        _u(0x00001fff)</span></div>
 197 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="preprocessor">#define PICOBIN_PARTITION_LOCATION_LAST_SECTOR_LSB                          _u(13)</span></div>
 198 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="preprocessor">#define PICOBIN_PARTITION_LOCATION_LAST_SECTOR_BITS                         _u(0x03ffe000)</span></div>
 199 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
 200 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_HAS_ID_BITS                                 _u(0x00000001)</span></div>
 201 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_TYPE_LSB                               _u(1)</span></div>
 202 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_TYPE_BITS                              _u(0x00000006)</span></div>
 203 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_VALUE_LSB                              _u(3)</span></div>
 204 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_VALUE_BITS                             _u(0x00000078)</span></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><span class="preprocessor">#define PICOBIN_PARTITION_MAX_EXTRA_FAMILIES                                _u(3)</span></div>
 207 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_LSB              _u(7)</span></div>
 208 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_BITS             _u(0x00000180)</span></div>
 209 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">// these are an optimization when booting in either ARM or RISC-V, to avoid looking at partitions</span></div>
 210 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">// which are known not to contain the right sort of binary, OR as a way to prevent</span></div>
 211 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">// auto-architecture-switch. NOTE: the first partition that can be booted, will be,</span></div>
 212 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">// so if you have a RISC-V binary in the first partition, and auto-arhcitecture-switch enabled, then</span></div>
 213 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">// even if booting under ARM, with an ARM binary in a later partition, the RISC-V binary</span></div>
 214 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">// will be booted by default; setting PICOBIN_PARTITION_FLAGS_IGNORED_DURING_ARM_BOOT_BITS</span></div>
 215 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">// on the partition, will have the RISC-V binary containing partition ignored under ARM</span></div>
 216 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">// boot</span></div>
 217 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_IGNORED_DURING_ARM_BOOT_BITS                _u(0x00000200)</span></div>
 218 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_IGNORED_DURING_RISCV_BOOT_BITS              _u(0x00000400)</span></div>
 219 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_UF2_DOWNLOAD_AB_NON_BOOTABLE_OWNER_AFFINITY _u(0x00000800)</span></div>
 220 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS                               _u(0x00001000)</span></div>
 221 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_UF2_DOWNLOAD_NO_REBOOT_BITS                 _u(0x00002000)</span></div>
 222 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">// we have a bit for each well known family-id .. note we expect there to be more in the future with new chips,</span></div>
 223 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">// but we have plenty of space for now.</span></div>
 224 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILIES_LSB                _u(14)</span></div>
 225 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2040_BITS          _u(0x00004000)</span></div>
 226 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_ABSOLUTE_BITS        _u(0x00008000)</span></div>
 227 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_DATA_BITS            _u(0x00010000)</span></div>
 228 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_S_BITS    _u(0x00020000)</span></div>
 229 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_RISCV_BITS    _u(0x00040000)</span></div>
 230 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_NS_BITS   _u(0x00080000)</span></div>
 231 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
 232 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_TYPE_NONE                        _u(0)</span></div>
 233 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_TYPE_A_PARTITION                 _u(1)</span></div>
 234 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_TYPE_OWNER_PARTITION             _u(2)</span></div>
 235 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="preprocessor">#define PICOBIN_PARTITION_FLAGS_LINK_TYPE_AS_BITS(x) PICOBIN_INDEX_TO_BITS(PICOBIN_PARTITION_FLAGS_LINK_TYPE, x)</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">  136</span> </div>
 238 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="preprocessor">#define PICOBIN_HASH_SHA256                    _u(0x01)</span></div>
 239 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span> </div>
 240 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="preprocessor">#define PICOBIN_SIGNATURE_SECP256K1            _u(0x01)</span></div>
 241 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
 242 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="preprocessor">#ifndef __ASSEMBLER__</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="preprocessor">#include &lt;stdbool.h&gt;</span></div>
 245 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
 246 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="structpicobin__load__map__entry.html">  145</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
 247 <div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>    <span class="comment">// these must all be word aligned</span></div>
 248 <div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>    uint32_t storage_address_rel;</div>
 249 <div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>    uint32_t runtime_address;</div>
 250 <div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>    uint32_t size;</div>
 251 <div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>} <a class="code hl_struct" href="structpicobin__load__map__entry.html">picobin_load_map_entry</a>;</div>
 252 <div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span> </div>
 253 <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"><a class="line" href="structpicobin__load__map.html">  152</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
 254 <div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>    uint32_t header;</div>
 255 <div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>    <a class="code hl_struct" href="structpicobin__load__map__entry.html">picobin_load_map_entry</a> entries[];</div>
 256 <div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>} <a class="code hl_struct" href="structpicobin__load__map.html">picobin_load_map</a>;</div>
 257 <div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span> </div>
 258 <div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> picobin_load_map_entry_count(<span class="keyword">const</span> <a class="code hl_struct" href="structpicobin__load__map.html">picobin_load_map</a> *lm) {</div>
 259 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>    <span class="keywordflow">return</span> (lm-&gt;header &lt;&lt; 1) &gt;&gt; 25;</div>
 260 <div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>}</div>
 261 <div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span> </div>
 262 <div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> picobin_load_map_is_relative(<span class="keyword">const</span> <a class="code hl_struct" href="structpicobin__load__map.html">picobin_load_map</a> *lm) {</div>
 263 <div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>    <span class="keywordflow">return</span> (int32_t)lm-&gt;header &gt;= 0;</div>
 264 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>}</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="preprocessor">#endif</span></div>
 267 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span> </div>
 268 <div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="preprocessor">#endif</span></div>
 269 <div class="ttc" id="aplatform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></div></div>
 270 <div class="ttc" id="astructpicobin__load__map__entry_html"><div class="ttname"><a href="structpicobin__load__map__entry.html">picobin_load_map_entry</a></div><div class="ttdef"><b>Definition:</b> picobin.h:145</div></div>
 271 <div class="ttc" id="astructpicobin__load__map_html"><div class="ttname"><a href="structpicobin__load__map.html">picobin_load_map</a></div><div class="ttdef"><b>Definition:</b> picobin.h:152</div></div>
 272 </div><!-- fragment --></div><!-- contents -->
 273 </div><!-- doc-content -->
 274
 275         <script src="main.js"></script>
 276 </body>
 277 </html>