web/docs/stdlib_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: pico_stdlib/include/pico/stdlib.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                                 v1.5.1
  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('stdlib_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">stdlib.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="stdlib_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 _PICO_STDLIB_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_STDLIB_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 &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</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="stdio_8h.html">pico/stdio.h</a>&quot;</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;<a class="code" href="time_8h.html">pico/time.h</a>&quot;</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#include &quot;<a class="code" href="gpio_8h.html">hardware/gpio.h</a>&quot;</span></div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &quot;<a class="code" href="rp2__common_2hardware__uart_2include_2hardware_2uart_8h.html">hardware/uart.h</a>&quot;</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
 123 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 124 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 125 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="preprocessor">#endif</span></div>
 126 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
 127 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">// Note PICO_STDIO_UART, PICO_STDIO_USB, PICO_STDIO_SEMIHOSTING are set by the</span></div>
 128 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">// respective INTERFACE libraries, so these defines are set if the library</span></div>
 129 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">// is included for the target executable</span></div>
 130 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
 131 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#if LIB_PICO_STDIO_UART</span></div>
 132 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#include &quot;pico/stdio_uart.h&quot;</span></div>
 133 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">#endif</span></div>
 134 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
 135 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#if LIB_PICO_STDIO_USB</span></div>
 136 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">#include &quot;pico/stdio_usb.h&quot;</span></div>
 137 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#endif</span></div>
 138 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
 139 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#if LIB_PICO_STDIO_SEMIHOSTING</span></div>
 140 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#include &quot;pico/stdio_semihosting.h&quot;</span></div>
 141 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#endif</span></div>
 142 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
 143 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">// PICO_CONFIG: PICO_DEFAULT_LED_PIN, Optionally define a pin that drives a regular LED on the board, group=pico_stdlib</span></div>
 144 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
 145 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">// PICO_CONFIG: PICO_DEFAULT_LED_PIN_INVERTED, 1 if LED is inverted or 0 if not, type=int, default=0, group=pico_stdlib</span></div>
 146 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#ifndef PICO_DEFAULT_LED_PIN_INVERTED</span></div>
 147 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#define PICO_DEFAULT_LED_PIN_INVERTED 0</span></div>
 148 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#endif</span></div>
 149 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
 150 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">// PICO_CONFIG: PICO_DEFAULT_WS2812_PIN, Optionally define a pin that controls data to a WS2812 compatible LED on the board, group=pico_stdlib</span></div>
 151 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">// PICO_CONFIG: PICO_DEFAULT_WS2812_POWER_PIN, Optionally define a pin that controls power to a WS2812 compatible LED on the board, group=pico_stdlib</span></div>
 152 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
 153 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdlib.html#gacf31cd777510116d829aea040b034c4c">setup_default_uart</a>(<span class="keywordtype">void</span>);</div>
 154 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
 155 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdlib.html#ga89efe34eab0b8b96954eb0e19a38c8be">set_sys_clock_48mhz</a>(<span class="keywordtype">void</span>);</div>
 156 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
 157 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdlib.html#ga44d5e0845d4f75f3b0c97c733e39f4c8">set_sys_clock_pll</a>(uint32_t vco_freq, uint post_div1, uint post_div2);</div>
 158 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
 159 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdlib.html#ga8553a9d91b581e0d3dbccd8d83b1a1b9">check_sys_clock_khz</a>(uint32_t freq_khz, uint *vco_freq_out, uint *post_div1_out, uint *post_div2_out);</div>
 160 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span> </div>
 161 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="group__pico__stdlib.html#gab3a273e837ba1947bb5fd8fc97cf47e5">  126</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdlib.html#gab3a273e837ba1947bb5fd8fc97cf47e5">set_sys_clock_khz</a>(uint32_t freq_khz, <span class="keywordtype">bool</span> required) {</div>
 162 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>    uint vco, postdiv1, postdiv2;</div>
 163 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>    <span class="keywordflow">if</span> (<a class="code hl_function" href="group__pico__stdlib.html#ga8553a9d91b581e0d3dbccd8d83b1a1b9">check_sys_clock_khz</a>(freq_khz, &amp;vco, &amp;postdiv1, &amp;postdiv2)) {</div>
 164 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>        <a class="code hl_function" href="group__pico__stdlib.html#ga44d5e0845d4f75f3b0c97c733e39f4c8">set_sys_clock_pll</a>(vco, postdiv1, postdiv2);</div>
 165 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
 166 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>    } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (required) {</div>
 167 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>        <a class="code hl_function" href="group__pico__platform.html#gad1f1a1dc0581a11b597453f148106393">panic</a>(<span class="stringliteral">&quot;System clock of %u kHz cannot be exactly achieved&quot;</span>, freq_khz);</div>
 168 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>    }</div>
 169 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
 170 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>}</div>
 171 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span> </div>
 172 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 173 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>}</div>
 174 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="preprocessor">#endif</span></div>
 175 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="preprocessor">#endif</span></div>
 176 <div class="ttc" id="agpio_8h_html"><div class="ttname"><a href="gpio_8h.html">gpio.h</a></div></div>
 177 <div class="ttc" id="agroup__pico__platform_html_gad1f1a1dc0581a11b597453f148106393"><div class="ttname"><a href="group__pico__platform.html#gad1f1a1dc0581a11b597453f148106393">panic</a></div><div class="ttdeci">void panic(const char *fmt,...)</div><div class="ttdoc">Displays a panic message and halts execution.</div></div>
 178 <div class="ttc" id="agroup__pico__stdlib_html_ga44d5e0845d4f75f3b0c97c733e39f4c8"><div class="ttname"><a href="group__pico__stdlib.html#ga44d5e0845d4f75f3b0c97c733e39f4c8">set_sys_clock_pll</a></div><div class="ttdeci">void set_sys_clock_pll(uint32_t vco_freq, uint post_div1, uint post_div2)</div><div class="ttdoc">Initialise the system clock.</div><div class="ttdef"><b>Definition:</b> stdlib.c:48</div></div>
 179 <div class="ttc" id="agroup__pico__stdlib_html_ga8553a9d91b581e0d3dbccd8d83b1a1b9"><div class="ttname"><a href="group__pico__stdlib.html#ga8553a9d91b581e0d3dbccd8d83b1a1b9">check_sys_clock_khz</a></div><div class="ttdeci">bool check_sys_clock_khz(uint32_t freq_khz, uint *vco_freq_out, uint *post_div1_out, uint *post_div2_out)</div><div class="ttdoc">Check if a given system clock frequency is valid/attainable.</div><div class="ttdef"><b>Definition:</b> stdlib.c:88</div></div>
 180 <div class="ttc" id="agroup__pico__stdlib_html_ga89efe34eab0b8b96954eb0e19a38c8be"><div class="ttname"><a href="group__pico__stdlib.html#ga89efe34eab0b8b96954eb0e19a38c8be">set_sys_clock_48mhz</a></div><div class="ttdeci">void set_sys_clock_48mhz(void)</div><div class="ttdoc">Initialise the system clock to 48MHz.</div><div class="ttdef"><b>Definition:</b> stdlib.c:17</div></div>
 181 <div class="ttc" id="agroup__pico__stdlib_html_gab3a273e837ba1947bb5fd8fc97cf47e5"><div class="ttname"><a href="group__pico__stdlib.html#gab3a273e837ba1947bb5fd8fc97cf47e5">set_sys_clock_khz</a></div><div class="ttdeci">static bool set_sys_clock_khz(uint32_t freq_khz, bool required)</div><div class="ttdoc">Attempt to set a system clock frequency in khz.</div><div class="ttdef"><b>Definition:</b> stdlib.h:126</div></div>
 182 <div class="ttc" id="agroup__pico__stdlib_html_gacf31cd777510116d829aea040b034c4c"><div class="ttname"><a href="group__pico__stdlib.html#gacf31cd777510116d829aea040b034c4c">setup_default_uart</a></div><div class="ttdeci">void setup_default_uart(void)</div><div class="ttdoc">Set up the default UART and assign it to the default GPIOs.</div><div class="ttdef"><b>Definition:</b> stdlib.c:108</div></div>
 183 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
 184 <div class="ttc" id="arp2__common_2hardware__uart_2include_2hardware_2uart_8h_html"><div class="ttname"><a href="rp2__common_2hardware__uart_2include_2hardware_2uart_8h.html">uart.h</a></div></div>
 185 <div class="ttc" id="astdio_8h_html"><div class="ttname"><a href="stdio_8h.html">stdio.h</a></div></div>
 186 <div class="ttc" id="atime_8h_html"><div class="ttname"><a href="time_8h.html">time.h</a></div></div>
 187 </div><!-- fragment --></div><!-- contents -->
 188 </div><!-- doc-content -->
 189
 190         <script src="main.js"></script>
 191 </body>
 192 </html>