web/docs/stdio_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_stdio/include/pico/stdio.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('stdio_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">stdio.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="stdio_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_STDIO_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_STDIO_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="l00017" name="l00017"></a><span class="lineno">   17</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="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
 119 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment">// PICO_CONFIG: PICO_STDOUT_MUTEX, Enable/disable mutex around stdout, type=bool, default=1, group=pico_stdio</span></div>
 120 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#ifndef PICO_STDOUT_MUTEX</span></div>
 121 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#define PICO_STDOUT_MUTEX 1</span></div>
 122 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#endif</span></div>
 123 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
 124 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment">// PICO_CONFIG: PICO_STDIO_ENABLE_CRLF_SUPPORT, Enable/disable CR/LF output conversion support, type=bool, default=1, group=pico_stdio</span></div>
 125 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#ifndef PICO_STDIO_ENABLE_CRLF_SUPPORT</span></div>
 126 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#define PICO_STDIO_ENABLE_CRLF_SUPPORT 1</span></div>
 127 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#endif</span></div>
 128 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
 129 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// PICO_CONFIG: PICO_STDIO_DEFAULT_CRLF, Default for CR/LF conversion enabled on all stdio outputs, type=bool, default=1, depends=PICO_STDIO_ENABLE_CRLF_SUPPORT, group=pico_stdio</span></div>
 130 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#ifndef PICO_STDIO_DEFAULT_CRLF</span></div>
 131 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#define PICO_STDIO_DEFAULT_CRLF 1</span></div>
 132 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#endif</span></div>
 133 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
 134 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">// PICO_CONFIG: PICO_STDIO_STACK_BUFFER_SIZE, Define printf buffer size (on stack)... this is just a working buffer not a max output size, min=0, max=512, default=128, group=pico_stdio</span></div>
 135 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#ifndef PICO_STDIO_STACK_BUFFER_SIZE</span></div>
 136 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#define PICO_STDIO_STACK_BUFFER_SIZE 128</span></div>
 137 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#endif</span></div>
 138 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
 139 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">// PICO_CONFIG: PICO_STDIO_DEADLOCK_TIMEOUT_MS, Time after which to assume stdio_usb is deadlocked by use in IRQ and give up, type=int, default=1000, group=pico_stdio</span></div>
 140 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#ifndef PICO_STDIO_DEADLOCK_TIMEOUT_MS</span></div>
 141 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#define PICO_STDIO_DEADLOCK_TIMEOUT_MS 1000</span></div>
 142 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#endif</span></div>
 143 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
 144 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 145 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 146 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#endif</span></div>
 147 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
 148 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
 149 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structstdio__driver.html">stdio_driver</a> <a class="code hl_struct" href="structstdio__driver.html">stdio_driver_t</a>;</div>
 150 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
 151 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdio.html#ga0e604311fb226dae91ff4eb17a19d67a">stdio_init_all</a>(<span class="keywordtype">void</span>);</div>
 152 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
 153 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdio.html#ga90927805d6b48285139ab31098623df1">stdio_flush</a>(<span class="keywordtype">void</span>);</div>
 154 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
 155 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="keywordtype">int</span> <a class="code hl_function" href="group__pico__stdio.html#ga9b10b3bc1a4750fcb0e691566bc868e8">getchar_timeout_us</a>(uint32_t timeout_us);</div>
 156 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
 157 <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__stdio.html#ga826d33ec05c3e33dbddf0cb09e329562">stdio_set_driver_enabled</a>(<a class="code hl_struct" href="structstdio__driver.html">stdio_driver_t</a> *driver, <span class="keywordtype">bool</span> enabled);</div>
 158 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
 159 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdio.html#gae3944ee24af8163a9538f01cda3e28df">stdio_filter_driver</a>(<a class="code hl_struct" href="structstdio__driver.html">stdio_driver_t</a> *driver);</div>
 160 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
 161 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdio.html#gaba86bf2cb6b86a9078cd94dcf47b1915">stdio_set_translate_crlf</a>(<a class="code hl_struct" href="structstdio__driver.html">stdio_driver_t</a> *driver, <span class="keywordtype">bool</span> translate);</div>
 162 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span> </div>
 163 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="keywordtype">int</span> <a class="code hl_function" href="group__pico__stdio.html#ga919e541a385cc6ff534133b19ee5da37">putchar_raw</a>(<span class="keywordtype">int</span> c);</div>
 164 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
 165 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="keywordtype">int</span> <a class="code hl_function" href="group__pico__stdio.html#ga7a35b8117b27c04d898d1a36de6a7b0b">puts_raw</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *s);</div>
 166 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span> </div>
 167 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__stdio.html#ga4b010bf88f65fc5d38a29d5538fa80e1">stdio_set_chars_available_callback</a>(<span class="keywordtype">void</span> (*fn)(<span class="keywordtype">void</span>*), <span class="keywordtype">void</span> *param);</div>
 168 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span> </div>
 169 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 170 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>}</div>
 171 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="preprocessor">#endif</span></div>
 172 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span> </div>
 173 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#endif</span></div>
 174 <div class="ttc" id="agroup__pico__stdio_html_ga0e604311fb226dae91ff4eb17a19d67a"><div class="ttname"><a href="group__pico__stdio.html#ga0e604311fb226dae91ff4eb17a19d67a">stdio_init_all</a></div><div class="ttdeci">bool stdio_init_all(void)</div><div class="ttdoc">Initialize all of the present standard stdio types that are linked into the binary.</div><div class="ttdef"><b>Definition:</b> stdio.c:283</div></div>
 175 <div class="ttc" id="agroup__pico__stdio_html_ga4b010bf88f65fc5d38a29d5538fa80e1"><div class="ttname"><a href="group__pico__stdio.html#ga4b010bf88f65fc5d38a29d5538fa80e1">stdio_set_chars_available_callback</a></div><div class="ttdeci">void stdio_set_chars_available_callback(void(*fn)(void *), void *param)</div><div class="ttdoc">get notified when there are input characters available</div><div class="ttdef"><b>Definition:</b> stdio.c:339</div></div>
 176 <div class="ttc" id="agroup__pico__stdio_html_ga7a35b8117b27c04d898d1a36de6a7b0b"><div class="ttname"><a href="group__pico__stdio.html#ga7a35b8117b27c04d898d1a36de6a7b0b">puts_raw</a></div><div class="ttdeci">int puts_raw(const char *s)</div><div class="ttdoc">puts variant that skips any CR/LF conversion if enabled</div><div class="ttdef"><b>Definition:</b> stdio.c:158</div></div>
 177 <div class="ttc" id="agroup__pico__stdio_html_ga826d33ec05c3e33dbddf0cb09e329562"><div class="ttname"><a href="group__pico__stdio.html#ga826d33ec05c3e33dbddf0cb09e329562">stdio_set_driver_enabled</a></div><div class="ttdeci">void stdio_set_driver_enabled(stdio_driver_t *driver, bool enabled)</div><div class="ttdoc">Adds or removes a driver from the list of active drivers used for input/output.</div><div class="ttdef"><b>Definition:</b> stdio.c:200</div></div>
 178 <div class="ttc" id="agroup__pico__stdio_html_ga90927805d6b48285139ab31098623df1"><div class="ttname"><a href="group__pico__stdio.html#ga90927805d6b48285139ab31098623df1">stdio_flush</a></div><div class="ttdeci">void stdio_flush(void)</div><div class="ttdoc">Flushes any buffered output.</div><div class="ttdef"><b>Definition:</b> stdio.c:217</div></div>
 179 <div class="ttc" id="agroup__pico__stdio_html_ga919e541a385cc6ff534133b19ee5da37"><div class="ttname"><a href="group__pico__stdio.html#ga919e541a385cc6ff534133b19ee5da37">putchar_raw</a></div><div class="ttdeci">int putchar_raw(int c)</div><div class="ttdoc">putchar variant that skips any CR/LF conversion if enabled</div><div class="ttdef"><b>Definition:</b> stdio.c:152</div></div>
 180 <div class="ttc" id="agroup__pico__stdio_html_ga9b10b3bc1a4750fcb0e691566bc868e8"><div class="ttname"><a href="group__pico__stdio.html#ga9b10b3bc1a4750fcb0e691566bc868e8">getchar_timeout_us</a></div><div class="ttdeci">int getchar_timeout_us(uint32_t timeout_us)</div><div class="ttdoc">Return a character from stdin if there is one available within a timeout.</div><div class="ttdef"><b>Definition:</b> stdio.c:312</div></div>
 181 <div class="ttc" id="agroup__pico__stdio_html_gaba86bf2cb6b86a9078cd94dcf47b1915"><div class="ttname"><a href="group__pico__stdio.html#gaba86bf2cb6b86a9078cd94dcf47b1915">stdio_set_translate_crlf</a></div><div class="ttdeci">void stdio_set_translate_crlf(stdio_driver_t *driver, bool translate)</div><div class="ttdoc">control conversion of line feeds to carriage return on transmissions</div><div class="ttdef"><b>Definition:</b> stdio.c:324</div></div>
 182 <div class="ttc" id="agroup__pico__stdio_html_gae3944ee24af8163a9538f01cda3e28df"><div class="ttname"><a href="group__pico__stdio.html#gae3944ee24af8163a9538f01cda3e28df">stdio_filter_driver</a></div><div class="ttdeci">void stdio_filter_driver(stdio_driver_t *driver)</div><div class="ttdoc">Control limiting of output to a single driver.</div><div class="ttdef"><b>Definition:</b> stdio.c:320</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="astructstdio__driver_html"><div class="ttname"><a href="structstdio__driver.html">stdio_driver</a></div><div class="ttdef"><b>Definition:</b> driver.h:12</div></div>
 185 </div><!-- fragment --></div><!-- contents -->
 186 </div><!-- doc-content -->
 187
 188         <script src="main.js"></script>
 189 </body>
 190 </html>