begriffs open source - cmsis/blob - main/Driver/group__usart__flow__control.html

   1 <!-- HTML header for doxygen 1.9.6-->
   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" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: USART Flow Control</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__usart__flow__control.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a>  </div>
 129   <div class="headertitle"><div class="title">USART Flow Control<div class="ingroups"><a class="el" href="group__usart__interface__gr.html">USART Interface</a> &raquo; <a class="el" href="group__USART__control.html">USART Control Codes</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Specifies RTS/CTS flow control.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 137 Macros</h2></td></tr>
 138 <tr class="memitem:gad04aa3fe4ea4b7363aee4bdca2ed3764"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a>&#160;&#160;&#160;(0UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td></tr>
 139 <tr class="memdesc:gad04aa3fe4ea4b7363aee4bdca2ed3764"><td class="mdescLeft">&#160;</td><td class="mdescRight">No Flow Control (default)  <br /></td></tr>
 140 <tr class="separator:gad04aa3fe4ea4b7363aee4bdca2ed3764"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga80c8a78e8868165cfcc543105bfd9621"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#ga80c8a78e8868165cfcc543105bfd9621">ARM_USART_FLOW_CONTROL_RTS</a>&#160;&#160;&#160;(1UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td></tr>
 142 <tr class="memdesc:ga80c8a78e8868165cfcc543105bfd9621"><td class="mdescLeft">&#160;</td><td class="mdescRight">RTS Flow Control.  <br /></td></tr>
 143 <tr class="separator:ga80c8a78e8868165cfcc543105bfd9621"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:gaa7b38ebff1ce0f5c3e4479d22e66715f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#gaa7b38ebff1ce0f5c3e4479d22e66715f">ARM_USART_FLOW_CONTROL_CTS</a>&#160;&#160;&#160;(2UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td></tr>
 145 <tr class="memdesc:gaa7b38ebff1ce0f5c3e4479d22e66715f"><td class="mdescLeft">&#160;</td><td class="mdescRight">CTS Flow Control.  <br /></td></tr>
 146 <tr class="separator:gaa7b38ebff1ce0f5c3e4479d22e66715f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gab16151b5c376b41586faf033f4a42d02"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#gab16151b5c376b41586faf033f4a42d02">ARM_USART_FLOW_CONTROL_RTS_CTS</a>&#160;&#160;&#160;(3UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td></tr>
 148 <tr class="memdesc:gab16151b5c376b41586faf033f4a42d02"><td class="mdescLeft">&#160;</td><td class="mdescRight">RTS/CTS Flow Control.  <br /></td></tr>
 149 <tr class="separator:gab16151b5c376b41586faf033f4a42d02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 152 <p>Specifies RTS/CTS flow control. </p>
 153 <h2 class="groupheader">Macro Definition Documentation</h2>
 154 <a id="gad04aa3fe4ea4b7363aee4bdca2ed3764" name="gad04aa3fe4ea4b7363aee4bdca2ed3764"></a>
 155 <h2 class="memtitle"><span class="permalink"><a href="#gad04aa3fe4ea4b7363aee4bdca2ed3764">&#9670;&#160;</a></span>ARM_USART_FLOW_CONTROL_NONE</h2>
 156
 157 <div class="memitem">
 158 <div class="memproto">
 159       <table class="memname">
 160         <tr>
 161           <td class="memname">#define ARM_USART_FLOW_CONTROL_NONE&#160;&#160;&#160;(0UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td>
 162         </tr>
 163       </table>
 164 </div><div class="memdoc">
 165
 166 <p>No Flow Control (default) </p>
 167 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
 168
 169 </div>
 170 </div>
 171 <a id="ga80c8a78e8868165cfcc543105bfd9621" name="ga80c8a78e8868165cfcc543105bfd9621"></a>
 172 <h2 class="memtitle"><span class="permalink"><a href="#ga80c8a78e8868165cfcc543105bfd9621">&#9670;&#160;</a></span>ARM_USART_FLOW_CONTROL_RTS</h2>
 173
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname">#define ARM_USART_FLOW_CONTROL_RTS&#160;&#160;&#160;(1UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td>
 179         </tr>
 180       </table>
 181 </div><div class="memdoc">
 182
 183 <p>RTS Flow Control. </p>
 184 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
 185
 186 </div>
 187 </div>
 188 <a id="gaa7b38ebff1ce0f5c3e4479d22e66715f" name="gaa7b38ebff1ce0f5c3e4479d22e66715f"></a>
 189 <h2 class="memtitle"><span class="permalink"><a href="#gaa7b38ebff1ce0f5c3e4479d22e66715f">&#9670;&#160;</a></span>ARM_USART_FLOW_CONTROL_CTS</h2>
 190
 191 <div class="memitem">
 192 <div class="memproto">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname">#define ARM_USART_FLOW_CONTROL_CTS&#160;&#160;&#160;(2UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td>
 196         </tr>
 197       </table>
 198 </div><div class="memdoc">
 199
 200 <p>CTS Flow Control. </p>
 201 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
 202
 203 </div>
 204 </div>
 205 <a id="gab16151b5c376b41586faf033f4a42d02" name="gab16151b5c376b41586faf033f4a42d02"></a>
 206 <h2 class="memtitle"><span class="permalink"><a href="#gab16151b5c376b41586faf033f4a42d02">&#9670;&#160;</a></span>ARM_USART_FLOW_CONTROL_RTS_CTS</h2>
 207
 208 <div class="memitem">
 209 <div class="memproto">
 210       <table class="memname">
 211         <tr>
 212           <td class="memname">#define ARM_USART_FLOW_CONTROL_RTS_CTS&#160;&#160;&#160;(3UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">ARM_USART_FLOW_CONTROL_Pos</a>)</td>
 213         </tr>
 214       </table>
 215 </div><div class="memdoc">
 216
 217 <p>RTS/CTS Flow Control. </p>
 218 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface.">ARM_USART_Control</a> </dd></dl>
 219
 220 </div>
 221 </div>
 222 </div><!-- contents -->
 223 </div><!-- doc-content -->
 224 <!-- start footer part -->
 225 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 226   <ul>
 227     <li class="footer">
 228       <script type="text/javascript">
 229         <!--
 230         writeFooter.call(this);
 231         //-->
 232       </script>
 233     </li>
 234   </ul>
 235 </div>
 236 </body>
 237 </html>