web/docs/group__pico__stdio__usb.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_usb</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__stdio__usb.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_stdio_usb<div class="ingroups"><a class="el" href="group__runtime.html">Runtime Infrastructure</a> &raquo; <a class="el" href="group__pico__stdio.html">pico_stdio</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>Support for stdin/stdout over USB serial (CDC)
 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:gab87bcfa3f24e5a3fe92a944f9eecc460"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__usb.html#gab87bcfa3f24e5a3fe92a944f9eecc460">stdio_usb_init</a> (void)</td></tr>
 117 <tr class="memdesc:gab87bcfa3f24e5a3fe92a944f9eecc460"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly initialize USB stdio and add it to the current set of stdin drivers.  <a href="group__pico__stdio__usb.html#gab87bcfa3f24e5a3fe92a944f9eecc460">More...</a><br /></td></tr>
 118 <tr class="separator:gab87bcfa3f24e5a3fe92a944f9eecc460"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:ga1a1edc699811e2dc3c119e8b00edc038"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__usb.html#ga1a1edc699811e2dc3c119e8b00edc038">stdio_usb_deinit</a> (void)</td></tr>
 120 <tr class="memdesc:ga1a1edc699811e2dc3c119e8b00edc038"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly deinitialize USB stdio and remove it from the current set of stdin drivers.  <a href="group__pico__stdio__usb.html#ga1a1edc699811e2dc3c119e8b00edc038">More...</a><br /></td></tr>
 121 <tr class="separator:ga1a1edc699811e2dc3c119e8b00edc038"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:ga86edc8e3a477bb388ae73d92a3e87824"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdio__usb.html#ga86edc8e3a477bb388ae73d92a3e87824">stdio_usb_connected</a> (void)</td></tr>
 123 <tr class="memdesc:ga86edc8e3a477bb388ae73d92a3e87824"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if there is an active stdio CDC connection to a host.  <a href="group__pico__stdio__usb.html#ga86edc8e3a477bb388ae73d92a3e87824">More...</a><br /></td></tr>
 124 <tr class="separator:ga86edc8e3a477bb388ae73d92a3e87824"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 </table>
 126 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 127 <p >Support for stdin/stdout over USB serial (CDC) </p>
 128 <p >Linking this library or calling <code>pico_enable_stdio_usb(TARGET ENABLED)</code> in the CMake (which achieves the same thing) will add USB CDC to the drivers used for standard input/output</p>
 129 <p >Note this library is a developer convenience. It is not applicable in all cases; for one it takes full control of the USB device precluding your use of the USB in device or host mode. For this reason, this library will automatically disengage if you try to using it alongside <a class="el" href="group__tinyusb__device.html">tinyusb_device</a> or <a class="el" href="group__tinyusb__host.html">tinyusb_host</a>. It also takes control of a lower level IRQ and sets up a periodic background task.</p>
 130 <p >This library also includes (by default) functionality to enable the RP-series microcontroller to be reset over the USB interface. </p>
 131 <h2 class="groupheader">Function Documentation</h2>
 132 <a id="ga86edc8e3a477bb388ae73d92a3e87824" name="ga86edc8e3a477bb388ae73d92a3e87824"></a>
 133 <h2 class="memtitle"><span class="permalink"><a href="#ga86edc8e3a477bb388ae73d92a3e87824">&#9670;&nbsp;</a></span>stdio_usb_connected()</h2>
 134
 135 <div class="memitem">
 136 <div class="memproto">
 137       <table class="memname">
 138         <tr>
 139           <td class="memname">bool stdio_usb_connected </td>
 140           <td>(</td>
 141           <td class="paramtype">void&#160;</td>
 142           <td class="paramname"></td><td>)</td>
 143           <td></td>
 144         </tr>
 145       </table>
 146 </div><div class="memdoc">
 147
 148 <p>Check if there is an active stdio CDC connection to a host. </p>
 149 <dl class="section return"><dt>Returns</dt><dd>true if stdio is connected over CDC </dd></dl>
 150
 151 </div>
 152 </div>
 153 <a id="ga1a1edc699811e2dc3c119e8b00edc038" name="ga1a1edc699811e2dc3c119e8b00edc038"></a>
 154 <h2 class="memtitle"><span class="permalink"><a href="#ga1a1edc699811e2dc3c119e8b00edc038">&#9670;&nbsp;</a></span>stdio_usb_deinit()</h2>
 155
 156 <div class="memitem">
 157 <div class="memproto">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname">bool stdio_usb_deinit </td>
 161           <td>(</td>
 162           <td class="paramtype">void&#160;</td>
 163           <td class="paramname"></td><td>)</td>
 164           <td></td>
 165         </tr>
 166       </table>
 167 </div><div class="memdoc">
 168
 169 <p>Explicitly deinitialize USB stdio and remove it from the current set of stdin drivers. </p>
 170 <dl class="section return"><dt>Returns</dt><dd>true if the USB CDC was deinitialized, false if an error occurred </dd></dl>
 171
 172 </div>
 173 </div>
 174 <a id="gab87bcfa3f24e5a3fe92a944f9eecc460" name="gab87bcfa3f24e5a3fe92a944f9eecc460"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#gab87bcfa3f24e5a3fe92a944f9eecc460">&#9670;&nbsp;</a></span>stdio_usb_init()</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">bool stdio_usb_init </td>
 182           <td>(</td>
 183           <td class="paramtype">void&#160;</td>
 184           <td class="paramname"></td><td>)</td>
 185           <td></td>
 186         </tr>
 187       </table>
 188 </div><div class="memdoc">
 189
 190 <p>Explicitly initialize USB stdio and add it to the current set of stdin drivers. </p>
 191 <p >PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS can be set to cause this method to wait for a CDC connection from the host before returning, which is useful if you don't want any initial stdout output to be discarded before the connection is established.</p>
 192 <dl class="section return"><dt>Returns</dt><dd>true if the USB CDC was initialized, false if an error occurred</dd></dl>
 193 <p>Copyright (c) 2020 Raspberry Pi (Trading) Ltd.</p>
 194 <p >SPDX-License-Identifier: BSD-3-Clause </p>
 195
 196 </div>
 197 </div>
 198 </div><!-- contents -->
 199 </div><!-- doc-content -->
 200
 201         <script src="main.js"></script>
 202 </body>
 203 </html>