web/docs/group__pico__runtime__init.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: pico_runtime_init</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('group__pico__runtime__init.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="summary">
 106 <a href="#func-members">Functions</a>  </div>
 107   <div class="headertitle"><div class="title">pico_runtime_init<div class="ingroups"><a class="el" href="group__runtime.html">Runtime Infrastructure</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>Main runtime initialization functions required to set up the runtime environment before entering main.
 112 <a href="#details">More...</a></p>
 113 <table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 115 Functions</h2></td></tr>
 116 <tr class="memitem:gac415ea9c7e62071c4f7629ae240833f3"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__runtime__init.html#gac415ea9c7e62071c4f7629ae240833f3">clocks_init</a> (void)</td></tr>
 117 <tr class="memdesc:gac415ea9c7e62071c4f7629ae240833f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the clock hardware.  <a href="group__pico__runtime__init.html#gac415ea9c7e62071c4f7629ae240833f3">More...</a><br /></td></tr>
 118 <tr class="separator:gac415ea9c7e62071c4f7629ae240833f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 </table>
 120 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 121 <p >Main runtime initialization functions required to set up the runtime environment before entering main. </p>
 122 <p >The runtime initialization is registration based:</p>
 123 <p >For each step of the initialization there is a 5 digit ordinal which indicates the ordering (alphabetic increasing sort of the 5 digits) of the steps.</p>
 124 <p >e.g. for the step "bootrom_reset", there is:</p>
 125 <div class="fragment"><div class="line"><span class="preprocessor">#ifndef PICO_RUNTIME_INIT_BOOTROM_RESET</span></div>
 126 <div class="line"><span class="preprocessor">#define PICO_RUNTIME_INIT_BOOTROM_RESET   &quot;00050&quot;</span></div>
 127 <div class="line"><span class="preprocessor">#endif</span></div>
 128 </div><!-- fragment --><p >The user can override the order if they wish, by redefining PICO_RUNTIME_INIT_BOOTROM_RESET</p>
 129 <p >For each step, the automatic initialization may be skipped by defining (in this case) PICO_RUNTIME_SKIP_INIT_BOOTROM_RESET = 1. The user can then choose to either omit the step completely or register their own replacement initialization.</p>
 130 <p >The default method used to perform the initialization is provided, in case the user wishes to call it manually; in this case:</p>
 131 <div class="fragment"><div class="line"><span class="keywordtype">void</span> runtime_init_bootrom_reset(<span class="keywordtype">void</span>);</div>
 132 </div><!-- fragment --><p >If PICO_RUNTIME_NO_INIT_BOOTOROM_RESET define is set (NO vs SKIP above), then the function is not defined, allowing the user to provide a replacement (and also avoiding cases where the default implementation won't compile due to missing dependencies) </p>
 133 <h2 class="groupheader">Function Documentation</h2>
 134 <a id="gac415ea9c7e62071c4f7629ae240833f3" name="gac415ea9c7e62071c4f7629ae240833f3"></a>
 135 <h2 class="memtitle"><span class="permalink"><a href="#gac415ea9c7e62071c4f7629ae240833f3">&#9670;&nbsp;</a></span>clocks_init()</h2>
 136
 137 <div class="memitem">
 138 <div class="memproto">
 139 <table class="mlabels">
 140   <tr>
 141   <td class="mlabels-left">
 142       <table class="memname">
 143         <tr>
 144           <td class="memname">static void clocks_init </td>
 145           <td>(</td>
 146           <td class="paramtype">void&#160;</td>
 147           <td class="paramname"></td><td>)</td>
 148           <td></td>
 149         </tr>
 150       </table>
 151   </td>
 152   <td class="mlabels-right">
 153 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 154   </tr>
 155 </table>
 156 </div><div class="memdoc">
 157
 158 <p>Initialise the clock hardware. </p>
 159 <p >Must be called before any other clock function. </p>
 160
 161 </div>
 162 </div>
 163 </div><!-- contents -->
 164 </div><!-- doc-content -->
 165
 166         <script src="main.js"></script>
 167 </body>
 168 </html>