]> Git Repo - pico-vscode.git/blob - web/docs/stdio__usb_8h_source.html
Merge branch 'main' into main
[pico-vscode.git] / web / docs / stdio__usb_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: include/pico/stdio_usb.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                                 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('stdio__usb_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_usb.h</div></div>
106 </div><!--header-->
107 <div class="contents">
108 <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_USB_H</span></div>
115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_STDIO_USB_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="stdio_8h.html">pico/stdio.h</a>&quot;</span></div>
118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
119 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_DEFAULT_CRLF, Default state of CR/LF translation for USB output, type=bool, default=PICO_STDIO_DEFAULT_CRLF, group=pico_stdio_usb</span></div>
120 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#ifndef PICO_STDIO_USB_DEFAULT_CRLF</span></div>
121 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#define PICO_STDIO_USB_DEFAULT_CRLF PICO_STDIO_DEFAULT_CRLF</span></div>
122 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#endif</span></div>
123 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
124 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_STDOUT_TIMEOUT_US, Number of microseconds to be blocked trying to write USB output before assuming the host has disappeared and discarding data, default=500000, group=pico_stdio_usb</span></div>
125 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#ifndef PICO_STDIO_USB_STDOUT_TIMEOUT_US</span></div>
126 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define PICO_STDIO_USB_STDOUT_TIMEOUT_US 500000</span></div>
127 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">#endif</span></div>
128 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
129 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">// todo perhaps unnecessarily frequent?</span></div>
130 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_TASK_INTERVAL_US, Period of microseconds between calling tud_task in the background, default=1000, advanced=true, group=pico_stdio_usb</span></div>
131 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#ifndef PICO_STDIO_USB_TASK_INTERVAL_US</span></div>
132 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#define PICO_STDIO_USB_TASK_INTERVAL_US 1000</span></div>
133 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#endif</span></div>
134 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
135 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_LOW_PRIORITY_IRQ, Explicit User IRQ number to claim for tud_task() background execution instead of letting the implementation pick a free one dynamically (deprecated), advanced=true, group=pico_stdio_usb</span></div>
136 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#ifndef PICO_STDIO_USB_LOW_PRIORITY_IRQ</span></div>
137 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">// this variable is no longer set by default (one is claimed dynamically), but will be respected if specified</span></div>
138 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#endif</span></div>
139 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
140 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE, Enable/disable resetting into BOOTSEL mode if the host sets the baud rate to a magic value (PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE), type=bool, default=1 if application is not using TinyUSB directly, group=pico_stdio_usb</span></div>
141 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#ifndef PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE</span></div>
142 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">#if !defined(LIB_TINYUSB_HOST) &amp;&amp; !defined(LIB_TINYUSB_DEVICE)</span></div>
143 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="preprocessor">#define PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE 1</span></div>
144 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#endif</span></div>
145 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">#endif</span></div>
146 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
147 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE, baud rate that if selected causes a reset into BOOTSEL mode (if PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE is set), default=1200, group=pico_stdio_usb</span></div>
148 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE</span></div>
149 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE 1200</span></div>
150 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#endif</span></div>
151 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
152 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS, Maximum number of milliseconds to wait during initialization for a CDC connection from the host (negative means indefinite) during initialization, default=0, group=pico_stdio_usb</span></div>
153 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#ifndef PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS</span></div>
154 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="preprocessor">#define PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS 0</span></div>
155 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#endif</span></div>
156 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div>
157 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS, Number of extra milliseconds to wait when using PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS after a host CDC connection is detected (some host terminals seem to sometimes lose transmissions sent right after connection), default=50, group=pico_stdio_usb</span></div>
158 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#ifndef PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS</span></div>
159 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">#define PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS 50</span></div>
160 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#endif</span></div>
161 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
162 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_DEINIT_DELAY_MS, Number of milliseconds to wait before deinitializing stdio_usb, default=110, group=pico_stdio_usb</span></div>
163 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">#ifndef PICO_STDIO_USB_DEINIT_DELAY_MS</span></div>
164 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#define PICO_STDIO_USB_DEINIT_DELAY_MS 110</span></div>
165 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="preprocessor">#endif</span></div>
166 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
167 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED, Optionally define a pin to use as bootloader activity LED when BOOTSEL mode is entered via USB (either VIA_BAUD_RATE or VIA_VENDOR_INTERFACE), type=int, min=0, max=29, group=pico_stdio_usb</span></div>
168 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
169 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED, Whether the pin specified by PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED is fixed or can be modified by picotool over the VENDOR USB interface, type=bool, default=0, group=pico_stdio_usb</span></div>
170 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED</span></div>
171 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED 0</span></div>
172 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="preprocessor">#endif</span></div>
173 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
174 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">// Any modes disabled here can&#39;t be re-enabled by picotool via VENDOR_INTERFACE.</span></div>
175 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK, Optionally disable either the mass storage interface (bit 0) or the PICOBOOT interface (bit 1) when entering BOOTSEL mode via USB (either VIA_BAUD_RATE or VIA_VENDOR_INTERFACE), type=int, min=0, max=3, default=0, group=pico_stdio_usb</span></div>
176 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK</span></div>
177 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK 0u</span></div>
178 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#endif</span></div>
179 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
180 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE, Enable/disable resetting into BOOTSEL mode via an additional VENDOR USB interface - enables picotool based reset, type=bool, default=1 if application is not using TinyUSB directly, group=pico_stdio_usb</span></div>
181 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="preprocessor">#ifndef PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE</span></div>
182 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#if !defined(LIB_TINYUSB_HOST) &amp;&amp; !defined(LIB_TINYUSB_DEVICE)</span></div>
183 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="preprocessor">#define PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE 1</span></div>
184 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#endif</span></div>
185 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="preprocessor">#endif</span></div>
186 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span> </div>
187 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL, If vendor reset interface is included allow rebooting to BOOTSEL mode, type=bool, default=1, group=pico_stdio_usb</span></div>
188 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL</span></div>
189 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL 1</span></div>
190 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="preprocessor">#endif</span></div>
191 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
192 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT, If vendor reset interface is included allow rebooting with regular flash boot, type=bool, default=1, group=pico_stdio_usb</span></div>
193 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT</span></div>
194 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT 1</span></div>
195 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="preprocessor">#endif</span></div>
196 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
197 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR, If vendor reset interface is included add support for Microsoft OS 2.0 Descriptor, type=bool, default=1, group=pico_stdio_usb</span></div>
198 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR</span></div>
199 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR 1</span></div>
200 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="preprocessor">#endif</span></div>
201 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span> </div>
202 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS, Delay in ms before rebooting via regular flash boot, default=100, group=pico_stdio_usb</span></div>
203 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="preprocessor">#ifndef PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS</span></div>
204 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="preprocessor">#define PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS 100</span></div>
205 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="preprocessor">#endif</span></div>
206 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span> </div>
207 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_CONNECTION_WITHOUT_DTR, Disable use of DTR for connection checking meaning connection is assumed to be valid, type=bool, default=0, group=pico_stdio_usb</span></div>
208 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="preprocessor">#ifndef PICO_STDIO_USB_CONNECTION_WITHOUT_DTR</span></div>
209 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="preprocessor">#define PICO_STDIO_USB_CONNECTION_WITHOUT_DTR 0</span></div>
210 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="preprocessor">#endif</span></div>
211 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
212 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_DEVICE_SELF_POWERED, Set USB device as self powered device, type=bool, default=0, group=pico_stdio_usb</span></div>
213 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="preprocessor">#ifndef PICO_STDIO_USB_DEVICE_SELF_POWERED</span></div>
214 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="preprocessor">#define PICO_STDIO_USB_DEVICE_SELF_POWERED 0</span></div>
215 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="preprocessor">#endif</span></div>
216 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span> </div>
217 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">// PICO_CONFIG: PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK, Enable USB STDIO support for stdio_set_chars_available_callback. Can be disabled to make use of USB CDC RX callback elsewhere, type=bool, default=1, group=pico_stdio_usb</span></div>
218 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="preprocessor">#ifndef PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK</span></div>
219 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="preprocessor">#define PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK 1</span></div>
220 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="preprocessor">#endif</span></div>
221 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span> </div>
222 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#ifdef __cplusplus</span></div>
223 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
224 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="preprocessor">#endif</span></div>
225 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span> </div>
226 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="keyword">extern</span> <a class="code hl_struct" href="structstdio__driver.html">stdio_driver_t</a> stdio_usb;</div>
227 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span> </div>
228 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdio__usb.html#gab87bcfa3f24e5a3fe92a944f9eecc460">stdio_usb_init</a>(<span class="keywordtype">void</span>);</div>
229 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span> </div>
230 <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="group__pico__stdio__usb.html#ga1a1edc699811e2dc3c119e8b00edc038">  151</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdio__usb.html#ga1a1edc699811e2dc3c119e8b00edc038">stdio_usb_deinit</a>(<span class="keywordtype">void</span>);</div>
231 <div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span> </div>
232 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="group__pico__stdio__usb.html#ga86edc8e3a477bb388ae73d92a3e87824">  158</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__stdio__usb.html#ga86edc8e3a477bb388ae73d92a3e87824">stdio_usb_connected</a>(<span class="keywordtype">void</span>);</div>
233 <div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="preprocessor">#ifdef __cplusplus</span></div>
234 <div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>}</div>
235 <div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="preprocessor">#endif</span></div>
236 <div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span> </div>
237 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="preprocessor">#endif</span></div>
238 <div class="ttc" id="agroup__pico__stdio__usb_html_ga1a1edc699811e2dc3c119e8b00edc038"><div class="ttname"><a href="group__pico__stdio__usb.html#ga1a1edc699811e2dc3c119e8b00edc038">stdio_usb_deinit</a></div><div class="ttdeci">bool stdio_usb_deinit(void)</div><div class="ttdoc">Explicitly deinitialize USB stdio and remove it from the current set of stdin drivers.</div></div>
239 <div class="ttc" id="agroup__pico__stdio__usb_html_ga86edc8e3a477bb388ae73d92a3e87824"><div class="ttname"><a href="group__pico__stdio__usb.html#ga86edc8e3a477bb388ae73d92a3e87824">stdio_usb_connected</a></div><div class="ttdeci">bool stdio_usb_connected(void)</div><div class="ttdoc">Check if there is an active stdio CDC connection to a host.</div></div>
240 <div class="ttc" id="agroup__pico__stdio__usb_html_gab87bcfa3f24e5a3fe92a944f9eecc460"><div class="ttname"><a href="group__pico__stdio__usb.html#gab87bcfa3f24e5a3fe92a944f9eecc460">stdio_usb_init</a></div><div class="ttdeci">bool stdio_usb_init(void)</div><div class="ttdoc">Explicitly initialize USB stdio and add it to the current set of stdin drivers.</div><div class="ttdef"><b>Definition:</b> stdio_usb.c:295</div></div>
241 <div class="ttc" id="astdio_8h_html"><div class="ttname"><a href="stdio_8h.html">stdio.h</a></div></div>
242 <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>
243 </div><!-- fragment --></div><!-- contents -->
244 </div><!-- doc-content -->
245
246         <script src="main.js"></script>
247 </body>
248 </html>
This page took 0.043975 seconds and 4 git commands to generate.