]> begriffs open source - cmsis/blob - main/Driver/html/group__usart__mode__control.html
Update documentation for branch main
[cmsis] / main / Driver / html / group__usart__mode__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 Mode Control</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="jquery.js"></script>
15 <script type="text/javascript" src="dynsections.js"></script>
16 <script type="text/javascript" src="printComponentTabs.js"></script>
17 <script type="text/javascript" src="footer.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="resize.js"></script>
21 <script type="text/javascript" src="navtreedata.js"></script>
22 <script type="text/javascript" src="navtree.js"></script>
23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
24 <script type="text/javascript" src="search/searchdata.js"></script>
25 <script type="text/javascript" src="search/search.js"></script>
26 <script type="text/javascript">
27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
28   $(document).ready(function() { init_search(); });
29 /* @license-end */
30 </script>
31 <script type="text/javascript" src="darkmode_toggle.js"></script>
32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
35 <link href="version.css" rel="stylesheet" type="text/css" />
36 <script type="text/javascript" src="../../../version.js"></script>
37 </head>
38 <body>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
40 <div id="titlearea">
41 <table cellspacing="0" cellpadding="0">
42  <tbody>
43  <tr style="height: 55px;">
44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
46    <div id="projectname">CMSIS-Driver
47    &#160;<span id="projectnumber"><script type="text/javascript">
48      <!--
49      writeHeader.call(this);
50      writeVersionDropdown.call(this);
51      //-->
52     </script>
53    </span>
54    </div>
55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
56   </td>
57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
58         <span class="left">
59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
61                onfocus="searchBox.OnSearchFieldFocus(true)" 
62                onblur="searchBox.OnSearchFieldFocus(false)" 
63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
64           </span><span class="right">
65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
66           </span>
67         </div>
68 </td>
69   <!--END !PROJECT_NAME-->
70  </tr>
71  </tbody>
72 </table>
73 </div>
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
76   <ul class="tablist">
77     <script type="text/javascript">
78       writeComponentTabs.call(this);
79     </script>
80   </ul>
81 </div>
82 <script type="text/javascript">
83   writeSubComponentTabs.call(this);
84 </script>
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 /* @license-end */
90 </script>
91 </div><!-- top -->
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
93   <div id="nav-tree">
94     <div id="nav-tree-contents">
95       <div id="nav-sync" class="sync"></div>
96     </div>
97   </div>
98   <div id="splitbar" style="-moz-user-select:none;" 
99        class="ui-resizable-handle">
100   </div>
101 </div>
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('group__usart__mode__control.html',''); initResizable(); });
105 /* @license-end */
106 </script>
107 <div id="doc-content">
108 <!-- window showing the filter options -->
109 <div id="MSearchSelectWindow"
110      onmouseover="return searchBox.OnSearchSelectShow()"
111      onmouseout="return searchBox.OnSearchSelectHide()"
112      onkeydown="return searchBox.OnSearchSelectKey(event)">
113 </div>
114
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
118 <div class="SRPage">
119 <div id="SRIndex">
120 <div id="SRResults"></div>
121 <div class="SRStatus" id="Loading">Loading...</div>
122 <div class="SRStatus" id="Searching">Searching...</div>
123 <div class="SRStatus" id="NoMatches">No Matches</div>
124 </div>
125 </div>
126 </div>
127 </div>
128
129 <div class="header">
130   <div class="summary">
131 <a href="#define-members">Macros</a>  </div>
132   <div class="headertitle"><div class="title">USART Mode 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>
133 </div><!--header-->
134 <div class="contents">
135
136 <p>Specify USART mode.  
137 <a href="#details">More...</a></p>
138 <table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
140 Macros</h2></td></tr>
141 <tr class="memitem:gad85039731478c924d3b418ec00768388"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a>&#160;&#160;&#160;(0x01UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td></tr>
142 <tr class="memdesc:gad85039731478c924d3b418ec00768388"><td class="mdescLeft">&#160;</td><td class="mdescRight">UART (Asynchronous); arg = Baudrate.  <br /></td></tr>
143 <tr class="separator:gad85039731478c924d3b418ec00768388"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:ga7d3e9e0e838a3f15f8661983b9ac4573"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#ga7d3e9e0e838a3f15f8661983b9ac4573">ARM_USART_MODE_SYNCHRONOUS_MASTER</a>&#160;&#160;&#160;(0x02UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td></tr>
145 <tr class="memdesc:ga7d3e9e0e838a3f15f8661983b9ac4573"><td class="mdescLeft">&#160;</td><td class="mdescRight">Synchronous Master (generates clock signal); arg = Baudrate.  <br /></td></tr>
146 <tr class="separator:ga7d3e9e0e838a3f15f8661983b9ac4573"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:gae78778475f3fab09a080c2279afc69fa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#gae78778475f3fab09a080c2279afc69fa">ARM_USART_MODE_SYNCHRONOUS_SLAVE</a>&#160;&#160;&#160;(0x03UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td></tr>
148 <tr class="memdesc:gae78778475f3fab09a080c2279afc69fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Synchronous Slave (external clock signal)  <br /></td></tr>
149 <tr class="separator:gae78778475f3fab09a080c2279afc69fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:ga4132136971d4f93f2e6a87c6775a9bb0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#ga4132136971d4f93f2e6a87c6775a9bb0">ARM_USART_MODE_SINGLE_WIRE</a>&#160;&#160;&#160;(0x04UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td></tr>
151 <tr class="memdesc:ga4132136971d4f93f2e6a87c6775a9bb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">UART Single-wire (half-duplex); arg = Baudrate.  <br /></td></tr>
152 <tr class="separator:ga4132136971d4f93f2e6a87c6775a9bb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:ga458f4f60d1d772cfd7567ae424d9aad9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#ga458f4f60d1d772cfd7567ae424d9aad9">ARM_USART_MODE_IRDA</a>&#160;&#160;&#160;(0x05UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td></tr>
154 <tr class="memdesc:ga458f4f60d1d772cfd7567ae424d9aad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">UART IrDA; arg = Baudrate.  <br /></td></tr>
155 <tr class="separator:ga458f4f60d1d772cfd7567ae424d9aad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:gade65a1c27d9097d9ef0e86c02b55cecd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#gade65a1c27d9097d9ef0e86c02b55cecd">ARM_USART_MODE_SMART_CARD</a>&#160;&#160;&#160;(0x06UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td></tr>
157 <tr class="memdesc:gade65a1c27d9097d9ef0e86c02b55cecd"><td class="mdescLeft">&#160;</td><td class="mdescRight">UART Smart Card; arg = Baudrate.  <br /></td></tr>
158 <tr class="separator:gade65a1c27d9097d9ef0e86c02b55cecd"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 </table>
160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
161 <p>Specify USART mode. </p>
162 <h2 class="groupheader">Macro Definition Documentation</h2>
163 <a id="gad85039731478c924d3b418ec00768388" name="gad85039731478c924d3b418ec00768388"></a>
164 <h2 class="memtitle"><span class="permalink"><a href="#gad85039731478c924d3b418ec00768388">&#9670;&#160;</a></span>ARM_USART_MODE_ASYNCHRONOUS</h2>
165
166 <div class="memitem">
167 <div class="memproto">
168       <table class="memname">
169         <tr>
170           <td class="memname">#define ARM_USART_MODE_ASYNCHRONOUS&#160;&#160;&#160;(0x01UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td>
171         </tr>
172       </table>
173 </div><div class="memdoc">
174
175 <p>UART (Asynchronous); arg = Baudrate. </p>
176 <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>
177
178 </div>
179 </div>
180 <a id="ga7d3e9e0e838a3f15f8661983b9ac4573" name="ga7d3e9e0e838a3f15f8661983b9ac4573"></a>
181 <h2 class="memtitle"><span class="permalink"><a href="#ga7d3e9e0e838a3f15f8661983b9ac4573">&#9670;&#160;</a></span>ARM_USART_MODE_SYNCHRONOUS_MASTER</h2>
182
183 <div class="memitem">
184 <div class="memproto">
185       <table class="memname">
186         <tr>
187           <td class="memname">#define ARM_USART_MODE_SYNCHRONOUS_MASTER&#160;&#160;&#160;(0x02UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td>
188         </tr>
189       </table>
190 </div><div class="memdoc">
191
192 <p>Synchronous Master (generates clock signal); arg = Baudrate. </p>
193 <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>
194
195 </div>
196 </div>
197 <a id="gae78778475f3fab09a080c2279afc69fa" name="gae78778475f3fab09a080c2279afc69fa"></a>
198 <h2 class="memtitle"><span class="permalink"><a href="#gae78778475f3fab09a080c2279afc69fa">&#9670;&#160;</a></span>ARM_USART_MODE_SYNCHRONOUS_SLAVE</h2>
199
200 <div class="memitem">
201 <div class="memproto">
202       <table class="memname">
203         <tr>
204           <td class="memname">#define ARM_USART_MODE_SYNCHRONOUS_SLAVE&#160;&#160;&#160;(0x03UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td>
205         </tr>
206       </table>
207 </div><div class="memdoc">
208
209 <p>Synchronous Slave (external clock signal) </p>
210 <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>
211
212 </div>
213 </div>
214 <a id="ga4132136971d4f93f2e6a87c6775a9bb0" name="ga4132136971d4f93f2e6a87c6775a9bb0"></a>
215 <h2 class="memtitle"><span class="permalink"><a href="#ga4132136971d4f93f2e6a87c6775a9bb0">&#9670;&#160;</a></span>ARM_USART_MODE_SINGLE_WIRE</h2>
216
217 <div class="memitem">
218 <div class="memproto">
219       <table class="memname">
220         <tr>
221           <td class="memname">#define ARM_USART_MODE_SINGLE_WIRE&#160;&#160;&#160;(0x04UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td>
222         </tr>
223       </table>
224 </div><div class="memdoc">
225
226 <p>UART Single-wire (half-duplex); arg = Baudrate. </p>
227 <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>
228
229 </div>
230 </div>
231 <a id="ga458f4f60d1d772cfd7567ae424d9aad9" name="ga458f4f60d1d772cfd7567ae424d9aad9"></a>
232 <h2 class="memtitle"><span class="permalink"><a href="#ga458f4f60d1d772cfd7567ae424d9aad9">&#9670;&#160;</a></span>ARM_USART_MODE_IRDA</h2>
233
234 <div class="memitem">
235 <div class="memproto">
236       <table class="memname">
237         <tr>
238           <td class="memname">#define ARM_USART_MODE_IRDA&#160;&#160;&#160;(0x05UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td>
239         </tr>
240       </table>
241 </div><div class="memdoc">
242
243 <p>UART IrDA; arg = Baudrate. </p>
244 <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>
245
246 </div>
247 </div>
248 <a id="gade65a1c27d9097d9ef0e86c02b55cecd" name="gade65a1c27d9097d9ef0e86c02b55cecd"></a>
249 <h2 class="memtitle"><span class="permalink"><a href="#gade65a1c27d9097d9ef0e86c02b55cecd">&#9670;&#160;</a></span>ARM_USART_MODE_SMART_CARD</h2>
250
251 <div class="memitem">
252 <div class="memproto">
253       <table class="memname">
254         <tr>
255           <td class="memname">#define ARM_USART_MODE_SMART_CARD&#160;&#160;&#160;(0x06UL &lt;&lt; <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">ARM_USART_CONTROL_Pos</a>)</td>
256         </tr>
257       </table>
258 </div><div class="memdoc">
259
260 <p>UART Smart Card; arg = Baudrate. </p>
261 <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>
262
263 </div>
264 </div>
265 </div><!-- contents -->
266 </div><!-- doc-content -->
267 <!-- start footer part -->
268 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
269   <ul>
270     <li class="footer">
271       <script type="text/javascript">
272         <!--
273         writeFooter.call(this);
274         //-->
275       </script> 
276     </li>
277   </ul>
278 </div>
279 </body>
280 </html>