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">
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/pico/bootrom_constants.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"/>
27 <div class="navigation-mobile">
28 <div class="logo--mobile">
29 <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
31 <div class="navigation-toggle">
32 <span class="line-1"></span>
36 <span class="line-3"></span>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
42 <span style="display: inline-block; margin-top: 10px;">
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>
50 <!-- <div class="search">
52 <input type="search" name="search" id="search" placeholder="Search">
53 <input type="submit" value="Search">
56 <!-- Generated by Doxygen 1.9.4 -->
57 <script type="text/javascript">
58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
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&dn=expat.txt MIT */
67 initMenu('',true,false,'search.php','Search');
68 $(document).ready(function() { init_search(); });
72 <div id="main-nav"></div>
74 <div id="side-nav" class="ui-resizable side-nav-resizable">
76 <div id="nav-tree-contents">
77 <div id="nav-sync" class="sync"></div>
80 <div id="splitbar" style="-moz-user-select:none;"
81 class="ui-resizable-handle">
84 <script type="text/javascript">
85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
86 $(document).ready(function(){initNavTree('bootrom__constants_8h_source.html',''); initResizable(); });
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)">
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">
105 <div class="headertitle"><div class="title">bootrom_constants.h</div></div>
107 <div class="contents">
108 <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 _PICO_BOOTROM_CONSTANTS_H</span></div>
115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define _PICO_BOOTROM_CONSTANTS_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 "<a class="code" href="platform_8h.html">pico/platform.h</a>"</span></div>
119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#endif</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="comment">// ROOT ADDRESSES</span></div>
122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define BOOTROM_MAGIC_OFFSET 0x10</span></div>
123 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#define BOOTROM_FUNC_TABLE_OFFSET 0x14</span></div>
124 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#if PICO_RP2040</span></div>
125 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#define BOOTROM_DATA_TABLE_OFFSET 0x16</span></div>
126 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#endif</span></div>
127 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
128 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#if PICO_RP2040</span></div>
129 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define BOOTROM_VTABLE_OFFSET 0x00</span></div>
130 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#define BOOTROM_TABLE_LOOKUP_OFFSET 0x18</span></div>
131 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#else</span></div>
132 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">// todo remove this (or #ifdef it for A1/A2)</span></div>
133 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#define BOOTROM_IS_A2() ((*(volatile uint8_t *)0x13) == 2)</span></div>
134 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#define BOOTROM_WELL_KNOWN_PTR_SIZE (BOOTROM_IS_A2() ? 2 : 4)</span></div>
135 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#if defined(__riscv)</span></div>
136 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#define BOOTROM_ENTRY_OFFSET 0x7dfc</span></div>
137 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#define BOOTROM_TABLE_LOOKUP_ENTRY_OFFSET (BOOTROM_ENTRY_OFFSET - BOOTROM_WELL_KNOWN_PTR_SIZE)</span></div>
138 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#define BOOTROM_TABLE_LOOKUP_OFFSET (BOOTROM_ENTRY_OFFSET - BOOTROM_WELL_KNOWN_PTR_SIZE*2)</span></div>
139 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#else</span></div>
140 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#define BOOTROM_VTABLE_OFFSET 0x00</span></div>
141 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#define BOOTROM_TABLE_LOOKUP_OFFSET (BOOTROM_FUNC_TABLE_OFFSET + BOOTROM_WELL_KNOWN_PTR_SIZE)</span></div>
142 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
143 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#endif</span></div>
144 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
145 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#if !PICO_RP2040 || PICO_COMBINED_DOCS</span></div>
146 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
147 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#define BOOTROM_OK 0</span></div>
148 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">//#define BOOTROM_ERROR_TIMEOUT (-1)</span></div>
149 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">//#define BOOTROM_ERROR_GENERIC (-2)</span></div>
150 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">//#define BOOTROM_ERROR_NO_DATA (-3) // E.g. read from an empty buffer/FIFO</span></div>
151 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#define BOOTROM_ERROR_NOT_PERMITTED (-4) </span><span class="comment">// Permission violation e.g. write to read-only flash partition</span></div>
152 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#define BOOTROM_ERROR_INVALID_ARG (-5) </span><span class="comment">// Argument is outside of range of supported values`</span></div>
153 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">//#define BOOTROM_ERROR_IO (-6)</span></div>
154 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">//#define BOOTROM_ERROR_BADAUTH (-7)</span></div>
155 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">//#define BOOTROM_ERROR_CONNECT_FAILED (-8)</span></div>
156 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">//#define BOOTROM_ERROR_INSUFFICIENT_RESOURCES (-9) // Dynamic allocation of resources failed</span></div>
157 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#define BOOTROM_ERROR_INVALID_ADDRESS (-10) </span><span class="comment">// Address argument was out-of-bounds or was determined to be an address that the caller may not access</span></div>
158 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#define BOOTROM_ERROR_BAD_ALIGNMENT (-11) </span><span class="comment">// Address modulo transfer chunk size was nonzero (e.g. word-aligned transfer with address % 4 != 0)</span></div>
159 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#define BOOTROM_ERROR_INVALID_STATE (-12) </span><span class="comment">// Something happened or failed to happen in the past, and consequently we (currently) can't service the request</span></div>
160 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#define BOOTROM_ERROR_BUFFER_TOO_SMALL (-13) </span><span class="comment">// A user-allocated buffer was too small to hold the result or working state of this function</span></div>
161 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#define BOOTROM_ERROR_PRECONDITION_NOT_MET (-14) </span><span class="comment">// This call failed because another ROM function must be called first</span></div>
162 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#define BOOTROM_ERROR_MODIFIED_DATA (-15) </span><span class="comment">// Cached data was determined to be inconsistent with the full version of the data it was calculated from</span></div>
163 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#define BOOTROM_ERROR_INVALID_DATA (-16) </span><span class="comment">// A data structure failed to validate</span></div>
164 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#define BOOTROM_ERROR_NOT_FOUND (-17) </span><span class="comment">// Attempted to access something that does not exist; or, a search failed</span></div>
165 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#define BOOTROM_ERROR_UNSUPPORTED_MODIFICATION (-18) </span><span class="comment">// Write is impossible based on previous writes; e.g. attempted to clear an OTP bit</span></div>
166 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#define BOOTROM_ERROR_LOCK_REQUIRED (-19) </span><span class="comment">// A required lock is not owned</span></div>
167 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#define BOOTROM_ERROR_LAST (-19)</span></div>
168 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
169 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#define RT_FLAG_FUNC_RISCV 0x0001</span></div>
170 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#define RT_FLAG_FUNC_RISCV_FAR 0x0003</span></div>
171 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#define RT_FLAG_FUNC_ARM_SEC 0x0004</span></div>
172 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">// reserved for 32-bit pointer: 0x0008</span></div>
173 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#define RT_FLAG_FUNC_ARM_NONSEC 0x0010</span></div>
174 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment">// reserved for 32-bit pointer: 0x0020</span></div>
175 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#define RT_FLAG_DATA 0x0040</span></div>
176 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">// reserved for 32-bit pointer: 0x0080</span></div>
177 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
178 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="preprocessor">#define PARTITION_TABLE_MAX_PARTITIONS 16</span></div>
179 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">// note this is deliberately > MAX_PARTITIONs is likely to be, and also -1 as a signed byte</span></div>
180 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="preprocessor">#define PARTITION_TABLE_NO_PARTITION_INDEX 0xff</span></div>
181 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
182 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">// todo these are duplicated in picoboot_constants.h</span></div>
183 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">// values 0-7 are secure/non-secure</span></div>
184 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="preprocessor">#define BOOT_TYPE_NORMAL 0</span></div>
185 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="preprocessor">#define BOOT_TYPE_BOOTSEL 2</span></div>
186 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#define BOOT_TYPE_RAM_IMAGE 3</span></div>
187 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="preprocessor">#define BOOT_TYPE_FLASH_UPDATE 4</span></div>
188 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
189 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">// values 8-15 are secure only</span></div>
190 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#define BOOT_TYPE_PC_SP 0xd</span></div>
191 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
192 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">// ORed in if a bootloader chained into the image</span></div>
193 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="preprocessor">#define BOOT_TYPE_CHAINED_FLAG 0x80</span></div>
194 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
195 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment">// call from NS to S</span></div>
196 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="preprocessor">#ifndef __riscv</span></div>
197 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#define BOOTROM_API_CALLBACK_secure_call 0</span></div>
198 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor">#endif</span></div>
199 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#define BOOTROM_API_CALLBACK_COUNT 1</span></div>
200 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
201 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#define BOOTROM_LOCK_SHA_256 0</span></div>
202 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="preprocessor">#define BOOTROM_LOCK_FLASH_OP 1</span></div>
203 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="preprocessor">#define BOOTROM_LOCK_OTP 2</span></div>
204 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#define BOOTROM_LOCK_MAX 2</span></div>
205 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
206 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="preprocessor">#define BOOTROM_LOCK_ENABLE 7</span></div>
207 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
208 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="preprocessor">#define BOOT_PARTITION_NONE (-1)</span></div>
209 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#define BOOT_PARTITION_SLOT0 (-2)</span></div>
210 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="preprocessor">#define BOOT_PARTITION_SLOT1 (-3)</span></div>
211 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="preprocessor">#define BOOT_PARTITION_WINDOW (-4)</span></div>
212 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
213 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_WINDOW_SEARCHED 0x01</span></div>
214 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">// note if both BOOT_DIAGNOSTIC_INVALID_BLOCK_LOOP and BOOT_DIAGNOSTIC_VALID_BLOCK_LOOP then the block loop was valid</span></div>
215 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment">// but it has a PARTITION_TABLE which while it passed the initial verification (and hash/sig) had invalid contents</span></div>
216 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment">// (discovered when it was later loaded)</span></div>
217 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_INVALID_BLOCK_LOOP 0x02</span></div>
218 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_VALID_BLOCK_LOOP 0x04</span></div>
219 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_VALID_IMAGE_DEF 0x08</span></div>
220 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_HAS_PARTITION_TABLE 0x10</span></div>
221 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_CONSIDERED 0x20</span></div>
222 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_CHOSEN 0x40</span></div>
223 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_PARTITION_TABLE_LSB 7</span></div>
224 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_PARTITION_TABLE_MATCHING_KEY_FOR_VERIFY 0x80</span></div>
225 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_PARTITION_TABLE_HASH_FOR_VERIFY 0x100</span></div>
226 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_PARTITION_TABLE_VERIFIED_OK 0x200</span></div>
227 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_IMAGE_DEF_LSB 10</span></div>
228 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_IMAGE_DEF_MATCHING_KEY_FOR_VERIFY 0x400</span></div>
229 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_IMAGE_DEF_HASH_FOR_VERIFY 0x800</span></div>
230 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_IMAGE_DEF_VERIFIED_OK 0x1000</span></div>
231 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
232 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_LOAD_MAP_ENTRIES_LOADED 0x2000</span></div>
233 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_IMAGE_LAUNCHED 0x4000</span></div>
234 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#define BOOT_DIAGNOSTIC_IMAGE_CONDITION_FAILURE 0x8000</span></div>
235 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
236 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="preprocessor">#define BOOT_PARSED_BLOCK_DIAGNOSTIC_MATCHING_KEY_FOR_VERIFY 0x1 </span><span class="comment">// if this is present and VERIFIED_OK isn't the sig check failed</span></div>
237 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="preprocessor">#define BOOT_PARSED_BLOCK_DIAGNOSTIC_HASH_FOR_VERIFY 0x2 </span><span class="comment">// if this is present and VERIFIED_OL isn't then hash check failed</span></div>
238 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="preprocessor">#define BOOT_PARSED_BLOCK_DIAGNOSTIC_VERIFIED_OK 0x4</span></div>
239 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
240 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="preprocessor">#define BOOT_TBYB_AND_UPDATE_FLAG_BUY_PENDING 0x1</span></div>
241 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="preprocessor">#define BOOT_TBYB_AND_UPDATE_FLAG_OTP_VERSION_APPLIED 0x2</span></div>
242 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="preprocessor">#define BOOT_TBYB_AND_UPDATE_FLAG_OTHER_ERASED 0x4</span></div>
243 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
244 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="preprocessor">#ifndef __ASSEMBLER__</span></div>
245 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment">// Limited to 3 arguments in case of varm multiplex hint (trashes Arm r3)</span></div>
246 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="keyword">typedef</span> int (*bootrom_api_callback_generic_t)(uint32_t r0, uint32_t r1, uint32_t r2);</div>
247 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="comment">// Return negative for error, else number of bytes transferred:</span></div>
248 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="comment">//typedef int (*bootrom_api_callback_stdout_put_blocking_t)(const uint8_t *buffer, uint32_t size);</span></div>
249 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="comment">//typedef int (*bootrom_api_callback_stdin_get_t)(uint8_t *buffer, uint32_t size);</span></div>
250 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="comment">//typedef void (*bootrom_api_callback_core1_security_setup_t)(void);</span></div>
251 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="preprocessor">#endif</span></div>
252 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
253 <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="preprocessor">#endif</span></div>
254 <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
255 <div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="group__pico__bootrom.html#ga5b3c93cbab0054e9938f2aca7261a73e"> 157</a></span><span class="preprocessor">#define ROM_TABLE_CODE(c1, c2) ((c1) | ((c2) << 8))</span></div>
256 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> </div>
257 <div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="comment">// ROM FUNCTIONS</span></div>
258 <div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
259 <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span><span class="comment">// RP2040 & RP2350</span></div>
260 <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="preprocessor">#define ROM_DATA_SOFTWARE_GIT_REVISION ROM_TABLE_CODE('G', 'R')</span></div>
261 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span><span class="preprocessor">#define ROM_FUNC_FLASH_ENTER_CMD_XIP ROM_TABLE_CODE('C', 'X')</span></div>
262 <div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span><span class="preprocessor">#define ROM_FUNC_FLASH_EXIT_XIP ROM_TABLE_CODE('E', 'X')</span></div>
263 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span><span class="preprocessor">#define ROM_FUNC_FLASH_FLUSH_CACHE ROM_TABLE_CODE('F', 'C')</span></div>
264 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span><span class="preprocessor">#define ROM_FUNC_CONNECT_INTERNAL_FLASH ROM_TABLE_CODE('I', 'F')</span></div>
265 <div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span><span class="preprocessor">#define ROM_FUNC_FLASH_RANGE_ERASE ROM_TABLE_CODE('R', 'E')</span></div>
266 <div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span><span class="preprocessor">#define ROM_FUNC_FLASH_RANGE_PROGRAM ROM_TABLE_CODE('R', 'P')</span></div>
267 <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
268 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div>
269 <div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span><span class="preprocessor">#if PICO_RP2040</span></div>
270 <div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span><span class="comment">// RP2040 only</span></div>
271 <div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span><span class="preprocessor">#define ROM_FUNC_MEMCPY44 ROM_TABLE_CODE('C', '4')</span></div>
272 <div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span><span class="preprocessor">#define ROM_DATA_COPYRIGHT ROM_TABLE_CODE('C', 'R')</span></div>
273 <div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span><span class="preprocessor">#define ROM_FUNC_CLZ32 ROM_TABLE_CODE('L', '3')</span></div>
274 <div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span><span class="preprocessor">#define ROM_FUNC_MEMCPY ROM_TABLE_CODE('M', 'C')</span></div>
275 <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span><span class="preprocessor">#define ROM_FUNC_MEMSET ROM_TABLE_CODE('M', 'S')</span></div>
276 <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span><span class="preprocessor">#define ROM_FUNC_POPCOUNT32 ROM_TABLE_CODE('P', '3')</span></div>
277 <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span><span class="preprocessor">#define ROM_FUNC_REVERSE32 ROM_TABLE_CODE('R', '3')</span></div>
278 <div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span><span class="preprocessor">#define ROM_FUNC_MEMSET4 ROM_TABLE_CODE('S', '4')</span></div>
279 <div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span><span class="preprocessor">#define ROM_FUNC_CTZ32 ROM_TABLE_CODE('T', '3')</span></div>
280 <div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span><span class="preprocessor">#define ROM_FUNC_RESET_USB_BOOT ROM_TABLE_CODE('U', 'B')</span></div>
281 <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span><span class="preprocessor">#endif</span></div>
282 <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
283 <div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span><span class="preprocessor">#if !PICO_RP2040 || PICO_COMBINED_DOCS</span></div>
284 <div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span><span class="comment">// RP2350 only</span></div>
285 <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span><span class="preprocessor">#define ROM_FUNC_PICK_AB_PARTITION ROM_TABLE_CODE('A', 'B')</span></div>
286 <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span><span class="preprocessor">#define ROM_FUNC_CHAIN_IMAGE ROM_TABLE_CODE('C', 'I')</span></div>
287 <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span><span class="preprocessor">#define ROM_FUNC_EXPLICIT_BUY ROM_TABLE_CODE('E', 'B')</span></div>
288 <div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span><span class="preprocessor">#define ROM_FUNC_FLASH_RUNTIME_TO_STORAGE_ADDR ROM_TABLE_CODE('F', 'A')</span></div>
289 <div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span><span class="preprocessor">#define ROM_DATA_FLASH_DEVINFO16_PTR ROM_TABLE_CODE('F', 'D')</span></div>
290 <div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span><span class="preprocessor">#define ROM_FUNC_FLASH_OP ROM_TABLE_CODE('F', 'O')</span></div>
291 <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="preprocessor">#define ROM_FUNC_GET_B_PARTITION ROM_TABLE_CODE('G', 'B')</span></div>
292 <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span><span class="preprocessor">#define ROM_FUNC_GET_PARTITION_TABLE_INFO ROM_TABLE_CODE('G', 'P')</span></div>
293 <div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span><span class="preprocessor">#define ROM_FUNC_GET_SYS_INFO ROM_TABLE_CODE('G', 'S')</span></div>
294 <div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span><span class="preprocessor">#define ROM_FUNC_GET_UF2_TARGET_PARTITION ROM_TABLE_CODE('G', 'U')</span></div>
295 <div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span><span class="preprocessor">#define ROM_FUNC_LOAD_PARTITION_TABLE ROM_TABLE_CODE('L', 'P')</span></div>
296 <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span><span class="preprocessor">#define ROM_FUNC_OTP_ACCESS ROM_TABLE_CODE('O', 'A')</span></div>
297 <div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span><span class="preprocessor">#define ROM_DATA_PARTITION_TABLE_PTR ROM_TABLE_CODE('P', 'T')</span></div>
298 <div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span><span class="preprocessor">#define ROM_FUNC_FLASH_RESET_ADDRESS_TRANS ROM_TABLE_CODE('R', 'A')</span></div>
299 <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span><span class="preprocessor">#define ROM_FUNC_REBOOT ROM_TABLE_CODE('R', 'B')</span></div>
300 <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span><span class="preprocessor">#define ROM_FUNC_SET_ROM_CALLBACK ROM_TABLE_CODE('R', 'C')</span></div>
301 <div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span><span class="preprocessor">#define ROM_FUNC_SECURE_CALL ROM_TABLE_CODE('S', 'C')</span></div>
302 <div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span><span class="preprocessor">#define ROM_FUNC_SET_NS_API_PERMISSION ROM_TABLE_CODE('S', 'P')</span></div>
303 <div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span><span class="preprocessor">#define ROM_FUNC_BOOTROM_STATE_RESET ROM_TABLE_CODE('S', 'R')</span></div>
304 <div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span><span class="preprocessor">#define ROM_FUNC_SET_BOOTROM_STACK ROM_TABLE_CODE('S', 'S')</span></div>
305 <div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span><span class="preprocessor">#define ROM_DATA_SAVED_XIP_SETUP_FUNC_PTR ROM_TABLE_CODE('X', 'F')</span></div>
306 <div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span><span class="preprocessor">#define ROM_FUNC_FLASH_SELECT_XIP_READ_MODE ROM_TABLE_CODE('X', 'M')</span></div>
307 <div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span><span class="preprocessor">#define ROM_FUNC_VALIDATE_NS_BUFFER ROM_TABLE_CODE('V', 'B')</span></div>
308 <div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span><span class="preprocessor">#endif</span></div>
309 <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> </div>
310 <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span><span class="comment">// these form a bit set</span></div>
311 <div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span><span class="preprocessor">#define BOOTROM_STATE_RESET_CURRENT_CORE 0x01</span></div>
312 <div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span><span class="preprocessor">#define BOOTROM_STATE_RESET_OTHER_CORE 0x02</span></div>
313 <div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span><span class="preprocessor">#define BOOTROM_STATE_RESET_GLOBAL_STATE 0x04 </span><span class="comment">// reset any global state (e.g. permissions)</span></div>
314 <div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div>
315 <div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span><span class="comment">// partition level stuff is returned first (note PT_INFO flags is only 16 bits)</span></div>
316 <div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> </div>
317 <div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span><span class="comment">// 3 words: pt_count, unpartitioned_perm_loc, unpartioned_perm_flags</span></div>
318 <div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span><span class="preprocessor">#define PT_INFO_PT_INFO 0x0001</span></div>
319 <div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span><span class="preprocessor">#define PT_INFO_SINGLE_PARTITION 0x8000 </span><span class="comment">// marker to just include a single partition in the results)</span></div>
320 <div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> </div>
321 <div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span><span class="comment">// then in order per partition selected</span></div>
322 <div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
323 <div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span><span class="comment">// 2 words: unpartitioned_perm_loc, unpartioned_perm_flags</span></div>
324 <div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span><span class="preprocessor">#define PT_INFO_PARTITION_LOCATION_AND_FLAGS 0x0010</span></div>
325 <div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span><span class="comment">// 2 words: id lsb first</span></div>
326 <div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span><span class="preprocessor">#define PT_INFO_PARTITION_ID 0x0020</span></div>
327 <div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span><span class="comment">// n+1 words: n, family_id...</span></div>
328 <div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span><span class="preprocessor">#define PT_INFO_PARTITION_FAMILY_IDS 0x0040</span></div>
329 <div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span><span class="comment">// (n+3)/4 words... bytes are: n (len), c0, c1, ... cn-1 padded to word boundary with zeroes</span></div>
330 <div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span><span class="preprocessor">#define PT_INFO_PARTITION_NAME 0x0080</span></div>
331 <div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
332 <div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span><span class="comment">// items are returned in order</span></div>
333 <div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span><span class="comment">// 3 words package_id, device_id, wafer_id</span></div>
334 <div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span><span class="preprocessor">#define SYS_INFO_CHIP_INFO 0x0001</span></div>
335 <div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span><span class="comment">// 1 word: chip specific critical bits</span></div>
336 <div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span><span class="preprocessor">#define SYS_INFO_CRITICAL 0x0002</span></div>
337 <div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span><span class="comment">// 1 word: bytes: cpu_type, supported_cpu_type_bitfield</span></div>
338 <div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span><span class="preprocessor">#define SYS_INFO_CPU_INFO 0x0004</span></div>
339 <div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span><span class="comment">// 1 word: same as FLASH_DEVINFO row in OTP</span></div>
340 <div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span><span class="preprocessor">#define SYS_INFO_FLASH_DEV_INFO 0x0008</span></div>
341 <div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span><span class="comment">// 4 words</span></div>
342 <div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span><span class="preprocessor">#define SYS_INFO_BOOT_RANDOM 0x0010</span></div>
343 <div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span><span class="comment">// 2 words lsb first</span></div>
344 <div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span><span class="preprocessor">#define SYS_INFO_NONCE 0x0020</span></div>
345 <div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span><span class="comment">// 4 words boot_info, boot_diagnostic, boot_param0, boot_param1</span></div>
346 <div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span><span class="preprocessor">#define SYS_INFO_BOOT_INFO 0x0040</span></div>
347 <div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> </div>
348 <div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span><span class="preprocessor">#define BOOTROM_NS_API_get_sys_info 0</span></div>
349 <div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span><span class="preprocessor">#define BOOTROM_NS_API_checked_flash_op 1</span></div>
350 <div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span><span class="preprocessor">#define BOOTROM_NS_API_flash_runtime_to_storage_addr 2</span></div>
351 <div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span><span class="preprocessor">#define BOOTROM_NS_API_get_partition_table_info 3</span></div>
352 <div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span><span class="preprocessor">#define BOOTROM_NS_API_secure_call 4</span></div>
353 <div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span><span class="preprocessor">#define BOOTROM_NS_API_otp_access 5</span></div>
354 <div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span><span class="preprocessor">#define BOOTROM_NS_API_reboot 6</span></div>
355 <div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span><span class="preprocessor">#define BOOTROM_NS_API_get_b_partition 7</span></div>
356 <div class="line"><a id="l00258" name="l00258"></a><span class="lineno"> 258</span><span class="preprocessor">#define BOOTROM_NS_API_COUNT 8</span></div>
357 <div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> </div>
358 <div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span><span class="preprocessor">#ifndef __ASSEMBLER__</span></div>
359 <div class="line"><a id="l00261" name="l00261"></a><span class="lineno"> 261</span> </div>
360 <div class="line"><a id="l00262" name="l00262"></a><span class="lineno"><a class="line" href="structresident__partition__t.html"> 262</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
361 <div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> uint32_t permissions_and_location;</div>
362 <div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> uint32_t permissions_and_flags;</div>
363 <div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span>} <a class="code hl_struct" href="structresident__partition__t.html">resident_partition_t</a>;</div>
364 <div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span><span class="keyword">static_assert</span>(<span class="keyword">sizeof</span>(<a class="code hl_struct" href="structresident__partition__t.html">resident_partition_t</a>) == 8, <span class="stringliteral">""</span>);</div>
365 <div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> </div>
366 <div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span><span class="preprocessor">#define OTP_CMD_ROW_BITS 0x0000ffffu</span></div>
367 <div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span><span class="preprocessor">#define OTP_CMD_ROW_LSB 0u</span></div>
368 <div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span><span class="preprocessor">#define OTP_CMD_WRITE_BITS 0x00010000u</span></div>
369 <div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span><span class="preprocessor">#define OTP_CMD_ECC_BITS 0x00020000u</span></div>
370 <div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> </div>
371 <div class="line"><a id="l00273" name="l00273"></a><span class="lineno"><a class="line" href="structotp__cmd.html"> 273</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structotp__cmd.html">otp_cmd</a> {</div>
372 <div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> uint32_t flags;</div>
373 <div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span>} <a class="code hl_struct" href="structotp__cmd.html">otp_cmd_t</a>;</div>
374 <div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> </div>
375 <div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
376 <div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> BOOTROM_XIP_MODE_03H_SERIAL = 0,</div>
377 <div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> BOOTROM_XIP_MODE_0BH_SERIAL,</div>
378 <div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> BOOTROM_XIP_MODE_BBH_DUAL,</div>
379 <div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> BOOTROM_XIP_MODE_EBH_QUAD,</div>
380 <div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> BOOTROM_XIP_MODE_N_MODES</div>
381 <div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span>} bootrom_xip_mode_t;</div>
382 <div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> </div>
383 <div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span><span class="comment">// The checked flash API wraps the low-level flash routines from generic_flash, adding bounds</span></div>
384 <div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span><span class="comment">// checking, permission checking against the resident partition table, and simple address</span></div>
385 <div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span><span class="comment">// translation. The low-level API deals with flash offsets (i.e. distance from the start of the</span></div>
386 <div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span><span class="comment">// first flash device, measured in bytes) but the checked flash API accepts one of two types of</span></div>
387 <div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span><span class="comment">// address:</span></div>
388 <div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span><span class="comment">//</span></div>
389 <div class="line"><a id="l00291" name="l00291"></a><span class="lineno"> 291</span><span class="comment">// - Flash runtime addresses: the address of some flash-resident data or code in the currently</span></div>
390 <div class="line"><a id="l00292" name="l00292"></a><span class="lineno"> 292</span><span class="comment">// running image. The flash addresses your binary is "linked at" by the linker.</span></div>
391 <div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span><span class="comment">// - Flash storage addresses: a flash offset, plus the address base where QSPI hardware is first</span></div>
392 <div class="line"><a id="l00294" name="l00294"></a><span class="lineno"> 294</span><span class="comment">// mapped on the system bus (XIP_BASE constant from addressmap.h)</span></div>
393 <div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span><span class="comment">//</span></div>
394 <div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span><span class="comment">// These addresses are one and the same *if* the currently running program is stored at the</span></div>
395 <div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span><span class="comment">// beginning of flash. They are different if the start of your image has been "rolled" by the flash</span></div>
396 <div class="line"><a id="l00298" name="l00298"></a><span class="lineno"> 298</span><span class="comment">// boot path to make it appear at the address it was linked at even though it is stored at a</span></div>
397 <div class="line"><a id="l00299" name="l00299"></a><span class="lineno"> 299</span><span class="comment">// different location in flash, which is necessary when you have A/B images for example.</span></div>
398 <div class="line"><a id="l00300" name="l00300"></a><span class="lineno"> 300</span><span class="comment">//</span></div>
399 <div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span><span class="comment">// The address translation between flash runtime and flash storage addresses is configured in</span></div>
400 <div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span><span class="comment">// hardware by the QMI_ATRANSx registers, and this API assumes those registers contain a valid</span></div>
401 <div class="line"><a id="l00303" name="l00303"></a><span class="lineno"> 303</span><span class="comment">// address mapping which it can use to translate runtime to storage addresses.</span></div>
402 <div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span> </div>
403 <div class="line"><a id="l00305" name="l00305"></a><span class="lineno"><a class="line" href="structcflash__flags.html"> 305</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structcflash__flags.html">cflash_flags</a> {</div>
404 <div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span> uint32_t flags;</div>
405 <div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span>} <a class="code hl_struct" href="structcflash__flags.html">cflash_flags_t</a>;</div>
406 <div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> </div>
407 <div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span><span class="comment">// Bits which are permitted to be set in a flags variable -- any other bits being set is an error</span></div>
408 <div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span><span class="preprocessor">#define CFLASH_FLAGS_BITS 0x00070301u</span></div>
409 <div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> </div>
410 <div class="line"><a id="l00312" name="l00312"></a><span class="lineno"> 312</span><span class="comment">// Used to tell checked flash API which space a given address belongs to</span></div>
411 <div class="line"><a id="l00313" name="l00313"></a><span class="lineno"> 313</span><span class="preprocessor">#define CFLASH_ASPACE_BITS 0x00000001u</span></div>
412 <div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span><span class="preprocessor">#define CFLASH_ASPACE_LSB 0u</span></div>
413 <div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span><span class="preprocessor">#define CFLASH_ASPACE_VALUE_STORAGE 0u</span></div>
414 <div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span><span class="preprocessor">#define CFLASH_ASPACE_VALUE_RUNTIME 1u</span></div>
415 <div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span> </div>
416 <div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span><span class="comment">// Used to tell checked flash APIs the effective security level of a flash access (may be forced to</span></div>
417 <div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span><span class="comment">// one of these values for the NonSecure-exported version of this API)</span></div>
418 <div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span><span class="preprocessor">#define CFLASH_SECLEVEL_BITS 0x00000300u</span></div>
419 <div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span><span class="preprocessor">#define CFLASH_SECLEVEL_LSB 8u</span></div>
420 <div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span><span class="comment">// Zero is not a valid security level:</span></div>
421 <div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span><span class="preprocessor">#define CFLASH_SECLEVEL_VALUE_SECURE 1u</span></div>
422 <div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span><span class="preprocessor">#define CFLASH_SECLEVEL_VALUE_NONSECURE 2u</span></div>
423 <div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span><span class="preprocessor">#define CFLASH_SECLEVEL_VALUE_BOOTLOADER 3u</span></div>
424 <div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> </div>
425 <div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span><span class="preprocessor">#define CFLASH_OP_BITS 0x00070000u</span></div>
426 <div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span><span class="preprocessor">#define CFLASH_OP_LSB 16u</span></div>
427 <div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span><span class="comment">// Erase size_bytes bytes of flash, starting at address addr. Both addr and size_bytes must be a</span></div>
428 <div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span><span class="comment">// multiple of 4096 bytes (one flash sector).</span></div>
429 <div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span><span class="preprocessor">#define CFLASH_OP_VALUE_ERASE 0u</span></div>
430 <div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span><span class="comment">// Program size_bytes bytes of flash, starting at address addr. Both addr and size_bytes must be a</span></div>
431 <div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span><span class="comment">// multiple of 256 bytes (one flash page).</span></div>
432 <div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span><span class="preprocessor">#define CFLASH_OP_VALUE_PROGRAM 1u</span></div>
433 <div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span><span class="comment">// Read size_bytes bytes of flash, starting at address addr. There are no alignment restrictions on</span></div>
434 <div class="line"><a id="l00336" name="l00336"></a><span class="lineno"> 336</span><span class="comment">// addr or size_bytes.</span></div>
435 <div class="line"><a id="l00337" name="l00337"></a><span class="lineno"> 337</span><span class="preprocessor">#define CFLASH_OP_VALUE_READ 2u</span></div>
436 <div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span><span class="preprocessor">#define CFLASH_OP_MAX 2u</span></div>
437 <div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span> </div>
438 <div class="line"><a id="l00340" name="l00340"></a><span class="lineno"> 340</span><span class="preprocessor">#endif</span></div>
439 <div class="line"><a id="l00341" name="l00341"></a><span class="lineno"> 341</span> </div>
440 <div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span><span class="preprocessor">#endif</span></div>
441 <div class="ttc" id="aplatform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></div></div>
442 <div class="ttc" id="astructcflash__flags_html"><div class="ttname"><a href="structcflash__flags.html">cflash_flags</a></div><div class="ttdef"><b>Definition:</b> bootrom_constants.h:305</div></div>
443 <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>
444 <div class="ttc" id="astructresident__partition__t_html"><div class="ttname"><a href="structresident__partition__t.html">resident_partition_t</a></div><div class="ttdef"><b>Definition:</b> bootrom_constants.h:262</div></div>
445 </div><!-- fragment --></div><!-- contents -->
446 </div><!-- doc-content -->
448 <script src="main.js"></script>
projects / pico-vscode.git / blob