<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Raspberry Pi Pico SDK: pico_stdlib/include/pico/stdlib.h Source File</title>
+ <title>Raspberry Pi Pico SDK: include/pico/stdlib.h Source File</title>
<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<div class="logo">
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
<span style="display: inline-block; margin-top: 10px;">
- v1.5.1
+ v2.0.0
</span>
</div>
<div class="navigation-footer">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "<a class="code" href="pico_8h.html">pico.h</a>"</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "<a class="code" href="stdio_8h.html">pico/stdio.h</a>"</span></div>
-<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "<a class="code" href="time_8h.html">pico/time.h</a>"</span></div>
+<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "<a class="code" href="common_2pico__time_2include_2pico_2time_8h.html">pico/time.h</a>"</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include "<a class="code" href="gpio_8h.html">hardware/gpio.h</a>"</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include "<a class="code" href="rp2__common_2hardware__uart_2include_2hardware_2uart_8h.html">hardware/uart.h</a>"</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
-<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>
-<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>
-<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>
-<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
-<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#if LIB_PICO_STDIO_UART</span></div>
-<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#include "pico/stdio_uart.h"</span></div>
-<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
-<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#if LIB_PICO_STDIO_USB</span></div>
-<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#include "pico/stdio_usb.h"</span></div>
-<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
-<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#if LIB_PICO_STDIO_SEMIHOSTING</span></div>
-<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#include "pico/stdio_semihosting.h"</span></div>
-<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
-<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>
-<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
-<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>
-<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>
-<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>
-<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
-<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>
-<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>
-<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
-<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>
-<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
-<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>
-<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
-<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>
-<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
-<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>
-<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
-<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>
-<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> uint vco, postdiv1, postdiv2;</div>
-<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, &vco, &postdiv1, &postdiv2)) {</div>
-<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>
-<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>
-<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>
-<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">"System clock of %u kHz cannot be exactly achieved"</span>, freq_khz);</div>
-<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> }</div>
-<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>
-<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span>}</div>
-<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
-<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="preprocessor">#ifdef __cplusplus</span></div>
-<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>}</div>
-<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">// Note PICO_STDIO_UART, PICO_STDIO_USB, PICO_STDIO_SEMIHOSTING are set by the</span></div>
+<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">// respective INTERFACE libraries, so these defines are set if the library</span></div>
+<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">// is included for the target executable</span></div>
+<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
+<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#if LIB_PICO_STDIO_UART</span></div>
+<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#include "pico/stdio_uart.h"</span></div>
+<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
+<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#if LIB_PICO_STDIO_USB</span></div>
+<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#include "pico/stdio_usb.h"</span></div>
+<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
+<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#if LIB_PICO_STDIO_SEMIHOSTING</span></div>
+<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#include "pico/stdio_semihosting.h"</span></div>
+<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
+<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment">// PICO_CONFIG: PICO_DEFAULT_LED_PIN, Optionally define a pin that drives a regular LED on the board, default=Usually provided via board header, group=pico_stdlib</span></div>
+<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
+<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</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>
+<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#ifndef PICO_DEFAULT_LED_PIN_INVERTED</span></div>
+<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#define PICO_DEFAULT_LED_PIN_INVERTED 0</span></div>
+<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
+<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</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>
+<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</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>
+<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
+<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</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>
+<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
+<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor">#ifdef __cplusplus</span></div>
+<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>}</div>
+<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#endif</span></div>
+<div class="ttc" id="acommon_2pico__time_2include_2pico_2time_8h_html"><div class="ttname"><a href="common_2pico__time_2include_2pico_2time_8h.html">time.h</a></div></div>
<div class="ttc" id="agpio_8h_html"><div class="ttname"><a href="gpio_8h.html">gpio.h</a></div></div>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
+<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:14</div></div>
<div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
<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>
<div class="ttc" id="astdio_8h_html"><div class="ttname"><a href="stdio_8h.html">stdio.h</a></div></div>
-<div class="ttc" id="atime_8h_html"><div class="ttname"><a href="time_8h.html">time.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
projects / pico-vscode.git / blobdiff