web/docs/uf2_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/uf2.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('uf2_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">uf2.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="uf2_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_UF2_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _BOOT_UF2_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;assert.h&gt;</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
 120 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#define UF2_MAGIC_START0 0x0A324655u</span></div>
 121 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#define UF2_MAGIC_START1 0x9E5D5157u</span></div>
 122 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#define UF2_MAGIC_END    0x0AB16F30u</span></div>
 123 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
 124 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#define UF2_FLAG_NOT_MAIN_FLASH     0x00000001u</span></div>
 125 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#define UF2_FLAG_FILE_CONTAINER     0x00001000u</span></div>
 126 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#define UF2_FLAG_FAMILY_ID_PRESENT  0x00002000u</span></div>
 127 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#define UF2_FLAG_MD5_PRESENT        0x00004000u</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 RP2040_FAMILY_ID            0xe48bff56u</span></div>
 130 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#define ABSOLUTE_FAMILY_ID          0xe48bff57u</span></div>
 131 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#define DATA_FAMILY_ID              0xe48bff58u</span></div>
 132 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#define RP2350_ARM_S_FAMILY_ID      0xe48bff59u</span></div>
 133 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#define RP2350_RISCV_FAMILY_ID      0xe48bff5au</span></div>
 134 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define RP2350_ARM_NS_FAMILY_ID     0xe48bff5bu</span></div>
 135 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">#define FAMILY_ID_MAX               0xe48bff5bu</span></div>
 136 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
 137 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
 138 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structuf2__block.html">   37</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structuf2__block.html">uf2_block</a> {</div>
 139 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>    <span class="comment">// 32 byte header</span></div>
 140 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    uint32_t magic_start0;</div>
 141 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>    uint32_t magic_start1;</div>
 142 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>    uint32_t flags;</div>
 143 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>    uint32_t target_addr;</div>
 144 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>    uint32_t payload_size;</div>
 145 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>    uint32_t block_no;</div>
 146 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>    uint32_t num_blocks;</div>
 147 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    uint32_t file_size; <span class="comment">// or familyID;</span></div>
 148 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    uint8_t  data[476];</div>
 149 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    uint32_t magic_end;</div>
 150 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</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="keyword">static_assert</span>(<span class="keyword">sizeof</span>(<span class="keyword">struct </span><a class="code hl_struct" href="structuf2__block.html">uf2_block</a>) == 512, <span class="stringliteral">&quot;uf2_block not sector sized&quot;</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">#endif</span></div>
 155 <div class="ttc" id="astructuf2__block_html"><div class="ttname"><a href="structuf2__block.html">uf2_block</a></div><div class="ttdef"><b>Definition:</b> uf2.h:37</div></div>
 156 </div><!-- fragment --></div><!-- contents -->
 157 </div><!-- doc-content -->
 158
 159         <script src="main.js"></script>
 160 </body>
 161 </html>