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: pico_stdio_uart</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('group__pico__stdio__uart.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="summary">
106 <a href="#func-members">Functions</a> </div>
107 <div class="headertitle"><div class="title">pico_stdio_uart<div class="ingroups"><a class="el" href="group__runtime.html">Runtime Infrastructure</a> » <a class="el" href="group__pico__stdio.html">pico_stdio</a></div></div></div>
109 <div class="contents">
111 <p>Support for stdin/stdout using UART.
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:gafcc9bb58b1eb66b8571a507589f66fc2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#gafcc9bb58b1eb66b8571a507589f66fc2">stdio_uart_init</a> (void)</td></tr>
117 <tr class="memdesc:gafcc9bb58b1eb66b8571a507589f66fc2"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly initialize stdin/stdout over UART and add it to the current set of stdin/stdout drivers. <a href="group__pico__stdio__uart.html#gafcc9bb58b1eb66b8571a507589f66fc2">More...</a><br /></td></tr>
118 <tr class="separator:gafcc9bb58b1eb66b8571a507589f66fc2"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:ga265eeb67b5f1f4720dbe863e34d6acc4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#ga265eeb67b5f1f4720dbe863e34d6acc4">stdout_uart_init</a> (void)</td></tr>
120 <tr class="memdesc:ga265eeb67b5f1f4720dbe863e34d6acc4"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly initialize stdout only (no stdin) over UART and add it to the current set of stdout drivers. <a href="group__pico__stdio__uart.html#ga265eeb67b5f1f4720dbe863e34d6acc4">More...</a><br /></td></tr>
121 <tr class="separator:ga265eeb67b5f1f4720dbe863e34d6acc4"><td class="memSeparator" colspan="2"> </td></tr>
122 <tr class="memitem:ga77fc28ecaf14439cdec18ac5a96d50f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#ga77fc28ecaf14439cdec18ac5a96d50f4">stdin_uart_init</a> (void)</td></tr>
123 <tr class="memdesc:ga77fc28ecaf14439cdec18ac5a96d50f4"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly initialize stdin only (no stdout) over UART and add it to the current set of stdin drivers. <a href="group__pico__stdio__uart.html#ga77fc28ecaf14439cdec18ac5a96d50f4">More...</a><br /></td></tr>
124 <tr class="separator:ga77fc28ecaf14439cdec18ac5a96d50f4"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:ga2335d6c842d8363cf3df6b215f881919"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#ga2335d6c842d8363cf3df6b215f881919">stdio_uart_init_full</a> (uart_inst_t *uart, uint baud_rate, int tx_pin, int rx_pin)</td></tr>
126 <tr class="memdesc:ga2335d6c842d8363cf3df6b215f881919"><td class="mdescLeft"> </td><td class="mdescRight">Perform custom initialization initialize stdin/stdout over UART and add it to the current set of stdin/stdout drivers. <a href="group__pico__stdio__uart.html#ga2335d6c842d8363cf3df6b215f881919">More...</a><br /></td></tr>
127 <tr class="separator:ga2335d6c842d8363cf3df6b215f881919"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:ga3f1c7640efd0d3a9f60cf0581b3e5db3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#ga3f1c7640efd0d3a9f60cf0581b3e5db3">stdio_uart_deinit</a> (void)</td></tr>
129 <tr class="memdesc:ga3f1c7640efd0d3a9f60cf0581b3e5db3"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly deinitialize stdin/stdout over UART and remove it from the current set of stdin/stdout drivers. <a href="group__pico__stdio__uart.html#ga3f1c7640efd0d3a9f60cf0581b3e5db3">More...</a><br /></td></tr>
130 <tr class="separator:ga3f1c7640efd0d3a9f60cf0581b3e5db3"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:ga4c07c9747cd1f6cca963e9ab1b827745"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#ga4c07c9747cd1f6cca963e9ab1b827745">stdout_uart_deinit</a> (void)</td></tr>
132 <tr class="memdesc:ga4c07c9747cd1f6cca963e9ab1b827745"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly deinitialize stdout only (no stdin) over UART and remove it from the current set of stdout drivers. <a href="group__pico__stdio__uart.html#ga4c07c9747cd1f6cca963e9ab1b827745">More...</a><br /></td></tr>
133 <tr class="separator:ga4c07c9747cd1f6cca963e9ab1b827745"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:ga83ea2a4916972e370b2faff60895611f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#ga83ea2a4916972e370b2faff60895611f">stdin_uart_deinit</a> (void)</td></tr>
135 <tr class="memdesc:ga83ea2a4916972e370b2faff60895611f"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly deinitialize stdin only (no stdout) over UART and remove it from the current set of stdin drivers. <a href="group__pico__stdio__uart.html#ga83ea2a4916972e370b2faff60895611f">More...</a><br /></td></tr>
136 <tr class="separator:ga83ea2a4916972e370b2faff60895611f"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:gab4956585ad29fb33dd08924866209e31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__uart.html#gab4956585ad29fb33dd08924866209e31">stdio_uart_deinit_full</a> (uart_inst_t *uart, int tx_pin, int rx_pin)</td></tr>
138 <tr class="memdesc:gab4956585ad29fb33dd08924866209e31"><td class="mdescLeft"> </td><td class="mdescRight">Perform custom deinitialization deinitialize stdin/stdout over UART and remove it from the current set of stdin/stdout drivers. <a href="group__pico__stdio__uart.html#gab4956585ad29fb33dd08924866209e31">More...</a><br /></td></tr>
139 <tr class="separator:gab4956585ad29fb33dd08924866209e31"><td class="memSeparator" colspan="2"> </td></tr>
141 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
142 <p >Support for stdin/stdout using UART. </p>
143 <p >Linking this library or calling <code>pico_enable_stdio_uart(TARGET ENABLED)</code> in the CMake (which achieves the same thing) will add UART to the drivers used for standard input/output </p>
144 <h2 class="groupheader">Function Documentation</h2>
145 <a id="ga83ea2a4916972e370b2faff60895611f" name="ga83ea2a4916972e370b2faff60895611f"></a>
146 <h2 class="memtitle"><span class="permalink"><a href="#ga83ea2a4916972e370b2faff60895611f">◆ </a></span>stdin_uart_deinit()</h2>
148 <div class="memitem">
149 <div class="memproto">
150 <table class="memname">
152 <td class="memname">void stdin_uart_deinit </td>
154 <td class="paramtype">void </td>
155 <td class="paramname"></td><td>)</td>
159 </div><div class="memdoc">
161 <p>Explicitly deinitialize stdin only (no stdout) over UART and remove it from the current set of stdin drivers. </p>
162 <p >This method disables PICO_DEFAULT_UART_RX_PIN for UART input (if defined), and leaves the pads isolated </p>
166 <a id="ga77fc28ecaf14439cdec18ac5a96d50f4" name="ga77fc28ecaf14439cdec18ac5a96d50f4"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#ga77fc28ecaf14439cdec18ac5a96d50f4">◆ </a></span>stdin_uart_init()</h2>
169 <div class="memitem">
170 <div class="memproto">
171 <table class="memname">
173 <td class="memname">void stdin_uart_init </td>
175 <td class="paramtype">void </td>
176 <td class="paramname"></td><td>)</td>
180 </div><div class="memdoc">
182 <p>Explicitly initialize stdin only (no stdout) over UART and add it to the current set of stdin drivers. </p>
183 <p >This method sets up PICO_DEFAULT_UART_RX_PIN for UART input (if defined) , and configures the baud rate as PICO_DEFAULT_UART_BAUD_RATE </p>
187 <a id="ga3f1c7640efd0d3a9f60cf0581b3e5db3" name="ga3f1c7640efd0d3a9f60cf0581b3e5db3"></a>
188 <h2 class="memtitle"><span class="permalink"><a href="#ga3f1c7640efd0d3a9f60cf0581b3e5db3">◆ </a></span>stdio_uart_deinit()</h2>
190 <div class="memitem">
191 <div class="memproto">
192 <table class="memname">
194 <td class="memname">void stdio_uart_deinit </td>
196 <td class="paramtype">void </td>
197 <td class="paramname"></td><td>)</td>
201 </div><div class="memdoc">
203 <p>Explicitly deinitialize stdin/stdout over UART and remove it from the current set of stdin/stdout drivers. </p>
204 <p >This method disables PICO_DEFAULT_UART_TX_PIN for UART output (if defined), PICO_DEFAULT_UART_RX_PIN for input (if defined) and leaves the pads isolated.</p>
205 <dl class="section note"><dt>Note</dt><dd>this method is automatically called by <a class="el" href="group__pico__stdio.html#gace6c31545f212bf181718f4fc7587ea7">stdio_deinit_all()</a> if <code>pico_stdio_uart</code> is included in the build </dd></dl>
209 <a id="gab4956585ad29fb33dd08924866209e31" name="gab4956585ad29fb33dd08924866209e31"></a>
210 <h2 class="memtitle"><span class="permalink"><a href="#gab4956585ad29fb33dd08924866209e31">◆ </a></span>stdio_uart_deinit_full()</h2>
212 <div class="memitem">
213 <div class="memproto">
214 <table class="memname">
216 <td class="memname">void stdio_uart_deinit_full </td>
218 <td class="paramtype">uart_inst_t * </td>
219 <td class="paramname"><em>uart</em>, </td>
222 <td class="paramkey"></td>
224 <td class="paramtype">int </td>
225 <td class="paramname"><em>tx_pin</em>, </td>
228 <td class="paramkey"></td>
230 <td class="paramtype">int </td>
231 <td class="paramname"><em>rx_pin</em> </td>
239 </div><div class="memdoc">
241 <p>Perform custom deinitialization deinitialize stdin/stdout over UART and remove it from the current set of stdin/stdout drivers. </p>
242 <dl class="params"><dt>Parameters</dt><dd>
243 <table class="params">
244 <tr><td class="paramname">uart</td><td>the uart instance to use, <a class="el" href="group__hardware__uart.html#ga4c45ff280c79aa60358d8241b7e5824b">uart0</a> or <a class="el" href="group__hardware__uart.html#gad94ac6d5e345a1f794174d9bb7c6f69c">uart1</a> </td></tr>
245 <tr><td class="paramname">tx_pin</td><td>the UART pin to use for stdout (or -1 for no stdout) </td></tr>
246 <tr><td class="paramname">rx_pin</td><td>the UART pin to use for stdin (or -1 for no stdin) </td></tr>
253 <a id="gafcc9bb58b1eb66b8571a507589f66fc2" name="gafcc9bb58b1eb66b8571a507589f66fc2"></a>
254 <h2 class="memtitle"><span class="permalink"><a href="#gafcc9bb58b1eb66b8571a507589f66fc2">◆ </a></span>stdio_uart_init()</h2>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
260 <td class="memname">void stdio_uart_init </td>
262 <td class="paramtype">void </td>
263 <td class="paramname"></td><td>)</td>
267 </div><div class="memdoc">
269 <p>Explicitly initialize stdin/stdout over UART and add it to the current set of stdin/stdout drivers. </p>
270 <p >This method sets up PICO_DEFAULT_UART_TX_PIN for UART output (if defined), PICO_DEFAULT_UART_RX_PIN for input (if defined) and configures the baud rate as PICO_DEFAULT_UART_BAUD_RATE.</p>
271 <dl class="section note"><dt>Note</dt><dd>this method is automatically called by <a class="el" href="group__pico__stdio.html#ga0e604311fb226dae91ff4eb17a19d67a">stdio_init_all()</a> if <code>pico_stdio_uart</code> is included in the build </dd></dl>
275 <a id="ga2335d6c842d8363cf3df6b215f881919" name="ga2335d6c842d8363cf3df6b215f881919"></a>
276 <h2 class="memtitle"><span class="permalink"><a href="#ga2335d6c842d8363cf3df6b215f881919">◆ </a></span>stdio_uart_init_full()</h2>
278 <div class="memitem">
279 <div class="memproto">
280 <table class="memname">
282 <td class="memname">void stdio_uart_init_full </td>
284 <td class="paramtype">uart_inst_t * </td>
285 <td class="paramname"><em>uart</em>, </td>
288 <td class="paramkey"></td>
290 <td class="paramtype">uint </td>
291 <td class="paramname"><em>baud_rate</em>, </td>
294 <td class="paramkey"></td>
296 <td class="paramtype">int </td>
297 <td class="paramname"><em>tx_pin</em>, </td>
300 <td class="paramkey"></td>
302 <td class="paramtype">int </td>
303 <td class="paramname"><em>rx_pin</em> </td>
311 </div><div class="memdoc">
313 <p>Perform custom initialization initialize stdin/stdout over UART and add it to the current set of stdin/stdout drivers. </p>
314 <dl class="params"><dt>Parameters</dt><dd>
315 <table class="params">
316 <tr><td class="paramname">uart</td><td>the uart instance to use, <a class="el" href="group__hardware__uart.html#ga4c45ff280c79aa60358d8241b7e5824b">uart0</a> or <a class="el" href="group__hardware__uart.html#gad94ac6d5e345a1f794174d9bb7c6f69c">uart1</a> </td></tr>
317 <tr><td class="paramname">baud_rate</td><td>the baud rate in Hz </td></tr>
318 <tr><td class="paramname">tx_pin</td><td>the UART pin to use for stdout (or -1 for no stdout) </td></tr>
319 <tr><td class="paramname">rx_pin</td><td>the UART pin to use for stdin (or -1 for no stdin) </td></tr>
326 <a id="ga4c07c9747cd1f6cca963e9ab1b827745" name="ga4c07c9747cd1f6cca963e9ab1b827745"></a>
327 <h2 class="memtitle"><span class="permalink"><a href="#ga4c07c9747cd1f6cca963e9ab1b827745">◆ </a></span>stdout_uart_deinit()</h2>
329 <div class="memitem">
330 <div class="memproto">
331 <table class="memname">
333 <td class="memname">void stdout_uart_deinit </td>
335 <td class="paramtype">void </td>
336 <td class="paramname"></td><td>)</td>
340 </div><div class="memdoc">
342 <p>Explicitly deinitialize stdout only (no stdin) over UART and remove it from the current set of stdout drivers. </p>
343 <p >This method disables PICO_DEFAULT_UART_TX_PIN for UART output (if defined), and leaves the pad isolated </p>
347 <a id="ga265eeb67b5f1f4720dbe863e34d6acc4" name="ga265eeb67b5f1f4720dbe863e34d6acc4"></a>
348 <h2 class="memtitle"><span class="permalink"><a href="#ga265eeb67b5f1f4720dbe863e34d6acc4">◆ </a></span>stdout_uart_init()</h2>
350 <div class="memitem">
351 <div class="memproto">
352 <table class="memname">
354 <td class="memname">void stdout_uart_init </td>
356 <td class="paramtype">void </td>
357 <td class="paramname"></td><td>)</td>
361 </div><div class="memdoc">
363 <p>Explicitly initialize stdout only (no stdin) over UART and add it to the current set of stdout drivers. </p>
364 <p >This method sets up PICO_DEFAULT_UART_TX_PIN for UART output (if defined) , and configures the baud rate as PICO_DEFAULT_UART_BAUD_RATE </p>
368 </div><!-- contents -->
369 </div><!-- doc-content -->
371 <script src="main.js"></script>